Skip to content

AWS Storage Gateway API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<fullname>Storage Gateway Service</fullname> <p>Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the Amazon Web Services storage infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.</p> <p>Use the following links to get started using the <i>Storage Gateway Service API Reference</i>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders">Storage Gateway required request headers</a>: Describes the required headers that you must send with every POST request to Storage Gateway.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests">Signing requests</a>: Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses">Error responses</a>: Provides reference information about Storage Gateway errors.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html">Operations in Storage Gateway</a>: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/general/latest/gr/sg.html">Storage Gateway endpoints and quotas</a>: Provides a list of each Amazon Web Services Region and the endpoints available for use with Storage Gateway.</p> </li> </ul> <note> <p>Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be <code>vol-AA22BB012345DAF670</code>. When you use this ID with the EC2 API, you must change it to <code>vol-aa22bb012345daf670</code>. Otherwise, the EC2 API might not behave as expected.</p> </note> <important> <p>IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see <a href="http://aws.amazon.com/ec2/faqs/#longer-ids">Longer EC2 and EBS resource IDs</a>.</p> <p>For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:</p> <p> <code>arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG</code>.</p> <p>A snapshot ID with the longer ID format looks like the following: <code>snap-78e226633445566ee</code>.</p> <p>For more information, see <a href="http://forums.aws.amazon.com/ann.jspa?annID=3557">Announcement: Heads-up – Longer Storage Gateway volume and snapshot IDs coming in 2016</a>.</p> </important>

