Machine

Generated on 18 Mar 2026

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

Endpoints

GET List machine events GET Get a machine event GET List machines POST Create a machine GET Get a machine PUT Update a machine DELETE Delete a machine GET List accessors POST Add an accessor GET Get an accessor DELETE Delete an accessor GET Get desktop settings PATCH Restart a machine PATCH Start a machine PATCH Stop a machine

GET List machine events

/machine-events
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a list of machine events.

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 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: /machine-events
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/machine-events"

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
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".

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": [
    {
      "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"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

GET Get a machine event

/machine-events/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a single machine event by ID.

Path Parameters

id string required

The ID of the machine event to fetch.

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

Responses

200

Successful response
Response Schema: application/json
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
{
  "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 List machines

/machines
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Fetches a list of machines.

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, state 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
name string optional
region anyOf optional
agentType string optional
machineType string optional
Request: /machines
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/machines"

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
accelerators array of object optional Nullable

The accelerators of the machine.

Show child properties
count number required

The number of accelerators of this type.

memory integer required Nullable

The amount of memory the accelerator has, if applicable.

name string required

The name of the accelerator.

agentType string required

The agent type of the machine.

autoShutdownEnabled boolean required

Whether auto shutdown is enabled.

autoShutdownForce boolean required Nullable

Whether to force shutdown the machine.

autoShutdownTimeout number required Nullable

The shutdown timeout of the machine in hours.

autoSnapshotEnabled boolean required

Whether auto snapshots are enabled.

autoSnapshotFrequency string, one of: hourly, daily, weekly, monthly required Nullable

The frequency of auto snapshots.

autoSnapshotSaveCount number required Nullable

The number of auto snapshots to save.

cpus number required

The number of CPUs.

dtCreated string (date-time) required

The date the machine was created.

dtDeleted string (date-time) required Nullable

The date the machine was deleted.

dtModified string (date-time) required

The date the machine was last modified.

id string required

The ID of the machine.

machineType string required

The type of the machine.

name string required

The name of the machine.

networkId string required Nullable

The ID of the network the machine is on.

os string required

The operating system of the machine.

privateIp string required Nullable

The private IP address of the machine.

publicIp string required Nullable

The public IP address of the machine.

publicIpType string, one of: static, dynamic, none required

The public IP type.

ram integer (int64) required

The amount of RAM in bytes.

region string, one of: ny2, ca1, ams1 required

The region of the machine.

reservation object required Nullable
Show child properties
dtFinished string (date-time) required
dtStarted string (date-time) required
id string (uuid) required
isActive boolean required
name string required
restorePointEnabled boolean required

Whether a restore point is enabled.

restorePointFrequency string, one of: shutdown required Nullable

The frequency of restore points.

restorePointSnapshotId string required Nullable

The ID of the snapshot to use as a restore point.

state string (enum) required

The state of the machine.

storageRate number required

The storage rate of the machine.

storageTotal integer (int64) required

The total amount of storage.

storageUsed integer (int64) required

The amount of storage used.

updatesPending boolean required

Whether updates are pending.

usageRate number required

The usage rate of the machine.

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": [
    {
      "accelerators": [],
      "agentType": "string",
      "autoShutdownEnabled": true,
      "autoShutdownForce": true,
      "autoShutdownTimeout": 0,
      "autoSnapshotEnabled": true,
      "autoSnapshotFrequency": "hourly",
      "autoSnapshotSaveCount": 0,
      "cpus": 0,
      "dtCreated": "2019-08-24T14:15:22Z",
      "dtDeleted": "2019-08-24T14:15:22Z",
      "dtModified": "2019-08-24T14:15:22Z",
      "id": "string",
      "machineType": "string",
      "name": "string",
      "networkId": "string",
      "os": "string",
      "privateIp": "string",
      "publicIp": "string",
      "publicIpType": "static",
      "ram": 0,
      "region": "ny2",
      "restorePointEnabled": true,
      "restorePointFrequency": "shutdown",
      "restorePointSnapshotId": "string",
      "state": "off",
      "storageRate": 0,
      "storageTotal": 0,
      "storageUsed": 0,
      "updatesPending": true,
      "usageRate": 0
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Create a machine

/machines
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Creates a new machine.

Request Body: application/json

accessorIds array of string optional

The IDs of users to grant access to the machine.

autoShutdownEnabled boolean optional

Whether to enable auto shutdown.

autoShutdownForce boolean optional

Whether to force shutdown the machine.

autoShutdownTimeout number optional

The auto shutdown timeout in hours.

autoSnapshotEnabled boolean optional

Whether to enable auto snapshots.

autoSnapshotFrequency string, one of: hourly, daily, weekly, monthly optional

The auto snapshot frequency.

autoSnapshotSaveCount number optional

The number of auto snapshots to save.

diskSize number (enum, 10 values) required

The disk size in gigabytes.

emailPassword boolean optional

Whether to email the password.

enableNvlink boolean optional

Whether to enable NVLink.

machineType string required

The machine type. This must correspond to a machine type label as indicated in List OS templates or List templates.

name string required

The name of the new machine.

networkId string optional

The network ID.

publicIpType string, one of: static, dynamic, none optional

The public IP type.

region string, one of: ny2, ca1, ams1 required

The region to create the machine in.

restorePointEnabled boolean optional

Whether to use initial snapshot as a restore point.

restorePointFrequency string, one of: shutdown optional

The restore point frequency.

startOnCreate boolean optional

Whether to start the machine on creation.

startupScriptId string optional

The startup script ID.

takeInitialSnapshot boolean optional

Whether to take an initial snapshot.

templateId string required

The template ID. See List OS templates or List templates.

Request: /machines
Content type application/json 
{
  "accessorIds": [
    "string"
  ],
  "autoShutdownEnabled": true,
  "autoShutdownForce": true,
  "autoShutdownTimeout": 0,
  "autoSnapshotEnabled": true,
  "autoSnapshotFrequency": "hourly",
  "autoSnapshotSaveCount": 0,
  "diskSize": 0,
  "emailPassword": true,
  "enableNvlink": true,
  "machineType": "string",
  "name": "string",
  "networkId": "string",
  "publicIpType": "static",
  "region": "ny2",
  "restorePointEnabled": true,
  "restorePointFrequency": "shutdown",
  "startOnCreate": true,
  "startupScriptId": "string",
  "takeInitialSnapshot": true,
  "templateId": "string"
}
curl -X POST \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "accessorIds": [
    "string"
  ],
  "autoShutdownEnabled": true,
  "autoShutdownForce": true,
  "autoShutdownTimeout": 0,
  "autoSnapshotEnabled": true,
  "autoSnapshotFrequency": "hourly",
  "autoSnapshotSaveCount": 0,
  "diskSize": 0,
  "emailPassword": true,
  "enableNvlink": true,
  "machineType": "string",
  "name": "string",
  "networkId": "string",
  "publicIpType": "static",
  "region": "ny2",
  "restorePointEnabled": true,
  "restorePointFrequency": "shutdown",
  "startOnCreate": true,
  "startupScriptId": "string",
  "takeInitialSnapshot": true,
  "templateId": "string"
}' \
  "https://api.paperspace.com/v1/machines"

Responses

200

Successful response
Response Schema: application/json
data object required

The machine.

Show child properties
accelerators array of object optional Nullable

The accelerators of the machine.

Show child properties
count number required

The number of accelerators of this type.

memory integer required Nullable

The amount of memory the accelerator has, if applicable.

name string required

The name of the accelerator.

agentType string required

The agent type of the machine.

autoShutdownEnabled boolean required

Whether auto shutdown is enabled.

autoShutdownForce boolean required Nullable

Whether to force shutdown the machine.

autoShutdownTimeout number required Nullable

The shutdown timeout of the machine in hours.

autoSnapshotEnabled boolean required

Whether auto snapshots are enabled.

autoSnapshotFrequency string, one of: hourly, daily, weekly, monthly required Nullable

The frequency of auto snapshots.

autoSnapshotSaveCount number required Nullable

The number of auto snapshots to save.

cpus number required

The number of CPUs.

dtCreated string (date-time) required

The date the machine was created.

dtDeleted string (date-time) required Nullable

The date the machine was deleted.

dtModified string (date-time) required

The date the machine was last modified.

id string required

The ID of the machine.

machineType string required

The type of the machine.

name string required

The name of the machine.

networkId string required Nullable

The ID of the network the machine is on.

os string required

The operating system of the machine.

privateIp string required Nullable

The private IP address of the machine.

publicIp string required Nullable

The public IP address of the machine.

publicIpType string, one of: static, dynamic, none required

The public IP type.

ram integer (int64) required

The amount of RAM in bytes.

region string, one of: ny2, ca1, ams1 required

The region of the machine.

reservation object required Nullable
Show child properties
dtFinished string (date-time) required
dtStarted string (date-time) required
id string (uuid) required
isActive boolean required
name string required
restorePointEnabled boolean required

Whether a restore point is enabled.

restorePointFrequency string, one of: shutdown required Nullable

The frequency of restore points.

restorePointSnapshotId string required Nullable

The ID of the snapshot to use as a restore point.

state string (enum) required

The state of the machine.

storageRate number required

The storage rate of the machine.

storageTotal integer (int64) required

The total amount of storage.

storageUsed integer (int64) required

The amount of storage used.

updatesPending boolean required

Whether updates are pending.

usageRate number required

The usage rate of the machine.

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": {
    "accelerators": [],
    "agentType": "string",
    "autoShutdownEnabled": true,
    "autoShutdownForce": true,
    "autoShutdownTimeout": 0,
    "autoSnapshotEnabled": true,
    "autoSnapshotFrequency": "hourly",
    "autoSnapshotSaveCount": 0,
    "cpus": 0,
    "dtCreated": "2019-08-24T14:15:22Z",
    "dtDeleted": "2019-08-24T14:15:22Z",
    "dtModified": "2019-08-24T14:15:22Z",
    "id": "string",
    "machineType": "string",
    "name": "string",
    "networkId": "string",
    "os": "string",
    "privateIp": "string",
    "publicIp": "string",
    "publicIpType": "static",
    "ram": 0,
    "region": "ny2",
    "reservation": {
      "dtFinished": "2019-08-24T14:15:22Z",
      "dtStarted": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isActive": true,
      "name": "string"
    },
    "restorePointEnabled": true,
    "restorePointFrequency": "shutdown",
    "restorePointSnapshotId": "string",
    "state": "off",
    "storageRate": 0,
    "storageTotal": 0,
    "storageUsed": 0,
    "updatesPending": true,
    "usageRate": 0
  },
  "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 machine

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

An API key or access token

Fetches a single machine by ID.

Path Parameters

id string required

The ID of the machine to fetch.

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

Responses

200

Successful response
Response Schema: application/json
accelerators array of object optional Nullable

The accelerators of the machine.

Show child properties
count number required

The number of accelerators of this type.

memory integer required Nullable

The amount of memory the accelerator has, if applicable.

name string required

The name of the accelerator.

agentType string required

The agent type of the machine.

autoShutdownEnabled boolean required

Whether auto shutdown is enabled.

autoShutdownForce boolean required Nullable

Whether to force shutdown the machine.

autoShutdownTimeout number required Nullable

The shutdown timeout of the machine in hours.

autoSnapshotEnabled boolean required

Whether auto snapshots are enabled.

autoSnapshotFrequency string, one of: hourly, daily, weekly, monthly required Nullable

The frequency of auto snapshots.

autoSnapshotSaveCount number required Nullable

The number of auto snapshots to save.

cpus number required

The number of CPUs.

dtCreated string (date-time) required

The date the machine was created.

dtDeleted string (date-time) required Nullable

The date the machine was deleted.

dtModified string (date-time) required

The date the machine was last modified.

id string required

The ID of the machine.

machineType string required

The type of the machine.

name string required

The name of the machine.

networkId string required Nullable

The ID of the network the machine is on.

os string required

The operating system of the machine.

privateIp string required Nullable

The private IP address of the machine.

publicIp string required Nullable

The public IP address of the machine.

publicIpType string, one of: static, dynamic, none required

The public IP type.

ram integer (int64) required

The amount of RAM in bytes.

region string, one of: ny2, ca1, ams1 required

The region of the machine.

reservation object required Nullable
Show child properties
dtFinished string (date-time) required
dtStarted string (date-time) required
id string (uuid) required
isActive boolean required
name string required
restorePointEnabled boolean required

Whether a restore point is enabled.

restorePointFrequency string, one of: shutdown required Nullable

The frequency of restore points.

restorePointSnapshotId string required Nullable

The ID of the snapshot to use as a restore point.

state string (enum) required

The state of the machine.

storageRate number required

The storage rate of the machine.

storageTotal integer (int64) required

The total amount of storage.

storageUsed integer (int64) required

The amount of storage used.

updatesPending boolean required

Whether updates are pending.

usageRate number required

The usage rate of the machine.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "accelerators": [
    {
      "count": 0,
      "memory": 0,
      "name": "string"
    }
  ],
  "agentType": "string",
  "autoShutdownEnabled": true,
  "autoShutdownForce": true,
  "autoShutdownTimeout": 0,
  "autoSnapshotEnabled": true,
  "autoSnapshotFrequency": "hourly",
  "autoSnapshotSaveCount": 0,
  "cpus": 0,
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtDeleted": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "id": "string",
  "machineType": "string",
  "name": "string",
  "networkId": "string",
  "os": "string",
  "privateIp": "string",
  "publicIp": "string",
  "publicIpType": "static",
  "ram": 0,
  "region": "ny2",
  "reservation": {
    "dtFinished": "2019-08-24T14:15:22Z",
    "dtStarted": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "isActive": true,
    "name": "string"
  },
  "restorePointEnabled": true,
  "restorePointFrequency": "shutdown",
  "restorePointSnapshotId": "string",
  "state": "off",
  "storageRate": 0,
  "storageTotal": 0,
  "storageUsed": 0,
  "updatesPending": true,
  "usageRate": 0
}
{
  "code": "string",
  "message": "string"
}

