Skip to main content

machines

Paperspace Core API reference guide for machines.

Core machines are Linux and Windows-based virtual machines (VMs) that run on top of virtualized hardware. Each machine you create is a new server or desktop instance you can use, either standalone or as part of a larger, cloud-based infrastructure.

create

This command creates a new Paperspace virtual machine.

If you are using an individual account, you will be assigned as the owner of the machine.

If you are a team administrator, you must specify the user that should be assigned to the machine, either by specifying a user id, or by providing an email address, password, first name and last name for the creation of a new user on the team.

Only account administrators may create machines. Team members cannot create machines themselves.

Examples

paperspace machines create \
--apiKey "edc20a51d9b2145..." \
--region "East Coast (NY2)" \
--machineType "P4000" \
--size 50 \
--billingType "hourly" \
--machineName "My Machine 1" \
--templateId "tbu200wi" \
--teamId "tewr3st2z"

Parameters

NameTypeAttributesDescription
regionstringName of the region. Valid entries: West Coast (CA1), East Coast (NY2), or Europe (AMS1).
machineTypestringMachine type. Valud entries are Air, Standard, Pro, Advanced, GPU+, P4000, P5000, P6000, V100, C1, C2, C3, C4, C5, C6, C7, C8, C9, or C10. Note: Windows os templates cannot be used to create CPU-only machine types 'C1' - 'C10'. Ubuntu os templates cannot be used to create GRID GPU machine types: 'Air', 'Standard', 'Pro', or 'Advanced'.
sizenumberStorage size for the machine in GB.
billingTypestringEither monthly or hourly billing.
machineNamestringA memorable name for this machine.
templateIdstringTemplate ID of the template to use for creating this machine.
teamIdstringoptionalRequired if creating this machine for a team
assignPublicIpbooleanoptionalAssign a new public ip address on machine creation. Cannot be used with dynamicPublicIp.
dynamicPublicIpbooleanoptionalAssigns a new public IP address on machine start and releases it from the account on machine stop. Cannot be used with assignPublicIp.
startOnCreatebooleanoptionalStart the VM immediately after creation. Defaults to true.
networkIdstringoptionalIf creating on a specific network specify its ID
scriptIdstringoptionalThe script ID of a script to be run on startup. See the Script Guide for more info on using scripts.
userIdstringoptionalIf assigning to an existing user other than yourself specify the user ID (mutually exclusive with email , password, firstName,lastName).
emailstringoptionalIf creating a new user for this machine specify their email address (mutually exclusive with userId).
passwordstringoptionalIf creating a new user specify their password (mutually exclusive with userId).
firstNamestringoptionalIf creating a new user specify their first name (mutually exclusive with userId).
lastNamestringoptionalIf creating a new user specify their last name (mutually exclusive with userId).
notificationEmailstringoptionalSend a notification to this email address when complete.
takeInitialSnapshotbooleanoptionalTake a snapshot of the VM at first boot.
markSnapshotAsRestorePointbooleanoptionalUse initial snapshot as a restore point for the VM. If this is true takeInitialSnapshot must be true and restorePointFrequency must be specified.
restorePointFrequencystringoptionalHow often the VM's restore point should be used. Valid options: shutdown.

Response

The created machine JSON object

{
"id": "psazmnxdy",
"name": "My Machine 1",
"os": null,
"ram": null,
"cpus": 1,
"gpu": null,
"storageTotal": null,
"storageUsed": null,
"machineType": "P4000",
"usageRate": "P4000 hourly",
"shutdownTimeoutInHours": 168,
"shutdownTimeoutForces": false,
"performAutoSnapshot": false,
"autoSnapshotFrequency": null,
"autoSnapshotSaveCount": null,
"dynamicPublicIp": false,
"agentType": "LinuxHeadless",
"dtCreated": "2022-03-14T15:09:51.974Z",
"state": "provisioning",
"updatesPending": false,
"networkId": null,
"privateIpAddress": null,
"publicIpAddress": null,
"region": null,
"scriptId": null,
"dtLastRun": null,
"restorePointSnapshotId": null,
"restorePointFrequency": null
}

start

Start an individual machine. If the machine is already started, this action is a no-op. If the machine is off, it will be booted up. This action can only be performed by the user who owns the machine.

Examples

