AWS Backup
AWS Backup is a fully managed, policy-based data protection service that centralizes and automates backup of data across AWS services including EBS volumes, EC2 instances, RDS databases, DynamoDB tables, EFS file systems, FSx file systems, Storage Gateway volumes, S3, and on-premises data via the AWS Backup gateway. The AWS Backup API allows programmatic management of backup plans, vaults, recovery points, restore jobs, and cross-account, cross-Region copies, authenticated with AWS Signature Version 4 (SigV4).
1 APIs
0 Features
BackupData ProtectionDisaster RecoveryManaged ServiceCompliance
APIs
AWS Backup API
REST API for centrally configuring and managing AWS Backup including backup plans, backup selections, backup vaults, recovery points, restore jobs, framework reports, audit repo...
Collections
AWS Backup API
OPENResources
Sources
opencollection: 1.0.0
info:
name: AWS Backup API
version: '2018-11-15'
request:
auth:
type: apikey
key: Authorization
value: '{{Authorization}}'
placement: header
items:
- info:
name: Backup Plans
type: folder
items:
- info:
name: List backup plans
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/backup/plans
params:
- name: maxResults
value: ''
type: query
- name: nextToken
value: ''
type: query
docs: List backup plans
- info:
name: Create a backup plan
type: http
http:
method: POST
url: https://backup.{region}.amazonaws.com/backup/plans
body:
type: json
data: '{}'
docs: Create a backup plan
- info:
name: Get a backup plan
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/backup/plans/:backupPlanId
params:
- name: backupPlanId
value: ''
type: path
docs: Get a backup plan
- info:
name: Update a backup plan
type: http
http:
method: POST
url: https://backup.{region}.amazonaws.com/backup/plans/:backupPlanId
params:
- name: backupPlanId
value: ''
type: path
body:
type: json
data: '{}'
docs: Update a backup plan
- info:
name: Delete a backup plan
type: http
http:
method: DELETE
url: https://backup.{region}.amazonaws.com/backup/plans/:backupPlanId
params:
- name: backupPlanId
value: ''
type: path
docs: Delete a backup plan
- info:
name: Backup Selections
type: folder
items:
- info:
name: List backup selections
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/backup/plans/:backupPlanId/selections
params:
- name: backupPlanId
value: ''
type: path
docs: List backup selections
- info:
name: Create a backup selection
type: http
http:
method: PUT
url: https://backup.{region}.amazonaws.com/backup/plans/:backupPlanId/selections
params:
- name: backupPlanId
value: ''
type: path
body:
type: json
data: '{}'
docs: Create a backup selection
- info:
name: Backup Vaults
type: folder
items:
- info:
name: List backup vaults
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/backup-vaults
params:
- name: maxResults
value: ''
type: query
- name: nextToken
value: ''
type: query
docs: List backup vaults
- info:
name: Describe a backup vault
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/backup-vaults/:backupVaultName
params:
- name: backupVaultName
value: ''
type: path
docs: Describe a backup vault
- info:
name: Create a backup vault
type: http
http:
method: PUT
url: https://backup.{region}.amazonaws.com/backup-vaults/:backupVaultName
params:
- name: backupVaultName
value: ''
type: path
body:
type: json
data: '{}'
docs: Create a backup vault
- info:
name: Delete a backup vault
type: http
http:
method: DELETE
url: https://backup.{region}.amazonaws.com/backup-vaults/:backupVaultName
params:
- name: backupVaultName
value: ''
type: path
docs: Delete a backup vault
- info:
name: Recovery Points
type: folder
items:
- info:
name: List recovery points in a vault
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/backup-vaults/:backupVaultName/recovery-points
params:
- name: backupVaultName
value: ''
type: path
- name: maxResults
value: ''
type: query
- name: nextToken
value: ''
type: query
docs: List recovery points in a vault
- info:
name: Describe a recovery point
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/backup-vaults/:backupVaultName/recovery-points/:recoveryPointArn
params:
- name: backupVaultName
value: ''
type: path
- name: recoveryPointArn
value: ''
type: path
docs: Describe a recovery point
- info:
name: Delete a recovery point
type: http
http:
method: DELETE
url: https://backup.{region}.amazonaws.com/backup-vaults/:backupVaultName/recovery-points/:recoveryPointArn
params:
- name: backupVaultName
value: ''
type: path
- name: recoveryPointArn
value: ''
type: path
docs: Delete a recovery point
- info:
name: Backup Jobs
type: folder
items:
- info:
name: List backup jobs
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/backup-jobs
params:
- name: maxResults
value: ''
type: query
- name: nextToken
value: ''
type: query
docs: List backup jobs
- info:
name: Start a backup job
type: http
http:
method: PUT
url: https://backup.{region}.amazonaws.com/backup-jobs
body:
type: json
data: '{}'
docs: Start a backup job
- info:
name: Describe a backup job
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/backup-jobs/:backupJobId
params:
- name: backupJobId
value: ''
type: path
docs: Describe a backup job
- info:
name: Stop a backup job
type: http
http:
method: POST
url: https://backup.{region}.amazonaws.com/backup-jobs/:backupJobId
params:
- name: backupJobId
value: ''
type: path
docs: Stop a backup job
- info:
name: Copy Jobs
type: folder
items:
- info:
name: List copy jobs
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/copy-jobs
docs: List copy jobs
- info:
name: Start a copy job
type: http
http:
method: PUT
url: https://backup.{region}.amazonaws.com/copy-jobs
body:
type: json
data: '{}'
docs: Start a copy job
- info:
name: Restore Jobs
type: folder
items:
- info:
name: List restore jobs
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/restore-jobs
docs: List restore jobs
- info:
name: Start a restore job
type: http
http:
method: PUT
url: https://backup.{region}.amazonaws.com/restore-jobs
body:
type: json
data: '{}'
docs: Start a restore job
- info:
name: Frameworks
type: folder
items:
- info:
name: List audit frameworks
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/audit/frameworks
docs: List audit frameworks
- info:
name: Create a framework
type: http
http:
method: POST
url: https://backup.{region}.amazonaws.com/audit/frameworks
body:
type: json
data: '{}'
docs: Create a framework
- info:
name: Report Plans
type: folder
items:
- info:
name: List report plans
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/audit/report-plans
docs: List report plans
- info:
name: Create a report plan
type: http
http:
method: POST
url: https://backup.{region}.amazonaws.com/audit/report-plans
body:
type: json
data: '{}'
docs: Create a report plan
- info:
name: Tags
type: folder
items:
- info:
name: List tags on a resource
type: http
http:
method: GET
url: https://backup.{region}.amazonaws.com/tags/:resourceArn
params:
- name: resourceArn
value: ''
type: path
docs: List tags on a resource
- info:
name: Tag a resource
type: http
http:
method: POST
url: https://backup.{region}.amazonaws.com/tags/:resourceArn
params:
- name: resourceArn
value: ''
type: path
body:
type: json
data: '{}'
docs: Tag a resource
bundled: true