brackets-curlyAPI

Authentication

All Datafy endpoints use a bearer token for authentication and to identify your account. Actions can only be performed on the account associated with the provided token.

API tokens can be generated by an admin in the Datafy app.

Volume Lifecycle

Create snapshot of a volume

post

Create a snapshot of the specified volume

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
volumeIdstringRequiredExample: vol-0b9176567fe16f0bc
Header parameters
X-Datafy-Sub-Account-IdstringOptional

Sub-account ID for sub-account context

Example: 1536356a-b26f-4feb-8cd5-56b54b6c51d2
Body
autoscalingOnlybooleanOptional

Create snapshots only for volumes managed by Datafy

Default: true
useSourceVolumebooleanRead-onlyOptional

Create the snapshot from the source volume (if it exists) (for internal use only)

Default: false
descriptionstringOptional

Description for the new snapshot

Example: Snapshot of volume vol-0b9176567fe16f0bc
Responses
chevron-right
200

Sent create snapshot command

application/json
datafySnapshotIdstringOptional

Datafy id of the snapshot

Example: dsnap-0b9176567fe16f0bd
volumeIdstringOptional

Source volume id

Example: vol-0b9176567fe16f0bc
statusstringOptionalExample: pending
startTimestring · date-timeOptional
volumeSizeGbintegerOptional

Original size of the source volume

Example: 100
descriptionstringOptionalExample: Snapshot of volume vol-0b9176567fe16f0bc
post
/api/v1/volumes/{volumeId}/create-snapshot

Create autoscaling volume from Datafy snapshots

post

Create new Datafy-managed autoscaling volume from Datafy snapshots

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
X-Datafy-Sub-Account-IdstringOptional

Sub-account ID for sub-account context

Example: 1536356a-b26f-4feb-8cd5-56b54b6c51d2
Body
sourceone ofRequired

Source specification for creating the autoscaling volume

or
Responses
chevron-right
200

Created autoscaling volume from Datafy snapshots

application/json
volumeIdstringOptionalExample: vol-0b9176567fe16f0bc
volumeSizeGBintegerOptionalExample: 20
post
/api/v1/volumes/create-from-snapshots

Attach autoscaling volume

post

Attach an unattached Datafy-managed autoscaling volume to an instance with Datafy AutoScaler

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
volumeIdstringRequiredExample: vol-0b9176567fe16f0bc
Header parameters
X-Datafy-Sub-Account-IdstringOptional

Sub-account ID for sub-account context

Example: 1536356a-b26f-4feb-8cd5-56b54b6c51d2
Body
instanceIdstringRequiredExample: i-09759c0bdec242294
deviceNamestringRequiredExample: /dev/sdb
Responses
chevron-right
200

Attached autoscaling volume

No content

post
/api/v1/volumes/{volumeId}/attach

No content

Send deactivate autoscaling command

post

Send deactivate autoscaling command of a specific volume

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
volumeIdstringRequiredExample: vol-0b9176567fe16f0bc
Header parameters
X-Datafy-Sub-Account-IdstringOptional

Sub-account ID for sub-account context

Example: 1536356a-b26f-4feb-8cd5-56b54b6c51d2
Responses
chevron-right
200

send deactivate autoscaling command

No content

post
/api/v1/volumes/{volumeId}/deactivate-autoscaling

No content

Last updated

Was this helpful?