Skip to main content
POST
Run a published service

Authorizations

Authorization
string
header
required

A Cool Computers API key, user access token, or claimed agent access token in the Authorization header. Follow https://www.cool.computer/auth.md for agent registration and https://www.cool.computer/authentication.md for direct user credentials.

Headers

Idempotency-Key
string

A caller-generated key for safely retrying this side effect. The server retains the key and response for 24 hours. Reusing it with the same request replays the original response; reusing it with different input returns 409.

Required string length: 1 - 128
Pattern: ^[!-~]+$
Example:

"req_01J6M6Y9TF9Q9QF6M1ZP8K4R2A"

Path Parameters

id
string
required

Stable public computer identifier.

Minimum string length: 1
Example:

"cmp_123"

Body

application/json
command
string
required
Minimum string length: 1
port
integer
required

HTTP port to expose after the command starts. Platform ports 3129, 8080 and 18080 are reserved.

Required range: 1 <= x <= 65535
cwd
string
default:/home/runtime/app

Existing absolute directory used to start the service. Omit it to use /home/runtime/app, created if missing. /, /home and /home/runtime hold credentials and are refused with 400.

Response

The configured service and current process state.

configured
boolean
required
status
string
required

Current lifecycle or process status.

public_url
string<uri>
command
string
cwd
string
port
integer
Required range: 1 <= x <= 65535
exec_id
string
pid
integer
Required range: x >= 1
started_at
string<date-time>
ended_at
string<date-time>
exit_code
integer
signal
string
restart_policy
string
Allowed value: "none"
readiness
object
logs
object