Amazon Web Services, Inc.

AWS Backup

Backup Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation,…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Backup
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.

Endpoints 115

  • PUTAssociate backup vault mpa approval team/backup-vaults/:BackupVaultName/mpaApprovalTeamAssociates an MPA approval team with a backup vault.
  • POSTDisassociate backup vault mpa approval team/backup-vaults/:BackupVaultName/mpaApprovalTeam?delete=Removes the association between an MPA approval team and a backup vault, disabling the MPA approval workflow for restore operations.
  • GETGet legal hold/legal-holds/:LegalHoldIdThis action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
  • DELETECancel legal hold/legal-holds/:LegalHoldId?cancelDescription=string&retainRecordInDays=0Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
  • PUTCreate backup access point/backup-access-point/createCreates a backup access point for an Amazon S3 recovery point. A backup access point provides on-demand, read-only access to the backup data in a recovery…
  • GETList backup plans/backup/plans?nextToken=string&maxResults=0&includeDeleted=trueLists the active backup plans for the account.
  • PUTCreate backup plan/backup/plansCreates 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 that…
  • GETList backup selections/backup/plans/:BackupPlanId/selections?nextToken=string&maxResults=0Returns an array containing metadata of the resources associated with the target backup plan.
  • PUTCreate backup selection/backup/plans/:BackupPlanId/selectionsCreates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically .
  • GETDescribe backup vault/backup-vaults/:BackupVaultName?backupVaultAccountId=stringReturns metadata about a backup vault specified by its name.
  • PUTCreate backup vault/backup-vaults/:BackupVaultNameCreates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key,…
  • DELETEDelete backup vault/backup-vaults/:BackupVaultNameDeletes the backup vault identified by its name. A vault can be deleted only if it is empty.
  • GETList frameworks/audit/frameworks?MaxResults=0&NextToken=stringReturns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
  • POSTCreate framework/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…
  • GETList legal holds/legal-holds?nextToken=string&maxResults=0This action returns metadata about active and previous legal holds.
  • POSTCreate legal hold/legal-holdsCreates 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 legal…
  • PUTCreate logically air gapped backup vault/logically-air-gapped-backup-vaults/:BackupVaultNameCreates a logical container to where backups may be copied. This request includes a name, the Region, the maximum number of retention days, the minimum number…
  • GETList report plans/audit/report-plans?MaxResults=0&NextToken=stringReturns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan .
  • POSTCreate report plan/audit/report-plansCreates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it. If you call…
  • PUTCreate restore access backup vault/restore-access-backup-vaultsCreates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.
  • GETList restore testing plans/restore-testing/plans?MaxResults=0&NextToken=stringReturns a list of restore testing plans.
  • PUTCreate restore testing plan/restore-testing/plansCreates a restore testing plan. The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using…
  • GETList restore testing selections/restore-testing/plans/:RestoreTestingPlanName/selections?MaxResults=0&NextToken=stringReturns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName .
  • PUTCreate restore testing selection/restore-testing/plans/:RestoreTestingPlanName/selectionsThis request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must…
  • GETList tiering configurations/tiering-configurations?maxResults=0&nextToken=stringReturns a list of tiering configurations.
  • PUTCreate tiering configuration/tiering-configurationsCreates a tiering configuration. A tiering configuration enables automatic movement of backup data to a lower-cost storage tier based on the age of backed-up…
  • DELETEDelete backup access point/backup-access-point/delete/:AccessPointArnDeletes a backup access point. This deletes the underlying Amazon S3 access point and, if no other backup access points remain for the recovery point, resumes…
  • GETGet backup plan/backup/plans/:BackupPlanId?versionId=string&MaxScheduledRunsPreview=0Returns BackupPlan details for the specified BackupPlanId . The details are the body of a backup plan in JSON format, in addition to plan metadata.
  • POSTUpdate backup plan/backup/plans/:BackupPlanIdUpdates the specified backup plan. The new version is uniquely identified by its ID.
  • DELETEDelete backup plan/backup/plans/:BackupPlanIdDeletes 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…
  • GETGet backup selection/backup/plans/:BackupPlanId/selections/:SelectionIdReturns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
  • DELETEDelete backup selection/backup/plans/:BackupPlanId/selections/:SelectionIdDeletes the resource selection associated with a backup plan that is specified by the SelectionId .
  • GETGet backup vault access policy/backup-vaults/:BackupVaultName/access-policyReturns the access policy document that is associated with the named backup vault.
  • PUTPut backup vault access policy/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…
  • DELETEDelete backup vault access policy/backup-vaults/:BackupVaultName/access-policyDeletes the policy document that manages permissions on a backup vault.
  • PUTPut backup vault lock configuration/backup-vaults/:BackupVaultName/vault-lockApplies 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 prevents…
  • DELETEDelete backup vault lock configuration/backup-vaults/:BackupVaultName/vault-lockDeletes Backup Vault Lock from a backup vault specified by a backup vault name. If the Vault Lock configuration is immutable, then you cannot delete Vault…
  • GETGet backup vault notifications/backup-vaults/:BackupVaultName/notification-configurationReturns event notifications for the specified backup vault.
  • PUTPut backup vault notifications/backup-vaults/:BackupVaultName/notification-configurationTurns on notifications on a backup vault for the specified topic and events.
  • DELETEDelete backup vault notifications/backup-vaults/:BackupVaultName/notification-configurationDeletes event notifications for the specified backup vault.
  • GETDescribe framework/audit/frameworks/:FrameworkNameReturns the framework details for the specified FrameworkName .
  • PUTUpdate framework/audit/frameworks/:FrameworkNameUpdates the specified framework.
  • DELETEDelete framework/audit/frameworks/:FrameworkNameDeletes the framework specified by a framework name.
  • GETDescribe recovery point/backup-vaults/:BackupVaultName/recovery-points/:RecoveryPointArn?backupVaultAccountId=stringReturns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
  • POSTUpdate recovery point lifecycle/backup-vaults/:BackupVaultName/recovery-points/:RecoveryPointArnSets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup…
  • DELETEDelete recovery point/backup-vaults/:BackupVaultName/recovery-points/:RecoveryPointArnDeletes the recovery point specified by a recovery point ID. If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the…
  • GETDescribe report plan/audit/report-plans/:ReportPlanNameReturns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
  • PUTUpdate report plan/audit/report-plans/:ReportPlanNameUpdates the specified report plan.
  • DELETEDelete report plan/audit/report-plans/:ReportPlanNameDeletes the report plan specified by a report plan name.
  • GETGet restore testing plan/restore-testing/plans/:RestoreTestingPlanNameReturns RestoreTestingPlan details for the specified RestoreTestingPlanName . The details are the body of a restore testing plan in JSON format, in addition…
  • PUTUpdate restore testing plan/restore-testing/plans/:RestoreTestingPlanNameThis request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created. RecoveryPointSelection…
  • DELETEDelete restore testing plan/restore-testing/plans/:RestoreTestingPlanNameThis request deletes the specified restore testing plan. Deletion can only successfully occur if all associated restore testing selections are deleted first.
  • GETGet restore testing selection/restore-testing/plans/:RestoreTestingPlanName/selections/:RestoreTestingSelectionNameReturns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
  • PUTUpdate restore testing selection/restore-testing/plans/:RestoreTestingPlanName/selections/:RestoreTestingSelectionNameUpdates the specified restore testing selection. Most elements except the RestoreTestingSelectionName can be updated with this request. You can use either…
  • DELETEDelete restore testing selection/restore-testing/plans/:RestoreTestingPlanName/selections/:RestoreTestingSelectionNameInput the Restore Testing Plan name and Restore Testing Selection name. All testing selections associated with a restore testing plan must be deleted before…
  • GETGet tiering configuration/tiering-configurations/:TieringConfigurationNameReturns TieringConfiguration details for the specified TieringConfigurationName . The details are the body of a tiering configuration in JSON format, in…
  • PUTUpdate tiering configuration/tiering-configurations/:TieringConfigurationNameThis request will send changes to your specified tiering configuration. TieringConfigurationName cannot be updated after it is created. ResourceSelection can…
  • DELETEDelete tiering configuration/tiering-configurations/:TieringConfigurationNameDeletes the tiering configuration specified by a tiering configuration name.
  • GETDescribe backup access point/backup-access-point/:AccessPointArnReturns metadata about a backup access point, including its status and the details of the underlying Amazon S3 access point. After a backup access point…
  • GETDescribe backup job/backup-jobs/:BackupJobIdReturns backup job details for the specified BackupJobId .
  • POSTStop backup job/backup-jobs/:BackupJobIdAttempts to cancel a job to create a one-time backup of a resource. This action is not supported for the following services: Amazon Aurora Amazon DocumentDB…
  • GETDescribe copy job/copy-jobs/:CopyJobIdReturns metadata associated with creating a copy of a resource.
  • GETDescribe global settings/global-settingsDescribes whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party…
  • PUTUpdate global settings/global-settingsUpdates whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval,…
  • GETDescribe protected resource/resources/:ResourceArnReturns 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…
  • GETDescribe region settings/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…
  • PUTUpdate region settings/account-settingsUpdates the current service opt-in settings for the Region. Use the DescribeRegionSettings API to determine the resource types that are supported.
  • GETDescribe report job/audit/report-jobs/:ReportJobIdReturns the details associated with creating a report as specified by its ReportJobId .
  • GETDescribe restore job/restore-jobs/:RestoreJobIdReturns metadata associated with a restore job that is specified by a job ID.
  • GETDescribe scan job/scan/jobs/:ScanJobIdReturns scan job details for the specified ScanJobID.
  • POSTDisassociate recovery point/backup-vaults/:BackupVaultName/recovery-points/:RecoveryPointArn/disassociateDeletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS.…
  • DELETEDisassociate recovery point from parent/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.
  • GETExport backup plan template/backup/plans/:BackupPlanId/toTemplateReturns the backup plan that is specified by the plan ID as a backup template.
  • POSTGet backup plan from jSON/backup/template/json/toPlanReturns a valid JSON document specifying a backup plan or an error.
  • GETGet backup plan from template/backup/template/plans/:BackupPlanTemplateId/toPlanReturns the template specified by its templateId as a backup plan.
  • GETGet pITR malware scan results/scan/pitr-malware-scan-results?RecoveryPointArn=string&BackupVaultName=string&ScanEndTime=string&MalwareScanner=stringReturns the malware scan results for a specified point in time within a continuous (point-in-time recovery) backup.
  • GETGet recovery point index details/backup-vaults/:BackupVaultName/recovery-points/:RecoveryPointArn/indexThis operation returns the metadata and details specific to the backup index associated with the specified recovery point.
  • POSTUpdate recovery point index settings/backup-vaults/:BackupVaultName/recovery-points/:RecoveryPointArn/indexThis operation updates the settings of a recovery point index. Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn
  • GETGet recovery point restore metadata/backup-vaults/:BackupVaultName/recovery-points/:RecoveryPointArn/restore-metadata?backupVaultAccountId=stringReturns a set of metadata key-value pairs that were used to create the backup.
  • GETGet restore job metadata/restore-jobs/:RestoreJobId/metadataThis request returns the metadata for the specified restore job.
  • GETGet restore testing inferred metadata/restore-testing/inferred-metadata?BackupVaultAccountId=string&BackupVaultName=string&RecoveryPointArn=stringThis request returns the minimal required set of metadata needed to start a restore job with secure default settings. BackupVaultName and RecoveryPointArn are…
  • GETGet supported resource types/supported-resource-typesReturns the Amazon Web Services resource types supported by Backup.
  • GETList backup access points/backup-access-point?MaxResults=0&NextToken=stringReturns a list of the backup access points in your account and Region.
  • POSTList backup access points by recovery point/backup-access-point/recovery-point/:RecoveryPointArn?MaxResults=0&NextToken=stringReturns the backup access points associated with the specified recovery point. If you own the recovery point and have shared it with other accounts, the…
  • POSTList backup access points by resource/backup-access-point/resource/:ResourceArn?MaxResults=0&NextToken=stringReturns the backup access points associated with the specified resource, such as an Amazon S3 bucket.
  • GETList backup job summaries/audit/backup-job-summaries?AccountId=string&State=string&ResourceType=string&MessageCategory=string&AggregationPeriod=string&MaxResults=0&NextToken=stringThis is a request for a summary of backup jobs created or running within the most recent 14 days. You can include parameters AccountID, State, ResourceType,…
  • GETList backup jobs/backup-jobs?nextToken=string&maxResults=0&resourceArn=string&state=string&backupVaultName=string&createdBefore=string&createdAfter=string&resourceType=string&accountId=string&completeAfter=string&completeBefore=string&parentJobId=string&messageCategory=stringReturns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools .
  • PUTStart backup job/backup-jobsStarts an on-demand backup job for the specified resource.
  • GETList backup plan templates/backup/template/plans?nextToken=string&maxResults=0Lists the backup plan templates.
  • GETList backup plan versions/backup/plans/:BackupPlanId/versions?nextToken=string&maxResults=0Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version…
  • GETList backup vaults/backup-vaults?vaultType=string&shared=true&nextToken=string&maxResults=0Returns a list of recovery point storage containers along with information about them.
  • GETList copy job summaries/audit/copy-job-summaries?AccountId=string&State=string&ResourceType=string&MessageCategory=string&AggregationPeriod=string&MaxResults=0&NextToken=stringThis request obtains a list of copy jobs created or running within the the most recent 14 days. You can include parameters AccountID, State, ResourceType,…
  • GETList copy jobs/copy-jobs?nextToken=string&maxResults=0&resourceArn=string&state=string&createdBefore=string&createdAfter=string&resourceType=string&destinationVaultArn=string&accountId=string&completeBefore=string&completeAfter=string&parentJobId=string&messageCategory=string&sourceRecoveryPointArn=stringReturns metadata about your copy jobs.
  • PUTStart copy job/copy-jobsStarts a job to create a one-time copy of the specified resource. Does not support continuous backups. See Copy job retry for information on how Backup…
  • GETList indexed recovery points/indexes/recovery-point?nextToken=string&maxResults=0&sourceResourceArn=string&createdBefore=string&createdAfter=string&resourceType=string&indexStatus=stringThis operation returns a list of recovery points that have an associated index, belonging to the specified account. Optional parameters you can include are:…
  • GETList protected resources/resources?nextToken=string&maxResults=0Returns an array of resources with recovery points created by Backup (regardless of the recovery point's status ), including the time the resource was saved,…
  • GETList protected resources by backup vault/backup-vaults/:BackupVaultName/resources?backupVaultAccountId=string&nextToken=string&maxResults=0This request lists the protected resources corresponding to each backup vault.
  • GETList recovery points by backup vault/backup-vaults/:BackupVaultName/recovery-points?backupVaultAccountId=string&nextToken=string&maxResults=0&resourceArn=string&resourceType=string&backupPlanId=string&createdBefore=string&createdAfter=string&parentRecoveryPointArn=stringReturns detailed information about the recovery points stored in a backup vault.
  • GETList recovery points by legal hold/legal-holds/:LegalHoldId/recovery-points?nextToken=string&maxResults=0This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
  • GETList recovery points by resource/resources/:ResourceArn/recovery-points?nextToken=string&maxResults=0&managedByAWSBackupOnly=trueThe information about the recovery points of the type specified by a resource Amazon Resource Name (ARN). For Amazon EFS and Amazon EC2, this action only…
  • GETList report jobs/audit/report-jobs?ReportPlanName=string&CreationBefore=string&CreationAfter=string&Status=string&MaxResults=0&NextToken=stringReturns details about your report jobs.
  • GETList restore access backup vaults/logically-air-gapped-backup-vaults/:BackupVaultName/restore-access-backup-vaults?nextToken=string&maxResults=0Returns a list of restore access backup vaults associated with a specified backup vault.
  • GETList restore job summaries/audit/restore-job-summaries?AccountId=string&State=string&ResourceType=string&AggregationPeriod=string&MaxResults=0&NextToken=stringThis request obtains a summary of restore jobs created or running within the the most recent 14 days. You can include parameters AccountID, State,…
  • GETList restore jobs/restore-jobs?nextToken=string&maxResults=0&accountId=string&resourceType=string&createdBefore=string&createdAfter=string&status=string&completeBefore=string&completeAfter=string&restoreTestingPlanArn=string&parentJobId=stringReturns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
  • PUTStart restore job/restore-jobsRecovers the saved resource identified by an Amazon Resource Name (ARN).
  • GETList restore jobs by protected resource/resources/:ResourceArn/restore-jobs?status=string&recoveryPointCreationDateAfter=string&recoveryPointCreationDateBefore=string&nextToken=string&maxResults=0This returns restore jobs that contain the specified protected resource. You must include ResourceArn . You can optionally include NextToken , ByStatus ,…
  • GETList scan job summaries/audit/scan-job-summaries?AccountId=string&ResourceType=string&MalwareScanner=string&ScanResultStatus=string&State=string&AggregationPeriod=string&MaxResults=0&NextToken=stringThis is a request for a summary of scan jobs created or running within the most recent 14 days.
  • GETList scan jobs/scan/jobs?ByAccountId=string&ByBackupVaultName=string&ByCompleteAfter=string&ByCompleteBefore=string&ByMalwareScanner=string&ByRecoveryPointArn=string&ByResourceArn=string&ByResourceType=string&ByScanResultStatus=string&ByState=string&MaxResults=0&NextToken=stringReturns a list of existing scan jobs for an authenticated account for the last 30 days.
  • GETList tags/tags/:ResourceArn?nextToken=string&maxResults=0Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault. This operation returns results depending on the…
  • POSTTag resource/tags/:ResourceArnAssigns a set of key-value pairs to a resource.
  • PUTPut restore validation result/restore-jobs/:RestoreJobId/validationsThis request allows you to send your independent self-run restore test validation results. RestoreJobId and ValidationStatus are required. Optionally, you can…
  • DELETERevoke restore access backup vault/logically-air-gapped-backup-vaults/:BackupVaultName/restore-access-backup-vaults/:RestoreAccessBackupVaultArn?requesterComment=stringRevokes access to a restore access backup vault, removing the ability to restore from its recovery points and permanently deleting the vault.
  • POSTStart report job/audit/report-jobs/:ReportPlanNameStarts an on-demand report job for the specified report plan.
  • PUTStart scan job/scan/jobStarts scanning jobs for specific resources.
  • POSTUntag resource/untag/:ResourceArnRemoves a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN) This API is not supported for…

API details

Base URL
https://backup.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
115 operations on 75 pathsGET 59PUT 25DELETE 16POST 15
Description format
AWS Smithy model, API version 2018-11-15

How to test the AWS Backup in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Backup collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate backup vault mpa approval team” (PUT /backup-vaults/:BackupVaultName/mpaApprovalTeam), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Backup?

Backup Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation,… It is listed under Developer tools and has 115 endpoints.

Who publishes the AWS Backup?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Backup?

Requests go to https://backup.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Backup?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Backup have?

115 operations on 75 paths (59 GET, 25 PUT, 16 DELETE, 15 POST).

Is forking the AWS Backup free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.