Snapshots

Generated on 18 Mar 2026

Base URL https://api.paperspace.com/v1

Endpoints

GET List snapshots POST Create snapshot GET Get a snapshot PUT Update a snapshot DELETE Delete snapshot POST Restore snapshot

GET List snapshots

/snapshots
Authorizations: BearerAuth
Http: Bearer

An API key or access token

List snapshots and filter by machine.

Query Parameters

after string optional

Fetch the next page of results after this cursor.

limit integer 1 – 120 optional

The number of items to fetch after this page.

orderBy string, one of: dtCreated, name optional

Order results by one of these fields.

Default: dtCreated
order string, one of: asc, desc optional

The order to sort the results by.

Default: desc
machineId string optional
Request: /snapshots
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/snapshots"

Responses

200

Successful response
Response Schema: application/json
hasMore boolean required

Whether there are more pages of results available.

items array of object required

The items on this page.

Show child properties
id string required

The ID of the snapshot.

isAutoSnapshot boolean required

Whether the snapshot was made automatically.

machineId string required

The ID of the machine the snapshot is for.

name string required

The name of the snapshot.

nextPage string optional

The cursor required to fetch the next page of results. i.e. ?after=nextPage. This is null when there is no next page.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "hasMore": true,
  "items": [
    {
      "id": "string",
      "isAutoSnapshot": true,
      "machineId": "string",
      "name": "string"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Create snapshot

/snapshots
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Create a snapshot for a machine.

Request Body: application/json

machineId string required

The ID of the machine to create a snapshot for.

name string required

The name of the snapshot.

Request: /snapshots
Content type application/json 
{
  "machineId": "string",
  "name": "string"
}
curl -X POST \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "machineId": "string",
  "name": "string"
}' \
  "https://api.paperspace.com/v1/snapshots"

Responses

200

Successful response
Response Schema: application/json
data object required

The snapshot.

Show child properties
id string required

The ID of the snapshot.

isAutoSnapshot boolean required

Whether the snapshot was made automatically.

machineId string required

The ID of the machine the snapshot is for.

name string required

The name of the snapshot.

event object required

The machine event to poll for the async operation.

Show child properties
dtCreated string (date-time) required

The date the event was created.

dtFinished string (date-time) required Nullable

The date the event was finished.

dtStarted string (date-time) required Nullable

The date the event was started.

error string required Nullable

The error message of the event, if any.

id string required

The ID of the event.

machineId string required Nullable

The ID of the machine the event is for.

name string (enum) required

The name of the event, e.g. "create".

state string, one of: new, in progress, done, error, cancelled required

The state of the event, e.g. "done".

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "data": {
    "id": "string",
    "isAutoSnapshot": true,
    "machineId": "string",
    "name": "string"
  },
  "event": {
    "dtCreated": "2019-08-24T14:15:22Z",
    "dtFinished": "2019-08-24T14:15:22Z",
    "dtStarted": "2019-08-24T14:15:22Z",
    "error": "string",
    "id": "string",
    "machineId": "string",
    "name": "bill-sessions",
    "state": "new"
  }
}
{
  "code": "string",
  "message": "string"
}

GET Get a snapshot

/snapshots/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a single snapshot by ID.

Path Parameters

id string required

The ID of the snapshot.

Request: /snapshots/{id}
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/snapshots/{id}"

Responses

200

Successful response
Response Schema: application/json
id string required

The ID of the snapshot.

isAutoSnapshot boolean required

Whether the snapshot was made automatically.

machineId string required

The ID of the machine the snapshot is for.

name string required

The name of the snapshot.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "id": "string",
  "isAutoSnapshot": true,
  "machineId": "string",
  "name": "string"
}
{
  "code": "string",
  "message": "string"
}

PUT Update a snapshot

/snapshots/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Updates a single snapshot by ID.

Path Parameters

id string required

The ID of the snapshot.

Request Body: application/json

name string optional

The updated name of the snapshot.

