Stop Compute Instance

Initiates a graceful shutdown of the specified compute instance.

POST /computes/{id}/stop

Stop a compute instance

cURL

curl --request POST \
  --url https://api.strettch.cloud/api/v1/computes/{id}/stop \
  --header 'Authorization: Bearer <token>'

202

{
  "message": "Operation successful",
  "requestId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "success": true,
  "timestamp": "2024-01-15T10:00:00Z",
  "data": {
    "id": "325",
    "hostName": "my-server-01",
    "state": "RUNNING",
    "image": "UBUNTU-24.04",
    "specification": "S-1C-1G",
    "region": "KGL-1",
    "ipv4": "195.15.0.73",
    "privateIpv4": "10.0.0.5",
    "tags": [
      "production",
      "web"
    ],
    "createdAt": "2024-01-15T10:00:00Z",
    "updatedAt": "2024-01-15T10:05:00Z"
  }
}

Response Error Codes

If the request fails, the code field in the error response will contain one of the following.

Standard

Code	Status	Description
BAD_REQUEST	400	The request was invalid or malformed.
UNAUTHORIZED	401	Authentication failed or was not provided.
FORBIDDEN	403	You do not have permission to perform this action.
RESOURCE_NOT_FOUND	404	The specified compute instance was not found.
CONFLICT	409	A conflict with the current server state occurred.
UNPROCESSABLE_ENTITY	422	The request was well-formed but failed semantic validation.
TOO_MANY_REQUESTS	429	You have exceeded the rate limit.
INTERNAL_SERVER_ERROR	500	An unexpected error occurred on our end.

Billing & Team

These errors block all resource operations. Resolve your team’s billing status before retrying.

Code	Status	Description
INSUFFICIENT_BALANCE	403	Team balance is too low to perform this action.
TEAM_SUSPENDED	403	Team is suspended due to an outstanding payment.
TEAM_PAST_DUE	403	Team has an outstanding balance that must be settled first.
TEAM_TERMINATED	403	Team has been terminated and can no longer access resources.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Compute ID

Response

202

application/json

Accepted

message · string

Example:

"Operation successful"

requestId · string

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

success · boolean

Example:

true

timestamp · string

Example:

"2024-01-15T10:00:00Z"

data · object

Show child attributes