paperspace machines start \
--apiKey "edc20a51d9b2145..." \
--machineId "psfj3c701"

Parameters

NameTypeDescription
machineIdstringId of the machine to start

stop

Stop an individual machine. If the machine is already stopped or has been shut down, this action is a no-op. If the machine is running, it will be stopped and any users logged in will be immediately kicked out. This action can only be performed by the user who owns the machine.

Examples

paperspace machines stop \
--apiKey "edc20a51d9b2145..." \
--machineId "psfj3c701"

Parameters

NameTypeDescription
machineIdstringId of the machine to shut down

restart

Restart an individual machine. If the machine is already restarting, this action will request the machine be restarted again. This action can only be performed by the user who owns the machine.

Examples

paperspace machines restart \
--apiKey "edc20a51d9b2145..." \
--machineId "psfj3c701"

Parameters

NameTypeDescription
machineIdstringId of the machine to restart

destroy

Destroy the machine with the given id. When this action is performed, the machine is immediately shut down and marked for deletion from the datacenter. Any snapshots that were derived from the machine are also deleted. Access to the machine is terminated immediately and billing for the machine is prorated to the hour. This action can only be performed by the user who owns the machine, or in the case of a team, the team administrator.

Examples

paperspace machines destroy \
--apiKey "edc20a51d9b2145..." \
--machineId "psfj3c701"

Parameters

NameTypeAttributesDescription
machineIdstringThe id of the machine to destroy
releasePublicIpbooleanoptionalreleases any assigned public ip address for the machine; defaults to false

update

Update attributes of a machine.

Examples

paperspace machines update \
--apiKey "edc20a51d9b2145..." \
--machineId "psec02yp2" \
--machineName "New Machine Name"

Parameters

NameTypeAttributesDescription
machineIdstringId of the machine to update
machineNamestringoptionalNew name for the machine
shutdownTimeoutInHoursnumberoptionalNumber of hours before machine is shutdown if no one is logged in via the Paperspace client
shutdownTimeoutForcesbooleanoptionalForce shutdown at shutdown timeout, even if there is a Paperspace client connection
autoSnapshotFrequencynumberoptionalOne of 'hour', 'day', 'week', or null
autoSnapshotSaveCountnumberoptionalNumber of snapshots to save
performAutoSnapshotbooleanoptionalPerform auto snapshots
dynamicPublicIpbooleanoptionalIf true, assigns a new public ip address on machine start and releases it from the account on machine stop

list

List information about all machines available to either the current authenticated user or the team, if the user belongs to a team. The list method takes an optional first argument to limit the returned machine objects.

This API supports pagination using limit and skip. The default limit is 1000 items. To retrieve more than 1000 items, set your skip parameter to a multiple of 1000. For example, to retrieve the 3rd page of 1000 items, you would pass { limit: 1000, skip: 2000 }.

Examples

paperspace machines list \
--apiKey "edc20a51d9b2145..."

Parameters

NameTypeAttributesDescription
limitnumberoptionalNumber of items to return. Defaults to 1000.
skipnumberoptionalNumber of items in the list to skip.
machineIdstringoptionalMachine id to match on. Note: must be specified as "machineId", not "id".
namestringoptionalName to match on
osstringoptionalOS to match on
ramstringoptionalRAM value to match on
cpusnumberoptionalCPU count to match on
gpustringoptionalGPU to match on
storageTotalstringoptionalstorageTotal value to match on
storageUsedstringoptionalstorageUsed value to match on
usageRatestringoptionalusageRate value to match on
shutdownTimeoutInHoursnumberoptionalshutdownTimeoutInHours value to match on
performAutoSnapshotbooleanoptionalperformAutoSnapshot value to match on, either true or false
autoSnapshotFrequencystringoptionalautoSnapshotFrequency value to match on
autoSnapshotSaveCountnumberoptionalautoSnapshotSaveCount value to match on
agentTypestringoptionalagentType value to match on
dtCreatedstringoptionaldatetime created value to match on
statestringoptionalstate value to match on
updatesPendingbooleanoptionalupdatesPending value to match on
networkIdstringoptionalnetworkId to match on
privateIpAddressstringoptionalprivateIpAddress to match on
publicIpAddressstringoptionalpublicIpAddress to match on
regionstringoptionalregion to match on
userIdstringoptionaluserId to match on
teamIdstringoptionalteamId to match on
scriptIdstringoptionalscriptId to match on
dtLastRunstringoptionalscript datetime last run value to match on

