Update

Update attributes of a machine.

Examples

HTTPS

# HTTP request:
https://api.paperspace.io
POST /machines/ps123abc/updateMachinePublic {"machineId": "ps123abc", "machineName": "New Machine Name", "shutdownTimeoutInHours": 24, "shutdownTimeoutForces": true, "performAutoSnapshot": true, "autoSnapshotFrequency": "week", "autoSnapshotSaveCount": 4, "dynamicPublicIp": true}
x-api-key: 1ba4f98e7c0...
# Returns 204 on success

Node.js

paperspace.machines.update({
  machineId: 'ps123abc',
  machineName: 'New Machine Name',
  shutdownTimeoutInHours: 24,
  shutdownTimeoutForces: true,
  performAutoSnapshot: true,
  autoSnapshotFrequency: 'week',
  autoSnapshotSaveCount: 4
}, function(err, res) {
  // handle error or result
});

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