Open documentation ↗Overview
<p>Using the Amazon Cognito user pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.</p> <p>This API reference provides information about user pools in Amazon Cognito user pools.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html">Amazon Cognito Documentation</a>.</p>
Amazon Cognito Identity Provider is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 101 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2016-04-18
- Endpoints
- 101
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-17
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AddCustomAttributes | Adds additional user attributes to the user pool schema. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminAddUserToGroup | <p>Adds the specified user to the specified group.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminConfirmSignUp | <p>Confirms user registration as an admin without using a confirmation code. Works on any user.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminCreateUser | <p>Creates a new user in the specified user pool.</p> <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via email or phone (S |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDeleteUser | <p>Deletes a user as an administrator. Works on any user.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDeleteUserAttributes | <p>Deletes the user attributes in a user pool as an administrator. Works on any user.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDisableProviderForUser | <p>Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon C |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDisableUser | <p>Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to <code>GetUser</code> a |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminEnableUser | <p>Enables the specified user as an administrator. Works on any user.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminForgetDevice | <p>Forgets the device, as an administrator.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminGetDevice | <p>Gets the device, as an administrator.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminGetUser | <p>Gets the specified user by user name in a user pool as an administrator. Works on any user.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminInitiateAuth | <p>Initiates the authentication flow, as an administrator.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carri |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminLinkProviderForUser | <p>Links an existing user account in a user pool (<code>DestinationUser</code>) to an identity from an external IdP (<code>SourceUser</code>) based on a specifi |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminListDevices | <p>Lists devices, as an administrator.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminListGroupsForUser | <p>Lists the groups that the user belongs to.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminListUserAuthEvents | A history of user activity and any risks detected as part of Amazon Cognito advanced security. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminRemoveUserFromGroup | <p>Removes the specified user from the specified group.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminResetUserPassword | <p>Resets the specified user's password in a user pool as an administrator. Works on any user.</p> <p>When a developer calls this API, the current password is i |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminRespondToAuthChallenge | <p>Responds to an authentication challenge, as an administrator.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminSetUserMFAPreference | The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as pref |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminSetUserPassword | <p>Sets the specified user's password in a user pool as an administrator. Works on any user. </p> <p>The password can be temporary or permanent. If it is tempor |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminSetUserSettings | <i>This action is no longer supported.</i> You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminUpdateAuthEventFeedback | Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the u |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminUpdateDeviceStatus | <p>Updates the device status as an administrator.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminUpdateUserAttributes | <p>Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.</p> <p>For custom attributes, you must prepe |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminUserGlobalSignOut | <p>Signs out a user from all devices. You must sign <code>AdminUserGlobalSignOut</code> requests with Amazon Web Services credentials. It also invalidates all r |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.AssociateSoftwareToken | <p>Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ChangePassword | Changes the password for a specified user in a user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ConfirmDevice | Confirms tracking of the device. This API call is the call that begins device tracking. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ConfirmForgotPassword | Allows a user to enter a confirmation code to reset a forgotten password. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ConfirmSignUp | Confirms registration of a new user. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateGroup | <p>Creates a new group in the specified user pool.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateIdentityProvider | Creates an IdP for a user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateResourceServer | Creates a new OAuth2.0 resource server and defines custom scopes within it. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserImportJob | Creates the user import job. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPool | <p>Creates a new Amazon Cognito user pool and sets the password policy for the pool.</p> <note> <p>This action might generate an SMS text message. Starting June |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPoolClient | <p>Creates the user pool client.</p> <p>When you create a new user pool client, token revocation is automatically activated. For more information about revoking |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPoolDomain | Creates a new domain for a user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteGroup | <p>Deletes a group.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteIdentityProvider | Deletes an IdP for a user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteResourceServer | Deletes a resource server. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUser | Allows a user to delete himself or herself. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserAttributes | Deletes the attributes for a user. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserPool | Deletes the specified Amazon Cognito user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserPoolClient | Allows the developer to delete the user pool client. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserPoolDomain | Deletes a domain for a user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeIdentityProvider | Gets information about a specific IdP. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeResourceServer | Describes a resource server. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeRiskConfiguration | Describes the risk configuration. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserImportJob | Describes the user import job. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserPool | Returns the configuration information and metadata of the specified user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserPoolClient | Client method for returning the configuration information and metadata of the specified user pool app client. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserPoolDomain | Gets information about a domain. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ForgetDevice | Forgets the specified device. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ForgotPassword | <p>Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the <code>Username< |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.GetCSVHeader | Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.GetDevice | Gets the device. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.GetGroup | <p>Gets a group.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.GetIdentityProviderByIdentifier | Gets the specified IdP. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.GetSigningCertificate | <p>This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.</p> <p>Amazon Cog |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.GetUICustomization | Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client. If nothing is set fo |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.GetUser | Gets the user attributes and metadata for a user. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.GetUserAttributeVerificationCode | <p>Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAtt |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.GetUserPoolMfaConfig | Gets the user pool multi-factor authentication (MFA) configuration. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.GlobalSignOut | Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to re |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.InitiateAuth | <p>Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP with <code>InitiateAuth</code>. For more inf |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ListDevices | Lists the sign-in devices that Amazon Cognito has registered to the current user. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ListGroups | <p>Lists the groups associated with a user pool.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ListIdentityProviders | Lists information about all IdPs for a user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ListResourceServers | Lists the resource servers for a user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ListTagsForResource | <p>Lists the tags that are assigned to an Amazon Cognito user pool.</p> <p>A tag is a label that you can apply to user pools to categorize and manage them in di |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserImportJobs | Lists the user import jobs. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserPoolClients | Lists the clients that have been created for the specified user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserPools | Lists the user pools associated with an Amazon Web Services account. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ListUsers | Lists the users in the Amazon Cognito user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ListUsersInGroup | <p>Lists the users in the specified group.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.ResendConfirmationCode | <p>Resends the confirmation (for confirmation of registration) to a specific user in the user pool.</p> <note> <p>This action might generate an SMS text message |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.RespondToAuthChallenge | <p>Responds to the authentication challenge.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require yo |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.RevokeToken | Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token t |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.SetRiskConfiguration | <p>Configures actions on detected risks. To delete the risk configuration for <code>UserPoolId</code> or <code>ClientId</code>, pass null values for all four co |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.SetUICustomization | <p>Sets the user interface (UI) customization information for a user pool's built-in app UI.</p> <p>You can specify app UI customization settings for a single c |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.SetUserMFAPreference | Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be s |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.SetUserPoolMfaConfig | <p>Sets the user pool multi-factor authentication (MFA) configuration.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US t |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.SetUserSettings | <i>This action is no longer supported.</i> You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.SignUp | <p>Registers the user in the specified user pool and creates a user name, password, and user attributes.</p> <note> <p>This action might generate an SMS text me |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.StartUserImportJob | Starts the user import. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.StopUserImportJob | Stops the user import job. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.TagResource | <p>Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by pur |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.UntagResource | Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateAuthEventFeedback | Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateDeviceStatus | Updates the device status. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateGroup | <p>Updates the specified group with the specified attributes.</p> <p>Calling this action requires developer credentials.</p> |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateIdentityProvider | Updates IdP information for a user pool. |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateResourceServer | <p>Updates the name and scopes of resource server. All other fields are read-only.</p> <important> <p>If you don't provide a value for an attribute, it is set t |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserAttributes | <p>Allows a user to update a specific attribute (one at a time).</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPool | <p>Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using <a href="https://docs.aws.amazon.co |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPoolClient | <p>Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using <a href="http |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPoolDomain | <p>Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.</p> <p>You can use this operation to provide the Amazon Resource |
| POST | /#X-Amz-Target=AWSCognitoIdentityProviderService.VerifySoftwareToken | Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. Th |
Showing the first 100 of 101 endpoints; the full list is in the documentation.
Questions
Does the Amazon Cognito Identity Provider API need an API key?
Yes. The Amazon Cognito Identity Provider API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon Cognito Identity Provider API support HTTPS?
Yes, the Amazon Cognito Identity Provider API is served over HTTPS.
How many endpoints does the Amazon Cognito Identity Provider API have?
Its OpenAPI description lists 101 endpoints in version 2016-04-18. The first 100 are shown on this page.
What are alternatives to the Amazon Cognito Identity Provider 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).