Stop an instance

PUT

This endpoint is used to stop an existing instance by its ID.

Path parameters

instance_idstringRequired

Headers

api-keystringOptional

Response

This endpoint returns an object.
idstring

The unique identifier of the instance.

statusenumOptional

The current status of the instance.

usernamestringOptional

The username used to connect to the instance. For example, to connect to the instance via SSH, use: “ssh -i <path/to/private/key> <username>@<ip_address>“.

ssh_portstringOptional

The SSH port used to connect to the instance.

ssh_keyslist of stringsOptional

The names of the SSH keys used to login to the instance.

ip_addressstringOptional

The IP address of the instance.

namestringOptional

The name provided when the instance was created.

current_gpu_hr_costdoubleOptional

The current hourly price of the instance per processor based on its current status.

configurationobjectOptional

The configuration used to create the instance.

created_atdatetimeOptional

The creation date and time of the instance.

volumeslist of objectsOptional

The volumes attached to the instance.

Built with