Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Backup Backup Plans API

The Backup Plans API from AWS Backup — 2 operation(s) for backup plans.

AWS Backup Backup Plans API is one of 11 APIs that AWS Backup publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Backup Plans. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 2018-11-15.

Requests are made against a single base URL, https://backup.{region}.amazonaws.com.

5 operations 2 paths 0 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2018-11-15
Base URL
https://backup.us-east-1.amazonaws.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

AWS Backup Backup Plans API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (SigV4). By default, every request must be authenticated.

  • SigV4 — AWS Signature Version 4 signed Authorization header

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Backup Plans 5
GET
/backup/plans
List backup plans
ListBackupPlans 2 params → 200
POST
/backup/plans
Create a backup plan
CreateBackupPlan body → 200
GET
/backup/plans/{backupPlanId}
Get a backup plan
GetBackupPlan 1 param → 200
POST
/backup/plans/{backupPlanId}
Update a backup plan
UpdateBackupPlan 1 param body → 200
DELETE
/backup/plans/{backupPlanId}
Delete a backup plan
DeleteBackupPlan 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-backup-backup-plans-api-openapi.yml Raw ↑

Other APIs AWS Backup publishes across the network.

AWS Backup API
AWS Backup Backup Jobs API
AWS Backup Backup Selections API
AWS Backup Backup Vaults API
AWS Backup Copy Jobs API
AWS Backup Frameworks API
AWS Backup Recovery Points API
AWS Backup Report Plans API
AWS Backup Restore Jobs API
AWS Backup Tags API