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
HTTPS
Node.js
1
# HTTP request:
2
https://api.paperspace.io
3
GET /machines/getMachinePublic?machineId=ps123abc
4
x-api-key: 1ba4f98e7c0...
5
# Returns 200 on success
Copied!
1
paperspace.machines.show({
2
machineId: 'ps123abc',
3
}, function(err, res) {
4
// handle error or result
5
});
Copied!
Parameters
Name
Type
Description
machineId
string
Id of the machine to show
Returns:
machine - The machine JSON object
Type object
1
//Example return value:
2
{
3
"id": "ps123abc",
4
"name": "My Machine",
5
"os": "Microsoft Windows Server 2016 Datacenter",
6
"ram": "8589938688",
7
"cpus": 4,
8
"gpu": "GRID K160Q (2GB)",
9
"storageTotal": "53687091200",
10
"storageUsed": "110080",
11
"usageRate": "Air monthly",
12
"shutdownTimeoutInHours": 168,
13
"shutdownTimeoutForces": false,
14
"performAutoSnapshot": false,
15
"autoSnapshotFrequency": null,
16
"autoSnapshotSaveCount": null,
17
"agentType": "WindowsDesktop",
18
"dtCreated": "2016-11-18T05:18:29.533Z",
19
"state": "ready",
20
"updatesPending": false,
21
"networkId": "n789ghi",
22
"privateIpAddress": "10.64.21.47",
23
"publicIpAddress": null,
24
"region": "East Coast (NY2)",
25
"userId": "u123abc",
26
"teamId": "te456def",
27
"scriptId": "sc123abc",
28
"dtLastRun": "2017-06-30T07:22:49.763Z",
29
"dynamicPublicIp": null,
30
"events": [
31
{
32
"name": "start",
33
"state": "done",
34
"errorMsg": "",
35
"handle": "8ebe43dd-57c8-4bd4-b770-86b7fd0202e4",
36
"dtModified": "2017-08-16T14:36:24.802Z",
37
"dtFinished": null,
38
"dtCreated": "2017-08-16T14:36:18.373Z"
39
},
40
{
41
"name": "start",
42
"state": "error",
43
"errorMsg": "Uh oh. This machine type can't start due to insufficient capacity or higher than normal demand. Please try again later.",
44
"handle": "f6adb486-f5ae-4ab3-9a1a-51c19df5b337",
45
"dtModified": "2017-06-09T15:32:38.115Z",
46
"dtFinished": "2017-06-09T15:32:38.115Z",
47
"dtCreated": "2017-06-09T15:32:37.019Z"
48
},
49
{
50
"name": "stop",
51
"state": "done",
52
"errorMsg": "",
53
"handle": "e352ad96-734f-4a26-8829-007c2f1d89f2",
54
"dtModified": "2017-06-03T04:14:01.327Z",
55
"dtFinished": null,
56
"dtCreated": "2017-06-03T04:13:47.885Z"
57
}
58
]
59
}
Copied!
Last modified 9mo ago
Copy link