Request: /snapshots/{id}
Content type application/json 
{
  "name": "string"
}
curl -X PUT \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}' \
  "https://api.paperspace.com/v1/snapshots/{id}"

Responses

200

Successful response
Response Schema: application/json
id string required

The ID of the snapshot.

isAutoSnapshot boolean required

Whether the snapshot was made automatically.

machineId string required

The ID of the machine the snapshot is for.

name string required

The name of the snapshot.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "id": "string",
  "isAutoSnapshot": true,
  "machineId": "string",
  "name": "string"
}
{
  "code": "string",
  "message": "string"
}

DELETE Delete snapshot

/snapshots/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Delete a snapshot for a machine.

Path Parameters

id string required

The ID of the snapshot.

Request: /snapshots/{id}
curl -X DELETE \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/snapshots/{id}"

Responses

200

Successful response
Response Schema: application/json
data object required

The snapshot.

Show child properties
id string required

The ID of the snapshot.

isAutoSnapshot boolean required

Whether the snapshot was made automatically.

machineId string required

The ID of the machine the snapshot is for.

name string required

The name of the snapshot.

event object required

The machine event to poll for the async operation.

Show child properties
dtCreated string (date-time) required

The date the event was created.

dtFinished string (date-time) required Nullable

The date the event was finished.

dtStarted string (date-time) required Nullable

The date the event was started.

error string required Nullable

The error message of the event, if any.

id string required

The ID of the event.

machineId string required Nullable

The ID of the machine the event is for.

name string (enum) required

The name of the event, e.g. "create".

state string, one of: new, in progress, done, error, cancelled required

The state of the event, e.g. "done".

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "data": {
    "id": "string",
    "isAutoSnapshot": true,
    "machineId": "string",
    "name": "string"
  },
  "event": {
    "dtCreated": "2019-08-24T14:15:22Z",
    "dtFinished": "2019-08-24T14:15:22Z",
    "dtStarted": "2019-08-24T14:15:22Z",
    "error": "string",
    "id": "string",
    "machineId": "string",
    "name": "bill-sessions",
    "state": "new"
  }
}
{
  "code": "string",
  "message": "string"
}

POST Restore snapshot

/snapshots/{id}/restore
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Restore a snapshot for a machine.

Path Parameters

id string required

The ID of the snapshot.

Request Body: application/json

createSnapshotBeforeRestore boolean optional

Create a new snapshot before restoring.

Request: /snapshots/{id}/restore
Content type application/json 
{
  "createSnapshotBeforeRestore": true
}
curl -X POST \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "createSnapshotBeforeRestore": true
}' \
  "https://api.paperspace.com/v1/snapshots/{id}/restore"

Responses

200

Successful response
Response Schema: application/json
data object required

The snapshot.

Show child properties
id string required

The ID of the snapshot.

isAutoSnapshot boolean required

Whether the snapshot was made automatically.

machineId string required

The ID of the machine the snapshot is for.

name string required

The name of the snapshot.

event object required

The machine event to poll for the async operation.

Show child properties
dtCreated string (date-time) required

The date the event was created.

dtFinished string (date-time) required Nullable

The date the event was finished.

dtStarted string (date-time) required Nullable

The date the event was started.

error string required Nullable

The error message of the event, if any.

id string required

The ID of the event.

machineId string required Nullable

The ID of the machine the event is for.

name string (enum) required

The name of the event, e.g. "create".

state string, one of: new, in progress, done, error, cancelled required

The state of the event, e.g. "done".

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "data": {
    "id": "string",
    "isAutoSnapshot": true,
    "machineId": "string",
    "name": "string"
  },
  "event": {
    "dtCreated": "2019-08-24T14:15:22Z",
    "dtFinished": "2019-08-24T14:15:22Z",
    "dtStarted": "2019-08-24T14:15:22Z",
    "error": "string",
    "id": "string",
    "machineId": "string",
    "name": "bill-sessions",
    "state": "new"
  }
}
{
  "code": "string",
  "message": "string"
}

We can't find any results for your search.

Try using different keywords or simplifying your search terms.