PUT Update a machine

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

An API key or access token

Updates a machine.

Path Parameters

id string required

The ID of the machine to update.

Request Body: application/json

autoShutdownEnabled boolean optional

Whether to enable auto shutdown.

autoShutdownForce boolean optional

Whether to force shutdown the machine.

autoShutdownTimeout number optional

The auto shutdown timeout in hours.

autoSnapshotEnabled boolean optional

Whether to enable auto snapshots.

autoSnapshotFrequency string, one of: hourly, daily, weekly, monthly optional

The auto snapshot frequency.

autoSnapshotSaveCount number optional

The number of auto snapshots to save.

diskSize number (enum, 10 values) optional

The disk size in gigabytes.

machineType string optional

The machine type. This must correspond to a machine type label as indicated in List OS templates or List templates.

name string optional

The name of the machine.

networkId string optional

The network ID.

publicIpType string, one of: static, dynamic, none optional

The public IP type.

restorePointEnabled boolean optional

Whether to use initial snapshot as a restore point.

restorePointFrequency string, one of: shutdown optional

The restore point frequency.

restorePointSnapshotId string optional

The restore point snapshot ID.

Request: /machines/{id}
Content type application/json 
{
  "autoShutdownEnabled": true,
  "autoShutdownForce": true,
  "autoShutdownTimeout": 0,
  "autoSnapshotEnabled": true,
  "autoSnapshotFrequency": "hourly",
  "autoSnapshotSaveCount": 0,
  "diskSize": 0,
  "machineType": "string",
  "name": "string",
  "networkId": "string",
  "publicIpType": "static",
  "restorePointEnabled": true,
  "restorePointFrequency": "shutdown",
  "restorePointSnapshotId": "string"
}
curl -X PUT \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "autoShutdownEnabled": true,
  "autoShutdownForce": true,
  "autoShutdownTimeout": 0,
  "autoSnapshotEnabled": true,
  "autoSnapshotFrequency": "hourly",
  "autoSnapshotSaveCount": 0,
  "diskSize": 0,
  "machineType": "string",
  "name": "string",
  "networkId": "string",
  "publicIpType": "static",
  "restorePointEnabled": true,
  "restorePointFrequency": "shutdown",
  "restorePointSnapshotId": "string"
}' \
  "https://api.paperspace.com/v1/machines/{id}"