AWS Storage Gateway is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 90 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2013-06-30
Endpoints
90
Spec updated
2020-04-30

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=StorageGateway_20130630.ActivateGateway<p>Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the Amazon Web Services Region that yo
POST/#X-Amz-Target=StorageGateway_20130630.AddCache<p>Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see <a
POST/#X-Amz-Target=StorageGateway_20130630.AddTagsToResource<p>Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you
POST/#X-Amz-Target=StorageGateway_20130630.AddUploadBuffer<p>Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and ta
POST/#X-Amz-Target=StorageGateway_20130630.AddWorkingStorage<p>Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operati
POST/#X-Amz-Target=StorageGateway_20130630.AssignTapePoolAssigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your
POST/#X-Amz-Target=StorageGateway_20130630.AssociateFileSystemAssociate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are avai
POST/#X-Amz-Target=StorageGateway_20130630.AttachVolumeConnects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your dat
POST/#X-Amz-Target=StorageGateway_20130630.CancelArchivalCancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gatew
POST/#X-Amz-Target=StorageGateway_20130630.CancelRetrievalCancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the
POST/#X-Amz-Target=StorageGateway_20130630.CreateCachediSCSIVolume<p>Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.</p> <note> <p>Cache storage
POST/#X-Amz-Target=StorageGateway_20130630.CreateNFSFileShare<p>Creates a Network File System (NFS) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon
POST/#X-Amz-Target=StorageGateway_20130630.CreateSMBFileShare<p>Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazo
POST/#X-Amz-Target=StorageGateway_20130630.CreateSnapshot<p>Initiates a snapshot of a volume.</p> <p>Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazo
POST/#X-Amz-Target=StorageGateway_20130630.CreateSnapshotFromVolumeRecoveryPoint<p>Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.</p> <p>A volume recovery
POST/#X-Amz-Target=StorageGateway_20130630.CreateStorediSCSIVolume<p>Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.</p> <p>The size of the volume to create is infer
POST/#X-Amz-Target=StorageGateway_20130630.CreateTapePoolCreates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.
POST/#X-Amz-Target=StorageGateway_20130630.CreateTapeWithBarcode<p>Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if i
POST/#X-Amz-Target=StorageGateway_20130630.CreateTapes<p>Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.
POST/#X-Amz-Target=StorageGateway_20130630.DeleteAutomaticTapeCreationPolicyDeletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (AR
POST/#X-Amz-Target=StorageGateway_20130630.DeleteBandwidthRateLimitDeletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only o
POST/#X-Amz-Target=StorageGateway_20130630.DeleteChapCredentialsDeletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume an
POST/#X-Amz-Target=StorageGateway_20130630.DeleteFileShareDeletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways.
POST/#X-Amz-Target=StorageGateway_20130630.DeleteGateway<p>Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway;
POST/#X-Amz-Target=StorageGateway_20130630.DeleteSnapshotSchedule<p>Deletes a snapshot of a volume.</p> <p>You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a
POST/#X-Amz-Target=StorageGateway_20130630.DeleteTapeDeletes the specified virtual tape. This operation is only supported in the tape gateway type.
POST/#X-Amz-Target=StorageGateway_20130630.DeleteTapeArchiveDeletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
POST/#X-Amz-Target=StorageGateway_20130630.DeleteTapePoolDelete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that re
POST/#X-Amz-Target=StorageGateway_20130630.DeleteVolume<p>Deletes the specified storage volume that you previously created using the <a>CreateCachediSCSIVolume</a> or <a>CreateStorediSCSIVolume</a> API. This operati
POST/#X-Amz-Target=StorageGateway_20130630.DescribeAvailabilityMonitorTestReturns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status a
POST/#X-Amz-Target=StorageGateway_20130630.DescribeBandwidthRateLimit<p>Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is
POST/#X-Amz-Target=StorageGateway_20130630.DescribeBandwidthRateLimitSchedule<p> Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no ba
POST/#X-Amz-Target=StorageGateway_20130630.DescribeCache<p>Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.</p> <p>The response in
POST/#X-Amz-Target=StorageGateway_20130630.DescribeCachediSCSIVolumes<p>Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.</p> <p>The list o
POST/#X-Amz-Target=StorageGateway_20130630.DescribeChapCredentialsReturns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
POST/#X-Amz-Target=StorageGateway_20130630.DescribeFileSystemAssociationsGets the file system association information. This operation is only supported for FSx File Gateways.
POST/#X-Amz-Target=StorageGateway_20130630.DescribeGatewayInformationReturns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify w
POST/#X-Amz-Target=StorageGateway_20130630.DescribeMaintenanceStartTimeReturns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.
POST/#X-Amz-Target=StorageGateway_20130630.DescribeNFSFileSharesGets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways.
POST/#X-Amz-Target=StorageGateway_20130630.DescribeSMBFileSharesGets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.
POST/#X-Amz-Target=StorageGateway_20130630.DescribeSMBSettingsGets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
POST/#X-Amz-Target=StorageGateway_20130630.DescribeSnapshotScheduleDescribes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically init
POST/#X-Amz-Target=StorageGateway_20130630.DescribeStorediSCSIVolumesReturns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, S
POST/#X-Amz-Target=StorageGateway_20130630.DescribeTapeArchives<p>Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.</p> <p>If a spec
POST/#X-Amz-Target=StorageGateway_20130630.DescribeTapeRecoveryPoints<p>Returns a list of virtual tape recovery points that are available for the specified tape gateway.</p> <p>A recovery point is a point-in-time view of a virtua
POST/#X-Amz-Target=StorageGateway_20130630.DescribeTapesReturns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a <code>TapeARN</code> is not specified, returns a description of all vir
POST/#X-Amz-Target=StorageGateway_20130630.DescribeUploadBuffer<p>Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.</p> <p>Th
POST/#X-Amz-Target=StorageGateway_20130630.DescribeVTLDevices<p>Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information.<
POST/#X-Amz-Target=StorageGateway_20130630.DescribeWorkingStorage<p>Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated
POST/#X-Amz-Target=StorageGateway_20130630.DetachVolumeDisconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover y
POST/#X-Amz-Target=StorageGateway_20130630.DisableGateway<p>Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover
POST/#X-Amz-Target=StorageGateway_20130630.DisassociateFileSystemDisassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx f
POST/#X-Amz-Target=StorageGateway_20130630.JoinDomainAdds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
POST/#X-Amz-Target=StorageGateway_20130630.ListAutomaticTapeCreationPolicies<p>Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.</p> <p>
POST/#X-Amz-Target=StorageGateway_20130630.ListFileSharesGets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling user account. This operation is only suppor
POST/#X-Amz-Target=StorageGateway_20130630.ListFileSystemAssociationsGets a list of <code>FileSystemAssociationSummary</code> objects. Each object contains a summary of a file system association. This operation is only supported
POST/#X-Amz-Target=StorageGateway_20130630.ListGateways<p>Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Ama
POST/#X-Amz-Target=StorageGateway_20130630.ListLocalDisks<p>Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the r
POST/#X-Amz-Target=StorageGateway_20130630.ListTagsForResourceLists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.
POST/#X-Amz-Target=StorageGateway_20130630.ListTapePools<p>Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify
POST/#X-Amz-Target=StorageGateway_20130630.ListTapes<p>Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon
POST/#X-Amz-Target=StorageGateway_20130630.ListVolumeInitiatorsLists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only sup
POST/#X-Amz-Target=StorageGateway_20130630.ListVolumeRecoveryPoints<p>Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.</p> <p>Each cache volume has one recov
POST/#X-Amz-Target=StorageGateway_20130630.ListVolumes<p>Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume info
POST/#X-Amz-Target=StorageGateway_20130630.NotifyWhenUploaded<p>Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to S3. Amazon S3.</p> <p>Storage Gateway can se
POST/#X-Amz-Target=StorageGateway_20130630.RefreshCache<p>Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or rep
POST/#X-Amz-Target=StorageGateway_20130630.RemoveTagsFromResourceRemoves one or more tags from the specified resource. This operation is supported in storage gateways of all types.
POST/#X-Amz-Target=StorageGateway_20130630.ResetCache<p>Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an er
POST/#X-Amz-Target=StorageGateway_20130630.RetrieveTapeArchive<p>Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway
POST/#X-Amz-Target=StorageGateway_20130630.RetrieveTapeRecoveryPoint<p>Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.</p> <p>A recovery point is a point in
POST/#X-Amz-Target=StorageGateway_20130630.SetLocalConsolePasswordSets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We reco
POST/#X-Amz-Target=StorageGateway_20130630.SetSMBGuestPasswordSets the password for the guest user <code>smbguest</code>. The <code>smbguest</code> user is the user when the authentication method for the file share is set
POST/#X-Amz-Target=StorageGateway_20130630.ShutdownGateway<p>Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.</p> <p>The operat
POST/#X-Amz-Target=StorageGateway_20130630.StartAvailabilityMonitorTest<p>Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates th
POST/#X-Amz-Target=StorageGateway_20130630.StartGateway<p>Starts a gateway that you previously shut down (see <a>ShutdownGateway</a>). After the gateway starts, you can then make other API calls, your applications c
POST/#X-Amz-Target=StorageGateway_20130630.UpdateAutomaticTapeCreationPolicy<p>Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supporte
POST/#X-Amz-Target=StorageGateway_20130630.UpdateBandwidthRateLimit<p>Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't
POST/#X-Amz-Target=StorageGateway_20130630.UpdateBandwidthRateLimitScheduleUpdates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rat
POST/#X-Amz-Target=StorageGateway_20130630.UpdateChapCredentials<p>Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; ho
POST/#X-Amz-Target=StorageGateway_20130630.UpdateFileSystemAssociationUpdates a file system association. This operation is only supported in the FSx File Gateways.
POST/#X-Amz-Target=StorageGateway_20130630.UpdateGatewayInformation<p>Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the
POST/#X-Amz-Target=StorageGateway_20130630.UpdateGatewaySoftwareNow<p>Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.</p> <note> <p>When you make this request, you get a
POST/#X-Amz-Target=StorageGateway_20130630.UpdateMaintenanceStartTimeUpdates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.
POST/#X-Amz-Target=StorageGateway_20130630.UpdateNFSFileShare<p>Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.</p> <note> <p>To leave a file share field unchanged, se
POST/#X-Amz-Target=StorageGateway_20130630.UpdateSMBFileShare<p>Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.</p> <note> <p>To leave a file share field unchanged,
POST/#X-Amz-Target=StorageGateway_20130630.UpdateSMBFileShareVisibilityControls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation is only supported for S3 File Gateways.
POST/#X-Amz-Target=StorageGateway_20130630.UpdateSMBLocalGroupsUpdates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
POST/#X-Amz-Target=StorageGateway_20130630.UpdateSMBSecurityStrategy<p>Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.</p> <note> <p>This API is called Security level in the U
POST/#X-Amz-Target=StorageGateway_20130630.UpdateSnapshotSchedule<p>Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.</p> <p>Th
POST/#X-Amz-Target=StorageGateway_20130630.UpdateVTLDeviceTypeUpdates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation en

Questions

Does the AWS Storage Gateway API need an API key?

Yes. The AWS Storage Gateway API uses API key authentication; the documentation explains how to get credentials.

Does the AWS Storage Gateway API support HTTPS?

Yes, the AWS Storage Gateway API is served over HTTPS.

How many endpoints does the AWS Storage Gateway API have?

Its OpenAPI description lists 90 endpoints in version 2013-06-30. All of them are shown on this page.

What are alternatives to the AWS Storage Gateway 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).