Sprites Docs

Appearance

Sprites API ​

External API for managing sprites. Used by the sprite CLI.

Create Sprite ​

POST /v1/sprites

Request ​

json
{
  "name": "my-sprite"
}

Response ​

json
{
  "name": "my-sprite"
}

List Sprites ​

GET /v1/sprites

Query Parameters ​

ParamDescription
max_resultsLimit results
prefixFilter by name prefix
continuation_tokenPagination token

Response ​

json
{
  "sprites": [
    {
      "id": "...",
      "name": "my-sprite",
      "status": "running",
      "url": "https://my-sprite.sprites.dev",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ],
  "continuation_token": "..."
}

Get Sprite ​

GET /v1/sprites/{name}

Response ​

json
{
  "id": "...",
  "name": "my-sprite",
  "organization_name": "...",
  "status": "running",
  "url": "https://my-sprite.sprites.dev",
  "url_settings": {
    "auth_required": true
  },
  "bucket_name": "...",
  "primary_region": "iad",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}

Update URL Settings ​

PUT /v1/sprites/{name}

Request ​

json
{
  "url_settings": {
    "auth_required": false
  }
}

Makes the sprite's HTTP endpoint publicly accessible.

Delete Sprite ​

DELETE /v1/sprites/{name}

Upgrade Sprite ​

Upgrade to latest base image.

POST /v1/sprites/{name}/upgrade

Update Network Policy ​

PUT /v1/sprites/{name}/policy/network

Request ​

json
{
  "rules": [
    {"include": "defaults"},
    {"domain": "api.example.com", "action": "allow"}
  ]
}

See Network Policy for rule format.