Responses

200

Successful response
Response Schema: application/json
data object required

The machine.

Show child properties
accelerators array of object optional Nullable

The accelerators of the machine.

Show child properties
count number required

The number of accelerators of this type.

memory integer required Nullable

The amount of memory the accelerator has, if applicable.

name string required

The name of the accelerator.

agentType string required

The agent type of the machine.

autoShutdownEnabled boolean required

Whether auto shutdown is enabled.

autoShutdownForce boolean required Nullable

Whether to force shutdown the machine.

autoShutdownTimeout number required Nullable

The shutdown timeout of the machine in hours.

autoSnapshotEnabled boolean required

Whether auto snapshots are enabled.

autoSnapshotFrequency string, one of: hourly, daily, weekly, monthly required Nullable

The frequency of auto snapshots.

autoSnapshotSaveCount number required Nullable

The number of auto snapshots to save.

cpus number required

The number of CPUs.

dtCreated string (date-time) required

The date the machine was created.

dtDeleted string (date-time) required Nullable

The date the machine was deleted.

dtModified string (date-time) required

The date the machine was last modified.

id string required

The ID of the machine.

machineType string required

The type of the machine.

name string required

The name of the machine.

networkId string required Nullable

The ID of the network the machine is on.

os string required

The operating system of the machine.

