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
HTTPS
Node.js
1
# HTTP request:
2
https://api.paperspace.io
3
POST /machines/ps123abc/stop
4
x-api-key: 1ba4f98e7c0...
5
# Returns 204 on success
Copied!
1
paperspace.machines.stop({
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 shut down
Last modified 9mo ago
Copy link