Open documentation ↗Overview
<p>Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.</p> <p>You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli">Amazon Lightsail Developer Guide</a>.</p> <p>This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see <a href="https://docs.aws.amazon.com/general/latest/gr/lightsail.html">Amazon Lightsail Endpoints and Quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>
Amazon Lightsail is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 159 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2016-11-28
- Endpoints
- 159
- OpenAPI
- Specification ↗
- Spec updated
- 2020-05-07
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=Lightsail_20161128.AllocateStaticIp | Allocates a static IP address. |
| POST | /#X-Amz-Target=Lightsail_20161128.AttachCertificateToDistribution | <p>Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.</p> <p>After the certificate is attached, your distribu |
| POST | /#X-Amz-Target=Lightsail_20161128.AttachDisk | <p>Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.</p> <p>The <code>attach |
| POST | /#X-Amz-Target=Lightsail_20161128.AttachInstancesToLoadBalancer | <p>Attaches one or more Lightsail instances to a load balancer.</p> <p>After some time, the instances are attached to the load balancer and the health check sta |
| POST | /#X-Amz-Target=Lightsail_20161128.AttachLoadBalancerTlsCertificate | <p>Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p |
| POST | /#X-Amz-Target=Lightsail_20161128.AttachStaticIp | Attaches a static IP address to a specific Amazon Lightsail instance. |
| POST | /#X-Amz-Target=Lightsail_20161128.CloseInstancePublicPorts | <p>Closes ports for a specific Amazon Lightsail instance.</p> <p>The <code>CloseInstancePublicPorts</code> action supports tag-based access control via resource |
| POST | /#X-Amz-Target=Lightsail_20161128.CopySnapshot | <p>Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateBucket | <p>Creates an Amazon Lightsail bucket.</p> <p>A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objec |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateBucketAccessKey | <p>Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.</p> <p>Acces |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateCertificate | <p>Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.</p> <p>After the certificate is v |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateCloudFormationStack | <p>Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFor |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateContactMethod | <p>Creates an email or SMS text message contact method.</p> <p>A contact method is used to send you notifications about your Amazon Lightsail resources. You can |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateContainerService | <p>Creates an Amazon Lightsail container service.</p> <p>A Lightsail container service is a compute resource to which you can deploy containers. For more inform |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateContainerServiceDeployment | <p>Creates a deployment for your Amazon Lightsail container service.</p> <p>A deployment specifies the containers that will be launched on the container service |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateContainerServiceRegistryLogin | <p>Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateDisk | <p>Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., <code>us-east-2a</code>).</p> <p>The < |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateDiskFromSnapshot | <p>Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Av |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateDiskSnapshot | <p>Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail ins |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateDistribution | <p>Creates an Amazon Lightsail content delivery network (CDN) distribution.</p> <p>A distribution is a globally distributed network of caching servers that impr |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateDomain | <p>Creates a domain resource for the specified domain (e.g., example.com).</p> <p>The <code>create domain</code> operation supports tag-based access control via |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateDomainEntry | <p>Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateGUISessionAccessDetails | <p>Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateInstanceSnapshot | <p>Creates a snapshot of a specific virtual private server, or <i>instance</i>. You can use a snapshot to create a new instance that is based on that snapshot.< |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateInstances | <p>Creates one or more Amazon Lightsail instances.</p> <p>The <code>create instances</code> operation supports tag-based access control via request tags. For mo |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateInstancesFromSnapshot | <p>Creates one or more new instances from a manual or automatic snapshot of an instance.</p> <p>The <code>create instances from snapshot</code> operation suppor |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateKeyPair | <p>Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.</p> <note> <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-1 |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateLoadBalancer | <p>Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see <a href="https://lightsail.aws.amazon.com/ls/do |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateLoadBalancerTlsCertificate | <p>Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateRelationalDatabase | <p>Creates a new database in Amazon Lightsail.</p> <p>The <code>create relational database</code> operation supports tag-based access control via request tags. |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateRelationalDatabaseFromSnapshot | <p>Creates a new database from an existing database snapshot in Amazon Lightsail.</p> <p>You can create a new database from a snapshot in if something goes wron |
| POST | /#X-Amz-Target=Lightsail_20161128.CreateRelationalDatabaseSnapshot | <p>Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteAlarm | <p>Deletes an alarm.</p> <p>An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by e |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteAutoSnapshot | Deletes an automatic snapshot of an instance or disk. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-ligh |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteBucket | <p>Deletes a Amazon Lightsail bucket.</p> <note> <p>When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteBucketAccessKey | <p>Deletes an access key for the specified Amazon Lightsail bucket.</p> <p>We recommend that you delete an access key if the secret access key is compromised.</ |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteCertificate | <p>Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.</p> <p>Certificates that are currently attached to a di |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteContactMethod | <p>Deletes a contact method.</p> <p>A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteContainerImage | Deletes a container image that is registered to your Amazon Lightsail container service. |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteContainerService | Deletes your Amazon Lightsail container service. |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteDisk | <p>Deletes the specified block storage disk. The disk must be in the <code>available</code> state (not attached to a Lightsail instance).</p> <note> <p>The disk |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteDiskSnapshot | <p>Deletes the specified disk snapshot.</p> <p>When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteDistribution | Deletes your Amazon Lightsail content delivery network (CDN) distribution. |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteDomain | <p>Deletes the specified domain recordset and all of its domain records.</p> <p>The <code>delete domain</code> operation supports tag-based access control via r |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteDomainEntry | <p>Deletes a specific domain entry.</p> <p>The <code>delete domain entry</code> operation supports tag-based access control via resource tags applied to the res |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteInstance | <p>Deletes an Amazon Lightsail instance.</p> <p>The <code>delete instance</code> operation supports tag-based access control via resource tags applied to the re |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteInstanceSnapshot | <p>Deletes a specific snapshot of a virtual private server (or <i>instance</i>).</p> <p>The <code>delete instance snapshot</code> operation supports tag-based a |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteKeyPair | <p>Deletes the specified key pair by removing the public key from Amazon Lightsail.</p> <p>You can delete key pairs that were created using the <a href="https:/ |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteKnownHostKeys | <p>Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables t |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteLoadBalancer | <p>Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteLoadBalancerTlsCertificate | <p>Deletes an SSL/TLS certificate associated with a Lightsail load balancer.</p> <p>The <code>DeleteLoadBalancerTlsCertificate</code> operation supports tag-bas |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteRelationalDatabase | <p>Deletes a database in Amazon Lightsail.</p> <p>The <code>delete relational database</code> operation supports tag-based access control via resource tags appl |
| POST | /#X-Amz-Target=Lightsail_20161128.DeleteRelationalDatabaseSnapshot | <p>Deletes a database snapshot in Amazon Lightsail.</p> <p>The <code>delete relational database snapshot</code> operation supports tag-based access control via |
| POST | /#X-Amz-Target=Lightsail_20161128.DetachCertificateFromDistribution | <p>Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.</p> <p>After the certificate is detached, your distri |
| POST | /#X-Amz-Target=Lightsail_20161128.DetachDisk | <p>Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stop |
| POST | /#X-Amz-Target=Lightsail_20161128.DetachInstancesFromLoadBalancer | <p>Detaches the specified instances from a Lightsail load balancer.</p> <p>This operation waits until the instances are no longer needed before they are detache |
| POST | /#X-Amz-Target=Lightsail_20161128.DetachStaticIp | Detaches a static IP from the Amazon Lightsail instance to which it is attached. |
| POST | /#X-Amz-Target=Lightsail_20161128.DisableAddOn | Disables an add-on for an Amazon Lightsail resource. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-light |
| POST | /#X-Amz-Target=Lightsail_20161128.DownloadDefaultKeyPair | <p>Downloads the regional Amazon Lightsail default key pair.</p> <p>This action also creates a Lightsail default key pair if a default key pair does not current |
| POST | /#X-Amz-Target=Lightsail_20161128.EnableAddOn | Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/a |
| POST | /#X-Amz-Target=Lightsail_20161128.ExportSnapshot | <p>Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapsho |
| POST | /#X-Amz-Target=Lightsail_20161128.GetActiveNames | Returns the names of all active (not deleted) resources. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetAlarms | <p>Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored r |
| POST | /#X-Amz-Target=Lightsail_20161128.GetAutoSnapshots | Returns the available automatic snapshots for an instance or disk. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/article |
| POST | /#X-Amz-Target=Lightsail_20161128.GetBlueprints | <p>Returns the list of available instance images, or <i>blueprints</i>. You can use a blueprint to create a new instance already running a specific operating sy |
| POST | /#X-Amz-Target=Lightsail_20161128.GetBucketAccessKeys | <p>Returns the existing access key IDs for the specified Amazon Lightsail bucket.</p> <important> <p>This action does not return the secret access key value of |
| POST | /#X-Amz-Target=Lightsail_20161128.GetBucketBundles | <p>Returns the bundles that you can apply to a Amazon Lightsail bucket.</p> <p>The bucket bundle specifies the monthly cost, storage quota, and data transfer qu |
| POST | /#X-Amz-Target=Lightsail_20161128.GetBucketMetricData | <p>Returns the data points of a specific metric for an Amazon Lightsail bucket.</p> <p>Metrics report the utilization of a bucket. View and collect metric data |
| POST | /#X-Amz-Target=Lightsail_20161128.GetBuckets | <p>Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Ser |
| POST | /#X-Amz-Target=Lightsail_20161128.GetBundles | <p>Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.</p> <p>A bundle describes the specifications of an instance, such |
| POST | /#X-Amz-Target=Lightsail_20161128.GetCertificates | <p>Returns information about one or more Amazon Lightsail SSL/TLS certificates.</p> <note> <p>To get a summary of a certificate, ommit <code>includeCertificateD |
| POST | /#X-Amz-Target=Lightsail_20161128.GetCloudFormationStackRecords | <p>Returns the CloudFormation stack record created as a result of the <code>create cloud formation stack</code> operation.</p> <p>An AWS CloudFormation stack is |
| POST | /#X-Amz-Target=Lightsail_20161128.GetContactMethods | <p>Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.</p> <p>A |
| POST | /#X-Amz-Target=Lightsail_20161128.GetContainerAPIMetadata | Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetContainerImages | <p>Returns the container images that are registered to your Amazon Lightsail container service.</p> <note> <p>If you created a deployment on your Lightsail cont |
| POST | /#X-Amz-Target=Lightsail_20161128.GetContainerLog | <p>Returns the log events of a container of your Amazon Lightsail container service.</p> <p>If your container service has more than one node (i.e., a scale grea |
| POST | /#X-Amz-Target=Lightsail_20161128.GetContainerServiceDeployments | <p>Returns the deployments for your Amazon Lightsail container service</p> <p>A deployment specifies the settings, such as the ports and launch command, of cont |
| POST | /#X-Amz-Target=Lightsail_20161128.GetContainerServiceMetricData | <p>Returns the data points of a specific metric of your Amazon Lightsail container service.</p> <p>Metrics report the utilization of your resources. Monitor and |
| POST | /#X-Amz-Target=Lightsail_20161128.GetContainerServicePowers | <p>Returns the list of powers that can be specified for your Amazon Lightsail container services.</p> <p>The power specifies the amount of memory, the number of |
| POST | /#X-Amz-Target=Lightsail_20161128.GetContainerServices | Returns information about one or more of your Amazon Lightsail container services. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetCostEstimate | Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetDisk | Returns information about a specific block storage disk. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetDiskSnapshot | Returns information about a specific block storage disk snapshot. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetDiskSnapshots | Returns information about all block storage disk snapshots in your AWS account and region. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetDisks | Returns information about all block storage disks in your AWS account and region. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetDistributionBundles | <p>Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.</p> <p>A distribution bundle specifies the mon |
| POST | /#X-Amz-Target=Lightsail_20161128.GetDistributionLatestCacheReset | Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetDistributionMetricData | <p>Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.</p> <p>Metrics report the utilization of yo |
| POST | /#X-Amz-Target=Lightsail_20161128.GetDistributions | Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetDomain | Returns information about a specific domain recordset. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetDomains | Returns a list of all domains in the user's account. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetExportSnapshotRecords | <p>Returns all export snapshot records created as a result of the <code>export snapshot</code> operation.</p> <p>An export snapshot record can be used to create |
| POST | /#X-Amz-Target=Lightsail_20161128.GetInstance | Returns information about a specific Amazon Lightsail instance, which is a virtual private server. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetInstanceAccessDetails | <p>Returns temporary SSH keys you can use to connect to a specific virtual private server, or <i>instance</i>.</p> <p>The <code>get instance access details</cod |
| POST | /#X-Amz-Target=Lightsail_20161128.GetInstanceMetricData | <p>Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.</p> <p>Metrics report the utilization of your resources, |
| POST | /#X-Amz-Target=Lightsail_20161128.GetInstancePortStates | Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protoc |
| POST | /#X-Amz-Target=Lightsail_20161128.GetInstanceSnapshot | Returns information about a specific instance snapshot. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetInstanceSnapshots | Returns all instance snapshots for the user's account. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetInstanceState | Returns the state of a specific instance. Works on one instance at a time. |
| POST | /#X-Amz-Target=Lightsail_20161128.GetInstances | Returns information about all Amazon Lightsail virtual private servers, or <i>instances</i>. |
Showing the first 100 of 159 endpoints; the full list is in the documentation.
Questions
Does the Amazon Lightsail API need an API key?
Yes. The Amazon Lightsail API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon Lightsail API support HTTPS?
Yes, the Amazon Lightsail API is served over HTTPS.
How many endpoints does the Amazon Lightsail API have?
Its OpenAPI description lists 159 endpoints in version 2016-11-28. The first 100 are shown on this page.
What are alternatives to the Amazon Lightsail API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
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
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
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).