privateIp string required Nullable

The private IP address of the machine.

publicIp string required Nullable

The public IP address of the machine.

publicIpType string, one of: static, dynamic, none required

The public IP type.

ram integer (int64) required

The amount of RAM in bytes.

region string, one of: ny2, ca1, ams1 required

The region of the machine.

reservation object required Nullable
Show child properties
dtFinished string (date-time) required
dtStarted string (date-time) required
id string (uuid) required
isActive boolean required
name string required
restorePointEnabled boolean required

Whether a restore point is enabled.

restorePointFrequency string, one of: shutdown required Nullable

The frequency of restore points.

restorePointSnapshotId string required Nullable

The ID of the snapshot to use as a restore point.

state string (enum) required

The state of the machine.

storageRate number required

The storage rate of the machine.

storageTotal integer (int64) required

The total amount of storage.

storageUsed integer (int64) required

The amount of storage used.

updatesPending boolean required

Whether updates are pending.

usageRate number required

The usage rate of the machine.

event object optional

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": {
    "accelerators": [],
    "agentType": "string",
    "autoShutdownEnabled": true,
    "autoShutdownForce": true,
    "autoShutdownTimeout": 0,
    "autoSnapshotEnabled": true,
    "autoSnapshotFrequency": "hourly",
    "autoSnapshotSaveCount": 0,
    "cpus": 0,
    "dtCreated": "2019-08-24T14:15:22Z",
    "dtDeleted": "2019-08-24T14:15:22Z",
    "dtModified": "2019-08-24T14:15:22Z",
    "id": "string",
    "machineType": "string",
    "name": "string",
    "networkId": "string",
    "os": "string",
    "privateIp": "string",
    "publicIp": "string",
    "publicIpType": "static",
    "ram": 0,
    "region": "ny2",
    "reservation": {
      "dtFinished": "2019-08-24T14:15:22Z",
      "dtStarted": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isActive": true,
      "name": "string"
    },
    "restorePointEnabled": true,
    "restorePointFrequency": "shutdown",
    "restorePointSnapshotId": "string",
    "state": "off",
    "storageRate": 0,
    "storageTotal": 0,
    "storageUsed": 0,
    "updatesPending": true,
    "usageRate": 0
  },
  "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"
}

