Skip to content

Amazon Glacier API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p> Amazon S3 Glacier (Glacier) is a storage solution for "cold data."</p> <p>Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Glacier, customers can store their data cost effectively for months, years, or decades. Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.</p> <p>Glacier is a great storage choice when low storage cost is paramount and your data is rarely retrieved. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see <a href="http://aws.amazon.com/s3/">Amazon Simple Storage Service (Amazon S3)</a>.</p> <p>You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Glacier.</p> <p>If you are a first-time user of Glacier, we recommend that you begin by reading the following sections in the <i>Amazon S3 Glacier Developer Guide</i>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html">What is Amazon S3 Glacier</a> - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html">Getting Started with Amazon S3 Glacier</a> - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.</p> </li> </ul>

Amazon Glacier is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 33 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2012-06-01
Endpoints
33
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
GET/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}<p>This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progr
POST/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}<p>You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive fro
PUT/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}<p>This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 par
DELETE/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}<p>This operation aborts a multipart upload identified by the upload ID.</p> <p>After the Abort Multipart Upload request succeeds, you cannot upload any more pa
GET/{accountId}/vaults/{vaultName}/lock-policy<p>This operation retrieves the following attributes from the <code>lock-policy</code> subresource set on the specified vault: </p> <ul> <li> <p>The vault lock
POST/{accountId}/vaults/{vaultName}/lock-policy<p>This operation initiates the vault locking process by doing the following:</p> <ul> <li> <p>Installing a vault lock policy on the specified vault.</p> </li>
DELETE/{accountId}/vaults/{vaultName}/lock-policy<p>This operation aborts the vault locking process if the vault lock is not in the <code>Locked</code> state. If the vault lock is in the <code>Locked</code> st
POST/{accountId}/vaults/{vaultName}/tags#operation=addThis operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the
POST/{accountId}/vaults/{vaultName}/lock-policy/{lockId}<p>This operation completes the vault locking process by transitioning the vault lock from the <code>InProgress</code> state to the <code>Locked</code> state, w
GET/{accountId}/vaults/{vaultName}<p>This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it
PUT/{accountId}/vaults/{vaultName}<p>This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,0
DELETE/{accountId}/vaults/{vaultName}<p>This operation deletes a vault. Amazon S3 Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been
DELETE/{accountId}/vaults/{vaultName}/archives/{archiveId}<p>This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progres
GET/{accountId}/vaults/{vaultName}/access-policyThis operation retrieves the <code>access-policy</code> subresource set on the vault; for more information on setting this subresource, see <a href="https://doc
PUT/{accountId}/vaults/{vaultName}/access-policyThis operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the <cod
DELETE/{accountId}/vaults/{vaultName}/access-policy<p>This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Am
GET/{accountId}/vaults/{vaultName}/notification-configuration<p>This operation retrieves the <code>notification-configuration</code> subresource of the specified vault.</p> <p>For information about setting a notification
PUT/{accountId}/vaults/{vaultName}/notification-configuration<p>This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.</p> <p>To conf
DELETE/{accountId}/vaults/{vaultName}/notification-configuration<p>This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon S3
GET/{accountId}/vaults/{vaultName}/jobs/{jobId}<p>This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status co
GET/{accountId}/policies/data-retrievalThis operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval poli
PUT/{accountId}/policies/data-retrieval<p>This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account.
GET/{accountId}/vaults/{vaultName}/jobs/{jobId}/output<p>This operation downloads the output of the job you initiated using <a>InitiateJob</a>. Depending on the job type you specified when you initiated the job, th
GET/{accountId}/vaults/{vaultName}/jobs<p>This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of the
POST/{accountId}/vaults/{vaultName}/jobsThis operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this
GET/{accountId}/vaults/{vaultName}/multipart-uploads<p>This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by
POST/{accountId}/vaults/{vaultName}/multipart-uploads<p>This operation initiates a multipart upload. Amazon S3 Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload I
GET/{accountId}/provisioned-capacityThis operation lists the provisioned capacity units for the specified AWS account.
POST/{accountId}/provisioned-capacityThis operation purchases a provisioned capacity unit for an AWS account.
GET/{accountId}/vaults/{vaultName}/tagsThis operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see <a href="ht
GET/{accountId}/vaults<p>This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.</p> <p>By default, this
POST/{accountId}/vaults/{vaultName}/tags#operation=removeThis operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see <a href="https://docs.aws.amazon.com/amaz
POST/{accountId}/vaults/{vaultName}/archives<p>This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon S3 Glacier re

Questions

Does the Amazon Glacier API need an API key?

Yes. The Amazon Glacier API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon Glacier API support HTTPS?

Yes, the Amazon Glacier API is served over HTTPS.

How many endpoints does the Amazon Glacier API have?

Its OpenAPI description lists 33 endpoints in version 2012-06-01. All of them are shown on this page.

What are alternatives to the Amazon Glacier API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).