Computers

Stop a Computer.

Halts the machine. The root disk and the network address are kept, so a later start comes back to the same files at the same address. Runtime billing stops; disk billing continues at the parked rate.

post/v1/computers/{id}/stop

Request

  • Base URL: https://api.scalix.world
  • URL: https://api.scalix.world/v1/computers/{id}/stop
  • Auth: HTTP bearer

Path parameters

idstring required

Computer id

Response

The Computer, now STOPPED

idstring required
namestring required
imagestring required
statusstring required

CREATING | RUNNING | STOPPING | STOPPED | STARTING | DELETING | FAILED

statusReasonstring nullable

Human-readable reason for the current status (set on FAILED).

ipAddressstring nullable

Private address inside your network. Reserved for the Computer's lifetime — the same address comes back after a stop/start.

vcpusinteger required
memoryMbinteger required
diskGbinteger required
sshKeysstring[]

The OpenSSH public keys currently authorised for root. Public halves only — there is nothing secret to withhold here, and being able to read back what is installed is how you confirm a revocation took.

createdAtstring required
updatedAtstring required

Example response

{
  "status": "RUNNING"
}

Changes

No recorded changes to this operation across all 1 revision of this API.