DELETE Delete a machine

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

An API key or access token

Deletes a single machine by ID.

Path Parameters

id string required

The ID of the machine to delete.

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

Responses

200

Successful response
Response Schema: application/json
data object required

The machine.

Show child properties
accelerators array of object optional Nullable

The accelerators of the machine.

Show child properties
count number required

The number of accelerators of this type.

memory integer required Nullable

The amount of memory the accelerator has, if applicable.

name string required

The name of the accelerator.

agentType string required

The agent type of the machine.

autoShutdownEnabled boolean required

Whether auto shutdown is enabled.

autoShutdownForce boolean required Nullable

Whether to force shutdown the machine.

autoShutdownTimeout number required Nullable

The shutdown timeout of the machine in hours.

autoSnapshotEnabled boolean required

Whether auto snapshots are enabled.

autoSnapshotFrequency string, one of: hourly, daily, weekly, monthly required Nullable

The frequency of auto snapshots.

autoSnapshotSaveCount number required Nullable

The number of auto snapshots to save.

cpus number required

The number of CPUs.

dtCreated string (date-time) required

The date the machine was created.

dtDeleted string (date-time) required Nullable

The date the machine was deleted.

dtModified string (date-time) required

The date the machine was last modified.

id string required

The ID of the machine.

machineType string required

The type of the machine.

name string required

The name of the machine.

networkId string required Nullable

The ID of the network the machine is on.

os string required

The operating system of the machine.

privateIp string required Nullable

The private IP address of the machine.

publicIp string required Nullable

The public IP address of the machine.

publicIpType string, one of: static, dynamic, none required

The public IP type.

ram integer (int64) required

The amount of RAM in bytes.

region string, one of: ny2, ca1, ams1 required

The region of the machine.

reservation object required Nullable
Show child properties
dtFinished string (date-time) required
dtStarted string (date-time) required
id string (uuid) required
isActive boolean required
name string required
restorePointEnabled boolean required

Whether a restore point is enabled.

restorePointFrequency string, one of: shutdown required Nullable

The frequency of restore points.

restorePointSnapshotId string required Nullable

The ID of the snapshot to use as a restore point.

state string (enum) required

The state of the machine.

storageRate number required

The storage rate of the machine.

storageTotal integer (int64) required

The total amount of storage.

storageUsed integer (int64) required

The amount of storage used.

updatesPending boolean required

Whether updates are pending.

usageRate number required

The usage rate of the machine.

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": {
    "accelerators": [],
    "agentType": "string",
    "autoShutdownEnabled": true,
    "autoShutdownForce": true,
    "autoShutdownTimeout": 0,
    "autoSnapshotEnabled": true,
    "autoSnapshotFrequency": "hourly",
    "autoSnapshotSaveCount": 0,
    "cpus": 0,
    "dtCreated": "2019-08-24T14:15:22Z",
    "dtDeleted": "2019-08-24T14:15:22Z",
    "dtModified": "2019-08-24T14:15:22Z",
    "id": "string",
    "machineType": "string",
    "name": "string",
    "networkId": "string",
    "os": "string",
    "privateIp": "string",
    "publicIp": "string",
    "publicIpType": "static",
    "ram": 0,
    "region": "ny2",
    "reservation": {
      "dtFinished": "2019-08-24T14:15:22Z",
      "dtStarted": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isActive": true,
      "name": "string"
    },
    "restorePointEnabled": true,
    "restorePointFrequency": "shutdown",
    "restorePointSnapshotId": "string",
    "state": "off",
    "storageRate": 0,
    "storageTotal": 0,
    "storageUsed": 0,
    "updatesPending": true,
    "usageRate": 0
  },
  "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 List accessors

/machines/{id}/accessors
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Lists the team members that can explicitly access a machine.

Path Parameters

id string required

The ID of the 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: id optional

Order results by one of these fields.

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

The order to sort the results by.

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

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
dtDeleted string (date-time) optional Nullable

The date the user was removed from the machine as an accessor.

user object required

The user that can access the machine

Show child properties
email string (email) required

The email address of the user

firstName string optional Nullable

The first name of the user

id string required

The ID of the user

lastName string optional Nullable

The last name of the user

publicProfileImageUrl string optional Nullable

