Appearance
REST API
Two APIs
| API | Access | Purpose |
|---|---|---|
| External API | api.sprites.dev | Full sprite management (create, delete, settings, network policy, checkpoints) |
| Internal API | /.sprite/api.sock | Services 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
| Method | Endpoint | Description |
|---|---|---|
| POST | /sprites | Create sprite |
| GET | /sprites | List sprites |
| GET | /sprites/{name} | Get sprite |
| PUT | /sprites/{name} | Update URL settings |
| DELETE | /sprites/{name} | Delete sprite |
| POST | /sprites/{name}/upgrade | Upgrade sprite |
| PUT | /sprites/{name}/policy/network | Update network policy |
| POST | /sprites/{name}/checkpoint | Create checkpoint |
| GET | /sprites/{name}/checkpoints | List checkpoints |
| GET | /sprites/{name}/checkpoints/{id} | Get checkpoint |
| POST | /sprites/{name}/checkpoints/{id}/restore | Restore checkpoint |
| POST | /sprites/{name}/exec | Execute 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.