Get Compute Instance

Returns the details of a specific compute instance by its ID.

GET /computes/{id}

Get a compute instance

cURL

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

200

{
  "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.

Code	Status	Description
UNAUTHORIZED	401	Authentication failed or was not provided.
RESOURCE_NOT_FOUND	404	The specified compute instance was not found.
TOO_MANY_REQUESTS	429	You have exceeded the rate limit.
INTERNAL_SERVER_ERROR	500	An unexpected error occurred on our end.

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

200

application/json

OK

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