The URL of the team's profile image.

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": [
    {
      "dtDeleted": "2019-08-24T14:15:22Z"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Add an accessor

/machines/{id}/accessors
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Adds an accessor to a machine.

Path Parameters

id string required

The ID of the machine to add an accessor to.

Request Body: application/json

userId string required

The ID of the user to add as an accessor. This can be found on the team members page at https://console.paperspace.com/settings/members.

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

Responses

200

Successful response
Response Schema: application/json
dtDeleted string (date-time) optional Nullable

The date the user was removed from the machine as an accessor.

user object required

The user that can access the machine

Show child properties
email string (email) required

The email address of the user

firstName string optional Nullable

The first name of the user

id string required

The ID of the user

lastName string optional Nullable

The last name of the user

publicProfileImageUrl string optional Nullable

The URL of the team's profile image.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtDeleted": "2019-08-24T14:15:22Z",
  "user": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "publicProfileImageUrl": "string"
  }
}
{
  "code": "string",
  "message": "string"
}

GET Get an accessor

/machines/{id}/accessors/{userId}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Get an accessor for a machine.

Path Parameters

id string required

The ID of the machine to get an accessor for.

userId string required

The ID of the user to get. This can be found on the team members page at https://console.paperspace.com/settings/members.

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

Responses

200

Successful response
Response Schema: application/json
dtDeleted string (date-time) optional Nullable

The date the user was removed from the machine as an accessor.

user object required

The user that can access the machine

Show child properties
email string (email) required

The email address of the user

firstName string optional Nullable

The first name of the user

id string required

The ID of the user

lastName string optional Nullable

The last name of the user

publicProfileImageUrl string optional Nullable

The URL of the team's profile image.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtDeleted": "2019-08-24T14:15:22Z",
  "user": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "publicProfileImageUrl": "string"
  }
}
{
  "code": "string",
  "message": "string"
}

DELETE Delete an accessor

/machines/{id}/accessors/{userId}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Deletes an accessor from a machine.

Path Parameters

id string required

The ID of the machine to add an accessor to.

userId string required

The ID of the user to add as an accessor. This can be found on the team members page at https://console.paperspace.com/settings/members.

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

Responses

200

Successful response
Response Schema: application/json
dtDeleted string (date-time) optional Nullable

The date the user was removed from the machine as an accessor.

user object required

The user that can access the machine

Show child properties
email string (email) required

The email address of the user

firstName string optional Nullable

The first name of the user

id string required

The ID of the user

lastName string optional Nullable

The last name of the user

publicProfileImageUrl string optional Nullable

The URL of the team's profile image.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "dtDeleted": "2019-08-24T14:15:22Z",
  "user": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "publicProfileImageUrl": "string"
  }
}
{
  "code": "string",
  "message": "string"
}

GET Get desktop settings

/machines/{id}/desktop
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Gets the machine settings that are used to configure desktop streaming.

Path Parameters

id string required

The ID of the machine.

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

Responses

200

Successful response
Response Schema: application/json
vnc object optional

Settings for Linux desktop machines.

Show child properties
hostname string required

The VNC hostname.

password string required

The VNC password.

port integer required

The port VNC is listening on.

windows object optional

Settings for Windows desktop machines.

Show child properties
hostname string required

The Windows hostname.

port integer required

The port Windows is listening on.

publicIp string optional

The public IP of the machine.

default

Error response
Response Schema: application/json
code string required
details object optional
message string required
Response
{
  "vnc": {
    "hostname": "string",
    "password": "string",
    "port": 0
  },
  "windows": {
    "hostname": "string",
    "port": 0,
    "publicIp": "string"
  }
}
{
  "code": "string",
  "message": "string"
}

PATCH Restart a machine

/machines/{id}/restart
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Restarts a machine.

Path Parameters

id string required

The ID of the machine to restart.

Request: /machines/{id}/restart
curl -X PATCH \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  "https://api.paperspace.com/v1/machines/{id}/restart"

Responses

200

Successful response
Response Schema: application/json
data object required

The machine.

Show child properties
accelerators array of object optional Nullable

The accelerators of the machine.

Show child properties
count number required

The number of accelerators of this type.

memory integer required Nullable

The amount of memory the accelerator has, if applicable.

name string required

The name of the accelerator.

agentType string required

The agent type of the machine.

autoShutdownEnabled boolean required

Whether auto shutdown is enabled.

autoShutdownForce boolean required Nullable

Whether to force shutdown the machine.

autoShutdownTimeout number required Nullable

The shutdown timeout of the machine in hours.

autoSnapshotEnabled boolean required

Whether auto snapshots are enabled.

autoSnapshotFrequency string, one of: hourly, daily, weekly, monthly required Nullable

The frequency of auto snapshots.

autoSnapshotSaveCount number required Nullable

The number of auto snapshots to save.

cpus number required

The number of CPUs.

dtCreated string (date-time) required

The date the machine was created.

dtDeleted string (date-time) required Nullable

The date the machine was deleted.

dtModified string (date-time) required

The date the machine was last modified.

id string required

The ID of the machine.

machineType string required

The type of the machine.

name string required

The name of the machine.

networkId string required Nullable

