Open documentation ↗Overview
<p>The Amazon Chime application programming interface (API) is designed so administrators can perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.</p> <p>You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a <i>See Also</i> section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.</p> <dl> <dt>Using an AWS SDK</dt> <dd> <p> You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the <a href="http://aws.amazon.com/developer/">AWS Developer Center</a>. </p> </dd> <dt>Using the AWS CLI</dt> <dd> <p>Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/installing.html">Installing the AWS Command Line Interface</a> in the <i>AWS Command Line Interface User Guide</i>. For a list of available Amazon Chime commands, see the <a href="https://docs.aws.amazon.com/cli/latest/reference/chime/index.html">Amazon Chime commands</a> in the <i>AWS CLI Command Reference</i>. </p> </dd> <dt>Using REST APIs</dt> <dd> <p>If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>When making REST API calls, use the service name <code>chime</code> and REST endpoint <code>https://service.chime.aws.amazon.com</code>.</p> </dd> </dl> <p>Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see <a href="https://docs.aws.amazon.com/chime/latest/ag/security-iam.html">Identity and Access Management for Amazon Chime</a> in the <i>Amazon Chime Administration Guide</i>.</p>
Amazon Chime is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 191 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Base URL
http://service.chime.aws.amazon.com- Version
- 2018-05-01
- Endpoints
- 191
- OpenAPI
- Specification ↗
- Spec updated
- 2020-04-09
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "http://service.chime.aws.amazon.com/accounts" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch("http://service.chime.aws.amazon.com/accounts", {
method: "GET",
headers: {
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"http://service.chime.aws.amazon.com/accounts",
headers={
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /accounts/{accountId}/users/{userId}#operation=associate-phone-number | Associates a phone number with the specified Amazon Chime user. |
| POST | /voice-connectors/{voiceConnectorId}#operation=associate-phone-numbers | Associates phone numbers with the specified Amazon Chime Voice Connector. |
| POST | /voice-connector-groups/{voiceConnectorGroupId}#operation=associate-phone-numbers | Associates phone numbers with the specified Amazon Chime Voice Connector group. |
| POST | /accounts/{accountId}#operation=associate-signin-delegate-groups | Associates the specified sign-in delegate groups with the specified Amazon Chime account. |
| POST | /meetings/{meetingId}/attendees#operation=batch-create | Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.co |
| POST | /channels/{channelArn}/memberships#operation=batch-create | Adds a specified number of users to a channel. |
| POST | /accounts/{accountId}/rooms/{roomId}/memberships#operation=batch-create | Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a cha |
| POST | /phone-numbers#operation=batch-delete | <p> Moves phone numbers into the <b>Deletion queue</b>. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be d |
| POST | /accounts/{accountId}/users#operation=suspend | <p>Suspends up to 50 users from a <code>Team</code> or <code>EnterpriseLWA</code> Amazon Chime account. For more information about different account types, see |
| POST | /accounts/{accountId}/users#operation=unsuspend | <p>Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime <code>EnterpriseLWA</code> account. Only users on <code>Enterp |
| POST | /phone-numbers#operation=batch-update | <p>Updates phone number product types or calling names. You can update one attribute at a time for each <code>UpdatePhoneNumberRequestItem</code>. For example, |
| GET | /accounts/{accountId}/users | Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to. |
| POST | /accounts/{accountId}/users | Updates user details within the <a>UpdateUserRequestItem</a> object for up to 20 users for the specified Amazon Chime account. Currently, only <code>LicenseType |
| GET | /accounts | Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a |
| POST | /accounts | Creates an Amazon Chime account under the administrator's AWS account. Only <code>Team</code> account types are currently supported for this action. For more in |
| GET | /app-instances | Lists all Amazon Chime <code>AppInstance</code>s created under a single AWS account. |
| POST | /app-instances | Creates an Amazon Chime SDK messaging <code>AppInstance</code> under an AWS account. Only SDK messaging customers use this API. <code>CreateAppInstance</code> s |
| GET | /app-instances/{appInstanceArn}/admins | Returns a list of the administrators in the <code>AppInstance</code>. |
| POST | /app-instances/{appInstanceArn}/admins | <p>Promotes an <code>AppInstanceUser</code> to an <code>AppInstanceAdmin</code>. The promoted user can perform the following actions. </p> <ul> <li> <p> <code>C |
| POST | /app-instance-users | Creates a user under an Amazon Chime <code>AppInstance</code>. The request consists of a unique <code>appInstanceUserId</code> and <code>Name</code> for that us |
| GET | /meetings/{meetingId}/attendees | Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime- |
| POST | /meetings/{meetingId}/attendees | Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime-s |
| GET | /accounts/{accountId}/bots | Lists the bots associated with the administrator's Amazon Chime Enterprise account ID. |
| POST | /accounts/{accountId}/bots | Creates a bot for an Amazon Chime Enterprise account. |
| POST | /channels | <p>Creates a channel to which you can add users and send messages.</p> <p> <b>Restriction</b>: You can't change a channel's privacy.</p> <note> <p>The <code>x-a |
| GET | /channels/{channelArn}/bans | <p>Lists all the users banned from a particular channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanc |
| POST | /channels/{channelArn}/bans | <p>Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, a |
| GET | /channels/{channelArn}/memberships | <p>Lists all channel memberships in a channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</ |
| POST | /channels/{channelArn}/memberships | <p>Adds a user to a channel. The <code>InvitedBy</code> response field is derived from the request header. A channel member can:</p> <ul> <li> <p>List messages< |
| GET | /channels/{channelArn}/moderators | <p>Lists all the moderators for a channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code |
| POST | /channels/{channelArn}/moderators | <p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p> <ul> <li> <p>Add and remove other members of the channel.</p> </li> <li> <p>Add and |
| GET | /media-capture-pipelines | Returns a list of media capture pipelines. |
| POST | /media-capture-pipelines | Creates a media capture pipeline. |
| GET | /meetings | Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/ |
| POST | /meetings | Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see <a href |
| POST | /meetings/{meetingId}/dial-outs | <p>Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone |
| POST | /meetings#operation=create-attendees | Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see <a href="https:// |
| GET | /phone-number-orders | Lists the phone number orders for the administrator's Amazon Chime account. |
| POST | /phone-number-orders | Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside |
| GET | /voice-connectors/{voiceConnectorId}/proxy-sessions | Lists the proxy sessions for the specified Amazon Chime Voice Connector. |
| POST | /voice-connectors/{voiceConnectorId}/proxy-sessions | Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers. |
| GET | /accounts/{accountId}/rooms | Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of roo |
| POST | /accounts/{accountId}/rooms | Creates a chat room for the specified Amazon Chime Enterprise account. |
| GET | /accounts/{accountId}/rooms/{roomId}/memberships | Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names. |
| POST | /accounts/{accountId}/rooms/{roomId}/memberships | Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a c |
| GET | /sip-media-applications | Lists the SIP media applications under the administrator's AWS account. |
| POST | /sip-media-applications | Creates a SIP media application. |
| POST | /sip-media-applications/{sipMediaApplicationId}/calls | Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified <code>sipMediaApplicatio |
| GET | /sip-rules | Lists the SIP rules under the administrator's AWS account. |
| POST | /sip-rules | Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type. |
| POST | /accounts/{accountId}/users#operation=create | Creates a user under the specified Amazon Chime account. |
| GET | /voice-connectors | Lists the Amazon Chime Voice Connectors for the administrator's AWS account. |
| POST | /voice-connectors | <p>Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Reg |
| GET | /voice-connector-groups | Lists the Amazon Chime Voice Connector groups for the administrator's AWS account. |
| POST | /voice-connector-groups | <p>Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Vo |
| GET | /accounts/{accountId} | Retrieves details for the specified Amazon Chime account, such as account type and supported licenses. |
| POST | /accounts/{accountId} | Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action. |
| DELETE | /accounts/{accountId} | <p>Deletes the specified Amazon Chime account. You must suspend all users before deleting <code>Team</code> account. You can use the <a>BatchSuspendUser</a> act |
| GET | /app-instances/{appInstanceArn} | Returns the full details of an <code>AppInstance</code>. |
| PUT | /app-instances/{appInstanceArn} | Updates <code>AppInstance</code> metadata. |
| DELETE | /app-instances/{appInstanceArn} | Deletes an <code>AppInstance</code> and all associated data asynchronously. |
| GET | /app-instances/{appInstanceArn}/admins/{appInstanceAdminArn} | Returns the full details of an <code>AppInstanceAdmin</code>. |
| DELETE | /app-instances/{appInstanceArn}/admins/{appInstanceAdminArn} | Demotes an <code>AppInstanceAdmin</code> to an <code>AppInstanceUser</code>. This action does not delete the user. |
| GET | /app-instances/{appInstanceArn}/streaming-configurations | Gets the streaming settings for an <code>AppInstance</code>. |
| PUT | /app-instances/{appInstanceArn}/streaming-configurations | The data streaming configurations of an <code>AppInstance</code>. |
| DELETE | /app-instances/{appInstanceArn}/streaming-configurations | Deletes the streaming configurations of an <code>AppInstance</code>. |
| GET | /app-instance-users/{appInstanceUserArn} | Returns the full details of an <code>AppInstanceUser</code>. |
| PUT | /app-instance-users/{appInstanceUserArn} | Updates the details of an <code>AppInstanceUser</code>. You can update names and metadata. |
| DELETE | /app-instance-users/{appInstanceUserArn} | Deletes an <code>AppInstanceUser</code>. |
| GET | /meetings/{meetingId}/attendees/{attendeeId} | Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see <a href="https://doc |
| DELETE | /meetings/{meetingId}/attendees/{attendeeId} | Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their <code>JoinToken</code>. Attendees are automatically deleted when a Amazon Chim |
| GET | /channels/{channelArn} | <p>Returns the full details of a channel in an Amazon Chime <code>AppInstance</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandat |
| PUT | /channels/{channelArn} | <p>Update a channel's attributes.</p> <p> <b>Restriction</b>: You can't change a channel's privacy. </p> <note> <p>The <code>x-amz-chime-bearer</code> request h |
| DELETE | /channels/{channelArn} | <p>Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.</p> <note> <p>The <code>x-amz-chim |
| GET | /channels/{channelArn}/bans/{memberArn} | <p>Returns the full details of a channel ban.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</c |
| DELETE | /channels/{channelArn}/bans/{memberArn} | <p>Removes a user from a channel's ban list.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</co |
| GET | /channels/{channelArn}/memberships/{memberArn} | <p>Returns the full details of a user's channel membership.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInst |
| DELETE | /channels/{channelArn}/memberships/{memberArn} | <p>Removes a member from a channel.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of th |
| GET | /channels/{channelArn}/messages/{messageId} | <p>Gets the full details of a channel message.</p> <note> <p>The x-amz-chime-bearer request header is mandatory. Use the <code>AppInstanceUserArn</code> of the |
| PUT | /channels/{channelArn}/messages/{messageId} | <p>Updates the content of a message.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of t |
| DELETE | /channels/{channelArn}/messages/{messageId} | <p>Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions |
| GET | /channels/{channelArn}/moderators/{channelModeratorArn} | <p>Returns the full details of a single ChannelModerator.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstan |
| DELETE | /channels/{channelArn}/moderators/{channelModeratorArn} | <p>Deletes a channel moderator.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the us |
| GET | /accounts/{accountId}/bots/{botId}/events-configuration | Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN. |
| PUT | /accounts/{accountId}/bots/{botId}/events-configuration | Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For |
| DELETE | /accounts/{accountId}/bots/{botId}/events-configuration | Deletes the events configuration that allows a bot to receive outgoing events. |
| GET | /media-capture-pipelines/{mediaPipelineId} | Gets an existing media capture pipeline. |
| DELETE | /media-capture-pipelines/{mediaPipelineId} | Deletes the media capture pipeline. |
| GET | /meetings/{meetingId} | Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.co |
| DELETE | /meetings/{meetingId} | Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. |
| GET | /phone-numbers/{phoneNumberId} | Retrieves details for the specified phone number ID, such as associations, capabilities, and product type. |
| POST | /phone-numbers/{phoneNumberId} | <p>Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For |
| DELETE | /phone-numbers/{phoneNumberId} | <p>Moves the specified phone number into the <b>Deletion queue</b>. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before |
| GET | /voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId} | Gets the specified proxy session details for the specified Amazon Chime Voice Connector. |
| POST | /voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId} | Updates the specified proxy session details, such as voice or SMS capabilities. |
| DELETE | /voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId} | Deletes the specified proxy session from the specified Amazon Chime Voice Connector. |
| GET | /accounts/{accountId}/rooms/{roomId} | Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account. |
| POST | /accounts/{accountId}/rooms/{roomId} | Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account. |
| DELETE | /accounts/{accountId}/rooms/{roomId} | Deletes a chat room in an Amazon Chime Enterprise account. |
| POST | /accounts/{accountId}/rooms/{roomId}/memberships/{memberId} | Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a c |
Showing the first 100 of 191 endpoints; the full list is in the documentation.
Questions
Does the Amazon Chime API need an API key?
Yes. The Amazon Chime API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon Chime API support HTTPS?
Yes, the Amazon Chime API is served over HTTPS.
How many endpoints does the Amazon Chime API have?
Its OpenAPI description lists 191 endpoints in version 2018-05-01. The first 100 are shown on this page.
What are alternatives to the Amazon Chime 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).