{ "openapi": "3.1.0", "info": { "title": "Caplets HTTP API", "version": "2.0.0", "description": "Canonical public non-MCP HTTP contract for Caplets." }, "servers": [ { "url": "/" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "Caplets remote credential", "description": "Operator or Access Client bearer credential, according to route policy." }, "dashboardSession": { "type": "apiKey", "in": "cookie", "name": "caplets_dashboard_session", "description": "Host-only HttpOnly dashboard session cookie. Browser requests remain subject to same-origin checks and unsafe methods require X-Caplets-CSRF." } }, "schemas": { "ServiceDiscovery": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "caplets" ] }, "protocol": { "type": "string", "enum": [ "caplets-http" ] }, "schemaVersion": { "type": "number", "enum": [ 1 ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "enum": [ "/api" ] }, "openapi": { "type": "string", "enum": [ "/api/openapi.json" ] }, "v1": { "type": "string", "enum": [ "/api/v1" ] }, "admin": { "type": "string", "enum": [ "/api/v2/admin/host" ] } }, "required": [ "self", "openapi", "v1", "admin" ], "additionalProperties": false } }, "required": [ "name", "protocol", "schemaVersion", "links" ], "additionalProperties": false }, "Problem": { "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "minimum": 400, "maximum": 599 }, "detail": { "type": "string" }, "code": { "type": "string", "minLength": 1 }, "nextAction": { "type": "string" }, "links": { "type": "object", "additionalProperties": { "type": "string", "format": "uri" } } }, "required": [ "type", "title", "status", "detail", "code" ] }, "VersionDiscovery": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "path": { "type": "string", "enum": [ "/api/v1" ] }, "links": { "type": "object", "properties": { "health": { "type": "string", "enum": [ "/api/v1/healthz" ] }, "attachSessions": { "type": "string", "enum": [ "/api/v1/attach/sessions" ] }, "attachManifest": { "type": "string", "enum": [ "/api/v1/attach/manifest" ] }, "attachEvents": { "type": "string", "enum": [ "/api/v1/attach/events" ] }, "attachInvoke": { "type": "string", "enum": [ "/api/v1/attach/invoke" ] } }, "required": [ "health" ], "additionalProperties": false } }, "required": [ "version", "path", "links" ], "additionalProperties": false }, "Health": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok", "unavailable" ] }, "ready": { "type": "boolean" }, "checks": { "type": "object", "additionalProperties": {} } }, "required": [ "status", "ready" ] }, "RemoteLoginStartResponse": { "type": "object", "properties": { "flowId": { "type": "string", "minLength": 1 }, "operatorCode": { "type": "string", "minLength": 1 }, "operatorCodeFingerprint": { "type": "string", "minLength": 1 }, "approvalCommand": { "type": "string", "minLength": 1 }, "pendingRefreshSecret": { "type": "string", "minLength": 1 }, "pendingCompletionSecret": { "type": "string", "minLength": 1 }, "codeExpiresAt": { "type": "string", "format": "date-time" }, "flowExpiresAt": { "type": "string", "format": "date-time" }, "intervalSeconds": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "flowId", "operatorCode", "operatorCodeFingerprint", "approvalCommand", "pendingRefreshSecret", "pendingCompletionSecret", "codeExpiresAt", "flowExpiresAt", "intervalSeconds" ], "additionalProperties": false }, "RemoteLoginErrorResponse": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ false ] }, "error": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false }, "PublicV1TextError": { "type": "string" }, "RemoteLoginPollResponse": { "type": "object", "properties": { "flowId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "pending", "approved", "denied", "cancelled", "expired", "exchanged" ] } }, "required": [ "flowId", "status" ], "additionalProperties": false }, "RemoteLoginRefreshResponse": { "type": "object", "properties": { "flowId": { "type": "string", "minLength": 1 }, "operatorCode": { "type": "string", "minLength": 1 }, "operatorCodeFingerprint": { "type": "string", "minLength": 1 }, "pendingRefreshSecret": { "type": "string", "minLength": 1 }, "codeExpiresAt": { "type": "string", "format": "date-time" }, "flowExpiresAt": { "type": "string", "format": "date-time" }, "intervalSeconds": { "type": "integer", "exclusiveMinimum": 0 }, "generation": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "flowId", "operatorCode", "operatorCodeFingerprint", "pendingRefreshSecret", "codeExpiresAt", "flowExpiresAt", "intervalSeconds" ], "additionalProperties": false }, "RemoteLoginCompletionResponse": { "type": "object", "properties": { "hostUrl": { "type": "string", "format": "uri" }, "clientId": { "type": "string", "minLength": 1 }, "clientLabel": { "type": "string" }, "role": { "type": "string", "enum": [ "access", "operator" ] }, "accessToken": { "type": "string", "minLength": 1 }, "refreshToken": { "type": "string", "minLength": 1 }, "tokenType": { "type": "string", "enum": [ "Bearer" ] }, "expiresAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "hostUrl", "clientId", "clientLabel", "role", "accessToken", "refreshToken", "tokenType", "expiresAt", "createdAt" ], "additionalProperties": false }, "RemoteLoginCancelResponse": { "type": "object", "properties": { "flowId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "cancelled" ] }, "generation": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "flowId", "status" ], "additionalProperties": false }, "RemoteCredentials": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1 }, "clientLabel": { "type": "string" }, "role": { "type": "string", "enum": [ "access", "operator" ] }, "accessToken": { "type": "string", "minLength": 1 }, "refreshToken": { "type": "string", "minLength": 1 }, "tokenType": { "type": "string", "enum": [ "Bearer" ] }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "clientId", "clientLabel", "role", "accessToken", "refreshToken", "tokenType", "expiresAt" ], "additionalProperties": false }, "RemoteClientDeleteResponse": { "type": "object", "properties": { "revoked": { "type": "boolean" }, "clientId": { "type": "string", "minLength": 1 } }, "required": [ "revoked", "clientId" ], "additionalProperties": false }, "AttachSessionCreateResponse": { "type": "object", "properties": { "sessionId": { "type": "string", "minLength": 1 } }, "required": [ "sessionId" ], "additionalProperties": false }, "AttachErrorResponse": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ false ] }, "error": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false }, "AttachSessionRequest": { "type": "object", "properties": { "projectRoot": { "type": "string" }, "projectConfigPath": { "type": "string" } }, "additionalProperties": false }, "AttachSessionDeleteResponse": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false }, "AttachManifest": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "revision": { "type": "string" }, "generatedAt": { "type": "string", "format": "date-time" }, "caplets": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "tools": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "resources": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "resourceTemplates": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "prompts": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "completions": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "codeModeCaplets": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "diagnostics": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "version", "revision", "generatedAt", "caplets", "tools", "resources", "resourceTemplates", "prompts", "completions", "codeModeCaplets", "diagnostics" ], "additionalProperties": false }, "AttachInvokeResponse": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "data": {} }, "required": [ "ok" ], "additionalProperties": false }, "AttachInvokeRequest": { "type": "object", "properties": { "revision": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "caplet", "tool", "resource", "resourceTemplate", "prompt", "completion" ] }, "exportId": { "type": "string", "minLength": 1 }, "input": {} }, "required": [ "revision", "kind", "exportId" ], "additionalProperties": false }, "AttachManifestRevisionEvent": { "type": "object", "properties": { "revision": { "type": "string", "minLength": 1 } }, "required": [ "revision" ], "additionalProperties": false }, "ProjectBindingLegacyErrorEnvelope": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ false ] }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "CONFIG_NOT_FOUND", "CONFIG_EXISTS", "CONFIG_INVALID", "REQUEST_INVALID", "SERVER_NOT_FOUND", "SERVER_UNAVAILABLE", "SERVER_START_TIMEOUT", "UNKNOWN_OPERATION", "CAPLET_NAMESPACE_COLLISION", "TOOL_NOT_FOUND", "TOOL_CALL_TIMEOUT", "AUTH_REQUIRED", "AUTH_FAILED", "REMOTE_CREDENTIALS_REVOKED", "AUTH_REFRESH_FAILED", "DOWNSTREAM_PROTOCOL_ERROR", "DOWNSTREAM_TOOL_ERROR", "UNSUPPORTED_OPERATION", "UNSUPPORTED_CAPABILITY", "PROMPT_NOT_FOUND", "DOWNSTREAM_RESOURCE_ERROR", "DOWNSTREAM_PROMPT_ERROR", "DOWNSTREAM_COMPLETION_ERROR", "ATTACH_MANIFEST_STALE", "ATTACH_EXPORT_NOT_FOUND", "UNSUPPORTED_TRANSPORT", "PRECONDITION_REQUIRED", "PRECONDITION_FAILED", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "IDEMPOTENCY_CONFLICT", "IDEMPOTENCY_IN_PROGRESS", "IDEMPOTENCY_UNKNOWN", "IDEMPOTENCY_CAPACITY_EXCEEDED", "UPLOAD_CAPACITY_EXCEEDED", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": {} }, "required": [ "code" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false }, "ProjectBindingTextAuthError": { "anyOf": [ { "type": "string", "enum": [ "Unauthorized" ] }, { "type": "string", "enum": [ "Forbidden: access role required" ] } ] }, "ProjectBindingConnectProbe": { "type": "object", "properties": { "error": { "type": "string", "enum": [ "websocket_upgrade_required" ] } }, "required": [ "error" ], "additionalProperties": false }, "ProjectBindingSessionCreateResponse": { "type": "object", "properties": { "binding": { "$ref": "#/components/schemas/ProjectBinding" }, "sessionId": { "type": "string", "minLength": 1 } }, "required": [ "binding", "sessionId" ], "additionalProperties": false }, "ProjectBinding": { "type": "object", "properties": { "bindingId": { "type": "string", "minLength": 1 }, "state": { "$ref": "#/components/schemas/ProjectBindingState" }, "syncState": { "$ref": "#/components/schemas/ProjectBindingSyncState" }, "projectFingerprint": { "type": "string", "minLength": 1 }, "serverProjectRoot": { "type": "string", "minLength": 1 }, "updatedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "bindingId", "state", "syncState", "projectFingerprint", "serverProjectRoot", "updatedAt", "expiresAt" ], "additionalProperties": false }, "ProjectBindingState": { "type": "string", "enum": [ "not_attached", "attaching", "syncing", "ready", "degraded", "blocked", "offline", "cleaning_up", "ended", "expired" ] }, "ProjectBindingSyncState": { "type": "string", "enum": [ "not_started", "pending", "syncing", "idle", "failed" ] }, "ProjectBindingSessionCreateRequest": { "type": "object", "properties": { "projectRoot": { "type": "string", "minLength": 1 }, "projectFingerprint": { "type": "string", "minLength": 1 } }, "required": [ "projectRoot", "projectFingerprint" ], "additionalProperties": false }, "ProjectBindingStatusResponse": { "anyOf": [ { "$ref": "#/components/schemas/ProjectBinding" }, { "type": "object", "properties": { "bindingId": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "not_attached" ] } }, "required": [ "bindingId", "state" ], "additionalProperties": false }, { "type": "object", "properties": { "bindingId": { "type": "string", "minLength": 1 }, "state": { "$ref": "#/components/schemas/ProjectBindingState" }, "syncState": { "$ref": "#/components/schemas/ProjectBindingSyncState" }, "readiness": { "$ref": "#/components/schemas/ProjectBindingReadiness" }, "active": { "type": "boolean", "enum": [ true ] }, "expiresAt": { "type": "string", "format": "date-time" }, "affinity": { "type": "object", "properties": { "ownerNodeId": { "type": "string", "minLength": 1 }, "currentNode": { "type": "boolean" }, "required": { "type": "boolean" } }, "required": [ "ownerNodeId", "currentNode", "required" ], "additionalProperties": false } }, "required": [ "bindingId", "state", "syncState", "readiness", "active", "expiresAt", "affinity" ], "additionalProperties": false }, { "type": "object", "properties": { "bindingId": { "type": "string", "minLength": 1 }, "state": { "$ref": "#/components/schemas/ProjectBindingState" }, "syncState": { "$ref": "#/components/schemas/ProjectBindingSyncState" }, "readiness": { "type": "string", "enum": [ "quarantined" ] }, "active": { "type": "boolean", "enum": [ false ] }, "requiresOperatorRebind": { "type": "boolean", "enum": [ true ] }, "ownerNodeId": { "type": "string", "minLength": 1 } }, "required": [ "bindingId", "state", "syncState", "readiness", "active", "requiresOperatorRebind", "ownerNodeId" ], "additionalProperties": false } ] }, "ProjectBindingReadiness": { "type": "string", "enum": [ "not_ready", "ready", "quarantined" ] }, "ProjectBindingSessionGetResponse": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "binding": { "$ref": "#/components/schemas/ProjectBinding" }, "sessionId": { "type": "string", "minLength": 1 } }, "required": [ "ok", "binding", "sessionId" ], "additionalProperties": false }, "ProjectBindingHeartbeatResponse": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "binding": { "$ref": "#/components/schemas/ProjectBinding" } }, "required": [ "ok", "binding" ], "additionalProperties": false }, "ProjectBindingHeartbeatRequest": { "type": "object", "properties": { "sessionId": { "type": "string", "minLength": 1 }, "state": { "$ref": "#/components/schemas/ProjectBindingState" }, "syncState": { "$ref": "#/components/schemas/ProjectBindingSyncState" } }, "required": [ "sessionId", "state", "syncState" ], "additionalProperties": false }, "ProjectBindingSessionDeleteResponse": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "binding": { "$ref": "#/components/schemas/ProjectBinding" } }, "required": [ "ok", "binding" ], "additionalProperties": false }, "AdminHostSummary": { "type": "object", "properties": { "host": { "type": "object", "properties": { "current": { "type": "boolean", "enum": [ true ] }, "baseUrl": { "type": "string", "format": "uri" }, "dashboardUrl": { "type": "string", "format": "uri" }, "version": { "type": "string" }, "roleModel": { "type": "string", "enum": [ "current-host" ] } }, "required": [ "current", "baseUrl", "dashboardUrl", "version", "roleModel" ], "additionalProperties": false }, "attention": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "pending-login" ] }, "severity": { "type": "string", "enum": [ "warning" ] }, "label": { "type": "string" }, "href": { "type": "string" } }, "required": [ "kind", "severity", "label", "href" ], "additionalProperties": false } }, "sections": { "type": "object", "properties": { "caplets": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0 }, "href": { "type": "string" } }, "required": [ "count", "href" ], "additionalProperties": false }, "catalog": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ], "additionalProperties": false }, "access": { "type": "object", "properties": { "clients": { "type": "integer", "minimum": 0 }, "pending": { "type": "integer", "minimum": 0 }, "href": { "type": "string" } }, "required": [ "clients", "pending", "href" ], "additionalProperties": false }, "vault": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0 }, "href": { "type": "string" } }, "required": [ "count", "href" ], "additionalProperties": false }, "projectBinding": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "connected", "disconnected" ] }, "href": { "type": "string" } }, "required": [ "state", "href" ], "additionalProperties": false }, "runtime": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok", "error" ] }, "href": { "type": "string" } }, "required": [ "status", "href" ], "additionalProperties": false }, "logs": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ], "additionalProperties": false }, "diagnostics": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ], "additionalProperties": false }, "activity": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ], "additionalProperties": false }, "settings": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ], "additionalProperties": false } }, "required": [ "caplets", "catalog", "access", "vault", "projectBinding", "runtime", "logs", "diagnostics", "activity", "settings" ], "additionalProperties": false } }, "required": [ "host", "attention", "sections" ], "additionalProperties": false }, "AdminRuntime": { "type": "object", "properties": { "runtime": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok", "error" ] }, "version": { "type": "string" }, "bind": { "type": "string" }, "baseUrl": { "type": "string", "format": "uri" }, "publicOrigin": { "type": [ "string", "null" ], "format": "uri" }, "reason": { "type": "string" } }, "required": [ "status", "version", "bind", "baseUrl", "publicOrigin" ], "additionalProperties": false }, "daemon": { "type": "object", "properties": { "restartAvailable": { "type": "boolean" }, "stopAvailable": { "type": "boolean" }, "uninstallAvailable": { "type": "boolean" } }, "required": [ "restartAvailable", "stopAvailable", "uninstallAvailable" ], "additionalProperties": false } }, "required": [ "runtime", "daemon" ], "additionalProperties": false }, "AdminRuntimeRestartResult": { "type": "object", "properties": { "restartAvailable": { "type": "boolean", "enum": [ true ] } }, "required": [ "restartAvailable" ], "additionalProperties": false }, "AdminLogPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminLogEntry" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminLogEntry": { "type": "object", "properties": { "timestamp": { "type": "string", "maxLength": 40, "format": "date-time" }, "level": { "type": "string", "enum": [ "trace", "debug", "info", "warn", "error", "fatal" ] }, "message": { "type": "string" }, "source": { "type": "string" } }, "required": [ "timestamp", "level", "message" ], "additionalProperties": false }, "AdminDiagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok", "warning", "error" ] }, "diagnostics": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "detail": { "type": "string" } }, "required": [ "id", "status" ], "additionalProperties": false } }, "checks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "ok", "warning", "error" ] }, "detail": { "type": "string" } }, "required": [ "id", "status" ], "additionalProperties": false } } }, "required": [ "status", "diagnostics", "checks" ], "additionalProperties": false }, "AdminProjectBinding": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "connected", "disconnected" ] }, "affectedCaplets": { "type": "array", "items": { "type": "string" } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "enabled": { "type": "boolean" }, "reason": { "type": "string" } }, "required": [ "id", "label", "enabled" ], "additionalProperties": false } } }, "required": [ "state", "affectedCaplets", "actions" ], "additionalProperties": false }, "AdminRuntimeEvent": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "runtime_health" ] }, "runtime": { "$ref": "#/components/schemas/AdminRuntimeEventRuntime" }, "projectBinding": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "connected", "disconnected" ] } }, "required": [ "state" ], "additionalProperties": false } }, "required": [ "type", "runtime", "projectBinding" ], "additionalProperties": false }, "AdminRuntimeEventRuntime": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "version": { "type": "string" } }, "required": [ "status", "version" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "version": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "status", "version" ], "additionalProperties": false } ] }, "AdminActivityPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminActivityEntry" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminActivityEntry": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "actorClientId": { "type": "string", "minLength": 1 }, "action": { "type": "string", "minLength": 1 }, "outcome": { "type": "string", "enum": [ "success", "failure" ] }, "target": { "type": "object", "properties": { "type": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "label": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false }, "metadata": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } } }, "required": [ "id", "createdAt", "actorClientId", "action", "outcome", "target" ], "additionalProperties": false }, "AdminEffectiveCapletPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminEffectiveCaplet" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminEffectiveCaplet": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "description": { "type": "string" }, "backend": { "type": "string" }, "exposure": { "type": "string", "enum": [ "direct", "progressive", "code_mode", "direct_and_code_mode", "progressive_and_code_mode" ] }, "setupRequired": { "type": "boolean" }, "authRequired": { "type": "boolean" }, "projectBindingRequired": { "type": "boolean" }, "source": { "type": "string" }, "updateState": { "type": "string", "enum": [ "unknown", "locked" ] }, "setupActions": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSetupAction" } } }, "required": [ "id", "name", "description", "backend", "setupRequired", "authRequired", "projectBindingRequired", "updateState", "setupActions" ], "additionalProperties": false }, "AdminSetupAction": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "auth", "vault", "project_binding", "backend_check", "exposure_validation", "code_mode" ] }, "label": { "type": "string" }, "required": { "type": "boolean" } }, "required": [ "kind", "label", "required" ], "additionalProperties": false }, "AdminCatalogEntryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminCatalogEntry" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminCatalogEntry": { "type": "object", "properties": { "entryKey": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "description": { "type": "string" }, "source": { "$ref": "#/components/schemas/AdminCatalogSource" }, "sourcePath": { "type": "string" }, "trustLevel": { "type": "string", "enum": [ "official", "community" ] }, "resolvedRevision": { "type": "string" }, "indexedContentHash": { "type": "string" }, "contentMarkdown": { "type": "string" }, "icon": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "type", "url" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bundled" ] }, "path": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "type", "path", "url" ], "additionalProperties": false } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "setupReadiness": { "type": "string", "enum": [ "ready", "required", "unknown" ] }, "authReadiness": { "type": "string", "enum": [ "ready", "required", "unknown" ] }, "projectBindingReadiness": { "type": "string", "enum": [ "ready", "required", "unknown" ] }, "workflow": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "code_mode", "mcp", "openapi", "google_discovery", "graphql", "http", "cli", "set", "unknown" ] }, "label": { "type": "string" } }, "required": [ "kind", "label" ], "additionalProperties": false }, "children": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "childId": { "type": "string" }, "name": { "type": "string" }, "backend": { "type": "string" }, "workflow": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "code_mode", "mcp", "openapi", "google_discovery", "graphql", "http", "cli", "set", "unknown" ] }, "label": { "type": "string" } }, "required": [ "kind", "label" ], "additionalProperties": false } }, "required": [ "id", "name", "backend", "workflow" ], "additionalProperties": false } }, "installCommand": { "type": "object", "properties": { "text": { "type": "string" }, "copyable": { "type": "boolean" }, "revisionBound": { "type": "boolean" }, "reason": { "type": "string", "enum": [ "revision_unavailable", "revision_install_unsupported", "unsupported_source" ] } }, "required": [ "text", "copyable", "revisionBound" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "unverified_community", "local_control", "mutating_saas", "auth_required", "setup_required", "project_binding_required", "readiness_unknown" ] }, "severity": { "type": "string", "enum": [ "info", "caution", "danger" ] }, "label": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "severity", "label", "message" ], "additionalProperties": false } } }, "required": [ "entryKey", "id", "name", "description", "source", "sourcePath", "trustLevel", "tags", "setupReadiness", "authReadiness", "projectBindingReadiness", "workflow", "installCommand", "warnings" ], "additionalProperties": false }, "AdminCatalogSource": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "github" ] }, "owner": { "type": "string" }, "repo": { "type": "string" }, "repository": { "type": "string" }, "canonicalUrl": { "type": "string", "format": "uri" } }, "required": [ "provider", "owner", "repo", "repository", "canonicalUrl" ], "additionalProperties": false }, "AdminCatalogEntryDetail": { "type": "object", "properties": { "entry": { "$ref": "#/components/schemas/AdminCatalogEntry" }, "setupActions": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSetupAction" } }, "projectScopedInstallAvailable": { "type": "boolean", "enum": [ false ] } }, "required": [ "entry", "setupActions", "projectScopedInstallAvailable" ], "additionalProperties": false }, "AdminCatalogUpdateCandidatePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminCatalogUpdateCandidate" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminCatalogUpdateCandidate": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "locked" ] }, "risk": { "type": "object", "additionalProperties": {} } }, "required": [ "id", "status", "risk" ], "additionalProperties": false }, "AdminCatalogMutationResult": { "type": "object", "properties": { "installed": { "type": "array", "items": { "$ref": "#/components/schemas/AdminCatalogMutationInstalledSummary" }, "maxItems": 500 }, "installedCount": { "type": "integer", "minimum": 0 }, "setupActions": { "type": "array", "items": { "$ref": "#/components/schemas/AdminCatalogMutationSetupActionSummary" }, "maxItems": 6 }, "setupActionCount": { "type": "integer", "minimum": 0 } }, "required": [ "installed", "installedCount", "setupActions", "setupActionCount" ], "additionalProperties": false }, "AdminCatalogMutationInstalledSummary": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "file", "directory" ] }, "status": { "type": "string", "enum": [ "installed", "restored", "updated", "content_updated", "noop" ] }, "catalogIndexing": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "accepted", "already_current", "counted", "ineligible", "rate_limited", "rejected", "revision_unavailable", "suppressed", "unavailable" ] } }, "required": [ "status" ], "additionalProperties": false } }, "required": [ "kind" ], "additionalProperties": false }, "AdminCatalogMutationSetupActionSummary": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "auth", "vault", "project_binding", "backend_check", "exposure_validation", "code_mode" ] }, "required": { "type": "boolean" } }, "required": [ "kind", "required" ], "additionalProperties": false }, "AdminCatalogInstallRequest": { "type": "object", "properties": { "source": { "type": "string", "minLength": 1, "maxLength": 8192 }, "entryKey": { "type": "string", "minLength": 1, "maxLength": 256 }, "repo": { "type": "string", "minLength": 1, "maxLength": 8192 }, "capletIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 500 }, "force": { "type": "boolean" }, "disableCatalogIndexing": { "type": "boolean" } }, "additionalProperties": false }, "AdminCatalogUpdateRequest": { "type": "object", "properties": { "capletIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 500 }, "force": { "type": "boolean" }, "acknowledgeRiskIncrease": { "type": "boolean" }, "disableCatalogIndexing": { "type": "boolean" } }, "additionalProperties": false }, "AdminRemoteClientPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminRemoteClient" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminRemoteClient": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1, "maxLength": 256 }, "clientLabel": { "type": "string", "maxLength": 120 }, "role": { "type": "string", "enum": [ "access", "operator" ] }, "hostUrl": { "type": "string", "maxLength": 32768, "format": "uri" }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "generation": { "type": "integer", "minimum": 0 }, "lastUsedAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "revokedAt": { "type": "string", "maxLength": 40, "format": "date-time" } }, "required": [ "clientId", "clientLabel", "role", "hostUrl", "createdAt", "generation" ], "additionalProperties": false }, "AdminRemoteClientPatch": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "access", "operator" ] } }, "required": [ "role" ], "additionalProperties": false }, "AdminRemoteClientDeleteResult": { "type": "object", "properties": { "revoked": { "type": "boolean" }, "clientId": { "type": "string", "minLength": 1, "maxLength": 256 }, "sessionEnded": { "type": "boolean" } }, "required": [ "revoked", "clientId", "sessionEnded" ], "additionalProperties": false }, "AdminRemoteLoginRequestPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminRemoteLoginRequest" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminRemoteLoginRequest": { "type": "object", "properties": { "flowId": { "type": "string", "minLength": 1, "maxLength": 64 }, "hostUrl": { "type": "string", "maxLength": 32768, "format": "uri" }, "hostIdentity": { "type": "string", "maxLength": 512 }, "status": { "type": "string", "enum": [ "pending", "approved", "denied", "cancelled", "expired", "exchanged" ] }, "requestedRole": { "type": "string", "enum": [ "access", "operator" ] }, "grantedRole": { "type": "string", "enum": [ "access", "operator" ] }, "operatorCodeFingerprint": { "type": "string", "maxLength": 256 }, "clientLabel": { "type": "string", "maxLength": 120 }, "clientFingerprint": { "type": "string", "maxLength": 256 }, "sourceHint": { "type": "string", "maxLength": 256 }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "codeExpiresAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "flowExpiresAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "generation": { "type": "integer", "minimum": 0 }, "approvedAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "deniedAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "cancelledAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "exchangedAt": { "type": "string", "maxLength": 40, "format": "date-time" } }, "required": [ "flowId", "hostUrl", "status", "requestedRole", "clientLabel", "createdAt", "codeExpiresAt", "flowExpiresAt", "generation" ], "additionalProperties": false }, "AdminRemoteLoginRequestPatch": { "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "approve" ] }, "grantedRole": { "type": "string", "enum": [ "access", "operator" ] } }, "required": [ "action" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "deny" ] } }, "required": [ "action" ], "additionalProperties": false } ] }, "AdminBackendAuthConnectionPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminBackendAuthConnection" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminBackendAuthConnection": { "type": "object", "properties": { "server": { "type": "string", "minLength": 1, "maxLength": 512 }, "generation": { "type": "integer", "minimum": 0 }, "status": { "type": "string", "enum": [ "expired", "authenticated" ] }, "authType": { "type": "string", "enum": [ "oauth2", "oidc" ] }, "expiresAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "scope": { "type": "string", "maxLength": 65536 } }, "required": [ "server", "generation", "status" ], "additionalProperties": false }, "AdminBackendAuthDeleteResult": { "type": "object", "properties": { "server": { "type": "string", "minLength": 1, "maxLength": 512 }, "deleted": { "type": "boolean" } }, "required": [ "server", "deleted" ], "additionalProperties": false }, "AdminBackendAuthFlowStartResult": { "anyOf": [ { "type": "object", "properties": { "server": { "type": "string", "minLength": 1, "maxLength": 512 }, "authenticated": { "type": "boolean", "enum": [ true ] } }, "required": [ "server", "authenticated" ], "additionalProperties": false }, { "type": "object", "properties": { "server": { "type": "string", "minLength": 1, "maxLength": 512 }, "flowId": { "type": "string", "minLength": 1, "maxLength": 64 }, "authorizationUrl": { "type": "string", "maxLength": 32768, "format": "uri" } }, "required": [ "server", "flowId", "authorizationUrl" ], "additionalProperties": false } ] }, "AdminBackendAuthFlowStartRequest": { "type": "object", "properties": { "serverId": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "serverId" ], "additionalProperties": false }, "AdminBackendAuthFlow": { "type": "object", "properties": { "flowId": { "type": "string", "minLength": 1, "maxLength": 64 }, "server": { "type": "string", "minLength": 1, "maxLength": 512 }, "status": { "type": "string", "enum": [ "pending", "completing", "completed", "expired", "failed", "unknown" ] }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "expiresAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "updatedAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "claimedAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "terminalAt": { "type": "string", "maxLength": 40, "format": "date-time" } }, "required": [ "flowId", "server", "status", "createdAt", "expiresAt", "updatedAt" ], "additionalProperties": false }, "AdminBackendAuthRefreshRequest": { "type": "object", "properties": { "serverId": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "serverId" ], "additionalProperties": false }, "AdminVaultValuePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminVaultValue" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminVaultValue": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 128 }, "present": { "type": "boolean", "enum": [ true ] }, "generation": { "type": "integer", "minimum": 0 }, "valueBytes": { "type": "integer", "minimum": 0, "maximum": 65536 }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "updatedAt": { "type": "string", "maxLength": 40, "format": "date-time" } }, "required": [ "key", "present", "generation", "valueBytes", "createdAt", "updatedAt" ], "additionalProperties": false }, "AdminVaultValuePutRequest": { "type": "object", "properties": { "value": { "type": "string", "maxLength": 65536 }, "grant": { "type": "string", "minLength": 1, "maxLength": 64 }, "referenceName": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "value" ], "additionalProperties": false }, "AdminVaultValueDeleteResult": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 128 }, "deleted": { "type": "boolean" }, "grantsRetained": { "type": "integer", "minimum": 0 } }, "required": [ "key", "deleted", "grantsRetained" ], "additionalProperties": false }, "AdminVaultGrantPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminVaultGrant" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminVaultGrant": { "type": "object", "properties": { "storedKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "referenceName": { "type": "string", "minLength": 1, "maxLength": 128 }, "capletId": { "type": "string", "minLength": 1, "maxLength": 64 }, "origin": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "kind" ], "additionalProperties": false }, "resourceVersion": { "type": "string", "minLength": 1, "maxLength": 128 }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "updatedAt": { "type": "string", "maxLength": 40, "format": "date-time" } }, "required": [ "storedKey", "referenceName", "capletId", "origin", "resourceVersion", "createdAt", "updatedAt" ], "additionalProperties": false }, "AdminVaultGrantRevokeResult": { "type": "object", "properties": { "revoked": { "type": "array", "items": { "$ref": "#/components/schemas/AdminVaultGrant" }, "maxItems": 1 } }, "required": [ "revoked" ], "additionalProperties": false }, "AdminCapletRecordPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminCapletRecordSummary" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminCapletRecordSummary": { "type": "object", "properties": { "recordKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9_-]+$/u" }, "headGeneration": { "type": "integer", "minimum": 0 }, "historyLimit": { "type": [ "integer", "null" ], "minimum": 0 }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "updatedAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "currentRevision": { "$ref": "#/components/schemas/AdminCapletRevisionSummary" } }, "required": [ "recordKey", "id", "headGeneration", "historyLimit", "createdAt", "updatedAt", "currentRevision" ], "additionalProperties": false }, "AdminCapletRevisionSummary": { "type": "object", "properties": { "revisionKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "sequence": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "maxLength": 80 }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" } }, "required": [ "revisionKey", "sequence", "name", "createdAt" ], "additionalProperties": false }, "AdminCapletRecordDetail": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/AdminCapletRecord" }, "document": { "type": "string" } }, "required": [ "record", "document" ], "additionalProperties": false }, "AdminCapletRecord": { "type": "object", "properties": { "recordKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9_-]+$/u" }, "headGeneration": { "type": "integer", "minimum": 0 }, "historyLimit": { "type": [ "integer", "null" ], "minimum": 0 }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "updatedAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "currentRevision": { "$ref": "#/components/schemas/AdminCapletRevision" } }, "required": [ "recordKey", "id", "headGeneration", "historyLimit", "createdAt", "updatedAt", "currentRevision" ], "additionalProperties": false }, "AdminCapletRevision": { "type": "object", "properties": { "revisionKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "sequence": { "type": "integer", "exclusiveMinimum": 0 }, "name": { "type": "string", "maxLength": 80 }, "description": { "type": "string", "maxLength": 1500 }, "body": { "type": "string" }, "schemaUrl": { "type": [ "string", "null" ], "format": "uri" }, "content": { "type": "object", "additionalProperties": {} }, "contentHash": { "type": "string", "minLength": 1 }, "sourceRevision": { "type": [ "string", "null" ] }, "sourceContentHash": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "actor": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "backends": { "type": "array", "items": { "$ref": "#/components/schemas/AdminCapletBackend" } }, "bundle": { "type": "array", "items": { "$ref": "#/components/schemas/AdminCapletBundleEntry" } } }, "required": [ "revisionKey", "sequence", "name", "description", "body", "schemaUrl", "content", "contentHash", "sourceRevision", "sourceContentHash", "createdAt", "actor", "tags", "backends", "bundle" ], "additionalProperties": false }, "AdminCapletBackend": { "type": "object", "properties": { "family": { "type": "string", "minLength": 1 }, "childId": { "type": [ "string", "null" ] }, "config": { "type": "object", "additionalProperties": {} } }, "required": [ "family", "childId", "config" ], "additionalProperties": false }, "AdminCapletBundleEntry": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1 }, "hash": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string", "minLength": 1 }, "size": { "type": "integer", "minimum": 0 }, "executable": { "type": "boolean" } }, "required": [ "path", "hash", "mediaType", "size", "executable" ], "additionalProperties": false }, "AdminCapletRecordPatch": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9_-]+$/u" }, "document": { "type": "string", "maxLength": 1048576 }, "historyLimit": { "type": [ "integer", "null" ], "exclusiveMinimum": 0 } }, "additionalProperties": false }, "AdminCapletRecordDeleteResult": { "type": "object", "properties": { "deleted": { "type": "boolean", "enum": [ true ] }, "id": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9_-]+$/u" } }, "required": [ "deleted", "id" ], "additionalProperties": false }, "CapletBundleDownload": { "type": "string", "format": "binary" }, "CapletBundleUpload": { "type": "object", "properties": { "manifest": { "type": "string", "description": "JSON bundle manifest. This part must be first." }, "file": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Repeated bundle files in manifest order." } }, "required": [ "manifest", "file" ] }, "AdminCapletRevisionPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminCapletRevisionSummary" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminCapletRevisionDeleteResult": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/AdminCapletRecordSummary" } }, "additionalProperties": false }, "AdminCapletCurrentRevisionPutRequest": { "type": "object", "properties": { "revisionKey": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "revisionKey" ], "additionalProperties": false }, "AdminCapletInstallationPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminCapletInstallation" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminCapletInstallation": { "type": "object", "properties": { "installationKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "capletId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9_-]+$/u" }, "recordKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "generation": { "type": "integer", "minimum": 0 }, "status": { "type": "string", "enum": [ "active", "detached" ] }, "sourceKind": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceIdentity": { "type": "string", "minLength": 1, "maxLength": 65536 }, "channel": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 256 }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "updatedAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "detachedAt": { "type": [ "string", "null" ], "maxLength": 40, "format": "date-time" }, "detachedBy": { "type": [ "string", "null" ], "maxLength": 128 } }, "required": [ "installationKey", "capletId", "recordKey", "generation", "status", "sourceKind", "sourceIdentity", "channel", "createdAt", "updatedAt", "detachedAt", "detachedBy" ], "additionalProperties": false }, "AdminCapletInstallationMutationResult": { "type": "object", "properties": { "installationKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "capletId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9_-]+$/u" }, "recordKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "generation": { "type": "integer", "minimum": 0 }, "status": { "type": "string", "enum": [ "active", "detached" ] }, "createdAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "updatedAt": { "type": "string", "maxLength": 40, "format": "date-time" }, "detachedAt": { "type": [ "string", "null" ], "maxLength": 40, "format": "date-time" } }, "required": [ "installationKey", "capletId", "recordKey", "generation", "status", "createdAt", "updatedAt", "detachedAt" ], "additionalProperties": false }, "AdminCapletInstallationPutRequest": { "type": "object", "properties": { "sourceKind": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceIdentity": { "type": "string", "minLength": 1, "maxLength": 65536 }, "channel": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "sourceKind", "sourceIdentity" ], "additionalProperties": false }, "AdminCapletInstallationDeleteResult": { "type": "object", "properties": { "installationKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "capletId": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9_-]+$/u" }, "deleted": { "type": "boolean", "enum": [ true ] } }, "required": [ "installationKey", "capletId", "deleted" ], "additionalProperties": false }, "AdminCapletInstallationObservationPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdminCapletInstallationObservation" } }, "nextCursor": { "type": "string", "minLength": 1 } }, "required": [ "items" ], "additionalProperties": false }, "AdminCapletInstallationObservation": { "type": "object", "properties": { "observationKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "installationKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "resolvedRevision": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 256 }, "contentHash": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 128 }, "risk": { "$ref": "#/components/schemas/AdminCapletInstallationRisk" }, "status": { "type": "string", "enum": [ "current", "metadata-only", "source-unavailable" ] }, "observedAt": { "type": "string", "maxLength": 40, "format": "date-time" } }, "required": [ "observationKey", "installationKey", "resolvedRevision", "contentHash", "risk", "status", "observedAt" ], "additionalProperties": false }, "AdminCapletInstallationRisk": { "type": [ "object", "null" ], "properties": { "backendFamilies": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 64 }, "safety": { "type": "string", "enum": [ "standard", "mutating_saas", "local_control", "unknown" ] }, "projectBindingRequired": { "type": "boolean" }, "authScopes": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 512 }, "maxItems": 64 }, "runtimeFeatures": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 512 }, "maxItems": 64 }, "mutating": { "type": "boolean" }, "destructive": { "type": "boolean" }, "bodyHash": { "type": "string", "minLength": 1, "maxLength": 128 }, "referenceHash": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "backendFamilies", "safety", "projectBindingRequired", "mutating", "destructive" ], "additionalProperties": false }, "AdminCapletInstallationObservationMutationResult": { "type": "object", "properties": { "observationKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "installationKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "resolvedRevision": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 256 }, "contentHash": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 128 }, "status": { "type": "string", "enum": [ "current", "metadata-only", "source-unavailable" ] }, "observedAt": { "type": "string", "maxLength": 40, "format": "date-time" } }, "required": [ "observationKey", "installationKey", "resolvedRevision", "contentHash", "status", "observedAt" ], "additionalProperties": false }, "AdminCapletInstallationObservationRequest": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "current", "metadata-only", "source-unavailable" ] }, "resolvedRevision": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 256 }, "contentHash": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 128 }, "risk": { "$ref": "#/components/schemas/AdminCapletInstallationRisk" } }, "required": [ "status" ], "additionalProperties": false }, "AdminBackendAuthCallbackResult": { "type": "object", "properties": { "server": { "type": "string", "minLength": 1, "maxLength": 512 }, "authenticated": { "type": "boolean", "enum": [ true ] } }, "required": [ "server", "authenticated" ], "additionalProperties": false } }, "parameters": {} }, "paths": { "/api": { "get": { "operationId": "getServiceDiscovery", "tags": [ "Discovery" ], "security": [], "responses": { "200": { "description": "Successful direct resource representation.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceDiscovery" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1": { "get": { "operationId": "getVersionDiscovery", "tags": [ "Discovery" ], "security": [], "responses": { "200": { "description": "Successful direct resource representation.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionDiscovery" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/healthz": { "get": { "operationId": "getHealth", "tags": [ "Discovery" ], "security": [], "responses": { "200": { "description": "Host is ready.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" } } } }, "503": { "description": "Host is not ready.", "headers": { "Retry-After": { "schema": { "type": "string" }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/remote/login/start": { "post": { "operationId": "startRemoteLogin", "tags": [ "Remote access" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientLabel": { "type": "string", "minLength": 1 }, "clientFingerprint": { "type": "string", "minLength": 1 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Pending Remote Login challenge and completion material.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginStartResponse" } } } }, "400": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "401": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "403": { "description": "Request rejected by host protection.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "404": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "409": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "500": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "503": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "504": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } } } } }, "/api/v1/remote/login/poll": { "post": { "operationId": "pollRemoteLogin", "tags": [ "Remote access" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "flowId": { "type": "string", "minLength": 1 }, "pendingCompletionSecret": { "type": "string", "minLength": 1 } }, "required": [ "flowId", "pendingCompletionSecret" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Current Pending Remote Login status.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginPollResponse" } } } }, "400": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "401": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "403": { "description": "Request rejected by host protection.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "404": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "409": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "500": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "503": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "504": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } } } } }, "/api/v1/remote/login/refresh": { "post": { "operationId": "refreshPendingRemoteLogin", "tags": [ "Remote access" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "flowId": { "type": "string", "minLength": 1 }, "pendingCompletionSecret": { "type": "string", "minLength": 1 }, "pendingRefreshSecret": { "type": "string", "minLength": 1 } }, "required": [ "flowId", "pendingCompletionSecret", "pendingRefreshSecret" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Rotated Pending Remote Login challenge and refresh material.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginRefreshResponse" } } } }, "400": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "401": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "403": { "description": "Request rejected by host protection.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "404": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "409": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "500": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "503": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "504": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } } } } }, "/api/v1/remote/login/complete": { "post": { "operationId": "completeRemoteLogin", "tags": [ "Remote access" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "flowId": { "type": "string", "minLength": 1 }, "pendingCompletionSecret": { "type": "string", "minLength": 1 } }, "required": [ "flowId", "pendingCompletionSecret" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Issued Remote Client credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginCompletionResponse" } } } }, "400": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "401": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "403": { "description": "Request rejected by host protection.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "404": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "409": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "500": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "503": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "504": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } } } } }, "/api/v1/remote/login/cancel": { "post": { "operationId": "cancelRemoteLogin", "tags": [ "Remote access" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "flowId": { "type": "string", "minLength": 1 }, "pendingCompletionSecret": { "type": "string", "minLength": 1 } }, "required": [ "flowId", "pendingCompletionSecret" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Cancelled Pending Remote Login.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginCancelResponse" } } } }, "400": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "401": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "403": { "description": "Request rejected by host protection.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "404": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "409": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "500": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "503": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "504": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } } } } }, "/api/v1/remote/refresh": { "post": { "operationId": "refreshRemoteCredentials", "tags": [ "Remote access" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "refreshToken": { "type": "string", "minLength": 1 } }, "required": [ "refreshToken" ] } } } }, "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteCredentials" } } } }, "400": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "401": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "404": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "409": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "500": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "503": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "504": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } } } } }, "/api/v1/remote/client": { "delete": { "operationId": "revokeCurrentRemoteClient", "tags": [ "Remote access" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteClientDeleteResponse" } } } }, "400": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "401": { "description": "Missing, invalid, or rejected bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "403": { "description": "Request rejected by host protection.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "404": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "409": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "500": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "503": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } }, "504": { "description": "Legacy Remote Login error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteLoginErrorResponse" } } } } } } }, "/api/v1/attach/sessions": { "post": { "operationId": "createAttachSession", "tags": [ "Attach" ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachSessionRequest" } } } }, "responses": { "201": { "description": "Created Attach session.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachSessionCreateResponse" } } } }, "400": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "401": { "description": "Missing or invalid bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "403": { "description": "Request rejected by host protection.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "404": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "409": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "500": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } } } } }, "/api/v1/attach/sessions/{sessionId}": { "delete": { "operationId": "deleteAttachSession", "tags": [ "Attach" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "sessionId", "in": "path" } ], "responses": { "200": { "description": "Closed Attach session.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachSessionDeleteResponse" } } } }, "401": { "description": "Missing or invalid bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "403": { "description": "Request rejected by host protection.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } } } } }, "/api/v1/attach/manifest": { "get": { "operationId": "getAttachManifest", "tags": [ "Attach" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "Caplets-Attach-Session-Id", "in": "header" } ], "responses": { "200": { "description": "Current Attach export manifest.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachManifest" } } } }, "400": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "401": { "description": "Missing or invalid bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "403": { "description": "Request rejected by host protection.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "404": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "409": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "500": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } } } } }, "/api/v1/attach/invoke": { "post": { "operationId": "invokeAttachExport", "tags": [ "Attach" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "Caplets-Attach-Session-Id", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachInvokeRequest" } } } }, "responses": { "200": { "description": "Attach export invocation result.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachInvokeResponse" } } } }, "400": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "401": { "description": "Missing or invalid bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "403": { "description": "Request rejected by host protection.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "404": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "409": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "500": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } } } } }, "/api/v1/attach/events": { "get": { "operationId": "streamAttachEvents", "tags": [ "Attach" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "Caplets-Attach-Session-Id", "in": "header" } ], "responses": { "200": { "description": "Server-sent manifest revision events.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-cache" ] }, "required": true }, "Connection": { "schema": { "type": "string", "enum": [ "keep-alive" ] }, "required": true }, "X-Accel-Buffering": { "schema": { "type": "string", "enum": [ "no" ] }, "required": true } }, "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/AttachManifestRevisionEvent" } } } }, "400": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "401": { "description": "Missing or invalid bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "403": { "description": "Request rejected by host protection.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicV1TextError" } } } }, "404": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "409": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } }, "500": { "description": "Legacy Attach error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachErrorResponse" } } } } } } }, "/api/v1/attach/project-bindings/connect": { "get": { "operationId": "upgradeProjectBindingConnection", "tags": [ "Project Binding" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "bindingId", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "sessionId", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "projectFingerprint", "in": "query" } ], "responses": { "101": { "description": "Switching Protocols response. The server always negotiates `caplets.project-binding.v1`. OpenAPI models only the HTTP upgrade response, not WebSocket message sequencing or payload transport.", "headers": { "Connection": { "schema": { "type": "string", "enum": [ "Upgrade" ] }, "required": true }, "Upgrade": { "schema": { "type": "string", "enum": [ "websocket" ] }, "required": true }, "Sec-WebSocket-Protocol": { "schema": { "type": "string", "enum": [ "caplets.project-binding.v1" ] }, "required": true } } }, "400": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "401": { "description": "Missing or invalid bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } } } }, "403": { "description": "Insufficient role or rejected Project Binding session.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "404": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "409": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "426": { "description": "HTTP probe response when a WebSocket upgrade was not requested.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingConnectProbe" } } } } } } }, "/api/v1/attach/project-bindings/sessions": { "post": { "operationId": "createProjectBindingSession", "tags": [ "Project Binding" ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingSessionCreateRequest" } } } }, "responses": { "201": { "description": "Created Project Binding session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingSessionCreateResponse" } } } }, "400": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "401": { "description": "Missing or invalid bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } } } }, "403": { "description": "Bearer credential lacks the Access Client role.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } } } }, "500": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "503": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } } } } }, "/api/v1/attach/project-bindings/{bindingId}/status": { "get": { "operationId": "getProjectBindingStatus", "tags": [ "Project Binding" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "bindingId", "in": "path" } ], "responses": { "200": { "description": "Current Project Binding status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingStatusResponse" } } } }, "401": { "description": "Missing or invalid bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } } } }, "403": { "description": "Bearer credential lacks the Access Client role.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } } } } } } }, "/api/v1/attach/project-bindings/{bindingId}/session": { "get": { "operationId": "getProjectBindingSession", "tags": [ "Project Binding" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "bindingId", "in": "path" } ], "responses": { "200": { "description": "Current Project Binding session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingSessionGetResponse" } } } }, "401": { "description": "Missing or invalid bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } } } }, "403": { "description": "Bearer credential lacks the Access Client role.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } } } }, "404": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } } } }, "delete": { "operationId": "deleteProjectBindingSession", "tags": [ "Project Binding" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "bindingId", "in": "path" } ], "responses": { "200": { "description": "Ended Project Binding session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingSessionDeleteResponse" } } } }, "400": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "401": { "description": "Missing or invalid bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } } } }, "403": { "description": "Insufficient role or rejected Project Binding session.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "404": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "500": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } } } } }, "/api/v1/attach/project-bindings/{bindingId}/heartbeat": { "post": { "operationId": "heartbeatProjectBindingSession", "tags": [ "Project Binding" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "bindingId", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingHeartbeatRequest" } } } }, "responses": { "200": { "description": "Renewed Project Binding session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingHeartbeatResponse" } } } }, "400": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "401": { "description": "Missing or invalid bearer credential.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } } } }, "403": { "description": "Insufficient role or rejected Project Binding session.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectBindingTextAuthError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "404": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } }, "500": { "description": "Legacy Project Binding v1 JSON error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBindingLegacyErrorEnvelope" } } } } } } }, "/api/v2/admin/host": { "get": { "operationId": "adminV2GetHost", "tags": [ "Admin Host" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminHostSummary" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/runtime": { "get": { "operationId": "adminV2GetRuntime", "tags": [ "Admin Host" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminRuntime" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/runtime-restarts": { "post": { "operationId": "adminV2CreateRuntimeRestart", "tags": [ "Admin Host" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "enum": [ "*" ], "description": "Creation precondition. The target operation resource must not already exist." }, "required": true, "description": "Creation precondition. The target operation resource must not already exist.", "name": "If-None-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } }, "responses": { "201": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Location": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminRuntimeRestartResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/logs": { "get": { "operationId": "adminV2ListLogs", "tags": [ "Admin Host" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminLogPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/diagnostics": { "get": { "operationId": "adminV2GetDiagnostics", "tags": [ "Admin Host" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminDiagnostics" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/project-binding": { "get": { "operationId": "adminV2GetProjectBinding", "tags": [ "Admin Host" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminProjectBinding" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/events": { "get": { "operationId": "adminV2ListEvents", "tags": [ "Admin Host" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "responses": { "200": { "description": "Current Host event stream.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/AdminRuntimeEvent" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/activity": { "get": { "operationId": "adminV2ListActivity", "tags": [ "Admin Host" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[a-z][a-z0-9_.-]{0,127}$" }, "required": false, "name": "action", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminActivityPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/caplets": { "get": { "operationId": "adminV2ListEffectiveCaplets", "tags": [ "Admin Effective Caplets" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminEffectiveCapletPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/catalog/entries": { "get": { "operationId": "adminV2ListCatalogEntries", "tags": [ "Admin Catalog" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "source", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "query", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCatalogEntryPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/catalog/entries/{entryKey}": { "get": { "operationId": "adminV2GetCatalogEntry", "tags": [ "Admin Catalog" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 256 }, "required": true, "name": "entryKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "source", "in": "query" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCatalogEntryDetail" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/catalog/update-candidates": { "get": { "operationId": "adminV2ListCatalogUpdateCandidates", "tags": [ "Admin Catalog" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCatalogUpdateCandidatePage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/catalog/installations": { "post": { "operationId": "adminV2InstallCatalogCaplets", "tags": [ "Admin Catalog" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "enum": [ "*" ], "description": "Creation precondition. The target operation resource must not already exist." }, "required": true, "description": "Creation precondition. The target operation resource must not already exist.", "name": "If-None-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCatalogInstallRequest" } } } }, "responses": { "201": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Location": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCatalogMutationResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/catalog/update-runs": { "post": { "operationId": "adminV2UpdateCatalogCaplets", "tags": [ "Admin Catalog" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "enum": [ "*" ], "description": "Creation precondition. The target operation resource must not already exist." }, "required": true, "description": "Creation precondition. The target operation resource must not already exist.", "name": "If-None-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCatalogUpdateRequest" } } } }, "responses": { "201": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Location": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCatalogMutationResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/remote-clients": { "get": { "operationId": "adminV2ListRemoteClients", "tags": [ "Admin Remote access" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" }, { "schema": { "type": "string", "enum": [ "access", "operator" ] }, "required": false, "name": "role", "in": "query" }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "required": false, "name": "revoked", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminRemoteClientPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/remote-clients/{clientId}": { "get": { "operationId": "adminV2GetRemoteClient", "tags": [ "Admin Remote access" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 256 }, "required": true, "name": "clientId", "in": "path" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminRemoteClient" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "patch": { "operationId": "adminV2UpdateRemoteClient", "tags": [ "Admin Remote access" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 256 }, "required": true, "name": "clientId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/AdminRemoteClientPatch" } } } }, "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminRemoteClient" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "delete": { "operationId": "adminV2DeleteRemoteClient", "tags": [ "Admin Remote access" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 256 }, "required": true, "name": "clientId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminRemoteClientDeleteResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/remote-login-requests": { "get": { "operationId": "adminV2ListRemoteLoginRequests", "tags": [ "Admin Remote access" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" }, { "schema": { "type": "string", "enum": [ "pending", "approved", "denied", "cancelled", "expired", "exchanged" ] }, "required": false, "name": "status", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminRemoteLoginRequestPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/remote-login-requests/{flowId}": { "get": { "operationId": "adminV2GetRemoteLoginRequest", "tags": [ "Admin Remote access" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "flowId", "in": "path" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminRemoteLoginRequest" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "patch": { "operationId": "adminV2UpdateRemoteLoginRequest", "tags": [ "Admin Remote access" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "flowId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/AdminRemoteLoginRequestPatch" } } } }, "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminRemoteLoginRequest" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/backend-auth-connections": { "get": { "operationId": "adminV2ListBackendAuth", "tags": [ "Admin Backend auth" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminBackendAuthConnectionPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/backend-auth-connections/{serverId}": { "get": { "operationId": "adminV2GetBackendAuth", "tags": [ "Admin Backend auth" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "required": true, "name": "serverId", "in": "path" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminBackendAuthConnection" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "delete": { "operationId": "adminV2DeleteBackendAuth", "tags": [ "Admin Backend auth" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "required": true, "name": "serverId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminBackendAuthDeleteResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/backend-auth-flows": { "post": { "operationId": "adminV2StartBackendAuthFlow", "tags": [ "Admin Backend auth" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "enum": [ "*" ], "description": "Creation precondition. The target operation resource must not already exist." }, "required": true, "description": "Creation precondition. The target operation resource must not already exist.", "name": "If-None-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminBackendAuthFlowStartRequest" } } } }, "responses": { "201": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Location": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminBackendAuthFlowStartResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/backend-auth-flows/{flowId}": { "get": { "operationId": "adminV2GetBackendAuthFlow", "tags": [ "Admin Backend auth" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "flowId", "in": "path" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminBackendAuthFlow" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/backend-auth-refreshes": { "post": { "operationId": "adminV2RefreshBackendAuth", "tags": [ "Admin Backend auth" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminBackendAuthRefreshRequest" } } } }, "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminBackendAuthConnection" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/vault-values": { "get": { "operationId": "adminV2ListVaultValues", "tags": [ "Admin Vault" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultValuePage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/vault-values/{storedKey}": { "get": { "operationId": "adminV2GetVaultValue", "tags": [ "Admin Vault" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true, "name": "storedKey", "in": "path" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultValue" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "put": { "operationId": "adminV2PutVaultValue", "tags": [ "Admin Vault" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true, "name": "storedKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag required when replacing an existing resource." }, "required": false, "description": "Strong ETag required when replacing an existing resource.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "enum": [ "*" ], "description": "Use * when creating a resource that must not already exist." }, "required": false, "description": "Use * when creating a resource that must not already exist.", "name": "If-None-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Opaque strong ETag of the current grant named by the request body. Required when that grant exists." }, "required": false, "description": "Opaque strong ETag of the current grant named by the request body. Required when that grant exists.", "name": "X-Caplets-Grant-If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultValuePutRequest" } } } }, "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultValue" } } } }, "201": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Location": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultValue" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "delete": { "operationId": "adminV2DeleteVaultValue", "tags": [ "Admin Vault" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true, "name": "storedKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultValueDeleteResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/vault-grants": { "get": { "operationId": "adminV2ListVaultGrants", "tags": [ "Admin Vault" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "storedKey", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "capletId", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultGrantPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/vault-values/{storedKey}/grants": { "get": { "operationId": "adminV2ListVaultValueGrants", "tags": [ "Admin Vault" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true, "name": "storedKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultGrantPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/vault-values/{storedKey}/grants/{capletId}/{referenceName}": { "get": { "operationId": "adminV2GetVaultGrant", "tags": [ "Admin Vault" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true, "name": "storedKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "capletId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true, "name": "referenceName", "in": "path" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultGrant" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "put": { "operationId": "adminV2PutVaultGrant", "tags": [ "Admin Vault" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true, "name": "storedKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "capletId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true, "name": "referenceName", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag required when replacing an existing resource." }, "required": false, "description": "Strong ETag required when replacing an existing resource.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "enum": [ "*" ], "description": "Use * when creating a resource that must not already exist." }, "required": false, "description": "Use * when creating a resource that must not already exist.", "name": "If-None-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } }, "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultGrant" } } } }, "201": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Location": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultGrant" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "delete": { "operationId": "adminV2RevokeVaultAccess", "tags": [ "Admin Vault" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true, "name": "storedKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "capletId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true, "name": "referenceName", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminVaultGrantRevokeResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/caplet-records": { "get": { "operationId": "adminV2ListCapletRecords", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "source", "in": "query" }, { "schema": { "type": "string", "enum": [ "active", "detached" ] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "tag", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "search", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletRecordPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/caplet-records/{id}": { "get": { "operationId": "adminV2GetCapletRecord", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletRecordDetail" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "patch": { "operationId": "adminV2UpdateCapletRecord", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/AdminCapletRecordPatch" } } } }, "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false }, "Location": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletRecordSummary" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "delete": { "operationId": "adminV2DeleteCapletRecord", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletRecordDeleteResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/caplet-records/{id}/bundle": { "get": { "operationId": "adminV2GetCapletRecordBundle", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Streaming manifest-first Caplet Bundle.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Content-Disposition": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "multipart/mixed": { "schema": { "$ref": "#/components/schemas/CapletBundleDownload" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "put": { "operationId": "adminV2PutCapletRecordBundle", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag required when replacing an existing resource." }, "required": false, "description": "Strong ETag required when replacing an existing resource.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "enum": [ "*" ], "description": "Use * when creating a resource that must not already exist." }, "required": false, "description": "Use * when creating a resource that must not already exist.", "name": "If-None-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CapletBundleUpload" } } } }, "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletRecordSummary" } } } }, "201": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Location": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletRecordSummary" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/caplet-records/{id}/revisions": { "get": { "operationId": "adminV2ListCapletRecordRevisions", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletRevisionPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/caplet-records/{id}/revisions/{revisionKey}": { "get": { "operationId": "adminV2GetCapletRecordRevision", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "revisionKey", "in": "path" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletRecordDetail" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "delete": { "operationId": "adminV2DeleteCapletRecordRevision", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "revisionKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Opaque strong ETag of the current parent Caplet Record. Required in addition to the target revision If-Match." }, "required": true, "description": "Opaque strong ETag of the current parent Caplet Record. Required in addition to the target revision If-Match.", "name": "X-Caplets-Parent-If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletRevisionDeleteResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/caplet-records/{id}/revisions/{revisionKey}/bundle": { "get": { "operationId": "adminV2GetCapletRecordRevisionBundle", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "revisionKey", "in": "path" } ], "responses": { "200": { "description": "Streaming manifest-first Caplet Bundle.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Content-Disposition": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "multipart/mixed": { "schema": { "$ref": "#/components/schemas/CapletBundleDownload" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/caplet-records/{id}/current-revision": { "put": { "operationId": "adminV2PutCapletRecordCurrentRevision", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletCurrentRevisionPutRequest" } } } }, "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletRecordSummary" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/caplet-records/{id}/installations": { "get": { "operationId": "adminV2ListCapletRecordInstallations", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletInstallationPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/caplet-records/{id}/installations/{installationKey}": { "get": { "operationId": "adminV2GetCapletRecordInstallation", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "installationKey", "in": "path" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletInstallation" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "put": { "operationId": "adminV2PutCapletRecordInstallation", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "installationKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag required when replacing an existing resource." }, "required": false, "description": "Strong ETag required when replacing an existing resource.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "enum": [ "*" ], "description": "Use * when creating a resource that must not already exist." }, "required": false, "description": "Use * when creating a resource that must not already exist.", "name": "If-None-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletInstallationPutRequest" } } } }, "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletInstallationMutationResult" } } } }, "201": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Location": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletInstallationMutationResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "delete": { "operationId": "adminV2DeleteCapletRecordInstallation", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "installationKey", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletInstallationDeleteResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/caplet-records/{id}/installation-observations": { "get": { "operationId": "adminV2ListCapletRecordInstallationObservations", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "enum": [ "desc" ], "description": "Omit for ascending order; pass desc for descending order." }, "required": false, "description": "Omit for ascending order; pass desc for descending order.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "Cursor page of resources.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletInstallationObservationPage" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "operationId": "adminV2CreateCapletRecordInstallationObservation", "tags": [ "Admin Caplet Records" ], "security": [ { "bearerAuth": [] }, { "dashboardSession": [] } ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response." }, "required": true, "description": "Principal-scoped retry key. Reuse with the same validated request replays the finalized response.", "name": "Idempotency-Key", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Strong ETag of the current resource. Required for an existing resource mutation." }, "required": true, "description": "Strong ETag of the current resource. Required for an existing resource mutation.", "name": "If-Match", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication." }, "required": false, "description": "Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.", "name": "X-Caplets-CSRF", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletInstallationObservationRequest" } } } }, "responses": { "201": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "ETag": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Location": { "schema": { "type": "string", "minLength": 1 }, "required": true }, "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "required": false } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCapletInstallationObservationMutationResult" } } } }, "401": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/admin/backend-auth-flows/{flowId}/callback": { "get": { "operationId": "adminV2CompleteBackendAuthFlowCallback", "tags": [ "Admin Backend auth" ], "security": [], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "required": true, "name": "flowId", "in": "path" }, { "schema": { "type": "string" }, "required": false, "name": "code", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "state", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "error", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "error_description", "in": "query" } ], "responses": { "200": { "description": "Successful direct resource representation.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminBackendAuthCallbackResult" } } } }, "default": { "description": "RFC 9457 Problem Details. Sensitive implementation details are redacted.", "headers": { "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] }, "required": true }, "Retry-After": { "schema": { "type": "string", "minLength": 1 }, "required": false } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } } }, "webhooks": {} }