API

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

Authorizer

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

application/json

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

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

400

Bad request

401

Authentication information is missing or invalid

post

/api/v1/volumes/{volumeId}/create-snapshot

HTTPcURLJavaScriptPython

POST /api/v1/volumes/{volumeId}/create-snapshot HTTP/1.1
Host: api.datafy.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "autoscalingOnly": true,
  "description": "Snapshot of volume vol-0b9176567fe16f0bc",
  "tags": [
    {
      "key": "Name",
      "value": "My Storage Block Snapshot"
    }
  ]
}

{
  "datafySnapshotId": "dsnap-0b9176567fe16f0bd",
  "volumeId": "vol-0b9176567fe16f0bc",
  "status": "pending",
  "startTime": "2026-03-23T15:56:05.016Z",
  "volumeSizeGb": 100,
  "description": "Snapshot of volume vol-0b9176567fe16f0bc"
}

Create autoscaling volume from Datafy snapshots

post

Create new Datafy-managed autoscaling volume from Datafy snapshots

Authorizations

Authorizer

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

application/json

sourceone ofRequired

Source specification for creating the autoscaling volume

or

Responses

200

Created autoscaling volume from Datafy snapshots

application/json

volumeIdstringOptionalExample: vol-0b9176567fe16f0bc

volumeSizeGBintegerOptionalExample: 20

400

Bad request

401

Authentication information is missing or invalid

post

/api/v1/volumes/create-from-snapshots

HTTPcURLJavaScriptPython

POST /api/v1/volumes/create-from-snapshots HTTP/1.1
Host: api.datafy.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "source": {
    "datafySnapshotId": "dsnap-0b9176567fe16f0bd"
  },
  "volumeProperties": {
    "availabilityZone": "us-east-1a",
    "volumeIops": 3000,
    "volumeThroughput": 125,
    "tags": [
      {
        "key": "Name",
        "value": "Database"
      }
    ]
  }
}

{
  "volumeId": "vol-0b9176567fe16f0bc",
  "volumeSizeGB": 20
}

Attach autoscaling volume

post

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

Authorizations

Authorizer

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

application/json

instanceIdstringRequiredExample: i-09759c0bdec242294

deviceNamestringRequiredExample: /dev/sdb

Responses

200

Attached autoscaling volume

No content

400

Bad request

401

Authentication information is missing or invalid

post

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

HTTPcURLJavaScriptPython

POST /api/v1/volumes/{volumeId}/attach HTTP/1.1
Host: api.datafy.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "instanceId": "i-09759c0bdec242294",
  "deviceName": "/dev/sdb"
}

No content

Send deactivate autoscaling command

post

Send deactivate autoscaling command of a specific volume

Authorizations

Authorizer

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

200

send deactivate autoscaling command

No content

400

Bad request

401

Authentication information is missing or invalid

422

Unprocessable content

post

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

HTTPcURLJavaScriptPython

POST /api/v1/volumes/{volumeId}/deactivate-autoscaling HTTP/1.1
Host: api.datafy.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content