Skip to content

AWS Backup API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<fullname>Backup</fullname> <p>Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.</p>

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2018-11-15
Endpoints
72
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
DELETE/legal-holds/{legalHoldId}#cancelDescriptionThis action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
GET/backup/plans/Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation a
PUT/backup/plans/<p>Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks tha
GET/backup/plans/{backupPlanId}/selections/Returns an array containing metadata of the resources associated with the target backup plan.
PUT/backup/plans/{backupPlanId}/selections/Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see <a href="https://docs.aws.amazon.com/aws-backup/latest/d
GET/backup-vaults/{backupVaultName}Returns metadata about a backup vault specified by its name.
PUT/backup-vaults/{backupVaultName}<p>Creates a logical container where backups are stored. A <code>CreateBackupVault</code> request includes a name, optionally one or more resource tags, an encr
DELETE/backup-vaults/{backupVaultName}Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
GET/audit/frameworksReturns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
POST/audit/frameworksCreates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built cu
GET/legal-holds/This action returns metadata about active and previous legal holds.
POST/legal-holds/This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the
GET/audit/report-plansReturns a list of your report plans. For detailed information about a single report plan, use <code>DescribeReportPlan</code>.
POST/audit/report-plans<p>Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.</p> <p>If you
POST/backup/plans/{backupPlanId}Updates an existing backup plan identified by its <code>backupPlanId</code> with the input document in JSON format. The new version is uniquely identified by a
DELETE/backup/plans/{backupPlanId}Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the curr
GET/backup/plans/{backupPlanId}/selections/{selectionId}Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
DELETE/backup/plans/{backupPlanId}/selections/{selectionId}Deletes the resource selection associated with a backup plan that is specified by the <code>SelectionId</code>.
GET/backup-vaults/{backupVaultName}/access-policyReturns the access policy document that is associated with the named backup vault.
PUT/backup-vaults/{backupVaultName}/access-policySets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in
DELETE/backup-vaults/{backupVaultName}/access-policyDeletes the policy document that manages permissions on a backup vault.
PUT/backup-vaults/{backupVaultName}/vault-lock<p>Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevent
DELETE/backup-vaults/{backupVaultName}/vault-lock<p>Deletes Backup Vault Lock from a backup vault specified by a backup vault name.</p> <p>If the Vault Lock configuration is immutable, then you cannot delete V
GET/backup-vaults/{backupVaultName}/notification-configurationReturns event notifications for the specified backup vault.
PUT/backup-vaults/{backupVaultName}/notification-configurationTurns on notifications on a backup vault for the specified topic and events.
DELETE/backup-vaults/{backupVaultName}/notification-configurationDeletes event notifications for the specified backup vault.
GET/audit/frameworks/{frameworkName}Returns the framework details for the specified <code>FrameworkName</code>.
PUT/audit/frameworks/{frameworkName}Updates an existing framework identified by its <code>FrameworkName</code> with the input document in JSON format.
DELETE/audit/frameworks/{frameworkName}Deletes the framework specified by a framework name.
GET/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
POST/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}<p>Sets the transition lifecycle of a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires
DELETE/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}<p>Deletes the recovery point specified by a recovery point ID.</p> <p>If the recovery point ID belongs to a continuous backup, calling this endpoint deletes th
GET/audit/report-plans/{reportPlanName}Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
PUT/audit/report-plans/{reportPlanName}Updates an existing report plan identified by its <code>ReportPlanName</code> with the input document in JSON format.
DELETE/audit/report-plans/{reportPlanName}Deletes the report plan specified by a report plan name.
GET/backup-jobs/{backupJobId}Returns backup job details for the specified <code>BackupJobId</code>.
POST/backup-jobs/{backupJobId}<p>Attempts to cancel a job to create a one-time backup of a resource.</p> <p>This action is not supported for the following services: Amazon FSx for Windows Fi
GET/copy-jobs/{copyJobId}Returns metadata associated with creating a copy of a resource.
GET/global-settingsDescribes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organ
PUT/global-settingsUpdates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account.
GET/resources/{resourceArn}Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type o
GET/account-settingsReturns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this
PUT/account-settingsUpdates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, Backup tries to protect that service's resources in this
GET/audit/report-jobs/{reportJobId}Returns the details associated with creating a report as specified by its <code>ReportJobId</code>.
GET/restore-jobs/{restoreJobId}Returns metadata associated with a restore job that is specified by a job ID.
POST/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/disassociate<p>Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS.
DELETE/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/parentAssociationThis action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
GET/backup/plans/{backupPlanId}/toTemplate/Returns the backup plan that is specified by the plan ID as a backup template.
GET/backup/plans/{backupPlanId}/Returns <code>BackupPlan</code> details for the specified <code>BackupPlanId</code>. The details are the body of a backup plan in JSON format, in addition to pl
POST/backup/template/json/toPlanReturns a valid JSON document specifying a backup plan or an error.
GET/backup/template/plans/{templateId}/toPlanReturns the template specified by its <code>templateId</code> as a backup plan.
GET/legal-holds/{legalHoldId}/This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
GET/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/restore-metadataReturns a set of metadata key-value pairs that were used to create the backup.
GET/supported-resource-typesReturns the Amazon Web Services resource types supported by Backup.
GET/backup-jobs/Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these <a href="https://doc
GET/backup/template/plansReturns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
GET/backup/plans/{backupPlanId}/versions/Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs
GET/backup-vaults/Returns a list of recovery point storage containers along with information about them.
GET/copy-jobs/Returns metadata about your copy jobs.
GET/resources/Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a
GET/backup-vaults/{backupVaultName}/recovery-points/Returns detailed information about the recovery points stored in a backup vault.
GET/legal-holds/{legalHoldId}/recovery-pointsThis action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
GET/resources/{resourceArn}/recovery-points/<p>Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).</p> <note> <p>For Amazon EFS and A
GET/audit/report-jobsReturns details about your report jobs.
GET/restore-jobs/Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
GET/tags/{resourceArn}/<p>Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.</p> <p> <code>ListTags</code> only works for resource ty
PUT/backup-jobsStarts an on-demand backup job for the specified resource.
PUT/copy-jobs<p>Starts a job to create a one-time copy of the specified resource.</p> <p>Does not support continuous backups.</p>
POST/audit/report-jobs/{reportPlanName}Starts an on-demand report job for the specified report plan.
PUT/restore-jobsRecovers the saved resource identified by an Amazon Resource Name (ARN).
POST/tags/{resourceArn}Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
POST/untag/{resourceArn}Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

Questions

Does the AWS Backup API need an API key?

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

Does the AWS Backup API support HTTPS?

Yes, the AWS Backup API is served over HTTPS.

How many endpoints does the AWS Backup API have?

Its OpenAPI description lists 72 endpoints in version 2018-11-15. All of them are shown on this page.

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