Response

[
{
"id": "psec02yp2",
"name": "New Machine Name1",
"os": "",
"ram": "32212254720",
"cpus": 8,
"gpu": "Quadro P4000",
"storageTotal": "53687091200",
"storageUsed": "110080",
"machineType": "P4000",
"usageRate": "P4000 hourly",
"shutdownTimeoutInHours": 24,
"shutdownTimeoutForces": false,
"performAutoSnapshot": false,
"autoSnapshotFrequency": "day",
"autoSnapshotSaveCount": 1,
"dynamicPublicIp": false,
"agentType": "LinuxDesktop",
"dtCreated": "2022-03-14T15:47:53.852Z",
"state": "ready",
"updatesPending": false,
"networkId": "nng82wb",
"privateIpAddress": "10.64.1.99",
"publicIpAddress": "172.83.15.54",
"region": "East Coast (NY2)",
"scriptId": null,
"dtLastRun": null,
"restorePointSnapshotId": null,
"restorePointFrequency": null,
"internalId": 1713423
}
]

show

Show machine information for the machine with the given id.

The state property can take on the follow values:

  • off
  • starting - machine is in the process of changing to the ready or serviceready state
  • stopping - machine is in the process of changing to the off state
  • restarting - combines stopping follow immediately by starting
  • serviceready - services are running on the machine but the Paperspace agent is not yet available
  • ready - services are running on machine and the Paperspace agent is ready to stream or accept logins
  • upgrading - the machine specification are being upgraded, which involves a shutdown and startup sequence
  • provisioning - the machine is in the process of being created for the first time

The updatesPending property is either true or false and reflects whether the operating system has scheduled updates for the next machine state transition, e.g, stopping, starting, restarting, or upgrading.

Note: in some cases, the operating system can force installation of critical updates immediately upon a state transition, or automatically restart a machine to install updates. In such cases, the updatesPending property may not always be set accurately by the underlying os.

Examples

paperspace machines show \
--apiKey "edc20a51d9b2145..." \
--machineId "psec02yp2"

Parameters

NameTypeAttributesDescription
machineIdstringId of the machine to show

Response

machine - The machine JSON object

Type object

{
"id": "psec02yp2",
"name": "New Machine Name1",
"os": "",
"ram": "32212254720",
"cpus": 8,
"gpu": "Quadro P4000",
"storageTotal": "53687091200",
"storageUsed": "110080",
"machineType": "P4000",
"usageRate": "P4000 hourly",
"shutdownTimeoutInHours": 24,
"shutdownTimeoutForces": false,
"performAutoSnapshot": false,
"autoSnapshotFrequency": "day",
"autoSnapshotSaveCount": 1,
"dynamicPublicIp": false,
"agentType": "LinuxDesktop",
"dtCreated": "2022-03-14T15:47:53.852Z",
"state": "ready",
"updatesPending": false,
"networkId": "nng82wb",
"privateIpAddress": "10.64.1.99",
"publicIpAddress": "172.83.15.54",
"region": "East Coast (NY2)",
"scriptId": null,
"dtLastRun": null,
"restorePointSnapshotId": null,
"restorePointFrequency": null,
"events": [
{
"name": "start",
"state": "done",
"errorMsg": "",
"handle": "fabd398a-9c8e-4565-95fa-5f07928564d8",
"dtModified": "2022-03-14T15:49:00.734Z",
"dtFinished": "2022-03-14T15:49:00.734Z",
"dtCreated": "2022-03-14T15:48:30.994Z"
},
{
"name": "create",
"state": "done",
"errorMsg": "",
"handle": "396ea947-9c10-4b63-a15b-574a9a9844bc",
"dtModified": "2022-03-14T15:48:31.026Z",
"dtFinished": "2022-03-14T15:48:31.026Z",
"dtCreated": "2022-03-14T15:47:53.852Z"
}
]
}

setAccessForUser

Examples

paperspace machines setAccessForUser \
--apiKey "edc20a51d9b2145..." \
--machineId "psec02yp2" \
--userId "ubx9ce8k" \
--enableAccess true

Parameters

