GET /api/openapi.json; no token is needed to read it. Customer data and deployment operations still require authentication. The interactive reference is in the app.
Authenticated operations accept Authorization: Bearer $SPRINGWINTER_TOKEN. Cookie mutations require a CSRF token. Signed webhooks use their own signature checks. Read each operation’s security setting.
GET /api/api_tokens
List API tokens
{
"tags": [
"API tokens"
],
"summary": "List API tokens",
"operationId": "listApiTokens",
"responses": {
"200": {
"description": "Kept tokens for the signed-in organization. Secrets are not included.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"api_tokens"
],
"properties": {
"api_tokens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiToken"
}
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
}
},
"parameters": []
}
POST /api/api_tokens
Create an API token
{
"tags": [
"API tokens"
],
"summary": "Create an API token",
"operationId": "createApiToken",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"api_token"
],
"properties": {
"api_token": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
}
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Token metadata plus the secret, returned only on this response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"api_token"
],
"properties": {
"api_token": {
"allOf": [
{
"$ref": "#/components/schemas/ApiToken"
},
{
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"type": "string"
}
}
}
]
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"422": {
"description": "token_limit; invalid_api_token; invalid_csrf_token",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"token_limit",
"invalid_api_token",
"invalid_csrf_token"
]
}
},
"required": [
"error"
]
}
}
}
}
},
"parameters": []
}
DELETE /api/api_tokens/{id}
Revoke an API token
{
"tags": [
"API tokens"
],
"summary": "Revoke an API token",
"operationId": "revokeApiToken",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Token revoked"
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"$ref": "#/components/responses/NotFound"
}
}
}
Referenced definitions
These keys resolve the local references in the operations above.{
"#/components/responses/NotFound": {
"description": "Record not found in the current organization. Empty response body."
},
"#/components/responses/Unauthenticated": {
"description": "No session cookie",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"error": "unauthenticated"
}
}
}
},
"#/components/schemas/ApiToken": {
"type": "object",
"required": [
"id",
"name",
"token_prefix",
"created_at",
"last_used_at"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"token_prefix": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_used_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"#/components/schemas/Error": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}