Skip to content

REST API

Two APIs

APIAccessPurpose
External APIapi.sprites.devFull sprite management (create, delete, settings, network policy, checkpoints)
Internal API/.sprite/api.sockServices and checkpoints only (from inside the sprite)

External API

Base URL: https://api.sprites.dev/v1

Authentication: Authorization: Bearer <token>

Used by the sprite CLI on your local machine.

Endpoints

MethodEndpointDescription
POST/spritesCreate sprite
GET/spritesList sprites
GET/sprites/{name}Get sprite
PUT/sprites/{name}Update URL settings
DELETE/sprites/{name}Delete sprite
POST/sprites/{name}/upgradeUpgrade sprite
PUT/sprites/{name}/policy/networkUpdate network policy
POST/sprites/{name}/checkpointCreate checkpoint
GET/sprites/{name}/checkpointsList checkpoints
GET/sprites/{name}/checkpoints/{id}Get checkpoint
POST/sprites/{name}/checkpoints/{id}/restoreRestore checkpoint
POST/sprites/{name}/execExecute command

Internal API

Socket: /.sprite/api.sock

Used by the sprite-env CLI inside the sprite.

Scope: Services and checkpoints for this sprite only. Cannot modify network policy, URL settings, or other sprite configuration—those must be managed externally.

See Internal API for details.