API

Authentication

All Datafy endpoints use a bearer token for authentication. Pass the token in the Authorization header:

Authorization: Bearer <token>

API tokens can be generated by an admin in the Datafy app and are scoped to the account from which they were created.

Account tokens

Account tokens are scoped to a single sub-account. Requests authenticated with an account token automatically target that account, no additional identifier is needed.

Organization tokens

Organization tokens are scoped to your organization and can target any sub-account within it. Generate an organization token the same way as an account token, by generating a token while logged in to an organization account in the Datafy app.

Specify the target sub-account using the accounts query parameter:

• For single-resource endpoints (e.g. create snapshot, attach, deactivate autoscaling) pass a single sub-account ID:

  ?accounts=<sub-account-id>

• For list or aggregate endpoints pass a comma-separated list of sub-account IDs, or all to include every sub-account in your organization. The accounts parameter is required if using an organization token on list and aggregate endpoints.

  ?accounts=<sub-account-id>,<sub-account-id>,...
  ?accounts=all

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

Query parameters

accountsstring[]Optional

Target account(s) for the request. On list/aggregate endpoints: a comma-separated list of sub-account ids, or "all" to include every sub-account of the calling org. Required for org users on these endpoints. On single-resource endpoints: at most one sub-account id. Multiple values or "all" are silently ignored and the request runs against the caller's effective account.

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-06-16T07:29:22.200Z",
  "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>.

Query parameters

accountsstring[]Optional

Target account(s) for the request. On list/aggregate endpoints: a comma-separated list of sub-account ids, or "all" to include every sub-account of the calling org. Required for org users on these endpoints. On single-resource endpoints: at most one sub-account id. Multiple values or "all" are silently ignored and the request runs against the caller's effective account.

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

Query parameters

accountsstring[]Optional

Target account(s) for the request. On list/aggregate endpoints: a comma-separated list of sub-account ids, or "all" to include every sub-account of the calling org. Required for org users on these endpoints. On single-resource endpoints: at most one sub-account id. Multiple values or "all" are silently ignored and the request runs against the caller's effective account.

Body

application/json

instanceIdstringRequiredExample: i-09759c0bdec242294

deviceNamestringRequiredExample: /dev/sdb

deleteOnTerminationbooleanOptional

Indicates whether the volume is deleted on instance termination. This flag is only effective when a Datafy agent is present on the instance.

Default: false

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: 88

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

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

Query parameters

accountsstring[]Optional

Target account(s) for the request. On list/aggregate endpoints: a comma-separated list of sub-account ids, or "all" to include every sub-account of the calling org. Required for org users on these endpoints. On single-resource endpoints: at most one sub-account id. Multiple values or "all" are silently ignored and the request runs against the caller's effective account.

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

Modify a volume

post

Modify the size of a specific volume

Authorizations

Authorizer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

volumeIdstringRequiredExample: vol-0b9176567fe16f0bc

Query parameters

accountsstring[]Optional

Target account(s) for the request. On list/aggregate endpoints: a comma-separated list of sub-account ids, or "all" to include every sub-account of the calling org. Required for org users on these endpoints. On single-resource endpoints: at most one sub-account id. Multiple values or "all" are silently ignored and the request runs against the caller's effective account.

Body

application/json

Desired values for modifying volume

volumeSizeGBintegerOptional

Desired size of volume, in GiB. Must be larger than current original size

Example: 10

expandFilesystembooleanOptional

Expand filesystem automatically after modifying

Default: falseExample: false

autoscalingOnlybooleanOptional

Modify only volumes managed by Datafy

Default: trueExample: false

Responses

200

send modify command

No content

400

Bad request

401

Authentication information is missing or invalid

post

/api/v1/volumes/{volumeId}/modify

HTTPcURLJavaScriptPython

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

{
  "volumeSizeGB": 10,
  "expandFilesystem": false,
  "autoscalingOnly": false
}

No content