Update
Update attributes of a machine.
Examples
HTTPS
Node.js
1
# HTTP request:
2
https://api.paperspace.io
3
POST /machines/ps123abc/updateMachinePublic {"machineId": "ps123abc", "machineName": "New Machine Name", "shutdownTimeoutInHours": 24, "shutdownTimeoutForces": true, "performAutoSnapshot": true, "autoSnapshotFrequency": "week", "autoSnapshotSaveCount": 4, "dynamicPublicIp": true}
4
x-api-key: 1ba4f98e7c0...
5
# Returns 204 on success
Copied!
1
paperspace.machines.update({
2
machineId: 'ps123abc',
3
machineName: 'New Machine Name',
4
shutdownTimeoutInHours: 24,
5
shutdownTimeoutForces: true,
6
performAutoSnapshot: true,
7
autoSnapshotFrequency: 'week',
8
autoSnapshotSaveCount: 4
9
}, function(err, res) {
10
// handle error or result
11
});
Copied!
Parameters
Name
Type
Attributes
Description
machineId
string
Id of the machine to update
machineName
string
<optional>
New name for the machine
shutdownTimeoutInHours
number
<optional>
Number of hours before machine is shutdown if no one is logged in via the Paperspace client
shutdownTimeoutForces
boolean
<optional>
Force shutdown at shutdown timeout, even if there is a Paperspace client connection
autoSnapshotFrequency
number
<optional>
One of 'hour', 'day', 'week', or null
autoSnapshotSaveCount
number
<optional>
Number of snapshots to save
performAutoSnapshot
boolean
<optional>
Perform auto snapshots
dynamicPublicIp
boolean
<optional>
If true, assigns a new public ip address on machine start and releases it from the account on machine stop
Last modified 9mo ago
Copy link