The ID of the network the machine is on.

os string required

The operating system of the machine.

privateIp string required Nullable

The private IP address of the machine.

publicIp string required Nullable

The public IP address of the machine.

publicIpType string, one of: static, dynamic, none required

The public IP type.

ram integer (int64) required

The amount of RAM in bytes.

region string, one of: ny2, ca1, ams1 required

The region of the machine.

reservation object required Nullable
Show child properties
dtFinished string (date-time) required
dtStarted string (date-time) required
id string (uuid) required
isActive boolean required
name string required
restorePointEnabled boolean required

Whether a restore point is enabled.

restorePointFrequency string, one of: shutdown required Nullable

The frequency of restore points.

restorePointSnapshotId string required Nullable

The ID of the snapshot to use as a restore point.

state string (enum) required

The state of the machine.

storageRate number required

The storage rate of the machine.

storageTotal integer (int64) required

The total amount of storage.

storageUsed integer (int64) required

The amount of storage used.

updatesPending boolean required

Whether updates are pending.

usageRate number required

The usage rate of the machine.

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": {
    "accelerators": [],
    "agentType": "string",
    "autoShutdownEnabled": true,
    "autoShutdownForce": true,
    "autoShutdownTimeout": 0,
    "autoSnapshotEnabled": true,
    "autoSnapshotFrequency": "hourly",
    "autoSnapshotSaveCount": 0,
    "cpus": 0,
    "dtCreated": "2019-08-24T14:15:22Z",
    "dtDeleted": "2019-08-24T14:15:22Z",
    "dtModified": "2019-08-24T14:15:22Z",
    "id": "string",
    "machineType": "string",
    "name": "string",
    "networkId": "string",
    "os": "string",
    "privateIp": "string",
    "publicIp": "string",
    "publicIpType": "static",
    "ram": 0,
    "region": "ny2",
    "reservation": {
      "dtFinished": "2019-08-24T14:15:22Z",
      "dtStarted": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isActive": true,
      "name": "string"
    },
    "restorePointEnabled": true,
    "restorePointFrequency": "shutdown",
    "restorePointSnapshotId": "string",
    "state": "off",
    "storageRate": 0,
    "storageTotal": 0,
    "storageUsed": 0,
    "updatesPending": true,
    "usageRate": 0
  },
  "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"
}

PATCH Start a machine

/machines/{id}/start
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Starts a machine.

Path Parameters

id string required

The ID of the machine to start.

Request: /machines/{id}/start
curl -X PATCH \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  "https://api.paperspace.com/v1/machines/{id}/start"

Responses

200

Successful response
Response Schema: application/json
data object required

The machine.

Show child properties
accelerators array of object optional Nullable

The accelerators of the machine.

Show child properties
count number required

The number of accelerators of this type.

memory integer required Nullable

The amount of memory the accelerator has, if applicable.

name string required

The name of the accelerator.

agentType string required

The agent type of the machine.

autoShutdownEnabled boolean required

Whether auto shutdown is enabled.

autoShutdownForce boolean required Nullable

Whether to force shutdown the machine.

autoShutdownTimeout number required Nullable

The shutdown timeout of the machine in hours.

autoSnapshotEnabled boolean required

Whether auto snapshots are enabled.

autoSnapshotFrequency string, one of: hourly, daily, weekly, monthly required Nullable

The frequency of auto snapshots.

autoSnapshotSaveCount number required Nullable

The number of auto snapshots to save.

cpus number required

The number of CPUs.

dtCreated string (date-time) required

The date the machine was created.

dtDeleted string (date-time) required Nullable

The date the machine was deleted.

dtModified string (date-time) required

The date the machine was last modified.

id string required

The ID of the machine.

machineType string required

The type of the machine.

name string required

The name of the machine.

networkId string required Nullable

The ID of the network the machine is on.

os string required

The operating system of the machine.

privateIp string required Nullable

The private IP address of the machine.

publicIp string required Nullable

The public IP address of the machine.

publicIpType string, one of: static, dynamic, none required

The public IP type.

ram integer (int64) required

The amount of RAM in bytes.

region string, one of: ny2, ca1, ams1 required

The region of the machine.

reservation object required Nullable
Show child properties
dtFinished string (date-time) required
dtStarted string (date-time) required
id string (uuid) required
isActive boolean required
name string required
restorePointEnabled boolean required

Whether a restore point is enabled.

restorePointFrequency string, one of: shutdown required Nullable

The frequency of restore points.

restorePointSnapshotId string required Nullable

The ID of the snapshot to use as a restore point.

state string (enum) required

The state of the machine.

storageRate number required

The storage rate of the machine.

storageTotal integer (int64) required

The total amount of storage.

storageUsed integer (int64) required

The amount of storage used.

updatesPending boolean required

Whether updates are pending.

usageRate number required

