Amazon Web Services, Inc.

Amazon Elastic Block Store

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to your snapshots, read data on your…

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

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to
your snapshots, read data on your snapshots, and identify the differences or changes between
two snapshots. If you’re an independent software vendor (ISV) who offers backup services for
Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on
your Amazon EBS volumes through snapshots. This can be done without having to create new volumes
from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.
You can create incremental snapshots directly from data on-premises into volumes and the
cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can
write your on-premises data to an snapshot during a disaster. Then after recovery, you can
restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and
maintain complex mechanisms to copy data to and from Amazon EBS.
This API reference provides detailed information about the actions, data types,
parameters, and errors of the EBS direct APIs. For more information about the elements that
make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User
Guide . For more information about the supported Amazon Web Services Regions, endpoints,
and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in
the Amazon Web Services General Reference .

Endpoints 6

  • POSTComplete snapshot/snapshots/completion/:SnapshotIdSeals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed .…
  • GETGet snapshot block/snapshots/:SnapshotId/blocks/:BlockIndex?blockToken=stringReturns the data in a block in an Amazon Elastic Block Store snapshot. You should always retry requests that receive server ( 5xx ) error responses, and…
  • PUTPut snapshot block/snapshots/:SnapshotId/blocks/:BlockIndexWrites a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending…
  • GETList changed blocks/snapshots/:SecondSnapshotId/changedblocks?firstSnapshotId=string&pageToken=string&maxResults=0&startingBlockIndex=0Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage. You should…
  • GETList snapshot blocks/snapshots/:SnapshotId/blocks?pageToken=string&maxResults=0&startingBlockIndex=0Returns information about the blocks in an Amazon Elastic Block Store snapshot. You should always retry requests that receive server ( 5xx ) error responses,…
  • POSTStart snapshot/snapshotsCreates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes. After creating the snapshot, use PutSnapshotBlock to…

API details

Base URL
https://ebs.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
6 operations on 5 pathsGET 3POST 2PUT 1
Description format
AWS Smithy model, API version 2019-11-02

How to test the Amazon Elastic Block Store 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 Amazon Elastic Block Store 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 “Complete snapshot” (POST /snapshots/completion/:SnapshotId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Elastic Block Store?

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to your snapshots, read data on your… It is listed under Developer tools and has 6 endpoints.

Who publishes the Amazon Elastic Block Store?

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 Amazon Elastic Block Store?

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

How do I authenticate with the Amazon Elastic Block Store?

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

How many endpoints does the Amazon Elastic Block Store have?

6 operations on 5 paths (3 GET, 2 POST, 1 PUT).

Is forking the Amazon Elastic Block Store 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.