Skip to content

Amazon Simple Systems Manager (SSM) API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.</p> <p>This reference is intended to be used with the <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/">Amazon Web Services Systems Manager User Guide</a>. To get started, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html">Setting up Amazon Web Services Systems Manager</a>.</p> <p class="title"> <b>Related resources</b> </p> <ul> <li> <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> </li> <li> <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the <i> <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html">Systems Manager Automation runbook reference</a> </i>.</p> </li> <li> <p>For information about AppConfig, a capability of Systems Manager, see the <i> <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/">AppConfig User Guide</a> </i> and the <i> <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/">AppConfig API Reference</a> </i>.</p> </li> <li> <p>For information about Incident Manager, a capability of Systems Manager, see the <i> <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/">Systems Manager Incident Manager User Guide</a> </i> and the <i> <a href="https://docs.aws.amazon.com/incident-manager/latest/APIReference/">Systems Manager Incident Manager API Reference</a> </i>.</p> </li> </ul>

Amazon Simple Systems Manager (SSM) is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 138 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2014-11-06
Endpoints
138
Spec updated
2020-05-07

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=AmazonSSM.AddTagsToResource<p>Adds or overwrites one or more tags for the specified resource. <i>Tags</i> are metadata that you can assign to your automations, documents, managed nodes, m
POST/#X-Amz-Target=AmazonSSM.AssociateOpsItemRelatedItemAssociates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incid
POST/#X-Amz-Target=AmazonSSM.CancelCommandAttempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
POST/#X-Amz-Target=AmazonSSM.CancelMaintenanceWindowExecutionStops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in pro
POST/#X-Amz-Target=AmazonSSM.CreateActivation<p>Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Servic
POST/#X-Amz-Target=AmazonSSM.CreateAssociationA State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software
POST/#X-Amz-Target=AmazonSSM.CreateAssociationBatch<p>Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.</p> <p>When you associate a
POST/#X-Amz-Target=AmazonSSM.CreateDocumentCreates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more
POST/#X-Amz-Target=AmazonSSM.CreateMaintenanceWindow<p>Creates a new maintenance window.</p> <note> <p>The value you specify for <code>Duration</code> determines the specific end time for the maintenance window b
POST/#X-Amz-Target=AmazonSSM.CreateOpsItem<p>Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see <a href="https://d
POST/#X-Amz-Target=AmazonSSM.CreateOpsMetadataIf you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new applic
POST/#X-Amz-Target=AmazonSSM.CreatePatchBaseline<p>Creates a patch baseline.</p> <note> <p>For information about valid key-value pairs in <code>PatchFilters</code> for each supported operating system type, se
POST/#X-Amz-Target=AmazonSSM.CreateResourceDataSync<p>A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sy
POST/#X-Amz-Target=AmazonSSM.DeleteActivationDeletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes.
POST/#X-Amz-Target=AmazonSSM.DeleteAssociation<p>Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by us
POST/#X-Amz-Target=AmazonSSM.DeleteDocument<p>Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.</p> <p>Before you delete the docum
POST/#X-Amz-Target=AmazonSSM.DeleteInventoryDelete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom in
POST/#X-Amz-Target=AmazonSSM.DeleteMaintenanceWindowDeletes a maintenance window.
POST/#X-Amz-Target=AmazonSSM.DeleteOpsMetadataDelete OpsMetadata related to an application.
POST/#X-Amz-Target=AmazonSSM.DeleteParameterDelete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
POST/#X-Amz-Target=AmazonSSM.DeleteParametersDelete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
POST/#X-Amz-Target=AmazonSSM.DeletePatchBaselineDeletes a patch baseline.
POST/#X-Amz-Target=AmazonSSM.DeleteResourceDataSyncDeletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Del
POST/#X-Amz-Target=AmazonSSM.DeleteResourcePolicyDeletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage yo
POST/#X-Amz-Target=AmazonSSM.DeregisterManagedInstanceRemoves the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command o
POST/#X-Amz-Target=AmazonSSM.DeregisterPatchBaselineForPatchGroupRemoves a patch group from a patch baseline.
POST/#X-Amz-Target=AmazonSSM.DeregisterTargetFromMaintenanceWindowRemoves a target from a maintenance window.
POST/#X-Amz-Target=AmazonSSM.DeregisterTaskFromMaintenanceWindowRemoves a task from a maintenance window.
POST/#X-Amz-Target=AmazonSSM.DescribeActivationsDescribes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role
POST/#X-Amz-Target=AmazonSSM.DescribeAssociationDescribes the association for the specified target or managed node. If you created the association by using the <code>Targets</code> parameter, then you must re
POST/#X-Amz-Target=AmazonSSM.DescribeAssociationExecutionTargetsViews information about a specific execution of a specific association.
POST/#X-Amz-Target=AmazonSSM.DescribeAssociationExecutionsViews all executions for a specific association ID.
POST/#X-Amz-Target=AmazonSSM.DescribeAutomationExecutionsProvides details about all active and terminated Automation executions.
POST/#X-Amz-Target=AmazonSSM.DescribeAutomationStepExecutionsInformation about all active and terminated step executions in an Automation workflow.
POST/#X-Amz-Target=AmazonSSM.DescribeAvailablePatchesLists all patches eligible to be included in a patch baseline.
POST/#X-Amz-Target=AmazonSSM.DescribeDocumentDescribes the specified Amazon Web Services Systems Manager document (SSM document).
POST/#X-Amz-Target=AmazonSSM.DescribeDocumentPermissionDescribes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is sh
POST/#X-Amz-Target=AmazonSSM.DescribeEffectiveInstanceAssociationsAll associations for the managed node(s).
POST/#X-Amz-Target=AmazonSSM.DescribeEffectivePatchesForPatchBaselineRetrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.
POST/#X-Amz-Target=AmazonSSM.DescribeInstanceAssociationsStatusThe status of the associations for the managed node(s).
POST/#X-Amz-Target=AmazonSSM.DescribeInstanceInformation<p>Describes one or more of your managed nodes, including information about the operating system platform, the version of SSM Agent installed on the managed nod
POST/#X-Amz-Target=AmazonSSM.DescribeInstancePatchStatesRetrieves the high-level patch state of one or more managed nodes.
POST/#X-Amz-Target=AmazonSSM.DescribeInstancePatchStatesForPatchGroupRetrieves the high-level patch state for the managed nodes in the specified patch group.
POST/#X-Amz-Target=AmazonSSM.DescribeInstancePatchesRetrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
POST/#X-Amz-Target=AmazonSSM.DescribeInventoryDeletionsDescribes a specific delete inventory operation.
POST/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowExecutionTaskInvocationsRetrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
POST/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowExecutionTasksFor a given maintenance window execution, lists the tasks that were run.
POST/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowExecutionsLists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about task
POST/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowScheduleRetrieves information about upcoming executions of a maintenance window.
POST/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowTargetsLists the targets registered with the maintenance window.
POST/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowTasks<p>Lists the tasks in a maintenance window.</p> <note> <p>For maintenance window tasks without a specified target, you can't supply values for <code>--max-error
POST/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowsRetrieves the maintenance windows in an Amazon Web Services account.
POST/#X-Amz-Target=AmazonSSM.DescribeMaintenanceWindowsForTargetRetrieves information about the maintenance window targets or tasks that a managed node is associated with.
POST/#X-Amz-Target=AmazonSSM.DescribeOpsItems<p>Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see <a href="htt
POST/#X-Amz-Target=AmazonSSM.DescribeParameters<p>Get information about a parameter.</p> <p>Request results are returned on a best-effort basis. If you specify <code>MaxResults</code> in the request, the res
POST/#X-Amz-Target=AmazonSSM.DescribePatchBaselinesLists the patch baselines in your Amazon Web Services account.
POST/#X-Amz-Target=AmazonSSM.DescribePatchGroupStateReturns high-level aggregated patch compliance state information for a patch group.
POST/#X-Amz-Target=AmazonSSM.DescribePatchGroupsLists all patch groups that have been registered with patch baselines.
POST/#X-Amz-Target=AmazonSSM.DescribePatchProperties<p>Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can
POST/#X-Amz-Target=AmazonSSM.DescribeSessionsRetrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
POST/#X-Amz-Target=AmazonSSM.DisassociateOpsItemRelatedItemDeletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident
POST/#X-Amz-Target=AmazonSSM.GetAutomationExecutionGet detailed information about a particular Automation execution.
POST/#X-Amz-Target=AmazonSSM.GetCalendarState<p>Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, <code>GetCalendarStat
POST/#X-Amz-Target=AmazonSSM.GetCommandInvocation<p>Returns detailed information about command execution for an invocation or plugin.</p> <p> <code>GetCommandInvocation</code> only gives the execution status o
POST/#X-Amz-Target=AmazonSSM.GetConnectionStatusRetrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
POST/#X-Amz-Target=AmazonSSM.GetDefaultPatchBaseline<p>Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a d
POST/#X-Amz-Target=AmazonSSM.GetDeployablePatchSnapshotForInstance<p>Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the <code>AWS-RunPatchBaseline</code> Systems Mana
POST/#X-Amz-Target=AmazonSSM.GetDocumentGets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
POST/#X-Amz-Target=AmazonSSM.GetInventoryQuery inventory information. This includes managed node status, such as <code>Stopped</code> or <code>Terminated</code>.
POST/#X-Amz-Target=AmazonSSM.GetInventorySchemaReturn a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
POST/#X-Amz-Target=AmazonSSM.GetMaintenanceWindowRetrieves a maintenance window.
POST/#X-Amz-Target=AmazonSSM.GetMaintenanceWindowExecutionRetrieves details about a specific a maintenance window execution.
POST/#X-Amz-Target=AmazonSSM.GetMaintenanceWindowExecutionTaskRetrieves the details about a specific task run as part of a maintenance window execution.
POST/#X-Amz-Target=AmazonSSM.GetMaintenanceWindowExecutionTaskInvocationRetrieves information about a specific task running on a specific target.
POST/#X-Amz-Target=AmazonSSM.GetMaintenanceWindowTask<p>Retrieves the details of a maintenance window task.</p> <note> <p>For maintenance window tasks without a specified target, you can't supply values for <code>
POST/#X-Amz-Target=AmazonSSM.GetOpsItem<p>Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For
POST/#X-Amz-Target=AmazonSSM.GetOpsMetadataView operational metadata related to an application in Application Manager.
POST/#X-Amz-Target=AmazonSSM.GetOpsSummaryView a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Ma
POST/#X-Amz-Target=AmazonSSM.GetParameter<p>Get information about a single parameter by specifying the parameter name.</p> <note> <p>To get information about more than one parameter at a time, use the
POST/#X-Amz-Target=AmazonSSM.GetParameterHistory<p>Retrieves the history of all changes to a parameter.</p> <important> <p>If you change the KMS key alias for the KMS key used to encrypt a parameter, then you
POST/#X-Amz-Target=AmazonSSM.GetParameters<p>Get information about one or more parameters by specifying multiple parameter names.</p> <note> <p>To get information about a single parameter, you can use t
POST/#X-Amz-Target=AmazonSSM.GetParametersByPath<p>Retrieve information about one or more parameters in a specific hierarchy. </p> <p>Request results are returned on a best-effort basis. If you specify <code>
POST/#X-Amz-Target=AmazonSSM.GetPatchBaselineRetrieves information about a patch baseline.
POST/#X-Amz-Target=AmazonSSM.GetPatchBaselineForPatchGroupRetrieves the patch baseline that should be used for the specified patch group.
POST/#X-Amz-Target=AmazonSSM.GetResourcePoliciesReturns an array of the <code>Policy</code> object.
POST/#X-Amz-Target=AmazonSSM.GetServiceSetting<p> <code>ServiceSetting</code> is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service
POST/#X-Amz-Target=AmazonSSM.LabelParameterVersion<p>A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Mana
POST/#X-Amz-Target=AmazonSSM.ListAssociationVersionsRetrieves all versions of an association for a specific association ID.
POST/#X-Amz-Target=AmazonSSM.ListAssociationsReturns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State
POST/#X-Amz-Target=AmazonSSM.ListCommandInvocationsAn invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one manage
POST/#X-Amz-Target=AmazonSSM.ListCommandsLists the commands requested by users of the Amazon Web Services account.
POST/#X-Amz-Target=AmazonSSM.ListComplianceItemsFor a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource
POST/#X-Amz-Target=AmazonSSM.ListComplianceSummariesReturns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, o
POST/#X-Amz-Target=AmazonSSM.ListDocumentMetadataHistoryInformation about approval reviews for a version of a change template in Change Manager.
POST/#X-Amz-Target=AmazonSSM.ListDocumentVersionsList all versions for a document.
POST/#X-Amz-Target=AmazonSSM.ListDocumentsReturns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request
POST/#X-Amz-Target=AmazonSSM.ListInventoryEntriesA list of inventory items returned by the request.
POST/#X-Amz-Target=AmazonSSM.ListOpsItemEventsReturns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated w
POST/#X-Amz-Target=AmazonSSM.ListOpsItemRelatedItemsLists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
POST/#X-Amz-Target=AmazonSSM.ListOpsMetadataAmazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.

Showing the first 100 of 138 endpoints; the full list is in the documentation.

Questions

Does the Amazon Simple Systems Manager (SSM) API need an API key?

Yes. The Amazon Simple Systems Manager (SSM) API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon Simple Systems Manager (SSM) API support HTTPS?

Yes, the Amazon Simple Systems Manager (SSM) API is served over HTTPS.

How many endpoints does the Amazon Simple Systems Manager (SSM) API have?

Its OpenAPI description lists 138 endpoints in version 2014-11-06. The first 100 are shown on this page.

What are alternatives to the Amazon Simple Systems Manager (SSM) 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).