The usage rate of the machine.

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": {
    "accelerators": [],
    "agentType": "string",
    "autoShutdownEnabled": true,
    "autoShutdownForce": true,
    "autoShutdownTimeout": 0,
    "autoSnapshotEnabled": true,
    "autoSnapshotFrequency": "hourly",
    "autoSnapshotSaveCount": 0,
    "cpus": 0,
    "dtCreated": "2019-08-24T14:15:22Z",
    "dtDeleted": "2019-08-24T14:15:22Z",
    "dtModified": "2019-08-24T14:15:22Z",
    "id": "string",
    "machineType": "string",
    "name": "string",
    "networkId": "string",
    "os": "string",
    "privateIp": "string",
    "publicIp": "string",
    "publicIpType": "static",
    "ram": 0,
    "region": "ny2",
    "reservation": {
      "dtFinished": "2019-08-24T14:15:22Z",
      "dtStarted": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isActive": true,
      "name": "string"
    },
    "restorePointEnabled": true,
    "restorePointFrequency": "shutdown",
    "restorePointSnapshotId": "string",
    "state": "off",
    "storageRate": 0,
    "storageTotal": 0,
    "storageUsed": 0,
    "updatesPending": true,
    "usageRate": 0
  },
  "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"
}

PATCH Stop a machine

/machines/{id}/stop
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Stops a machine.

Path Parameters

id string required

The ID of the machine to stop.

Request: /machines/{id}/stop
curl -X PATCH \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  "https://api.paperspace.com/v1/machines/{id}/stop"

Responses

200

Successful response
Response Schema: application/json
data object required

The machine.

Show child properties
accelerators array of object optional Nullable

The accelerators of the machine.

Show child properties
count number required

The number of accelerators of this type.

memory integer required Nullable

The amount of memory the accelerator has, if applicable.

name string required

The name of the accelerator.

agentType string required

The agent type of the machine.

autoShutdownEnabled boolean required

Whether auto shutdown is enabled.

autoShutdownForce boolean required Nullable

Whether to force shutdown the machine.

autoShutdownTimeout number required Nullable

The shutdown timeout of the machine in hours.

autoSnapshotEnabled boolean required

Whether auto snapshots are enabled.

autoSnapshotFrequency string, one of: hourly, daily, weekly, monthly required Nullable

The frequency of auto snapshots.

autoSnapshotSaveCount number required Nullable

The number of auto snapshots to save.

cpus number required

The number of CPUs.

dtCreated string (date-time) required

The date the machine was created.

dtDeleted string (date-time) required Nullable

The date the machine was deleted.

dtModified string (date-time) required

The date the machine was last modified.

id string required

The ID of the machine.

machineType string required

The type of the machine.

name string required

The name of the machine.

networkId string required Nullable

The ID of the network the machine is on.

os string required

The operating system of the machine.

privateIp string required Nullable

The private IP address of the machine.

publicIp string required Nullable

The public IP address of the machine.

publicIpType string, one of: static, dynamic, none required

The public IP type.

ram integer (int64) required

The amount of RAM in bytes.

region string, one of: ny2, ca1, ams1 required

The region of the machine.

reservation object required Nullable
Show child properties
dtFinished string (date-time) required
dtStarted string (date-time) required
id string (uuid) required
isActive boolean required
name string required
restorePointEnabled boolean required

Whether a restore point is enabled.

restorePointFrequency string, one of: shutdown required Nullable

The frequency of restore points.

restorePointSnapshotId string required Nullable

The ID of the snapshot to use as a restore point.

state string (enum) required

The state of the machine.

storageRate number required

The storage rate of the machine.

storageTotal integer (int64) required

The total amount of storage.

storageUsed integer (int64) required

The amount of storage used.

updatesPending boolean required

Whether updates are pending.

usageRate number required

The usage rate of the machine.

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": {
    "accelerators": [],
    "agentType": "string",
    "autoShutdownEnabled": true,
    "autoShutdownForce": true,
    "autoShutdownTimeout": 0,
    "autoSnapshotEnabled": true,
    "autoSnapshotFrequency": "hourly",
    "autoSnapshotSaveCount": 0,
    "cpus": 0,
    "dtCreated": "2019-08-24T14:15:22Z",
    "dtDeleted": "2019-08-24T14:15:22Z",
    "dtModified": "2019-08-24T14:15:22Z",
    "id": "string",
    "machineType": "string",
    "name": "string",
    "networkId": "string",
    "os": "string",
    "privateIp": "string",
    "publicIp": "string",
    "publicIpType": "static",
    "ram": 0,
    "region": "ny2",
    "reservation": {
      "dtFinished": "2019-08-24T14:15:22Z",
      "dtStarted": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isActive": true,
      "name": "string"
    },
    "restorePointEnabled": true,
    "restorePointFrequency": "shutdown",
    "restorePointSnapshotId": "string",
    "state": "off",
    "storageRate": 0,
    "storageTotal": 0,
    "storageUsed": 0,
    "updatesPending": true,
    "usageRate": 0
  },
  "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.