NameTypeAttributeDescription
machineIdstringrequiredId of the machine to enable access
userIdstringrequiredId of the user to enable machine access for
enableAccessbooleanrequiredWhen "true", the person is added as an accessor to the machine; when "false" the person is removed

utilization

Get machine utilization data for the machine with the given id. Machine upgrades are not represented in utilization data.

Examples

paperspace machines utilization \
--apiKey "edc20a51d9b2145..." \
--machineId "psec02yp2" \
--billingMonth "2022-03"

Parameters

NameTypeAttributeDescription
machineIdstringrequiredId of the machine to get utilization data for
billingMonthstringrequiredBilling period to query in YYYY-MM format

Response

utilization - The utilization JSON object

Type object

{
"machineId": "psec02yp2",
"utilization": {
"machineId": "psec02yp2",
"secondsUsed": 8728.27191281319,
"hourlyRate": "0.51",
"billingMonth": "2022-03"
},
"storageUtilization": {
"machineId": "psec02yp2",
"secondsUsed": 8785.19808006287,
"monthlyRate": "5.00",
"billingMonth": "2022-03"
}
}

waitFor

Wait for the machine with the given id to enter a certain machine state. This action polls the server and returns only when we detect that the machine has transitioned into the given state. States available to check for are:

  • off
  • serviceready - services are running on the machine but the Paperspace agent is not yet available
  • ready - services are running on machine and the Paperspace agent is ready to stream or accept logins

When the callback is called, the returned object will be information about the machine.

Examples

paperspace machines waitfor \
--apiKey "edc20a51d9b2145..." \
--machineId "psec02yp2" \
--state "ready"

Parameters

NameTypeAttributesDescription
machineIdstringrequiredId of the machine to wait for
statestringrequiredName of the state to wait for, either 'off', 'serviceready', 'ready'

Response

machine - The machine JSON object

Type object

{
"id": "psec02yp2",
"name": "New Machine Name1",
"os": "",
"ram": "32212254720",
"cpus": 8,
"gpu": "Quadro P4000",
"storageTotal": "53687091200",
"storageUsed": "110080",
"machineType": "P4000",
"usageRate": "P4000 hourly",
"shutdownTimeoutInHours": 24,
"shutdownTimeoutForces": false,
"performAutoSnapshot": false,
"autoSnapshotFrequency": "day",
"autoSnapshotSaveCount": 1,
"dynamicPublicIp": false,
"agentType": "LinuxDesktop",
"dtCreated": "2022-03-14T15:47:53.852Z",
"state": "ready",
"updatesPending": false,
"networkId": "nng82wb",
"privateIpAddress": "10.64.1.99",
"publicIpAddress": "172.83.15.54",
"region": "East Coast (NY2)",
"scriptId": null,
"dtLastRun": null,
"restorePointSnapshotId": null,
"restorePointFrequency": null,
"events": [
{
"name": "start",
"state": "done",
"errorMsg": "",
"handle": "fabd398a-9c8e-4565-95fa-5f07928564d8",
"dtModified": "2022-03-14T15:49:00.734Z",
"dtFinished": "2022-03-14T15:49:00.734Z",
"dtCreated": "2022-03-14T15:48:30.994Z"
},
{
"name": "create",
"state": "done",
"errorMsg": "",
"handle": "396ea947-9c10-4b63-a15b-574a9a9844bc",
"dtModified": "2022-03-14T15:48:31.026Z",
"dtFinished": "2022-03-14T15:48:31.026Z",
"dtCreated": "2022-03-14T15:47:53.852Z"
}
]
}

availability

Get machine availability for the given region and machine type. Note: availability is only provided for the dedicated GPU machine types. Also, not all machine types are available in all regions.

Examples

paperspace machines availability \
--apiKey "edc20a51d9b2145..." \
--region "East Coast (NY2)" \
--machineType "P4000"

Parameters

NameTypeAttributesDescription
regionstringrequiredName of the region: either 'East Coast (NY2)', 'West Coast (CA1)', or 'Europe (AMS1)'
machineTypestringrequiredMachine type: either 'GPU+', 'P4000', 'P5000', 'P6000', or 'V100'

Response

availability - The availability JSON object, containing a single boolean attribute, "available". A value of true for "available" means machines of that type can currently be requested in that region. A value of false means that requests for that machine type are not currently available in that region.

Type object

{
"available": true
}