Skip to content

API Overview ​

Base URL: https://api.snapenv.io
All endpoints are under the /v1/ prefix.

Authentication ​

Authorization: Bearer <credential>

Two credential types:

TypeFormatUse case
JWTeyJ…Dashboard sessions only
Access tokensnp_live_…CLI, CI/CD, server scripts, operator

Variable endpoints (/projects/*) accept both. Account and workspace endpoints (/me/*, /workspace/*) require a JWT.

Error format ​

All non-2xx responses:

json
{
  "error": {
    "code": "SNAKE_CASE",
    "message": "Human readable description",
    "field": "fieldName"
  }
}

Common codes:

HTTPCodeMeaning
400VALIDATIONMissing or invalid field
401UNAUTHORIZEDMissing, expired, or invalid credential
403FORBIDDENInsufficient role or permission
404NOT_FOUNDResource does not exist
409CONFLICTDuplicate (e.g. email already registered)
429RATE_LIMITToo many requests
500SERVERInternal error

Rate limits ​

EndpointLimit
POST /v1/auth/login10 req/min per IP
POST /v1/auth/resend-verification1 req/min per user
All other endpointsNo hard limit

Sections ​

Built with SnapEnv