Create Compute Instance

Provisions a new compute instance under the team associated with the given API key.

POST /computes

Create a compute instance

cURL

curl --request POST \
  --url https://api.strettch.cloud/api/v1/computes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "hostName": "my-server-01",
  "image": "UBUNTU-24.04",
  "publicKeys": [
    "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC8Z5mS1x7I6n... user@host"
  ],
  "region": "KGL-1",
  "specification": "S-1C-1G",
  "tags": [
    "production",
    "web"
  ],
  "withPublicIp": true
}
'

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"
  }
}

Request Reference

Use these slugs for the region, image, and specification fields in your request body.

Regions

Slug	Name	Country
KGL-1	Kigali-1	🇷🇼 Rwanda

Images

Slug	OS	Version
UBUNTU-24.04	Ubuntu	24.04 LTS
UBUNTU-22.04	Ubuntu	22.04 LTS

Specifications

The S prefix stands for Shared CPU. RAM in GB (512 MB for the smallest tier).

Slug	vCPUs	RAM	Storage (SSD)
S-1C	1	512 MB	10 GB
S-1C-1G	1	1 GB	20 GB
S-1C-2G	1	2 GB	40 GB
S-2C-4G	2	4 GB	80 GB
S-4C-8G	4	8 GB	160 GB
S-8C-16G	8	16 GB	320 GB
S-16C-32G	16	32 GB	640 GB

---

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 requested resource (image, region, or specification) 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 provision this instance.
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.

Headers

Idempotency-Key · string · required

Idempotency key (UUID v4)

Body

application/json

hostName · string · required

Example:

"my-server-01"

image · string · required

Example:

"UBUNTU-24.04"

publicKeys · string[] · required

Minimum array length: 1

Example:

[
  "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC8Z5mS1x7I6n... user@host"
]

region · string · required

Example:

"KGL-1"

specification · string · required

e.g. S-1C-1G or S-1C

Example:

"S-1C-1G"

tags · string[]

Example:

["production", "web"]

withPublicIp · boolean

Example:

true

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