Execute Command

Execute a command via simple HTTP POST (non-TTY only). Simpler alternative for exec for environments that can’t handle websockets.

POST /v1/sprites/{name}/exec

Execute Command

cURL

curl --request POST \
  --url https://api.sprites.dev/v1/sprites/{name}/exec \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --data '<string>'

Authorizations

Authorization · string · header · required

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

Path Parameters

name · string · required

Query Parameters

cmd · string · required

Command to execute (can be repeated for command + args)

path · string

Explicit path to executable (defaults to first cmd value or bash)

stdin · boolean

Enable stdin from request body (default: false)

env · string

Environment variables in KEY=VALUE format (can be repeated)

dir · string

Working directory for the command

Body

application/octet-stream

Raw bytes forwarded to stdin when stdin=true. Empty or omitted when stdin is disabled.

The body is of type file.

Response

200

Success