Generated API Reference
Generated from ../soha/contracts/openapi/soha-api.yaml (Soha API 0.2.0).
This page is generated by npm run api:reference:generate. Run npm run api:reference:check before publishing docs changes.
This index describes the checked-out contracts and may include unreleased additions. The schema version does not identify deployed feature availability. Check the authentication requirements before using CLI v2 endpoints.
Operation Index
Access
GET /api/v1/access/permissions-getPermissionCatalog. Schemas:PermissionCatalogEnvelope.GET /api/v1/access/roles-listAccessRoles. Schemas:AccessRoleListEnvelope.POST /api/v1/access/roles-createAccessRole. Schemas:AccessRoleEnvelope,AccessRoleInput.DELETE /api/v1/access/roles/:accessRoleID-deleteAccessRole. Schemas:AccessRoleDeleteResult.GET /api/v1/access/roles/:accessRoleID-getAccessRole. Schemas:AccessRoleEnvelope.PUT /api/v1/access/roles/:accessRoleID-updateAccessRole. Schemas:AccessRoleEnvelope,AccessRoleInput.GET /api/v1/access/scope-grants-listScopeGrants. Schemas:ScopeGrantListEnvelope.POST /api/v1/access/scope-grants-createScopeGrant. Schemas:ScopeGrantEnvelope,ScopeGrantInput.DELETE /api/v1/access/scope-grants/:scopeGrantID-deleteScopeGrant.PUT /api/v1/access/scope-grants/:scopeGrantID-updateScopeGrant. Schemas:ScopeGrantEnvelope,ScopeGrantInput.GET /api/v1/access/teams/:teamID/scope-grants-listTeamScopeGrants. Schemas:ScopeGrantListEnvelope.POST /api/v1/access/teams/:teamID/scope-grants-createTeamScopeGrant. Schemas:ScopeGrantEnvelope,ScopeGrantInput.DELETE /api/v1/access/teams/:teamID/scope-grants/:scopeGrantID-deleteTeamScopeGrant.PUT /api/v1/access/teams/:teamID/scope-grants/:scopeGrantID-updateTeamScopeGrant. Schemas:ScopeGrantEnvelope,ScopeGrantInput.GET /api/v1/access/users/:userID/scope-grants-listUserScopeGrants. Schemas:ScopeGrantListEnvelope.POST /api/v1/access/users/:userID/scope-grants-createUserScopeGrant. Schemas:ScopeGrantEnvelope,ScopeGrantInput.DELETE /api/v1/access/users/:userID/scope-grants/:scopeGrantID-deleteUserScopeGrant.PUT /api/v1/access/users/:userID/scope-grants/:scopeGrantID-updateUserScopeGrant. Schemas:ScopeGrantEnvelope,ScopeGrantInput.
Agent
GET /api/v1/ssh/capability-getAgentSSHCapability. Schemas:AgentSSHCapability.POST /api/v1/ssh/sessions-prepareAgentSSHSession. Schemas:AgentSSHSessionRequest.GET /api/v1/ssh/sessions/:sessionID/stream-streamAgentSSHSession. Schemas:VirtualMachineSSHFrame.POST /api/v1/virtualization/ssh-sessions/:sessionID/execution-status-checkVMSSHCommandAuthorization. Schemas:VMSSHCredentialRedemptionInput,VirtualMachineSSHCommandEnvelope.
Agent Fleet
GET /api/v1/ai/agent-providers/conformance-runs-listAgentProviderConformanceRuns. Schemas:AgentProviderConformanceRunListEnvelope.POST /api/v1/ai/agent-providers/conformance-runs-createAgentProviderConformanceRun. Schemas:AgentProviderConformanceRunEnvelope,AgentProviderConformanceRunInput.GET /api/v1/ai/agent-providers/rollouts-listAgentProviderRollouts. Schemas:AgentProviderRolloutListEnvelope.POST /api/v1/ai/agent-providers/rollouts-createAgentProviderRollout. Schemas:AgentProviderRolloutEnvelope,AgentProviderRolloutInput.POST /api/v1/ai/agent-providers/rollouts/:rolloutID/:rolloutAction-transitionAgentProviderRollout. Schemas:AgentProviderRolloutEnvelope.POST /api/v1/ai/environments/gc-collectExpiredAIEnvironmentLeases. Schemas:AIProductionOperationEnvelope.GET /api/v1/ai/environments/leases-listAIEnvironmentLeases. Schemas:AIEnvironmentLeaseListEnvelope.POST /api/v1/ai/environments/leases/:leaseID/release-releaseAIEnvironmentLease. Schemas:AIEnvironmentLeaseEnvelope.GET /api/v1/ai/environments/templates-listAIEnvironmentTemplates. Schemas:AIEnvironmentTemplateListEnvelope.POST /api/v1/ai/environments/templates-putAIEnvironmentTemplate. Schemas:AIEnvironmentTemplateEnvelope,AIEnvironmentTemplateInput.GET /api/v1/ai/operations-listAIProductionOperations. Schemas:AIProductionOperationListEnvelope.POST /api/v1/ai/operations-startAIProductionOperation. Schemas:AIProductionOperationEnvelope,AIProductionOperationInput.GET /api/v1/ai/operations/runbook-evidence-listAIProductionRunbookEvidence. Schemas:AIRunbookEvidenceListEnvelope.
Agent Providers
GET /api/v1/ai/agent-providers/catalog-getAgentProviderCatalog. Schemas:AgentProviderCatalogEnvelope.POST /api/v1/ai/agent-providers/registry-acks-acknowledgeAgentProviderRegistry. Schemas:AgentProviderRegistryAcknowledgement,AgentProviderRegistryAcknowledgementEnvelope.GET /api/v1/ai/agent-providers/registry-snapshot-getAgentProviderRegistrySnapshot. Schemas:AgentProviderRegistrySnapshotEnvelope.GET /api/v1/ai/agent-providers/runtime-status-getAgentProviderRuntimeStatus. Schemas:AgentProviderRuntimeStatusEnvelope.
AI Gateway
GET /api/v1/ai-gateway/approval-requests-listAIGatewayApprovalRequests. Schemas:ApprovalRequestListEnvelope,RiskLevel.- Status:
implemented - Permissions:
ai.gateway.manage,approval candidate or related actor visibility - Scopes: approval id or status; actor, AI client, skill, tool, risk, and strategy filters; time range and limit
- Audit: Reads approval request summaries and backend-derived approvalTrace metadata without replaying tools or exposing unredacted tool input.
- Examples: HTTP request
GET /api/v1/ai-gateway/approval-requests?status=pending&limit=100
- Status:
POST /api/v1/ai-gateway/approval-requests/:requestID/:action-decideAIGatewayApprovalRequest. Schemas:ApprovalDecisionInput,ApprovalDecisionResultEnvelope.- Status:
implemented - Permissions:
approval candidate authorization,ai.gateway.manage for authorized Gateway administration - Scopes: requestID; action approve, reject, or cancel; decision comment; approval routing quorum, stage, role, team, and change-window requirements; original grant, policy, skill binding, and business authorization during replay
- Audit: Records approval decisions and stage transitions; approvals that satisfy routing replay the original tool only after current Gateway and business authorization are rechecked.
- Examples: HTTP request
POST /api/v1/ai-gateway/approval-requests/:requestID/approve
- Status:
GET /api/v1/ai-gateway/approval-requests/:requestID/timeline-getAIGatewayApprovalTimeline. Schemas:ApprovalTimelineEnvelope.- Status:
implemented - Permissions:
ai.gateway.manage,approval candidate or related actor visibility - Scopes: approval request id; approval routing trace; related workflow or execution task ids; same-request Gateway audit events
- Audit: Reads the approval request, decision/stage trace, related workflow or task links, and same-request Gateway audit events without mutating approval state.
- Examples: HTTP request
GET /api/v1/ai-gateway/approval-requests/:requestID/timeline
- Status:
GET /api/v1/ai-gateway/audit-logs-listAIGatewayAuditLogs. Schemas:AuditLogListEnvelope,RiskLevel.- Status:
implemented - Permissions:
ai.gateway.manage - Scopes: actor, AI client, skill, tool, approval request, risk, result, and action filters; time range; result limit
- Audit: Reads the dedicated AI Gateway audit projection with redacted request/result metadata and without raw tool input, tokens, kubeconfigs, environment variables, or raw log bodies.
- Examples: HTTP request
GET /api/v1/ai-gateway/audit-logs?riskLevel=high&limit=100
- Status:
GET /api/v1/ai-gateway/capabilities-getAIGatewayCapabilities. Schemas:AIGatewayManifestEnvelope.- Status:
implemented - Permissions:
ai.gateway.view - Scopes: caller principal; optional AI client context; optional skill context
- Audit: Records the caller, source, optional AI client, and skill context while returning only permission-filtered capabilities.
- Examples: Response fixture
../soha/contracts/examples/openapi/gateway-manifest-envelope.json; HTTP requestGET /api/v1/ai-gateway/capabilities
- Status:
GET /api/v1/ai-gateway/governance/status-getAIGatewayGovernanceStatus. Schemas:GovernanceStatusEnvelope.- Status:
implemented - Permissions:
ai.gateway.manage - Scopes: Gateway administration surface; audit aggregation window from 1 to 168 hours
- Audit: Reads recent Gateway audit aggregates and returns redacted governance summaries, findings, coverage state, and recommendation actions without exposing raw tool input or token values.
- Examples: HTTP request
GET /api/v1/ai-gateway/governance/status?windowHours=24
- Status:
POST /api/v1/ai-gateway/governed-credentials/personal-access-tokens-createGovernedPersonalAccessToken. Schemas:CreatedPersonalAccessTokenEnvelope,PersonalAccessTokenInput.POST /api/v1/ai-gateway/governed-credentials/personal-access-tokens/:tokenID/rotate-rotateGovernedPersonalAccessToken. Schemas:CreatedPersonalAccessTokenEnvelope,TokenRotationInput.POST /api/v1/ai-gateway/governed-credentials/service-account-tokens/:tokenID/rotate-rotateGovernedServiceAccountToken. Schemas:CreatedServiceAccountTokenEnvelope,TokenRotationInput.POST /api/v1/ai-gateway/governed-credentials/service-accounts/:serviceAccountID/tokens-createGovernedServiceAccountToken. Schemas:CreatedServiceAccountTokenEnvelope,ServiceAccountTokenInput.POST /api/v1/ai-gateway/llm/:openaiCompatibleProvider/v1/audio/speech-createAIGatewayOpenAICompatibleProviderAudioSpeech. Schemas:OpenAIAudioSpeechRequest.POST /api/v1/ai-gateway/llm/:openaiCompatibleProvider/v1/audio/transcriptions-createAIGatewayOpenAICompatibleProviderAudioTranscription. Schemas:NativeProviderObject,OpenAIAudioTranscriptionRequest.POST /api/v1/ai-gateway/llm/:openaiCompatibleProvider/v1/audio/translations-createAIGatewayOpenAICompatibleProviderAudioTranslation. Schemas:NativeProviderObject,OpenAIAudioTranslationRequest.POST /api/v1/ai-gateway/llm/:openaiCompatibleProvider/v1/chat/completions-createAIGatewayOpenAICompatibleProviderChatCompletion. Schemas:NativeProviderObject,OpenAIChatCompletionRequest.POST /api/v1/ai-gateway/llm/:openaiCompatibleProvider/v1/embeddings-createAIGatewayOpenAICompatibleProviderEmbedding. Schemas:NativeProviderObject,OpenAIEmbeddingRequest.POST /api/v1/ai-gateway/llm/:openaiCompatibleProvider/v1/images/edits-createAIGatewayOpenAICompatibleProviderImageEdit. Schemas:NativeProviderObject,OpenAIImageEditRequest.POST /api/v1/ai-gateway/llm/:openaiCompatibleProvider/v1/images/generations-createAIGatewayOpenAICompatibleProviderImageGeneration. Schemas:NativeProviderObject,OpenAIImageGenerationRequest.POST /api/v1/ai-gateway/llm/:openaiCompatibleProvider/v1/images/variations-createAIGatewayOpenAICompatibleProviderImageVariation. Schemas:NativeProviderObject,OpenAIImageVariationRequest.GET /api/v1/ai-gateway/llm/:openaiCompatibleProvider/v1/models-listAIGatewayOpenAICompatibleProviderModels. Schemas:OpenAIModelsResponse.POST /api/v1/ai-gateway/llm/:openaiCompatibleProvider/v1/responses-createAIGatewayOpenAICompatibleProviderResponse. Schemas:NativeProviderObject,OpenAIResponseRequest.POST /api/v1/ai-gateway/llm/anthropic/v1/messages-createAIGatewayAnthropicMessage. Schemas:AnthropicMessagesRequest,NativeProviderObject.GET /api/v1/ai-gateway/llm/anthropic/v1/models-listAIGatewayAnthropicModels. Schemas:AnthropicModelsResponse.POST /api/v1/ai-gateway/llm/cohere/v2/rerank-createAIGatewayCohereRerank. Schemas:CohereRerankRequest,NativeProviderObject.POST /api/v1/ai-gateway/llm/gemini/v1beta/interactions-createAIGatewayGeminiInteractions. Schemas:GeminiInteractionsRequest,NativeProviderObject.GET /api/v1/ai-gateway/llm/gemini/v1beta/models-listAIGatewayGeminiModels. Schemas:GeminiModelsResponse.POST /api/v1/ai-gateway/llm/gemini/v1beta/models/:geminiModel:generateContent-createAIGatewayGeminiGenerateContent. Schemas:GeminiGenerateContentRequest,NativeProviderObject.POST /api/v1/ai-gateway/llm/gemini/v1beta/models/:geminiModel:streamGenerateContent-createAIGatewayGeminiStreamGenerateContent. Schemas:GeminiGenerateContentRequest.POST /api/v1/ai-gateway/llm/openai/v1/audio/speech-createAIGatewayOpenAIAudioSpeech. Schemas:OpenAIAudioSpeechRequest.POST /api/v1/ai-gateway/llm/openai/v1/audio/transcriptions-createAIGatewayOpenAIAudioTranscription. Schemas:NativeProviderObject,OpenAIAudioTranscriptionRequest.POST /api/v1/ai-gateway/llm/openai/v1/audio/translations-createAIGatewayOpenAIAudioTranslation. Schemas:NativeProviderObject,OpenAIAudioTranslationRequest.POST /api/v1/ai-gateway/llm/openai/v1/chat/completions-createAIGatewayOpenAIChatCompletion. Schemas:NativeProviderObject,OpenAIChatCompletionRequest.POST /api/v1/ai-gateway/llm/openai/v1/embeddings-createAIGatewayOpenAIEmbedding. Schemas:NativeProviderObject,OpenAIEmbeddingRequest.POST /api/v1/ai-gateway/llm/openai/v1/images/edits-createAIGatewayOpenAIImageEdit. Schemas:NativeProviderObject,OpenAIImageEditRequest.POST /api/v1/ai-gateway/llm/openai/v1/images/generations-createAIGatewayOpenAIImageGeneration. Schemas:NativeProviderObject,OpenAIImageGenerationRequest.POST /api/v1/ai-gateway/llm/openai/v1/images/variations-createAIGatewayOpenAIImageVariation. Schemas:NativeProviderObject,OpenAIImageVariationRequest.GET /api/v1/ai-gateway/llm/openai/v1/models-listAIGatewayOpenAIModels. Schemas:OpenAIModelsResponse.GET /api/v1/ai-gateway/llm/openai/v1/realtime-connectAIGatewayOpenAIRealtime.POST /api/v1/ai-gateway/llm/openai/v1/responses-createAIGatewayOpenAIResponse. Schemas:NativeProviderObject,OpenAIResponseRequest.GET /api/v1/ai-gateway/personal-access-tokens-listPersonalAccessTokens. Schemas:PersonalAccessTokenListEnvelope.- Status:
implemented - Permissions:
authenticated Gateway principal,ai.gateway.manage for cross-subject queries - Scopes: current user by default; optional scope filter; optional userId filter for privileged queries
- Audit: Returns token metadata and tokenPrefix only; token values and token hashes are never returned by the listing boundary.
- Examples: HTTP request
GET /api/v1/ai-gateway/personal-access-tokens?scope=default
- Status:
POST /api/v1/ai-gateway/personal-access-tokens-createPersonalAccessToken. Schemas:CreatedPersonalAccessTokenEnvelope,PersonalAccessTokenInput.- Status:
implemented - Permissions:
authenticated Gateway principal,requested permissionKeys must be valid for the caller - Scopes: token scopes; permissionKeys; optional expiresAt; optional metadata
- Audit: Creates an opaque personal Gateway token and returns the clear value once; persistent storage keeps only the hash and display prefix.
- Examples: HTTP request
POST /api/v1/ai-gateway/personal-access-tokens
- Status:
POST /api/v1/ai-gateway/personal-access-tokens/:tokenID/revoke-revokePersonalAccessToken. Schemas:OperationStatus.- Status:
implemented - Permissions:
token owner,ai.gateway.manage for delegated administration - Scopes: personal access token id; current principal ownership or privileged administration
- Audit: Revokes a personal Gateway token by id, invalidating future bearer use while recording the token lifecycle action without exposing token values or hashes.
- Examples: HTTP request
POST /api/v1/ai-gateway/personal-access-tokens/:tokenID/revoke
- Status:
POST /api/v1/ai-gateway/personal-access-tokens/:tokenID/rotate-rotatePersonalAccessToken. Schemas:CreatedPersonalAccessTokenEnvelope,TokenRotationInput.- Status:
implemented - Permissions:
token owner,ai.gateway.manage for delegated administration - Scopes: personal access token id; replacement token scopes and permissionKeys; optional expiresAt and metadata
- Audit: Rotates a personal Gateway token and returns the replacement clear value once; storage keeps only the new hash/display prefix and audit records the lifecycle action.
- Examples: HTTP request
POST /api/v1/ai-gateway/personal-access-tokens/:tokenID/rotate
- Status:
POST /api/v1/ai-gateway/plans/validate-validateCapabilityPlan. Schemas:CapabilityPlanValidationEnvelope,CapabilityTaskInput.POST /api/v1/ai-gateway/prompts/get-getAIGatewayPrompt. Schemas:PromptGetRequest,PromptGetResultEnvelope.- Status:
implemented - Permissions:
ai.gateway.invoke,associated prompt or tool business permission - Scopes: prompt name; prompt arguments and context; optional AI client and skill binding
- Audit: Writes Gateway audit for prompt reads with caller, AI client, skill, prompt name, arguments/context, and redacted related metadata; prompt content is assembled by the backend.
- Examples: HTTP request
POST /api/v1/ai-gateway/prompts/get
- Status:
POST /api/v1/ai-gateway/relay/cache/purge-purgeAIGatewayRelayCache. Schemas:LLMRelayCachePurgeRequest,LLMRelayCachePurgeResultEnvelope.GET /api/v1/ai-gateway/relay/cache/stats-getAIGatewayRelayCacheStats. Schemas:LLMRelayCacheStatsEnvelope.GET /api/v1/ai-gateway/relay/metrics-getAIGatewayRelayMetrics. Schemas:LLMRelayMetricsEnvelope.GET /api/v1/ai-gateway/relay/model-calls-listAIGatewayRelayModelCalls. Schemas:LLMCallLogListEnvelope.GET /api/v1/ai-gateway/relay/model-routes-listAIGatewayRelayModelRoutes. Schemas:LLMModelRouteListEnvelope.POST /api/v1/ai-gateway/relay/model-routes-createAIGatewayRelayModelRoute. Schemas:LLMModelRouteEnvelope,LLMModelRouteInput.DELETE /api/v1/ai-gateway/relay/model-routes/:routeID-deleteAIGatewayRelayModelRoute. Schemas:OperationStatus.PUT /api/v1/ai-gateway/relay/model-routes/:routeID-updateAIGatewayRelayModelRoute. Schemas:LLMModelRouteEnvelope,LLMModelRouteInput.GET /api/v1/ai-gateway/relay/upstreams-listAIGatewayRelayUpstreams. Schemas:LLMUpstreamListEnvelope.POST /api/v1/ai-gateway/relay/upstreams-createAIGatewayRelayUpstream. Schemas:LLMUpstreamEnvelope,LLMUpstreamInput.PUT /api/v1/ai-gateway/relay/upstreams/:upstreamID-updateAIGatewayRelayUpstream. Schemas:LLMUpstreamEnvelope,LLMUpstreamInput.POST /api/v1/ai-gateway/relay/upstreams/:upstreamID/test-testAIGatewayRelayUpstream. Schemas:LLMUpstreamTestRequest,LLMUpstreamTestResultEnvelope.POST /api/v1/ai-gateway/relay/upstreams/health-checks/run-runAIGatewayRelayHealthChecks. Schemas:LLMRelayHealthCheckRunEnvelope.POST /api/v1/ai-gateway/relay/upstreams/test-testAIGatewayRelayUpstreamDraft. Schemas:LLMUpstreamInput,LLMUpstreamTestResultEnvelope.POST /api/v1/ai-gateway/resources/read-readAIGatewayResource. Schemas:ResourceReadRequest,ResourceReadResultEnvelope.- Status:
implemented - Permissions:
ai.gateway.invoke,associated capability business permission - Scopes: manifest resource visibility; resource URI or name; resource context such as cluster, namespace, application, or environment; optional AI client and skill binding
- Audit: Writes Gateway audit for resource reads with caller, AI client, skill, resource identity, request context, and redacted related metadata; the local MCP process only proxies the backend boundary.
- Examples: HTTP request
POST /api/v1/ai-gateway/resources/read
- Status:
GET /api/v1/ai-gateway/service-account-tokens-listServiceAccountTokens. Schemas:ServiceAccountTokenListEnvelope.- Status:
implemented - Permissions:
ai.gateway.manage - Scopes: service-account token inventory; service account subject; token scopes and permissionKeys
- Audit: Returns service-account token metadata and tokenPrefix only; clear token values and hashes are excluded from list responses.
- Examples: HTTP request
GET /api/v1/ai-gateway/service-account-tokens
- Status:
POST /api/v1/ai-gateway/service-account-tokens/:tokenID/revoke-revokeServiceAccountToken. Schemas:OperationStatus.- Status:
implemented - Permissions:
ai.gateway.manage - Scopes: service-account token id; service account subject; automation token lifecycle administration
- Audit: Revokes a service-account Gateway token by id, invalidating future automation bearer use while recording the lifecycle action without exposing token values or hashes.
- Examples: HTTP request
POST /api/v1/ai-gateway/service-account-tokens/:tokenID/revoke
- Status:
POST /api/v1/ai-gateway/service-account-tokens/:tokenID/rotate-rotateServiceAccountToken. Schemas:CreatedServiceAccountTokenEnvelope,TokenRotationInput.- Status:
implemented - Permissions:
ai.gateway.manage - Scopes: service-account token id; replacement token scopes and permissionKeys; optional expiresAt and metadata
- Audit: Rotates a service-account Gateway token and returns the replacement clear value once; storage keeps only the new hash/display prefix and audit records the lifecycle action.
- Examples: HTTP request
POST /api/v1/ai-gateway/service-account-tokens/:tokenID/rotate
- Status:
GET /api/v1/ai-gateway/service-accounts-listServiceAccounts. Schemas:ServiceAccountListEnvelope.- Status:
implemented - Permissions:
ai.gateway.manage - Scopes: service identity inventory; roleIds, teamIds, and scopeGrantIds visibility
- Audit: Returns service-account metadata and ownership boundaries without exposing service-account token values or hashes.
- Examples: HTTP request
GET /api/v1/ai-gateway/service-accounts
- Status:
POST /api/v1/ai-gateway/service-accounts-createServiceAccount. Schemas:ServiceAccountEnvelope,ServiceAccountInput.- Status:
implemented - Permissions:
ai.gateway.manage - Scopes: service account id and status; roleIds; teamIds; scopeGrantIds; optional owner and metadata
- Audit: Creates a bounded service identity for automation use while keeping roles, teams, and scope grants explicit for later token evaluation.
- Examples: HTTP request
POST /api/v1/ai-gateway/service-accounts
- Status:
POST /api/v1/ai-gateway/service-accounts/:serviceAccountID/tokens-createServiceAccountToken. Schemas:CreatedServiceAccountTokenEnvelope,ServiceAccountTokenInput.- Status:
implemented - Permissions:
ai.gateway.manage - Scopes: serviceAccountID; token scopes; permissionKeys; optional expiresAt; optional metadata
- Audit: Creates an opaque service-account Gateway token and returns the clear value once; persistent storage keeps only the hash and display prefix.
- Examples: HTTP request
POST /api/v1/ai-gateway/service-accounts/:serviceAccountID/tokens
- Status:
GET /api/v1/ai-gateway/tasks-listCapabilityTasks. Schemas:CapabilityTaskListEnvelope.POST /api/v1/ai-gateway/tasks-createCapabilityTask. Schemas:CapabilityTaskEnvelope,CapabilityTaskInput.GET /api/v1/ai-gateway/tasks/:taskId-getCapabilityTask. Schemas:CapabilityTaskEnvelope.POST /api/v1/ai-gateway/tasks/:taskId/cancel-cancelCapabilityTask. Schemas:CapabilityTaskEnvelope.POST /api/v1/ai-gateway/tasks/:taskId/resume-resumeCapabilityTask. Schemas:CapabilityTaskEnvelope,CapabilityTaskRevisionInput.POST /api/v1/ai-gateway/tools/:toolName/invoke-invokeAIGatewayTool. Schemas:ToolInvocationRequest,ToolInvocationResultEnvelope.- Status:
implemented - Permissions:
ai.gateway.invoke,owning tool business permission - Scopes: tool grant or access policy; tool-required resource scope such as cluster or namespace; optional AI client and skill binding
- Audit: Writes the standard audit record and ai_gateway_audit_logs with actor, AI client, skill, tool, risk, redacted request/result, and related IDs.
- Examples: Request fixture
../soha/contracts/examples/openapi/tool-invocation-request.json; Response fixture../soha/contracts/examples/openapi/tool-invocation-result-envelope.json
- Status:
AI Workbench
GET /api/v1/ai/agent-runs/multi-agent-listMultiAgentPlans. Schemas:MultiAgentPlanListEnvelope.POST /api/v1/ai/agent-runs/multi-agent-createMultiAgentPlan. Schemas:MultiAgentPlan,MultiAgentPlanEnvelope.POST /api/v1/ai/agent-runs/multi-agent/:planID/cancel-cancelMultiAgentPlan. Schemas:MultiAgentPlanEnvelope.POST /api/v1/ai/agent-runs/multi-agent/:planID/subtasks/:subtaskID/complete-completeMultiAgentSubtask. Schemas:MultiAgentPlanEnvelope,MultiAgentSubtaskCompletionInput.GET /api/v1/copilot/agent-providers-listWorkbenchAgentProviders. Schemas:WorkbenchAgentProviderListEnvelope.GET /api/v1/copilot/agent-runs-listAgentRuns. Schemas:GenericItemsEnvelope,WorkbenchAgentRun.- Status:
implemented - Permissions:
observe.ai.chat - Scopes: current user or authorized AI workbench visibility; AgentRun status and provider filters where supported; redacted output and artifact summaries
- Audit: Lists AgentRun records visible to the current user for AI Workbench operations without exposing runner callback tokens or provider credentials.
- Examples: HTTP request
GET /api/v1/copilot/agent-runs
- Status:
POST /api/v1/copilot/agent-runs/:runID/cancel-cancelWorkbenchAgentRun. Schemas:WorkbenchAgentRunEnvelope.GET /api/v1/copilot/agent-runs/:runID/events-listAgentRunEvents. Schemas:AgentRunEventListEnvelope.POST /api/v1/copilot/agent-runs/:runID/resume-resumeAgentRun. Schemas:AgentRunResumeRequest,WorkbenchAgentRunEnvelope.GET /api/v1/copilot/analysis-profiles-listWorkbenchAnalysisProfiles. Schemas:WorkbenchAnalysisProfileListEnvelope.POST /api/v1/copilot/analysis-profiles-createWorkbenchAnalysisProfile. Schemas:WorkbenchAnalysisProfileEnvelope,WorkbenchAnalysisProfileInput.PUT /api/v1/copilot/analysis-profiles/:profileID-updateWorkbenchAnalysisProfile. Schemas:WorkbenchAnalysisProfileEnvelope,WorkbenchAnalysisProfileInput.GET /api/v1/copilot/analysis/runs-listWorkbenchAnalysisRuns. Schemas:WorkbenchRootCauseRunListEnvelope.PATCH /api/v1/copilot/assistant-updatePersonalAssistant. Schemas:PersonalAssistantEnvelope,PersonalAssistantUpdateRequest.POST /api/v1/copilot/assistant-ensurePersonalAssistant. Schemas:PersonalAssistantEnvelope.GET /api/v1/copilot/assistant/access-getPersonalAgentAccess. Schemas:PersonalAgentAccessEnvelope.POST /api/v1/copilot/assistant/access-requestPersonalAgentAccess. Schemas:PersonalAgentAccessEnvelope.GET /api/v1/copilot/assistant/access/requests-listPersonalAgentAccessRequests. Schemas:PersonalAgentAccessListEnvelope.PATCH /api/v1/copilot/assistant/access/requests/:userId-decidePersonalAgentAccess. Schemas:PersonalAgentAccessDecision,PersonalAgentAccessEnvelope.GET /api/v1/copilot/assistant/artifacts-listPersonalAssistantArtifacts. Schemas:PersonalAssistantArtifactListEnvelope.PATCH /api/v1/copilot/assistant/avatar-updatePersonalAssistantAvatar. Schemas:PersonalAssistantAvatarRequest,PersonalAssistantEnvelope.DELETE /api/v1/copilot/assistant/environment-deletePersonalEnvironmentData. Explicitly delete the authenticated assistant’s personal files Schemas:PersonalEnvironmentDataDeletionRequest,PersonalEnvironmentEnvelope.GET /api/v1/copilot/assistant/environment-getPersonalEnvironment. Read the authenticated assistant’s latest environment receipt Schemas:PersonalEnvironmentEnvelope.POST /api/v1/copilot/assistant/environment-changePersonalEnvironment. Wake, sleep or reconcile the authenticated assistant’s environment Schemas:PersonalEnvironmentActionRequest,PersonalEnvironmentEnvelope.POST /api/v1/copilot/assistant/environment/export-exportPersonalEnvironmentData. Download the authenticated assistant’s retained personal files Schemas:PersonalEnvironmentDataExportRequest.POST /api/v1/copilot/assistant/environment/guest-enrollment-preparePersonalGuestEnrollment. Prepare the current owner’s dedicated personal VM guest identity Schemas:PersonalGuestPreparationEnvelope,PersonalGuestPreparationInput.POST /api/v1/copilot/assistant/environment/guest-provisioning-provisionPersonalGuest. Initialize the current owner’s personal VM data and managed guest service Schemas:PersonalGuestPreparationInput,VirtualizationOperationEnvelope.POST /api/v1/copilot/assistant/environment/guest-provisioning/:operationId/reconcile-reconcilePersonalGuestProvisioning. Explicitly reconcile the original retained personal guest operation Schemas:PersonalGuestPreparationInput,VirtualizationOperationEnvelope.POST /api/v1/copilot/assistant/environment/guest-tools-installPersonalGuestTools. Install the owned VM’s fixed execution tools without initializing data Schemas:PersonalGuestToolsInput,VirtualizationOperationEnvelope.GET /api/v1/copilot/assistant/environment/runtime-getPersonalWorkspaceRuntime. Read shared workspace runtime state across Web and App Schemas:PersonalWorkspaceRuntimeEnvelope.POST /api/v1/copilot/assistant/environment/runtime-startPersonalGuestRuntime. Start one bounded owner-authorized VM workspace operation Schemas:PersonalGuestRuntimeEnvelope,PersonalGuestRuntimeInput.GET /api/v1/copilot/assistant/environment/runtime/:operationId-getPersonalGuestRuntime. Read the original owner’s retained workspace receipt Schemas:PersonalGuestRuntimeEnvelope.GET /api/v1/copilot/assistant/environment/templates-listPersonalEnvironmentTemplates. List personal Docker template choices within the current user’s node scope Schemas:PersonalEnvironmentTemplateListEnvelope.GET /api/v1/copilot/assistant/feed-listPersonalFeed. Schemas:PersonalFeedEnvelope.GET /api/v1/copilot/assistant/feed/items/:itemID-getPersonalFeedItem. Schemas:PersonalFeedItemEnvelope.PATCH /api/v1/copilot/assistant/feed/items/:itemID-updatePersonalFeedFeedback. Schemas:PersonalFeedFeedback,PersonalFeedItemEnvelope.POST /api/v1/copilot/assistant/feed/refresh-refreshPersonalFeed. Schemas:PersonalFeedEnvelope.PUT /api/v1/copilot/assistant/feed/settings-updatePersonalFeedSettings. Schemas:PersonalFeedEnvelope,PersonalFeedSettings.GET /api/v1/copilot/assistant/sessions-listPersonalAgentSessions. Schemas:WorkbenchSessionListEnvelope.POST /api/v1/copilot/assistant/sessions-createPersonalAgentSession. Schemas:WorkbenchCreateSessionRequest,WorkbenchSessionEnvelope.GET /api/v1/copilot/assistant/tasks-listPersonalAssistantTasks. Schemas:WorkbenchAgentRunListEnvelope.GET /api/v1/copilot/automation-policies-listWorkbenchAutomationPolicies. Schemas:WorkbenchAutomationPolicyListEnvelope.POST /api/v1/copilot/automation-policies-createWorkbenchAutomationPolicy. Schemas:WorkbenchAutomationPolicyEnvelope,WorkbenchAutomationPolicyInput.DELETE /api/v1/copilot/automation-policies/:policyID-deleteWorkbenchAutomationPolicy.PUT /api/v1/copilot/automation-policies/:policyID-updateWorkbenchAutomationPolicy. Schemas:WorkbenchAutomationPolicyEnvelope,WorkbenchAutomationPolicyInput.GET /api/v1/copilot/data-source-capabilities-listWorkbenchDataSourceCapabilities. Schemas:WorkbenchAdapterListEnvelope.GET /api/v1/copilot/data-sources-listWorkbenchDataSources. Schemas:WorkbenchDataSourceListEnvelope.POST /api/v1/copilot/data-sources-createWorkbenchDataSource. Schemas:WorkbenchDataSourceEnvelope,WorkbenchDataSourceInput.PUT /api/v1/copilot/data-sources/:dataSourceID-updateWorkbenchDataSource. Schemas:WorkbenchDataSourceEnvelope,WorkbenchDataSourceInput.POST /api/v1/copilot/data-sources/:dataSourceID/validate-validateWorkbenchDataSource. Schemas:WorkbenchDataSourceEnvelope.POST /api/v1/copilot/global-assistant/events-recordWorkbenchGlobalAssistantEvent. Schemas:WorkbenchGlobalAssistantEventEnvelope,WorkbenchGlobalAssistantOpenRequest.GET /api/v1/copilot/insights-listWorkbenchInsights. Schemas:WorkbenchInsightListEnvelope.GET /api/v1/copilot/inspection-runs-listWorkbenchInspectionRuns. Schemas:WorkbenchInspectionRunListEnvelope.POST /api/v1/copilot/inspection-runs/:runID/session-createWorkbenchSessionFromInspectionRun. Schemas:WorkbenchSessionEnvelope.GET /api/v1/copilot/inspection-tasks-listWorkbenchInspectionTasks. Schemas:WorkbenchInspectionTaskListEnvelope.POST /api/v1/copilot/inspection-tasks-createWorkbenchInspectionTask. Schemas:WorkbenchInspectionTaskEnvelope,WorkbenchInspectionTaskInput.DELETE /api/v1/copilot/inspection-tasks/:taskID-deleteWorkbenchInspectionTask.GET /api/v1/copilot/inspection-tasks/:taskID-getWorkbenchInspectionTask. Schemas:WorkbenchInspectionTaskEnvelope.PUT /api/v1/copilot/inspection-tasks/:taskID-updateWorkbenchInspectionTask. Schemas:WorkbenchInspectionTaskEnvelope,WorkbenchInspectionTaskInput.POST /api/v1/copilot/inspection-tasks/:taskID/execute-executeWorkbenchInspectionTask. Schemas:WorkbenchInspectionRunEnvelope.GET /api/v1/copilot/messages/search-searchWorkbenchMessages. Schemas:WorkbenchMessageSearchEnvelope.GET /api/v1/copilot/root-cause/runs-listWorkbenchRootCauseRuns. Schemas:WorkbenchRootCauseRunListEnvelope.POST /api/v1/copilot/root-cause/runs-createWorkbenchRootCauseRun. Schemas:WorkbenchRootCauseRunEnvelope,WorkbenchRootCauseRunInput.GET /api/v1/copilot/root-cause/runs/:runID-getWorkbenchRootCauseRun. Schemas:WorkbenchRootCauseRunEnvelope.GET /api/v1/copilot/sessions-listWorkbenchSessions. Schemas:WorkbenchSessionListEnvelope.POST /api/v1/copilot/sessions-createWorkbenchSession. Schemas:WorkbenchCreateSessionRequest,WorkbenchSessionEnvelope.DELETE /api/v1/copilot/sessions/:sessionID-deleteWorkbenchSession.GET /api/v1/copilot/sessions/:sessionID-getWorkbenchSession. Schemas:WorkbenchSessionEnvelope.PATCH /api/v1/copilot/sessions/:sessionID-updateWorkbenchSession. Schemas:WorkbenchSessionEnvelope,WorkbenchUpdateSessionRequest.POST /api/v1/copilot/sessions/:sessionID/analyze-analyzeWorkbenchSession. Schemas:WorkbenchAnalyzeSessionRequest,WorkbenchSessionMessageResultEnvelope.POST /api/v1/copilot/sessions/:sessionID/inspection-task-createWorkbenchInspectionTaskFromSession. Schemas:WorkbenchInspectionTaskEnvelope,WorkbenchInspectionTaskInput.GET /api/v1/copilot/sessions/:sessionID/messages-listWorkbenchSessionMessages. Schemas:WorkbenchMessageListEnvelope.POST /api/v1/copilot/sessions/:sessionID/messages-sendWorkbenchSessionMessage. Schemas:WorkbenchSendMessageRequest,WorkbenchSessionMessageResultEnvelope.POST /api/v1/copilot/sessions/:sessionID/messages/stream-streamWorkbenchSessionMessage. Schemas:WorkbenchSendMessageStreamRequest,WorkbenchStreamEvent.GET /api/v1/copilot/sessions/:sessionID/messages/window-getWorkbenchMessageWindow. Schemas:WorkbenchMessageWindowEnvelope.GET /api/v1/copilot/sessions/:sessionID/native-request-findNativeRequest. Schemas:WorkbenchAgentRunEnvelope.PUT /api/v1/copilot/sessions/:sessionID/runtime-profile-selectWorkbenchRuntimeProfile. Schemas:WorkbenchRuntimeProfileSelection,WorkbenchSessionEnvelope.POST /api/v1/copilot/sessions/main-ensureWorkbenchMainSession. Schemas:WorkbenchMainSessionRequest,WorkbenchSessionEnvelope.GET /api/v1/copilot/workbench/catalog-getWorkbenchCatalog. Schemas:WorkbenchCatalogEnvelope.GET /api/v1/copilot/workbench/runtime-profiles-listWorkbenchRuntimeProfiles. Schemas:WorkbenchRuntimeProfileListEnvelope.
Applications
GET /api/v1/applications-listApplications. Schemas:ApplicationListEnvelope.POST /api/v1/applications-createApplication. Schemas:ApplicationEnvelope,ApplicationInput.DELETE /api/v1/applications/:applicationID-deleteApplication. Schemas:OperationStatus.GET /api/v1/applications/:applicationID-getApplication. Schemas:ApplicationEnvelope.PUT /api/v1/applications/:applicationID-updateApplication. Schemas:ApplicationEnvelope,ApplicationInput.PUT /api/v1/applications/:applicationID/application-environments/:applicationEnvironmentID/workflow-saveApplicationEnvironmentWorkflow. Schemas:ApplicationEnvironmentEnvelope,ApplicationWorkflowInput.GET /api/v1/applications/:applicationID/buildpacks-capability-getApplicationBuildpacksCapability. Schemas:BuildpacksCapabilityEnvelope.POST /api/v1/applications/:applicationID/delivery-actions-triggerApplicationDeliveryAction. Schemas:ApplicationDeliveryActionRequest,ApplicationDeliveryActionResultEnvelope.GET /api/v1/applications/:applicationID/detail-getApplicationDeliveryDetail. Schemas:ApplicationDeliveryDetailEnvelope.POST /api/v1/applications/:applicationID/helm-chart-inspectApplicationHelmChart. Schemas:HelmChartInspectionEnvelope,HelmChartInspectionInput.POST /api/v1/applications/:applicationID/repository-analysis-analyzeApplicationRepository. Schemas:RepositoryAnalysisEnvelope,RepositoryAnalysisInput.GET /api/v1/applications/:applicationID/runtime-getApplicationRuntimeDetail. Schemas:ApplicationRuntimeDetailEnvelope.GET /api/v1/applications/:applicationID/services-listApplicationServices. Schemas:ApplicationServiceListEnvelope.POST /api/v1/applications/:applicationID/services-createApplicationService. Schemas:ApplicationServiceEnvelope,ApplicationServiceInput.DELETE /api/v1/applications/:applicationID/services/:serviceID-deleteApplicationService. Schemas:OperationStatus.GET /api/v1/applications/:applicationID/services/:serviceID-getApplicationService. Schemas:ApplicationServiceEnvelope.PUT /api/v1/applications/:applicationID/services/:serviceID-updateApplicationService. Schemas:ApplicationServiceEnvelope,ApplicationServiceInput.GET /api/v1/integrations/gitlab/branches-listGitLabBranches. Schemas:GitReferenceListEnvelope.GET /api/v1/integrations/gitlab/commits-listGitLabCommits. Schemas:GitCommitPageEnvelope.GET /api/v1/integrations/gitlab/projects-listGitLabProjects. Schemas:GitProjectListEnvelope.GET /api/v1/integrations/gitlab/tags-listGitLabTags. Schemas:GitReferenceListEnvelope.GET /api/v1/repositories-listRepositories. Schemas:RepositoryListEnvelope.POST /api/v1/repositories-createRepository. Schemas:RepositoryEnvelope,RepositoryInput.DELETE /api/v1/repositories/:repositoryID-deleteRepository. Schemas:OperationStatus.GET /api/v1/repositories/:repositoryID-getRepository. Schemas:RepositoryEnvelope.PUT /api/v1/repositories/:repositoryID-updateRepository. Schemas:RepositoryEnvelope,RepositoryInput.
Auth
GET /api/v1/ai-gateway/token-rotations/:rotationRequestId-getTokenRotationRecord. Schemas:TokenRotationRecordEnvelope.GET /api/v1/auth/bootstrap-getAuthBootstrap. Schemas:AuthBootstrapEnvelope.- Status:
implemented - Permissions:
authenticated principal - Scopes: current principal; workspace/menu bootstrap; client feature and authorization context
- Audit: Returns authenticated bootstrap state used by clients to initialize navigation and permissions without performing mutations.
- Examples: HTTP request
GET /api/v1/auth/bootstrap
- Status:
GET /api/v1/auth/browser-handoffs/:browserHandoffID-getBrowserHandoff. Schemas:BrowserHandoffEnvelope.POST /api/v1/auth/browser-handoffs/:browserHandoffID/complete-completeBrowserHandoff. Schemas:BrowserHandoffCompletionEnvelope.POST /api/v1/auth/cli/device-authorizations-createCLIDeviceAuthorization. Schemas:CLIDeviceAuthorizationCreateRequest,CLIDeviceAuthorizationEnvelope.POST /api/v1/auth/cli/device-authorizations/cancel-cancelCLIDeviceAuthorization. Schemas:CLIDeviceAuthorizationStatusEnvelope,CLIDeviceCancelRequest.POST /api/v1/auth/cli/device-authorizations/decision-decideCLIDeviceAuthorization. Schemas:CLIDeviceAuthorizationStatusEnvelope,CLIDeviceDecisionRequest.POST /api/v1/auth/cli/device-authorizations/inspect-inspectCLIDeviceAuthorization. Schemas:CLIDeviceConfirmationEnvelope,CLIDeviceInspectRequest.POST /api/v1/auth/cli/device-token-exchangeCLIDeviceToken. Schemas:AuthResultEnvelope,CLIDeviceTokenRequest,ErrorEnvelope.POST /api/v1/auth/cli/logout-logoutCLISession. Schemas:CLILogoutRequest.GET /api/v1/auth/cli/options-getCLIAuthOptions. Schemas:CLIAuthOptionsEnvelope.POST /api/v1/auth/cli/password-passwordLoginCLI. Schemas:AuthResultEnvelope,PasswordLoginRequest.POST /api/v1/auth/cli/refresh-refreshCLISession. Schemas:AuthResultEnvelope,CLIRefreshRequest.GET /api/v1/auth/cli/sessions-listCLISessions. Schemas:CLISessionPageEnvelope.POST /api/v1/auth/cli/sessions/:sessionID/revoke-revokeOwnCLISession.GET /api/v1/auth/context-getAuthContext. Schemas:CLIAuthContextEnvelope.POST /api/v1/auth/desktop/attempts-createDesktopAuthAttempt. Schemas:DesktopAuthAttemptCreateRequest,DesktopAuthAttemptEnvelope.POST /api/v1/auth/desktop/attempts/:attemptID/exchange-exchangeDesktopAuthAttempt. Schemas:AuthResultEnvelope,DesktopAuthAttemptExchangeRequest.GET /api/v1/auth/desktop/attempts/:attemptID/start-startDesktopAuthAttempt.POST /api/v1/auth/login-passwordLogin. Schemas:AuthResultEnvelope,PasswordLoginRequest.- Status:
implemented - Permissions:
valid login credential - Scopes: username/password credential exchange; session token issuance; principal profile bootstrap
- Audit: Authenticates a user and returns session tokens plus principal metadata; password values are never echoed and failed attempts should remain redacted in logs.
- Examples: HTTP request
POST /api/v1/auth/login
- Status:
GET /api/v1/auth/login-options-getAuthLoginOptions. Schemas:LoginOptionsEnvelope.- Status:
implemented - Permissions:
public authentication discovery - Scopes: enabled login methods; provider availability; no authenticated user scope
- Audit: Returns login option metadata used by clients before authentication; secret material and provider credentials are never returned.
- Examples: HTTP request
GET /api/v1/auth/login-options
- Status:
POST /api/v1/auth/login/:providerID/acs-consumeSAMLLoginResponse. Schemas:SAMLResponseForm.GET /api/v1/auth/login/:providerID/callback-handleProviderCallback.- Status:
implemented - Permissions:
valid provider callback state - Scopes: providerID; authorization code and state parameter; provider profile, mapped roles, mapped organizations, and local session
- Compatibility: Preferred callback route for multi-provider OIDC, OAuth2, Feishu, DingTalk, and WeCom login providers; Uses the same frontend exchange-code handoff as the legacy OIDC callback
- Audit: Handles the selected provider callback, matches or creates the local user identity, applies configured login-time role or organization enrichment, creates a session, and redirects with a short-lived exchange code.
- Examples: HTTP redirect
GET /api/v1/auth/login/:providerID/callback?code=...&state=...
- Status:
GET /api/v1/auth/login/:providerID/start-beginProviderLogin.- Status:
implemented - Permissions:
public configured-provider login entry - Scopes: providerID; enabled OIDC, OAuth2, Feishu, DingTalk, or WeCom provider; state generation and provider redirect URL
- Compatibility: Preferred multi-provider browser entry for new console integrations; Coexists with the legacy /api/v1/auth/oidc/login route during the 0.1.x compatibility line
- Audit: Starts the selected provider browser redirect flow after resolving configured provider metadata; provider secrets remain server-side and the callback handles local identity reconciliation.
- Examples: HTTP redirect
GET /api/v1/auth/login/:providerID/start
- Status:
POST /api/v1/auth/logout-logoutAuthSession. Schemas:RefreshRequest.- Status:
implemented - Permissions:
authenticated session or refresh token context - Scopes: session termination; refresh token invalidation where applicable
- Audit: Terminates the current session or refresh context without returning secret material; clients should discard local bearer state after success.
- Examples: HTTP request
POST /api/v1/auth/logout
- Status:
GET /api/v1/auth/me-getCurrentPrincipal. Schemas:PrincipalEnvelope.- Status:
implemented - Permissions:
authenticated principal - Scopes: current principal identity; roles and permissions visible to the caller
- Audit: Returns the current authenticated principal summary without mutating state or exposing bearer token contents.
- Examples: HTTP request
GET /api/v1/auth/me
- Status:
GET /api/v1/auth/oidc/callback-handleOIDCCallback.- Status:
implemented - Permissions:
valid OIDC state and provider callback - Scopes: authorization code; state parameter; legacy OIDC provider profile and local identity binding
- Compatibility: Legacy callback retained for existing OIDC provider redirect URLs; The backend still redirects to the same frontend exchange page as provider-specific callbacks
- Deprecation: Compatibility route only; no removal date is scheduled for 0.1.x, but new provider configurations should use /api/v1/auth/login/:providerID/callback.
- Audit: Validates the OIDC callback, reconciles the provider identity with existing local roles and organizations, creates a session, and redirects to the console with a short-lived exchange code.
- Examples: HTTP redirect
GET /api/v1/auth/oidc/callback?code=...&state=...
- Status:
POST /api/v1/auth/oidc/exchange-exchangeOIDCCode. Schemas:AuthResultEnvelope,OIDCExchangeRequest.- Status:
implemented - Permissions:
valid one-time OIDC or OAuth2 exchange code - Scopes: frontend callback exchange code; session token issuance; principal profile bootstrap
- Compatibility: Despite the OIDC path name, this is the shared frontend session exchange endpoint for OIDC and OAuth2-style provider callbacks; The route returns the same AuthResultEnvelope as password login and refresh session flows
- Audit: Consumes the short-lived login exchange code and returns the final session tokens and principal metadata without returning provider credentials or stored token hashes.
- Examples: HTTP request
POST /api/v1/auth/oidc/exchange
- Status:
GET /api/v1/auth/oidc/login-beginOIDCLogin.- Status:
implemented - Permissions:
public OIDC login entry - Scopes: legacy single-provider OIDC configuration; state generation; redirect to configured identity provider
- Compatibility: Legacy browser entry retained for deployments that still use the single-provider OIDC settings path; New multi-provider login buttons should prefer /api/v1/auth/login/:providerID/start when a provider id is available
- Deprecation: Compatibility route only; no removal date is scheduled for 0.1.x, but new clients should prefer the provider-specific start route.
- Audit: Starts the browser OIDC login redirect flow without exposing client secrets; the callback and exchange steps perform state validation and session issuance.
- Examples: HTTP redirect
GET /api/v1/auth/oidc/login
- Status:
GET /api/v1/auth/profile-getCurrentUserProfile. Schemas:UserProfileEnvelope.- Status:
implemented - Permissions:
authenticated principal - Scopes: current user profile; workspace and UI bootstrap context
- Audit: Returns current user profile metadata for console bootstrap without exposing token, password, or provider secret material.
- Examples: HTTP request
GET /api/v1/auth/profile
- Status:
PATCH /api/v1/auth/profile-updateCurrentUserProfile. Schemas:UpdateProfileRequest,UserProfileEnvelope.POST /api/v1/auth/profile/password-changeCurrentUserPassword. Schemas:ChangePasswordRequest,PasswordChangeResult.GET /api/v1/auth/providers-listAuthProviders. Schemas:AuthProviderListEnvelope.- Status:
implemented - Permissions:
public authentication discovery - Scopes: configured login providers; provider display metadata; no authenticated user scope
- Audit: Returns configured authentication provider metadata for login discovery without exposing provider secrets or mutating session state.
- Examples: HTTP request
GET /api/v1/auth/providers
- Status:
POST /api/v1/auth/refresh-refreshAuthSession. Schemas:AuthResultEnvelope,RefreshRequest.- Status:
implemented - Permissions:
valid refresh token - Scopes: session refresh; token expiry and rotation policy; principal profile continuity
- Audit: Refreshes an authenticated session using a refresh token and returns updated token metadata without exposing stored token hashes.
- Examples: HTTP request
POST /api/v1/auth/refresh
- Status:
GET /api/v1/auth/saml/:providerID/metadata-getSAMLServiceProviderMetadata.POST /api/v1/auth/stream-ticket-issueStreamTicket. Schemas:StreamTicketEnvelope,StreamTicketRequest.- Status:
implemented - Permissions:
authenticated principal - Scopes: short-lived stream access; requested stream target; caller authorization for the target stream
- Audit: Issues a short-lived stream ticket for authorized streaming clients without exposing long-lived bearer tokens to stream URLs.
- Examples: HTTP request
POST /api/v1/auth/stream-ticket
- Status:
Companion
POST /api/v1/companion/interactions-recordCompanionInteraction. Schemas:CompanionInteractionReceiptEnvelope,CompanionInteractionRequest.GET /api/v1/companion/profile-getCompanionProfile. Schemas:CompanionProfileEnvelope.POST /api/v1/companion/profile/reset-resetCompanionProfile. Schemas:CompanionProfileEnvelope,CompanionProfileResetRequest.
Compute
GET /api/v1/compute/access-sources-listComputeAccessSources. Schemas:ComputeAccessSourceListEnvelope,ComputeAccessSourceType.GET /api/v1/compute/capabilities-getComputeCapabilities. Schemas:ComputeCapabilityManifestEnvelope.GET /api/v1/compute/overview-getComputeOverview. Schemas:ComputeOverviewEnvelope.GET /api/v1/compute/provider-instances-listComputeProviderInstances. Schemas:ComputeProviderDomain,ComputeProviderInstanceListEnvelope.GET /api/v1/compute/provider-instances/:domain/:providerKey/:instanceRef-getComputeProviderInstance. Schemas:ComputeProviderInstanceEnvelope.POST /api/v1/compute/provider-instances/:domain/:providerKey/:instanceRef/discoveries-discoverComputeProviderInstance. Schemas:ComputeProviderDiscoverRequest,ComputeTaskEnvelope.POST /api/v1/compute/provider-instances/:domain/:providerKey/:instanceRef/health-checks-checkComputeProviderInstanceHealth. Schemas:ComputeProviderReadRequest,ComputeTaskEnvelope,ConnectionCheckResultEnvelope.GET /api/v1/compute/providers-listComputeProviders. Schemas:ComputeProviderDomain,ComputeProviderListEnvelope,ComputeProviderSource.GET /api/v1/compute/resources/:domain/:kind/:id-getComputeResource. Schemas:GenericDataEnvelope.POST /api/v1/compute/resources/:domain/:kind/:id/actions/:action-executeComputeResourceAction. Schemas:ComputeResourceActionRequest,ComputeTaskEnvelope.GET /api/v1/compute/resources/:domain/:kind/:id/relations-listComputeResourceRelations. Schemas:ComputeResourceRelationListEnvelope.GET /api/v1/compute/tasks-listComputeTasks. Schemas:ComputeTaskCategory,ComputeTaskDomain,ComputeTaskListEnvelope,ComputeTaskStatus.GET /api/v1/compute/tasks/:domain/:id-getComputeTask. Schemas:ComputeTaskEnvelope.POST /api/v1/compute/tasks/:domain/:id/cancel-cancelComputeTask. Schemas:ComputeTaskEnvelope,ComputeTaskMutationRequest.GET /api/v1/compute/tasks/:domain/:id/logs-listComputeTaskLogs. Schemas:ComputeTaskLogListEnvelope.POST /api/v1/compute/tasks/:domain/:id/retry-retryComputeTask. Schemas:ComputeTaskEnvelope,ComputeTaskMutationRequest.GET /api/v1/compute/tasks/:domain/:id/stream-streamComputeTask.
Context
POST /api/v1/ai/context/inspect-inspectAIContext. Schemas:AIContextBuildInput,AIContextInspectionEnvelope.
Delivery
GET /api/v1/application-environments-listApplicationEnvironments. Schemas:ApplicationEnvironmentListEnvelope.POST /api/v1/application-environments-createApplicationEnvironment. Schemas:ApplicationEnvironmentEnvelope,ApplicationEnvironmentInput.DELETE /api/v1/application-environments/:applicationEnvironmentID-deleteApplicationEnvironment. Schemas:OperationStatus.GET /api/v1/application-environments/:applicationEnvironmentID-getApplicationEnvironment. Schemas:ApplicationEnvironmentEnvelope.PUT /api/v1/application-environments/:applicationEnvironmentID-updateApplicationEnvironment. Schemas:ApplicationEnvironmentEnvelope,ApplicationEnvironmentInput.PUT /api/v1/application-environments/:applicationEnvironmentID/configuration-updateApplicationEnvironmentConfiguration. Schemas:ApplicationEnvironmentEnvelope,ApplicationEnvironmentInput.GET /api/v1/application-environments/:applicationEnvironmentID/detail-getApplicationEnvironmentDeliveryDetail. Schemas:ApplicationEnvironmentDeliveryDetailEnvelope.GET /api/v1/application-environments/:applicationEnvironmentID/service-reference-candidates-listEnvironmentServiceReferenceCandidates. Schemas:EnvironmentServiceReferenceCandidatePage.DELETE /api/v1/application-environments/:applicationEnvironmentID/service-reference-candidates/:serviceID-deleteEnvironmentServiceReferenceCandidate. Schemas:EnvironmentServiceReferenceCandidateDeleteInput.GET /api/v1/application-environments/:applicationEnvironmentID/service-reference-candidates/:serviceID-getEnvironmentServiceReferenceCandidate. Schemas:EnvironmentServiceReferenceCandidateEnvelope.PUT /api/v1/application-environments/:applicationEnvironmentID/service-reference-candidates/:serviceID-putEnvironmentServiceReferenceCandidate. Schemas:EnvironmentServiceReferenceCandidateEnvelope,EnvironmentServiceReferenceCandidateInput.GET /api/v1/application-environments/:applicationEnvironmentID/service-reference-consumers-listEnvironmentServiceReferenceConsumers. Schemas:EnvironmentServiceReferenceConsumerPage.POST /api/v1/application-environments/:applicationEnvironmentID/service-reference-previews-previewEnvironmentServiceReference. Schemas:EnvironmentServiceReferencePreviewEnvelope,EnvironmentServiceReferencePreviewInput.GET /api/v1/application-environments/:applicationEnvironmentID/service-references-listEnvironmentServiceReferences. Schemas:EnvironmentServiceReferencePage.DELETE /api/v1/application-environments/:applicationEnvironmentID/service-references/:serviceID-deleteEnvironmentServiceReference. Schemas:EnvironmentServiceReferenceDeleteInput.GET /api/v1/application-environments/:applicationEnvironmentID/service-references/:serviceID-getEnvironmentServiceReference. Schemas:EnvironmentServiceReferenceEnvelope.PUT /api/v1/application-environments/:applicationEnvironmentID/service-references/:serviceID-putEnvironmentServiceReference. Schemas:EnvironmentServiceReferenceEnvelope,EnvironmentServiceReferenceInput.GET /api/v1/application-environments/:applicationEnvironmentID/service-references/:serviceID/targets/:targetID-resolveEnvironmentServiceReferenceTarget. Schemas:EnvironmentServiceReferenceResolvedTarget.GET /api/v1/application-environments/:applicationEnvironmentID/targets/:targetID/relations-getApplicationEnvironmentTargetRelations. Schemas:ResourceRelationsEnvelope.GET /api/v1/application-environments/:applicationEnvironmentID/targets/:targetID/source-getApplicationEnvironmentTargetSource. Schemas:KubernetesResourceYamlEnvelope.POST /api/v1/application-environments/helm-release-imports-importHelmReleases. Schemas:HelmReleaseImportRequest,HelmReleaseImportResultEnvelope.POST /api/v1/application-environments/helm-release-imports/mapped-importMappedHelmReleases. Schemas:HelmReleaseImportRequest,HelmReleaseImportResultEnvelope.POST /api/v1/application-environments/imports-importKubernetesServices. Schemas:KubernetesServiceImportRequest,KubernetesServiceImportResultEnvelope.POST /api/v1/application-environments/imports/mapped-importMappedKubernetesServices. Schemas:KubernetesServiceImportRequest,KubernetesServiceImportResultEnvelope.GET /api/v1/application-environments/target-candidates-listApplicationEnvironmentTargetCandidates. Schemas:KubernetesImportCandidateListEnvelope.POST /api/v1/applications/:applicationID/deployment-template-preview-previewServiceDeploymentTemplate. previewServiceDeploymentTemplate Schemas:DeploymentTemplatePreviewEnvelope,DeploymentTemplatePreviewInput.GET /api/v1/build-templates-listBuildTemplates. Schemas:BuildTemplateListEnvelope.POST /api/v1/build-templates-createBuildTemplate. Schemas:BuildTemplateEnvelope,BuildTemplateInput.DELETE /api/v1/build-templates/:buildTemplateID-deleteBuildTemplate. Schemas:OperationStatus.GET /api/v1/build-templates/:buildTemplateID-getBuildTemplate. Schemas:BuildTemplateEnvelope.PUT /api/v1/build-templates/:buildTemplateID-updateBuildTemplate. Schemas:BuildTemplateEnvelope,BuildTemplateInput.POST /api/v1/build-templates/:buildTemplateID/publish-publishBuildTemplate. Schemas:BuildTemplateEnvelope,TemplatePublishInput.GET /api/v1/build-templates/:buildTemplateID/versions-listBuildTemplateVersions. Schemas:BuildTemplateListEnvelope.GET /api/v1/build-templates/:buildTemplateID/versions/:version-getBuildTemplateVersion. Schemas:BuildTemplateEnvelope.GET /api/v1/builds-listBuildRecords. Schemas:BuildRecord.POST /api/v1/builds/trigger-triggerBuild. Schemas:BuildTriggerEnvelope,BuildTriggerRequest.GET /api/v1/delivery-batches-listDeliveryBatches. Schemas:DeliveryBatchListEnvelope.POST /api/v1/delivery-batches-createDeliveryBatch. Schemas:DeliveryBatchEnvelope,DeliveryBatchInput.GET /api/v1/delivery-batches/:deliveryBatchID-getDeliveryBatch. Schemas:DeliveryBatchEnvelope.POST /api/v1/delivery-batches/:deliveryBatchID/cancel-cancelDeliveryBatch. Schemas:DeliveryBatchActionInput,DeliveryBatchEnvelope.GET /api/v1/delivery-workflows-listDeliveryWorkflows. Schemas:DeliveryWorkflowListEnvelope.POST /api/v1/delivery-workflows-createDeliveryWorkflow. Schemas:DeliveryWorkflowEnvelope,DeliveryWorkflowInput.GET /api/v1/delivery-workflows/:deliveryWorkflowID-getDeliveryWorkflow. Schemas:DeliveryWorkflowEnvelope.PUT /api/v1/delivery-workflows/:deliveryWorkflowID-updateDeliveryWorkflow. Schemas:DeliveryWorkflowEnvelope,DeliveryWorkflowInput.POST /api/v1/delivery/applications/:applicationID/environments/:applicationEnvironmentID/logs/query-queryDeliveryEnvironmentLogs. Schemas:LogPageEnvelope,LogQuery.POST /api/v1/delivery/applications/:applicationID/environments/:applicationEnvironmentID/logs/stream-ticket-issueDeliveryEnvironmentLogStreamTicket. Schemas:LogQuery,StreamTicketEnvelope.GET /api/v1/delivery/artifacts-listDeliveryArtifacts. Schemas:ExecutionArtifactListEnvelope.GET /api/v1/delivery/blueprints-listDeliveryBlueprints. Schemas:DeliveryBlueprintListEnvelope.POST /api/v1/delivery/blueprints-createDeliveryBlueprint. Schemas:DeliveryBlueprintEnvelope,DeliveryBlueprintInput.PUT /api/v1/delivery/blueprints/:blueprintID-updateDeliveryBlueprint. Schemas:DeliveryBlueprintEnvelope,DeliveryBlueprintInput.POST /api/v1/delivery/blueprints/:blueprintID/bootstrap-application-bootstrapApplicationFromBlueprint. Schemas:BlueprintBootstrapResultEnvelope.POST /api/v1/delivery/blueprints/:blueprintID/render-spec-renderDeliveryBlueprintSpec. Schemas:RenderedDeliverySpecEnvelope.GET /api/v1/delivery/blueprints/:blueprintID/usage-getDeliveryBlueprintUsage. Schemas:DeliveryTemplateUsageSummaryEnvelope.GET /api/v1/delivery/documents/:kind/:objectID/export-exportDeliveryDocument. Schemas:DeliveryDocumentExportEnvelope,DeliveryDocumentKind.GET /api/v1/delivery/documents/:kind/:objectID/source-getDeliveryDocumentSource. Schemas:DeliveryDocumentKind,DeliveryDocumentSourceInfoEnvelope.POST /api/v1/delivery/documents/imports/:previewID/apply-applyDeliveryDocumentImport. Schemas:DeliveryDocumentApplyInput,DeliveryDocumentImportEnvelope.POST /api/v1/delivery/documents/preview-previewDeliveryDocuments. Schemas:DeliveryDocumentPreviewEnvelope,DeliveryDocumentPreviewInput.POST /api/v1/delivery/drafts-createDeliveryDraft. Schemas:DeliveryDraftEnvelope,DeliveryDraftInput.GET /api/v1/delivery/drafts/:draftID-getDeliveryDraft. Schemas:DeliveryDraftEnvelope.POST /api/v1/delivery/drafts/:draftID/confirm-confirmDeliveryDraft. Schemas:DeliveryDraftConfirmResultEnvelope.GET /api/v1/delivery/environments-listDeliveryEnvironments. Schemas:DeliveryEnvironmentListEnvelope.GET /api/v1/delivery/execution-history-listDeliveryExecutionHistory. Schemas:DeliveryExecutionHistoryEnvelope.GET /api/v1/delivery/execution-tasks-listDeliveryExecutionTasks. Schemas:ExecutionTaskListEnvelope.GET /api/v1/delivery/execution-tasks/:taskID-getDeliveryExecutionTask. Schemas:ExecutionTaskEnvelope.GET /api/v1/delivery/execution-tasks/:taskID/artifacts-listExecutionTaskArtifacts. Schemas:ExecutionArtifactListEnvelope.POST /api/v1/delivery/execution-tasks/:taskID/cancel-cancelExecutionTask. Schemas:ExecutionTaskActionInput,ExecutionTaskEnvelope.POST /api/v1/delivery/execution-tasks/:taskID/control-controlExecutionTask. Schemas:ExecutionTaskControlInput,ExecutionTaskEnvelope.GET /api/v1/delivery/execution-tasks/:taskID/logs-listExecutionTaskLogs. Schemas:ExecutionLogListEnvelope.POST /api/v1/delivery/execution-tasks/:taskID/retry-retryExecutionTask. Schemas:ExecutionTaskActionInput,ExecutionTaskEnvelope.GET /api/v1/delivery/execution-tasks/:taskID/rollout-getExecutionTaskRollout. Schemas:ProgressiveRolloutStatusEnvelope.POST /api/v1/delivery/execution-tasks/:taskID/rollout-controlExecutionTaskRollout. Schemas:ProgressiveRolloutControlInput,ProgressiveRolloutStatusEnvelope.DELETE /api/v1/delivery/manifest-bindings/:manifestBindingID-deleteManifestBinding. Schemas:OperationStatus.PUT /api/v1/delivery/manifest-bindings/:manifestBindingID-updateManifestBinding. Schemas:ManifestBindingEnvelope,ManifestBindingUpdateInput.POST /api/v1/delivery/manifest-bindings/:manifestBindingID/desired-revision-setManifestDesiredRevision. Schemas:ManifestDeploymentActionEnvelope,ManifestDesiredRevisionInput.POST /api/v1/delivery/manifest-delivery-intents/:manifestDeliveryIntentID/accept-acceptManifestDeliveryIntent. Schemas:ManifestDeliveryIntentDecisionInput,ManifestDeliveryIntentEnvelope.POST /api/v1/delivery/manifest-delivery-intents/:manifestDeliveryIntentID/reject-rejectManifestDeliveryIntent. Schemas:ManifestDeliveryIntentDecisionInput,ManifestDeliveryIntentEnvelope.GET /api/v1/delivery/manifest-deployments-listManifestDeployments. Schemas:ManifestDeploymentListEnvelope,ManifestDeploymentPhase,ManifestSourceMode.GET /api/v1/delivery/manifest-deployments/:manifestDeploymentID-getManifestDeployment. Schemas:ManifestDeploymentEnvelope.POST /api/v1/delivery/manifest-deployments/:manifestDeploymentID/adopt-adoptManifestDeployment. Schemas:ManifestDeploymentActionEnvelope,ManifestDeploymentActionInput.POST /api/v1/delivery/manifest-deployments/:manifestDeploymentID/reconcile-reconcileManifestDeployment. Schemas:ManifestDeploymentActionEnvelope,ManifestDeploymentActionInput.POST /api/v1/delivery/manifest-deployments/:manifestDeploymentID/repair-repairManifestDeployment. Schemas:ManifestDeploymentActionEnvelope,ManifestDeploymentActionInput.POST /api/v1/delivery/manifest-deployments/:manifestDeploymentID/rollback-rollbackManifestDeployment. Schemas:ManifestDeploymentActionEnvelope,ManifestRollbackInput.GET /api/v1/delivery/manifest-packages-listManifestPackages. Schemas:ManifestPackagePageEnvelope.POST /api/v1/delivery/manifest-packages-createManifestPackage. Schemas:ManifestPackageEnvelope,ManifestPackageInput.DELETE /api/v1/delivery/manifest-packages/:manifestPackageID-deleteManifestPackage. Schemas:OperationStatus.GET /api/v1/delivery/manifest-packages/:manifestPackageID-getManifestPackage. Schemas:ManifestPackageEnvelope.PUT /api/v1/delivery/manifest-packages/:manifestPackageID-updateManifestPackage. Schemas:ManifestPackageEnvelope,ManifestPackageInput.GET /api/v1/delivery/manifest-packages/:manifestPackageID/bindings-listManifestBindings. Schemas:ManifestBindingListEnvelope.POST /api/v1/delivery/manifest-packages/:manifestPackageID/bindings-createManifestBinding. Schemas:ManifestBindingEnvelope,ManifestBindingInput.GET /api/v1/delivery/manifest-packages/:manifestPackageID/delivery-intents-listManifestDeliveryIntents. Schemas:ManifestDeliveryIntentListEnvelope.POST /api/v1/delivery/manifest-packages/:manifestPackageID/delivery-intents-createManifestDeliveryIntent. Schemas:ManifestDeliveryIntentEnvelope,ManifestDeliveryIntentInput.POST /api/v1/delivery/manifest-packages/:manifestPackageID/preflight-preflightManifestPackage. Schemas:ManifestExecutionTaskEnvelope,ManifestPreflightInput.POST /api/v1/delivery/manifest-packages/:manifestPackageID/render-renderManifestPackage. Schemas:ManifestRenderEnvelope,ManifestRenderInput.GET /api/v1/delivery/manifest-packages/:manifestPackageID/revisions-listManifestRevisions. Schemas:ManifestRevisionListEnvelope.POST /api/v1/delivery/manifest-packages/:manifestPackageID/revisions-saveManifestRevision. Schemas:ManifestPackageEnvelope,ManifestRevisionInput.GET /api/v1/delivery/manifest-packages/:manifestPackageID/source-getManifestSource. Schemas:ManifestSourceEnvelope.PUT /api/v1/delivery/manifest-packages/:manifestPackageID/source-updateManifestSource. Schemas:ManifestSourceEnvelope,ManifestSourceUpdateInput.POST /api/v1/delivery/manifest-packages/:manifestPackageID/sync-syncManifestPackage. Schemas:ManifestSyncActionEnvelope,ManifestSyncInput.GET /api/v1/delivery/manifest-packages/:manifestPackageID/sync-runs-listManifestSyncRuns. Schemas:ManifestSyncRunListEnvelope.POST /api/v1/delivery/manifest-sources/:manifestSourceID/webhook-triggerManifestSourceWebhook. Schemas:ManifestSyncActionEnvelope,ManifestSyncWebhookInput.POST /api/v1/delivery/plans-createDeliveryPlan. Schemas:DeliveryPlanEnvelope,DeliveryPlanInput.GET /api/v1/delivery/plans/:planID-getDeliveryPlan. Schemas:DeliveryPlanEnvelope.POST /api/v1/delivery/plans/:planID/approval-decideDeliveryPlanApproval. Schemas:DeliveryPlanApprovalInput,DeliveryPlanEnvelope.POST /api/v1/delivery/plans/:planID/confirm-confirmDeliveryPlan. Schemas:DeliveryPlanConfirmResultEnvelope.GET /api/v1/delivery/plans/:planID/service-reference-impact-getDeliveryPlanServiceReferenceImpact. Schemas:DeliveryPlanServiceReferenceImpact.GET /api/v1/delivery/release-bundles-listReleaseBundles. Schemas:ReleaseBundleListEnvelope.GET /api/v1/delivery/release-bundles/:bundleID-getReleaseBundle. Schemas:ReleaseBundleEnvelope.GET /api/v1/delivery/release-bundles/:bundleID/artifacts-listReleaseBundleArtifacts. Schemas:ExecutionArtifactListEnvelope.GET /api/v1/delivery/runtime/workflows/:workflowRunID-getWorkflowRuntimeDetail. Schemas:GenericDataEnvelope.GET /api/v1/delivery/template-sources-listDeliveryTemplateSources. Schemas:DeliveryTemplateSourceListEnvelope.POST /api/v1/delivery/template-sources-createDeliveryTemplateSource. Schemas:DeliveryTemplateSourceEnvelope,DeliveryTemplateSourceInput.DELETE /api/v1/delivery/template-sources/:sourceID-removeDeliveryTemplateSource. Schemas:DeliveryTemplateSourceRemoveInput.GET /api/v1/delivery/template-sources/:sourceID-getDeliveryTemplateSource. Schemas:DeliveryTemplateSourceEnvelope.PUT /api/v1/delivery/template-sources/:sourceID-updateDeliveryTemplateSource. Schemas:DeliveryTemplateSourceEnvelope,DeliveryTemplateSourceInput.GET /api/v1/delivery/template-sources/:sourceID/objects-listDeliveryTemplateSourceObjects. Schemas:DeliveryTemplateSourceAssociationListEnvelope.POST /api/v1/delivery/template-sources/:sourceID/objects/:kind/:objectID/detach-detachDeliveryTemplateSourceObject. Schemas:DeliveryDocumentKind,DeliveryTemplateSourceRemoveInput.POST /api/v1/delivery/template-sources/:sourceID/sync-syncDeliveryTemplateSource. Schemas:DeliveryTemplateSyncInput,DeliveryTemplateSyncRunEnvelope.GET /api/v1/delivery/template-sources/:sourceID/sync-runs-listDeliveryTemplateSyncRuns. Schemas:DeliveryTemplateSyncRunListEnvelope.GET /api/v1/delivery/template-sources/:sourceID/sync-runs/:runID-getDeliveryTemplateSyncRun. Schemas:DeliveryTemplateSyncRunEnvelope.POST /api/v1/delivery/template-sources/:sourceID/sync-runs/:runID/apply-applyDeliveryTemplateSync. Schemas:DeliveryTemplateSyncApplyInput,DeliveryTemplateSyncRunEnvelope.GET /api/v1/delivery/template-updates/policies-listTemplateUpdatePolicies. List explicit adoption policies visible to the current principal Schemas:TemplateUpdateKind,TemplateUpdatePolicyListEnvelope.PUT /api/v1/delivery/template-updates/policies-saveTemplateUpdatePolicy. Save fixed manual automatic or approval policy using a binding-scoped CAS Schemas:TemplateUpdatePolicyEnvelope,TemplateUpdatePolicyInput.POST /api/v1/delivery/template-updates/previews-createTemplateUpdatePreview. Freeze final template adoption and cumulative plus adjacent-version differences Schemas:TemplateUpdatePreviewEnvelope,TemplateUpdatePreviewInput.GET /api/v1/delivery/template-updates/previews/:previewID-getTemplateUpdatePreview. Read a frozen adoption preview with current scope revalidation Schemas:TemplateUpdatePreviewEnvelope.POST /api/v1/delivery/template-updates/previews/:previewID/batches-createTemplateUpdateBatch. Adopt selected candidates in waves through existing DeliveryBatch and Plan approvals Schemas:DeliveryBatchEnvelope,TemplateUpdateBatchInput.GET /api/v1/delivery/template-updates/targets-listTemplateUpdateTargets. Preview affected application bindings with honest paginated totals Schemas:TemplateUpdateKind,TemplateUpdateTargetPageEnvelope.GET /api/v1/delivery/triggers-listDeliveryTriggers. Schemas:DeliveryTriggerListEnvelope.POST /api/v1/delivery/triggers-createDeliveryTrigger. Schemas:DeliveryTriggerEnvelope,DeliveryTriggerInput.GET /api/v1/delivery/triggers/:triggerID-getDeliveryTrigger. Schemas:DeliveryTriggerEnvelope.PUT /api/v1/delivery/triggers/:triggerID-updateDeliveryTrigger. Schemas:DeliveryTriggerEnvelope,DeliveryTriggerInput.GET /api/v1/delivery/triggers/:triggerID/events-listDeliveryTriggerEvents. Schemas:DeliveryTriggerEventListEnvelope.POST /api/v1/delivery/triggers/:triggerID/webhook-receiveDeliveryTriggerWebhook. Schemas:DeliveryGitLabPushEvent,DeliveryTriggerEventEnvelope.GET /api/v1/delivery/workflow-catalog-listWorkflowCatalog. Schemas:WorkflowCatalogEnvelope.GET /api/v1/deployment-templates-listServiceDeploymentTemplates. listServiceDeploymentTemplates Schemas:ServiceDeploymentTemplateListEnvelope.POST /api/v1/deployment-templates-createServiceDeploymentTemplate. createServiceDeploymentTemplate Schemas:ServiceDeploymentTemplateEnvelope,ServiceDeploymentTemplateInput.DELETE /api/v1/deployment-templates/:deploymentTemplateID-deprecateServiceDeploymentTemplate. deprecateServiceDeploymentTemplateGET /api/v1/deployment-templates/:deploymentTemplateID-getServiceDeploymentTemplate. getServiceDeploymentTemplate Schemas:ServiceDeploymentTemplateEnvelope.PUT /api/v1/deployment-templates/:deploymentTemplateID-updateServiceDeploymentTemplate. updateServiceDeploymentTemplate Schemas:ServiceDeploymentTemplateEnvelope,ServiceDeploymentTemplateInput.POST /api/v1/deployment-templates/:deploymentTemplateID/publish-publishServiceDeploymentTemplate. publishServiceDeploymentTemplate Schemas:ServiceDeploymentTemplateEnvelope,TemplatePublishInput.GET /api/v1/deployment-templates/:deploymentTemplateID/versions-listServiceDeploymentTemplateVersions. listServiceDeploymentTemplateVersions Schemas:ServiceDeploymentTemplateListEnvelope.GET /api/v1/deployment-templates/:deploymentTemplateID/versions/:version-getServiceDeploymentTemplateVersion. getServiceDeploymentTemplateVersion Schemas:ServiceDeploymentTemplateEnvelope.GET /api/v1/registries-listRegistryConnections. Schemas:RegistryConnectionListEnvelope.POST /api/v1/registries-createRegistryConnection. Schemas:RegistryConnectionEnvelope,RegistryConnectionInput.DELETE /api/v1/registries/:connectionID-deleteRegistryConnection. Schemas:OperationStatus.PUT /api/v1/registries/:connectionID-updateRegistryConnection. Schemas:RegistryConnectionEnvelope,RegistryConnectionInput.POST /api/v1/workflow-requests-submitWorkflowRequest. Schemas:WorkflowRequestInput,WorkflowRequestReceiptEnvelope.GET /api/v1/workflow-requests/:requestKey-getWorkflowRequestReceipt. Schemas:WorkflowRequestReceiptEnvelope.GET /api/v1/workflow-templates-listWorkflowTemplates. Schemas:WorkflowTemplateListEnvelope.POST /api/v1/workflow-templates-createWorkflowTemplate. Schemas:WorkflowTemplateEnvelope,WorkflowTemplateInput.DELETE /api/v1/workflow-templates/:workflowTemplateID-deleteWorkflowTemplate. Schemas:OperationStatus.GET /api/v1/workflow-templates/:workflowTemplateID-getWorkflowTemplate. Schemas:WorkflowTemplateEnvelope.PUT /api/v1/workflow-templates/:workflowTemplateID-updateWorkflowTemplate. Schemas:WorkflowTemplateEnvelope,WorkflowTemplateInput.POST /api/v1/workflow-templates/:workflowTemplateID/publish-publishWorkflowTemplate. Schemas:TemplatePublishInput,WorkflowTemplateEnvelope.GET /api/v1/workflow-templates/:workflowTemplateID/versions-listWorkflowTemplateVersions. Schemas:WorkflowTemplateListEnvelope.GET /api/v1/workflow-templates/:workflowTemplateID/versions/:version-getWorkflowTemplateVersion. Schemas:WorkflowTemplateEnvelope.GET /api/v1/workflows-listWorkflowRuns. Schemas:WorkflowRun.GET /api/v1/workflows/:workflowRunID-getWorkflowRun. Schemas:WorkflowRunEnvelope.POST /api/v1/workflows/:workflowRunID/approve-approveWorkflowRun. Schemas:OperationCommentInput,WorkflowRunEnvelope.POST /api/v1/workflows/:workflowRunID/reject-rejectWorkflowRun. Schemas:OperationCommentInput,WorkflowRunEnvelope.POST /api/v1/workflows/trigger-triggerWorkflowRun. Schemas:WorkflowRunEnvelope,WorkflowTriggerRequest.
Directory
GET /api/v1/access/directory-connections/:connectionID/events-listDirectoryEvents. Schemas:DirectoryEventListEnvelope,DirectoryEventStatus.POST /api/v1/access/directory-connections/:connectionID/events/:eventID/retry-retryDirectoryEvent. Schemas:DirectoryEventEnvelope.GET /api/v1/access/directory-connections/:connectionID/runs-listDirectorySynchronizationRuns. Schemas:GenericItemsEnvelope.POST /api/v1/access/directory-connections/:connectionID/runs/:runID/cancel-cancelDirectorySynchronizationRun. Schemas:GenericDataEnvelope.GET /api/v1/access/directory-connections/:connectionID/runtime-status-getDirectoryConnectionRuntimeStatus. Schemas:DirectoryRuntimeStatusEnvelope.POST /api/v1/access/directory-connections/:connectionID/sync-startDirectorySynchronization. Schemas:GenericDataEnvelope.POST /api/v1/access/directory-connections/:connectionID/sync-requests-createDirectorySynchronizationRequest. Schemas:DirectorySyncRequestEnvelope,DirectorySyncRequestInput.GET /api/v1/access/directory-connections/:connectionID/sync-requests/:idempotencyKey-getOriginalDirectorySynchronizationRequest. Schemas:DirectorySyncRequestEnvelope.POST /api/v1/access/directory-connections/:connectionID/sync/preview-previewDirectorySynchronization. Schemas:GenericDataEnvelope.GET /api/v1/access/directory-runs/:runID-getDirectorySynchronizationRun. Schemas:GenericDataEnvelope.
Docker
GET /api/v1/docker/agent-installations/:installTicket/install.sh-downloadDockerHostAgentInstaller.GET /api/v1/docker/configuration-requests/:requestKey-getDockerConfigurationRequest. Schemas:DockerConfigurationReceiptEnvelope.POST /api/v1/docker/containers/start-startDockerContainer. Schemas:DockerContainerStartInput,DockerOperationEnvelope.POST /api/v1/docker/hosts/:dockerHostID/agent-installation-createDockerHostAgentInstallation. Schemas:DockerHostAgentInstallationEnvelope.PATCH /api/v1/docker/hosts/:dockerHostID/configuration-patchDockerHostConfiguration. Schemas:DockerConfigurationPatchInput,DockerConfigurationReceiptEnvelope.POST /api/v1/docker/hosts/:dockerHostID/configuration-deletion-deleteDockerHostConfiguration. Schemas:DockerConfigurationDeleteInput,DockerConfigurationReceiptEnvelope.GET /api/v1/docker/hosts/:dockerHostID/identity-getDockerHostIdentity. Schemas:DockerResourceIdentityEnvelope.POST /api/v1/docker/hosts/quick-create-quickCreateDockerHost. Schemas:DockerOperationEnvelope,DockerQuickCreateHostInput.POST /api/v1/docker/hosts/quick-create/plan-planDockerHostQuickCreate. Schemas:DockerQuickCreateHostInput,OperationalPlanEnvelope.POST /api/v1/docker/hosts/registrations-registerDockerHostConfiguration. Schemas:DockerConfigurationReceiptEnvelope,DockerHostRegistrationInput.POST /api/v1/docker/projects-createDockerProject. Schemas:DockerProjectEnvelope,DockerProjectInput.GET /api/v1/docker/projects/:dockerProjectID-getDockerProject. Schemas:DockerProjectEnvelope.PATCH /api/v1/docker/projects/:dockerProjectID/configuration-patchDockerProjectConfiguration. Schemas:DockerConfigurationPatchInput,DockerConfigurationReceiptEnvelope.POST /api/v1/docker/projects/:dockerProjectID/configuration-deletion-deleteDockerProjectConfiguration. Schemas:DockerConfigurationDeleteInput,DockerConfigurationReceiptEnvelope.GET /api/v1/docker/projects/:dockerProjectID/content-dlp-getDockerVolumeDLPPolicy. Schemas:DockerVolumeDLPPolicyEnvelope.PUT /api/v1/docker/projects/:dockerProjectID/content-dlp-saveDockerVolumeDLPPolicy. Schemas:DockerVolumeDLPPolicyEnvelope,DockerVolumeDLPSaveInput.GET /api/v1/docker/projects/:dockerProjectID/content-dlp/activity-listDockerVolumeDLPActivity. Schemas:DockerVolumeDLPCaseListEnvelope.GET /api/v1/docker/projects/:dockerProjectID/content-dlp/events-listDockerVolumeDLPEvents. Schemas:DockerVolumeDLPEventListEnvelope.GET /api/v1/docker/projects/:dockerProjectID/content-dlp/events/:eventID-getDockerVolumeDLPCase. Schemas:DockerVolumeDLPCaseEnvelope.POST /api/v1/docker/projects/:dockerProjectID/content-dlp/events/:eventID/appeal-appealDockerVolumeDLPTransfer. Schemas:DockerVolumeDLPAppealEnvelope,DockerVolumeDLPAppealInput.POST /api/v1/docker/projects/:dockerProjectID/content-dlp/events/:eventID/appeal/review-reviewDockerVolumeDLPAppeal. Schemas:DockerVolumeDLPAppealEnvelope,DockerVolumeDLPAppealReviewInput.POST /api/v1/docker/projects/:dockerProjectID/content-dlp/events/:eventID/authorizations-authorizeDockerVolumeDLPTransfer. Schemas:DockerVolumeDLPAuthorizationEnvelope,DockerVolumeDLPAuthorizationInput.POST /api/v1/docker/projects/:dockerProjectID/content-dlp/publish-publishDockerVolumeDLPPolicy. Schemas:DockerVolumeDLPPolicyEnvelope,DockerVolumeDLPPublishInput.POST /api/v1/docker/projects/:dockerProjectID/deploy-deployDockerProject. Schemas:DockerOperationEnvelope,DockerProjectDeployInput.GET /api/v1/docker/projects/:dockerProjectID/deploy-requests/:requestKey-getOriginalDockerProjectDeployment. Schemas:DockerOperationEnvelope.POST /api/v1/docker/projects/:dockerProjectID/deploy/plan-planDockerProjectDeploy. Schemas:DockerProjectDeployInput,OperationalPlanEnvelope.GET /api/v1/docker/projects/:dockerProjectID/identity-getDockerProjectIdentity. Schemas:DockerResourceIdentityEnvelope.POST /api/v1/docker/projects/:dockerProjectID/logs/query-queryDockerProjectLogs. Schemas:LogPageEnvelope,LogQuery.POST /api/v1/docker/projects/:dockerProjectID/logs/stream-ticket-issueDockerProjectLogStreamTicket. Schemas:LogQuery,StreamTicketEnvelope.GET /api/v1/docker/projects/:dockerProjectID/runtime/v1/file-readDockerRuntimeFileV1. Schemas:DockerRuntimeReadEnvelope.GET /api/v1/docker/projects/:dockerProjectID/runtime/v1/files-listDockerRuntimeFilesV1. Schemas:DockerRuntimeReadEnvelope.GET /api/v1/docker/projects/:dockerProjectID/runtime/v1/logs-getDockerRuntimeLogsV1. Schemas:DockerRuntimeReadEnvelope.GET /api/v1/docker/projects/:dockerProjectID/runtime/v1/volumes-getDockerRuntimeVolumesV1. Schemas:DockerRuntimeReadEnvelope.GET /api/v1/docker/projects/:dockerProjectID/runtime/volume-file-readDockerProjectVolumeFile. Schemas:DockerVolumeFileContentEnvelope.POST /api/v1/docker/projects/:dockerProjectID/runtime/volume-file/read-readDockerProjectVolumeTransfer. Schemas:DockerVolumeFileReadInput,DockerVolumeTransferResultEnvelope.POST /api/v1/docker/projects/:dockerProjectID/terminal-sessions-createDockerNativeTerminal. Schemas:DockerNativeTerminalCreatedEnvelope,DockerNativeTerminalInput.DELETE /api/v1/docker/projects/:dockerProjectID/terminal-sessions/:sessionID-closeDockerNativeTerminal. Schemas:DockerNativeTerminalSessionEnvelope.GET /api/v1/docker/projects/:dockerProjectID/terminal-sessions/:sessionID-getDockerNativeTerminal. Schemas:DockerNativeTerminalSessionEnvelope.GET /api/v1/docker/projects/:dockerProjectID/terminal-sessions/:sessionID/stream-streamDockerNativeTerminal.
Evaluation
GET /api/v1/ai/evaluations/datasets-listEvaluationDatasets. Schemas:EvaluationDatasetListEnvelope.POST /api/v1/ai/evaluations/datasets-createEvaluationDataset. Schemas:EvaluationDataset,EvaluationDatasetEnvelope.GET /api/v1/ai/evaluations/executor-profiles-listEvaluationExecutorProfiles. Schemas:EvaluationExecutorProfileListEnvelope.POST /api/v1/ai/evaluations/executor-profiles-putEvaluationExecutorProfile. Schemas:EvaluationExecutorProfile,EvaluationExecutorProfileEnvelope.GET /api/v1/ai/evaluations/feedback-listEvaluationFeedback. Schemas:EvaluationFeedbackListEnvelope.POST /api/v1/ai/evaluations/feedback-putEvaluationFeedback. Schemas:EvaluationFeedbackEnvelope,EvaluationFeedbackInput.GET /api/v1/ai/evaluations/gate-decisions-listEvaluationGateDecisions. Schemas:EvaluationGateDecisionListEnvelope.GET /api/v1/ai/evaluations/gate-policies-listEvaluationGatePolicies. Schemas:EvaluationGatePolicyListEnvelope.POST /api/v1/ai/evaluations/gate-policies-putEvaluationGatePolicy. Schemas:EvaluationGatePolicyEnvelope,EvaluationGatePolicyInput.POST /api/v1/ai/evaluations/gates/evaluate-evaluateEvaluationGate. Schemas:EvaluationGateDecisionEnvelope,EvaluationGateRequest.GET /api/v1/ai/evaluations/replays-listEvaluationReplayPlans. Schemas:EvaluationReplayPlanListEnvelope.POST /api/v1/ai/evaluations/replays-putEvaluationReplayPlan. Schemas:EvaluationReplayPlanEnvelope,EvaluationReplayPlanInput.GET /api/v1/ai/evaluations/runs-listEvaluationRuns. Schemas:EvaluationRunListEnvelope.POST /api/v1/ai/evaluations/runs-startEvaluationRun. Schemas:EvaluationRun,EvaluationRunEnvelope.GET /api/v1/ai/evaluations/runs/:runID-getEvaluationRun. Schemas:EvaluationRunEnvelope.GET /api/v1/ai/evaluations/runs/:runID/attempts-listEvaluationSampleAttempts. Schemas:EvaluationSampleAttemptListEnvelope.POST /api/v1/ai/evaluations/runs/:runID/complete-completeEvaluationRun. Schemas:EvaluationCompleteRunInput,EvaluationRunEnvelope.POST /api/v1/ai/evaluations/runs/:runID/execute-executeEvaluationRun. Schemas:EvaluationExecuteRunInput,EvaluationRunEnvelope.GET /api/v1/ai/evaluations/runs/:runID/results-listEvaluationRunResults. Schemas:EvaluationResultListEnvelope.
Governance
GET /api/v1/audit/logs-listPlatformAuditLogs. Schemas:PlatformAuditLogListEnvelope.GET /api/v1/audit/logs/export-exportPlatformAuditLogs.GET /api/v1/audit/summary-summarizePlatformAuditLogs. Schemas:PlatformAuditSummaryEnvelope.GET /api/v1/operations/logs-listPlatformOperationLogs. Schemas:PlatformOperationLogListEnvelope.GET /api/v1/operations/logs/export-exportPlatformOperationLogs.GET /api/v1/operations/summary-summarizePlatformOperationLogs. Schemas:PlatformOperationSummaryEnvelope.
Identity
GET /api/v1/identity/applications-listIdentityApplications. Schemas:IdentityApplicationListEnvelope.POST /api/v1/identity/applications-createIdentityApplication. Schemas:IdentityApplicationEnvelope,IdentityApplicationInput.DELETE /api/v1/identity/applications/:identityApplicationID-deleteIdentityApplication.GET /api/v1/identity/applications/:identityApplicationID-getIdentityApplication. Schemas:IdentityApplicationEnvelope.PUT /api/v1/identity/applications/:identityApplicationID-updateIdentityApplication. Schemas:IdentityApplicationEnvelope,IdentityApplicationInput.POST /api/v1/identity/applications/onboard-onboardIdentityApplication. Schemas:IdentityApplicationOnboardingEnvelope,IdentityApplicationOnboardingInput.GET /api/v1/identity/capabilities-getIdentityRuntimeCapabilities. Schemas:IdentityRuntimeCapabilityEnvelope.POST /api/v1/identity/mfa/challenges/:mfaChallengeID/verify-verifyMFAChallenge. Schemas:MFAChallengeResultEnvelope,MFAChallengeVerifyRequest.GET /api/v1/identity/mfa/credentials-listMFACredentials. Schemas:MFACredentialListEnvelope.DELETE /api/v1/identity/mfa/credentials/:mfaCredentialID-revokeMFACredential.POST /api/v1/identity/mfa/recovery-codes/challenge-beginMFARecoveryChallenge. Schemas:MFARecoveryChallengeEnvelope.POST /api/v1/identity/mfa/recovery-codes/regenerate-regenerateMFARecoveryCodes. Schemas:MFARecoveryCodeSetEnvelope.POST /api/v1/identity/mfa/totp/enroll-beginTOTPEnrollment. Schemas:MFAEnrollmentChallengeEnvelope.POST /api/v1/identity/mfa/webauthn/authenticate-beginWebAuthnAuthentication. Schemas:MFAWebAuthnAuthenticationRequest,MFAWebAuthnRequestOptionsEnvelope.POST /api/v1/identity/mfa/webauthn/challenges/:mfaChallengeID/verify-verifyWebAuthnChallenge. Schemas:MFAChallengeResultEnvelope,MFAWebAuthnResponse.POST /api/v1/identity/mfa/webauthn/enroll-beginWebAuthnEnrollment. Schemas:MFAWebAuthnCreationOptionsEnvelope.GET /api/v1/identity/oidc-clients-listIdentityOIDCClients. Schemas:OIDCClientListEnvelope.POST /api/v1/identity/oidc-clients-createIdentityOIDCClient. Schemas:OIDCClientEnvelope,OIDCClientInput.DELETE /api/v1/identity/oidc-clients/:oidcClientID-deleteIdentityOIDCClient.GET /api/v1/identity/oidc-clients/:oidcClientID-getIdentityOIDCClient. Schemas:OIDCClientEnvelope.PUT /api/v1/identity/oidc-clients/:oidcClientID-updateIdentityOIDCClient. Schemas:OIDCClientEnvelope,OIDCClientInput.POST /api/v1/identity/oidc-clients/:oidcClientID/secret/reveal-revealIdentityOIDCClientSecret. Schemas:OIDCClientSecretRevealEnvelope.POST /api/v1/identity/outpost-runtime-executor/callback-recordIdentityOutpostRuntimeExecutionCallback. Schemas:ExecutionCallbackRequest,ExecutionTaskEnvelope.POST /api/v1/identity/outpost-runtime-executor/claim-claimIdentityOutpostRuntimeExecution. Schemas:ExecutionTaskEnvelope,IdentityOutpostRuntimeExecutorClaimRequest.GET /api/v1/identity/outpost-runtime-executor/status-getIdentityOutpostRuntimeExecutionStatus. Schemas:ExecutionTaskEnvelope.GET /api/v1/identity/outposts-listIdentityOutposts. Schemas:IdentityOutpostListEnvelope.POST /api/v1/identity/outposts-createIdentityOutpost. Schemas:IdentityOutpostEnvelope,IdentityOutpostInput.DELETE /api/v1/identity/outposts/:identityOutpostID-deleteIdentityOutpost.GET /api/v1/identity/outposts/:identityOutpostID-getIdentityOutpost. Schemas:IdentityOutpostEnvelope.PUT /api/v1/identity/outposts/:identityOutpostID-updateIdentityOutpost. Schemas:IdentityOutpostEnvelope,IdentityOutpostInput.POST /api/v1/identity/outposts/:identityOutpostID/check-checkIdentityOutpostAccess. Schemas:IdentityOutpostAccessCheckEnvelope,IdentityOutpostAccessCheckRequest.POST /api/v1/identity/outposts/:identityOutpostID/events-recordIdentityOutpostRuntimeEvents. Schemas:IdentityOutpostEventBatchRequest,OperationStatus.POST /api/v1/identity/outposts/:identityOutpostID/heartbeat-heartbeatIdentityOutpostRuntime. Schemas:IdentityOutpostHeartbeatEnvelope,IdentityOutpostHeartbeatRequest.GET /api/v1/identity/outposts/:identityOutpostID/runtime-getIdentityOutpostRuntime. Schemas:IdentityOutpostRuntimeEnvelope.PUT /api/v1/identity/outposts/:identityOutpostID/runtime-bindIdentityOutpostRuntime. Schemas:IdentityOutpostRuntimeBindingInput,IdentityOutpostRuntimeMutationEnvelope.POST /api/v1/identity/outposts/:identityOutpostID/runtime/control-controlIdentityOutpostRuntime. Schemas:IdentityOutpostRuntimeControlInput,IdentityOutpostRuntimeMutationEnvelope.POST /api/v1/identity/outposts/runtime/claim-claimIdentityOutpostRuntime. Schemas:IdentityOutpostClaimRequest,IdentityOutpostRuntimeConfigEnvelope.GET /api/v1/identity/policies-listIdentityPolicies. Schemas:IdentityPolicyListEnvelope.POST /api/v1/identity/policies-createIdentityPolicy. Schemas:IdentityPolicyEnvelope,IdentityPolicyInput.DELETE /api/v1/identity/policies/:identityPolicyID-deleteIdentityPolicy.GET /api/v1/identity/policies/:identityPolicyID-getIdentityPolicy. Schemas:IdentityPolicyEnvelope.PUT /api/v1/identity/policies/:identityPolicyID-updateIdentityPolicy. Schemas:IdentityPolicyEnvelope,IdentityPolicyInput.GET /api/v1/identity/providers-listIdentityProviders. Schemas:IdentityProviderListEnvelope.POST /api/v1/identity/providers-createIdentityProvider. Schemas:IdentityProviderEnvelope,IdentityProviderInput.DELETE /api/v1/identity/providers/:identityProviderID-deleteIdentityProvider.GET /api/v1/identity/providers/:identityProviderID-getIdentityProvider. Schemas:IdentityProviderEnvelope.PUT /api/v1/identity/providers/:identityProviderID-updateIdentityProvider. Schemas:IdentityProviderEnvelope,IdentityProviderInput.GET /api/v1/identity/providers/:identityProviderID/oidc-clients-listIdentityProviderOIDCClients. Schemas:OIDCClientListEnvelope.POST /api/v1/identity/providers/:identityProviderID/oidc-clients-createIdentityProviderOIDCClient. Schemas:OIDCClientCreatedEnvelope,OIDCClientInput.POST /api/v1/identity/providers/:identityProviderID/saml/certificate/rotate-rotateIdentityProviderSAMLCertificate. Schemas:SAMLCertificateRotateRequest,SAMLCertificateRotationEnvelope.GET /api/v1/identity/providers/:identityProviderID/setup-getIdentityProviderSetup. Read saved provider configuration and server-derived integration endpoints. Schemas:IdentityProviderSetupEnvelope.GET /api/v1/identity/providers/:identityProviderID/users/:userID/metadata-getIdentityProviderUserMetadata. Preview application attributes for a selected active user without signing tokens or creating a session. Schemas:IdentityProviderUserMetadataEnvelope.POST /api/v1/identity/saml/certificates/:certificateID/rotate-rotateSAMLCertificate. Schemas:SAMLCertificateRotateRequest,SAMLCertificateRotationEnvelope.GET /api/v1/identity/saml/login-sources-listSAMLLoginSources. Schemas:SAMLLoginSourceListEnvelope.POST /api/v1/identity/saml/login-sources-createSAMLLoginSource. Schemas:SAMLLoginSourceEnvelope,SAMLLoginSourceInput.DELETE /api/v1/identity/saml/login-sources/:samlLoginSourceID-deleteSAMLLoginSource.GET /api/v1/identity/saml/login-sources/:samlLoginSourceID-getSAMLLoginSource. Schemas:SAMLLoginSourceEnvelope.PUT /api/v1/identity/saml/login-sources/:samlLoginSourceID-updateSAMLLoginSource. Schemas:SAMLLoginSourceEnvelope,SAMLLoginSourceInput.POST /api/v1/identity/saml/login-sources/import-importSAMLLoginSourceMetadata. Schemas:SAMLLoginSourceEnvelope,SAMLMetadataImportRequest.POST /api/v1/identity/saml/metadata/validate-validateSAMLMetadata. Schemas:SAMLMetadataInput,SAMLMetadataValidationEnvelope.POST /api/v1/identity/users/:identityUserID/mfa/credentials/:mfaCredentialID/revoke-adminRevokeUserMFACredential. Schemas:OperationStatus.POST /api/v1/identity/users/:identityUserID/mfa/reset-adminResetUserMFA. Schemas:MFAAdminResetRequest,MFAAdminResetResultEnvelope.GET /api/v1/saml2/idp/:identityProviderID/metadata-getSAMLIdentityProviderMetadata.GET /api/v1/saml2/idp/:identityProviderID/sso-beginSAMLIdentityProviderSSO.POST /api/v1/saml2/idp/:identityProviderID/sso-postSAMLIdentityProviderSSO. Schemas:SAMLRequestForm.
Knowledge
GET /api/v1/ai/knowledge-bases-listKnowledgeBases. Schemas:KnowledgeBaseListEnvelope.POST /api/v1/ai/knowledge-bases-createKnowledgeBase. Schemas:KnowledgeBaseEnvelope,KnowledgeBaseInput.DELETE /api/v1/ai/knowledge-bases/:baseID-deleteKnowledgeBase. Schemas:OperationStatus.GET /api/v1/ai/knowledge-bases/:baseID-getKnowledgeBase. Schemas:KnowledgeBaseEnvelope.PATCH /api/v1/ai/knowledge-bases/:baseID-updateKnowledgeBase. Schemas:KnowledgeBaseEnvelope,KnowledgeBaseInput.GET /api/v1/ai/knowledge-bases/:baseID/documents-listKnowledgeDocuments. Schemas:KnowledgeDocumentListEnvelope.GET /api/v1/ai/knowledge-bases/:baseID/graph-revisions-listKnowledgeGraphRevisions. Schemas:KnowledgeGraphRevisionListEnvelope.POST /api/v1/ai/knowledge-bases/:baseID/graph-revisions-putKnowledgeGraphRevision. Schemas:KnowledgeGraphRevision,KnowledgeGraphRevisionEnvelope.POST /api/v1/ai/knowledge-bases/:baseID/graph-revisions/:revisionID/publish-publishKnowledgeGraphRevision. Schemas:KnowledgeGraphRevisionEnvelope.POST /api/v1/ai/knowledge-bases/:baseID/graph-revisions/:revisionID/query-queryKnowledgeGraphRevision. Schemas:KnowledgeGraphQueryInput,KnowledgeGraphQueryResultEnvelope.GET /api/v1/ai/knowledge-bases/:baseID/index-revisions-listKnowledgeIndexRevisions. Schemas:KnowledgeIndexRevisionListEnvelope.POST /api/v1/ai/knowledge-bases/:baseID/rebuild-rebuildKnowledgeBaseIndex. Schemas:AIProductionOperationEnvelope.GET /api/v1/ai/knowledge-bases/:baseID/sources-listKnowledgeSources. Schemas:KnowledgeSourceListEnvelope.POST /api/v1/ai/knowledge-bases/:baseID/sources-createKnowledgeSource. Schemas:KnowledgeSourceEnvelope,KnowledgeSourceInput.POST /api/v1/ai/knowledge-bases/:baseID/sources/:sourceID/sync-syncKnowledgeSource. Schemas:KnowledgeSyncRunEnvelope.POST /api/v1/ai/knowledge-bases/:baseID/sync-jobs-createKnowledgeIngestionJob. Schemas:KnowledgeIngestionJobEnvelope,KnowledgeIngestionJobInput.GET /api/v1/ai/knowledge-bases/:baseID/sync-runs-listKnowledgeSyncRuns. Schemas:KnowledgeSyncRunListEnvelope.GET /api/v1/ai/knowledge/connectors-listKnowledgeConnectors. Schemas:KnowledgeConnectorListEnvelope.POST /api/v1/ai/knowledge/connectors-createKnowledgeConnector. Schemas:KnowledgeConnectorEnvelope,KnowledgeConnectorInput.POST /api/v1/ai/knowledge/connectors/:connectorID/validate-validateKnowledgeConnector. Schemas:KnowledgeConnectorValidationEnvelope.POST /api/v1/ai/knowledge/search-searchKnowledge. Schemas:KnowledgeSearchRequest,KnowledgeSearchResultEnvelope.GET /api/v1/ai/knowledge/sync-jobs/:jobID-getKnowledgeIngestionJob. Schemas:KnowledgeIngestionJobEnvelope.POST /api/v1/ai/knowledge/sync-jobs/:jobID/cancel-cancelKnowledgeIngestionJob. Schemas:KnowledgeIngestionJobEnvelope.POST /api/v1/ai/knowledge/sync-jobs/:jobID/retry-retryKnowledgeIngestionJob. Schemas:KnowledgeIngestionJobEnvelope.
Marketplace
GET /api/v1/marketplace/index.json-getPublicMarketplaceCatalog. Schemas:MarketplaceCatalog.GET /api/v1/marketplace/plugins/:pluginID/:version/plugin.manifest.json-getPublicMarketplacePluginManifest. Schemas:PluginManifest.GET /api/v1/marketplace/plugins/:pluginID/:version/provenance.json-getPublicMarketplacePluginProvenance. Schemas:PluginProvenanceStatement.
MCP
GET /api/v1/mcp/capabilities-listMCPCapabilities. Schemas:MCPCapabilityListEnvelope.- Status:
implemented - Permissions:
authenticated Gateway or MCP caller context,permission-filtered capability visibility - Scopes: MCP adapter catalog; caller principal; optional AI client, source, and skill context
- Audit: Returns MCP-facing capability metadata for the caller without mutating state; downstream tool/resource/prompt calls perform their own Gateway audit and authorization checks.
- Examples: HTTP request
GET /api/v1/mcp/capabilities
- Status:
Memory
GET /api/v1/ai/memory-listAIMemoryRecords. Schemas:AIMemoryRecordListEnvelope.POST /api/v1/ai/memory-putAIMemoryRecord. Schemas:AIMemoryRecordEnvelope,AIMemoryWriteInput.DELETE /api/v1/ai/memory/:memoryID-deleteAIMemoryRecord.GET /api/v1/ai/memory/policies-listAIMemoryPolicies. Schemas:AIMemoryPolicyListEnvelope.POST /api/v1/ai/memory/policies-putAIMemoryPolicy. Schemas:AIMemoryPolicyEnvelope,AIMemoryPolicyInput.
Network Access
GET /api/v1/network-access/access-grants-listNetworkAccessGrants. Schemas:NetworkAccessGrantListEnvelope,NetworkAccessGrantStatus.POST /api/v1/network-access/access-grants-createNetworkAccessGrant. Schemas:NetworkAccessGrantInput,NetworkAccessGrantSecretEnvelope.GET /api/v1/network-access/access-grants/:grantID-getNetworkAccessGrant. Schemas:NetworkAccessGrantEnvelope.POST /api/v1/network-access/access-grants/:grantID/revoke-revokeNetworkAccessGrant. Schemas:NetworkAccessGrantEnvelope.POST /api/v1/network-access/admission/preview-previewNetworkAdmission. Schemas:NetworkAdmissionPreviewEnvelope,NetworkAdmissionPreviewRequest.POST /api/v1/network-access/conflicts/analyze-analyzeNetworkAccessConflicts. Schemas:NetworkConflictAnalysisEnvelope,NetworkConflictAnalysisRequest.GET /api/v1/network-access/connection-options-listCurrentNetworkConnectionOptions. Schemas:NetworkConnectionOptionListEnvelope.GET /api/v1/network-access/devices-listEndpointDevices. Schemas:EndpointDeviceListEnvelope,EndpointDeviceStatus.GET /api/v1/network-access/devices/:deviceID-getEndpointDevice. Schemas:EndpointDeviceEnvelope.PUT /api/v1/network-access/devices/:deviceID-updateEndpointDevice. Schemas:EndpointDeviceEnvelope,EndpointDeviceInput.POST /api/v1/network-access/devices/:deviceID/management-proof-submitNetworkManagementProof. Schemas:EndpointDeviceEnvelope,NetworkManagementProofInput.PUT /api/v1/network-access/devices/:deviceID/registration-registerEndpointDevice. Schemas:EndpointDeviceEnvelope,EndpointDeviceRegistrationInput.GET /api/v1/network-access/endpoint-devices/:deviceID/presence-getNetworkEndpointPresence. Schemas:NetworkEndpointPresenceEnvelope.GET /api/v1/network-access/endpoint-maintenance-windows-listNetworkEndpointMaintenanceWindows. Schemas:NetworkEndpointMaintenanceListEnvelope.POST /api/v1/network-access/endpoint-maintenance-windows-createNetworkEndpointMaintenanceWindow. Schemas:NetworkEndpointMaintenanceEnvelope,NetworkEndpointMaintenanceInput.DELETE /api/v1/network-access/endpoint-maintenance-windows/:windowID-deleteNetworkEndpointMaintenanceWindow.GET /api/v1/network-access/endpoint-response-events-listNetworkEndpointResponseEvents. Schemas:NetworkEndpointResponseEventListEnvelope,NetworkEndpointResponseEventStatus.GET /api/v1/network-access/endpoint-response-events/:eventID-getNetworkEndpointResponseEvent. Schemas:NetworkEndpointResponseEventEnvelope.POST /api/v1/network-access/endpoint-response-events/:eventID/restore-restoreNetworkEndpointResponseEvent. Schemas:NetworkEndpointResponseEventEnvelope,NetworkEndpointResponseRestoreInput.GET /api/v1/network-access/endpoint-response-policies-listNetworkEndpointResponsePolicies. Schemas:NetworkEndpointResponsePolicyListEnvelope.POST /api/v1/network-access/endpoint-response-policies-createNetworkEndpointResponsePolicy. Schemas:NetworkEndpointResponsePolicyEnvelope,NetworkEndpointResponsePolicyInput.DELETE /api/v1/network-access/endpoint-response-policies/:policyID-deleteNetworkEndpointResponsePolicy.GET /api/v1/network-access/endpoint-response-policies/:policyID-getNetworkEndpointResponsePolicy. Schemas:NetworkEndpointResponsePolicyEnvelope.PUT /api/v1/network-access/endpoint-response-policies/:policyID-updateNetworkEndpointResponsePolicy. Schemas:NetworkEndpointResponsePolicyEnvelope,NetworkEndpointResponsePolicyInput.POST /api/v1/network-access/endpoint-response-policies/:policyID/preview-previewNetworkEndpointResponsePolicy. Schemas:NetworkEndpointResponsePreviewEnvelope,NetworkEndpointResponsePreviewInput.POST /api/v1/network-access/endpoint-response-policies/:policyID/publish-publishNetworkEndpointResponsePolicy. Schemas:NetworkEndpointResponsePolicyEnvelope,NetworkEndpointResponsePolicyPublishInput.GET /api/v1/network-access/endpoint-response-policies/:policyID/revisions-listNetworkEndpointResponsePolicyRevisions. Schemas:NetworkEndpointResponsePolicyRevisionListEnvelope.POST /api/v1/network-access/endpoint-response-policies/:policyID/rollback-rollbackNetworkEndpointResponsePolicy. Schemas:NetworkEndpointResponsePolicyEnvelope,NetworkEndpointResponsePolicyRollbackInput.GET /api/v1/network-access/enrollments-listNetworkRuntimeEnrollments. Schemas:NetworkRuntimeEnrollmentListEnvelope.POST /api/v1/network-access/enrollments-createNetworkRuntimeEnrollment. Schemas:NetworkRuntimeEnrollmentInput,NetworkRuntimeEnrollmentSecretEnvelope.GET /api/v1/network-access/enrollments/:enrollmentID-getNetworkRuntimeEnrollment. Schemas:NetworkRuntimeEnrollmentEnvelope.POST /api/v1/network-access/enrollments/:enrollmentID/revoke-revokeNetworkRuntimeEnrollment. Schemas:NetworkRuntimeEnrollmentEnvelope.GET /api/v1/network-access/gateways-listNetworkGateways. Schemas:NetworkGatewayListEnvelope,NetworkGatewayStatus.POST /api/v1/network-access/gateways-createNetworkGateway. Schemas:NetworkGatewayEnvelope,NetworkGatewayInput.GET /api/v1/network-access/gateways/:gatewayID-getNetworkGateway. Schemas:NetworkGatewayEnvelope.PUT /api/v1/network-access/gateways/:gatewayID-updateNetworkGateway. Schemas:NetworkGatewayEnvelope,NetworkGatewayInput.GET /api/v1/network-access/mihomo-profiles-listNetworkMihomoProfiles. Schemas:NetworkMihomoMode,NetworkMihomoProfileListEnvelope,NetworkMihomoProfileStatus.POST /api/v1/network-access/mihomo-profiles-createNetworkMihomoProfile. Schemas:NetworkMihomoProfileEnvelope,NetworkMihomoProfileInput.DELETE /api/v1/network-access/mihomo-profiles/:profileID-deleteNetworkMihomoProfile. Schemas:OperationStatus.GET /api/v1/network-access/mihomo-profiles/:profileID-getNetworkMihomoProfile. Schemas:NetworkMihomoProfileEnvelope.PUT /api/v1/network-access/mihomo-profiles/:profileID-updateNetworkMihomoProfile. Schemas:NetworkMihomoProfileEnvelope,NetworkMihomoProfileInput.GET /api/v1/network-access/nas-bindings-listNetworkNASBindings. Schemas:NetworkNASBindingListEnvelope,NetworkNASBindingStatus.POST /api/v1/network-access/nas-bindings-createNetworkNASBinding. Schemas:NetworkNASBindingEnvelope,NetworkNASBindingInput.DELETE /api/v1/network-access/nas-bindings/:bindingID-deleteNetworkNASBinding. Schemas:OperationStatus.GET /api/v1/network-access/nas-bindings/:bindingID-getNetworkNASBinding. Schemas:NetworkNASBindingEnvelope.PUT /api/v1/network-access/nas-bindings/:bindingID-updateNetworkNASBinding. Schemas:NetworkNASBindingEnvelope,NetworkNASBindingInput.GET /api/v1/network-access/policies-listNetworkAccessPolicies. Schemas:NetworkAccessPolicyListEnvelope,NetworkPolicyEffect.POST /api/v1/network-access/policies-createNetworkAccessPolicy. Schemas:NetworkAccessPolicyEnvelope,NetworkAccessPolicyInput.DELETE /api/v1/network-access/policies/:policyID-deleteNetworkAccessPolicy. Schemas:OperationStatus.GET /api/v1/network-access/policies/:policyID-getNetworkAccessPolicy. Schemas:NetworkAccessPolicyEnvelope.PUT /api/v1/network-access/policies/:policyID-updateNetworkAccessPolicy. Schemas:NetworkAccessPolicyEnvelope,NetworkAccessPolicyInput.POST /api/v1/network-access/policies/compile-compileNetworkAccessPolicySnapshot. Schemas:NetworkPolicySnapshotEnvelope.POST /api/v1/network-access/policy/preview-previewNetworkAccessPolicy. Schemas:NetworkPolicyPreviewEnvelope,NetworkPolicyPreviewRequest.GET /api/v1/network-access/policy/snapshot-getNetworkAccessPolicySnapshot. Schemas:NetworkPolicySnapshotEnvelope.GET /api/v1/network-access/proxy-instances-listNetworkProxyInstances. Schemas:NetworkProxyEngine,NetworkProxyInstanceListEnvelope.POST /api/v1/network-access/proxy-instances-createNetworkProxyInstance. Schemas:NetworkProxyInstanceEnvelope,NetworkProxyInstanceInput.GET /api/v1/network-access/proxy-instances/:instanceID-getNetworkProxyInstance. Schemas:NetworkProxyInstanceEnvelope.GET /api/v1/network-access/proxy-instances/:instanceID/bundles-listNetworkProxyBundles. Schemas:NetworkProxyBundleList.POST /api/v1/network-access/proxy-instances/:instanceID/bundles-createNetworkProxyBundle. Schemas:NetworkProxyBundle,NetworkProxyBundleInput.POST /api/v1/network-access/proxy-instances/:instanceID/bundles/:bundleID/activate-activateNetworkProxyBundle. Schemas:NetworkProxyBundle,NetworkProxyBundleActivateInput.GET /api/v1/network-access/proxy-instances/:instanceID/close-commands/:commandID-getNetworkProxyCloseCommand. Schemas:NetworkProxyCloseCommandEnvelope.POST /api/v1/network-access/proxy-instances/:instanceID/commands-createNetworkProxyRuntimeCommand. Schemas:NetworkProxyRuntimeCommandInput,NetworkProxyRuntimeCommandReceipt.GET /api/v1/network-access/proxy-instances/:instanceID/commands/:commandID-getNetworkProxyRuntimeCommand. Schemas:NetworkProxyRuntimeCommandReceipt.POST /api/v1/network-access/proxy-instances/:instanceID/commands/:commandID/cancel-cancelNetworkProxyRuntimeCommand.PUT /api/v1/network-access/proxy-instances/:instanceID/configuration-updateNetworkProxyConfiguration. Schemas:NetworkProxyConfigurationPatchInput,NetworkProxyInstanceEnvelope.GET /api/v1/network-access/proxy-instances/:instanceID/configuration-history-listNetworkProxyConfigurationHistory. Schemas:NetworkProxyConfigurationHistoryEnvelope.POST /api/v1/network-access/proxy-instances/:instanceID/configuration-history/:revision/restore-restoreNetworkProxyConfiguration. Schemas:NetworkProxyInstanceEnvelope,NetworkProxyRestoreInput.GET /api/v1/network-access/proxy-instances/:instanceID/connections-getNetworkProxyConnections. Schemas:NetworkProxyConnectionsEnvelope.POST /api/v1/network-access/proxy-instances/:instanceID/connections/:connectionID/close-closeNetworkProxyConnection. Schemas:NetworkProxyCloseCommandEnvelope,NetworkProxyCloseInput.GET /api/v1/network-access/proxy-instances/:instanceID/deployment-getNetworkProxyDeployment. Schemas:NetworkProxyDeployment.PUT /api/v1/network-access/proxy-instances/:instanceID/deployment-bindNetworkProxyDeployment. Schemas:NetworkProxyDeployment,NetworkProxyDeploymentInput.POST /api/v1/network-access/proxy-instances/:instanceID/deployment/control-controlNetworkProxyDeployment. Schemas:NetworkProxyDeploymentControlInput,NetworkProxyDeploymentOperation.GET /api/v1/network-access/proxy-instances/:instanceID/personal-rules-getNetworkProxyPersonalRules. Schemas:NetworkProxyRules.PUT /api/v1/network-access/proxy-instances/:instanceID/personal-rules-updateNetworkProxyPersonalRules. Schemas:NetworkProxyRules,NetworkProxyRulesInput.GET /api/v1/network-access/proxy-instances/:instanceID/rules-getNetworkProxyRules. Schemas:NetworkProxyRules.PUT /api/v1/network-access/proxy-instances/:instanceID/rules-updateNetworkProxyRules. Schemas:NetworkProxyRules,NetworkProxyRulesInput.GET /api/v1/network-access/proxy-instances/:instanceID/sources-listNetworkProxySources. Schemas:NetworkProxySourceList.POST /api/v1/network-access/proxy-instances/:instanceID/sources-createNetworkProxySource. Schemas:NetworkProxySource,NetworkProxySourceInput.DELETE /api/v1/network-access/proxy-instances/:instanceID/sources/:sourceID-deleteNetworkProxySource. Schemas:NetworkProxySource.GET /api/v1/network-access/proxy-instances/:instanceID/sources/:sourceID-getNetworkProxySource. Schemas:NetworkProxySource.PUT /api/v1/network-access/proxy-instances/:instanceID/sources/:sourceID-updateNetworkProxySource. Schemas:NetworkProxySource,NetworkProxySourceInput.POST /api/v1/network-access/proxy-instances/:instanceID/sources/preview-previewNetworkProxySource. Schemas:NetworkProxyConversionPreview,NetworkProxySourceInput.GET /api/v1/network-access/proxy-instances/:instanceID/traffic-getNetworkProxyTraffic. Schemas:NetworkProxyTrafficEnvelope.GET /api/v1/network-access/radius-pools-listNetworkRADIUSPools. Schemas:NetworkRADIUSPoolList.POST /api/v1/network-access/radius-pools-createNetworkRADIUSPool. Schemas:NetworkRADIUSPool,NetworkRADIUSPoolInput.GET /api/v1/network-access/radius-pools/:poolID-getNetworkRADIUSPool. Schemas:NetworkRADIUSPool.PUT /api/v1/network-access/radius-pools/:poolID/configuration-configureNetworkRADIUSPool. Schemas:NetworkRADIUSConfigurationInput,NetworkRADIUSPool.POST /api/v1/network-access/radius-pools/:poolID/control-controlNetworkRADIUSPool. Schemas:NetworkRADIUSControlInput,NetworkRADIUSPool.GET /api/v1/network-access/radius-pools/options-getNetworkRADIUSOptions. Schemas:NetworkRADIUSOptions.GET /api/v1/network-access/resources-listNetworkResources. Schemas:NetworkResourceKind,NetworkResourceListEnvelope.POST /api/v1/network-access/resources-createNetworkResource. Schemas:NetworkResourceEnvelope,NetworkResourceInput.DELETE /api/v1/network-access/resources/:resourceID-deleteNetworkResource. Schemas:OperationStatus.GET /api/v1/network-access/resources/:resourceID-getNetworkResource. Schemas:NetworkResourceEnvelope.PUT /api/v1/network-access/resources/:resourceID-updateNetworkResource. Schemas:NetworkResourceEnvelope,NetworkResourceInput.GET /api/v1/network-access/session-commands/:commandID-getNetworkSessionCommand. Schemas:NetworkSessionCommandEnvelope.GET /api/v1/network-access/sessions-listNetworkSessions. Schemas:NetworkSessionListEnvelope,NetworkSessionStatus.GET /api/v1/network-access/sessions/:sessionID-getNetworkSession. Schemas:NetworkSessionEnvelope.POST /api/v1/network-access/sessions/:sessionID/actions/execute-executeNetworkSessionAction. Schemas:NetworkSessionActionExecuteInput,NetworkSessionCommandEnvelope.POST /api/v1/network-access/sessions/:sessionID/actions/plan-planNetworkSessionAction. Schemas:NetworkSessionActionInput,NetworkSessionActionPlanEnvelope.GET /api/v1/network-access/sessions/:sessionID/command-request-getOriginalNetworkSessionCommand. Schemas:NetworkSessionCommandEnvelope.GET /api/v1/network-access/sessions/:sessionID/commands/:commandID-getNetworkSessionScopedCommand. Schemas:NetworkSessionCommandEnvelope.GET /api/v1/network-access/sessions/:sessionID/vpn-revocation-getNetworkVPNSessionRevocation. Schemas:NetworkVPNRevocationStateEnvelope.POST /api/v1/network-access/sessions/:sessionID/vpn-revocation-revokeNetworkVPNSession. Schemas:NetworkVPNRevocationEnvelope.POST /api/v1/network-access/sessions/:sessionID/vpn-revocation/release-releaseNetworkVPNSessionRevocation. Schemas:NetworkVPNRevocationEnvelope,NetworkVPNRevocationReleaseInput.GET /api/v1/network-access/site-profile-bindings-listNetworkSiteProfileBindings. Schemas:NetworkAccessProfile,NetworkSiteProfileBindingListEnvelope.POST /api/v1/network-access/site-profile-bindings-createNetworkSiteProfileBinding. Schemas:NetworkSiteProfileBindingEnvelope,NetworkSiteProfileBindingInput.DELETE /api/v1/network-access/site-profile-bindings/:bindingID-deleteNetworkSiteProfileBinding. Schemas:OperationStatus.GET /api/v1/network-access/site-profile-bindings/:bindingID-getNetworkSiteProfileBinding. Schemas:NetworkSiteProfileBindingEnvelope.PUT /api/v1/network-access/site-profile-bindings/:bindingID-updateNetworkSiteProfileBinding. Schemas:NetworkSiteProfileBindingEnvelope,NetworkSiteProfileBindingInput.GET /api/v1/network-access/sites-listNetworkSites. Schemas:NetworkSiteListEnvelope,NetworkSiteStatus.POST /api/v1/network-access/sites-createNetworkSite. Schemas:NetworkSiteEnvelope,NetworkSiteInput.DELETE /api/v1/network-access/sites/:siteID-deleteNetworkSite. Schemas:OperationStatus.GET /api/v1/network-access/sites/:siteID-getNetworkSite. Schemas:NetworkSiteEnvelope.PUT /api/v1/network-access/sites/:siteID-updateNetworkSite. Schemas:NetworkSiteEnvelope,NetworkSiteInput.GET /api/v1/network-access/spaces-listNetworkSpaces. Schemas:NetworkSpaceListEnvelope,NetworkSpaceStatus.POST /api/v1/network-access/spaces-createNetworkSpace. Schemas:NetworkSpaceEnvelope,NetworkSpaceInput.DELETE /api/v1/network-access/spaces/:spaceID-deleteNetworkSpace. Schemas:OperationStatus.GET /api/v1/network-access/spaces/:spaceID-getNetworkSpace. Schemas:NetworkSpaceEnvelope.PUT /api/v1/network-access/spaces/:spaceID-updateNetworkSpace. Schemas:NetworkSpaceEnvelope,NetworkSpaceInput.GET /api/v1/network-access/telemetry/summary-getNetworkTelemetrySummary. Schemas:NetworkTelemetrySummaryEnvelope.POST /api/v1/network-access/vpn/connection-intents-createCurrentNetworkVPNConnectionIntent. Schemas:NetworkVPNConnectionIntentEnvelope,NetworkVPNConnectionIntentInput.GET /api/v1/network-access/vpn/connection-options-listCurrentNetworkVPNConnectionOptions. Schemas:NetworkVPNConnectionOptionListEnvelope.GET /api/v1/network-access/vpn/current-connection-getCurrentNetworkVPNConnection. Schemas:NetworkVPNCurrentConnectionEnvelope.GET /api/v1/network-access/vpn/dashboard-getNetworkVPNDashboard. Schemas:NetworkVPNDashboardEnvelope.GET /api/v1/network-access/vpn/decisions/:id-getNetworkVPNDecision. Schemas:NetworkVPNDecisionEnvelope.GET /api/v1/network-access/vpn/profiles-listNetworkVPNProfiles. Schemas:NetworkVPNProfileListEnvelope.POST /api/v1/network-access/vpn/profiles-createNetworkVPNProfile. Schemas:NetworkVPNProfileEnvelope,NetworkVPNProfileInput.DELETE /api/v1/network-access/vpn/profiles/:id-deleteNetworkVPNProfile. Schemas:OperationStatus.GET /api/v1/network-access/vpn/profiles/:id-getNetworkVPNProfile. Schemas:NetworkVPNProfileEnvelope.PUT /api/v1/network-access/vpn/profiles/:id-updateNetworkVPNProfile. Schemas:NetworkVPNProfileEnvelope,NetworkVPNProfileInput.POST /api/v1/network-access/vpn/profiles/:id/publish-publishNetworkVPNProfile. Schemas:NetworkVPNProfileEnvelope,NetworkVPNRevisionInput.GET /api/v1/network-access/vpn/profiles/:id/revisions-listNetworkVPNProfileRevisions. Schemas:NetworkVPNProfileRevisionListEnvelope.POST /api/v1/network-access/vpn/profiles/:id/rollback-rollbackNetworkVPNProfile. Schemas:NetworkVPNProfileEnvelope,NetworkVPNRollbackInput.GET /api/v1/network-access/vpn/selection-policies-listNetworkVPNSelectionPolicies. Schemas:NetworkVPNSelectionPolicyListEnvelope.POST /api/v1/network-access/vpn/selection-policies-createNetworkVPNSelectionPolicy. Schemas:NetworkVPNSelectionPolicyEnvelope,NetworkVPNSelectionPolicyInput.DELETE /api/v1/network-access/vpn/selection-policies/:id-deleteNetworkVPNSelectionPolicy. Schemas:OperationStatus.GET /api/v1/network-access/vpn/selection-policies/:id-getNetworkVPNSelectionPolicy. Schemas:NetworkVPNSelectionPolicyEnvelope.PUT /api/v1/network-access/vpn/selection-policies/:id-updateNetworkVPNSelectionPolicy. Schemas:NetworkVPNSelectionPolicyEnvelope,NetworkVPNSelectionPolicyInput.POST /api/v1/network-access/vpn/selection-policies/:id/publish-publishNetworkVPNSelectionPolicy. Schemas:NetworkVPNRevisionInput,NetworkVPNSelectionPolicyEnvelope.GET /api/v1/network-access/vpn/selection-policies/:id/revisions-listNetworkVPNSelectionPolicyRevisions. Schemas:NetworkVPNSelectionPolicyRevisionListEnvelope.POST /api/v1/network-access/vpn/selection-policies/:id/rollback-rollbackNetworkVPNSelectionPolicy. Schemas:NetworkVPNRollbackInput,NetworkVPNSelectionPolicyEnvelope.POST /api/v1/network-access/vpn/selection-preview-previewNetworkVPNSelection. Schemas:NetworkVPNDecisionEnvelope,NetworkVPNPreviewInput.GET /api/v1/network-access/workload-bindings-listNetworkWorkloadBindings. Schemas:NetworkWorkloadBindingListEnvelope.PUT /api/v1/network-access/workload-bindings/:bindingID-putNetworkWorkloadBinding. Schemas:NetworkWorkloadBindingEnvelope,NetworkWorkloadBindingInput.POST /api/v1/network-control/v1/proxies/:runtimeID/ingress/check-checkNetworkProxyIngress. Schemas:NetworkProxyIngressCheckInput,NetworkProxyIngressCheckResult.POST /api/v1/network-control/v1/proxies/:runtimeID/publication/ready-acknowledgeNetworkProxyBundleReadback. Schemas:NetworkProxyBundleReadback.POST /api/v1/network-control/v1/proxy-instances/:runtimeID/commands/:commandID/result-completeNetworkProxyRuntimeCommand. Schemas:NetworkProxyRuntimeCommandReceipt.GET /api/v1/network-control/v1/proxy-instances/:runtimeID/commands/next-getNextNetworkProxyRuntimeCommand. Schemas:NetworkProxyRuntimeCommandInput.GET /api/v1/network-control/v1/proxy-runtimes/:runtimeID/deployment/control-getNetworkProxyDeploymentRuntimeControl. Schemas:NetworkProxyDeploymentRuntimeControl.POST /api/v1/network-control/v1/proxy-runtimes/:runtimeID/deployment/control/receipt-acknowledgeNetworkProxyDeploymentRuntimeControl. Schemas:NetworkProxyDeploymentRuntimeAck.GET /api/v1/network-control/v1/radius-runtimes/:runtimeID/control-getNetworkRADIUSRuntimeControl. Schemas:NetworkRADIUSRuntimeControl.POST /api/v1/network-control/v1/radius-runtimes/:runtimeID/control/receipt-acknowledgeNetworkRADIUSRuntimeControl. Schemas:NetworkRADIUSRuntimeACK.GET /api/v1/network-control/v1/runtimes/:runtimeID/mihomo-profiles/:profileID/direct-projection-getNetworkProxyDirectProjection. Schemas:NetworkProxyDirectProjection.GET /api/v1/network-control/v1/runtimes/:runtimeID/mihomo-profiles/:profileID/projection-getNetworkProxyEmployeeProjection. Schemas:NetworkProxyEmployeeProjection.POST /api/v1/network-control/v1/runtimes/:runtimeID/mihomo-profiles/:profileID/projection/receipt-acknowledgeNetworkProxyEmployeeProjection. Schemas:NetworkProxyProjectionApplied.
NetworkAccess
POST /api/v1/docker/projects/:dockerProjectID/content-dlp/preview-previewDockerContentDLPPolicy. Compare saved draft with active policy on bounded samples Schemas:DLPShadowEnvelope,DLPShadowInput.GET /api/v1/network-access/content-transfers/destinations-listManagedContentDestinations. listManagedContentDestinations Schemas:ManagedContentDestinationsEnvelope.GET /api/v1/network-access/content-transfers/destinations/:destinationID-getManagedContentDestination. getManagedContentDestination Schemas:ManagedContentDestinationEnvelope.PUT /api/v1/network-access/content-transfers/destinations/:destinationID-saveManagedContentDestination. saveManagedContentDestination Schemas:ManagedContentDestinationEnvelope,ManagedContentSaveInput.GET /api/v1/network-access/content-transfers/destinations/:destinationID/cases-listManagedContentCases. listManagedContentCases Schemas:ManagedContentRecordPageEnvelope.POST /api/v1/network-access/content-transfers/destinations/:destinationID/preview-previewManagedContentDestination. Compare saved draft with active policy on bounded samples Schemas:DLPShadowEnvelope,DLPShadowInput.POST /api/v1/network-access/content-transfers/destinations/:destinationID/publish-publishManagedContentDestination. publishManagedContentDestination Schemas:ManagedContentDestinationEnvelope,ManagedContentPublishInput.GET /api/v1/network-access/content-transfers/destinations/admin-listManagedContentAdminDestinations. listManagedContentAdminDestinations Schemas:ManagedContentAdminDestinationsEnvelope.GET /api/v1/network-access/content-transfers/destinations/review-listManagedContentReviewDestinations. List authorized destinations for content case review Schemas:ManagedContentDestinationsEnvelope.GET /api/v1/network-access/content-transfers/files-listManagedContentFiles. listManagedContentFiles Schemas:ManagedContentRecordPageEnvelope.POST /api/v1/network-access/content-transfers/files/:fileID/copy-performManagedContentFileCopy. performManagedContentFileCopy Schemas:ManagedContentCopyInput,ManagedContentResultEnvelope.POST /api/v1/network-access/content-transfers/files/:fileID/delete-performManagedContentFileDelete. performManagedContentFileDelete Schemas:ManagedContentRequest,ManagedContentResultEnvelope.POST /api/v1/network-access/content-transfers/files/:fileID/read-performManagedContentFileRead. performManagedContentFileRead Schemas:ManagedContentRequest,ManagedContentResultEnvelope.POST /api/v1/network-access/content-transfers/pastes-submitManagedContentPastes. submitManagedContentPastes Schemas:ManagedContentPasteInput,ManagedContentResultEnvelope.GET /api/v1/network-access/content-transfers/records-listManagedContentRecords. listManagedContentRecords Schemas:ManagedContentRecordPageEnvelope.GET /api/v1/network-access/content-transfers/records/:recordID-getManagedContentRecord. getManagedContentRecord Schemas:ManagedContentRecordEnvelope.POST /api/v1/network-access/content-transfers/records/:recordID/appeal-handleManagedContentAppeal. handleManagedContentAppeal Schemas:ManagedContentAppealInput,ManagedContentRecordEnvelope.POST /api/v1/network-access/content-transfers/records/:recordID/authorize-handleManagedContentAuthorize. handleManagedContentAuthorize Schemas:ManagedContentAuthorizationEnvelope,ManagedContentAuthorizeInput.GET /api/v1/network-access/content-transfers/records/:recordID/network-getManagedContentNetworkState. Read source-owned network hold and execution receipts Schemas:ManagedContentNetworkEnvelope.POST /api/v1/network-access/content-transfers/records/:recordID/review-handleManagedContentReview. handleManagedContentReview Schemas:ManagedContentRecordEnvelope,ManagedContentReviewInput.POST /api/v1/network-access/content-transfers/uploads-submitManagedContentUploads. submitManagedContentUploads Schemas:ManagedContentResultEnvelope,ManagedContentUploadInput.GET /api/v1/network-access/endpoint-devices/:deviceID/channel-controls-getEndpointChannelControls. Schemas:EndpointChannelViewEnvelope.PUT /api/v1/network-access/endpoint-devices/:deviceID/channel-controls-saveEndpointChannelControls. Schemas:EndpointChannelPolicyEnvelope,EndpointChannelSaveInput.POST /api/v1/network-access/endpoint-devices/:deviceID/channel-controls/publish-publishEndpointChannelControls. Schemas:EndpointChannelPolicyEnvelope,EndpointChannelPublishInput.
NetworkControl
GET /api/v1/network-control/v1/runtimes/:runtimeID/channel-controls-getRuntimeChannelControls. Schemas:EndpointChannelDesiredEnvelope.POST /api/v1/network-control/v1/runtimes/:runtimeID/channel-controls/receipt-reportRuntimeChannelControls. Schemas:EndpointChannelReport.
Observability
GET /api/v1/alert-events-listAlertEventRecords. Schemas:GenericItemsEnvelope.GET /api/v1/alert-events/:eventID-getAlertEventRecord. Schemas:GenericDataEnvelope.POST /api/v1/alert-events/:eventID/acknowledge-acknowledgeAlertEventRecord. Schemas:GenericDataEnvelope.POST /api/v1/alert-events/:eventID/heal-healAlertEventRecord. Schemas:GenericDataEnvelope.POST /api/v1/alert-events/:eventID/healing-requests-createOriginalHealingRequest. Schemas:HealingOriginalRequestEnvelope,HealingOriginalRequestInput.GET /api/v1/alert-events/:eventID/healing-requests/:requestID-getOriginalHealingRequest. Schemas:HealingOriginalRequestEnvelope.POST /api/v1/alert-events/:eventID/resolve-resolveAlertEventRecord. Schemas:GenericDataEnvelope.GET /api/v1/alert-events/stream-streamAlertEvents.GET /api/v1/alert-rule-runs-listAlertRuleRuns. Schemas:AlertRuleRunListEnvelope.GET /api/v1/alert-rules-listAlertRules. Schemas:AlertRuleListEnvelope.POST /api/v1/alert-rules-createAlertRule. Schemas:AlertRuleEnvelope,AlertRuleInput.GET /api/v1/alert-rules/:ruleID-getAlertRule. Schemas:AlertRuleEnvelope.PUT /api/v1/alert-rules/:ruleID-updateAlertRule. Schemas:AlertRuleEnvelope,AlertRuleInput.POST /api/v1/alert-rules/:ruleID/test-testAlertRule. Schemas:AlertRuleInput,AlertRuleTestResultEnvelope.POST /api/v1/alert-rules/:ruleID/validate-validateAlertRule. Schemas:AlertRuleInput,AlertRuleTestResultEnvelope.GET /api/v1/alerts-listAlertRecords. Schemas:GenericItemsEnvelope.GET /api/v1/alerts/:alertID-getAlertRecord. Schemas:GenericDataEnvelope.POST /api/v1/alerts/:alertID/acknowledge-acknowledgeAlertRecord. Schemas:GenericDataEnvelope.PUT /api/v1/alerts/:alertID/ownership-assignAlertOwnership. Schemas:AlertOwnershipInput,GenericDataEnvelope.GET /api/v1/clusters/:clusterID/observability/logging-getClusterLogCollection. Schemas:LogCollectionStateEnvelope.POST /api/v1/clusters/:clusterID/observability/logging/disable-disableClusterLogCollection. Schemas:LogCollectionDisableInput,LogCollectionStateEnvelope.POST /api/v1/clusters/:clusterID/observability/logging/enable-enableClusterLogCollection. Schemas:LogCollectionEnableInput,LogCollectionStateEnvelope.POST /api/v1/clusters/:clusterID/observability/logging/preflight-preflightClusterLogCollection. Schemas:LogCollectionPlanEnvelope,LogCollectionPreflightInput.GET /api/v1/healing-runs-listHealingRunRecords. Schemas:GenericItemsEnvelope.GET /api/v1/healing-runs/:runID-getHealingRunRecord. Schemas:GenericDataEnvelope.POST /api/v1/healing-runs/:runID/approve-approveHealingRunRecord. Schemas:GenericDataEnvelope,OperationCommentInput.POST /api/v1/healing-runs/:runID/reject-rejectHealingRunRecord. Schemas:GenericDataEnvelope,OperationCommentInput.POST /api/v1/healing-runs/:runID/retry-retryHealingRunRecord. Schemas:GenericDataEnvelope.GET /api/v1/monitoring/summary-getMonitoringSummary. Schemas:GenericDataEnvelope.GET /api/v1/observability/dashboards-listObservabilityDashboards. Schemas:ObservabilityDashboardListEnvelope.DELETE /api/v1/observability/dashboards/:dashboardID-deleteObservabilityDashboard. Schemas:OperationStatus.GET /api/v1/observability/dashboards/:dashboardID-getObservabilityDashboard. Schemas:ObservabilityDashboardEnvelope.POST /api/v1/observability/dashboards/:dashboardID/panels/:panelID/query-queryObservabilityDashboardPanel. Schemas:ObservabilityDashboardPanelQueryInput,ObservabilityMetricQueryEnvelope.POST /api/v1/observability/dashboards/imports-importGrafanaDashboard. Schemas:ObservabilityDashboardImportResultEnvelope,ObservabilityGrafanaDashboardImportInput.GET /api/v1/observability/data-sources-listObservabilityDataSources. Schemas:ObservabilityDataSourceListEnvelope.POST /api/v1/observability/data-sources-createObservabilityDataSource. Schemas:ObservabilityDataSourceEnvelope,ObservabilityDataSourceInput.PUT /api/v1/observability/data-sources/:dataSourceID-updateObservabilityDataSource. Schemas:ObservabilityDataSourceEnvelope,ObservabilityDataSourceInput.POST /api/v1/observability/data-sources/:dataSourceID/validate-validateObservabilityDataSource. Schemas:ObservabilityDataSourceEnvelope.GET /api/v1/observability/metrics/catalog-listObservabilityMetricCatalog. Schemas:ObservabilityMetricCatalogEnvelope.GET /api/v1/observability/metrics/data-sources-listObservabilityMetricDataSources. Schemas:ObservabilityMetricDataSourceListEnvelope.POST /api/v1/observability/metrics/query-queryObservabilityMetrics. Schemas:ObservabilityMetricQueryEnvelope,ObservabilityMetricQueryInput.GET /api/v1/observability/providers-listObservabilityProviders. Schemas:ObservabilityProviderListEnvelope.GET /api/v1/observability/services-listObservabilityServices. Schemas:ObservabilityServiceListEnvelope.GET /api/v1/observability/services/:serviceID-getObservabilityService. Schemas:ObservabilityServiceEnvelope.GET /api/v1/observability/services/:serviceID/topology-getObservabilityServiceTopology. Schemas:ObservabilityTopologyEnvelope.POST /api/v1/observability/traces/query-queryObservabilityTraces. Schemas:ObservabilityTraceQueryEnvelope,ObservabilityTraceQueryInput.
Platform
GET /api/v1/agent-sessions/connect-connectClusterAgentSession.GET /api/v1/clusters-listKubernetesClusters. Schemas:KubernetesClusterListEnvelope.POST /api/v1/clusters/:clusterID/access-control/access-reviews-reviewKubernetesSubjectAccess. Schemas:KubernetesSubjectAccessReviewInput,KubernetesSubjectAccessReviewResultEnvelope.GET /api/v1/clusters/:clusterID/access-control/clusterrolebindings-listKubernetesClusterRoleBindings. Schemas:KubernetesClusterRoleBindingListEnvelope.GET /api/v1/clusters/:clusterID/access-control/clusterrolebindings/:name/detail-getKubernetesClusterRoleBindingDetail. Schemas:KubernetesClusterRoleBindingDetailEnvelope.GET /api/v1/clusters/:clusterID/access-control/clusterroles-listKubernetesClusterRoles. Schemas:KubernetesClusterRoleListEnvelope.GET /api/v1/clusters/:clusterID/access-control/clusterroles/:name/detail-getKubernetesClusterRoleDetail. Schemas:KubernetesClusterRoleDetailEnvelope.GET /api/v1/clusters/:clusterID/access-control/rolebindings-listKubernetesRoleBindings. Schemas:KubernetesRoleBindingListEnvelope.GET /api/v1/clusters/:clusterID/access-control/rolebindings/:name/detail-getKubernetesRoleBindingDetail. Schemas:KubernetesRoleBindingDetailEnvelope.GET /api/v1/clusters/:clusterID/access-control/roles-listKubernetesRoles. Schemas:KubernetesRoleListEnvelope.GET /api/v1/clusters/:clusterID/access-control/roles/:name/detail-getKubernetesRoleDetail. Schemas:KubernetesRoleDetailEnvelope.GET /api/v1/clusters/:clusterID/access-control/serviceaccounts-listKubernetesServiceAccounts. Schemas:KubernetesServiceAccountListEnvelope.GET /api/v1/clusters/:clusterID/access-control/serviceaccounts/:name/detail-getKubernetesServiceAccountDetail. Schemas:KubernetesServiceAccountDetailEnvelope.POST /api/v1/clusters/:clusterID/agent-installation-createClusterAgentInstallation. Schemas:AgentInstallationEnvelope.GET /api/v1/clusters/:clusterID/agent-upgrade-getClusterAgentUpgradeStatus. Schemas:ClusterAgentUpgradeStatusEnvelope.POST /api/v1/clusters/:clusterID/agent-upgrade-upgradeClusterAgent. Schemas:ClusterAgentUpgradeInput,ClusterAgentUpgradeResultEnvelope.GET /api/v1/clusters/:clusterID/configuration/configmaps-listKubernetesConfigMaps. Schemas:KubernetesConfigMapListEnvelope.PUT /api/v1/clusters/:clusterID/configuration/configmaps/:name/data-updateKubernetesConfigMapData. Schemas:KubernetesConfigMapDataInput,KubernetesConfigMapDetailEnvelope.GET /api/v1/clusters/:clusterID/configuration/configmaps/:name/detail-getKubernetesConfigMapDetail. Schemas:KubernetesConfigMapDetailEnvelope.GET /api/v1/clusters/:clusterID/configuration/configmaps/:name/references-listKubernetesConfigMapReferences. Schemas:KubernetesConfigReferenceListEnvelope.GET /api/v1/clusters/:clusterID/configuration/hpas-listKubernetesHorizontalPodAutoscalers. Schemas:KubernetesHorizontalPodAutoscalerListEnvelope.DELETE /api/v1/clusters/:clusterID/configuration/hpas/:name-deleteKubernetesHorizontalPodAutoscaler.GET /api/v1/clusters/:clusterID/configuration/hpas/:name/detail-getKubernetesHorizontalPodAutoscalerDetail. Schemas:KubernetesHorizontalPodAutoscalerDetailEnvelope.GET /api/v1/clusters/:clusterID/configuration/hpas/:name/yaml-getKubernetesHorizontalPodAutoscalerYaml. Schemas:KubernetesResourceYamlEnvelope.PUT /api/v1/clusters/:clusterID/configuration/hpas/:name/yaml-applyKubernetesHorizontalPodAutoscalerYaml. Schemas:KubernetesResourceYamlEnvelope,KubernetesResourceYamlInput.GET /api/v1/clusters/:clusterID/configuration/leases-listKubernetesLeases. Schemas:KubernetesLeaseListEnvelope.GET /api/v1/clusters/:clusterID/configuration/limitranges-listKubernetesLimitRanges. Schemas:KubernetesLimitRangeListEnvelope.GET /api/v1/clusters/:clusterID/configuration/limitranges/:name/detail-getKubernetesLimitRangeDetail. Schemas:KubernetesLimitRangeDetailEnvelope.GET /api/v1/clusters/:clusterID/configuration/mutatingwebhookconfigurations-listKubernetesMutatingWebhookConfigurations. Schemas:KubernetesAdmissionWebhookConfigurationListEnvelope.GET /api/v1/clusters/:clusterID/configuration/mutatingwebhookconfigurations/:name/detail-getKubernetesMutatingWebhookConfigurationDetail. Schemas:KubernetesAdmissionWebhookConfigurationDetailEnvelope.GET /api/v1/clusters/:clusterID/configuration/poddisruptionbudgets-listKubernetesPodDisruptionBudgets. Schemas:KubernetesPodDisruptionBudgetListEnvelope.DELETE /api/v1/clusters/:clusterID/configuration/poddisruptionbudgets/:name-deleteKubernetesPodDisruptionBudget.GET /api/v1/clusters/:clusterID/configuration/poddisruptionbudgets/:name/detail-getKubernetesPodDisruptionBudgetDetail. Schemas:KubernetesPodDisruptionBudgetDetailEnvelope.GET /api/v1/clusters/:clusterID/configuration/poddisruptionbudgets/:name/yaml-getKubernetesPodDisruptionBudgetYaml. Schemas:KubernetesResourceYamlEnvelope.PUT /api/v1/clusters/:clusterID/configuration/poddisruptionbudgets/:name/yaml-applyKubernetesPodDisruptionBudgetYaml. Schemas:KubernetesResourceYamlEnvelope,KubernetesResourceYamlInput.GET /api/v1/clusters/:clusterID/configuration/priorityclasses-listKubernetesPriorityClasses. Schemas:KubernetesPriorityClassListEnvelope.GET /api/v1/clusters/:clusterID/configuration/resourcequotas-listKubernetesResourceQuotas. Schemas:KubernetesResourceQuotaListEnvelope.GET /api/v1/clusters/:clusterID/configuration/resourcequotas/:name/detail-getKubernetesResourceQuotaDetail. Schemas:KubernetesResourceQuotaDetailEnvelope.GET /api/v1/clusters/:clusterID/configuration/runtimeclasses-listKubernetesRuntimeClasses. Schemas:KubernetesRuntimeClassListEnvelope.GET /api/v1/clusters/:clusterID/configuration/secrets-listKubernetesSecretMetadata. Schemas:KubernetesSecretMetadataListEnvelope.GET /api/v1/clusters/:clusterID/configuration/secrets/:name/certificate-getKubernetesSecretCertificate. Schemas:KubernetesSecretCertificateEnvelope.PUT /api/v1/clusters/:clusterID/configuration/secrets/:name/data-updateKubernetesSecretData. Schemas:KubernetesSecretDataInput,KubernetesSecretDetailEnvelope.GET /api/v1/clusters/:clusterID/configuration/secrets/:name/detail-getKubernetesSecretDetail. Schemas:KubernetesSecretDetailEnvelope.GET /api/v1/clusters/:clusterID/configuration/secrets/:name/references-listKubernetesSecretReferences. Schemas:KubernetesConfigReferenceListEnvelope.PUT /api/v1/clusters/:clusterID/configuration/secrets/:name/yaml-applyKubernetesSecretYaml. Schemas:KubernetesObservedResourceYamlInput,KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/configuration/validatingwebhookconfigurations-listKubernetesValidatingWebhookConfigurations. Schemas:KubernetesAdmissionWebhookConfigurationListEnvelope.GET /api/v1/clusters/:clusterID/configuration/validatingwebhookconfigurations/:name/detail-getKubernetesValidatingWebhookConfigurationDetail. Schemas:KubernetesAdmissionWebhookConfigurationDetailEnvelope.GET /api/v1/clusters/:clusterID/detail-getKubernetesClusterDetail. Schemas:KubernetesClusterDetailEnvelope.GET /api/v1/clusters/:clusterID/events-listKubernetesClusterEvents. Schemas:KubernetesClusterEventListEnvelope.GET /api/v1/clusters/:clusterID/extensions/crds-listKubernetesCustomResourceDefinitions. Schemas:KubernetesCustomResourceDefinitionListEnvelope.DELETE /api/v1/clusters/:clusterID/extensions/crds/:crdName-deleteKubernetesCustomResourceDefinition.GET /api/v1/clusters/:clusterID/extensions/crds/:crdName/access-getKubernetesCustomResourceAccess. Schemas:KubernetesCustomResourceAccessEnvelope.GET /api/v1/clusters/:clusterID/extensions/crds/:crdName/resources-listKubernetesCustomResources. Schemas:KubernetesCustomResourceListEnvelope.DELETE /api/v1/clusters/:clusterID/extensions/crds/:crdName/resources/:name-deleteKubernetesCustomResource.GET /api/v1/clusters/:clusterID/helm/charts-listKubernetesHelmCharts. Schemas:KubernetesHelmChartCatalogEnvelope.GET /api/v1/clusters/:clusterID/helm/charts/:repositoryName/:chartName-getKubernetesHelmChartDetail. Schemas:KubernetesHelmChartDetailEnvelope.GET /api/v1/clusters/:clusterID/helm/releases-listKubernetesHelmReleases. Schemas:KubernetesHelmReleaseListEnvelope.GET /api/v1/clusters/:clusterID/helm/releases/:releaseName/detail-getKubernetesHelmReleaseDetail. Schemas:KubernetesHelmReleaseDetailEnvelope.GET /api/v1/clusters/:clusterID/helm/releases/:releaseName/history-listKubernetesHelmReleaseHistory. Schemas:KubernetesHelmReleaseHistoryListEnvelope.GET /api/v1/clusters/:clusterID/helm/releases/:releaseName/manifest-getKubernetesHelmReleaseManifest. Schemas:KubernetesHelmReleaseManifestEnvelope.POST /api/v1/clusters/:clusterID/helm/releases/:releaseName/rollback-rollbackKubernetesHelmRelease. Schemas:KubernetesHelmReleaseDetailEnvelope,KubernetesHelmReleaseRollbackInput.POST /api/v1/clusters/:clusterID/helm/releases/:releaseName/rollback/plan-planKubernetesHelmReleaseRollback. Schemas:KubernetesHelmReleaseRollbackInput,OperationalPlanEnvelope.PUT /api/v1/clusters/:clusterID/helm/releases/:releaseName/values-updateKubernetesHelmReleaseValues. Schemas:KubernetesHelmReleaseValuesEnvelope,KubernetesHelmReleaseValuesUpdateInput.GET /api/v1/clusters/:clusterID/infrastructure/nodes-listKubernetesNodes. Schemas:KubernetesNodeListEnvelope.DELETE /api/v1/clusters/:clusterID/infrastructure/nodes/:nodeName-deleteKubernetesNode.PUT /api/v1/clusters/:clusterID/infrastructure/nodes/:nodeName-updateKubernetesNode. Schemas:KubernetesNodeDetailEnvelope,KubernetesNodeUpdateInput.GET /api/v1/clusters/:clusterID/infrastructure/nodes/:nodeName/detail-getKubernetesNodeDetail. Schemas:KubernetesNodeDetailEnvelope.POST /api/v1/clusters/:clusterID/infrastructure/nodes/:nodeName/drain-drainKubernetesNode. Schemas:KubernetesNodeDrainInput.PUT /api/v1/clusters/:clusterID/infrastructure/nodes/:nodeName/schedulability-setKubernetesNodeSchedulability. Schemas:KubernetesNodeSchedulabilityInput.GET /api/v1/clusters/:clusterID/infrastructure/nodes/:nodeName/yaml-getKubernetesNodeYaml. Schemas:KubernetesResourceYamlEnvelope.PUT /api/v1/clusters/:clusterID/infrastructure/nodes/:nodeName/yaml-applyKubernetesNodeYaml. Schemas:KubernetesResourceYamlEnvelope,KubernetesResourceYamlInput.POST /api/v1/clusters/:clusterID/logs/query-queryClusterLogs. Schemas:LogPageEnvelope,LogQuery.POST /api/v1/clusters/:clusterID/logs/stream-ticket-issueClusterLogStreamTicket. Schemas:LogQuery,StreamTicketEnvelope.GET /api/v1/clusters/:clusterID/namespaces-listKubernetesNamespaces. Schemas:KubernetesNamespaceListEnvelope.POST /api/v1/clusters/:clusterID/namespaces-createKubernetesNamespace. Schemas:KubernetesNamespaceCreateInput,KubernetesNamespaceEnvelope.DELETE /api/v1/clusters/:clusterID/namespaces/:namespaceName-deleteKubernetesNamespace.PUT /api/v1/clusters/:clusterID/namespaces/:namespaceName-updateKubernetesNamespace. Schemas:KubernetesNamespaceEnvelope,KubernetesNamespaceInput.GET /api/v1/clusters/:clusterID/network/backendtlspolicies-listKubernetesBackendTLSPolicies. Schemas:KubernetesBackendTLSPolicyListEnvelope.DELETE /api/v1/clusters/:clusterID/network/backendtlspolicies/:name-deleteKubernetesBackendTLSPolicy.GET /api/v1/clusters/:clusterID/network/backendtlspolicies/:name/detail-getKubernetesBackendTLSPolicyDetail. Schemas:KubernetesBackendTLSPolicyDetailEnvelope.GET /api/v1/clusters/:clusterID/network/backendtlspolicies/:name/yaml-getKubernetesBackendTLSPolicyYaml. Schemas:KubernetesResourceYamlEnvelope.PUT /api/v1/clusters/:clusterID/network/backendtlspolicies/:name/yaml-applyKubernetesBackendTLSPolicyYaml. Schemas:KubernetesResourceYamlEnvelope,KubernetesResourceYamlInput.GET /api/v1/clusters/:clusterID/network/endpointslices-listKubernetesEndpointSlices. Schemas:KubernetesEndpointSliceListEnvelope.GET /api/v1/clusters/:clusterID/network/endpointslices/:name/detail-getKubernetesEndpointSliceDetail. Schemas:KubernetesEndpointSliceDetailEnvelope.GET /api/v1/clusters/:clusterID/network/gatewayclasses-listKubernetesGatewayClasses. Schemas:KubernetesGatewayClassListEnvelope.GET /api/v1/clusters/:clusterID/network/gatewayclasses/:name/detail-getKubernetesGatewayClassDetail. Schemas:KubernetesGatewayClassDetailEnvelope.GET /api/v1/clusters/:clusterID/network/gateways-listKubernetesGateways. Schemas:KubernetesGatewayListEnvelope.GET /api/v1/clusters/:clusterID/network/gateways/:name/detail-getKubernetesGatewayDetail. Schemas:KubernetesGatewayDetailEnvelope.GET /api/v1/clusters/:clusterID/network/grpcroutes-listKubernetesGRPCRoutes. Schemas:KubernetesGRPCRouteListEnvelope.DELETE /api/v1/clusters/:clusterID/network/grpcroutes/:name-deleteKubernetesGRPCRoute.GET /api/v1/clusters/:clusterID/network/grpcroutes/:name/detail-getKubernetesGRPCRouteDetail. Schemas:KubernetesGRPCRouteDetailEnvelope.GET /api/v1/clusters/:clusterID/network/grpcroutes/:name/yaml-getKubernetesGRPCRouteYaml. Schemas:KubernetesResourceYamlEnvelope.PUT /api/v1/clusters/:clusterID/network/grpcroutes/:name/yaml-applyKubernetesGRPCRouteYaml. Schemas:KubernetesResourceYamlEnvelope,KubernetesResourceYamlInput.GET /api/v1/clusters/:clusterID/network/httproutes-listKubernetesHTTPRoutes. Schemas:KubernetesHTTPRouteListEnvelope.DELETE /api/v1/clusters/:clusterID/network/httproutes/:name-deleteKubernetesHTTPRoute.GET /api/v1/clusters/:clusterID/network/httproutes/:name/detail-getKubernetesHTTPRouteDetail. Schemas:KubernetesHTTPRouteDetailEnvelope.GET /api/v1/clusters/:clusterID/network/httproutes/:name/yaml-getKubernetesHTTPRouteYaml. Schemas:KubernetesResourceYamlEnvelope.PUT /api/v1/clusters/:clusterID/network/httproutes/:name/yaml-applyKubernetesHTTPRouteYaml. Schemas:KubernetesResourceYamlEnvelope,KubernetesResourceYamlInput.GET /api/v1/clusters/:clusterID/network/ingressclasses-listKubernetesIngressClasses. Schemas:KubernetesIngressClassListEnvelope.GET /api/v1/clusters/:clusterID/network/ingressclasses/:name/detail-getKubernetesIngressClassDetail. Schemas:KubernetesIngressClassDetailEnvelope.GET /api/v1/clusters/:clusterID/network/ingresses-listKubernetesIngresses. Schemas:KubernetesIngressListEnvelope.GET /api/v1/clusters/:clusterID/network/ingresses/:name/detail-getKubernetesIngressDetail. Schemas:KubernetesIngressDetailEnvelope.PUT /api/v1/clusters/:clusterID/network/ingresses/:name/yaml-applyKubernetesIngressYaml. Schemas:KubernetesObservedResourceYamlInput,KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/network/networkpolicies-listKubernetesNetworkPolicies. Schemas:KubernetesNetworkPolicyListEnvelope.GET /api/v1/clusters/:clusterID/network/networkpolicies/:name/detail-getKubernetesNetworkPolicyDetail. Schemas:KubernetesNetworkPolicyDetailEnvelope.GET /api/v1/clusters/:clusterID/network/referencegrants-listKubernetesReferenceGrants. Schemas:KubernetesReferenceGrantListEnvelope.DELETE /api/v1/clusters/:clusterID/network/referencegrants/:name-deleteKubernetesReferenceGrant.GET /api/v1/clusters/:clusterID/network/referencegrants/:name/detail-getKubernetesReferenceGrantDetail. Schemas:KubernetesReferenceGrantDetailEnvelope.GET /api/v1/clusters/:clusterID/network/referencegrants/:name/yaml-getKubernetesReferenceGrantYaml. Schemas:KubernetesResourceYamlEnvelope.PUT /api/v1/clusters/:clusterID/network/referencegrants/:name/yaml-applyKubernetesReferenceGrantYaml. Schemas:KubernetesResourceYamlEnvelope,KubernetesResourceYamlInput.GET /api/v1/clusters/:clusterID/network/services-listKubernetesServices. Schemas:KubernetesServiceListEnvelope.GET /api/v1/clusters/:clusterID/network/services/:serviceName/detail-getKubernetesServiceDetail. Schemas:KubernetesServiceDetailEnvelope.GET /api/v1/clusters/:clusterID/network/services/:serviceName/metrics-getKubernetesServiceMetrics. Schemas:KubernetesResourceMetricsEnvelope.PUT /api/v1/clusters/:clusterID/network/services/:serviceName/yaml-applyKubernetesServiceYaml. Schemas:KubernetesObservedResourceYamlInput,KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/network/topology-getKubernetesNetworkTopology. Schemas:KubernetesNetworkTopologyEnvelope.POST /api/v1/clusters/:clusterID/resource-creation/execute-executeKubernetesResourceCreate. Schemas:KubernetesResourceCreateRequest,KubernetesResourceCreateResultEnvelope.POST /api/v1/clusters/:clusterID/resource-creation/preflight-preflightKubernetesResourceCreate. Schemas:KubernetesResourceCreateRequest,KubernetesResourcePreflightEnvelope.POST /api/v1/clusters/:clusterID/resource-creation/scope-decision-decideKubernetesResourceCreateScope. Schemas:KubernetesResourceCreateScopeDecisionEnvelope,KubernetesResourceCreateScopeDecisionRequest.POST /api/v1/clusters/:clusterID/resource-creation/workload-snapshot-generateKubernetesWorkloadSnapshot. Schemas:KubernetesWorkloadSnapshotEnvelope,KubernetesWorkloadSnapshotRequest.GET /api/v1/clusters/:clusterID/resource-monitoring-getKubernetesResourceMonitoring. Schemas:ResourceMonitoringEnvelope,ResourceMonitoringViewName.DELETE /api/v1/clusters/:clusterID/resources/:kind/:name/conditional-deleteKubernetesResourceConditional. Schemas:KubernetesResourceDeletionReceiptEnvelope.POST /api/v1/clusters/:clusterID/resources/:kind/:name/conditional/actions/:action-executeKubernetesWorkloadActionConditional. Schemas:KubernetesConditionalWorkloadActionInput,KubernetesConditionalWorkloadActionReceiptEnvelope.PUT /api/v1/clusters/:clusterID/resources/:kind/:name/conditional/yaml-applyKubernetesResourceYamlConditional. Schemas:KubernetesConditionalResourceYamlInput,KubernetesResourceYamlEnvelope.POST /api/v1/clusters/:clusterID/resources/:kind/:name/conditional/yaml/preflight-preflightKubernetesResourceYamlConditional. Schemas:KubernetesConditionalResourceYamlInput,OperationalPlanEnvelope.GET /api/v1/clusters/:clusterID/resources/:kind/:name/identity-getKubernetesResourceIdentity. Schemas:KubernetesResourceIdentityEnvelope.GET /api/v1/clusters/:clusterID/resources/graph-getKubernetesResourceGraph. Schemas:KubernetesResourceGraphEnvelope.GET /api/v1/clusters/:clusterID/resources/search-searchKubernetesResources. Schemas:KubernetesResourceSearchEnvelope.GET /api/v1/clusters/:clusterID/resources/stream-streamKubernetesResourceEvents.POST /api/v1/clusters/:clusterID/resources/update-plan-planKubernetesResourceUpdate. Schemas:KubernetesResourceUpdatePlanRequest,OperationalPlanEnvelope.GET /api/v1/clusters/:clusterID/security/posture-getKubernetesSecurityPosture. Schemas:KubernetesSecurityPostureEnvelope.GET /api/v1/clusters/:clusterID/storage/persistentvolumeclaims-listKubernetesPersistentVolumeClaims. Schemas:KubernetesPersistentVolumeClaimListEnvelope.GET /api/v1/clusters/:clusterID/storage/persistentvolumeclaims/:name/detail-getKubernetesPersistentVolumeClaimDetail. Schemas:KubernetesPersistentVolumeClaimDetailEnvelope.GET /api/v1/clusters/:clusterID/storage/persistentvolumes-listKubernetesPersistentVolumes. Schemas:KubernetesPersistentVolumeListEnvelope.GET /api/v1/clusters/:clusterID/storage/persistentvolumes/:name/detail-getKubernetesPersistentVolumeDetail. Schemas:KubernetesPersistentVolumeDetailEnvelope.GET /api/v1/clusters/:clusterID/storage/storageclasses-listKubernetesStorageClasses. Schemas:KubernetesStorageClassListEnvelope.GET /api/v1/clusters/:clusterID/storage/storageclasses/:name/detail-getKubernetesStorageClassDetail. Schemas:KubernetesStorageClassDetailEnvelope.GET /api/v1/clusters/:clusterID/workloads/cronjobs-listKubernetesCronJobs. Schemas:KubernetesCronJobListEnvelope.GET /api/v1/clusters/:clusterID/workloads/cronjobs/:cronJobName/detail-getKubernetesCronJobDetail. Schemas:KubernetesCronJobDetailEnvelope.POST /api/v1/clusters/:clusterID/workloads/cronjobs/:cronJobName/suspend-setKubernetesCronJobSuspend. Schemas:KubernetesCronJobDetailEnvelope,KubernetesCronJobSuspendInput.GET /api/v1/clusters/:clusterID/workloads/cronjobs/:cronJobName/yaml-getKubernetesCronJobYaml. Schemas:KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/workloads/daemonsets-listKubernetesDaemonSets. Schemas:KubernetesDaemonSetListEnvelope.GET /api/v1/clusters/:clusterID/workloads/daemonsets/:daemonSetName/detail-getKubernetesDaemonSetDetail. Schemas:KubernetesDaemonSetDetailEnvelope.GET /api/v1/clusters/:clusterID/workloads/daemonsets/:daemonSetName/metrics-getKubernetesDaemonSetMetrics. Schemas:KubernetesResourceMetricsEnvelope.GET /api/v1/clusters/:clusterID/workloads/daemonsets/:daemonSetName/rollouts-listKubernetesDaemonSetRollouts. Schemas:KubernetesDeploymentRolloutListEnvelope.GET /api/v1/clusters/:clusterID/workloads/daemonsets/:daemonSetName/rollouts/:revisionName/yaml-getKubernetesDaemonSetRevisionYaml. Schemas:KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/workloads/daemonsets/:daemonSetName/yaml-getKubernetesDaemonSetYaml. Schemas:KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/workloads/deployments-listKubernetesDeployments. Schemas:KubernetesDeploymentListEnvelope.DELETE /api/v1/clusters/:clusterID/workloads/deployments/:deploymentName-deleteKubernetesDeployment.GET /api/v1/clusters/:clusterID/workloads/deployments/:deploymentName/detail-getKubernetesDeploymentDetail. Schemas:KubernetesDeploymentDetailEnvelope.GET /api/v1/clusters/:clusterID/workloads/deployments/:deploymentName/metrics-getKubernetesDeploymentMetrics. Schemas:KubernetesResourceMetricsEnvelope.GET /api/v1/clusters/:clusterID/workloads/deployments/:deploymentName/rollout-status-getKubernetesDeploymentRolloutStatus. Schemas:KubernetesDeploymentRolloutStatusEnvelope.GET /api/v1/clusters/:clusterID/workloads/deployments/:deploymentName/rollouts-listKubernetesDeploymentRollouts. Schemas:KubernetesDeploymentRolloutListEnvelope.GET /api/v1/clusters/:clusterID/workloads/deployments/:deploymentName/yaml-getKubernetesDeploymentYaml. Schemas:KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/workloads/jobs-listKubernetesJobs. Schemas:KubernetesJobListEnvelope.GET /api/v1/clusters/:clusterID/workloads/jobs/:jobName/detail-getKubernetesJobDetail. Schemas:KubernetesJobDetailEnvelope.GET /api/v1/clusters/:clusterID/workloads/jobs/:jobName/metrics-getKubernetesJobMetrics. Schemas:KubernetesResourceMetricsEnvelope.GET /api/v1/clusters/:clusterID/workloads/jobs/:jobName/yaml-getKubernetesJobYaml. Schemas:KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/workloads/overview-getKubernetesWorkloadOverview. Schemas:KubernetesWorkloadOverviewEnvelope.GET /api/v1/clusters/:clusterID/workloads/pods-listKubernetesPods. Schemas:KubernetesPodListEnvelope.DELETE /api/v1/clusters/:clusterID/workloads/pods/:podName-deleteKubernetesPod.GET /api/v1/clusters/:clusterID/workloads/pods/:podName/detail-getKubernetesPodDetail. Schemas:KubernetesPodDetailEnvelope.GET /api/v1/clusters/:clusterID/workloads/pods/:podName/executions-getKubernetesPodExecutionByKey. Schemas:KubernetesPodExecutionReceiptEnvelope.POST /api/v1/clusters/:clusterID/workloads/pods/:podName/executions-executeKubernetesPodArgv. Schemas:KubernetesPodArgvInput,KubernetesPodExecutionReceiptEnvelope.GET /api/v1/clusters/:clusterID/workloads/pods/:podName/executions/:executionID-getKubernetesPodExecution. Schemas:KubernetesPodExecutionReceiptEnvelope.GET /api/v1/clusters/:clusterID/workloads/pods/:podName/logs-getKubernetesPodLogs. Schemas:ErrorEnvelope,KubernetesPodLogsEnvelope.GET /api/v1/clusters/:clusterID/workloads/pods/:podName/metrics-getClusterPodMetrics. Schemas:PodMetricsEnvelope.POST /api/v1/clusters/:clusterID/workloads/pods/:podName/terminal-sessions-createKubernetesPodTerminal. Schemas:KubernetesPodTerminalCreatedEnvelope,KubernetesPodTerminalInput.DELETE /api/v1/clusters/:clusterID/workloads/pods/:podName/terminal-sessions/:sessionID-closeKubernetesPodTerminal. Schemas:KubernetesPodTerminalSessionEnvelope.GET /api/v1/clusters/:clusterID/workloads/pods/:podName/terminal-sessions/:sessionID-getKubernetesPodTerminal. Schemas:KubernetesPodTerminalSessionEnvelope.GET /api/v1/clusters/:clusterID/workloads/pods/:podName/terminal-sessions/:sessionID/stream-streamKubernetesPodTerminal.GET /api/v1/clusters/:clusterID/workloads/pods/:podName/yaml-getKubernetesPodYaml. Schemas:KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/workloads/replicasets-listKubernetesReplicaSets. Schemas:KubernetesReplicaSetListEnvelope.GET /api/v1/clusters/:clusterID/workloads/replicasets/:replicaSetName/detail-getKubernetesReplicaSetDetail. Schemas:KubernetesReplicaSetDetailEnvelope.GET /api/v1/clusters/:clusterID/workloads/replicasets/:replicaSetName/metrics-getKubernetesReplicaSetMetrics. Schemas:KubernetesResourceMetricsEnvelope.GET /api/v1/clusters/:clusterID/workloads/replicasets/:replicaSetName/yaml-getKubernetesReplicaSetYaml. Schemas:KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/workloads/replicationcontrollers-listKubernetesReplicationControllers. Schemas:KubernetesReplicationControllerListEnvelope.DELETE /api/v1/clusters/:clusterID/workloads/replicationcontrollers/:name-deleteKubernetesReplicationController.GET /api/v1/clusters/:clusterID/workloads/replicationcontrollers/:name/detail-getKubernetesReplicationControllerDetail. Schemas:KubernetesReplicationControllerDetailEnvelope.GET /api/v1/clusters/:clusterID/workloads/replicationcontrollers/:name/metrics-getKubernetesReplicationControllerMetrics. Schemas:KubernetesResourceMetricsEnvelope.GET /api/v1/clusters/:clusterID/workloads/replicationcontrollers/:name/yaml-getKubernetesReplicationControllerYaml. Schemas:KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/workloads/statefulsets-listKubernetesStatefulSets. Schemas:KubernetesStatefulSetListEnvelope.GET /api/v1/clusters/:clusterID/workloads/statefulsets/:statefulSetName/detail-getKubernetesStatefulSetDetail. Schemas:KubernetesStatefulSetDetailEnvelope.GET /api/v1/clusters/:clusterID/workloads/statefulsets/:statefulSetName/metrics-getKubernetesStatefulSetMetrics. Schemas:KubernetesResourceMetricsEnvelope.GET /api/v1/clusters/:clusterID/workloads/statefulsets/:statefulSetName/rollouts-listKubernetesStatefulSetRollouts. Schemas:KubernetesDeploymentRolloutListEnvelope.GET /api/v1/clusters/:clusterID/workloads/statefulsets/:statefulSetName/rollouts/:revisionName/yaml-getKubernetesStatefulSetRevisionYaml. Schemas:KubernetesResourceYamlEnvelope.GET /api/v1/clusters/:clusterID/workloads/statefulsets/:statefulSetName/yaml-getKubernetesStatefulSetYaml. Schemas:KubernetesResourceYamlEnvelope.GET /api/v1/clusters/capabilities-listClusterCapabilityMatrix. Schemas:ClusterCapabilityMatrixEnvelope.- Status:
implemented - Permissions:
authenticated platform principal - Scopes: cluster runtime capability matrix; Direct and Agent connection mode support metadata; risk, approval, required scopes, and documentation links
- Audit: Returns platform capability metadata only; callers use it to explain Direct and Agent support, risk, approval requirements, required scopes, and documentation links without executing cluster operations.
- Examples: HTTP request
GET /api/v1/clusters/capabilities
- Status:
GET /api/v1/kubernetes/agent-installations/:installTicket/manifest.yaml-downloadKubernetesAgentInstallationManifest.
Plugins
DELETE /api/v1/plugins/:pluginID-removeInstalledPlugin. Schemas:OperationStatus.- Status:
implemented - Permissions:
plugin.manage - Scopes: installed plugin id; plugin-owned asset cleanup or detachment; preserved installation and audit history
- Audit: Removes an installed plugin record while preserving lifecycle audit evidence and ensuring plugin-owned assets are cleaned up or detached through controlled paths.
- Examples: HTTP request
DELETE /api/v1/plugins/:pluginID
- Status:
GET /api/v1/plugins/:pluginID-getInstalledPlugin. Schemas:InstalledPluginEnvelope.- Status:
implemented - Permissions:
plugin.view - Scopes: installed plugin id; installation status and enabled state; installed version and manifest snapshot metadata
- Audit: Reads an installed plugin record without returning secret values, mutable authorization grants, or marketplace credentials.
- Examples: HTTP request
GET /api/v1/plugins/:pluginID
- Status:
POST /api/v1/plugins/:pluginID/activate-activateInstalledPlugin. Schemas:CompanionActivationRequest,InstalledPluginEnvelope.GET /api/v1/plugins/:pluginID/assets/:assetPath-getInstalledPluginAsset.PUT /api/v1/plugins/:pluginID/config-configureInstalledPlugin. Schemas:InstalledPluginEnvelope,PluginConfigRequest.- Status:
implemented - Permissions:
plugin.configure_secrets - Scopes: installed plugin id; configuration fields and secret reference bindings; redacted config update summary
- Audit: Updates plugin configuration and secret references while redacting secret values from responses, logs, and audit records.
- Examples: HTTP request
PUT /api/v1/plugins/:pluginID/config
- Status:
POST /api/v1/plugins/:pluginID/disable-disableInstalledPlugin. Schemas:InstalledPluginEnvelope.- Status:
implemented - Permissions:
plugin.manage - Scopes: installed plugin id; disabled state transition; dependent assets and capability exposure
- Audit: Disables an installed plugin and records the state transition without deleting the manifest snapshot, lifecycle history, or required audit trail.
- Examples: HTTP request
POST /api/v1/plugins/:pluginID/disable
- Status:
POST /api/v1/plugins/:pluginID/enable-enableInstalledPlugin. Schemas:InstalledPluginEnvelope.- Status:
implemented - Permissions:
plugin.manage - Scopes: installed plugin id; enabled state transition; current compatibility, policy, and secret reference readiness
- Audit: Enables an installed plugin only after current policy and readiness checks; plugin-declared permissions remain subject to RBAC, grants, access policies, skill bindings, approvals, and scopes.
- Examples: HTTP request
POST /api/v1/plugins/:pluginID/enable
- Status:
GET /api/v1/plugins/:pluginID/manifest-getInstalledPluginManifest. Schemas:PluginManifestEnvelope.- Status:
implemented - Permissions:
plugin.view - Scopes: installed plugin id; snapshotted plugin manifest; requested permissions, capability refs, and secret requirements
- Audit: Reads the installed manifest snapshot used for review, drift checks, and upgrade decisions without re-fetching mutable marketplace content as source of truth.
- Examples: HTTP request
GET /api/v1/plugins/:pluginID/manifest
- Status:
POST /api/v1/plugins/:pluginID/rollback-rollbackInstalledPlugin. Schemas:CompanionRollbackRequest,InstalledPluginEnvelope.POST /api/v1/plugins/:pluginID/upgrade-upgradeInstalledPlugin. Schemas:InstalledPluginEnvelope,PluginInstallRequest.- Status:
implemented - Permissions:
plugin.manage,approval where required by new permissions or risk - Scopes: installed plugin id; target marketplace version or default latest compatible version; refreshed manifest snapshot, checksum or signature status, and compatibility metadata
- Audit: Upgrades an installed plugin by taking a fresh target-version manifest snapshot and recording changed permissions, secret requirements, compatibility, and risk review outcome.
- Examples: HTTP request
POST /api/v1/plugins/:pluginID/upgrade
- Status:
POST /api/v1/plugins/install-installPlugin. Schemas:InstalledPluginEnvelope,PluginInstallRequest.- Status:
implemented - Permissions:
plugin.install,approval where required by requested permissions or risk - Scopes: marketplace plugin id and version; manifest snapshot; requested permissions, secret requirements, and compatibility metadata
- Audit: Installs a plugin by snapshotting its manifest, source metadata, checksum or signature status, requested permissions, and risk review outcome; installation does not grant the requested permissions by itself.
- Examples: HTTP request
POST /api/v1/plugins/install
- Status:
GET /api/v1/plugins/installed-listInstalledPlugins. Schemas:InstalledPluginListEnvelope.- Status:
implemented - Permissions:
plugin.view - Scopes: installed plugin inventory; workspace or control-plane plugin visibility; enabled, disabled, and configuration state
- Audit: Returns installed plugin records and status summaries without exposing secret values referenced by plugin configuration.
- Examples: HTTP request
GET /api/v1/plugins/installed
- Status:
GET /api/v1/plugins/marketplace-listMarketplacePlugins. Schemas:MarketplacePluginListEnvelope.- Status:
implemented - Permissions:
plugin.view - Scopes: marketplace catalog visibility; optional query, type, and publisher filters; current principal plugin discovery permissions
- Audit: Returns marketplace plugin metadata visible to the caller without installing assets, granting permissions, or exposing marketplace credentials.
- Examples: HTTP request
GET /api/v1/plugins/marketplace?type=connector
- Status:
GET /api/v1/plugins/marketplace/:pluginID-getMarketplacePlugin. Schemas:MarketplacePluginEnvelope.- Status:
implemented - Permissions:
plugin.view - Scopes: marketplace plugin id; publisher and version metadata; requested permissions and secret requirements preview
- Audit: Reads marketplace plugin detail for review before installation; requested permissions and secret requirements are descriptive and do not grant access.
- Examples: HTTP request
GET /api/v1/plugins/marketplace/:pluginID
- Status:
Portal
GET /api/v1/portal/applications-listPortalApplications. Schemas:PortalApplicationListEnvelope.GET /api/v1/portal/applications/:applicationID-getPortalApplication. Schemas:IdentityApplicationEnvelope.DELETE /api/v1/portal/applications/:applicationID/favorite-unfavoritePortalApplication.POST /api/v1/portal/applications/:applicationID/favorite-favoritePortalApplication. Schemas:IdentityApplicationEnvelope.POST /api/v1/portal/applications/:applicationID/launch-launchPortalApplication. Schemas:PortalLaunchDecisionEnvelope,PortalLaunchRequest.GET /api/v1/portal/bootstrap-getPortalBootstrap. Schemas:PortalBootstrapEnvelope.GET /api/v1/portal/recent-listPortalRecentLaunches. Schemas:IdentityApplicationLaunchListEnvelope.GET /api/v1/portal/security-getPortalSecuritySummary. Schemas:PortalSecuritySummaryEnvelope.
Runner
POST /api/v1/copilot/agent-runs/callback-recordAgentRunCallback. Schemas:AgentRunCallbackRequest,AgentRunEnvelope.- Status:
implemented - Permissions:
runtime execution runner token,AgentRun callback token - Scopes: AgentRun id and callback token; running, completed, failed, canceled, or timeout status; analysis artifacts, tool executions, usage, and data-source snapshots
- Audit: Records Agent Runtime callbacks, heartbeats, provider usage, tool execution summaries, and normalized AnalysisArtifact output while redacting provider secrets and raw credential material.
- Examples: HTTP request
POST /api/v1/copilot/agent-runs/callback
- Status:
POST /api/v1/copilot/agent-runs/claim-claimAgentRun. Schemas:AgentRunClaimRequest,AgentRunEnvelope.- Status:
implemented - Permissions:
runtime execution runner token,ai.gateway.invoke or observe.ai.chat when using service-account tokens - Scopes: Agent Runtime provider id or provider kind; runner worker id; queued AgentRun records matching the provider
- Audit: Claims an AgentRun for an authorized provider runner and returns the run contract, toolBindings, skillBindings, scope, and task-scoped callback token needed for controlled execution.
- Examples: HTTP request
POST /api/v1/copilot/agent-runs/claim
- Status:
POST /api/v1/copilot/agent-runs/tool-call-recordAgentRunToolCall. Schemas:AgentRunToolCallRequest,AgentToolCallResultEnvelope.- Status:
implemented - Permissions:
runtime execution runner token,AgentRun callback token,read-only tool binding captured on the AgentRun - Scopes: AgentRun id and callback token; toolBindings snapshot; read-only tool input, scope, and result redaction policy
- Audit: Executes only read-only tools from the AgentRun toolBindings snapshot, records each ToolExecution, and prevents external providers from bypassing Soha data-source credentials, resource scopes, or Gateway redaction.
- Examples: Request fixture
../soha/contracts/examples/openapi/agent-run-tool-call-request.json; Response fixture../soha/contracts/examples/openapi/agent-tool-call-result-envelope.json
- Status:
POST /api/v1/delivery/execution-callbacks-recordExecutionCallback. Schemas:ExecutionCallbackRequest,ExecutionTaskEnvelope.- Status:
implemented - Permissions:
valid execution task callback token - Scopes: task-scoped callback token; execution status and heartbeat; logs, artifacts, and build or deploy backfill metadata
- Audit: Persists delivery execution callbacks, updates task state, and backfills related build, deploy, release-bundle, log, and artifact records while rejecting stale task-scoped callback ownership.
- Examples: HTTP request
POST /api/v1/delivery/execution-callbacks
- Status:
GET /api/v1/delivery/execution-tasks/:taskID/runner-status-getExecutionTaskRunnerStatus. Schemas:ExecutionTaskEnvelope.- Status:
implemented - Permissions:
runtime execution runner token,delivery.execution-tasks.claim when using service-account tokens - Scopes: execution task id; runner-visible task state; cancellation, timeout, and terminal status polling
- Audit: Returns runner-visible task state so long-running agents can observe cancellation or timeout decisions without mutating the task.
- Examples: HTTP request
GET /api/v1/delivery/execution-tasks/:taskID/runner-status
- Status:
POST /api/v1/delivery/execution-tasks/claim-claimExecutionTask. Schemas:ExecutionTaskClaimRequest,ExecutionTaskEnvelope.- Status:
implemented - Permissions:
runtime execution runner token,delivery.execution-tasks.claim when using service-account tokens - Scopes: runner providerKinds; agentID and optional runtimeEndpoint; queued delivery execution tasks visible to the runner
- Audit: Claims one delivery execution task for an authorized runner and records runner identity, provider kind, runtime endpoint, and heartbeat context without granting access outside the task boundary.
- Examples: HTTP request
POST /api/v1/delivery/execution-tasks/claim
- Status:
POST /api/v1/docker/agent-installations/:operationID/enroll-exchangeDockerHostAgentEnrollment. Schemas:DockerHostAgentCredentialsEnvelope,DockerHostAgentEnrollmentRequest.POST /api/v1/docker/operation-callbacks-recordDockerOperationCallback. Schemas:DockerOperationCallbackRequest,DockerOperationEnvelope.- Status:
implemented - Permissions:
runtime execution runner token,operation-scoped callback token - Scopes: Docker operation id; operation-scoped callback token; status, logs, runtime service state, and output metadata
- Audit: Records Docker runner callbacks and normalizes status, logs, service state, and failure evidence without allowing the runner token to expand Docker operation scope.
- Examples: HTTP request
POST /api/v1/docker/operation-callbacks
- Status:
GET /api/v1/docker/operations/:operationID/runner-status-getDockerOperationRunnerStatus. Schemas:DockerOperationEnvelope.- Status:
implemented - Permissions:
runtime execution runner token,docker.operations.claim when using service-account tokens - Scopes: Docker operation id; runner-visible operation state; cancellation, timeout, and terminal status polling
- Audit: Returns runner-visible Docker operation state so agents can stop local Docker or Compose work when the control plane has already reached a terminal state.
- Examples: HTTP request
GET /api/v1/docker/operations/:operationID/runner-status
- Status:
POST /api/v1/docker/operations/claim-claimDockerOperation. Schemas:DockerOperationClaimRequest,DockerOperationEnvelope.- Status:
implemented - Permissions:
runtime execution runner token,docker.operations.claim when using service-account tokens - Scopes: Docker runner operation kinds; worker id and runtime endpoint; queued Docker operations visible to the runner
- Audit: Claims one Docker operation for an authorized runner so Docker Engine or Compose work stays outside API handlers and returns only the operation payload needed by that runner.
- Examples: HTTP request
POST /api/v1/docker/operations/claim
- Status:
POST /api/v1/runner/secret-leases/:secretLeaseID/redeem-redeemSecretLease. Schemas:SecretLeaseRedemptionEnvelope.POST /api/v1/runtime/agent-tools-callAgentRunnerTool. Schemas:AgentRunnerToolCallRequest,AgentToolCallResultEnvelope.
Secrets
GET /api/v1/secrets-listSecrets. Schemas:SecretMetadataListEnvelope,SecretScopeType.POST /api/v1/secrets-createSecret. Schemas:SecretCreateRequest,SecretMetadataEnvelope.DELETE /api/v1/secrets/:secretID-disableSecret. Schemas:SecretMetadataEnvelope.GET /api/v1/secrets/:secretID-getSecret. Schemas:SecretMetadataEnvelope.PATCH /api/v1/secrets/:secretID-updateSecret. Schemas:SecretMetadataEnvelope,SecretUpdateRequest.GET /api/v1/secrets/:secretID/references-listSecretReferences. Schemas:SecretReferenceUsageListEnvelope.GET /api/v1/secrets/:secretID/versions-listSecretVersions. Schemas:SecretVersionMetadataListEnvelope.POST /api/v1/secrets/:secretID/versions-rotateSecret. Schemas:SecretRotateRequest,SecretVersionMetadataEnvelope.POST /api/v1/secrets/:secretID/versions/:version/revoke-revokeSecretVersion. Schemas:SecretVersionMetadataEnvelope.POST /api/v1/secrets/generate-ssh-key-generateSecretSSHKey. Schemas:SecretGenerateSSHKeyRequest,SecretMetadataEnvelope.
Settings
GET /api/v1/settings/ai-getAISettings. Schemas:AISettingsEnvelope.GET /api/v1/settings/ai/skills-getAISkillsRegistry. Schemas:AISkillsSettingsEnvelope.PUT /api/v1/settings/ai/skills-updateAISkillsRegistry. Schemas:AISettingsEnvelope,UpdateAISkillsRequest.PUT /api/v1/settings/ai/workbench-model-updateAIWorkbenchModelSettings. Schemas:AISettingsEnvelope,UpdateAIWorkbenchModelRequest.GET /api/v1/settings/ai/workbench-runtime-assets-listWorkbenchRuntimeAssets. Schemas:WorkbenchManagedRuntimeAssetListEnvelope.PUT /api/v1/settings/ai/workbench-runtime-assets/:kind/:assetId/:version-setWorkbenchRuntimeAssetEnabled. Schemas:WorkbenchManagedRuntimeAssetEnvelope,WorkbenchRuntimeAssetEnablement,WorkbenchRuntimeProfileID.POST /api/v1/settings/ai/workbench-runtime-assets/mcp/:assetId/:version/probe-probeWorkbenchRuntimeMCP. Schemas:WorkbenchRuntimeMCPProbeEnvelope,WorkbenchRuntimeMCPProbeRequest,WorkbenchRuntimeProfileID.GET /api/v1/settings/ai/workbench-runtime-profiles/:profileId-listWorkbenchRuntimeProfileRevisions. Schemas:WorkbenchRuntimeProfileListEnvelope.PUT /api/v1/settings/ai/workbench-runtime-profiles/:profileId-publishWorkbenchRuntimeProfile. Schemas:WorkbenchRuntimeProfileEnvelope,WorkbenchRuntimeProfileUpdate.GET /api/v1/settings/branding-getBrandingSettings. Schemas:BrandingSettingsEnvelope.PUT /api/v1/settings/branding-updateBrandingSettings. Schemas:BrandingSettingsEnvelope,UpdateBrandingSettingsRequest.POST /api/v1/settings/branding/upload-uploadBrandingAsset. Schemas:BrandingAssetUploadEnvelope,UploadBrandingAssetRequest.GET /api/v1/settings/identity-getIdentitySettings. Schemas:IdentitySettingsEnvelope.PUT /api/v1/settings/identity/providers-updateLoginProvidersSettings. Schemas:IdentitySettingsEnvelope,UpdateLoginProvidersSettingsRequest.GET /api/v1/settings/runtime-config-getRuntimeConfig. Schemas:RuntimeConfigSnapshotEnvelope.GET /api/v1/settings/runtime-config/applications/:runtimeConfigApplicationID-getRuntimeConfigApplication. Schemas:RuntimeConfigApplicationEnvelope.POST /api/v1/settings/runtime-config/apply-applyRuntimeConfig. Schemas:RuntimeConfigApplyResultEnvelope,RuntimeConfigChangeRequest.GET /api/v1/settings/runtime-config/history-listRuntimeConfigHistory. Schemas:RuntimeConfigRevisionListEnvelope.GET /api/v1/settings/runtime-config/resources-getRuntimeResourceSnapshot. Schemas:RuntimeResourceSnapshotEnvelope.POST /api/v1/settings/runtime-config/rollback-rollbackRuntimeConfig. Schemas:RuntimeConfigApplyResultEnvelope,RuntimeConfigRollbackRequest.POST /api/v1/settings/runtime-config/validate-validateRuntimeConfig. Schemas:RuntimeConfigChangeRequest,RuntimeConfigValidationEnvelope.
Software
GET /api/v1/software/packages-listSoftwarePackages. Schemas:SoftwarePackageListEnvelope.POST /api/v1/software/packages-uploadSoftwarePackage. Schemas:SoftwarePackageEnvelope,SoftwarePackageUploadRequest.DELETE /api/v1/software/packages/:packageID-deleteSoftwarePackage.GET /api/v1/software/packages/:packageID/download-downloadSoftwarePackage.GET /api/v1/software/packages/:packageID/download-records-listSoftwarePackageDownloadRecords. Schemas:SoftwarePackageDownloadRecordListEnvelope.POST /api/v1/software/packages/import-importSoftwarePackage. Schemas:SoftwarePackageEnvelope,SoftwarePackageURLImportRequest.GET /api/v1/software/storage-getSoftwareStorage. Schemas:SoftwareStorageEnvelope.
Source Control
GET /api/v1/source-connections-listSourceConnections. Schemas:SourceConnectionListEnvelope.GET /api/v1/source-connections/:sourceConnectionID-getSourceConnection. Schemas:SourceConnectionEnvelope.GET /api/v1/source-connections/:sourceConnectionID/repositories-listSourceRepositories. Schemas:SourceRepositoryListEnvelope.GET /api/v1/source-connections/:sourceConnectionID/repositories/:repositoryID/branches-listSourceRepositoryBranches. Schemas:SourceBranchListEnvelope.GET /api/v1/source-connections/:sourceConnectionID/repositories/:repositoryID/files-getSourceRepositoryFile. Schemas:SourceFileEnvelope.GET /api/v1/source-connections/:sourceConnectionID/repositories/:repositoryID/tags-listSourceRepositoryTags. Schemas:SourceTagListEnvelope.
System
GET /api/v1/announcements/:announcementID/receipts-listAnnouncementReceipts. Schemas:AnnouncementReceiptPageEnvelope,AnnouncementReceiptState.GET /api/v1/healthz-getHealthz. Schemas:GenericObject.- Status:
implemented - Permissions:
public health probe - Scopes: process liveness; no workspace, cluster, or user scope
- Audit: Liveness probing is intentionally lightweight and does not emit per-request audit records; production exposure is controlled by deployment routing.
- Examples: HTTP request
GET /api/v1/healthz
- Status:
GET /api/v1/menus-listMenus. Schemas:MenuListEnvelope.POST /api/v1/menus-createMenu. Schemas:MenuEnvelope,MenuInput.DELETE /api/v1/menus/:menuID-deleteMenu. Schemas:MenuDeleteResult.GET /api/v1/menus/:menuID-getMenu. Schemas:MenuEnvelope.PUT /api/v1/menus/:menuID-updateMenu. Schemas:MenuEnvelope,MenuInput.GET /api/v1/menus/visible-listVisibleMenus. Schemas:MenuListEnvelope.GET /api/v1/readyz-getReadyz. Schemas:GenericObject.- Status:
implemented - Permissions:
public readiness probe - Scopes: service readiness; dependency readiness summary; no workspace, cluster, or user scope
- Audit: Readiness probing returns operational state for orchestrators and release gates without exposing secrets or emitting per-request audit records.
- Examples: HTTP request
GET /api/v1/readyz
- Status:
System Integrations
GET /api/v1/system-integrations-listSystemIntegrations. Schemas:SystemIntegrationCategory,SystemIntegrationListEnvelope.POST /api/v1/system-integrations-createSystemIntegration. Schemas:SystemIntegrationCreateRequest,SystemIntegrationEnvelope.DELETE /api/v1/system-integrations/:integrationID-deleteSystemIntegration.GET /api/v1/system-integrations/:integrationID-getSystemIntegration. Schemas:SystemIntegrationEnvelope.PATCH /api/v1/system-integrations/:integrationID-updateSystemIntegration. Schemas:SystemIntegrationEnvelope,SystemIntegrationUpdateRequest.POST /api/v1/system-integrations/:integrationID/oauth/authorize-authorizeSystemIntegrationOAuth. Schemas:SystemIntegrationOAuthAuthorizationEnvelope.POST /api/v1/system-integrations/:integrationID/test-testSystemIntegration. Schemas:SystemIntegrationTestResultEnvelope.GET /api/v1/system-integrations/oauth/gitlab/callback-completeGitLabSystemIntegrationOAuth.
Virtualization
POST /api/v1/virtualization/capacity/check-checkVirtualizationCapacity. Schemas:VirtualizationCapacityEnvelope,VirtualizationCapacityInput.GET /api/v1/virtualization/clusters-listVirtualizationClusters. Schemas:VirtualizationConnectionListEnvelope.POST /api/v1/virtualization/clusters-createVirtualizationCluster. Schemas:VirtualizationConnectionEnvelope,VirtualizationConnectionInput.DELETE /api/v1/virtualization/clusters/:connectionID-deleteVirtualizationCluster. Schemas:OperationStatus.PUT /api/v1/virtualization/clusters/:connectionID-updateVirtualizationCluster. Schemas:VirtualizationConnectionEnvelope,VirtualizationConnectionInput.GET /api/v1/virtualization/clusters/:connectionID/capacity-policy-getVirtualizationCapacityPolicy. Schemas:VirtualizationCapacityPolicyEnvelope.PUT /api/v1/virtualization/clusters/:connectionID/capacity-policy-updateVirtualizationCapacityPolicy. Schemas:VirtualizationCapacityPolicyEnvelope,VirtualizationCapacityPolicyInput.GET /api/v1/virtualization/clusters/:connectionID/delete-dependencies-getVirtualizationClusterDeleteDependencies. Schemas:VirtualizationConnectionDeleteDependenciesEnvelope.POST /api/v1/virtualization/clusters/:connectionID/sync-syncVirtualizationCluster. Schemas:VirtualizationOperationEnvelope.POST /api/v1/virtualization/clusters/:connectionID/test-testVirtualizationCluster. Schemas:ConnectionCheckResultEnvelope,VirtualizationOperationEnvelope.GET /api/v1/virtualization/flavors-listVirtualizationFlavors. Schemas:VirtualizationFlavorListEnvelope,VirtualizationFlavorPageEnvelope.POST /api/v1/virtualization/flavors-createVirtualizationFlavor. Schemas:VirtualizationFlavorEnvelope,VirtualizationFlavorInput.DELETE /api/v1/virtualization/flavors/:flavorID-deleteVirtualizationFlavor. Schemas:OperationStatus.PUT /api/v1/virtualization/flavors/:flavorID-updateVirtualizationFlavor. Schemas:VirtualizationFlavorEnvelope,VirtualizationFlavorInput.GET /api/v1/virtualization/images-listVirtualizationImages. Schemas:VirtualizationImageListEnvelope,VirtualizationImagePageEnvelope.POST /api/v1/virtualization/images-createVirtualizationImage. Schemas:VirtualizationImageEnvelope,VirtualizationImageInput.DELETE /api/v1/virtualization/images/:imageID-deleteVirtualizationImage. Schemas:OperationStatus.PUT /api/v1/virtualization/images/:imageID-updateVirtualizationImage. Schemas:VirtualizationImageEnvelope,VirtualizationImageInput.GET /api/v1/virtualization/operations-listVirtualizationOperations. Schemas:VirtualizationOperationListEnvelope,VirtualizationOperationPageEnvelope.GET /api/v1/virtualization/operations/:taskID-getVirtualizationOperation. Schemas:VirtualizationOperationEnvelope.POST /api/v1/virtualization/operations/:taskID/cancel-cancelVirtualizationOperation. Schemas:VirtualizationOperationEnvelope.GET /api/v1/virtualization/operations/:taskID/logs-listVirtualizationOperationLogs. Schemas:VirtualizationOperationLogListEnvelope.POST /api/v1/virtualization/operations/:taskID/retry-retryVirtualizationOperation. Schemas:VirtualizationOperationEnvelope.GET /api/v1/virtualization/operations/:taskID/stream-streamVirtualizationOperation.GET /api/v1/virtualization/operations/:taskID/worker-readiness-assessVirtualizationWorkerReadiness. Schemas:CapabilityAssessmentEnvelope.DELETE /api/v1/virtualization/ssh-commands/:commandID-cancelVMSSHCommand. Schemas:VirtualMachineSSHCommandEnvelope.GET /api/v1/virtualization/ssh-commands/:commandID-getVMSSHCommand. Schemas:VirtualMachineSSHCommandEnvelope.DELETE /api/v1/virtualization/ssh-sessions/:sessionID-closeVirtualMachineSSHSession. Schemas:VirtualMachineSSHSessionEnvelope.GET /api/v1/virtualization/ssh-sessions/:sessionID-getVirtualMachineSSHSession. Schemas:VirtualMachineSSHSessionEnvelope.POST /api/v1/virtualization/ssh-sessions/:sessionID/credentials-redeemVMSSHCredentials. Schemas:SecretLeaseRedemptionEnvelope,VMSSHCredentialRedemptionInput.GET /api/v1/virtualization/ssh-sessions/:sessionID/stream-streamVirtualMachineSSHSession. Schemas:VirtualMachineSSHFrame.POST /api/v1/virtualization/sync-syncAllVirtualizationClusters. Schemas:VirtualizationOperationEnvelope.GET /api/v1/virtualization/vms-listVirtualMachines. Schemas:VirtualMachineListEnvelope,VirtualMachinePageEnvelope.POST /api/v1/virtualization/vms-createVirtualMachine. Schemas:VirtualMachineCreateInput,VirtualizationOperationEnvelope.GET /api/v1/virtualization/vms/:vmID-getVirtualMachine. Schemas:VirtualMachineEnvelope.GET /api/v1/virtualization/vms/:vmID/access-binding-getVirtualMachineAccessBinding. Schemas:VirtualMachineAccessBindingEnvelope.PUT /api/v1/virtualization/vms/:vmID/access-binding-updateVirtualMachineAccessBinding. Schemas:VirtualMachineAccessBindingEnvelope,VirtualMachineAccessBindingInput.POST /api/v1/virtualization/vms/:vmID/actions-performVirtualMachineAction. Schemas:VirtualMachineActionInput,VirtualizationOperationEnvelope.GET /api/v1/virtualization/vms/:vmID/console-getVirtualMachineConsole. Schemas:VirtualMachineConsoleEnvelope.GET /api/v1/virtualization/vms/:vmID/console/novnc-streamVirtualMachineConsoleNoVNC.GET /api/v1/virtualization/vms/:vmID/console/vnc-streamVirtualMachineConsoleVNC.GET /api/v1/virtualization/vms/:vmID/detail-getVirtualMachineDetail. Schemas:VirtualMachineDetailEnvelope.GET /api/v1/virtualization/vms/:vmID/devices-listVirtualMachineDevices. Schemas:VirtualMachineDeviceListEnvelope.GET /api/v1/virtualization/vms/:vmID/metrics-getVirtualMachineMetrics. Schemas:VirtualMachineMetricsEnvelope.POST /api/v1/virtualization/vms/:vmID/power-powerVirtualMachine. Schemas:VirtualMachinePowerInput,VirtualizationOperationEnvelope.POST /api/v1/virtualization/vms/:vmID/ssh-commands-createVirtualMachineSSHCommand. Schemas:VirtualMachineSSHCommandEnvelope,VirtualMachineSSHCommandInput.POST /api/v1/virtualization/vms/:vmID/ssh-sessions-createVirtualMachineSSHSession. Schemas:VirtualMachineSSHSessionEnvelope,VirtualMachineSSHSessionInput.POST /api/v1/virtualization/vms/plan-planVirtualMachineCreate. Schemas:OperationalPlanEnvelope,VirtualMachineCreateInput.GET /api/v1/virtualization/worker-pools-listVirtualizationWorkerPools. Schemas:VirtualizationWorkerPoolListEnvelope.DELETE /api/v1/virtualization/worker-pools/:id-deleteVirtualizationWorkerPool.GET /api/v1/virtualization/worker-pools/:id-getVirtualizationWorkerPool. Schemas:VirtualizationWorkerPoolEnvelope.PUT /api/v1/virtualization/worker-pools/:id-saveVirtualizationWorkerPool. Schemas:VirtualizationWorkerPoolEnvelope,VirtualizationWorkerPoolInput.POST /api/v1/virtualization/worker-pools/:id/nodes-createVirtualizationWorker. Schemas:VirtualizationOperationEnvelope,VirtualizationWorkerCreateInput.
JSON Schema Artifacts
agent/agent-checkpoint.schema.json- Agent Checkpoint.- ID:
https://opensoha.dev/schemas/agent-checkpoint.schema.json - Required:
schemaVersion,id,runId,stepId,attempt,sequence,stateHash,contextRef,createdAt
- ID:
agent/agent-observation.schema.json- Agent Observation.- ID:
https://opensoha.dev/schemas/agent-observation.schema.json - Required:
schemaVersion,id,runId,stepId,kind,status,summary,redacted,observedAt
- ID:
agent/agent-protocol.schema.json- Soha Agent Protocol.- ID:
https://contracts.opensoha.dev/agent/agent-protocol.schema.json
- ID:
agent/agent-provider-definition.schema.json- Agent Provider Definition.- ID:
https://opensoha.dev/schemas/agent-provider-definition.schema.json - Required:
schemaVersion,id,kind,providerVersion,adapterProtocol,runtime,capabilities
- ID:
agent/agent-provider-registry.schema.json- Agent Provider Registry Snapshot.- ID:
https://opensoha.dev/schemas/agent-provider-registry.schema.json - Required:
schemaVersion,revision,digest,issuedAt,providers
- ID:
agent/agent-provider-runtime-event.schema.json- Agent Provider Runtime Event.- ID:
https://opensoha.dev/schemas/agent-provider-runtime-event.schema.json - Required:
schemaVersion,eventType,runnerId,revision,observedAt
- ID:
agent/agent-run-step.schema.json- Agent Run Step.- ID:
https://opensoha.dev/schemas/agent-run-step.schema.json - Required:
schemaVersion,id,runId,sequence,attempt,state,contextRef,startedAt
- ID:
agent/conformance-run.schema.json- Agent Provider Conformance Run.- ID:
https://opensoha.dev/schemas/agent/conformance-run.schema.json - Required:
schemaVersion,id,providerRef,environmentRef,suiteVersion,status,results,startedAt
- ID:
agent/dsh-runtime.schema.json- dsh-runtime.- ID:
https://opensoha.dev/schemas/dsh-runtime.schema.json
- ID:
agent/environment-lease.schema.json- Agent Environment Lease.- ID:
https://opensoha.dev/schemas/environment-lease.schema.json - Required:
schemaVersion,id,runId,ownerId,scopeHash,mode,quota,issuedAt,expiresAt
- ID:
agent/environment-snapshot.schema.json- Agent Environment Snapshot.- ID:
https://opensoha.dev/schemas/environment-snapshot.schema.json - Required:
schemaVersion,leaseId,runId,state,resourceUsage,observedAt
- ID:
agent/environment-template.schema.json- Agent Environment Template.- ID:
https://opensoha.dev/schemas/agent/environment-template.schema.json - Required:
schemaVersion,id,version,backend,isolationMode,quota,ttlSeconds,enabled
- ID:
agent/fleet-target.schema.json- Agent Fleet Target.- ID:
https://opensoha.dev/schemas/agent/fleet-target.schema.json - Required:
schemaVersion
- ID:
agent/multi-agent-plan.schema.json- Bounded Multi-Agent Plan.- ID:
https://opensoha.dev/schemas/agent/multi-agent-plan.schema.json - Required:
schemaVersion,id,coordinatorRef,subtasks,sharedBudget,status,createdAt
- ID:
agent/personal-browser-network-request.schema.json- agent/personal-browser-network-request.schema.json.- ID:
https://opensoha.dev/schemas/personal-browser-network-request.schema.json - Required:
url,method
- ID:
agent/personal-browser-network-response.schema.json- agent/personal-browser-network-response.schema.json.- ID:
https://opensoha.dev/schemas/personal-browser-network-response.schema.json - Required:
status,headers,bodyBase64
- ID:
agent/personal-environment-preflight-request.schema.json- Personal Docker Node Preflight Request.- ID:
https://opensoha.dev/schemas/personal-environment-preflight-request.schema.json - Required:
schemaVersion,id,quota
- ID:
agent/personal-environment-preflight-result.schema.json- Personal Docker Node Preflight Result.- ID:
https://opensoha.dev/schemas/personal-environment-preflight-result.schema.json - Required:
schemaVersion,id,quota,ready,cgroupVersion,diskMechanism,observedAt
- ID:
agent/personal-environment-request.schema.json- Personal Environment Agent Request.- ID:
https://opensoha.dev/schemas/personal-environment-request.schema.json - Required:
schemaVersion,action,lease
- ID:
agent/personal-environment-result.schema.json- Personal Environment Agent Result.- ID:
https://opensoha.dev/schemas/personal-environment-result.schema.json - Required:
schemaVersion,leaseId,runId,state,observedAt
- ID:
agent/personal-guest-binding.schema.json- Personal VM Guest Frozen Binding.- ID:
https://opensoha.dev/schemas/personal-guest-binding.schema.json - Required:
schemaVersion,id,version,assistantId,ownerId,provider,computeRef,computeGeneration,providerIdentityHash,dataRef,dataDiskSerial,dataDiskBytes,policyRevision,issuedAt,expiresAt
- ID:
agent/personal-guest-data-plan.schema.json- Personal Guest Data Operation.- ID:
https://opensoha.dev/schemas/personal-guest-data-plan.schema.json - Required:
schemaVersion,operationId,binding,diskQuotaBytes
- ID:
agent/personal-guest-enrollment.schema.json- Personal VM Guest Enrollment.- ID:
https://opensoha.dev/schemas/personal-guest-enrollment.schema.json - Required:
schemaVersion,enrollmentId
- ID:
agent/personal-guest-heartbeat.schema.json- Personal VM Guest Heartbeat.- ID:
https://opensoha.dev/schemas/personal-guest-heartbeat.schema.json - Required:
schemaVersion,bindingId,bindingVersion,computeGeneration,sequence,observedAt
- ID:
agent/personal-guest-provisioning.schema.json- Fixed Personal Guest Provisioning.- ID:
https://opensoha.dev/schemas/personal-guest-provisioning.schema.json - Required:
plan,endpoint,enrollmentId,challenge,certificatePEM,clientCAPEM,artifactSHA256,cpuQuotaMilli,memoryBytes,pidsLimit,network
- ID:
agent/personal-guest-renewal.schema.json- Personal Guest Certificate Renewal.- ID:
https://opensoha.dev/schemas/personal-guest-renewal.schema.json - Required:
schemaVersion,requestId,bindingVersion,csrPEM
- ID:
agent/personal-guest-runtime-result.schema.json- personal-guest-runtime-result.- ID:
https://opensoha.dev/schemas/personal-guest-runtime-result.schema.json - Required:
schemaVersion,operationId,bindingId,environment
- ID:
agent/personal-guest-runtime.schema.json- personal-guest-runtime.- ID:
https://opensoha.dev/schemas/personal-guest-runtime.schema.json - Required:
schemaVersion,operationId,binding,kind,request,deadline,artifactSHA256
- ID:
agent/personal-guest-tools.schema.json- personal-guest-tools.- ID:
https://opensoha.dev/schemas/personal-guest-tools.schema.json - Required:
schemaVersion,operationId,binding,artifactSHA256,diskQuotaBytes,cpuQuotaMilli,memoryBytes,pidsLimit,dockerImage,bubblewrapVersion,dockerVersion,chromiumVersion
- ID:
agent/provider-rollout.schema.json- Agent Provider Rollout.- ID:
https://opensoha.dev/schemas/agent/provider-rollout.schema.json - Required:
schemaVersion,id,desiredRevision,previousRevision,target,status,createdAt
- ID:
auth/permission-catalog.schema.json- OpenSoha Permission Catalog.- ID:
https://contracts.opensoha.dev/auth/permission-catalog.schema.json - Required:
schemaVersion,catalogVersion,contentHash,permissions
- ID:
auth/token-claims.schema.json- Soha Token Claims.- ID:
https://contracts.opensoha.dev/auth/token-claims.schema.json - Required:
sub,exp,iat,tokenId,tokenKind,subjectType,subjectId
- ID:
capabilities/cluster-capability-matrix.schema.json- OpenSoha Cluster Capability Matrix.- ID:
https://contracts.opensoha.dev/capabilities/cluster-capability-matrix.schema.json - Required:
items
- ID:
connectors/connector-action.schema.json- OpenSoha credential-bearing connector action v1.- ID:
https://contracts.opensoha.dev/connectors/connector-action.schema.json - Required:
schemaVersion,action,input,credentials
- ID:
connectors/connector-event-envelope.schema.json- OpenSoha Connector Event Batch Envelope.- ID:
https://contracts.opensoha.dev/connectors/connector-event-envelope.schema.json - Required:
connectorId,events
- ID:
delivery/document.schema.json- Soha Delivery Document.- ID:
https://contracts.opensoha.dev/delivery/document.schema.json
- ID:
endpointcontrol/protocol.schema.json- Endpoint channel controls.- ID:
https://opensoha.dev/contracts/endpointcontrol/protocol.schema.json
- ID:
evaluation/evaluation-dataset.schema.json- Evaluation Dataset.- ID:
https://opensoha.dev/schemas/evaluation-dataset.schema.json - Required:
schemaVersion,id,name,version,samples,createdAt
- ID:
evaluation/evaluation-result.schema.json- Evaluation Result.- ID:
https://opensoha.dev/schemas/evaluation-result.schema.json - Required:
schemaVersion,sampleId,scores,passed
- ID:
evaluation/evaluation-run.schema.json- Evaluation Run.- ID:
https://opensoha.dev/schemas/evaluation-run.schema.json - Required:
schemaVersion,id,datasetId,datasetVersion,candidateRefs,status,startedAt
- ID:
evaluation/executor-profile.schema.json- Evaluation Executor Profile.- ID:
https://opensoha.dev/schemas/evaluation/executor-profile.schema.json - Required:
schemaVersion,id,environmentPolicy,isolationMode,timeoutSeconds,enabled
- ID:
evaluation/feedback-sample.schema.json- Curated Evaluation Feedback Sample.- ID:
https://opensoha.dev/schemas/evaluation/feedback-sample.schema.json - Required:
schemaVersion,id,traceRef,scopeHash,redactedInput,redactedOutput,licenseRef,decision,createdAt
- ID:
evaluation/gate-decision.schema.json- Evaluation Gate Decision.- ID:
https://opensoha.dev/schemas/evaluation/gate-decision.schema.json - Required:
schemaVersion,id,policyId,policyVersion,baselineRunId,candidateRunId,decision,reasons,evidenceRefs,evaluatedAt
- ID:
evaluation/gate-policy.schema.json- Evaluation Gate Policy.- ID:
https://opensoha.dev/schemas/evaluation/gate-policy.schema.json - Required:
schemaVersion,id,version,minimumScores,enabled
- ID:
evaluation/replay-plan.schema.json- Evaluation Replay Plan.- ID:
https://opensoha.dev/schemas/evaluation/replay-plan.schema.json - Required:
schemaVersion,id,sourceTraceRefs,candidateRefs,executorProfileId,readOnly,createdAt
- ID:
evaluation/sample-attempt.schema.json- Evaluation Sample Attempt.- ID:
https://opensoha.dev/schemas/evaluation/sample-attempt.schema.json - Required:
schemaVersion,runId,sampleId,attempt,candidateRefs,status,latencyMillis,completedAt
- ID:
events/event-envelope.schema.json- Soha Event Envelope.- ID:
https://contracts.opensoha.dev/events/event-envelope.schema.json - Required:
id,source,category,severity,summary
- ID:
governance/approval-request.schema.json- OpenSoha Approval Request.- ID:
https://contracts.opensoha.dev/governance/approval-request.schema.json - Required:
id,status,strategy,actorType,actorId,toolName,riskLevel,requiresApproval,summary,createdAt,updatedAt
- ID:
governance/audit-log.schema.json- OpenSoha Audit Log.- ID:
https://contracts.opensoha.dev/governance/audit-log.schema.json - Required:
id,actorType,actorId,action,result,summary,createdAt
- ID:
knowledge/connector-checkpoint.schema.json- Knowledge Connector Checkpoint.- ID:
https://opensoha.dev/schemas/knowledge/connector-checkpoint.schema.json - Required:
schemaVersion,sourceId,connectorVersion,cursor,configHash,committedAt
- ID:
knowledge/connector-definition.schema.json- Knowledge Connector Definition.- ID:
https://opensoha.dev/schemas/knowledge/connector-definition.schema.json - Required:
schemaVersion,id,kind,version,configRef,enabled
- ID:
knowledge/context-envelope.schema.json- Context Envelope.- ID:
https://opensoha.dev/schemas/knowledge/context-envelope.schema.json - Required:
version,id,requestId,principal,task,budgets,budgetUsage,policySnapshot,contentHash,createdAt
- ID:
knowledge/graph-revision.schema.json- Knowledge Graph Revision.- ID:
https://opensoha.dev/schemas/knowledge/graph-revision.schema.json - Required:
schemaVersion,id,knowledgeBaseId,sourceIndexRef,extractorVersion,status,entityCount,relationCount,createdAt
- ID:
knowledge/index-publish.schema.json- Knowledge Index Publish Decision.- ID:
https://opensoha.dev/schemas/knowledge/index-publish.schema.json - Required:
schemaVersion,knowledgeBaseId,revisionId,expectedActiveRevision,decision,decidedAt
- ID:
knowledge/ingestion-job.schema.json- Knowledge Ingestion Job.- ID:
https://opensoha.dev/schemas/knowledge/ingestion-job.schema.json - Required:
schemaVersion,id,sourceId,targetRevision,stage,status,attempt,createdAt
- ID:
knowledge/ingestion-stage.schema.json- Knowledge Ingestion Stage Completion.- ID:
https://opensoha.dev/schemas/knowledge/ingestion-stage.schema.json - Required:
schemaVersion,jobId,stage,attempt,status,completedAt
- ID:
knowledge/knowledge-base.schema.json- Knowledge Base.- ID:
https://opensoha.dev/schemas/knowledge/knowledge-base.schema.json - Required:
id,name,status,ownerId,scope,retrievalPolicy,createdAt,updatedAt
- ID:
knowledge/knowledge-search.schema.json- Knowledge Search Request.- ID:
https://opensoha.dev/schemas/knowledge/knowledge-search.schema.json - Required:
knowledgeBaseIds,query
- ID:
knowledge/knowledge-source.schema.json- Knowledge Source.- ID:
https://opensoha.dev/schemas/knowledge/knowledge-source.schema.json - Required:
id,knowledgeBaseId,name,kind,syncPolicy,status,createdAt,updatedAt
- ID:
knowledge/retrieval-trace.schema.json- Production Retrieval Trace.- ID:
https://opensoha.dev/schemas/knowledge/retrieval-trace.schema.json - Required:
schemaVersion,traceId,queryHash,indexRevision,routeRef,candidateCount,hitCount,noAnswer,timingMs
- ID:
mcp/gateway-capability-baseline.schema.json- Soha AI Gateway Capability Baseline.- ID:
https://contracts.opensoha.dev/mcp/gateway-capability-baseline.schema.json - Required:
schemaVersion,version,source,tools
- ID:
mcp/gateway-manifest.schema.json- Soha AI Gateway Manifest.- ID:
https://contracts.opensoha.dev/mcp/gateway-manifest.schema.json - Required:
name,version,generatedAt,principal,caller,permissionKeys,tools,summary
- ID:
memory/memory-policy.schema.json- Long-Term Memory Policy.- ID:
https://opensoha.dev/schemas/memory/memory-policy.schema.json - Required:
schemaVersion,id,version,ownerTypes,defaultTtlSeconds,maximumTtlSeconds,minimumConfidence,explicitWriteOnly,enabled
- ID:
memory/memory-record.schema.json- Explicit Long-Term Memory Record.- ID:
https://opensoha.dev/schemas/memory/memory-record.schema.json - Required:
schemaVersion,id,ownerType,ownerId,scopeHash,fact,sourceType,confidence,validFrom,policyVersion,status,createdAt
- ID:
network/network-ingest-event.schema.json- OpenSoha Network Ingest Event Batch.- ID:
https://contracts.opensoha.dev/network/network-ingest-event.schema.json - Required:
schemaVersion,batchId,producerId,producerKind,sentAt,events
- ID:
network/network-radius-accounting.schema.json- OpenSoha FreeRADIUS Accounting Adapter Request.- ID:
https://contracts.opensoha.dev/network/network-radius-accounting.schema.json - Required:
schemaVersion,eventTimestamp,statusType,accountingSessionId,nasId,sessionTimeSeconds
- ID:
network/network-runtime-protocol.schema.json- OpenSoha Network Runtime Protocol Message.- ID:
https://contracts.opensoha.dev/network/network-runtime-protocol.schema.json - Required:
schemaVersion,messageId,messageType,producerId,runtimeId,runtimeKind,occurredAt,expiresAt,payload
- ID:
network/proxy-adapter.schema.json- Proxy Adapter v1 frame.- ID:
https://contracts.opensoha.dev/network/proxy-adapter.schema.json - Required:
major,minor,requestId,deadline,processEpoch,method
- ID:
network/proxy-runtime.schema.json- OpenSoha Proxy Runtime Message.- ID:
https://contracts.opensoha.dev/network/proxy-runtime.schema.json - Required:
schemaVersion,runtimeId,messageType,occurredAt,payload
- ID:
network/radius-password-verifier.schema.json- Restricted TTLS PAP password verifier.- ID:
https://contracts.opensoha.dev/network/radius-password-verifier.schema.json
- ID:
network/radius-runtime.schema.json- Managed RADIUS pool and member runtime.- ID:
https://contracts.opensoha.dev/network/radius-runtime.schema.json
- ID:
plugins/companion-pack.schema.json- OpenSoha Companion Pack.- ID:
https://contracts.opensoha.dev/plugins/companion-pack.schema.json - Required:
renderer,entryAsset,assets,license
- ID:
plugins/companion-provenance.schema.json- OpenSoha Companion Provenance Statement.- ID:
https://contracts.opensoha.dev/plugins/companion-provenance.schema.json - Required:
subjectSha256,builderId,sourceUri,sourceCommit,builtAt,signingKeyId,signatureAlgorithm,signature
- ID:
plugins/marketplace-catalog.schema.json- OpenSoha Marketplace Catalog.- ID:
https://contracts.opensoha.dev/plugins/marketplace-catalog.schema.json - Required:
schemaVersion,generatedAt,sourceId,plugins
- ID:
plugins/plugin-manifest.schema.json- OpenSoha Plugin Manifest.- ID:
https://contracts.opensoha.dev/plugins/plugin-manifest.schema.json - Required:
id,name,version,publisher,type
- ID:
presets/mcp-preset.schema.json- OpenSoha MCP Preset.- ID:
https://contracts.opensoha.dev/presets/mcp-preset.schema.json - Required:
schemaVersion,id,name,version,description,riskLevel,skillRefs,platformCapabilityRefs,requiredScopes,tools,guardrails
- ID:
profiles/agent-profile.schema.json- OpenSoha Agent Profile.- ID:
https://contracts.opensoha.dev/profiles/agent-profile.schema.json - Required:
schemaVersion,id,name,version,description,mode,providerKind,skillRefs,mcpPresetRefs,capabilityRefs,platformCapabilityRefs,requiredScopes,enabledToolRefs,guardrails
- ID:
runner/docker-container-identity.schema.json- Docker immutable container identity v1.- ID:
https://schemas.opensoha.io/runner/docker-container-identity.schema.json - Required:
protocol,hostUid,projectUid,namespace,serviceName,containerId
- ID:
runner/docker-project-identity.schema.json- Docker project runtime identity v1.- ID:
https://schemas.opensoha.io/runner/docker-project-identity.schema.json - Required:
protocol,hostUid,projectUid,namespace
- ID:
runner/docker-runtime-read-result.schema.json- Docker identity-bound runtime read result v1.- ID:
https://schemas.opensoha.io/runner/docker-runtime-read-result.schema.json - Required:
protocol,action,projectId,container,sizeBytes,truncated,complete,volumes,files,returnedBytes
- ID:
runner/docker-runtime-read.schema.json- Docker identity-bound runtime read request v1.- ID:
https://schemas.opensoha.io/runner/docker-runtime-read.schema.json - Required:
protocol,action,projectId,container
- ID:
runner/operation-lifecycle.schema.json- OpenSoha Runner Operation Lifecycle.- ID:
https://contracts.opensoha.dev/runner/operation-lifecycle.schema.json - Required:
operationId,operationKind,runnerId,state,occurredAt
- ID:
skills/skill-manifest.schema.json- Soha Skill Manifest.- ID:
https://contracts.opensoha.dev/skills/skill-manifest.schema.json - Required:
id,name,category
- ID:
Last updated on