Docs Reference
Reference · REST API
The Kumo.io API
Everything the web app can do, you can script. Two surfaces: the tenant API your team and automation use, and the admin API operators use on hosted or self-hosted control planes. Generated from the OpenAPI documents CI keeps in lockstep with the server.
Conventions
- Auth — every route takes
Authorization: Bearer <api key>. Tenant paths carry{accountId}, matched against the authenticated actor's account before any handler runs. - Envelopes — responses wrap payloads in a standard envelope; lists page by cursor.
- Shapes — open a route to see its query parameters, request body and success response, field by field; linked type names are listed under each surface's Schemas. Errors use the standard error envelope.
- Async work — long-running operations (syncs, exports) return
202with aLocationto poll. - Tiers — stable routes follow the compatibility policy; preview routes may change between releases and say so here first.
Tenant API
Account-scoped: paths carry {accountId} (yours), and workspace resources nest under {workspaceId}.
Environments · 39 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/environmentsQuery
Response 200 { data: EnvironmentByAccountItemDto[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environmentsQuery
Response 200 { data: ListEnvironmentsHttpResponseItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environmentsRequest body CreateEnvironmentBody
Response 201 { data: CreateEnvironmentHttpResponse; meta }
| stable | 201 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}Response 200 { data: GetEnvironmentHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/context-query/evaluateRequest body ContextQueryEvaluateBody
Response 200 { data: ContextQueryEvaluateResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/context-query/frontierRequest body ContextFrontierResolveBody
Response 200 { data: ContextFrontierResolveResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/cost-estimateResponse 200 { data: EnvironmentPricingEstimateResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/definitionsRequest body CreateEnvironmentDefinitionBody
Response 201 { data: CreateEnvironmentDefinitionHttpResponse; meta }
| stable | 201 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/revisionsQuery
Response 200 { data: EnvironmentRevisionHttpItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/revisionsRequest body EvaluateEnvironmentBody
Response 202 { data: EvaluateEnvironmentHttpResponse; meta }
| stable | 202 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/revisions/{environmentRevisionId}Response 200 { data: GetEnvironmentRevisionHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/revisions/{environmentRevisionId}/membersQuery
Response 200 { data: EnvironmentRevisionMember[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/source-modelQuery
Response 200 { data: EnvironmentSourceModelBuildHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/source-modelRequest body ContextSourceModelBuildBody
Response 200 { data: ContextSourceModelBuildResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/viewsQuery
Response 200 { data: ViewHttpItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/viewsRequest body CreateViewBody
Response 200 { data: CreateViewHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}Response 200 { data: GetViewHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/access-grantsResponse 200 { data: ViewAccessGrantsListResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/access-grantsRequest body CreateGrantBody
Response 200 { data: ViewAccessGrantCreateResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/access-grants/{grantId}Response 200 { data: ViewAccessGrantRevokeResult; meta } | stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/configurationsQuery
Response 200 { data: ViewConfigurationHttpItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/configurationsRequest body CreateViewConfigurationBody
Response 200 { data: CreateViewConfigurationHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/configurations/{viewConfigurationId}Response 200 { data: GetViewConfigurationHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisionsQuery
Response 200 { data: ViewRevisionHttpItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisionsRequest body GenerateViewRevisionBody
Response 202 { data: GenerateViewHttpResponse; meta }
| stable | 202 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}Response 200 { data: GetViewRevisionHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/artifacts/{kind}Response 200 */* (file or stream) | stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.drawioQuery
Response 200 */* (file or stream) | stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.mmdQuery
Response 200 */* (file or stream) | stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.pdfQuery
Response 200 */* (file or stream) | stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.pngQuery
Response 200 */* (file or stream) | stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.vsdxQuery
Response 200 */* (file or stream) | stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/sharesResponse 200 { data: ViewSharesListResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/sharesRequest body CreateShareBody
Response 200 { data: ViewShareCreateResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/shares/{shareId}Response 200 { data: ViewShareRevokeResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/source-modelQuery
Response 200 { data: ViewSourceModelBuildHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/template-overrideResponse 200 { data: ClearViewTemplateOverrideHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/template-overrideRequest body
Response 200 { data: SetViewTemplateOverrideHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/generate-defaultRequest body GenerateDefaultViewsBody
Response 201 { data: GenerateDefaultViewsHttpResponse; meta }
| stable | 201 |
Auth · 34 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /auth/havaQuery
Response 302 no body | stable | |||||||||||||||||||||||||
| POST | /auth/saml/{realmAccountId}/acsRequest body AcsBody
Response 200
| stable | 200 | ||||||||||||||||||||||||
| GET | /auth/saml/{realmAccountId}/loginQuery
Response 302 no body | stable | |||||||||||||||||||||||||
| GET | /auth/saml/{realmAccountId}/metadataResponse 200 application/samlmetadata+xml (file or stream) | stable | 200 | ||||||||||||||||||||||||
| GET | /v1/auth/captchaResponse 200 { data: { enabled: boolean } | { enabled: boolean; provider: "recaptcha" | "turnstile"; siteKey: string } } | internal | 200 | ||||||||||||||||||||||||
| GET | /v1/auth/kumo/callbackResponse 302 no body | stable | |||||||||||||||||||||||||
| POST | /v1/auth/kumo/deviceResponse 200 DeviceLoginError | DeviceLoginStartResponse | stable | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/kumo/device/tokenRequest body DeviceLoginTokenBody
Response 200 DeviceLoginError | DeviceLoginTokenResponse | stable | 200 | ||||||||||||||||||||||||
| GET | /v1/auth/kumo/end-sessionResponse 302 no body | stable | |||||||||||||||||||||||||
| GET | /v1/auth/kumo/startResponse 302 no body | stable | |||||||||||||||||||||||||
| POST | /v1/auth/loginRequest body
Response 200 { data: object } | { data: object | object } | internal | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/logoutResponse 200 { data: { signedOut: boolean } }
| internal | 200 | ||||||||||||||||||||||||
| GET | /v1/auth/meResponse 200 { data: { actor: kumo-contracts.ActorContext; session: object | null; profile: object | null; memberships: object[] }; meta }
| internal | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/mfa/challengeRequest body
Response 200 { data: { usedRecoveryCode: boolean; delivery: "bearer"; token: string; expiresAt: string; userId: string; accountId: string } | { usedRecoveryCode: boolean; delivery: "cookie"; expiresAt: string; userId: string; accountId: string | null; next: string; csrfToken: string } } | internal | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/mfa/disableRequest body
Response 200 { data: AuthMfaDisableResult }
| internal | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/mfa/enroll/confirmRequest body
Response 200 { data: { enabled: boolean; recoveryCodes: string[] } }
| internal | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/mfa/enroll/startRequest body
Response 200 { data: AuthMfaEnrollStartResult }
| internal | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/mfa/recovery-codesRequest body
Response 200 { data: AuthRecoveryCodesRegenerateResult }
| internal | 200 | ||||||||||||||||||||||||
| GET | /v1/auth/oidc/{realmAccountId}/callbackQuery
Response 302 no body | stable | |||||||||||||||||||||||||
| GET | /v1/auth/oidc/{realmAccountId}/startResponse 302 no body | stable | |||||||||||||||||||||||||
| POST | /v1/auth/partner-signupRequest body PartnerSignupBody
Response 201 { data: PartnerSignupProvisionResult; meta }
| stable | 201 | ||||||||||||||||||||||||
| POST | /v1/auth/passwordRequest body
Response 200 { data: AuthPasswordChangeResult }
| internal | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/password-reset/confirmRequest body
Response 200 { data: AuthPasswordResetConfirmResult }
| internal | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/password-reset/requestRequest body
Response 200 { data: AuthPasswordResetRequestResult }
| internal | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/session-handoffRequest body
Response 200 { data: AuthSessionGrantWire } | stable | 200 | ||||||||||||||||||||||||
| GET | /v1/auth/sessionsResponse 200 { data: { sessions: AuthSessionSummaryWire[] } }
| internal | 200 | ||||||||||||||||||||||||
| POST | internal | 200 | |||||||||||||||||||||||||
| POST | /v1/auth/signupRequest body
Response 200 { data: { verificationMailSent: boolean; delivery: "bearer"; token: string; expiresAt: string; userId: string; accountId: string } | { verificationMailSent: boolean; delivery: "cookie"; expiresAt: string; userId: string; accountId: string | null; next: string; csrfToken: string } } | internal | 200 | ||||||||||||||||||||||||
| GET | /v1/auth/socialResponse 200 { data: object; meta?: map<string, any> } | { data: object; meta?: map<string, any> } | internal | 200 | ||||||||||||||||||||||||
| GET | /v1/auth/social/callbackQuery
Response 302 no body | stable | |||||||||||||||||||||||||
| GET | /v1/auth/social/startResponse 302 no body | stable | |||||||||||||||||||||||||
| POST | /v1/auth/switch-accountRequest body
Response 200 { data: AuthSessionGrantWire } | stable | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/verify-emailRequest body
Response 200 { data: AuthEmailVerifyResult }
| internal | 200 | ||||||||||||||||||||||||
| POST | /v1/auth/verify-email/resendRequest body
Response 200 { data: AuthEmailVerifyResendResult }
| internal | 200 |
Scim · 22 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /scim/v2/GroupsResponse 200
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /scim/v2/GroupsRequest body any Response 201 ScimGroupResource
| stable | 201 | ||||||||||||||||||||||||||||||||||||||
| DELETE | /scim/v2/Groups/{scimId}Response 204 no body | stable | 204 | ||||||||||||||||||||||||||||||||||||||
| GET | /scim/v2/Groups/{scimId}Response 200 ScimGroupResource
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| PATCH | /scim/v2/Groups/{scimId}Request body any Response 200 ScimGroupResource
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| PUT | /scim/v2/Groups/{scimId}Request body any Response 200 ScimGroupResource
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /scim/v2/ResourceTypesResponse 200 ScimResourceType[] | stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /scim/v2/SchemasResponse 200 ScimSchemaDefinition[] | stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /scim/v2/Schemas/{scimId}Response 200 ScimSchemaDefinition
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /scim/v2/ServiceProviderConfigResponse 200 ScimServiceProviderConfig
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /scim/v2/UsersResponse 200
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /scim/v2/UsersRequest body any Response 201 ScimUserResource
| stable | 201 | ||||||||||||||||||||||||||||||||||||||
| DELETE | /scim/v2/Users/{scimId}Response 204 no body | stable | 204 | ||||||||||||||||||||||||||||||||||||||
| GET | /scim/v2/Users/{scimId}Response 200 ScimUserResource
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| PATCH | /scim/v2/Users/{scimId}Request body any Response 200 ScimUserResource
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| PUT | /scim/v2/Users/{scimId}Request body any Response 200 ScimUserResource
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/scim/directoriesResponse 200 { data: { directories: map<string, any>[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/scim/directoriesRequest body DirectoryCreateBody
Response 201 { data: { token?: map<string, any>; secret?: string; directory: map<string, any> }; meta }
| stable | 201 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/scim/directories/{directoryId}/disableResponse 200 { data: { directory: map<string, any> }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/scim/directories/{directoryId}/tokensResponse 200 { data: { tokens: map<string, any>[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/scim/directories/{directoryId}/tokensRequest body TokenMintBody
Response 201 { data: { token: map<string, any>; secret: string }; meta }
| stable | 201 | ||||||||||||||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/scim/directories/{directoryId}/tokens/{tokenId}Response 200 { data: { revoked: boolean }; meta }
| stable | 200 |
Sources · 19 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/sources/{sourceId}/credential-healthResponse 200 { data: CredentialHealthReportDto | null; meta } | stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/sources/{sourceId}/credential-health-checkRequest body RunCheckBody
Response 200 { data: CredentialHealthReportDto; meta?: map<string, any> } | { data: object; meta?: map<string, any> } | stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/sources/aws-external-idResponse 200 { data: AwsPendingExternalIdEnsureResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/sources/preflightRequest body ConnectBody
Response 200 { data: SourcePreflightResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/sourcesQuery
Response 200 { data: ListSourcesHttpResponseItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/sourcesRequest body kumo-core-server.SourcesRoute.CreateBody
Response 201 { data: CreateSourceHttpResponse; meta }
| stable | 201 | ||||||||||||||||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}Response 200 { data: SourceArchiveResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}Response 200 { data: GetSourceHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/change-eventsRequest body IngestBody
Response 202 { data: ChangeEventsIngestResult; meta }
| stable | 202 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/cost/billing-exportsResponse 200 { data: BillingExportsDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/cost/billing-exports/refreshResponse 200 { data: BillingExportsDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| PUT | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/parametersRequest body ParametersBody
Response 200 { data: SourceParametersUpdateHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/syncRequest body SyncBody
Response 202 { data: RunSourceSyncHttpResponse; meta }
| stable | 202 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/syncsQuery
Response 200 { data: SourceSyncsListHttpResponseItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/syncs/{sourceSyncId}Response 200 { data: SourceSyncGetHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/syncs/{sourceSyncId}/diagnosticsQuery
Response 200 { data: SyncDiagnosticsListHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/syncs/{sourceSyncId}/diagnostics/streamQuery
Response 200 text/event-stream (file or stream) | stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/unarchiveResponse 200 { data: SourceUnarchiveResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/sources/connectRequest body ConnectBody
Response 201 { data: SourceConnectResult; meta }
| stable | 201 |
Reports · 18 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/definitionsQuery
Response 200 { data: ReportDefinition[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/definitionsRequest body ReportDefinitionCreateBody
Response 200 { data: ReportDefinition; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/definitions/{definitionId}Response 200 { data: ReportDefinitionDeleteResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/definitions/{definitionId}Response 200 { data: ReportDefinition; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| PATCH | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/definitions/{definitionId}Request body ReportDefinitionUpdateBody
Response 200 { data: ReportDefinition; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/exports/{exportId}Response 200 { data: ReportExportRequest; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/exports/{exportId}/contentResponse 200 */* (file or stream) | stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/exports/{exportId}/downloadQuery
Response 200 { data: ReportArtifactGetDownloadUrlResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runsQuery
Response 200 { data: ReportRun[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runsRequest body ReportRunStartBody
Response 200 { data: ReportRunStartResultDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runs/{runId}Response 200 { data: ReportRun; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runs/{runId}/cancelResponse 200 { data: ReportRun; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runs/{runId}/exportsRequest body ReportExportStartBody
Response 200 { data: ReportExportStartResultDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runs/{runId}/modelResponse 200 { data: ReportModel; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/schedulesQuery
Response 200 { data: ReportSchedule[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/schedulesRequest body ReportScheduleCreateBody
Response 200 { data: ReportSchedule; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/schedules/{scheduleId}Response 200 { data: ReportScheduleDeleteResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| PATCH | /v1/accounts/{accountId}/workspaces/{workspaceId}/reports/schedules/{scheduleId}Request body ReportScheduleUpdateBody
Response 200 { data: ReportSchedule; meta }
| stable | 200 |
Cost · 16 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/allocation-rulesQuery
Response 200 { data: CostAllocationRulesListResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/allocation-rulesRequest body RuleSaveBody
Response 200 { data: { rule: CostAllocationRule }; meta } | stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/allocation-runsRequest body AllocationRunBody
Response 200 { data: CostAllocationRunResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/analyzeRequest body kumo-core-server.CostRoute.AnalyzeBody
Response 200 { data: WorkspaceCostAnalyzeResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/billing-exportsResponse 200 { data: BillingExportsListDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/billing-exports/ingestResponse 200 { data: BillingExportsIngestQueuedDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/changesQuery
Response 200 { data: CostChangeAnalyzeResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/forecastQuery
Response 200 { data: CostForecastGenerateResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/overlayQuery
Response 200 { data: CostOverlay; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/recommendationsQuery
Response 200 { data: CostRecommendation[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/reportsQuery
Response 200 { data: CostReport[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/reportsRequest body ReportCreateBody
Response 200 { data: { report: CostReport }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/reports/{reportId}Response 200 { data: { report: CostReport }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/rollupsQuery
Response 200 { data: CostRollupsDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/summaryQuery
Response 200 { data: CostSummaryDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/cost/wasteQuery
Response 200 { data: WasteFinding[]; page; meta }
| stable | 200 |
Sso · 11 routes
| Method | Path | Tier | 2xx | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/sso/oidcResponse 200 { data: { configuration: AuthOidcConfigView | null }; meta }
| stable | 200 | ||||||||||||||
| PUT | /v1/accounts/{accountId}/sso/oidcRequest body OidcConfigBody
Response 200 { data: { configuration: AuthOidcConfigView }; meta }
| stable | 200 | ||||||||||||||
| GET | /v1/accounts/{accountId}/sso/samlQuery
Response 200 { data: { configurations: SsoSamlConfigurationDto[] }; meta }
| stable | 200 | ||||||||||||||
| POST | /v1/accounts/{accountId}/sso/samlRequest body ConfigurationCreateBody
Response 201 { data: { configuration: SsoSamlConfigurationDto }; meta }
| stable | 201 | ||||||||||||||
| DELETE | /v1/accounts/{accountId}/sso/saml/{configurationId}Response 200 { data: { deleted: string }; meta }
| stable | 200 | ||||||||||||||
| GET | /v1/accounts/{accountId}/sso/saml/{configurationId}Response 200 { data: { configuration: SsoSamlConfigurationDto }; meta }
| stable | 200 | ||||||||||||||
| PATCH | /v1/accounts/{accountId}/sso/saml/{configurationId}Request body ConfigurationUpdateBody
Response 200 { data: { configuration: SsoSamlConfigurationDto }; meta }
| stable | 200 | ||||||||||||||
| POST | /v1/accounts/{accountId}/sso/saml/{configurationId}/activateResponse 200 { data: { deactivated?: SsoSamlConfigurationDto; configuration: SsoSamlConfigurationDto }; meta }
| stable | 200 | ||||||||||||||
| POST | /v1/accounts/{accountId}/sso/saml/{configurationId}/disableResponse 200 { data: { configuration: SsoSamlConfigurationDto }; meta }
| stable | 200 | ||||||||||||||
| GET | /v1/accounts/{accountId}/sso/saml/sp-metadataResponse 200 application/xml; charset=utf-8 (file or stream) | stable | 200 | ||||||||||||||
| GET | /v1/accounts/{accountId}/sso/setupResponse 200 { data: SsoSetupValues; meta }
| stable | 200 |
Export · 8 routes
| Method | Path | Tier | 2xx | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/export/archiveQuery
Response 200 */* (file or stream) | stable | 200 | ||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/export/connections.csvQuery
Response 200 text/csv; charset=utf-8 (file or stream) | stable | 200 | ||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/export/connections.jsonQuery
Response 200 */* (file or stream) | stable | 200 | ||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/export/jobs/{jobId}/downloadResponse 200 application/zip (file or stream) | stable | 200 | ||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/export/resources.csvQuery
Response 200 text/csv; charset=utf-8 (file or stream) | stable | 200 | ||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/export/resources.jsonQuery
Response 200 */* (file or stream) | stable | 200 | ||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/export/workspace.zipQuery
Response 200 application/zip (file or stream) | stable | 200 | ||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/export/workspace.zip/jobsQuery
Response 202 { data: { jobId: string; statusPath: string; downloadPath: string }; meta }
| stable | 202 |
Source credentials · 8 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/source-credentialsQuery
Response 200 { data: ListSourceCredentialsHttpResponseItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/source-credentialsRequest body kumo-core-server.SourceCredentialsRoute.CreateBody
Response 201 { data: CreateSourceCredentialHttpResponse; meta }
| stable | 201 | ||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/source-credentials/{credentialId}Response 200 { data: DeleteSourceCredentialHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/source-credentials/{credentialId}Response 200 { data: GetSourceCredentialHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/source-credentials/{credentialId}/rotateRequest body RotateBody
Response 200 { data: RotateSourceCredentialHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/source-credentials/{sourceCredentialReferenceId}/healthResponse 200 { data: CredentialHealthReportDto | null; meta } | stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/source-credentials/{sourceCredentialReferenceId}/health-checkRequest body RunCheckBody
Response 200 { data: CredentialHealthReportDto; meta?: map<string, any> } | { data: object; meta?: map<string, any> } | stable | 200 | ||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/source-credentials/{sourceCredentialReferenceId}/health-reportsQuery
Response 200 { data: CredentialHealthReportDto[]; page; meta }
| stable | 200 |
Change intelligence · 7 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/analyzeRequest body kumo-core-server.ChangeIntelligenceRoute.AnalyzeBody
Response 200 { data: ChangeIntelligenceAnalyzeResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/changesQuery
Response 200 { data: WorkspaceChangesListResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/changes/{changeId}/explainQuery
Response 200 { data: ChangeExplainResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/correlateRequest body CorrelateBody
Response 200 { data: ChangeCorrelationSearchResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/digestRequest body DigestBody
Response 200 { data: ChangeDigestBuildResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/materializeRequest body MaterializeBody
Response 200 { data: ChangeIntelligenceMaterializeResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/resources/{resourceId}/timelineQuery
Response 200 { data: ResourceChangeTimelineResult; meta }
| stable | 200 |
Graph diffs · 7 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffsRequest body kumo-core-server.GraphDiffsRoute.CreateBody
Response 200 { data: { summary: GraphDiffSummaryDto; cacheHit: boolean }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}Response 200 { data: GraphDiffSummaryDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}/changesQuery
Response 200 { data: GraphDiffChangeDto[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}/changes/{changeId}/explainQuery
Response 200 { data: GraphDiffExplanation; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}/exportQuery
Response 200 */* (file or stream) | stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}/overlayResponse 200 { data: GraphDiffOverlayDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}/summaryResponse 200 { data: GraphDiffSummaryDto; meta }
| stable | 200 |
Webhook subscriptions · 7 routes
| Method | Path | Tier | 2xx | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/webhook-subscriptionsResponse 200 { data: WebhookSubscriptionListResult; meta }
| stable | 200 | ||||||||||
| POST | /v1/accounts/{accountId}/webhook-subscriptionsRequest body CreateWebhookSubscriptionRequestBody
Response 201 { data: WebhookSubscriptionCreateResult; meta }
| stable | 201 | ||||||||||
| DELETE | /v1/accounts/{accountId}/webhook-subscriptions/{subscriptionId}Response 200 { data: WebhookSubscriptionDeleteResult; meta }
| stable | 200 | ||||||||||
| GET | /v1/accounts/{accountId}/webhook-subscriptions/{subscriptionId}Response 200 { data: WebhookSubscriptionGetResult; meta }
| stable | 200 | ||||||||||
| PATCH | /v1/accounts/{accountId}/webhook-subscriptions/{subscriptionId}Request body UpdateWebhookSubscriptionRequestBody | null Response 200 { data: WebhookSubscriptionUpdateResult; meta }
| stable | 200 | ||||||||||
| GET | /v1/accounts/{accountId}/webhook-subscriptions/{subscriptionId}/deliveriesQuery
Response 200 { data: WebhookDeliveryListResult; meta }
| stable | 200 | ||||||||||
| POST | /v1/accounts/{accountId}/webhook-subscriptions/{subscriptionId}/rotate-secretResponse 200 { data: WebhookSubscriptionRotateSecretResult; meta }
| stable | 200 |
Billing · 6 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/billing/entitlementsQuery
Response 200 { data: { subject: QuotaSubject; planId: PlanId | null; planVersionId: PlanVersionId | null; subscriptionId: SubscriptionId | null; entitlements: BillingEntitlementRecord[]; warnings: string[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/billing/features/{featureKey}Query
Response 200 { data: { featureKey: FeatureKey; enabled: boolean; entitlement: BillingEntitlementRecord | null }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/billing/plansQuery
Response 200 { data: { plans: SelfServePlan[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/billing/quota/checkRequest body QuotaCheckBody
Response 200 { data: BillingQuotaDecisionRecord; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/billing/subscriptionsResponse 200 { data: { subscriptions: BillingSubscriptionRecord[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/billing/subscriptions/{subscriptionId}Response 200 { data: BillingSubscriptionRecord; meta }
| stable | 200 |
Integrations · 6 routes
| Method | Path | Tier | 2xx | ||||||
|---|---|---|---|---|---|---|---|---|---|
| DELETE | /v1/accounts/{accountId}/integrations/slackResponse 200 { data: { disconnected: boolean }; meta }
| stable | 200 | ||||||
| GET | /v1/accounts/{accountId}/integrations/slackResponse 200 { data: object; meta?: map<string, any> } | { data: object; meta?: map<string, any> } | stable | 200 | ||||||
| GET | /v1/accounts/{accountId}/integrations/slack/channelsResponse 200 { data: { channels: SlackChannelInfo[] }; meta }
| stable | 200 | ||||||
| POST | /v1/accounts/{accountId}/integrations/slack/oauth/startResponse 200 { data: { authorizeUrl: string }; meta }
| stable | 200 | ||||||
| GET | /v1/integrations/slack/callbackQuery
Response 302 no body | stable | |||||||
| POST | stable | 200 |
Notifications · 6 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/notificationsQuery
Response 200 { data: NotificationInboxItemDto[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/notifications/{notificationId}Response 200 { data: NotificationDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/notifications/items/{recipientNotificationId}/dismissResponse 200 { data: { alreadyDismissed: boolean }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/notifications/items/{recipientNotificationId}/readResponse 200 { data: { alreadyRead: boolean }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/notifications/read-allQuery
Response 200 { data: { markedCount: number }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/notifications/unread-countQuery
Response 200 { data: { count: number }; meta }
| stable | 200 |
Provider scopes · 6 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/provider-scopesQuery
Response 200 { data: ListProviderScopesHttpResponseItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/provider-scopesRequest body CreateProviderScopeBody
Response 201 { data: CreateProviderScopeHttpResponse; meta }
| stable | 201 | ||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/provider-scopes/{providerScopeId}Response 200 { data: GetProviderScopeHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/provider-scopes/{providerScopeId}/credential-healthResponse 200 { data: CredentialHealthReportDto | null; meta } | stable | 200 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/provider-scopes/{providerScopeId}/credential-health-checkResponse 200 no body | stable | 200 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/provider-scopes/discoverRequest body DiscoverProviderScopesBody
Response 200 { data: DiscoverProviderScopesHttpResponse; meta }
| stable | 200 |
Resources · 6 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/resourcesQuery
Response 200 { data: ListResourcesAtRevisionHttpResponseItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/resources/{resourceId}Query
Response 200 { data: GetResourceAtRevisionHttpResponse; meta } | stable | 200 | ||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/resources/{resourceId}/connectionsQuery
Response 200 { data: ListResourceConnectionsAtRevisionHttpResponseItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/resources/{resourceId}/cost/explainQuery
Response 200 { data: ResourceCostExplainResult; meta }
| stable | 200 | ||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/resources/{resourceId}/cost/price-matchResponse 200 { data: PriceMatchExplainResult; meta }
| stable | 200 | ||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/resources/{resourceId}/pricingResponse 200 { data: ResourcePricingGetResult; meta }
| stable | 200 |
Sync runs · 6 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runsQuery
Response 200 { data: ListWorkspaceSyncRunsHttpResponseItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runsRequest body StartBody
Response 202 { data: StartWorkspaceSyncRunHttpResponse; meta }
| stable | 202 | ||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runs/{workspaceSyncRunId}Response 200 { data: GetWorkspaceSyncRunHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runs/{workspaceSyncRunId}/diagnosticsQuery
Response 200 { data: WorkspaceSyncRunDiagnosticsListHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runs/{workspaceSyncRunId}/diagnostics/streamQuery
Response 200 text/event-stream (file or stream) | stable | 200 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runs/{workspaceSyncRunId}/finalizeResponse 200 { data: FinalizeWorkspaceSyncRunHttpResponse; meta }
| stable | 200 |
Usage · 6 routes
| Method | Path | Tier | 2xx | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/usage/currentQuery
Response 200 { data: { counters: UsageCounterViewDto[] }; meta }
| stable | 200 | ||||||||||||||||
| GET | /v1/accounts/{accountId}/usage/exportQuery
Response 200 { data: { export: UsageExport; content: string }; meta }
| stable | 200 | ||||||||||||||||
| GET | /v1/accounts/{accountId}/usage/exports/{exportId}Response 200 { data: { export: UsageExport; content: string }; meta }
| stable | 200 | ||||||||||||||||
| GET | /v1/accounts/{accountId}/usage/ledgerQuery
Response 200 { data: UsageLedgerPageDto; meta }
| stable | 200 | ||||||||||||||||
| GET | /v1/accounts/{accountId}/usage/metersQuery
Response 200 { data: { meters: UsageMeterDefinition[] }; meta }
| stable | 200 | ||||||||||||||||
| GET | /v1/accounts/{accountId}/usage/reservationsQuery
Response 200 { data: { reservations: UsageReservation[] }; meta }
| stable | 200 |
View templates · 6 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/view-templatesQuery
Response 200 { data: ViewTemplateHttpItem[]; page; meta }
| stable | 200 | ||||||||||||||||||
| POST | /v1/accounts/{accountId}/view-templatesRequest body CreateTemplateBody
Response 200 { data: ViewTemplateCreateHttpResponse; meta }
| stable | 200 | ||||||||||||||||||
| GET | /v1/accounts/{accountId}/view-templates/{viewTemplateId}Response 200 { data: GetViewTemplateHttpResponse; meta }
| stable | 200 | ||||||||||||||||||
| GET | /v1/accounts/{accountId}/view-templates/{viewTemplateId}/versionsQuery
Response 200 { data: ViewTemplateVersionHttpItem[]; page; meta }
| stable | 200 | ||||||||||||||||||
| POST | /v1/accounts/{accountId}/view-templates/{viewTemplateId}/versionsRequest body CreateVersionBody
Response 201 { data: ViewTemplateVersionCreateHttpResponse; meta }
| stable | 201 | ||||||||||||||||||
| GET | /v1/accounts/{accountId}/view-templates/{viewTemplateId}/versions/{viewTemplateVersionId}Response 200 { data: GetViewTemplateVersionHttpResponse; meta }
| stable | 200 |
Alert targets · 5 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/alert-targetsQuery
Response 200 { data: { targets: AlertTargetDto[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/alert-targetsRequest body TargetCreateBody
Response 201 { data: AlertTargetDto; meta }
| stable | 201 | ||||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/alert-targets/{targetId}Response 200 { data: { deleted: boolean }; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| PATCH | /v1/accounts/{accountId}/alert-targets/{targetId}Request body TargetUpdateBody
Response 200 { data: AlertTargetDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/alert-targets/{targetId}/testResponse 200 { data: AlertTargetTestResult; meta }
| stable | 200 |
Roles · 5 routes
| Method | Path | Tier | 2xx | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/rolesResponse 200 { data: { roles: IamRoleRecord[] }; meta }
| stable | 200 | ||||||||||||
| POST | /v1/accounts/{accountId}/rolesRequest body CreateRoleBody
Response 201 { data: { role: IamRoleRecord }; meta }
| stable | 201 | ||||||||||||
| DELETE | /v1/accounts/{accountId}/roles/{roleId}Response 200 { data: { role: IamRoleRecord; transitioned: boolean }; meta }
| stable | 200 | ||||||||||||
| GET | /v1/accounts/{accountId}/roles/{roleId}Response 200 { data: { role: IamRoleRecord; permissions: string[] }; meta }
| stable | 200 | ||||||||||||
| PATCH | /v1/accounts/{accountId}/roles/{roleId}Request body UpdateRoleBody
Response 200 { data: { role: IamRoleRecord }; meta }
| stable | 200 |
Search · 5 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/searchQuery
Response 200 { data: SearchResultPage; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||
| GET | stable | 200 | |||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/search/saved-viewsRequest body SavedViewCreateBody
Response 200 { data: { view: SavedView; created: boolean }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/search/saved-views/{savedViewId}Response 200 { data: { deleted: true }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||
| PATCH | /v1/accounts/{accountId}/search/saved-views/{savedViewId}Request body SavedViewUpdateBody
Response 200 { data: { view: SavedView }; meta }
| stable | 200 |
Workspaces · 5 routes
| Method | Path | Tier | 2xx | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspacesQuery
Response 200 { data: WorkspaceListItemDto[]; page; meta }
| stable | 200 | ||||||||||||||||
| POST | /v1/accounts/{accountId}/workspacesRequest body CreateWorkspaceBody
Response 201 { data: CreateWorkspaceHttpResponse; meta }
| stable | 201 | ||||||||||||||||
| DELETE | /v1/accounts/{accountId}/workspaces/{workspaceId}Response 200 { data: WorkspaceArchiveResult; meta }
| stable | 200 | ||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}Response 200 { data: WorkspaceDto; meta }
| stable | 200 | ||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/demoRequest body ProvisionDemoWorkspaceBody
Response 201 { data: DemoWorkspaceProvisionHttpResponse; meta }
| stable | 201 |
Alert rules · 4 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/alert-rulesQuery
Response 200 { data: { rules: AlertRuleDto[] }; meta }
| stable | 200 | ||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/alert-rulesRequest body RuleCreateBody
Response 201 { data: AlertRuleDto; meta }
| stable | 201 | ||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/alert-rules/{ruleId}Response 200 { data: { deleted: boolean }; meta }
| stable | 200 | ||||||||||||||||||||||||
| PATCH | /v1/accounts/{accountId}/alert-rules/{ruleId}Request body RuleUpdateBody
Response 200 { data: AlertRuleDto; meta }
| stable | 200 |
Jobs · 4 routes
| Method | Path | Tier | 2xx | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/jobsQuery
Response 200 { data: map<string, any>[]; page; meta } | stable | 200 | ||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/jobs/{jobId}Response 200 { data: map<string, any>; meta } | stable | 200 | ||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/jobs/{jobId}/cancelRequest body CancelBody
Response 200 { data: map<string, any>; meta } | stable | 200 | ||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/jobs/{jobId}/retryResponse 200 { data: map<string, any>; meta } | stable | 200 |
Me · 4 routes
| Method | Path | Tier | 2xx | ||||||
|---|---|---|---|---|---|---|---|---|---|
| GET | stable | 200 | |||||||
| GET | /v1/me/featuresResponse 200 { data: TenantFeaturesResponseDto; meta }
| stable | 200 | ||||||
| GET | /v1/me/features/{featureKey}Response 200 { data: TenantFeatureResponseDto; meta }
| stable | 200 | ||||||
| GET | /v1/me/licenseResponse 200 { data: { installed: boolean; status: string }; meta }
| stable | 200 |
Operations · 4 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/operationsQuery
Response 200 { data: OperationHttpItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/operationsQuery
Response 200 { data: OperationHttpItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/operations/{operationId}Response 200 { data: GetOperationHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/operations/{operationId}/cancellationResponse 200 { data: CancelOperationHttpResponse; meta }
| stable | 200 |
Read models · 4 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/read-models/countsQuery
Response 200 { data: WorkspaceGraphCounts | null; meta } | stable | 200 | ||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/read-models/resourcesQuery
Response 200 { data: ResourceSummary[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/read-models/resources/{resourceId}/adjacencyResponse 200 { data: AdjacencyEntry | null; meta } | stable | 200 | ||||||||||||||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/read-models/sourcesResponse 200 { data: SourceSyncStatus[]; meta }
| stable | 200 |
Retention policies · 4 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/retention-policiesQuery
Response 200 { data: RetentionPolicyRecordHttpItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/retention-policiesRequest body kumo-core-server.RetentionPoliciesRoute.CreateBody
Response 201 { data: CreateRetentionPolicyHttpResponse; meta }
| stable | 201 | ||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/retention-policies/{retentionPolicyId}Response 200 { data: DeleteRetentionPolicyHttpResponse; meta }
| stable | 200 | ||||||||||||||||||||||
| GET | /v1/accounts/{accountId}/retention-policies/{retentionPolicyId}Response 200 { data: GetRetentionPolicyHttpResponse; meta }
| stable | 200 |
Sensitive field policies · 4 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/sensitive-field-policiesQuery
Response 200 { data: SensitiveFieldPolicyRecordHttpItem[]; page; meta }
| stable | 200 | ||||||||||||||||||
| POST | /v1/accounts/{accountId}/sensitive-field-policiesRequest body kumo-core-server.SensitiveFieldPoliciesRoute.CreateBody
Response 201 { data: CreateSensitiveFieldPolicyHttpResponse; meta }
| stable | 201 | ||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/sensitive-field-policies/{sensitiveFieldPolicyId}Response 200 { data: DeleteSensitiveFieldPolicyHttpResponse; meta }
| stable | 200 | ||||||||||||||||||
| GET | /v1/accounts/{accountId}/sensitive-field-policies/{sensitiveFieldPolicyId}Response 200 { data: GetSensitiveFieldPolicyHttpResponse; meta }
| stable | 200 |
Annotations · 3 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/annotationsQuery
Response 200 { data: { items: Annotation[] }; meta }
| stable | 200 | ||||||||||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/annotationsRequest body kumo-core-server.AnnotationsRoute.CreateBody
Response 201 { data: Annotation; meta }
| stable | 201 | ||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/workspaces/{workspaceId}/annotations/{annotationId}Response 200 { data: { deleted: boolean }; meta }
| stable | 200 |
Api tokens · 3 routes
| Method | Path | Tier | 2xx | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/api-tokensResponse 200 { data: { tokens: IamApiTokenRecord[] }; meta }
| stable | 200 | ||||||||||
| POST | /v1/accounts/{accountId}/api-tokensRequest body TokenCreateBody
Response 201 { data: { token: IamApiTokenRecord; secret: string }; meta }
| stable | 201 | ||||||||||
| DELETE | /v1/accounts/{accountId}/api-tokens/{apiKeyId}Response 200 { data: { token: IamApiTokenRecord; transitioned: boolean }; meta }
| stable | 200 |
Import · 3 routes
| Method | Path | Tier | 2xx | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/import/applyRequest body ApplyBody
Response 200 { data: { result: ApplyImportPlanResult }; meta }
| stable | 200 | ||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/import/inspectRequest body InspectBody
Response 200 { data: { plan: KumoImportPlanV1 }; meta }
| stable | 200 | ||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/import/jobsRequest body ApplyBody
Response 202 { data: { jobId: string; statusPath: string }; meta }
| stable | 202 |
Notification subscriptions · 3 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/notification-subscriptionsQuery
Response 200 { data: { subscriptions: NotificationSubscriptionDto[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/notification-subscriptionsRequest body SubscriptionCreateBody
Response 201 { data: NotificationSubscriptionDto; meta }
| stable | 201 | ||||||||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/notification-subscriptions/{subscriptionId}Response 200 { data: { deleted: boolean }; meta }
| stable | 200 |
Provider scope bindings · 3 routes
| Method | Path | Tier | 2xx | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/provider-scope-bindingsQuery
Response 200 { data: ListProviderScopeBindingsHttpResponseItem[]; page; meta }
| stable | 200 | ||||||||||||
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/provider-scope-bindingsRequest body CreateBindingBody
Response 201 { data: CreateProviderScopeBindingHttpResponse; meta }
| stable | 201 | ||||||||||||
| DELETE | /v1/accounts/{accountId}/workspaces/{workspaceId}/provider-scope-bindings/{bindingId}Response 204 no body | stable | 204 |
Role assignments · 3 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/role-assignmentsQuery
Response 200 { data: IamRoleAssignmentRecord[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/role-assignmentsRequest body AssignBody
Response 201 { data: { assignment: IamRoleAssignmentRecord; created: boolean }; meta }
| stable | 201 | ||||||||||||||||||||||||||
| DELETE | /v1/accounts/{accountId}/role-assignments/{assignmentId}Response 200 { data: { assignment: IamRoleAssignmentRecord; transitioned: boolean }; meta }
| stable | 200 |
Alerts · 2 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/alertsQuery
Response 200 { data: AlertDto[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||
| POST | /v1/accounts/{accountId}/alerts/acknowledgeRequest body AlertAcknowledgeBody
Response 200 { data: AlertDto; meta }
| stable | 200 |
Auth policy · 2 routes
| Method | Path | Tier | 2xx | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/auth-policyResponse 200 { data: AuthAccountPolicyGetResult; meta }
| stable | 200 | ||||||||||
| PUT | /v1/accounts/{accountId}/auth-policyRequest body PolicyBody
Response 200 { data: AuthAccountPolicyGetResult; meta }
| stable | 200 |
Events · 2 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/events/streamQuery
Response 200 text/event-stream (file or stream) | stable | 200 | ||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/events/streamQuery
Response 200 text/event-stream (file or stream) | stable | 200 |
Graph revisions · 2 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/graph-revisionsQuery
Response 200 { data: ListWorkspaceGraphRevisionsHttpResponseItem[]; page; meta }
| stable | 200 | ||||||||||||||||||||
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/graph-revisions/{wgrId}Response 200 { data: GetWorkspaceGraphRevisionHttpResponse; meta }
| stable | 200 |
Notification preferences · 2 routes
| Method | Path | Tier | 2xx | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/notification-preferencesQuery
Response 200 { data: { preferences: NotificationPreferenceDto[] }; meta }
| stable | 200 | ||||||||||||
| PUT | /v1/accounts/{accountId}/notification-preferencesRequest body PreferencesUpdateBody
Response 200 { data: { preferences: NotificationPreferenceDto[] }; meta }
| stable | 200 |
Ops · 2 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/ops/pipeline-runsQuery
Response 200 { data: PipelineRunHttpSummaryItem[]; page; meta }
| internal | 200 | ||||||||||||||||||||||||||
| GET | /v1/ops/pipeline-runs/{pipelineRunId}Response 200 { data: GetPipelineRunHttpResponse; meta }
| internal | 200 |
Shared views · 2 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/shared-viewsResponse 200 { data: ViewAccessGrantsReceivedListResult; meta }
| stable | 200 | ||
| GET | /v1/accounts/{accountId}/shared-views/{grantId}/renderQuery
Response 200 */* (file or stream) | stable | 200 |
Template overrides · 2 routes
| Method | Path | Tier | 2xx | ||||||
|---|---|---|---|---|---|---|---|---|---|
| DELETE | /v1/accounts/{accountId}/template-overrides/{templateKey}Response 200 { data: ClearAccountTemplateOverrideHttpResponse; meta }
| stable | 200 | ||||||
| POST | /v1/accounts/{accountId}/template-overrides/{templateKey}Request body
Response 200 { data: SetAccountTemplateOverrideHttpResponse; meta }
| stable | 200 |
Access · 1 routes
| Method | Path | Tier | 2xx | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/accessQuery
Response 200 { data: WorkspaceAccessDto; meta }
| stable | 200 |
Audit log · 1 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/audit-logQuery
Response 200 { data: TenantAuditRecordDto[]; page; meta }
| stable | 200 |
Compactions · 1 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/compactionsRequest body CompactionBody
Response 200 { data: CompactRevisionsHttpResponse; meta }
| stable | 200 |
Connections · 1 routes
| Method | Path | Tier | 2xx | ||||||
|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/connections/{connectionId}Query
Response 200 { data: GetConnectionAtRevisionHttpResponse; meta?: map<string, any> } | { data: GetConnectionAtTimestampHttpResponse; meta?: map<string, any> } | stable | 200 |
Credential health · 1 routes
| Method | Path | Tier | 2xx |
|---|---|---|---|
| GET | /v1/accounts/{accountId}/credential-health/reports/{reportId}Response 200 { data: null; meta?: map<string, any> } | { data: CredentialHealthReportDto; meta?: map<string, any> } | stable | 200 |
Embed · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /embed/{token}Query
Response 200 text/html; charset=utf-8 (file or stream) | stable | 200 |
Environment query · 1 routes
| Method | Path | Tier | 2xx | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/environment-query/previewRequest body EnvironmentQueryPreviewBody
Response 200 { data: EnvironmentQueryPreviewHttpResponse; meta }
| stable | 200 |
Features · 1 routes
| Method | Path | Tier | 2xx | ||||||
|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/featuresResponse 200 { data: TenantFeaturesResponseDto; meta }
| stable | 200 |
Healthz · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/healthzResponse 200
| stable | 200 |
Invites · 1 routes
| Method | Path | Tier | 2xx | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| POST | /v1/accounts/{accountId}/invitesRequest body InviteBody
Response 201 { data: AuthInviteCreateResult; meta }
| stable | 201 |
Lineage · 1 routes
| Method | Path | Tier | 2xx | ||||
|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/lineage/{subjectKind}/{subjectId}Response 200 { data: GraphDiffLineageChainDto; meta }
| stable | 200 |
Members · 1 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/membersQuery
Response 200 { data: AccountMemberSummary[]; page; meta }
| stable | 200 |
Notification test · 1 routes
| Method | Path | Tier | 2xx | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| POST | /v1/accounts/{accountId}/notification-testRequest body TestSendBody
Response 200 { data: { status?: "delivered" | "permanent_failure" | "retryable_failure"; sent: boolean }; meta }
| stable | 200 |
Partner branding · 1 routes
| Method | Path | Tier | 2xx | ||||
|---|---|---|---|---|---|---|---|
| GET | /v1/partner-brandingQuery
Response 200 { data: PartnerBrandingResolveResult; meta }
| experimental | 200 |
Permission catalog · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/permission-catalogResponse 200 { data: { permissions: IamPermissionRecord[] }; meta }
| stable | 200 |
Providers · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/providers/aws/ambient-identityResponse 200 { data: { identity: any }; meta }
| stable | 200 |
Readyz · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/readyzResponse 200
| stable | 200 |
Resource attribute values · 1 routes
| Method | Path | Tier | 2xx | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/resource-attribute-valuesQuery
Response 200 { data: ResourceAttributeValuesListHttpResponse; meta }
| stable | 200 |
Retention applications · 1 routes
| Method | Path | Tier | 2xx | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/retention-applicationsRequest body RetentionApplicationBody
Response 200 { data: ApplyRetentionPoliciesHttpResponse; meta }
| stable | 200 |
Share · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /share/{token}Query
Response 200 */* (file or stream) | stable | 200 |
Source model · 1 routes
| Method | Path | Tier | 2xx | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/workspaces/{workspaceId}/source-modelQuery
Response 200 { data: WorkspaceSourceModelBuildHttpResponse; meta }
| stable | 200 |
Unarchive · 1 routes
| Method | Path | Tier | 2xx | ||||
|---|---|---|---|---|---|---|---|
| POST | /v1/accounts/{accountId}/workspaces/{workspaceId}/unarchiveResponse 200 { data: WorkspaceUnarchiveResult; meta }
| stable | 200 |
Version · 1 routes
| Method | Path | Tier | 2xx | ||||
|---|---|---|---|---|---|---|---|
| GET | /v1/versionResponse 200
| stable | 200 |
Views · 1 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/viewsQuery
Response 200 { data: ViewByAccountItemDto[]; page; meta }
| stable | 200 |
Webhook event types · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/accounts/{accountId}/webhook-event-typesResponse 200 { data: WebhookEventTypeListResult; meta }
| stable | 200 |
Schemas · 740 types
AccountCostSubject
| kind | "account" |
| provider | string | null |
| providerAccountId | string |
AccountId
string
AccountMemberSummary
| userId | string |
| displayName | string |
| string | null | |
| membershipKind | string |
| status | string |
| invitedAt | string | null |
| acceptedAt | string | null |
| createdAt | string | null |
AcsBody
| SAMLResponse? | string |
| RelayState? | string |
AdapterDiagnosticSeverity
"error" | "fatal" | "info" | "warning"
AdjacencyEntry
| resourceId | ResourceId |
| workspaceId | WorkspaceId |
| revisionId | WorkspaceGraphRevisionId |
| outbound | AdjacentNeighbor[] |
| inbound | AdjacentNeighbor[] |
AdjacentNeighbor
| connectionId | ConnectionId |
| otherResourceId | ResourceId |
| connectionType | string |
AlertAcknowledgeBody
| dedupKey? | string |
| status? | "acknowledged" | "active" |
AlertDto
| ruleId | string |
| ruleName | string |
| accountId | string |
| workspaceId | string | null |
| source | string |
| severity | Severity |
| subjectLabel | string |
| kind | string |
| category | string | null |
| dedupKey | string |
| firedAt | string | null |
| status | string |
| acknowledgedAt | string | null |
| acknowledgedBy | string | null |
AlertNotificationSubject
| kind | "alert" |
| workspaceId? | WorkspaceId |
| alertId | string |
| displayName | string |
AlertRuleCondition
| minSeverity? | "critical" | "high" | "info" | "low" | "medium" |
| sources? | AlertSignalSource[] |
| categories? | string[] |
| kinds? | string[] |
| kindPrefixes? | string[] |
| semanticTypes? | string[] |
| services? | string[] |
AlertRuleConditionDto
| minSeverity? | "critical" | "high" | "info" | "low" | "medium" |
| sources? | string[] |
| categories? | string[] |
| kinds? | string[] |
| kindPrefixes? | string[] |
| semanticTypes? | string[] |
| services? | string[] |
AlertRuleDto
| ruleId | string |
| accountId | string |
| workspaceId | string | null |
| name | string |
| enabled | boolean |
| condition | AlertRuleConditionDto |
| severity? | "critical" | "high" | "info" | "low" | "medium" |
AlertSignalSource
"cost_anomaly" | "credential_health" | "graph_diff"
AlertTargetDto
| targetId | string |
| accountId | string |
| workspaceId | string | null |
| name | string |
| enabled | boolean |
| channel | string |
| destinationRedacted | string |
| minSeverity? | "critical" | "high" | "info" | "low" | "medium" |
AlertTargetTestResult
| delivered | boolean |
| error? | string |
AllocationRunBody
| window? | { startInclusive?: string; endExclusive?: string } |
| currency? | string |
| includeEstimates? | boolean |
AllocationStatus
"allocated" | "direct" | "shared" | "unallocated" | "unknown"
Annotation
| id | AnnotationId |
| accountId | AccountId |
| workspaceId | WorkspaceId |
| surface | AnnotationSurface |
| body | AnnotationBody |
| authorId | string |
| createdAt | string |
| updatedAt | string |
AnnotationBody
object | object
AnnotationId
string
AnnotationSurface
| kind | "environment" | "view" |
| id | string |
ApiTokenScope
"read" | "read_write"
ApplyActionOutcome
| actionId | string |
| status | "created" | "failed" | "rejected" | "skipped" | "updated" |
| error? | string |
ApplyBody
| idempotencyKey? | string |
| archive? | string |
| conflictMode? | string |
ApplyImportPlanResult
| ok | boolean |
| created | number |
| updated | number |
| skipped | number |
| rejected | number |
| failed | number |
| outcomes | ApplyActionOutcome[] |
| rejectedReason? | string |
| commitError? | string |
ApplyRetentionPoliciesHttpResponse
| policies | RetentionPolicyHttpItem[] |
| candidates | RetentionCandidateHttpItem[] |
| compactionOutcomes | RetentionCompactionOutcomeHttpItem[] |
AssignBody
| roleId? | string |
| principalId? | string |
| principalKind? | string |
| workspaceId? | string |
| expiresAt? | string |
AuthAccountPolicyGetResult
| requireMfa | boolean |
| requireSso | boolean |
| ssoEnforced | boolean |
AuthEmailVerifyResendResult
| accepted | true |
AuthEmailVerifyResult
| verified | true |
AuthInviteCreateResult
| inviteToken | string |
| expiresAt | string |
| mailSent | boolean |
AuthMfaDisableResult
| disabled | true |
AuthMfaEnrollStartResult
| secretBase32 | string |
| otpauthUri | string |
AuthOidcConfigView
| accountId | AccountId |
| issuer | string |
| clientId | string |
| hasClientSecret | boolean |
| scopes | string[] |
| emailClaim | string |
| status | "active" | "disabled" |
| updatedAt | string (date-time) |
AuthPasswordChangeResult
| changed | true |
| otherSessionsRevoked | number |
AuthPasswordResetConfirmResult
| reset | true |
AuthPasswordResetRequestResult
| accepted | true |
AuthRecoveryCodesRegenerateResult
| recoveryCodes | string[] |
AuthSessionGrantWire
object | object
AuthSessionRevokeResult
| revoked | boolean |
AuthSessionSummaryWire
| id | string |
| current | boolean |
| createdAt | string |
| lastSeenAt | string |
| expiresAt | string |
| methods | string[] |
AwsPendingExternalIdEnsureResult
| externalId | string |
| origin | "existing" | "minted" |
BillingEntitlementKind
"boolean" | "duration_days" | "enum" | "json_policy" | "metered_budget" | "quantity" | "rate_limit" | "storage_bytes"
BillingEntitlementRecord
| featureKey | string |
| kind | BillingEntitlementKind |
| scope | BillingEntitlementScope |
| value | boolean | string | number | map<string, any> |
| softLimit | number | null |
| hardLimit | number | null |
| resetPeriod | BillingEntitlementResetPeriod |
| status | "allowed" | "conflicted" | "denied" | "expired" | "license_blocked" | "limited" | "not_configured" | "subscription_inactive" | "trial_withheld" | "unknown_feature" | null |
| source | "account_override" | "addon" | "deployment_license" | "deployment_profile" | "internal_default" | "migration_legacy" | "plan_version" | "subscription" | "support_override" | "trial" | "workspace_override" | null |
BillingEntitlementResetPeriod
"billing_period" | "day" | "hour" | "month" | "none"
BillingEntitlementScope
"account" | "provider" | "source" | "tenant" | "workspace"
BillingExportsDto
| workspaceId | string |
| sourceId | string |
| status | "discovered" | "unavailable" | "unknown" | "unsupported" |
| exports | DiscoveredBillingExportDto[] |
| notes | string[] |
| observedAt | string | null |
| stale | boolean |
| adopted | { name: string; bucket: string; adoptedAt: string } | null |
| generatedAt | string |
BillingExportsIngestQueuedDto
| workspaceId | string |
| jobId | string |
| queuedAt | string |
| alreadyQueued | boolean |
BillingExportsListDto
| workspaceId | string |
| items | BillingExportsDto[] |
| generatedAt | string |
BillingQuotaDecisionKind
"allow" | "allow_with_warning" | "billing_unavailable" | "deny" | "unknown_feature" | "unknown_subject"
BillingQuotaDecisionRecord
| kind | BillingQuotaDecisionKind |
| featureKey | string |
| subject | BillingQuotaSubjectRecord |
| requestedQuantity | number |
| currentUsage | number | null |
| softLimit | number | null |
| hardLimit | number | null |
| resetAt | string | null |
| reason | string |
| reasonCode | string | null |
| evaluatedAt | string |
BillingQuotaSubjectRecord
| accountId | AccountId |
| workspaceId | WorkspaceId | null |
| scope | BillingEntitlementScope |
BillingSubscriptionRecord
| id | string |
| accountId | AccountId |
| billingCustomerId | string |
| planId | string |
| planName | string | null |
| planKey | string | null |
| planVersionId | string |
| provider | string |
| status | BillingSubscriptionStatus |
| currentPeriodStart | string | null |
| currentPeriodEnd | string | null |
| cancelAtPeriodEnd | boolean |
| trialEndsAt | string | null |
| createdAt | string |
| updatedAt | string |
| endedAt | string | null |
BillingSubscriptionStatus
"active" | "cancelled" | "expired" | "incomplete" | "past_due" | "paused" | "suspended" | "trialing"
BlastRadiusResultRef
| blastRadiusResultId | string |
CancelBody
| reason? | string |
CancelOperationHttpResponse
| id | string |
| type | "operation" |
| operationType | string |
| status | string |
| target | { type: string; id: string } |
| result | map<string, any> | null |
| createdAt | string |
| startedAt | string | null |
| completedAt | string | null |
ChangeAtom
| id | ChangeAtomId |
| subject | ChangeSubject |
| kind | ChangeAtomKind |
| fieldPath | string | null |
| before | RedactedChangeValue |
| after | RedactedChangeValue |
| rawDiffRef | RawDiffRef |
| evidenceRefs | ChangeEvidenceRef[] |
| detectedAt | string |
ChangeAtomId
string
ChangeAtomKind
"authority_value_changed" | "connection_added" | "connection_field_changed" | "connection_removed" | "hierarchy_changed" | "membership_changed" | "observation_changed" | "resource_added" | "resource_field_changed" | "resource_removed"
ChangeCategory
"configuration" | "cost" | "desired_vs_actual" | "exposure" | "ownership" | "reliability" | "security" | "structural"
ChangeCause
| kind | ChangeCauseKind |
| summary | string |
| confidence | ChangeConfidence |
| evidenceRefs | ChangeEvidenceRef[] |
| hypotheses | ChangeCauseHypothesis[] |
ChangeCauseHypothesis
| kind | ChangeCauseKind |
| summary | string |
| confidence | number |
| evidenceRefs | ChangeEvidenceRef[] |
ChangeCauseKind
"authority_rule_change" | "derived_graph_rule_change" | "desired_state_change" | "enrichment_change" | "identity_canonicalization_change" | "manual_change" | "provider_coverage_change" | "provider_sync" | "source_observed" | "unknown"
ChangeConfidence
| score | number |
| level | ChangeConfidenceLevel |
| reasons | ChangeConfidenceReason[] |
ChangeConfidenceLevel
"high" | "low" | "medium"
ChangeConfidenceReason
| message | string |
| contribution | number |
| evidenceRefs | ChangeEvidenceRef[] |
ChangeCorrelationSearchResult
| window | { since: string | null; until: string | null } |
| items | ChangeItem[] |
ChangeDiagnostic
| code | string |
| message | string |
| severity | "error" | "info" | "warning" |
ChangeDigest
| mode | ChangeDigestMode |
| workspaceId | WorkspaceId |
| window | { since: string | null; until: string | null } |
| title | string |
| headline | string |
| totalChanges | number |
| bySeverity | { info: number; low: number; medium: number; high: number; critical: number } |
| byCategory | { configuration: number; cost: number; security: number; exposure: number; reliability: number; ownership: number; structural: number; desired_vs_actual: number } |
| highlights | ChangeDigestHighlight[] |
| generatedAt | string |
ChangeDigestBuildResult
| digest | ChangeDigest |
ChangeDigestHighlight
| changeId | ChangeItemId |
| severity | Severity |
| category | ChangeCategory |
| title | string |
| subjectKey | string |
ChangeDigestMode
"cost" | "daily_workspace" | "deployment" | "incident" | "security" | "source_sync" | "weekly_account"
ChangeEventBody
| eventSource | string |
| eventName | string |
| payload? | map<string, any> |
ChangeEventsIngestResult
| matchedEvents | number |
| unmatchedEvents | number |
| subjectIds | number |
| scopeRequests | number |
| enqueued | boolean |
ChangeEvidence
| id | ChangeEvidenceId |
| kind | ChangeEvidenceKind |
| sourceId? | SourceId |
| sourceSnapshotId? | SourceSnapshotId |
| sourceSyncRunId? | string |
| crawlResultId? | CrawlResultId |
| workspaceGraphRevisionId? | WorkspaceGraphRevisionId |
| resourceRevisionId? | ResourceRevisionId |
| connectionRevisionId? | ConnectionRevisionId |
| provider? | string |
| providerScopeId? | ProviderScopeId |
| observedAt | string | null |
| summary | string |
| confidence | number |
| redaction | ChangeEvidenceRedaction |
| metadata | map<string, any> |
ChangeEvidenceId
string
ChangeEvidenceKind
"authority_decision" | "connection_revision" | "derived_rule" | "external_event" | "graph_revision" | "lineage" | "provider_diagnostic" | "provider_observation" | "resource_revision" | "source_snapshot" | "source_sync_run" | "user_annotation"
ChangeEvidenceRedaction
| redacted | boolean |
| reason | string | null |
ChangeEvidenceRef
| evidenceId | ChangeEvidenceId |
| kind | ChangeEvidenceKind |
ChangeExplainResult
| found | boolean |
| change | ChangeItem | null |
| explanation | string[] |
| rawDiffRefs | RawDiffRef[] |
ChangeImpact
| score | number |
| level | Severity |
| dimensions | ChangeImpactDimensions |
| affected | ImpactedTarget[] |
| blastRadiusRef? | BlastRadiusResultRef |
| explanation | ChangeImpactReason[] |
ChangeImpactDimensions
| topology | number |
| security | number |
| reliability | number |
| cost | number |
| compliance | number |
| ownership | number |
| userFacing | number |
| operational | number |
ChangeImpactReason
| message | string |
| evidenceRefs | ChangeEvidenceRef[] |
ChangeIntelligenceAnalyzeResult
| workspaceId | WorkspaceId |
| window | ChangeWindow |
| summary | ChangeSummary |
| changes | ChangeItem[] |
| stories | ChangeStory[] |
| suppressed | SuppressedChange[] |
| diagnostics | ChangeDiagnostic[] |
| truncated | { analysed: number; shown: number } | null |
| generatedAt | string |
| analysisVersion | string |
| inputHash | string |
ChangeIntelligenceMaterializeResult
| result | ChangeIntelligenceAnalyzeResult |
| fromCache | boolean |
ChangeItem
| id | ChangeItemId |
| fingerprint | string |
| workspaceId | WorkspaceId |
| subject | ChangeSubject |
| title | string |
| summary | string |
| kind | string |
| category | ChangeCategory |
| atoms | ChangeAtom[] |
| evidence | ChangeEvidence[] |
| sourceAttribution | ChangeSourceAttribution |
| cause | ChangeCause |
| impact | ChangeImpact |
| severity | ChangeSeverity |
| confidence | ChangeConfidence |
| firstObservedAt | string |
| lastObservedAt | string |
| tags | string[] |
| warnings | ChangeWarning[] |
ChangeItemId
string
ChangeLens
"all" | "cost" | "drift" | "exposure" | "operations" | "ownership" | "reliability" | "security" | "topology" | "views"
ChangeNarrativeStep
| text | string |
| changeItemIds? | ChangeItemId[] |
| evidenceRefs? | ChangeEvidenceRef[] |
ChangeRecommendation
| title | string |
| detail | string | null |
| priority | "high" | "low" | "medium" |
| relatedChangeIds? | ChangeItemId[] |
ChangeSeverity
| level | Severity |
| score | number |
| reasons | ChangeSeverityReason[] |
ChangeSeverityReason
| code | ChangeSeverityReasonCode |
| message | string |
| contribution | number |
| evidenceRefs | ChangeEvidenceRef[] |
ChangeSeverityReasonCode
"CONFIGURATION_CHANGED" | "COST_RISK_INCREASED" | "CRITICAL_DEPENDENCY_CHANGED" | "DATABASE_CONFIGURATION_CHANGED" | "DESIRED_STATE_DIVERGED" | "DOWNSTREAM_BLAST_RADIUS_HIGH" | "EXPECTED_CHANGE" | "IDENTITY_PERMISSION_EXPANDED" | "LOW_IMPACT_FIELD" | "MONITORING_COVERAGE_DECREASED" | "OWNER_REMOVED" | "PRODUCTION_RESOURCE_REMOVED" | "PUBLIC_EXPOSURE_INCREASED" | "SECURITY_POLICY_WIDENED" | "TOPOLOGY_CHANGED"
ChangeSourceAttribution
| attributionClass | string |
| sourceId? | SourceId |
| sourceSyncRunId? | string |
| providerScopeId? | ProviderScopeId |
| provider? | string |
| multiSourceCorroborated | boolean |
| observedAt | string | null |
ChangeStory
| id | ChangeStoryId |
| workspaceId | WorkspaceId |
| window | ChangeWindow |
| title | string |
| summary | string |
| narrative | ChangeNarrativeStep[] |
| primaryChangeIds | ChangeItemId[] |
| relatedChangeIds | ChangeItemId[] |
| severity | ChangeSeverity |
| confidence | ChangeConfidence |
| impact | ChangeImpact |
| evidenceRefs | ChangeEvidenceRef[] |
| recommendedNextActions | ChangeRecommendation[] |
| generatedAt | string |
ChangeStoryId
string
ChangeSubject
ResourceChangeSubject | ConnectionChangeSubject | WorkspaceChangeSubject | SourceChangeSubject | EnvironmentChangeSubject | ViewChangeSubject | PolicyChangeSubject
ChangeSummary
| totalChanges | number |
| totalSuppressed | number |
| addedResources | number |
| removedResources | number |
| changedResources | number |
| addedConnections | number |
| removedConnections | number |
| changedConnections | number |
| bySeverity | { info: number; low: number; medium: number; high: number; critical: number } |
| byCategory | { configuration: number; cost: number; security: number; exposure: number; reliability: number; ownership: number; structural: number; desired_vs_actual: number } |
| headline | string |
| bullets | string[] |
| highestSeverity | "critical" | "high" | "info" | "low" | "medium" | null |
| highestImpactScore | number |
ChangeWarning
| code | ChangeWarningCode |
| message | string |
| severity | "info" | "warning" |
ChangeWarningCode
"LOW_CONFIDENCE" | "NON_AUTHORITATIVE_SOURCE" | "PARTIAL_COVERAGE" | "PROVIDER_DIAGNOSTIC" | "REDACTED_EVIDENCE" | "SUPPRESSED_NOISE"
ChangeWindow
| workspaceId | WorkspaceId |
| fromWorkspaceGraphRevisionId | WorkspaceGraphRevisionId |
| toWorkspaceGraphRevisionId | WorkspaceGraphRevisionId |
| fromTimestamp | string | null |
| toTimestamp | string | null |
| label? | string |
ChargeType
"credit" | "discount" | "marketplace" | "other" | "refund" | "reservation_fee" | "savings_plan_fee" | "support" | "tax" | "usage"
ClearAccountTemplateOverrideHttpResponse
| templateKey | string |
ClearViewTemplateOverrideHttpResponse
| viewId | string |
CompactRevisionsCandidateHttpItem
| kind | string |
| entityId | string |
| revisionId | string |
| validFrom | string |
| validTo | string | null |
CompactRevisionsHttpResponse
| workspaceId | string |
| cutoff | string |
| minimumKept | number |
| applied | boolean |
| candidates | CompactRevisionsCandidateHttpItem[] |
| compactedResourceRevisionCount | number |
| compactedConnectionRevisionCount | number |
CompactionBody
| cutoff? | string |
| minimumKept? | number |
| apply? | boolean |
ConfigurationCreateBody
| displayName? | string |
| serviceProvider? | SamlServiceProviderConfig |
| identityProvider? | SamlIdentityProviderConfig |
| attributeMapping? | SamlAttributeMapping |
| provisioningPolicy? | SamlProvisioningPolicy |
| securityPolicy? | SamlSecurityPolicy |
ConfigurationUpdateBody
| displayName? | string |
| serviceProvider? | SamlServiceProviderConfig |
| identityProvider? | SamlIdentityProviderConfig |
| attributeMapping? | SamlAttributeMapping |
| provisioningPolicy? | SamlProvisioningPolicy |
| securityPolicy? | SamlSecurityPolicy |
ConnectBody
| provider? | string |
| providerKey? | string |
| credentialKind? | string |
| displayName? | string |
| secretMaterial? | string |
| credentialId? | string |
| scopeIdentifier? | string |
| discoveryParameters? | map<string, any> |
| startSync? | boolean |
Connection
ConnectionChangeSubject
| kind | "connection" |
| connectionId | ConnectionId |
| connectionType | string |
| sourceResourceId? | ResourceId |
| targetResourceId? | ResourceId |
| sourceDisplayName? | string | null |
| targetDisplayName? | string | null |
ConnectionCostSubject
| kind | "connection" |
| connectionId | ConnectionId |
| connectionType | string | null |
ConnectionDto
| id | string |
| connectionType | string |
| fromResourceId | string |
| toResourceId | string |
ConnectionId
string
ConnectionObservationId
string
ConnectionRevisionId
string
ContextEdgeId
ContextFrontierEntry
| fromSemanticType | string |
| toSemanticType | string |
| connectionType | string |
| direction | "in" | "out" |
| resourceCount | number |
ContextFrontierResolveBody
| contextQuery? | any |
| parameters? | map<string, any> |
| environmentRevisionId? | string |
| limit? | number |
ContextFrontierResolveResult
| entries | ContextFrontierEntry[] |
| memberCount | number |
| truncated | boolean |
| diagnostics | string[] |
ContextNodeId
ContextNotificationSubject
| kind | "context" |
| workspaceId | WorkspaceId |
| contextId | string |
| displayName | string |
ContextQueryEvaluateBody
| contextQuery? | any |
| parameters? | map<string, any> |
| environmentRevisionId? | string |
ContextQueryEvaluateConnectionRow
| id | ContextEdgeId |
| connectionType | string |
| fromResourceId | ContextNodeId |
| toResourceId | ContextNodeId |
| virtual? | true |
ContextQueryEvaluateResourceRow
| id | ContextNodeId |
| role | ContextResourceRole |
| semanticType | string |
| displayName | string |
| parentId? | ResourceId | ScopeNodeId |
| container? | boolean |
| virtual? | true |
ContextQueryEvaluateResult
| environmentId | EnvironmentId |
| environmentRevisionId | EnvironmentRevisionId |
| workspaceId | WorkspaceId |
| workspaceGraphRevisionId | WorkspaceGraphRevisionId |
| targetCount | number |
| resourceCount | number |
| connectionCount | number |
| roleCounts | map<string, number> |
| resources | ContextQueryEvaluateResourceRow[] |
| connections | ContextQueryEvaluateConnectionRow[] |
| trace | QueryExplainStep[] |
| diagnostics | string[] |
| contextResultHash | string |
| structure? | { scopes: "account" | "provider" | "region" | null; parentCount: number; containerCount: number; scopeNodeCount: number } |
ContextResourceRole
"aggregated" | "decorative_context" | "hidden_support" | "optional_context" | "required_context" | "target" | "user_added_context"
ContextSourceModelBuildBody
| contextQuery? | any |
| parameters? | map<string, any> |
| environmentRevisionId? | string |
| hierarchyStyle? | "containment" | "membership" |
ContextSourceModelBuildResult
| environmentId | EnvironmentId |
| environmentRevisionId | EnvironmentRevisionId |
| workspaceId | WorkspaceId |
| workspaceGraphRevisionId | WorkspaceGraphRevisionId |
| resourceCount | number |
| connectionCount | number |
| sourceModel | SourceModel |
| contextResultHash | string |
| diagnostics | string[] |
CorrelateBody
| anchor? | string |
| radiusMinutes? | number |
| since? | string |
| until? | string |
| severities? | Severity[] |
| categories? | ChangeCategory[] |
| subjectKinds? | "connection" | "environment" | "policy" | "resource" | "source" | "view" | "workspace"[] |
| resourceIds? | string[] |
| tags? | string[] |
| limit? | number |
CostAllocationMethod
"custom_expression" | "direct_owner" | "environment" | "equal_split" | "provider_scope" | "resource_owner" | "tag_value" | "weighted_by_cost" | "weighted_by_resource_count" | "weighted_by_usage"
CostAllocationRule
| id | CostAllocationRuleId |
| workspaceId | WorkspaceId |
| version | number |
| name | string |
| description? | string |
| selector | CostSubjectSelector |
| allocateTo | CostAllocationTarget |
| method | CostAllocationMethod |
| splitTargets? | CostAllocationTarget[] |
| priority | number |
| effectiveFrom | string |
| effectiveTo | string | null |
| createdBy | kumo-cost-analysis.ActorRef |
| createdAt | string |
CostAllocationRuleId
string
CostAllocationRulesListResult
| items | CostAllocationRule[] |
CostAllocationRun
| id | CostAllocationRunId |
| workspaceId | WorkspaceId |
| window | CostWindow |
| ruleVersionsApplied | { ruleId: CostAllocationRuleId; version: number; matchedLineCount: number }[] |
| allocatedTotal | Money |
| unallocatedTotal | Money |
| diagnostics | CostDiagnostic[] |
| executedAt | string |
| executedBy | kumo-cost-analysis.ActorRef |
CostAllocationRunId
string
CostAllocationRunResult
| run | CostAllocationRun |
| diagnostics | CostDiagnostic[] |
CostAllocationTarget
object | object | object | object | object
CostAssumption
| key | string |
| description | string |
| value | string |
CostBasis
"actual_amortized" | "actual_blended" | "actual_net_unblended" | "actual_public_on_demand" | "actual_unblended" | "allocated" | "estimated_rate_card" | "estimated_usage_based" | "forecast"
CostChangeAnalyzeResult
| workspaceId | WorkspaceId |
| window | CostWindow |
| comparisonWindow | CostWindow |
| currency | string |
| totalBefore | MoneyOrRedacted |
| totalAfter | MoneyOrRedacted |
| deltas | CostChangeDelta[] |
| anomalousCount | number |
| diagnostics | CostDiagnostic[] |
| generatedAt | string |
CostChangeClassification
"anomalous" | "expected" | "unknown"
CostChangeDelta
| groupKey | string |
| displayName | string | null |
| subject | ResourceCostSubject | ConnectionCostSubject | WorkspaceCostSubject | EnvironmentCostSubject | ProviderScopeCostSubject | SourceCostSubject | OwnerCostSubject | TeamCostSubject | ServiceCostSubject | TagCostSubject | AccountCostSubject | null |
| before | Money |
| after | Money |
| delta | Money |
| deltaPct | number | null |
| classification | CostChangeClassification |
| drivers | CostChangeDriver[] |
| evidence | CostEvidence[] |
CostChangeDriver
| kind | CostChangeDriverKind |
| summary | string |
CostChangeDriverKind
"allocation" | "discount" | "price" | "topology" | "unknown" | "usage"
CostConfidence
| score | number |
| level | CostConfidenceLevel |
| reasons | CostConfidenceReason[] |
CostConfidenceLevel
"high" | "low" | "medium"
CostConfidenceReason
"actual_aggregate" | "actual_line_item" | "allocation_fallback" | "allocation_rule_specific" | "attribute_incomplete" | "coverage_partial" | "currency_converted" | "estimate_only" | "forecast_high_variance" | "forecast_short_training_window" | "manual_override" | "price_catalog_stale" | "price_match_exact" | "price_match_generic_fallback" | "price_match_multiple_candidates" | "price_match_partial" | "usage_assumed" | "usage_measured" | "usage_metric_missing"
CostCoverageResult
| workspaceId | WorkspaceId |
| window | CostWindow |
| resourceCount | number |
| resourcesWithActuals | number |
| resourcesWithEstimates | number |
| unpricedResourceCount | number |
| actualCoverageRatio | number |
| providersWithActuals | string[] |
| evidence | CostEvidence[] |
CostDiagnostic
| severity | "error" | "info" | "warning" |
| code | CostDiagnosticCode |
| message | string |
| subject? | ResourceCostSubject | ConnectionCostSubject | WorkspaceCostSubject | EnvironmentCostSubject | ProviderScopeCostSubject | SourceCostSubject | OwnerCostSubject | TeamCostSubject | ServiceCostSubject | TagCostSubject | AccountCostSubject |
| evidence? | CostEvidence[] |
CostDiagnosticCode
"ALLOCATION_METHOD_UNSUPPORTED" | "ALLOCATION_RULE_CONFLICT" | "ANALYSIS_NOT_AVAILABLE" | "BILLING_EXPORT_CORRECTION_DETECTED" | "COST_FACT_INVALID" | "COST_FACT_REDACTED" | "COST_LIMIT_REACHED" | "CURRENCY_RATE_MISSING" | "FORECAST_LOW_CONFIDENCE" | "MULTIPLE_PRICE_MATCHES" | "NO_ACTUAL_COST_DATA" | "OWNER_UNKNOWN" | "PARTIAL_COST_COVERAGE" | "PRICE_CATALOG_EMPTY" | "PRICE_CATALOG_STALE" | "PRICE_MATCH_NOT_FOUND" | "PRICING_UNIT_UNSUPPORTED" | "RESOURCE_SIZE_MISSING" | "RESOURCE_UNALLOCATED" | "SYNTHETIC_COST_DATA" | "USAGE_METRIC_MISSING" | "USAGE_METRIC_UNAVAILABLE"
CostEstimateMethod
"last_actual_run_rate" | "manual_override" | "provider_estimate" | "rate_card_projection" | "unknown" | "usage_projection"
CostEvidence
| id | CostEvidenceId |
| kind | CostEvidenceKind |
| sourceId? | SourceId |
| provider? | string |
| providerAccountId? | string |
| providerScopeId? | ProviderScopeId |
| priceCatalogItemId? | PriceCatalogItemId |
| costIngestionRunId? | CostIngestionRunId |
| resourceId? | ResourceId |
| resourceRevisionId? | ResourceRevisionId |
| workspaceGraphRevisionId? | WorkspaceGraphRevisionId |
| summary | string |
| observedAt | string | null |
| confidence | number |
| redaction | CostEvidenceRedaction |
| metadata | map<string, any> |
CostEvidenceId
string
CostEvidenceKind
"allocation_rule" | "assumption" | "billing_export_aggregate" | "billing_export_line_item" | "currency_rate" | "discount_contract" | "forecast_model" | "manual_adjustment" | "ownership_mapping" | "price_catalog_item" | "provider_cost_api_result" | "resource_attribute_match" | "usage_metric"
CostEvidenceRedaction
| state | "clear" | "redacted" |
| reason | "not_authorized" | "policy" | "sensitive" | null |
CostForecast
| id | CostForecastId |
| workspaceId | WorkspaceId |
| subject | CostSubject |
| generatedAt | string |
| trainingWindow | CostWindow |
| forecastWindow | CostWindow |
| method | ForecastMethod |
| points | ForecastPoint[] |
| total | Money |
| confidence | CostConfidence |
| assumptions | CostAssumption[] |
CostForecastGenerateResult
| forecast | CostForecast |
| diagnostics | CostDiagnostic[] |
CostForecastId
string
CostGroupBy
"application" | "cost_center" | "custom" | "environment" | "owner" | "provider" | "provider_account" | "provider_scope" | "region" | "resource" | "resource_type" | "service" | "source" | "tag" | "team" | "workspace"
CostIngestionRunId
string
CostNotificationSubject
| kind | "cost" |
| workspaceId? | WorkspaceId |
| scope | string |
| displayName | string |
CostOverlay
| workspaceId | WorkspaceId |
| window | CostWindow |
| currency | string |
| nodes | object |
| legend | CostOverlayLegendItem[] |
| cacheKey | string |
| generatedAt | string |
| diagnostics | CostDiagnostic[] |
CostOverlayBadgeKind
"cost" | "cost_delta" | "recommendation" | "top_cost" | "unallocated" | "waste"
CostOverlayLegendItem
| kind | CostOverlayBadgeKind |
| label | string |
| count | number |
CostOwner
| ownerKey | string |
| kind | "cost_center" | "service" | "team" | "unknown" | "user" |
| displayName | string | null |
CostProvenance
| sourceKind | "allocation" | "billing_export" | "cost_api" | "estimate" | "manual" | "synthetic" | "unknown" |
| sourceRef | string | null |
| ingestionRunId | CostIngestionRunId | null |
| importedAt | string | null |
| correctionOf | ResourceCostFactId | null |
CostRecommendation
| id | CostRecommendationId |
| workspaceId | WorkspaceId |
| subject | CostSubject |
| kind | CostRecommendationKind |
| title | string |
| summary | string |
| estimatedMonthlySavings | Money | null |
| implementationRisk | "high" | "low" | "medium" | "unknown" |
| reversibility | "easy" | "hard" | "moderate" | "unknown" |
| confidence | CostConfidence |
| evidence | CostEvidence[] |
| assumptions | CostAssumption[] |
| actions | CostRecommendationAction[] |
| status | CostRecommendationStatus |
| createdAt | string |
CostRecommendationAction
| kind | "cli_hint" | "manual_step" | "review" |
| description | string |
| requiresHumanValidation | boolean |
CostRecommendationId
string
CostRecommendationKind
"assign_owner" | "budget_adjustment" | "buy_commitment" | "change_storage_tier" | "consolidate_resource" | "delete_unused_resource" | "manual_review" | "move_region" | "reduce_commitment" | "resize_resource" | "review_anomaly" | "tag_resource"
CostRecommendationStatus
"accepted" | "dismissed" | "expired" | "implemented" | "proposed"
CostReport
| id | CostReportId |
| workspaceId | WorkspaceId |
| kind | CostReportKind |
| title | string |
| window | CostWindow |
| summary | CostSummary |
| sections | CostReportSection[] |
| basis | CostBasis |
| currency | string |
| generatedAt | string |
| generatedBy | kumo-cost-analysis.ActorRef |
| evidence | CostEvidence[] |
| diagnostics | CostDiagnostic[] |
| fingerprint | string |
CostReportChartSeries
| label | string |
| points | { x: string; y: string }[] |
CostReportChartSpec
| kind | "bar" | "line" | "pie" | "sparkline" |
| title | string |
| series | CostReportChartSeries[] |
CostReportId
string
CostReportKind
"budget_variance" | "commitment_coverage" | "cost_change" | "cost_trend" | "environment_cost" | "optimization_report" | "owner_chargeback" | "provider_account_cost" | "unallocated_cost" | "waste_report" | "workspace_cost_summary"
CostReportRow
| id | string |
| label | string |
| subject | ResourceCostSubject | ConnectionCostSubject | WorkspaceCostSubject | EnvironmentCostSubject | ProviderScopeCostSubject | SourceCostSubject | OwnerCostSubject | TeamCostSubject | ServiceCostSubject | TagCostSubject | AccountCostSubject | null |
| amount | Money | RedactedMoney | null |
| sharePct | number | null |
| note | string | null |
| evidenceIds | CostEvidenceId[] |
CostReportSection
| id | string |
| title | string |
| summary | string |
| rows | CostReportRow[] |
| charts | CostReportChartSpec[] |
| evidence | CostEvidence[] |
| diagnostics | CostDiagnostic[] |
CostRollup
| groupBy | CostGroupBy |
| tagKey | string | null |
| window | CostWindow |
| currency | string |
| rows | CostRollupRow[] |
| total | Money |
CostRollupRow
| key | string |
| displayName | string | null |
| subject | ResourceCostSubject | ConnectionCostSubject | WorkspaceCostSubject | EnvironmentCostSubject | ProviderScopeCostSubject | SourceCostSubject | OwnerCostSubject | TeamCostSubject | ServiceCostSubject | TagCostSubject | AccountCostSubject | null |
| actual | Money | null |
| estimated | Money | null |
| allocated | Money | null |
| total | Money |
| sharePct | number |
| factCount | number |
| estimateCount | number |
CostRollupsDto
| workspaceId | string |
| window | CostWindow |
| currency | string |
| rollups | CostRollup[] |
| diagnostics | CostDiagnostic[] |
| status | "analysed" | "not_analysed" |
| analyzedAt | string | null |
| generatedAt | string |
CostSeverity
"critical" | "high" | "info" | "low" | "medium"
CostSubject
ResourceCostSubject | ConnectionCostSubject | WorkspaceCostSubject | EnvironmentCostSubject | ProviderScopeCostSubject | SourceCostSubject | OwnerCostSubject | TeamCostSubject | ServiceCostSubject | TagCostSubject | AccountCostSubject
CostSubjectSelector
| subjectKinds? | "account" | "connection" | "environment" | "owner" | "provider_scope" | "resource" | "service" | "source" | "tag" | "team" | "workspace"[] |
| providers? | string[] |
| services? | string[] |
| regions? | string[] |
| resourceTypes? | string[] |
| resourceIds? | ResourceId[] |
| tagEquals? | map<string, string> |
| tagKeysPresent? | string[] |
CostSummary
| actualCost | Money | RedactedMoney | null |
| estimatedCost | Money | RedactedMoney | null |
| totalCost | MoneyOrRedacted |
| unallocatedCost | Money | RedactedMoney | null |
| estimatedMonthlyWaste | Money | RedactedMoney | null |
| resourceCount | number |
| resourcesWithActuals | number |
| resourcesWithEstimates | number |
| unpricedResourceCount | number |
| confidence | CostConfidence |
CostSummaryDto
| workspaceId | string |
| window | CostWindow |
| currency | string |
| summary | CostSummary | null |
| coverage | CostCoverageResult | null |
| diagnostics | CostDiagnostic[] |
| status | "analysed" | "not_analysed" |
| analyzedAt | string | null |
| generatedAt | string |
CostWindow
| startInclusive | string |
| endExclusive | string |
| granularity | CostWindowGranularity |
CostWindowGranularity
"custom" | "day" | "hour" | "month" | "quarter" | "year"
CrawlResultId
string
CreateBindingBody
| providerScopeId? | string |
CreateEnvironmentBody
| name? | string |
CreateEnvironmentDefinitionBody
| dslBody? | any |
| activate? | boolean |
CreateEnvironmentDefinitionHttpResponse
| id | string |
| environmentId | string |
| version | number |
| dslBody | any |
| createdAt | string |
| activated | boolean |
CreateEnvironmentHttpResponse
| id | string |
| workspaceId | string |
| name | string |
| origin | string |
| activeDefinitionId | string | null |
| createdAt | string |
CreateGrantBody
| grantee? | { kind?: string; userId?: string; roleId?: string } |
CreateProviderScopeBindingHttpResponse
| id | string |
| workspaceId | string |
| providerScopeId | string |
| createdAt | string |
CreateProviderScopeBody
| provider? | string |
| providerKey? | string |
| canonicalScopeKey? | string |
| displayName? | string |
| name? | string |
CreateProviderScopeHttpResponse
| id | string |
| accountId | string |
| providerKey | string |
| canonicalScopeKey | string |
| displayName | string |
| createdAt | string |
CreateRetentionPolicyHttpResponse
| id | string |
| accountId | string |
| name | string |
| target | string |
| retainForDays | number |
| minimumKept | number |
| createdAt | string |
CreateRoleBody
| key? | string |
| displayName? | string |
| description? | string |
| permissions? | string[] |
| status? | "active" | "draft" |
CreateSensitiveFieldPolicyHttpResponse
| id | string |
| accountId | string |
| name | string |
| attributePathGlobs | string[] |
| action | string |
| createdAt | string |
CreateSourceCredentialHttpResponse
| id | string |
| accountId | string |
| displayName | string |
| credentialKind | string |
| secretRef | string |
| createdAt | string |
CreateSourceHttpResponse
| id | string |
| accountId | string |
| workspaceId | string |
| providerKey | string |
| displayName | string |
| credentialReferenceId | string |
| createdAt | string |
| providerScopeId | string | null |
| providerScope? | { id: string; canonicalScopeKey: string; status: string } |
CreateTemplateBody
| templateKey? | string |
| displayName? | string |
CreateVersionBody
| version? | string |
| body? | any |
| status? | "deprecated" | "draft" | "published" |
CreateViewBody
| name? | string |
CreateViewConfigurationBody
| viewTemplateVersionId? | string |
| parameters? | map<string, any> |
CreateViewConfigurationHttpResponse
| id | string |
| viewId | string |
| viewTemplateVersionId | string |
| parameters | map<string, any> |
| configurationHash | string |
| createdAt | string |
| created | boolean |
CreateViewHttpResponse
| id | string |
| environmentId | string |
| name | string |
| origin | string |
| createdAt | string |
| created | boolean |
CreateWebhookSubscriptionRequestBody
| url | string |
| description? | string |
| eventTypes | string[] |
CreateWorkspaceBody
| name? | string |
| displayName? | string |
CreateWorkspaceHttpResponse
| id | string |
| accountId | string |
| name | string |
| createdAt | string |
| created? | boolean |
CredentialHealthDecisionDto
| kind | CredentialHealthDecisionKind |
| reason | string |
| safeToSync | boolean |
| safeToDeleteMissingResources | boolean |
| requiresUserAction | boolean |
CredentialHealthDecisionKind
"allow" | "allow-degraded" | "block"
CredentialHealthFindingCategory
"authentication" | "authorization" | "configuration" | "coverage" | "expiry" | "identity" | "location" | "network" | "policy" | "provider-service" | "quota" | "rate-limit" | "rotation" | "secret-reference" | "secret-resolution"
CredentialHealthFindingDto
| id | string |
| severity | CredentialHealthSeverity |
| category | CredentialHealthFindingCategory |
| code | string |
| title | string |
| detail | string |
| providerKey | CredentialHealthProviderKey |
| serviceKey? | string |
| resourceType? | string |
| location? | string |
| scope? | string |
| remediation | { title: string; detail: string; docsUrl?: string; code?: string }[] |
CredentialHealthProviderKey
"aws" | "azure" | "cloudflare" | "custom" | "gcp" | "kubernetes" | "opentofu" | "terraform"
CredentialHealthReportDto
| id | string |
| providerKey | CredentialHealthProviderKey |
| status | CredentialHealthStatus |
| decision | CredentialHealthDecisionDto |
| subject? | CredentialSubjectDto |
| summary | CredentialHealthSummaryDto |
| coverage | CoverageAuthoritySliceDto[] |
| findings | CredentialHealthFindingDto[] |
| startedAt | string |
| finishedAt | string |
| expiresAt | string |
CredentialHealthSeverity
"error" | "fatal" | "info" | "warning"
CredentialHealthStatus
"blocked" | "degraded" | "healthy" | "stale" | "unknown"
CredentialHealthSummaryDto
| probeCount | number |
| passedProbeCount | number |
| failedProbeCount | number |
| warningProbeCount | number |
| timeoutProbeCount | number |
| authoritativeSliceCount | number |
| nonAuthoritativeSliceCount | number |
| unknownSliceCount | number |
| errorFindingCount | number |
| warningFindingCount | number |
CredentialNotificationSubject
| kind | "credential" |
| workspaceId? | WorkspaceId |
| credentialRef | string |
| sourceId? | SourceId |
| displayName | string |
CredentialSubjectDto
| providerKey | CredentialHealthProviderKey |
| displayName | string |
| providerAccountId? | string |
| providerTenantId? | string |
| providerSubscriptionIds? | string[] |
| providerProjectIds? | string[] |
| providerPrincipalId? | string |
| providerPrincipalArn? | string |
| providerPrincipalEmail? | string |
| clusterIdentity? | string |
DeleteRetentionPolicyHttpResponse
| deleted | boolean |
DeleteSensitiveFieldPolicyHttpResponse
| deleted | boolean |
DeleteSourceCredentialHttpResponse
| credentialId | string |
| deleted | true |
DemoWorkspaceProvisionHttpResponse
| workspaceId | string |
| sourceId | string |
| workspaceGraphRevisionId | string | null |
| resourceCount | number |
| connectionCount | number |
| reusedExistingWorkspace | boolean |
DeviceLoginError
| error | string |
| error_description? | string |
DeviceLoginStartResponse
| device_code | string |
| user_code | string |
| verification_uri | string |
| verification_uri_complete | string |
| expires_in | number |
| interval | number |
DeviceLoginTokenBody
| device_code? | string |
DeviceLoginTokenResponse
| access_token | string |
| token_type | "Bearer" |
| scope | "read_write" |
| token_id | string |
| key_prefix | string |
| display_name | string |
| expires_at | string | null |
DigestBody
| mode? | "cost" | "daily_workspace" | "deployment" | "incident" | "security" | "source_sync" | "weekly_account" |
| since? | string |
| until? | string |
| maxHighlights? | number |
DigestSchedule
| cadence | "daily" | "weekly" |
| hour | number |
| dayOfWeek? | number |
| timezone | string |
DirectoryCreateBody
| name? | string |
| provider? | string |
| initialToken? | { name?: string; expiresAt?: string } |
DiscoverProviderScopesBody
| provider? | string |
| providerKey? | string |
| credentialReferenceId? | string |
| parameters? | map<string, any> |
DiscoverProviderScopesHttpResponse
| supported | boolean |
| providerScopes | DiscoveredProviderScopeHttpItem[] |
| staleProviderScopes | { status: string; accountId: string; id: string; providerKey: string; canonicalScopeKey: string; scopeKind: string | null; displayName: string; parentProviderScopeId: string | null; createdAt: string; updatedAt: string }[] |
| diagnostics | { code: string; severity: string; message: string }[] |
DiscoveredBillingExportDto
| name | string |
| bucket | string |
| prefix | string |
| region | string |
| api | string |
| format | string |
DiscoveredProviderScopeHttpItem
| id | string |
| accountId | string |
| providerKey | string |
| canonicalScopeKey | string |
| displayName | string |
| status | string |
| scopeKind | string | null |
| parentProviderScopeId | string | null |
| createdAt | string |
| updatedAt | string |
| isNew | boolean |
Endpoint
| node | string |
| port? | string |
| role? | string |
EntitlementGrantReason
"addon" | "included" | "legacy" | "override" | "trial"
EntitlementTemplate
| featureKey | FeatureKey |
| kind | kumo-contracts.EntitlementKind |
| scope | kumo-contracts.EntitlementScope |
| value | FeatureValue |
| softLimit? | number | null |
| hardLimit? | number | null |
| resetPeriod? | "annual" | "daily" | "monthly" | "none" | "weekly" |
| grantReason | EntitlementGrantReason |
| notes? | string |
Entity
| id | string |
| kind | "node" |
| type | string |
| role? | string |
| parent? | string | null |
| labels? | string[] |
| data? | map<string, any> |
| view? | map<string, any> |
| meta? | map<string, any> |
EnvironmentByAccountItemDto
| id | string |
| name | string |
| workspaceId | string |
| workspaceName | string |
| origin | string |
| activeDefinitionId | string | null |
| createdAt | string |
| retiredAt | string | null |
| providers | string[] |
| sourceCount | number |
| membershipRule | any |
| evaluation | EnvironmentEvaluationDto | null |
| sourceFreshness | EnvironmentSourceFreshnessDto | null |
| status | ObjectStatus |
| workspaceStatus | ObjectStatus |
EnvironmentChangeSubject
| kind | "environment" |
| environmentId | EnvironmentId |
EnvironmentCostSubject
| kind | "environment" |
| environmentId | EnvironmentId |
| displayName | string | null |
EnvironmentEvaluationDto
| resourceCount | number |
| evaluatedAt | string |
| status | string |
| workspaceGraphRevisionId | string |
| behindLatestGraph | boolean |
| chainState | "failed" | "pending" | "running" | null |
EnvironmentId
string
EnvironmentNotificationSubject
| kind | "environment" |
| workspaceId | WorkspaceId |
| environmentId | EnvironmentId |
| environmentRevisionId? | EnvironmentRevisionId |
| displayName | string |
EnvironmentPricingEstimateResult
| environmentId | string |
| priceCatalogLoaded | boolean |
| estimates | PricingSubtotal[] |
| resourceCount | number |
| pricedResourceCount | number |
| hoursPerMonthAssumed | number |
EnvironmentQueryPreviewBody
| dslBody? | any |
| workspaceGraphRevisionId? | string |
EnvironmentQueryPreviewHttpResponse
| targetResourceCount | number |
| targetConnectionCount | number |
EnvironmentRevisionHttpItem
| id | string |
| environmentId | string |
| environmentDefinitionId | string |
| workspaceGraphRevisionId | string |
| targetSetId | string |
| targetMembershipHash | string |
| status | string |
| createdAt | string |
EnvironmentRevisionId
string
EnvironmentRevisionMember
| resourceId | ResourceId |
| label | { canonicalIdentityKey: string; displayName: string; semanticType: string; providerType: string; lifecycleState: string } | null |
EnvironmentSourceFreshnessDto
| observedAt | string | null |
| syncStatus | string |
| syncInProgress | boolean |
| coverage | string | null |
EnvironmentSourceModelBuildHttpResponse
| environmentId | string |
| environmentRevisionId | string |
| workspaceId | string |
| workspaceGraphRevisionId | string |
| resourceCount | number |
| connectionCount | number |
| sourceModel | SourceModel |
EvaluateEnvironmentBody
| environmentDefinitionId? | string |
| workspaceGraphRevisionId? | string |
EvaluateEnvironmentHttpResponse
| id | string |
| environmentId | string |
| environmentDefinitionId | string |
| workspaceGraphRevisionId | string |
| targetSetId | string |
| targetResourceCount | number |
| targetMembershipHash | string |
| status | string |
| createdAt | string |
ExternalNotificationRecipient
| kind | "external" |
| accountId | AccountId |
| channel | NotificationChannel |
| address | string |
FeatureKey
string
FeatureValue
boolean | string | number | string[] | kumo-contracts.JsonObject | null
FinalizeWorkspaceSyncRunHttpResponse
| status | string |
| workspaceGraphRevisionId | string | null |
| acceptedCount | number |
| partialCount | number |
| rejectedCount | number |
ForecastMethod
"last_30d_run_rate" | "last_7d_run_rate" | "linear_trend" | "manual" | "month_to_date_extrapolation" | "seasonal_weekday"
ForecastPoint
| window | CostWindow |
| amount | Money |
| lowerBound | Money | null |
| upperBound | Money | null |
GenerateDefaultViewsBody
| environmentRevisionId? | string |
GenerateDefaultViewsHttpResponse
| views | GeneratedDefaultViewHttpItem[] |
GenerateViewHttpResponse
| viewRevisionId | string |
| contextResultHash | string |
| semanticDiagramModelHash | string |
| visualGraphModelHash | string |
| layoutHash | string |
| inputHash | string |
| artifactCount | number |
| svgHash? | string |
GenerateViewRevisionBody
| viewConfigurationId? | string |
| environmentRevisionId? | string |
| regenerateStaleEngine? | boolean |
GeneratedDefaultViewHttpItem
| templateKey | string |
| viewRevisionId | string |
GetConnectionAtRevisionHttpResponse
object | object
GetConnectionAtTimestampHttpResponse
object | object
GetEnvironmentHttpDefinition
| id | string |
| environmentId | string |
| version | number |
| dslBody | any |
| createdAt | string |
GetEnvironmentHttpEvaluationFailure
| kind | "evaluation" | "post-sync-chain" |
| failedAt | string |
| workspaceGraphRevisionId | string |
| environmentRevisionId | string | null |
| error | string | null |
GetEnvironmentHttpEvaluationState
| latestUsableRevisionId | string | null |
| latestUsableEvaluatedAt | string | null |
| updating | "evaluation" | "sync" | null |
| failure | GetEnvironmentHttpEvaluationFailure | null |
GetEnvironmentHttpResponse
| id | string |
| workspaceId | string |
| name | string |
| origin | string |
| activeDefinitionId | string | null |
| policyKey | string | null |
| anchorResourceId | string | null |
| anchorCanonicalIdentityKey | string | null |
| createdAt | string |
| activeDefinition | GetEnvironmentHttpDefinition | null |
| evaluationState | GetEnvironmentHttpEvaluationState |
GetEnvironmentRevisionHttpResponse
| id | string |
| environmentId | string |
| environmentDefinitionId | string |
| workspaceGraphRevisionId | string |
| targetSetId | string |
| targetMembershipHash | string |
| status | string |
| createdAt | string |
| targetSet | GetEnvironmentRevisionHttpTargetSet | null |
GetEnvironmentRevisionHttpTargetSet
| id | string |
| targetMembershipHash | string |
| resourceIds | string[] |
| connectionIds | string[] |
GetOperationHttpResponse
| id | string |
| workspaceId | string | null |
| type | "operation" |
| operationType | string |
| status | string |
| target | { type: string; id: string } |
| result | map<string, any> | null |
| createdAt | string |
| startedAt | string | null |
| completedAt | string | null |
GetPipelineRunHttpResponse
| id | string |
| accountId | string | null |
| label | string |
| createdAt | string |
| status | string |
| mode | string |
| files | number |
| succeeded | number |
| failed | number |
| durationMs | number |
| metrics | map<string, any> |
| report | map<string, any> | null |
GetProviderScopeHttpResponse
| id | string |
| accountId | string |
| providerKey | string |
| canonicalScopeKey | string |
| displayName | string |
| createdAt | string |
GetResourceAtRevisionHttpResponse
object | object
GetRetentionPolicyHttpResponse
| id | string |
| accountId | string |
| name | string |
| target | string |
| retainForDays | number |
| minimumKept | number |
| createdAt | string |
GetSensitiveFieldPolicyHttpResponse
| id | string |
| accountId | string |
| name | string |
| attributePathGlobs | string[] |
| action | string |
| createdAt | string |
GetSourceCredentialHttpResponse
| id | string |
| accountId | string |
| displayName | string |
| credentialKind | string |
| secretRef | string |
| createdAt | string |
GetSourceHttpResponse
| id | string |
| accountId | string |
| workspaceId | string |
| providerKey | string |
| displayName | string |
| credentialReferenceId | string |
| providerScopeId | string | null |
| parameters | map<string, any> | null |
| createdAt | string |
| archivedAt | string | null |
GetViewConfigurationHttpResponse
| id | string |
| viewId | string |
| viewTemplateVersionId | string |
| parameters | map<string, any> |
| configurationHash | string |
| createdAt | string |
GetViewHttpResponse
| id | string |
| environmentId | string |
| name | string |
| origin | string |
| createdAt | string |
GetViewRevisionArtifactHttpItem
| kind | string |
| contentBlobSha | string |
| artifactHash | string |
| contentType | string |
| byteLength | number |
GetViewRevisionHttpResponse
| id | string |
| viewId | string |
| viewConfigurationId | string |
| viewTemplateVersionId | string |
| environmentRevisionId | string |
| workspaceGraphRevisionId | string |
| inputHash | string |
| visualGraphModelHash | string |
| layoutHash | string |
| status | string |
| artifacts | GetViewRevisionArtifactHttpItem[] |
| createdAt | string |
| renderEngineFingerprint | string | null |
| renderEngineStale | boolean |
GetViewTemplateHttpResponse
| id | string |
| accountId | string | null |
| templateKey | string |
| displayName | string |
| createdAt | string |
GetViewTemplateVersionHttpResponse
| id | string |
| viewTemplateId | string |
| version | string |
| status | string |
| resolvedBody | any |
| templateHash | string |
| createdAt | string |
GetWorkspaceGraphRevisionHttpResponse
| id | string |
| workspaceId | string |
| sequence | number |
| graphStateHash | string |
| producedBySnapshotId | string |
| snapshotVector | string[] |
| resourceRevisionCount | number |
| connectionRevisionCount | number |
| createdAt | string |
GetWorkspaceSyncRunHttpResponse
| id | string |
| workspaceId | string |
| accountId | string |
| status | string |
| triggerKind | string |
| finalizationPolicy | string |
| baseWorkspaceGraphRevisionId | string | null |
| finalWorkspaceGraphRevisionId | string | null |
| expectedSourceCount | number |
| completedSourceCount | number |
| acceptedSourceCount | number |
| rejectedSourceCount | number |
| partialSourceCount | number |
| createdAt | string |
| startedAt | string | null |
| completedAt | string | null |
| leaseExpiresAt | string | null |
| sourceFailures | WorkspaceSyncRunSourceFailure[] |
GraphDiffChangeDto
| id | string |
| kind | string |
| category | string |
| severity | string |
| title | string |
| description | string |
| subject | GraphDiffChangeSubjectDto |
| fields | GraphDiffFieldChangeDto[] |
| authority | GraphDiffAuthorityDto |
| redacted | boolean |
| explainUrl? | string |
GraphDiffChangeId
string
GraphDiffChangeSubjectDto
| kind | string |
| resourceId? | string |
| connectionId? | string |
| workspaceId? | string |
| environmentId? | string |
| semanticType? | string |
| providerType? | string |
| providerKey? | string |
| location? | string |
| connectionType? | string |
| sourceResourceId? | string |
| targetResourceId? | string |
GraphDiffEvidenceRef
object | object | object | object | object | object | object | object | object
GraphDiffExplainStep
| code | string |
| message | string |
| refs | GraphDiffEvidenceRef[] |
GraphDiffExplanation
| id | GraphDiffExplanationId |
| changeId | GraphDiffChangeId |
| summary | string |
| detail | string |
| cause | GraphDiffExplanationCause |
| steps | GraphDiffExplainStep[] |
| evidence | GraphDiffEvidenceRef[] |
GraphDiffExplanationCause
"authority-rule-change" | "graph-reprocessing" | "identity-correction" | "manual-change" | "policy-change" | "provider-observation" | "retention-compaction" | "source-sync" | "unknown" | "workspace-sync-finalization"
GraphDiffExplanationId
string
GraphDiffFieldChangeDto
| path | string |
| before | any |
| after | any |
| classification | string |
| importance | string |
| redacted | boolean |
| sensitive | boolean |
GraphDiffLegendItemDto
| label | string |
| status | string |
| count | number |
GraphDiffLineageChainDto
| subject | { kind: string; id: string } |
| hops | GraphDiffLineageHopDto[] |
GraphDiffLineageHopDto
| kind | string |
| ref | string |
| at? | string |
| label? | string |
GraphDiffOverlayDto
| artifactId | string |
| legend | GraphDiffLegendItemDto[] |
| resourceTreatments | map<string, GraphDiffVisualTreatmentDto> |
| connectionTreatments | map<string, GraphDiffVisualTreatmentDto> |
GraphDiffSummaryDto
| artifactId | string |
| fromWorkspaceGraphRevisionId | string |
| toWorkspaceGraphRevisionId | string |
| status | string |
| totalChanges | number |
| resources | { added: number; removed: number; changed: number } |
| connections | { added: number; removed: number; changed: number } |
| severities | map<string, number> |
| categories | map<string, number> |
| warnings | GraphDiffWarningDto[] |
GraphDiffVisualTreatmentDto
| status | string |
| emphasis | string |
| badges | string[] |
| tooltip | string |
GraphDiffWarningDto
| code | string |
| message | string |
| severity | string |
IamApiTokenRecord
| id | string |
| displayName | string |
| keyPrefix | string |
| status | string |
| scope | ApiTokenScope |
| createdBy | string |
| createdAt | string |
| expiresAt | string |
| lastUsedAt | string | null |
| revokedAt | string | null |
IamPermissionRecord
| key | string |
| displayName | string |
| description | string |
| namespace | string |
| sensitivity | string |
| allowedScopes | string[] |
IamRoleAssignmentRecord
| id | string |
| principalKind | string |
| principalId | string |
| roleId | string |
| scopeKind | string |
| scopeLabel | string |
| status | string |
| createdBy | string |
| createdAt | string |
| expiresAt | string | null |
| revokedAt | string | null |
IamRoleRecord
| id | string |
| key | string |
| displayName | string |
| description | string |
| status | string |
| system | boolean |
ImpactedTarget
| kind | "alert" | "connection" | "environment" | "owner" | "report" | "resource" | "service" | "source" | "team" | "view" |
| id | string |
| displayName | string | null |
| relationship | "derived" | "direct" | "downstream" | "same_environment" | "same_owner" | "upstream" |
| confidence | number |
IngestBody
| events | ChangeEventBody[] |
| dedupeBucket? | string |
InspectBody
| archive? | string |
| conflictMode? | string |
InviteBody
| email? | string |
| roleId? | string |
KumoArchiveFormat
"ndjson" | "zip"
KumoExportManifestEntryV1
| entryId | string |
| objectKind | KumoImportExportObjectKind |
| logicalId? | string |
| path | string |
| contentType | "application/json" | "application/octet-stream" | "application/pdf" | "application/x-ndjson" | "image/png" | "image/svg+xml" |
| schemaVersion | number |
| sizeBytes? | number |
| sha256 | string |
| redactionLevel | KumoRedactionLevel |
| sensitivity | KumoSensitivityLevel |
| importability | KumoImportabilityLevel |
| dependencies? | { objectKind: KumoImportExportObjectKind; logicalId: string }[] |
KumoExportProvenanceV1
| contentHash? | string |
| workspaceGraphRevisionId? | string |
| viewTemplateVersionIds? | string[] |
| notes? | string[] |
KumoExportSelectionV1
| objectKinds | KumoImportExportObjectKind[] |
| includeLogicalObjects | boolean |
| includeArtifacts | boolean |
| includeRenderedArtifacts | boolean |
| includeDiagnostics | boolean |
| includeRawSnapshots | boolean |
| includeProviderOutput | boolean |
| includeAuditTrail | boolean |
| viewMode? | "debug" | "portable" | "reproducible" |
| artifactMode? | "include_bytes" | "refs_only" |
KumoImportActionKind
"attach_artifact_ref" | "create" | "create_fixture" | "import_desired_state" | "merge" | "reject" | "remap_id" | "replace" | "skip" | "strip_field" | "update" | "upsert"
KumoImportConflictMode
"create_only" | "merge" | "plan_only" | "replace" | "restore" | "skip_existing" | "upsert_safe"
KumoImportConflictV1
| objectKind | KumoImportExportObjectKind |
| sourceObjectId | string |
| existingObjectId? | string |
| reason | string |
| requiresPermission? | string |
KumoImportExportManifestV1
| kind | "kumo.importExport.manifest" |
| manifestVersion | 1 |
| exportId | string |
| operationKind | KumoImportExportOperationKind |
| archiveFormat | KumoArchiveFormat |
| createdAt | string |
| createdByActorId? | string |
| createdByJobId? | string |
| producer | { kumoVersion?: string; packageVersion?: string; runtimeProfile?: string; serviceName?: string } |
| scope | { tenantId?: string; accountId?: string; workspaceId?: string; sourceId?: string; workspaceGraphRevisionId?: string; environmentId?: string; viewConfigurationId?: string; viewRevisionId?: string } |
| compatibility | KumoManifestCompatibilityV1 |
| redaction | KumoManifestRedactionV1 |
| selection | KumoExportSelectionV1 |
| provenance | KumoExportProvenanceV1 |
| contents | KumoExportManifestEntryV1[] |
| integrity | KumoManifestIntegrityV1 |
KumoImportExportObjectKind
"analytics_facts" | "audit_export" | "connection" | "connection_revision" | "diagnostics" | "environment_definition" | "environment_revision" | "graph_diff" | "provider_output_fixture" | "provider_scope" | "rendered_artifact" | "resource" | "resource_revision" | "semantic_diagram_model" | "source" | "source_credential_reference" | "source_snapshot" | "source_sync" | "support_bundle" | "view_configuration" | "view_revision" | "view_template" | "view_template_version" | "visual_graph_model" | "workspace" | "workspace_graph_revision"
KumoImportExportOperationKind
"analytics_export" | "artifact_export" | "backup_restore_bridge" | "external_desired_state_import" | "fixture_export" | "logical_object_export" | "logical_object_import" | "support_bundle_export"
KumoImportPlanActionV1
| actionId | string |
| actionKind | KumoImportActionKind |
| objectKind | KumoImportExportObjectKind |
| sourceObjectId? | string |
| targetObjectId? | string |
| reason | string |
| requiresConfirmation? | boolean |
| requiresPermission? | string |
| warnings? | string[] |
KumoImportPlanV1
| kind | "kumo.importExport.importPlan" |
| planVersion | 1 |
| importPlanId | string |
| archiveManifest | KumoImportExportManifestV1 |
| target | { tenantId: string; accountId: string; workspaceId?: string } |
| conflictMode | KumoImportConflictMode |
| scopeRemapping | KumoScopeRemappingPlanV1 |
| actions | KumoImportPlanActionV1[] |
| conflicts | KumoImportConflictV1[] |
| warnings | KumoImportWarningV1[] |
| validation | KumoValidationResultV1 |
| createdAt | string |
| createdByActorId | string |
KumoImportWarningV1
| code | string |
| message | string |
| objectKind? | "analytics_facts" | "audit_export" | "connection" | "connection_revision" | "diagnostics" | "environment_definition" | "environment_revision" | "graph_diff" | "provider_output_fixture" | "provider_scope" | "rendered_artifact" | "resource" | "resource_revision" | "semantic_diagram_model" | "source" | "source_credential_reference" | "source_snapshot" | "source_sync" | "support_bundle" | "view_configuration" | "view_revision" | "view_template" | "view_template_version" | "visual_graph_model" | "workspace" | "workspace_graph_revision" |
| objectId? | string |
KumoImportabilityLevel
"admin_only" | "export_only" | "importable" | "unsupported"
KumoManifestCompatibilityV1
| minKumoVersion? | string |
| producerKumoVersion? | string |
| supportedManifestMajors | number[] |
| objectSchemaVersions | map<string, number> |
| artifactSchemaVersions? | map<string, number> |
| importerVersions? | map<string, string> |
KumoManifestIntegrityV1
| hashAlgorithm | "sha256" |
| manifestSha256? | string |
| aggregateSha256? | string |
| entriesSha256? | map<string, string> |
KumoManifestRedactionV1
| level | KumoRedactionLevel |
| policyIds? | string[] |
| deterministic | boolean |
| redactedFieldsCount? | number |
| restrictedEntriesCount? | number |
KumoObjectIdRemapV1
| objectKind | KumoImportExportObjectKind |
| sourceObjectId | string |
| targetObjectId | string |
| reason | "artifact_rebound" | "conflict" | "credential_reference_unresolved" | "local_id_regenerated" | "new_scope" |
KumoRedactionLevel
"fixture" | "redacted" | "restricted" | "unredacted"
KumoScopeRemappingPlanV1
| sourceTenantId? | string |
| sourceAccountId? | string |
| sourceWorkspaceId? | string |
| targetTenantId | string |
| targetAccountId | string |
| targetWorkspaceId? | string |
| objectIdRemaps | KumoObjectIdRemapV1[] |
| strippedFields | KumoStrippedFieldV1[] |
| requiredPermissions | string[] |
| warnings | KumoImportWarningV1[] |
KumoSensitivityLevel
"public" | "restricted" | "secret" | "sensitive" | "tenant"
KumoStrippedFieldV1
| objectKind | KumoImportExportObjectKind |
| objectId? | string |
| fieldPath | string |
| reason | string |
KumoValidationIssueV1
| severity | KumoValidationSeverity |
| code | string |
| message | string |
| path? | string |
| objectKind? | "analytics_facts" | "audit_export" | "connection" | "connection_revision" | "diagnostics" | "environment_definition" | "environment_revision" | "graph_diff" | "provider_output_fixture" | "provider_scope" | "rendered_artifact" | "resource" | "resource_revision" | "semantic_diagram_model" | "source" | "source_credential_reference" | "source_snapshot" | "source_sync" | "support_bundle" | "view_configuration" | "view_revision" | "view_template" | "view_template_version" | "visual_graph_model" | "workspace" | "workspace_graph_revision" |
| objectId? | string |
KumoValidationPhase
"apply" | "archive" | "compatibility" | "plan" | "policy" | "schema" | "semantic" | "sensitivity"
KumoValidationResultV1
| ok | boolean |
| phases | { phase: KumoValidationPhase; ok: boolean; issues: KumoValidationIssueV1[] }[] |
KumoValidationSeverity
"error" | "fatal" | "info" | "warning"
ListEnvironmentsHttpResponseItem
| id | string |
| workspaceId | string |
| name | string |
| origin | string |
| activeDefinitionId | string | null |
| policyKey | string | null |
| anchorResourceId | string | null |
| anchorCanonicalIdentityKey | string | null |
| createdAt | string |
ListProviderScopeBindingsHttpResponseItem
| id | string |
| workspaceId | string |
| providerScopeId | string |
| createdAt | string |
ListProviderScopesHttpResponseItem
| id | string |
| accountId | string |
| providerKey | string |
| canonicalScopeKey | string |
| displayName | string |
| createdAt | string |
| status | string |
| scopeKind | string | null |
| parentProviderScopeId | string | null |
| resourceCount? | number |
| provisionedResourceCount? | number |
| unclassifiedResourceCount? | number |
| isOrganizationPayer? | boolean |
| organizationId? | string | null |
| attributes | map<string, any> |
ListResourceConnectionsAtRevisionHttpResponseItem
| connectionId | string |
| connectionType | string |
| direction | "in" | "out" |
| revisionId | string |
| otherResourceId | string | null |
ListResourcesAtRevisionHttpResponseItem
| id | string |
| workspaceId | string |
| canonicalIdentityKey | string |
| semanticType | string |
| providerType | string |
| lifecycleState | string |
| currentRevisionId | string |
| displayName | string |
ListSourceCredentialsHttpResponseItem
| id | string |
| accountId | string |
| displayName | string |
| credentialKind | string |
| secretRef | string |
| createdAt | string |
ListSourcesHttpResponseItem
| id | string |
| accountId | string |
| workspaceId | string |
| providerKey | string |
| displayName | string |
| credentialReferenceId | string |
| providerScopeId | string | null |
| parameters | map<string, any> | null |
| createdAt | string |
| archivedAt | string | null |
ListWorkspaceGraphRevisionsHttpResponseItem
| id | string |
| workspaceId | string |
| sequence | number |
| producedBySnapshotId | string |
| snapshotVector | string[] |
| graphStateHash | string |
| createdAt | string |
| quality | RevisionQualityHttpDto | null |
ListWorkspaceSyncRunsHttpResponseItem
| id | string |
| workspaceId | string |
| accountId | string |
| status | string |
| triggerKind | string |
| finalizationPolicy | string |
| baseWorkspaceGraphRevisionId | string | null |
| finalWorkspaceGraphRevisionId | string | null |
| expectedSourceCount | number |
| completedSourceCount | number |
| acceptedSourceCount | number |
| rejectedSourceCount | number |
| partialSourceCount | number |
| createdAt | string |
| startedAt | string | null |
| completedAt | string | null |
MaterializeBody
| force? | boolean |
| from? | string |
| to? | string |
| lenses? | ChangeLens[] |
| maxChanges? | number |
| includeSuppressed? | boolean |
Money
| amount | string |
| currency | string |
MoneyOrRedacted
NotificationChannel
"cli" | "desktop" | "email" | "in_app" | "mobile_push" | "slack" | "webhook"
NotificationDeliveryMode
"digest" | "immediate" | "in_app_only" | "muted"
NotificationDto
| id | string |
| accountId | string |
| workspaceId | string | null |
| kind | string |
| severity | string |
| urgency | string |
| title | string |
| summary | string |
| subject | NotificationSubject |
| links | NotificationLink[] |
| evidence | NotificationEvidence[] |
| threadKey | string | null |
| dedupeKey | string |
| createdAt | string |
| occurredAt | string |
| state | string |
NotificationEvidence
| kind | string |
| label | string |
| ref? | string |
| sensitive? | boolean |
| detail? | map<string, any> |
NotificationInboxItemDto
| recipientNotification | RecipientNotificationDto |
| notification | NotificationDto |
NotificationKind
"admin.notice" | "alert.triggered" | "comment.mentioned_user" | "context.changed" | "cost.anomaly_detected" | "cost.budget_threshold_crossed" | "credential.health.failed" | "environment.changed" | "environment.shared" | "graph.diff.ready" | "report.ready" | "report.scheduled_summary" | "resource.mentioned" | "security.finding_detected" | "source.sync.failed" | "source.sync.started" | "source.sync.succeeded" | "system.notice" | "view.changed" | "view.generated"
NotificationLink
| kind | NotificationLinkKind |
| label | string |
| href | string |
| requiresPermission? | string |
NotificationLinkKind
"alert" | "context" | "credential" | "diff" | "environment" | "external" | "graph_revision" | "report" | "resource" | "settings" | "source" | "sync_run" | "view" | "workspace"
NotificationPreferenceDto
| id | string |
| accountId | string |
| userId | string |
| scope | NotificationPreferenceScope |
| channel | string |
| kind | string |
| enabled | boolean |
| minimumSeverity | string | null |
| deliveryMode | string |
| quietHours? | QuietHours | null |
| digestSchedule? | DigestSchedule | null |
| createdAt | string |
| updatedAt | string |
NotificationPreferenceScope
object | object
NotificationPreferenceUpdateSpec
| scope | NotificationPreferenceScope |
| channel | NotificationChannel |
| kind | "admin.notice" | "alert.triggered" | "all" | "comment.mentioned_user" | "context.changed" | "cost.anomaly_detected" | "cost.budget_threshold_crossed" | "credential.health.failed" | "environment.changed" | "environment.shared" | "graph.diff.ready" | "report.ready" | "report.scheduled_summary" | "resource.mentioned" | "security.finding_detected" | "source.sync.failed" | "source.sync.started" | "source.sync.succeeded" | "system.notice" | "view.changed" | "view.generated" |
| enabled | boolean |
| minimumSeverity? | "critical" | "error" | "info" | "success" | "warning" |
| deliveryMode | NotificationDeliveryMode |
| quietHours? | QuietHours |
| digestSchedule? | DigestSchedule |
NotificationRecipient
UserNotificationRecipient | TeamNotificationRecipient | WorkspaceNotificationRecipient | ExternalNotificationRecipient
NotificationSubject
WorkspaceNotificationSubject | EnvironmentNotificationSubject | ContextNotificationSubject | ViewNotificationSubject | SourceNotificationSubject | ResourceNotificationSubject | ReportNotificationSubject | AlertNotificationSubject | CostNotificationSubject | CredentialNotificationSubject | SystemNotificationSubject
NotificationSubjectSelector
| workspaceId? | WorkspaceId |
| environmentId? | EnvironmentId |
| sourceId? | SourceId |
| contextId? | string |
| accountWide? | boolean |
NotificationSubscriptionDto
| id | string |
| accountId | string |
| workspaceId | string | null |
| subscriber | NotificationRecipient |
| selector | NotificationSubjectSelector |
| kinds | string[] |
| channels | string[] |
| minimumSeverity | string |
| enabled | boolean |
| createdAt | string |
ObjectStatus
| state | ObjectStatusState |
| reason | string |
| needsAttention | boolean |
ObjectStatusState
"current" | "failed" | "partial" | "read-only" | "setting-up" | "stale" | "updating"
OidcConfigBody
| issuer? | string |
| clientId? | string |
| clientSecret? | string |
| scopes? | string[] |
| emailClaim? | string |
| status? | "active" | "disabled" |
OperationHttpItem
| id | string |
| workspaceId | string | null |
| sourceId | string | null |
| type | "operation" |
| operationType | string |
| status | string |
| target | { type: string; id: string } |
| result | map<string, any> | null |
| failure | string | null |
| createdAt | string |
| startedAt | string | null |
| completedAt | string | null |
OwnerCostSubject
| kind | "owner" |
| ownerKey | string |
| displayName | string | null |
ParametersBody
| parameters? | map<string, any> | null |
PartnerBranding
| productName | string |
| logoUrl | string | null |
| faviconUrl | string | null |
| supportEmail | string | null |
| themeTokens | map<string, string> |
PartnerBrandingResolveResult
| partner | { partnerId: string; branding: PartnerBranding } | null |
PartnerSignupBody
| email? | string |
| password? | string |
| displayName? | string |
| accountName? | string |
| host? | string |
PartnerSignupProvisionResult
| partnerId | string |
| userId | string |
| accountId | string |
| planKey | string |
| trialEndsAt | string (date-time) |
| sessionToken? | string |
| sessionExpiresAt? | string (date-time) |
PipelineRunHttpSummaryItem
| id | string |
| accountId | string | null |
| label | string |
| createdAt | string |
| status | string |
| mode | string |
| files | number |
| succeeded | number |
| failed | number |
| durationMs | number |
| hasReport | boolean |
PlanId
string
PlanTier
"business" | "embedded" | "enterprise" | "free" | "internal" | "self_hosted" | "starter" | "team" | "trial"
PlanVersionId
string
PolicyBody
| requireMfa? | any |
| requireSso? | any |
PolicyChangeSubject
| kind | "policy" |
| policyId | PolicyId |
PolicyId
string
PreferencesUpdateBody
| updates? | NotificationPreferenceUpdateSpec[] |
PriceCatalogId
string
PriceCatalogItemId
string
PriceCatalogItemRef
| priceCatalogItemId | PriceCatalogItemId |
| catalogId | PriceCatalogId |
| sku | string |
| rate | Money |
| unit | PricingUnit |
| purchaseOption | PurchaseOption |
PriceMatch
| resourceId | ResourceId |
| priceCatalogItemId | PriceCatalogItemId | null |
| status | PriceMatchStatus |
| matchedOn | PriceMatchField[] |
| missingFields | string[] |
| confidence | CostConfidence |
| evidence | CostEvidence[] |
PriceMatchExplainResult
| match | PriceMatch |
| candidatesConsidered | number |
| generatedAt | string |
PriceMatchField
"architecture" | "database_edition" | "database_engine" | "deployment_option" | "instance_type" | "license_model" | "operating_system" | "pre_installed_sw" | "provider" | "purchase_option" | "region" | "resource_type" | "service" | "sku" | "storage_class" | "tenancy" | "unit"
PriceMatchStatus
"exact" | "generic_fallback" | "multiple_candidates" | "partial" | "unpriced"
PricingSubtotal
| currency | string |
| hourly | number |
| monthly | number |
| unit | string | null |
PricingUnit
"gb" | "gb_month" | "gb_second" | "hour" | "io" | "iops_month" | "license_hour" | "memory_gb_hour" | "million_requests" | "request" | "second" | "unit" | "unsupported" | "vcpu_hour"
ProviderKey
string
ProviderScopeCostSubject
| kind | "provider_scope" |
| providerScopeId | ProviderScopeId |
ProviderScopeId
string
ProvisionDemoWorkspaceBody
| workspaceName? | string |
PurchaseOption
"committed_use" | "custom_contract" | "enterprise_agreement" | "on_demand" | "reserved" | "savings_plan" | "spot" | "unknown"
QueryExplainStep
| stepId | string |
| stepType | string |
| inputCardinality | number |
| outputCardinality | number |
| durationMicros | number |
| notes? | string |
QuietHours
| timezone | string |
| startHour | number |
| endHour | number |
| days? | number[] |
QuotaCheckBody
| featureKey? | string |
| workspaceId? | string |
| requestedQuantity? | number |
QuotaSubject
| accountId | AccountId |
| workspaceId | WorkspaceId | null |
| scope | kumo-billing.EntitlementScope |
RawDiffRef
| graphDiffArtifactId | string |
| graphDiffChangeId | string |
RecipientNotificationDto
| id | string |
| notificationId | string |
| recipient | NotificationRecipient |
| visibility | string |
| readState | string |
| lifecycleState | string |
| deliveredChannels | string[] |
| createdAt | string |
| readAt | string | null |
| dismissedAt | string | null |
RedactedChangeValue
object | object | object
RedactedMoney
| kind | "redacted_money" |
| currency | string | null |
| reason | "not_authorized" | "policy" | "sensitive" |
ReportAccountSummary
| accountId | AccountId |
| name | string |
| plan? | string |
| environment? | string |
ReportArtifactBlock
| kind | "artifact" |
| blockId | string |
| title | string |
| artifactKind | "attachment" | "diagram" | "image" |
| href? | string |
| contentHash? | string |
| sourceEvidenceRefs? | ReportEvidenceRef[] |
ReportArtifactGetDownloadUrlResult
| url | string |
| expiresAt | string |
ReportBlock
ReportMarkdownBlock | ReportMetricGridBlock | ReportTableBlock | ReportChartBlock | ReportFindingListBlock | ReportResourceListBlock | ReportEvidenceListBlock | ReportArtifactBlock | ReportCalloutBlock
ReportCalloutBlock
| kind | "callout" |
| blockId | string |
| tone | "danger" | "empty" | "info" | "success" | "warning" |
| title? | string |
| body | string |
| sourceEvidenceRefs? | ReportEvidenceRef[] |
ReportChartBlock
| kind | "chart" |
| blockId | string |
| chart | ReportChartSpec |
| data | ReportChartDataset |
| fallbackTable | ReportTableBlock |
| sourceEvidenceRefs | ReportEvidenceRef[] |
ReportChartDataPoint
| label | string |
| value | number |
| series? | string |
ReportChartDataset
| points | ReportChartDataPoint[] |
ReportChartSpec
| chartType | "bar" | "line" | "map" | "pie" | "stacked_bar" |
| title? | string |
| xLabel? | string |
| yLabel? | string |
ReportConnectionRef
| connectionId | ConnectionId |
| label | string |
| connectionType? | string |
ReportContentBlobRef
| store | string |
| key | string |
| contentHash | string |
| contentType? | string |
| sizeBytes? | number |
ReportCreateBody
| kind? | string |
| window? | { startInclusive?: string; endExclusive?: string } |
| title? | string |
| basis? | string |
| currency? | string |
| includeForecast? | boolean |
| forecastMethod? | string |
ReportDefinition
| reportDefinitionId | ReportDefinitionId |
| accountId | AccountId |
| workspaceId | WorkspaceId |
| name | string |
| description? | string |
| kind | ReportKind |
| scope | ReportScope |
| sections | ReportSectionDefinition[] |
| defaultExportOptions | ReportExportOptions |
| createdBy | kumo-contracts.ActorRef |
| createdAt | string |
| updatedAt | string |
| version | number |
ReportDefinitionCreateBody
| workspaceId? | WorkspaceId |
| name | string |
| description? | string |
| kind | ReportKind |
| scope | ReportScope |
| sections? | ReportSectionDefinition[] |
| defaultExportOptions? | ReportExportOptions |
| correlationId? | string |
ReportDefinitionDeleteResult
| deleted | boolean |
ReportDefinitionId
string
ReportDefinitionUpdateBody
| name? | string |
| description? | string |
| sections? | ReportSectionDefinition[] |
| defaultExportOptions? | ReportExportOptions |
| correlationId? | string |
ReportDeliveryTarget
object | object | object | object | object
ReportDiagnostic
| severity | "error" | "info" | "warning" |
| code | ReportDiagnosticCode |
| message | string |
| sectionId? | string |
| findingId? | ReportFindingId |
| evidenceId? | ReportEvidenceId |
| safeForUser | boolean |
ReportDiagnosticCode
"report.authorization.projection_applied" | "report.change.unavailable" | "report.cost.estimated" | "report.cost.unavailable" | "report.credential_health.unavailable" | "report.data.truncated" | "report.diagrams.unavailable" | "report.evidence.missing" | "report.evidence.redacted" | "report.export.artifact_write_failed" | "report.export.format_unsupported" | "report.findings.unavailable" | "report.graph_revision.not_found" | "report.iam.not_available_for_provider" | "report.resource_data.partial" | "report.scope.empty" | "report.section.failed"
ReportEvidence
| evidenceId | ReportEvidenceId |
| kind | "connection_revision" | "cost_fact" | "credential_health_check" | "diff_result" | "manual_note" | "metric_fact" | "policy_decision" | "provider_observation" | "resource_revision" | "source_snapshot" | "view_artifact" |
| title | string |
| summary? | string |
| refs | ReportEvidenceTargetRef[] |
| observedAt? | string |
| generatedAt? | string |
| provider? | string |
| sourceId? | SourceId |
| sourceSnapshotId? | SourceSnapshotId |
| attributes? | ReportJsonObject |
| redaction | ReportEvidenceRedaction |
ReportEvidenceId
string
ReportEvidenceListBlock
| kind | "evidence_list" |
| blockId | string |
| evidenceRefs | ReportEvidenceRef[] |
ReportEvidenceRedaction
| mode | "field_redaction" | "none" | "placeholder" |
| redactedFields? | string[] |
| note? | string |
ReportEvidenceRef
| evidenceId | ReportEvidenceId |
ReportEvidenceTargetRef
| kind | "connection" | "connection_revision" | "cost_fact" | "credential_health_check" | "environment_revision" | "external" | "graph_revision" | "metric" | "policy_decision" | "resource" | "resource_revision" | "source" | "source_snapshot" | "view_revision" |
| id | string |
| label? | string |
ReportExportFormat
"csv" | "html" | "json" | "markdown" | "pdf"
ReportExportId
string
ReportExportOptions
| includeSections? | string[] |
| excludeSections? | string[] |
| includeEvidenceAppendix | boolean |
| includeDiagnostics | boolean |
| includeRedactedPlaceholders | boolean |
| findings | "expanded" | "expanded_with_evidence" | "summary_only" |
| resources | "included" | "included_with_attributes" | "summary_only" |
| diagrams | "embedded_images" | "links" | "none" |
| redactionMode | "compliance_full" | "metadata_only" | "safe_external" | "viewer_authorized" |
ReportExportRequest
| reportExportId | ReportExportId |
| reportRunId | ReportRunId |
| accountId | AccountId |
| workspaceId | WorkspaceId |
| requestedBy | kumo-contracts.ActorRef |
| requestedAt | string |
| startedAt? | string |
| completedAt? | string |
| failedAt? | string |
| format | ReportExportFormat |
| options | ReportExportOptions |
| redactionMode | ReportRedactionMode |
| status | ReportExportStatus |
| artifactRef? | ReportContentBlobRef |
| diagnostics | ReportDiagnostic[] |
ReportExportStartBody
| format | ReportExportFormat |
| options? | ReportExportOptions |
| mode? | "inline" | "queued" |
| correlationId? | string |
ReportExportStartResultDto
| export | ReportExportRequest |
ReportExportStatus
"expired" | "failed" | "queued" | "rendering" | "succeeded" | "uploading"
ReportFinding
| findingId | ReportFindingId |
| kind | ReportFindingKind |
| severity | ReportFindingSeverity |
| status | ReportFindingStatus |
| title | string |
| summary | string |
| detail? | string |
| affectedResources | ReportResourceRef[] |
| affectedConnections? | ReportConnectionRef[] |
| evidenceRefs | ReportEvidenceRef[] |
| recommendationRefs? | ReportRecommendationRef[] |
| source | ReportFindingSource |
| firstSeenAt? | string |
| lastSeenAt? | string |
ReportFindingId
string
ReportFindingKind
"change" | "compliance_gap" | "cost_anomaly" | "credential_issue" | "data_quality" | "drift" | "exposure" | "misconfiguration" | "other" | "policy_violation"
ReportFindingListBlock
| kind | "finding_list" |
| blockId | string |
| findingRefs | ReportFindingRef[] |
ReportFindingRef
| findingId | ReportFindingId |
ReportFindingSeverity
"critical" | "high" | "info" | "low" | "medium"
ReportFindingSource
"change" | "compliance" | "cost" | "credential_health" | "drift" | "graph_quality" | "manual" | "policy" | "security"
ReportFindingStatus
"accepted" | "informational" | "open" | "resolved" | "suppressed"
ReportJson
boolean | string | number | ReportJson[] | map<string, ReportJson> | null
ReportJsonObject
map<string, ReportJson>
ReportKind
"change" | "compliance" | "cost" | "credential_health" | "custom" | "drift" | "environment_summary" | "executive_summary" | "inventory" | "security" | "source_health" | "workspace_summary"
ReportMarkdownBlock
| kind | "markdown" |
| blockId | string |
| markdown | string |
| sourceEvidenceRefs? | ReportEvidenceRef[] |
ReportMetric
| metricId | string |
| label | string |
| value | boolean | string | number | null |
| unit? | string |
| kind | ReportMetricKind |
| quality | ReportMetricQuality |
| sourceEvidenceRefs | ReportEvidenceRef[] |
ReportMetricGridBlock
| kind | "metric_grid" |
| blockId | string |
| metricRefs | ReportMetricRef[] |
ReportMetricKind
"bytes" | "count" | "currency" | "duration" | "percentage" | "score" | "status"
ReportMetricQuality
"actual" | "derived" | "estimated" | "partial" | "unknown"
ReportMetricRef
| metricId | string |
ReportModel
| schemaVersion | 1 |
| reportRunId | ReportRunId |
| kind | ReportKind |
| title | string |
| account | ReportAccountSummary |
| workspace | ReportWorkspaceSummary |
| subject | ReportSubject |
| generatedAt | string |
| generatedBy | kumo-contracts.ActorRef |
| sourceState | ReportSourceState |
| sections | ReportSection[] |
| findings | ReportFinding[] |
| metrics | ReportMetric[] |
| evidence | ReportEvidence[] |
| recommendations | ReportRecommendation[] |
| diagnostics | ReportDiagnostic[] |
| redaction | ReportRedactionSummary |
| provenance | ReportProvenance |
ReportNotificationSubject
| kind | "report" |
| workspaceId? | WorkspaceId |
| reportId | string |
| reportRevisionId? | string |
| displayName | string |
ReportProvenance
| inputHash | string |
| modelHash | string |
| generatorVersion | string |
| schemaVersion | 1 |
| sourceHashes | ReportSourceHash[] |
ReportRecommendation
| recommendationId | string |
| title | string |
| text | string |
ReportRecommendationRef
| recommendationId | string |
| title | string |
ReportRedactionMode
"field_redaction" | "metadata_only" | "none" | "safe_external" | "unauthorized_projection"
ReportRedactionSummary
| mode | ReportRedactionMode |
| redactedFields | number |
| omittedResources | number |
| omittedConnections | number |
| omittedFindings | number |
| evidencePlaceholders | number |
| diagnostics | ReportDiagnostic[] |
ReportResourceListBlock
| kind | "resource_list" |
| blockId | string |
| resources | ReportResourceRef[] |
| sourceEvidenceRefs | ReportEvidenceRef[] |
ReportResourceRef
| resourceId | ResourceId |
| label | string |
| provider? | string |
| resourceType? | string |
| region? | string |
ReportRun
| reportRunId | ReportRunId |
| reportDefinitionId? | ReportDefinitionId |
| reportDefinitionVersion? | number |
| accountId | AccountId |
| workspaceId | WorkspaceId |
| kind | ReportKind |
| scope | ReportScope |
| status | ReportRunStatus |
| requestedBy | kumo-contracts.ActorRef |
| requestedAt | string |
| startedAt? | string |
| completedAt? | string |
| failedAt? | string |
| inputHash | string |
| modelHash? | string |
| sourceState | ReportSourceState |
| authorizationProjection | ReportAuthorizationProjection |
| modelRef? | ReportContentBlobRef |
| summary? | ReportRunSummary |
| diagnostics | ReportDiagnostic[] |
ReportRunId
string
ReportRunStartBody
| reportDefinitionId? | ReportDefinitionId |
| kind? | "change" | "compliance" | "cost" | "credential_health" | "custom" | "drift" | "environment_summary" | "executive_summary" | "inventory" | "security" | "source_health" | "workspace_summary" |
| scope? | { kind: "workspace"; workspaceId: WorkspaceId; graphRevisionId?: WorkspaceGraphRevisionId } | { kind: "environment"; workspaceId: WorkspaceId; environmentId: EnvironmentId; environmentRevisionId?: EnvironmentRevisionId } | { kind: "source"; workspaceId: WorkspaceId; sourceId: SourceId; sourceSnapshotId?: SourceSnapshotId } | { kind: "view"; workspaceId: WorkspaceId; viewId: ViewId; viewRevisionId?: ViewRevisionId } | { kind: "comparison"; workspaceId: WorkspaceId; baseGraphRevisionId: WorkspaceGraphRevisionId; targetGraphRevisionId: WorkspaceGraphRevisionId } |
| sections? | ReportSectionKind[] |
| mode? | "inline" | "queued" |
| correlationId? | string |
ReportRunStartResultDto
| run | ReportRun |
| model? | ReportModel |
ReportRunStatus
"cancelled" | "expired" | "failed" | "queued" | "running" | "succeeded"
ReportRunSummary
| sectionCount | number |
| findingCount | number |
| criticalFindingCount | number |
| highFindingCount | number |
| metricCount | number |
| evidenceCount | number |
| resourceCount? | number |
| redactionMode | ReportRedactionMode |
ReportSchedule
| reportScheduleId | ReportScheduleId |
| reportDefinitionId | ReportDefinitionId |
| accountId | AccountId |
| workspaceId | WorkspaceId |
| cron | string |
| timezone | string |
| delivery | ReportDeliveryTarget[] |
| exportFormats | ReportExportFormat[] |
| enabled | boolean |
| nextRunAt? | string |
| lastRunAt? | string |
| createdAt | string |
| updatedAt | string |
ReportScheduleCreateBody
| reportDefinitionId | ReportDefinitionId |
| workspaceId? | WorkspaceId |
| cron | string |
| timezone | string |
| delivery | ReportDeliveryTarget[] |
| exportFormats? | ReportExportFormat[] |
| enabled? | boolean |
| correlationId? | string |
ReportScheduleDeleteResult
| deleted | boolean |
ReportScheduleId
string
ReportScheduleUpdateBody
| cron? | string |
| timezone? | string |
| delivery? | ReportDeliveryTarget[] |
| exportFormats? | ReportExportFormat[] |
| enabled? | boolean |
ReportScope
object | object | object | object | object
ReportSection
| sectionId | string |
| kind | ReportSectionKind |
| title | string |
| summary? | string |
| status | ReportSectionStatus |
| blocks | ReportBlock[] |
| findings? | ReportFindingRef[] |
| metrics? | ReportMetricRef[] |
| evidence? | ReportEvidenceRef[] |
| diagnostics | ReportDiagnostic[] |
ReportSectionDefinition
| sectionId | string |
| kind | ReportSectionKind |
| title? | string |
| enabled? | boolean |
| options? | map<string, any> |
ReportSectionKind
"account_summary" | "architecture_diagrams" | "change_summary" | "compliance_findings" | "cost_summary" | "credential_health" | "diagnostics" | "drift_summary" | "evidence_appendix" | "iam_summary" | "network_exposure" | "provider_usage" | "region_usage" | "report_heading" | "resource_inventory" | "resource_stats" | "security_findings" | "source_summary" | "sync_summary" | "workspace_summary"
ReportSectionStatus
"complete" | "empty" | "failed" | "not_applicable" | "partial" | "redacted"
ReportSourceHash
| label | string |
| hash | string |
ReportSourceState
| scopeKind | "comparison" | "environment" | "source" | "view" | "workspace" |
| resolvedAt | string |
| workspaceId | WorkspaceId |
| graphRevisionId? | WorkspaceGraphRevisionId |
| environmentId? | EnvironmentId |
| environmentRevisionId? | EnvironmentRevisionId |
| sourceId? | SourceId |
| sourceSnapshotId? | SourceSnapshotId |
| viewId? | ViewId |
| viewRevisionId? | ViewRevisionId |
| baseGraphRevisionId? | WorkspaceGraphRevisionId |
| targetGraphRevisionId? | WorkspaceGraphRevisionId |
| sourceHashes | ReportSourceHash[] |
ReportSubject
| kind | "comparison" | "environment" | "source" | "view" | "workspace" |
| id | string |
| label | string |
ReportTableBlock
| kind | "table" |
| blockId | string |
| columns | ReportTableColumn[] |
| rows | ReportTableRow[] |
| sourceEvidenceRefs | ReportEvidenceRef[] |
ReportTableColumn
| key | string |
| label | string |
| align? | "center" | "left" | "right" |
| kind? | "currency" | "number" | "percentage" | "status" | "text" | "timestamp" |
ReportTableRow
| cells | map<string, ReportJson> |
ReportWorkspaceSummary
| workspaceId | WorkspaceId |
| name | string |
| description? | string |
ResourceAttributeValuesListHttpResponse
| values | ResourceAttributeValuesListHttpResponseValue[] |
| truncated | boolean |
ResourceAttributeValuesListHttpResponseValue
| value | string |
| count | number |
ResourceChangeSubject
| kind | "resource" |
| resourceId | ResourceId |
| resourceType | string |
| displayName | string | null |
| provider | string | null |
| region | string | null |
| authorityDomain? | "actual_configuration" | "business_metadata" | "cost_metadata" | "desired_configuration" | "manual_annotation" | "runtime_observed" | "security_finding" |
ResourceChangeTimelineResult
| resourceId | ResourceId |
| items | ChangeItem[] |
ResourceCostEstimate
| id | ResourceCostEstimateId |
| workspaceId | WorkspaceId |
| subject | CostSubject |
| window | CostWindow |
| amount | Money |
| method | CostEstimateMethod |
| assumptions | CostAssumption[] |
| matchedPriceItems | PriceCatalogItemRef[] |
| confidence | CostConfidence |
| evidence | CostEvidence[] |
| generatedAt | string |
ResourceCostEstimateId
string
ResourceCostExplainResult
| explanation | ResourceCostExplanation |
| generatedAt | string |
ResourceCostExplanation
| subject | ResourceCostSubject |
| window | CostWindow |
| actualTotal | Money | null |
| facts | ResourceCostFact[] |
| estimate | ResourceCostEstimate | null |
| priceMatch | PriceMatch | null |
| owner | CostOwner | null |
| appliedAllocationRules | { ruleId: CostAllocationRuleId; version: number; name: string }[] |
| assumptions | CostAssumption[] |
| evidence | CostEvidence[] |
| confidence | CostConfidence |
| diagnostics | CostDiagnostic[] |
ResourceCostFact
| id | ResourceCostFactId |
| workspaceId | WorkspaceId |
| subject | CostSubject |
| window | CostWindow |
| provider | string |
| sourceId | SourceId | null |
| namespace | string |
| key | string |
| amount | Money |
| costBasis | CostBasis |
| chargeType | ChargeType |
| allocationStatus | AllocationStatus |
| confidence | CostConfidence |
| provenance | CostProvenance |
| tags | map<string, string> |
| dimensions | map<string, string> |
| createdAt | string |
ResourceCostFactId
string
ResourceCostSubject
| kind | "resource" |
| resourceId | ResourceId |
| resourceType | string |
| provider | string | null |
| region | string | null |
| displayName | string | null |
ResourceDto
| id | string |
| workspaceId | string |
| canonicalIdentityKey | string |
| semanticType | string |
| providerType | string |
| coverageKey | string |
| lifecycleState | string |
ResourceId
string
ResourceNotificationSubject
| kind | "resource" |
| workspaceId | WorkspaceId |
| resourceId | string |
| displayName | string |
ResourceObservationId
string
ResourcePricingGetResult
| resourceId | string |
| priced | boolean |
| currency | string | null |
| hourly | number | null |
| monthly | number | null |
| unit | string | null |
| hoursPerMonthAssumed | number |
ResourceRevisionId
string
ResourceSummary
| resourceId | ResourceId |
| workspaceId | WorkspaceId |
| revisionId | WorkspaceGraphRevisionId |
| semanticType | string |
| displayName | string |
| providerKey | ProviderKey |
| region | string | null |
| environmentId | EnvironmentId | null |
| sensitive | boolean |
| updatedAt | string |
RetentionApplicationBody
| policies? | RetentionPolicyHttpInput[] |
| retentionPolicyIds? | string[] |
| apply? | boolean |
RetentionCandidateHttpItem
| target | string |
| id | string |
| ageDays | number |
| reason | string |
RetentionCompactionOutcomeHttpItem
| policyName | string |
| applied | boolean |
| candidatesCount | number |
| compactedResourceRevisionCount | number |
| compactedConnectionRevisionCount | number |
RetentionPolicyHttpInput
| id | string |
| name | string |
| target | RetentionTarget |
| retainForDays | number |
| minimumKept | number |
RetentionPolicyHttpItem
| id | string |
| name | string |
| target | string |
| retainForDays | number |
| minimumKept | number |
RetentionPolicyRecordHttpItem
| id | string |
| accountId | string |
| name | string |
| target | string |
| retainForDays | number |
| minimumKept | number |
| createdAt | string |
RetentionTarget
"compact_revisions" | "observations" | "revisions" | "snapshots" | "view_revisions"
RevisionQualityHttpDto
| coverage | string |
| freshness | string |
| perKey | { coverageKey: string; authority: string }[] |
RotateBody
| secretRef? | string |
| secretStoreKey? | string |
| credentialKind? | string |
| displayName? | string |
| secretMaterial? | any |
RotateSourceCredentialHttpResponse
| id | string |
| accountId | string |
| displayName | string |
| credentialKind | string |
| secretRef | string |
| createdAt | string |
RuleCreateBody
| name? | string |
| workspaceId? | string |
| condition? | AlertRuleCondition |
| enabled? | boolean |
| severity? | "critical" | "high" | "info" | "low" | "medium" |
RuleSaveBody
| ruleId? | string |
| rule? | { name?: string; description?: string; selector?: CostSubjectSelector; allocateTo?: object | object | object | object | object; method?: "custom_expression" | "direct_owner" | "environment" | "equal_split" | "provider_scope" | "resource_owner" | "tag_value" | "weighted_by_cost" | "weighted_by_resource_count" | "weighted_by_usage"; splitTargets?: CostAllocationTarget[]; priority?: number; effectiveFrom?: string; effectiveTo?: string | null } |
RuleUpdateBody
| name? | string |
| enabled? | boolean |
| condition? | AlertRuleCondition |
| severity? | "critical" | "high" | "info" | "low" | "medium" | null |
RunCheckBody
| mode? | string |
| force? | boolean |
RunSourceSyncHttpResponse
| sourceSyncId | string |
| sourceSnapshotId | string |
| workspaceGraphRevisionId | string | null |
| resourceRevisionsAppended | number |
| connectionRevisionsAppended | number |
| graphStateHash | string | null |
SamlAttributeMapping
| subject | SamlAttributeSource |
| SamlAttributeSource | |
| displayName? | { kind: "name_id" } | { kind: "attribute"; name: string; friendlyName?: string } | { kind: "constant"; value: string } | { kind: "template"; template: string } |
| givenName? | { kind: "name_id" } | { kind: "attribute"; name: string; friendlyName?: string } | { kind: "constant"; value: string } | { kind: "template"; template: string } |
| familyName? | { kind: "name_id" } | { kind: "attribute"; name: string; friendlyName?: string } | { kind: "constant"; value: string } | { kind: "template"; template: string } |
| groups? | { kind: "name_id" } | { kind: "attribute"; name: string; friendlyName?: string } | { kind: "constant"; value: string } | { kind: "template"; template: string } |
| roles? | { kind: "name_id" } | { kind: "attribute"; name: string; friendlyName?: string } | { kind: "constant"; value: string } | { kind: "template"; template: string } |
| accountHint? | { kind: "name_id" } | { kind: "attribute"; name: string; friendlyName?: string } | { kind: "constant"; value: string } | { kind: "template"; template: string } |
| workspaceHints? | { kind: "name_id" } | { kind: "attribute"; name: string; friendlyName?: string } | { kind: "constant"; value: string } | { kind: "template"; template: string } |
SamlAttributeSource
object | object | object | object
SamlBinding
"HTTP-Artifact" | "HTTP-POST" | "HTTP-Redirect" | "SOAP"
SamlCertificateDescriptor
| certificateId | string |
| fingerprintSha256 | string |
| notBefore? | string |
| notAfter? | string |
| use | "encryption" | "signing" | "unspecified" |
| status | "active" | "expired" | "next" | "revoked" |
| pem? | string |
SamlCertificateRolloverMode
"active_and_next" | "strict_active_only" | "trust_metadata_all_signing"
SamlConfigurationId
string
SamlConfigurationStatus
"active" | "disabled" | "draft" | "expired" | "invalid"
SamlGroupRoleMapping
| group | string |
| accountRole? | string |
| workspaceRole? | string |
| workspaceId? | string |
SamlIdentityProviderConfig
| entityId | string |
| ssoUrl | string |
| sloUrl? | string |
| certificates | SamlCertificateDescriptor[] |
| metadataSource | SamlMetadataSource |
| acceptedBindings | SamlBinding[] |
SamlMetadataSource
object | object | object
SamlProvisioningMode
"auto_link_existing_email" | "disabled" | "existing_user_only" | "just_in_time_user"
SamlProvisioningPolicy
| mode | SamlProvisioningMode |
| defaultAccountRole? | string |
| defaultWorkspaceRole? | string |
| groupRoleMappings | SamlGroupRoleMapping[] |
| requiredGroups? | string[] |
| blockedGroups? | string[] |
| emailDomainAllowlist? | string[] |
| requireVerifiedEmail | boolean |
SamlSecurityPolicy
| maxClockSkewSeconds | number |
| maxAssertionAgeSeconds | number |
| requireEncryptedAssertions | boolean |
| requireSignedAssertions | boolean |
| requireSignedResponse | boolean |
| allowIdpInitiatedLogin | boolean |
| allowUnsolicitedRelayState | boolean |
| replayWindowSeconds | number |
| allowedAudiences | string[] |
| allowedRecipients | string[] |
| allowedDestinations | string[] |
| certificateRolloverMode | SamlCertificateRolloverMode |
SamlServiceProviderConfig
| entityId | string |
| assertionConsumerServiceUrl | string |
| singleLogoutServiceUrl? | string |
| nameIdFormat? | "emailAddress" | "entity" | "kerberos" | "persistent" | "transient" | "unspecified" | "windowsDomainQualifiedName" |
| authnRequestSigned | boolean |
| wantAssertionsSigned | boolean |
| wantResponseSigned | boolean |
| signingKeyRef? | SecretRef |
| signingCertificateRef? | SecretRef |
| allowedBindings | SamlBinding[] |
SavedView
SavedViewCreateBody
| name | string |
| query | string |
SavedViewUpdateBody
| name? | string |
| query? | string |
ScimAddressAttribute
| type? | string |
| formatted? | string |
| streetAddress? | string |
| locality? | string |
| region? | string |
| postalCode? | string |
| country? | string |
| primary? | boolean |
ScimGroupMember
| value | string |
| $ref? | string |
| display? | string |
| type? | "Group" | "User" |
ScimGroupRef
| value | string |
| $ref? | string |
| display? | string |
| type? | "direct" | "indirect" |
ScimGroupResource
| schemas | string[] |
| id | string |
| externalId? | string |
| displayName | string |
| members? | ScimGroupMember[] |
| meta | ScimMeta |
ScimMeta
| resourceType | "Group" | "User" |
| created | TimestampIso |
| lastModified | TimestampIso |
| location | string |
| version? | string |
ScimMultiValueAttribute
| value | string |
| type? | string |
| primary? | boolean |
| display? | string |
| $ref? | string |
ScimResourceType
| schemas | string[] |
| id | string |
| name | string |
| endpoint | string |
| description | string |
| schema | string |
| schemaExtensions? | { schema: string; required: boolean }[] |
| meta | { resourceType: "ResourceType"; location: string } |
ScimSchemaAttribute
| name | string |
| type | "boolean" | "complex" | "dateTime" | "reference" | "string" |
| multiValued | boolean |
| required | boolean |
| caseExact? | boolean |
| mutability? | "immutable" | "readOnly" | "readWrite" | "writeOnly" |
| returned? | "always" | "default" | "never" | "request" |
| uniqueness? | "global" | "none" | "server" |
| subAttributes? | ScimSchemaAttribute[] |
ScimSchemaDefinition
| id | string |
| name | string |
| description | string |
| attributes | ScimSchemaAttribute[] |
| meta | { resourceType: "Schema"; location: string } |
ScimServiceProviderConfig
| schemas | string[] |
| documentationUri? | string |
| patch | { supported: boolean } |
| bulk | { supported: boolean; maxOperations: number; maxPayloadSize: number } |
| filter | { supported: boolean; maxResults: number } |
| changePassword | { supported: boolean } |
| sort | { supported: boolean } |
| etag | { supported: boolean } |
| authenticationSchemes | { type: string; name: string; description: string; primary?: boolean }[] |
| meta | { resourceType: "ServiceProviderConfig"; location: string } |
ScimUserName
| formatted? | string |
| familyName? | string |
| givenName? | string |
| middleName? | string |
| honorificPrefix? | string |
| honorificSuffix? | string |
ScimUserResource
| schemas | string[] |
| id | string |
| externalId? | string |
| userName | string |
| active? | boolean |
| name? | ScimUserName |
| displayName? | string |
| nickName? | string |
| title? | string |
| userType? | string |
| preferredLanguage? | string |
| locale? | string |
| timezone? | string |
| emails? | ScimMultiValueAttribute[] |
| phoneNumbers? | ScimMultiValueAttribute[] |
| photos? | ScimMultiValueAttribute[] |
| addresses? | ScimAddressAttribute[] |
| groups? | ScimGroupRef[] |
| meta | ScimMeta |
ScopeMembershipEdgeId
string
ScopeNodeId
string
SearchEntityKind
"connection" | "diagnostic" | "job" | "resource" | "source" | "view"
SearchFacet
| field | string |
| values | SearchFacetValue[] |
SearchFacetValue
| value | string |
| count | number |
SearchHit
| id | string |
| kind | SearchEntityKind |
| workspaceId | WorkspaceId | null |
| title | string |
| subtitle | string | null |
| snippet | string | null |
| score | number |
| providerKey | ProviderKey | null |
| semanticType | string | null |
| lifecycleState | string | null |
| region | string | null |
| updatedAt | string |
SearchResultPage
| hits | SearchHit[] |
| facets | SearchFacet[] |
| total | number |
| nextCursor | string | null |
SecretRef
string
SelfServeCadence
"annual" | "monthly" | "quarterly"
SelfServePlan
| planKey | string |
| familyKey | string |
| displayName | string |
| description? | string |
| tier | PlanTier |
| currentVersion | number |
| cadences | SelfServeCadence[] |
| entitlements | EntitlementTemplate[] |
| trial? | { days: number; signupDefault: boolean } |
SensitiveFieldPolicyRecordHttpItem
| id | string |
| accountId | string |
| name | string |
| attributePathGlobs | string[] |
| action | string |
| createdAt | string |
ServiceCostSubject
| kind | "service" |
| provider | string | null |
| service | string |
SetAccountTemplateOverrideHttpResponse
| templateKey | string |
| updatedAt | string |
SetViewTemplateOverrideHttpResponse
| viewId | string |
| updatedAt | string |
Severity
"critical" | "high" | "info" | "low" | "medium"
SlackChannelInfo
| id | string |
| name | string |
| isPrivate | boolean |
SlackCommandResponse
| response_type | "ephemeral" |
| text | string |
Source
| id | SourceId |
| accountId | AccountId |
| workspaceId | WorkspaceId |
| providerKey | string |
| displayName | string |
| credentialReferenceId | SourceCredentialReferenceId |
| createdAt | string (date-time) |
| providerScopeId | ProviderScopeId | null |
| archivedAt | string (date-time) | null |
| parameters | kumo-contracts.JsonObject | null |
| isArchived | boolean |
SourceArchiveResult
| source | Source |
SourceChangeSubject
| kind | "source" |
| sourceId | SourceId |
SourceConnectDiagnostic
| severity | string |
| code | string |
| message | string |
SourceConnectResult
| sourceId | string |
| workspaceId | string |
| providerKey | string |
| displayName | string |
| credentialId | string |
| providerScopeId | string |
| providerScopeKey | string |
| providerScopeStatus | string |
| syncStarted | boolean |
| workspaceSyncRunId | string | null |
| discoveryDiagnostics | SourceConnectDiagnostic[] |
SourceCostSubject
| kind | "source" |
| sourceId | SourceId |
SourceCredentialReferenceId
string
SourceId
string
SourceModel
| schemaVersion | string |
| id? | string |
| type? | string |
| data? | map<string, any> |
| meta? | map<string, any> |
| nodes | Entity[] |
| edges | Connection[] |
SourceNotificationSubject
| kind | "source" |
| workspaceId | WorkspaceId |
| sourceId | SourceId |
| sourceSyncId? | SourceSyncId |
| displayName | string |
SourceParametersUpdateHttpResponse
| id | string |
| accountId | string |
| workspaceId | string |
| providerKey | string |
| displayName | string |
| credentialReferenceId | string |
| providerScopeId | string | null |
| createdAt | string |
| archivedAt | string | null |
| parameters | kumo-contracts.JsonObject | null |
SourcePreflightResult
| supported | boolean |
| identity? | { principal: string; scopeHint?: string; detail?: map<string, string> } |
| providerScopes | { key: string; displayName?: string; scopeKind?: string }[] |
| diagnostics | { severity: AdapterDiagnosticSeverity; code: string; message: string }[] |
SourceSnapshotId
string
SourceSyncCoverage
"full" | "partial" | "skipped" | "unknown"
SourceSyncGetHttpResponse
| id | string |
| sourceId | string |
| status | string |
| triggerKind | string |
| plannedAt | string |
| startedAt | string | null |
| completedAt | string | null |
| rejectionReason | string | null |
SourceSyncId
string
SourceSyncState
"failed" | "never" | "partial" | "running" | "succeeded"
SourceSyncStatus
| workspaceId | WorkspaceId |
| sourceId | SourceId |
| providerKey | ProviderKey |
| lastSyncRunId | WorkspaceSyncRunId | null |
| state | SourceSyncState |
| coverage | SourceSyncCoverage |
| startedAt | string | null |
| finishedAt | string | null |
| resourceCount | number |
| errorCount | number |
SourceSyncsListHttpResponseItem
| id | string |
| sourceId | string |
| status | string |
| triggerKind | string |
| plannedAt | string |
| startedAt | string | null |
| completedAt | string | null |
| rejectionReason | string | null |
SourceUnarchiveResult
| source | Source |
SsoSamlConfigurationDto
| id | string |
| status | SamlConfigurationStatus |
| displayName | string |
| serviceProvider | SamlServiceProviderConfig |
| identityProvider | SamlIdentityProviderConfig |
| attributeMapping | SamlAttributeMapping |
| provisioningPolicy | SamlProvisioningPolicy |
| securityPolicy | SamlSecurityPolicy |
| createdAt | string |
| updatedAt | string |
| activatedAt? | string |
| disabledAt? | string |
| version | number |
SsoSetupValues
| saml | { entityId: string; assertionConsumerServiceUrl: string } |
| oidc | { redirectUri: string } |
StartBody
| finalizationPolicy? | "accept_partial" | "strict" |
| triggerKind? | string |
| leaseTtlMs? | number | null |
| reason? | string |
| sourceSelection? | any |
| syncKind? | string |
StartWorkspaceSyncRunHttpResponse
| workspaceSyncRunId | string |
| memberSourceIds | string[] |
SubscriptionCreateBody
| workspaceId? | string |
| subscriber? | UserNotificationRecipient | TeamNotificationRecipient | WorkspaceNotificationRecipient | ExternalNotificationRecipient |
| selector? | NotificationSubjectSelector |
| kinds? | NotificationKind[] |
| channels? | NotificationChannel[] |
| minimumSeverity? | "critical" | "error" | "info" | "success" | "warning" |
SubscriptionId
string
SuppressedChange
| subject | ChangeSubject |
| atomKind | ChangeAtomKind |
| fieldPath | string | null |
| reason | string |
SyncBody
| triggerKind? | "manual" | "scheduled" | "webhook" |
| parameters? | map<string, any> |
| workspaceSyncRunId? | any |
SyncDiagnosticWire
| id | string |
| seq | number |
| accountId | string |
| workspaceId | string |
| sourceId | string |
| sourceSyncId | string |
| workspaceSyncRunId | string | null |
| emittedAt | string |
| severity | string |
| phase | string |
| code | string |
| message | string |
| remediation | string | null |
| coverageKey | string | null |
| providerScopeKey | string | null |
| resourceKey | string | null |
| connectionKey | string | null |
| details | map<string, any> | null |
SyncDiagnosticsListHttpResponse
| items | SyncDiagnosticWire[] |
| nextAfterSeq | number | null |
SystemNotificationSubject
| kind | "system" |
| workspaceId? | WorkspaceId |
| displayName | string |
TagCostSubject
| kind | "tag" |
| tagKey | string |
| tagValue | string |
TargetCreateBody
| name? | string |
| workspaceId? | string |
| channel? | "email" | "slack" | "webhook" |
| destination? | string |
| enabled? | boolean |
| minSeverity? | "critical" | "high" | "info" | "low" | "medium" |
TargetUpdateBody
| name? | string |
| enabled? | boolean |
| channel? | "email" | "slack" | "webhook" |
| destination? | string |
| minSeverity? | "critical" | "high" | "info" | "low" | "medium" | null |
TeamCostSubject
| kind | "team" |
| teamKey | string |
| displayName | string | null |
TeamNotificationRecipient
| kind | "team" |
| teamId | string |
| accountId | AccountId |
TenantAuditRecordDto
| id | string |
| eventType | string |
| outcome | string |
| severity | string |
| occurredAt | string |
| recordedAt | string |
| actor | { kind: string; principalId: string | null; userId: string | null; displayName: string | null; authMethod: string | null; impersonated: boolean } |
| scopeKind | string |
| workspaceId | string | null |
| target | { type: string; id: string | null; displayName: string | null } | null |
| reason | string | null |
| sourcePackage | string |
TenantFeatureAvailabilityDto
| featureKey | string |
| enabled | boolean |
| visible | boolean |
| reasonCode | TenantFeatureReasonCode |
| reasonMessage | string |
| kind | TenantFeatureKind |
| softLimit | number | null |
| hardLimit | number | null |
| upgradeHint | string | null |
TenantFeatureKind
"allowlist" | "configuration" | "credit" | "deny" | "flag" | "limit"
TenantFeatureReasonCode
"ACCOUNT_SUSPENDED" | "DEPLOYMENT_KIND_INCOMPATIBLE" | "ENTITLEMENT_EXPIRED" | "ENTITLEMENT_NOT_YET_ACTIVE" | "FEATURE_CONFLICT" | "FEATURE_DENIED_BY_DEFAULT" | "FEATURE_DENIED_BY_OVERRIDE" | "FEATURE_GRANTED_BY_ADDON" | "FEATURE_GRANTED_BY_INTERNAL_DEFAULT" | "FEATURE_GRANTED_BY_MIGRATION" | "FEATURE_GRANTED_BY_OVERRIDE" | "FEATURE_GRANTED_BY_PLAN" | "FEATURE_GRANTED_BY_TRIAL" | "FEATURE_UNKNOWN" | "FEATURE_WITHHELD_DURING_TRIAL" | "LICENSE_DENIED" | "PLAN_VERSION_NOT_FOUND" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TRIAL_EXPIRED" | "WORKSPACE_ARCHIVED"
TenantFeatureResponseDto
| feature | TenantFeatureAvailabilityDto |
| evaluatedAt | string |
| cacheKey | string |
TenantFeaturesResponseDto
| features | TenantFeatureAvailabilityDto[] |
| evaluatedAt | string |
| cacheKey | string |
TestSendBody
| channel? | "cli" | "desktop" | "email" | "in_app" | "mobile_push" | "slack" | "webhook" |
| address? | string |
TimestampIso
string
TokenCreateBody
| displayName? | string |
| scope? | string |
| expiresAt? | string |
TokenMintBody
| name? | string |
| expiresAt? | string |
UpdateRoleBody
| permissions? | string[] |
| displayName? | string |
| description? | string |
UpdateWebhookSubscriptionRequestBody
| enabled | boolean |
UsageAdjustmentId
string
UsageAggregation
"distinct_count" | "duration_accrual" | "high_watermark" | "last" | "max" | "storage_accrual" | "sum"
UsageCounterDto
| accountId | AccountId |
| id | UsageCounterId |
| subject | UsageSubject |
| createdAt | string |
| updatedAt | string |
| meterKey | UsageMeterKey |
| meterVersion | number |
| window | UsageWindow |
| used | UsageQuantity |
| reserved | UsageQuantity |
| committed | UsageQuantity |
| adjusted | UsageQuantity |
| lastLedgerSequence | string |
UsageCounterId
string
UsageCounterViewDto
| counter | UsageCounterDto |
| effectiveUsed | string |
| breakdown? | UsageLedgerEntryDto[] |
UsageDimensions
| provider? | string |
| providerAccountId? | string |
| providerRegion? | string |
| runtimeProfile? | string |
| workspaceId? | WorkspaceId |
| sourceId? | SourceId |
| sourceKind? | string |
| resourceType? | string |
| connectionType? | string |
| viewTemplateId? | ViewTemplateId |
| jobKind? | string |
| jobId? | string |
| planKey? | string |
| featureKey? | string |
| actorKind? | string |
| actorRole? | string |
UsageEvidenceRef
| kind | "artifact" | "entity" | "note" | "url" |
| ref | string |
| note? | string |
UsageExport
| id | UsageExportId |
| accountId | AccountId |
| window | UsageWindow |
| format | UsageExportFormat |
| meterKeys | UsageMeterKey[] |
| lines | UsageExportLine[] |
| entryCount | number |
| firstSequence? | string |
| lastSequence? | string |
| generatedAt | string |
UsageExportFormat
"csv" | "json"
UsageExportId
string
UsageExportLine
| meterKey | UsageMeterKey |
| unit | UsageUnit |
| subjectKey? | string |
| gross | string |
| adjustments | string |
| net | string |
| entryCount | number |
UsageIdempotencyKey
string
UsageLedgerEntryDto
| accountId | AccountId |
| id | UsageLedgerEntryId |
| source | UsageSourceRef |
| quantity | UsageQuantity |
| subject | UsageSubject |
| evidence | UsageEvidenceRef[] |
| meterKey | UsageMeterKey |
| meterVersion | number |
| window | UsageWindow |
| entryKind | UsageLedgerEntryKind |
| effectiveQuantity | UsageQuantity |
| dimensions | UsageDimensions |
| idempotencyKey | UsageIdempotencyKey |
| occurredAt | string |
| recordedAt | string |
| reversedEntryId? | UsageLedgerEntryId |
| adjustmentForEntryId? | UsageLedgerEntryId |
| metadata? | boolean | string | number | UsageJson[] | map<string, UsageJson> | null |
| sequence | string |
UsageLedgerEntryId
string
UsageLedgerEntryKind
"adjustment" | "counter_rebuild_marker" | "reservation_committed" | "reservation_created" | "reservation_expired" | "reservation_released" | "reversal" | "usage"
UsageLedgerPageDto
| entries | UsageLedgerEntryDto[] |
| nextAfterSequence? | string |
UsageMeterDefinition
| key | UsageMeterKey |
| version | number |
| displayName | string |
| description | string |
| unit | UsageUnit |
| aggregation | UsageAggregation |
| windowing | UsageWindowing |
| subjectKind | UsageSubjectKind |
| dimensionality | "actorKind" | "actorRole" | "connectionType" | "featureKey" | "jobId" | "jobKind" | "planKey" | "provider" | "providerAccountId" | "providerRegion" | "resourceType" | "runtimeProfile" | "sourceId" | "sourceKind" | "viewTemplateId" | "workspaceId"[] |
| billable | boolean |
| quotaImpacting | boolean |
| exportable | boolean |
| effectiveFrom | string |
| effectiveTo? | string |
UsageMeterKey
"agent.job.completed" | "api.request.count" | "environment.evaluation.completed" | "graph.connection_observed" | "graph.diff_generated" | "graph.resource_observed" | "graph.workspace_revision_created" | "report.generation.completed" | "source.sync.completed" | "source.sync.compute_seconds" | "source.sync.failed" | "source.sync.provider_api_call_estimate" | "storage.artifact_byte_hours" | "storage.export_byte_hours" | "storage.snapshot_byte_hours" | "view.export.completed" | "view.generation.completed" | "view.generation.compute_seconds" | "worker.compute_seconds" | string
UsageQuantity
| value | string |
| unit | UsageUnit |
| scale? | number |
UsageReconciliationRunId
string
UsageReservation
| id | UsageReservationId |
| accountId | AccountId |
| subject | UsageSubject |
| meterKey | UsageMeterKey |
| meterVersion | number |
| window | UsageWindow |
| quantity | UsageQuantity |
| committedQuantity? | UsageQuantity |
| status | UsageReservationStatus |
| idempotencyKey | UsageIdempotencyKey |
| expiresAt | string |
| source | UsageSourceRef |
| createdAt | string |
| committedAt? | string |
| releasedAt? | string |
| expiredAt? | string |
UsageReservationId
string
UsageReservationStatus
"active" | "committed" | "expired" | "released"
UsageSourceRef
object | object | object | object | object | object
UsageSubject
| kind | UsageSubjectKind |
| accountId | AccountId |
| workspaceId? | WorkspaceId |
| sourceId? | SourceId |
| providerScopeId? | ProviderScopeId |
| environmentId? | EnvironmentId |
| viewId? | ViewId |
| userId? | UserId |
| agentId? | string |
UsageSubjectKind
"account" | "agent" | "environment" | "provider_scope" | "source" | "tenant" | "user" | "view" | "workspace"
UsageUnit
"api_request" | "byte" | "byte_hour" | "compute_second" | "connection" | "count" | "custom" | "gb_day" | "provider_api_call" | "report_generation" | "resource" | "revision" | "second" | "view_generation"
UsageWindow
| kind | UsageWindowKind |
| startsAt | string |
| endsAt | string |
| timezone? | string |
UsageWindowKind
"billing_period" | "day" | "hour" | "instant" | "month" | "rolling" | "week"
UsageWindowing
| kind | UsageWindowKind |
| timezone? | string |
UserId
string
ViewAccessGrantCreateResult
| grant | ViewAccessGrantSummary |
| existing | boolean |
ViewAccessGrantId
string
ViewAccessGrantReceived
| grant | ViewAccessGrantSummary |
| viewName | string |
| via | "role" | "user" |
ViewAccessGrantRevokeResult
ViewAccessGrantSummary
| id | ViewAccessGrantId |
| accountId | AccountId |
| workspaceId | WorkspaceId |
| environmentId | EnvironmentId |
| viewId | ViewId |
| grantee | ViewAccessGrantee |
| createdByUserId | UserId |
| createdAt | string (date-time) |
| revokedAt | string (date-time) | null |
ViewAccessGrantee
object | object
ViewAccessGrantsListResult
| items | ViewAccessGrantSummary[] |
ViewAccessGrantsReceivedListResult
| items | ViewAccessGrantReceived[] |
ViewByAccountItemDto
| id | string |
| name | string |
| origin | string |
| environmentId | string |
| environmentName | string |
| workspaceId | string |
| workspaceName | string |
| createdAt | string |
| providers | string[] |
ViewChangeSubject
| kind | "view" |
| viewId | ViewId |
ViewConfigurationHttpItem
| id | string |
| viewId | string |
| viewTemplateVersionId | string |
| parameters | map<string, any> |
| configurationHash | string |
| createdAt | string |
ViewHttpItem
| id | string |
| environmentId | string |
| name | string |
| origin | string |
| createdAt | string |
ViewId
string
ViewNotificationSubject
| kind | "view" |
| workspaceId | WorkspaceId |
| viewId | ViewId |
| viewRevisionId? | ViewRevisionId |
| displayName | string |
ViewRevisionArtifactHttpItem
| kind | string |
| contentBlobSha | string |
| artifactHash | string |
| contentType | string |
| byteLength | number |
ViewRevisionHttpItem
| id | string |
| viewId | string |
| viewConfigurationId | string |
| viewTemplateVersionId | string |
| environmentRevisionId | string |
| workspaceGraphRevisionId | string |
| inputHash | string |
| visualGraphModelHash | string |
| layoutHash | string |
| status | string |
| artifacts | ViewRevisionArtifactHttpItem[] |
| createdAt | string |
ViewRevisionId
string
ViewSourceModelBuildHttpResponse
| viewConfigurationId | string |
| viewTemplateVersionId | string |
| environmentRevisionId | string |
| workspaceGraphRevisionId | string |
| templateKey | string |
| templateVersion | string |
| resourceCount | number |
| connectionCount | number |
| sourceModel | SourceModel |
| template? | any |
| contextQuery? | any |
| options? | { showRoutes?: boolean } |
| diagrammarEnabled | boolean |
ViewTemplateCreateHttpResponse
| id | string |
| accountId | string | null |
| templateKey | string |
| displayName | string |
| createdAt | string |
| created | boolean |
ViewTemplateHttpItem
| id | string |
| accountId | string | null |
| templateKey | string |
| displayName | string |
| createdAt | string |
ViewTemplateId
string
ViewTemplateVersionCreateHttpResponse
| id | string |
| viewTemplateId | string |
| version | string |
| status | string |
| templateHash | string |
| createdAt | string |
ViewTemplateVersionHttpItem
| id | string |
| viewTemplateId | string |
| version | string |
| status | string |
| templateHash | string |
| createdAt | string |
WasteFinding
| id | WasteFindingId |
| workspaceId | WorkspaceId |
| subject | CostSubject |
| kind | WasteFindingKind |
| title | string |
| summary | string |
| estimatedMonthlyWaste | Money | null |
| actualWindowWaste | Money | null |
| severity | CostSeverity |
| confidence | CostConfidence |
| evidence | CostEvidence[] |
| recommendationIds | CostRecommendationId[] |
| firstDetectedAt | string |
| lastDetectedAt | string |
| status | WasteFindingStatus |
WasteFindingId
string
WasteFindingKind
"duplicate_resource" | "expensive_network_path" | "idle_compute" | "low_traffic_nat_gateway" | "low_utilization_database" | "old_snapshot" | "orphaned_public_ip" | "oversized_compute" | "stopped_compute_with_attached_cost" | "unallocated_spend" | "unattached_volume" | "underutilized_commitment" | "unknown" | "unowned_high_cost_resource" | "unused_commitment" | "unused_load_balancer"
WasteFindingStatus
"acknowledged" | "active" | "dismissed" | "resolved"
WebhookDeliveryListResult
| deliveries | WebhookDeliverySummary[] |
WebhookDeliverySummary
| id | string |
| subscriptionId | string |
| accountId | AccountId |
| eventId | string |
| eventType | string |
| status | "dead" | "delivered" | "failed" | "pending" |
| attempts | number |
| maxAttempts | number |
| nextAttemptAt | TimestampIso | null |
| lastError | string | null |
| createdAt | TimestampIso |
| updatedAt | TimestampIso |
WebhookEventTypeListResult
| eventTypes | string[] |
WebhookSubscription
| id | string |
| accountId | AccountId |
| url | string |
| description? | string |
| enabled | boolean |
| eventTypes | string[] |
| secretRef | string |
| createdAt | TimestampIso |
| updatedAt | TimestampIso |
| disabledAt? | TimestampIso | null |
WebhookSubscriptionCreateResult
| subscription | WebhookSubscription |
| signingSecret | string |
WebhookSubscriptionDeleteResult
| id | string |
WebhookSubscriptionGetResult
| subscription | WebhookSubscription |
WebhookSubscriptionListResult
| subscriptions | WebhookSubscription[] |
WebhookSubscriptionRotateSecretResult
| subscription | WebhookSubscription |
| signingSecret | string |
WebhookSubscriptionUpdateResult
| subscription | WebhookSubscription |
WorkspaceAccessDto
| workspaceId | string |
| workspaceActions | map<string, boolean> |
| accountActions | map<string, boolean> |
WorkspaceArchiveResult
| workspace | WorkspaceProjection |
WorkspaceChangeSubject
| kind | "workspace" |
| workspaceId | WorkspaceId |
WorkspaceChangesListResult
| items | ChangeItem[] |
| nextCursor | string | null |
WorkspaceCostAnalyzeResult
| workspaceId | WorkspaceId |
| window | CostWindow |
| currency | string |
| summary | CostSummary |
| rollups | CostRollup[] |
| waste | WasteFinding[] |
| recommendations | CostRecommendation[] |
| coverage | CostCoverageResult |
| diagnostics | CostDiagnostic[] |
| generatedAt | string |
WorkspaceCostSubject
| kind | "workspace" |
| workspaceId | WorkspaceId |
WorkspaceDto
| id | string |
| accountId | string |
| name | string |
| createdAt | string |
| archivedAt | string | null |
WorkspaceGraphCounts
| workspaceId | WorkspaceId |
| revisionId | WorkspaceGraphRevisionId |
| resourceCount | number |
| connectionCount | number |
| environmentCount | number |
| countsBySemanticType | map<string, number> |
| computedAt | string |
WorkspaceGraphRevisionId
string
WorkspaceId
string
WorkspaceListItemDto
| id | string |
| accountId | string |
| name | string |
| createdAt | string |
| archivedAt | string | null |
WorkspaceNotificationRecipient
| kind | "workspace" |
| workspaceId | WorkspaceId |
| accountId | AccountId |
WorkspaceNotificationSubject
| kind | "workspace" |
| workspaceId | WorkspaceId |
| displayName | string |
WorkspaceProjection
| id | WorkspaceId |
| accountId | AccountId |
| name | string |
| createdAt | string (date-time) |
| archivedAt | string (date-time) | null |
| isArchived | boolean |
WorkspaceSourceModelBuildHttpResponse
| workspaceId | string |
| workspaceGraphRevisionId | string |
| resourceCount | number |
| connectionCount | number |
| sourceModel | SourceModel |
WorkspaceSyncRunDiagnosticsListHttpResponse
| items | SyncDiagnosticWire[] |
| nextAfterSeq | number | null |
WorkspaceSyncRunId
string
WorkspaceSyncRunSourceFailure
| sourceId | string |
| status | "cancelled" | "partial" | "rejected" |
| reason | string | null |
WorkspaceUnarchiveResult
| workspace | WorkspaceProjection |
| archivedSourceIds | SourceId[] |
kumo-billing.EntitlementScope
"account" | "provider" | "source" | "tenant" | "workspace"
kumo-contracts.ActorContext
| userId | UserId |
| accountId | AccountId |
| workspaceId? | WorkspaceId |
| credentialScope? | "read" | "read_write" |
kumo-contracts.ActorRef
| kind | "api_key" | "scheduler" | "service" | "system" | "user" |
| id | string |
| displayName? | string |
kumo-contracts.EntitlementKind
"allowlist" | "configuration" | "credit" | "flag" | "limit"
kumo-contracts.EntitlementScope
"account" | "deployment" | "source" | "user" | "workspace"
kumo-contracts.JsonArray
kumo-contracts.JsonObject
map<string, kumo-contracts.JsonValue>
kumo-contracts.JsonValue
boolean | string | number | kumo-contracts.JsonObject | kumo-contracts.JsonArray | null
kumo-core-server.AnnotationsRoute.CreateBody
| surface? | AnnotationSurface |
| body? | { kind: "note"; text: string; anchorNodeId: string | null } | { kind: "connection"; fromNodeId: string; toNodeId: string; label: string | null } |
kumo-core-server.ChangeIntelligenceRoute.AnalyzeBody
| from? | string |
| to? | string |
| lenses? | ChangeLens[] |
| maxChanges? | number |
| includeSuppressed? | boolean |
kumo-core-server.CostRoute.AnalyzeBody
| window? | { startInclusive?: string; endExclusive?: string } |
| basis? | string |
| currency? | string |
| groupBy? | string[] |
| tagKey? | string |
| includeEstimates? | boolean |
| includeActuals? | boolean |
| includeWaste? | boolean |
| includeRecommendations? | boolean |
kumo-core-server.GraphDiffsRoute.CreateBody
| from? | { workspaceGraphRevisionId?: string } |
| to? | { workspaceGraphRevisionId?: string } |
| force? | boolean |
kumo-core-server.RetentionPoliciesRoute.CreateBody
| name? | string |
| target? | string |
| retainForDays? | number |
| minimumKept? | number |
kumo-core-server.SensitiveFieldPoliciesRoute.CreateBody
| name? | string |
| attributePathGlobs? | string[] |
| action? | string |
kumo-core-server.SourceCredentialsRoute.CreateBody
| displayName? | string |
| credentialKind? | string |
| secretRef? | string |
| secretStoreKey? | string |
| secretMaterial? | string |
| provider? | string |
| metadata? | any |
kumo-core-server.SourcesRoute.CreateBody
| provider? | string |
| providerKey? | string |
| displayName? | string |
| credentialReferenceId? | string |
| sourceCredentialId? | string |
| sourceKind? | string |
| adapterKey? | string |
| schedule? | any |
| configuration? | any |
| providerScopeKey? | string |
Admin API
Control-plane, operator-facing: tenant lifecycle, jobs, provider health, licensing, billing administration. Separate server, separate credentials.
Billing · 23 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/billing/accounts/{accountId}/credit-grantsResponse 200 { data: { grants: BillingCreditGrantRecord[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/accounts/{accountId}/credit-grantsRequest body CreditGrantCreateBody
Response 201 { data: BillingCreditGrantRecord; meta }
| stable | 201 | ||||||||||||||||||||||||||
| GET | /v1/admin/billing/accounts/{accountId}/invoicesQuery
Response 200 { data: { invoices: BillingInvoiceRecord[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| GET | /v1/admin/billing/accounts/{accountId}/payment-methodsResponse 200 { data: { paymentMethods: BillingPaymentMethodRecord[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/accounts/{accountId}/subscription-syncResponse 200 { data: { observed: number; changes: object[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| GET | /v1/admin/billing/accounts/{accountId}/subscriptionsResponse 200 { data: { subscriptions: BillingSubscriptionRecord[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/accounts/{accountId}/subscriptionsRequest body SubscriptionAssignBody
Response 200 { data: { subscription: BillingSubscriptionRecord; changed: boolean }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| GET | /v1/admin/billing/accounts/{accountId}/trialResponse 200 { data: { trial: BillingTrialRecord | null }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/accounts/{accountId}/trialRequest body TrialStartBody
Response 201 { data: { trial: BillingTrialRecord; subscription: BillingSubscriptionRecord }; meta }
| stable | 201 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/credit-grants/{creditGrantId}/expireResponse 200 { data: BillingCreditGrantRecord; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/plan-versions/{planVersionId}/publishRequest body PlanVersionPublishBody
Response 200 { data: { planVersion: BillingPlanVersionRecord; planCurrentVersionId: PlanVersionId | null }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| GET | /v1/admin/billing/plansResponse 200 { data: { plans: BillingPlanRecord[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/plansRequest body PlanCreateBody
Response 201 { data: BillingPlanRecord; meta }
| stable | 201 | ||||||||||||||||||||||||||
| GET | /v1/admin/billing/plans/{planId}Response 200 { data: BillingPlanRecord; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/plans/{planId}/activateResponse 200 { data: BillingPlanRecord; meta }
| stable | 200 | ||||||||||||||||||||||||||
| GET | /v1/admin/billing/plans/{planId}/versionsResponse 200 { data: { planVersions: BillingPlanVersionRecord[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/plans/{planId}/versionsRequest body PlanVersionDraftBody
Response 201 { data: BillingPlanVersionRecord; meta }
| stable | 201 | ||||||||||||||||||||||||||
| GET | /v1/admin/billing/reconciliation-runsResponse 200 { data: { runs: BillingReconciliationRunRecord[] }; meta } | stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/reconciliation-runsRequest body ReconciliationRunStartBody
Response 201 { data: { run: BillingReconciliationRunRecord; accounts: number; accountFailures: number }; meta }
| stable | 201 | ||||||||||||||||||||||||||
| GET | /v1/admin/billing/reconciliation-runs/{runId}Response 200 { data: BillingReconciliationRunRecord; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/seed-plansResponse 200 { data: CommercialCatalogSeedReport; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/trials/{trialStateId}/convertResponse 200 { data: { trial: BillingTrialRecord; subscription: BillingSubscriptionRecord }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/billing/trials/{trialStateId}/expireResponse 200 { data: { trial: BillingTrialRecord; subscription: BillingSubscriptionRecord }; meta }
| stable | 200 |
Entitlements · 12 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/entitlements/accounts/{accountId}Response 200 { data: AdminEntitlementsResolveResponseDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| GET | /v1/admin/entitlements/accounts/{accountId}/explain/{featureKey}Response 200 { data: AdminEntitlementExplainResponseDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| GET | /v1/admin/entitlements/accounts/{accountId}/features/{featureKey}Response 200 { data: AdminFeatureAccessResponseDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| GET | /v1/admin/entitlements/accounts/{accountId}/overridesResponse 200 { data: AdminOverridesListResponseDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| DELETE | /v1/admin/entitlements/accounts/{accountId}/overrides/{featureKey}Request body
Response 200 { data: { removed: boolean; overrideVersion: string | null }; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| POST | /v1/admin/entitlements/accounts/{accountId}/overrides/{featureKey}Request body OverrideBody
Response 200 { data: { overrideId: EntitlementOverrideId; grantId: EntitlementGrantId; overrideVersion: string }; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| POST | /v1/admin/entitlements/snapshotsRequest body SnapshotCreateBody
Response 201 { data: AdminSnapshotCreateResponseDto; meta }
| stable | 201 | ||||||||||||||||||||||||||||
| POST | /v1/admin/entitlements/snapshots/diffRequest body SnapshotDiffBody
Response 200 { data: AdminSnapshotDiffResponseDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| GET | /v1/admin/entitlements/workspaces/{workspaceId}Query
Response 200 { data: AdminEntitlementsResolveResponseDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| GET | /v1/admin/entitlements/workspaces/{workspaceId}/overridesQuery
Response 200 { data: AdminOverridesListResponseDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| DELETE | /v1/admin/entitlements/workspaces/{workspaceId}/overrides/{featureKey}Request body
Response 200 { data: { removed: boolean; overrideVersion: string | null }; meta }
| stable | 200 | ||||||||||||||||||||||||||||
| POST | /v1/admin/entitlements/workspaces/{workspaceId}/overrides/{featureKey}Request body
Response 200 { data: { overrideId: EntitlementOverrideId; grantId: EntitlementGrantId; overrideVersion: string }; meta }
| stable | 200 |
Plans · 9 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/plansQuery
Response 200 { data: PlanDefinition[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/plansRequest body CreatePlanRequestBody
Response 201 { data: PlanCreateResult; meta }
| stable | 201 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/plans/{fromPlanKey}/migration-pathRequest body ResolveMigrationPathRequestBody
Response 200 { data: PlanMigrationPathResolveResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| GET | stable | 200 | |||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/plans/{planKey}/compatibility-checkRequest body CheckCompatibilityRequestBody
Response 200 { data: PlanCompatibilityCheckResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/plans/{planKey}/versionsRequest body CreatePlanVersionRequestBody
Response 201 { data: PlanVersionDraftCreateResult; meta }
| stable | 201 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/plans/{planKey}/versions/{version}/deprecateResponse 200 { data: PlanVersionDeprecateResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/plans/{planKey}/versions/{version}/publishRequest body PublishPlanVersionRequestBody
Response 200 { data: PlanVersionPublishResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| GET | /v1/admin/plans/{planKey}/versions/{version}/resolveResponse 200 { data: PlanVersionResolveResult; meta }
| stable | 200 |
Accounts · 7 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/accountsQuery
Response 200 { data: AdminTenantDto[]; page; meta }
| stable | 200 | ||||||||||||||||||||||
| GET | /v1/admin/accounts/{accountId}Response 200 { data: AdminTenantGetResult; meta }
| stable | 200 | ||||||||||||||||||||||
| DELETE | /v1/admin/accounts/{accountId}/deletionRequest body ReasonBody
Response 200 { data: AdminTenantDeletionCancelResult; meta }
| stable | 200 | ||||||||||||||||||||||
| POST | /v1/admin/accounts/{accountId}/deletionRequest body ReasonBody
Response 200 { data: AdminTenantDeletionStartResult; meta }
| stable | 200 | ||||||||||||||||||||||
| POST | /v1/admin/accounts/{accountId}/reactivateRequest body ReasonBody
Response 200 { data: AdminTenantReactivateResult; meta }
| stable | 200 | ||||||||||||||||||||||
| GET | /v1/admin/accounts/{accountId}/summaryResponse 200 { data: AdminAccountSummaryGetResult; meta }
| stable | 200 | ||||||||||||||||||||||
| POST | /v1/admin/accounts/{accountId}/suspendRequest body ReasonBody
Response 200 { data: AdminTenantSuspendResult; meta }
| stable | 200 |
License · 7 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DELETE | /v1/admin/licenseResponse 200 { data: LicenseDiagnostics; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/admin/licenseResponse 200 { data: LicenseDiagnostics; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/licenseRequest body LicenseInstallInputDto
Response 200 { data: LicenseDiagnostics; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/license/activation-applyRequest body LicenseActivationApplyInputDto
Response 200 { data: LicenseDiagnostics; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/license/activation-requestRequest body LicenseActivationRequestInputDto
Response 200 { data: LicenseActivationRequestDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| GET | /v1/admin/license/fingerprintResponse 200 { data: AdminInstallationFingerprintDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/license/mint-testRequest body LicenseMintTestInputDto
Response 200 { data: { documentText: string; licenseId: string; signedByKeyId: string }; meta }
| stable | 200 |
Plan catalogs · 7 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/plan-catalogsQuery
Response 200 { data: PlanCatalog[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/plan-catalogsRequest body CreateCatalogRequestBody
Response 201 { data: PlanCatalogCreateResult; meta }
| stable | 201 | ||||||||||||||||||||||||||||||||||||||||||
| GET | /v1/admin/plan-catalogs/{catalogId}Response 200 { data: PlanCatalogGetResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/plan-catalogs/{catalogId}/deprecateResponse 200 { data: { auditEventId: string }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/plan-catalogs/{catalogId}/publishResponse 200 { data: { auditEventId: string }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/plan-catalogs/{catalogId}/validateResponse 200 { data: PlanCatalogValidateResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/plan-catalogs/diffRequest body DiffCatalogsRequestBody
Response 200 { data: PlanCatalogDiffOutput; meta } | stable | 200 |
Auth · 6 routes
| Method | Path | Tier | 2xx | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/auth/oidc/callbackQuery
Response 200
| stable | 200 | ||||||||||||
| GET | /v1/admin/auth/oidc/loginResponse 302 no body | stable | |||||||||||||
| POST | /v1/admin/auth/saml/{realmId}/acsRequest body AcsBody
Response 200
| stable | 200 | ||||||||||||
| GET | /v1/admin/auth/saml/{realmId}/loginQuery
Response 302 no body | stable | |||||||||||||
| GET | /v1/admin/auth/saml/{realmId}/metadataResponse 200 application/samlmetadata+xml (file or stream) | stable | 200 | ||||||||||||
| POST | /v1/admin/auth/saml/session-handoffRequest body
Response 200
| stable | 200 |
Usage · 6 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| POST | /v1/admin/usage/adjustRequest body AdjustBody
Response 200 { data: { diagnostics: UsageDiagnostic[]; adjustment?: UsageAdjustment; accepted: boolean; duplicate: boolean }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/usage/exportRequest body ExportBody
Response 200 { data: { export: UsageExport; content: string }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/usage/rebuild-countersRequest body RebuildBody
Response 200 { data: UsageRebuildCountersResult; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/usage/reconcileRequest body AccountBody
Response 200 { data: { run: UsageReconciliationRun; diagnostics: UsageDiagnostic[] }; meta }
| stable | 200 | ||||||||||||||||||||||||||
| GET | /v1/admin/usage/reconciliation-runsQuery
Response 200 { data: UsageReconciliationRun[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||
| POST | /v1/admin/usage/reverseRequest body ReverseBody
Response 200 { data: { diagnostics: UsageDiagnostic[]; reversalEntryId?: UsageLedgerEntryId; accepted: boolean; duplicate: boolean }; meta }
| stable | 200 |
Jobs · 5 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/jobsQuery
Response 200 { data: AdminJobDto[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| GET | /v1/admin/jobs/{jobId}Response 200 { data: AdminJobGetResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/jobs/{jobId}/cancelRequest body MutateBody
Response 200 { data: AdminJobCancelResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/jobs/{jobId}/retryRequest body MutateBody
Response 200 { data: AdminJobRetryResult; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||||||||||||||||
| GET | /v1/admin/jobs/queue-healthQuery
Response 200 { data: AdminQueueHealthResult; meta }
| stable | 200 |
Notifications · 4 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/notifications/deliveriesQuery
Response 200 { data: NotificationDeliveryDto[]; page; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| GET | /v1/admin/notifications/deliveries/{deliveryId}Response 200 { data: NotificationDeliveryTrailDto; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| POST | /v1/admin/notifications/deliveries/{deliveryId}/retryResponse 200 { data: { delivery: NotificationDeliveryDto; outcome: DispatchOutcome; retried: boolean }; meta }
| stable | 200 | ||||||||||||||||||||||||||||||||||||
| GET | /v1/admin/notifications/diagnosticsQuery
Response 200 { data: { notification: NotificationDto; recipients: RecipientNotificationDto[]; deliveries: NotificationDeliveryTrailDto[]; diagnostics: NotificationDiagnosticDto[] }; meta }
| stable | 200 |
Partners · 4 routes
| Method | Path | Tier | 2xx | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | stable | 200 | |||||||||||||
| POST | /v1/admin/partnersRequest body kumo-core-server-admin.CreateBody
Response 201 { data: { partner: Partner }; meta }
| stable | 201 | ||||||||||||
| PATCH | /v1/admin/partners/{partnerId}Request body UpdateBody
Response 200 { data: { partner: Partner }; meta }
| stable | 200 | ||||||||||||
| GET | /v1/admin/partners/{partnerId}/accountsQuery
Response 200 { data: { partnerId: string; accounts: object[] }; meta }
| stable | 200 |
Post sync jobs · 4 routes
| Method | Path | Tier | 2xx | ||||||
|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/post-sync-jobsQuery
Response 200 { data: WgrPostSyncJobsListByStatusResult; meta }
| stable | 200 | ||||||
| GET | /v1/admin/post-sync-jobs/{jobId}Response 200 { data: WgrPostSyncJobGetResult; meta }
| stable | 200 | ||||||
| POST | /v1/admin/post-sync-jobs/{jobId}/retryRequest body RetryBody
Response 200 { data: WgrPostSyncJobRetryFailedResult; meta }
| stable | 200 | ||||||
| GET | /v1/admin/post-sync-jobs/countQuery
Response 200 { data: WgrPostSyncJobsCountByStatusResult; meta }
| stable | 200 |
Features · 3 routes
| Method | Path | Tier | 2xx | ||||
|---|---|---|---|---|---|---|---|
| GET | /v1/admin/featuresQuery
Response 200 { data: FeaturesListResult; meta }
| stable | 200 | ||||
| POST | /v1/admin/featuresRequest body DefineFeatureRequestBody
Response 201 { data: FeatureDefineResult; meta }
| stable | 201 | ||||
| GET | /v1/admin/features/{featureKey}Response 200 { data: FeatureGetResult; meta }
| stable | 200 |
Meters · 3 routes
| Method | Path | Tier | 2xx | ||||
|---|---|---|---|---|---|---|---|
| GET | /v1/admin/metersQuery
Response 200 { data: MetersListResult; meta }
| stable | 200 | ||||
| POST | /v1/admin/metersRequest body DefineMeterRequestBody
Response 201 { data: MeterDefineResult; meta }
| stable | 201 | ||||
| GET | stable | 200 |
Analytics · 2 routes
| Method | Path | Tier | 2xx | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/analyticsQuery
Response 200 { data: AdminAnalyticsRollupGetResult; meta }
| stable | 200 | ||||||||||||
| GET | /v1/admin/analytics/seriesQuery
Response 200 { data: AdminAnalyticsSeriesGetResult; meta }
| stable | 200 |
Feature flags · 2 routes
| Method | Path | Tier | 2xx | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/feature-flags/{accountId}Response 200 { data: AdminFeatureFlagsListResult; meta }
| stable | 200 | ||||||||
| PUT | /v1/admin/feature-flags/{accountId}/{key}Request body SetBody
Response 200 { data: AdminFeatureFlagSetResult; meta }
| stable | 200 |
Storage · 2 routes
| Method | Path | Tier | 2xx | ||||||
|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/storage/historyQuery
Response 200 { data: AdminStorageHistoryGetResult; meta }
| stable | 200 | ||||||
| POST | /v1/admin/storage/snapshotsRequest body SnapshotPgStorageBody
Response 200 { data: StorageUsageSnapshotGetResult; meta }
| stable | 200 |
Account deletions · 1 routes
| Method | Path | Tier | 2xx | ||||
|---|---|---|---|---|---|---|---|
| GET | /v1/admin/account-deletionsQuery
Response 200 { data: AdminTenantDeletionsListResult; meta }
| stable | 200 |
Audit · 1 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/auditQuery
Response 200 { data: AdminAuditRecordDto[]; page; meta }
| stable | 200 |
Authorization denials · 1 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/authorization-denialsQuery
Response 200 { data: AuthorizationDenialRecord[]; page; meta }
| stable | 200 |
Capabilities · 1 routes
| Method | Path | Tier | 2xx | ||||
|---|---|---|---|---|---|---|---|
| GET | /v1/admin/capabilitiesResponse 200 { data: CapabilityReport; meta }
| stable | 200 |
Config · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/admin/configResponse 200 { data: AdminConfigSnapshotsListResult; meta }
| stable | 200 |
Cost projections · 1 routes
| Method | Path | Tier | 2xx | ||||||
|---|---|---|---|---|---|---|---|---|---|
| POST | /v1/admin/cost-projectionsRequest body ProjectCostsBody
Response 200 { data: CostProjectionGetResult; meta }
| stable | 200 |
Diagnostics · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/admin/diagnosticsResponse 200 { data: AdminRuntimeDiagnosticsGetResult; meta }
| stable | 200 |
Healthz · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/admin/healthzResponse 200
| stable | 200 |
Metrics · 1 routes
| Method | Path | Tier | 2xx |
|---|---|---|---|
| GET | stable | 200 |
Migrations · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/admin/migrationsResponse 200 { data: AdminMigrationStatusGetResult; meta }
| stable | 200 |
Overview · 1 routes
| Method | Path | Tier | 2xx | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/overviewResponse 200 { data: AdminOverviewGetResult; meta }
| stable | 200 |
Projections · 1 routes
| Method | Path | Tier | 2xx | ||||
|---|---|---|---|---|---|---|---|
| GET | /v1/admin/projections/healthQuery
Response 200 { data: AdminProjectionHealthGetResult; meta }
| stable | 200 |
Provider health · 1 routes
| Method | Path | Tier | 2xx |
|---|---|---|---|
| GET | /v1/admin/provider-healthResponse 200 { data: AdminProviderHealthGetResult; meta } | stable | 200 |
Readyz · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| GET | /v1/admin/readyzResponse 200
| stable | 200 |
Slo · 1 routes
| Method | Path | Tier | 2xx |
|---|---|---|---|
| GET | stable | 200 |
Support bundle · 1 routes
| Method | Path | Tier | 2xx | ||||
|---|---|---|---|---|---|---|---|
| GET | /v1/admin/support-bundleResponse 200 { data: AdminSupportBundle; meta }
| stable | 200 |
Sync diagnostics · 1 routes
| Method | Path | Tier | 2xx | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/sync-diagnosticsQuery
Response 200 { data: AdminSyncDiagnosticView[]; page; meta }
| stable | 200 |
Telemetry · 1 routes
| Method | Path | Tier | 2xx | ||
|---|---|---|---|---|---|
| POST | /v1/admin/telemetryRequest body
Response 204 no body | stable | 204 |
Whoami · 1 routes
| Method | Path | Tier | 2xx | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /v1/admin/whoamiResponse 200 { data: AdminWhoamiResult; meta }
| stable | 200 |
Schemas · 382 types
AccountBody
| accountId? | string |
| meterKeys? | string[] |
AccountId
string
AcsBody
| SAMLResponse? | string |
| RelayState? | string |
AdapterDiagnosticSeverity
"error" | "fatal" | "info" | "warning"
AddonDefinition
| addonKey | AddonKey |
| displayName | string |
| description? | string |
| lifecycle | AddonLifecycle |
| compatiblePlans | PlanSelector[] |
| incompatiblePlans | PlanSelector[] |
| entitlementTemplates | EntitlementTemplate[] |
| quotaTemplates | QuotaTemplate[] |
| skuRefs | SkuRef[] |
| stackable | boolean |
| maxQuantity? | number | null |
| metadata? | kumo-contracts.JsonObject |
AddonKey
string
AddonLifecycle
"active" | "deprecated" | "draft" | "retired"
AdjustBody
| accountId? | string |
| workspaceId? | string |
| meterKey? | string |
| quantity? | UsageQuantity |
| reason? | string |
| windowStartsAt? | string |
| windowEndsAt? | string |
| adjustedEntryId? | string |
| idempotencyKey? | string |
AdminAccountSummary
| accountId | string |
| workspaceCount | number |
| providerScopeCount | number |
| latestSyncStatus | string | null |
| latestSyncAt | string | null |
| workspaces | AdminAccountWorkspaceSummary[] |
AdminAccountSummaryGetResult
| summary | AdminAccountSummary |
AdminAccountWorkspaceSummary
| id | string |
| name | string |
| latestSyncStatus | string | null |
| latestSyncAt | string | null |
AdminAnalyticsRollupGetResult
| rollup | AnalyticsRollup |
AdminAnalyticsSeriesBucket
| start | string |
| end | string |
| rollup | AnalyticsRollup |
AdminAnalyticsSeriesGetResult
| bucket | AnalyticsBucket |
| buckets | AdminAnalyticsSeriesBucket[] |
AdminAuditRecordDto
| id | string |
| eventType | string |
| outcome | string |
| severity | string |
| actorKind | string |
| actorUserId | string | null |
| actorPrincipalId | string | null |
| actorDisplayName | string | null |
| accountId | string | null |
| workspaceId | string | null |
| targetType | string | null |
| targetId | string | null |
| reason | string | null |
| occurredAt | string |
| recordedAt | string |
AdminConfigSnapshotsListResult
| processes | ProcessConfigSnapshot[] |
AdminDiagnostic
| code | string |
| severity | AdminDiagnosticSeverity |
| component | string |
| summary | string |
| remediation? | string |
| detail? | map<string, AdminDiagnosticDetailValue> |
AdminDiagnosticDetailValue
boolean | string | number
AdminDiagnosticReport
| diagnostics | AdminDiagnostic[] |
| worst? | "error" | "fatal" | "info" | "warning" |
| counts | { warning: number; info: number; error: number; fatal: number } |
| healthy | boolean |
| generatedAt? | string |
AdminDiagnosticSeverity
"error" | "fatal" | "info" | "warning"
AdminEntitlementDto
| featureKey | string |
| enabled | boolean |
| status | string |
| reason | string |
| reasonCode | EntitlementReasonCode |
| kind | kumo-entitlements.EntitlementKind |
| value | boolean | string | number | string[] | map<string, any> | null |
| softLimit | number | null |
| hardLimit | number | null |
| resetPeriod | string | null |
| winningGrantId | string | null |
| appliedGrantIds | string[] |
| suppressedGrantIds | string[] |
| gates | AdminGateResultDto[] |
| warnings | AdminWarningDto[] |
| evaluatedAt | string |
| validUntil | string | null |
AdminEntitlementExplainResponseDto
| accountId | string |
| featureKey | string |
| entitlement | AdminEntitlementDto | null |
| summary | string |
| steps | AdminEntitlementExplainStepDto[] |
| inputs | { subscriptionId: string | null; subscriptionVersion: string | null; planVersionId: string | null; overrideVersion: string | null; licenseVersion: string | null; deploymentProfileVersion: string | null; featureRegistryVersion: string | null; grantCount: number; appliedGrantCount: number; suppressedGrantCount: number } |
AdminEntitlementExplainStepDto
| order | number |
| kind | string |
| message | string |
| grantId | string | null |
| reasonCode | string | null |
AdminEntitlementsResolveResponseDto
| accountId | string |
| workspaceId | string | null |
| entitlements | AdminEntitlementDto[] |
| warnings | AdminWarningDto[] |
| evaluatedAt | string |
| cacheKey | string |
AdminFeatureAccessResponseDto
| accountId | string |
| featureKey | string |
| allowed | boolean |
| reasonCode | EntitlementReasonCode |
| reasonMessage | string |
| entitlement | AdminEntitlementDto | null |
| gates | AdminGateResultDto[] |
| evaluatedAt | string |
| cacheKey | string |
AdminFeatureFlagSetResult
| flag | AdminFeatureFlagStateDto |
| auditEventId | string |
AdminFeatureFlagStateDto
| key | string |
| description | string |
| enabled | boolean |
| source | "default" | "override" |
| defaultEnabled | boolean |
| updatedAt | string | null |
| updatedBy | string | null |
AdminFeatureFlagsListResult
| flags | AdminFeatureFlagStateDto[] |
AdminGateResultDto
| gate | string |
| allowed | boolean |
| reasonCode | string |
| message | string |
AdminInstallationFingerprintDto
| schema | string |
| installationId | string |
| deploymentKind | string |
| generatedAt | string |
| hostHints? | { clusterUidHash?: string; machineIdHash?: string; namespace?: string } |
AdminJobCancelResult
| job | AdminJobDto |
| auditEventId | string |
AdminJobDto
| id | string |
| kind | string |
| queue | string | null |
| status | "cancelled" | "cancelling" | "dead_lettered" | "failed" | "queued" | "running" | "scheduled" | "succeeded" |
| scope | JobScope |
| requestedBy | JobRequester |
| attemptNumber | number |
| attemptsExhausted | boolean |
| leasedBy | string | null |
| leaseExpiresAt | string | null |
| progress | JobProgress | null |
| cancellation | JobCancellation | null |
| failure | JobFailure | null |
| createdAt | string |
| updatedAt | string |
| startedAt | string | null |
| completedAt | string | null |
| notBefore | string | null |
AdminJobGetResult
| job | AdminJobDto | null |
| attempts | JobAttempt[] |
AdminJobRetryResult
| job | AdminJobDto |
| auditEventId | string |
AdminMigrationRecord
| version | string |
| hasChecksum | boolean |
AdminMigrationStatus
| backend | "postgres" | "unavailable" |
| appliedCount | number |
| latestVersion | string | null |
| migrations | AdminMigrationRecord[] |
AdminMigrationStatusGetResult
| status | AdminMigrationStatus |
AdminOverrideGrantDto
| grantId | string |
| overrideId | string |
| featureKey | string |
| kind | kumo-entitlements.EntitlementKind |
| value | EntitlementValue |
| softLimit | number | null |
| hardLimit | number | null |
| effectiveFrom | string |
| effectiveTo | string | null |
| createdAt | string |
| createdBy | string | null |
| reason | string | null |
| reference | string | null |
AdminOverridesListResponseDto
| grants | AdminOverrideGrantDto[] |
| version | string | null |
| updatedAt | string | null |
AdminOverviewDiagnosticsSummary
| recentErrors | number |
AdminOverviewGetResult
| jobs | AdminOverviewJobsSummary |
| providers | AdminOverviewProvidersSummary |
| license | AdminOverviewLicenseSummary | null |
| diagnostics | AdminOverviewDiagnosticsSummary |
| generatedAt | string |
AdminOverviewJobsSummary
| failed | number |
AdminOverviewLicenseSummary
| installed | boolean |
| status | string |
| daysUntilExpiry | number | null |
| warningCount | number |
AdminOverviewProvidersSummary
| total | number |
| healthy | number |
| degraded | number |
| blocked | number |
| healthyPct | number |
AdminProjectionHealthDto
| summary | AdminProjectionHealthSummary |
| lanes | AdminProjectionLaneHealth[] |
AdminProjectionHealthGetResult
| health | AdminProjectionHealthDto |
AdminProjectionHealthSummary
| workspaces | number |
| upToDate | number |
| behind | number |
| missing | number |
AdminProjectionLaneHealth
| workspaceId | string |
| projectionName | string |
| status | AdminProjectionReconcileStatus |
| headSequence | number | null |
| checkpointSequence | number | null |
| lagSequences | number | null |
| lagMs | number | null |
AdminProjectionReconcileStatus
"behind" | "missing" | "upToDate"
AdminProviderHealthEntry
| providerKey | string |
| countsByStatus | AdminProviderHealthStatusCounts |
| total | number |
AdminProviderHealthGetResult
AdminProviderHealthRollupDto
| providers | AdminProviderHealthEntry[] |
| totalsByStatus | AdminProviderHealthStatusCounts |
| total | number |
AdminProviderHealthStatusCounts
| healthy | number |
| degraded | number |
| blocked | number |
| unknown | number |
| stale | number |
AdminQueueHealthResult
| countsByStatus | { cancelled: number; running: number; failed: number; succeeded: number; queued: number; scheduled: number; cancelling: number; dead_lettered: number } |
AdminRuntimeDiagnosticsGetResult
| report | AdminDiagnosticReport |
AdminSloDto
| generatedAt | string |
| slos | AdminSloMetric[] |
| summary | AdminSloSummary |
AdminSloMetric
| name | string |
| area | string |
| title | string |
| unit | string |
| comparison | string |
| warnThreshold | number |
| breachThreshold | number |
| description | string |
| value | number | null |
| status | AdminSloStatus |
| detail? | string |
| metric? | string |
| wired | boolean |
AdminSloSnapshotGetResult
| snapshot | AdminSloDto |
AdminSloStatus
"breach" | "ok" | "unknown" | "warn"
AdminSloSummary
| total | number |
| ok | number |
| warn | number |
| breach | number |
| unknown | number |
| wired | number |
AdminSnapshotCreateResponseDto
| snapshotId | string |
| accountId | string |
| workspaceId | string | null |
| evaluatedAt | string |
| createdAt | string |
| label | string | null |
| entitlementCount | number |
AdminSnapshotDiffDetailDto
| field | string |
| before | any |
| after | any |
AdminSnapshotDiffEntryDto
| featureKey | string |
| changeKind | EntitlementDiffChangeKind |
| severity | EntitlementDiffSeverity |
| summary | string |
| beforeEnabled | boolean | null |
| afterEnabled | boolean | null |
| details | AdminSnapshotDiffDetailDto[] |
AdminSnapshotDiffResponseDto
| fromSnapshotId | string | null |
| toSnapshotId | string | null |
| accountId | string |
| workspaceId | string | null |
| evaluatedAt | string |
| entries | AdminSnapshotDiffEntryDto[] |
| summary | { totalChanges: number; breakingCount: number; improvementCount: number; neutralCount: number; gainedCount: number; lostCount: number; changedCount: number } |
AdminStorageHistoryGetResult
| points | StorageHistoryPoint[] |
AdminSupportBundle
| manifest | KumoSupportBundleManifestV1 |
| sections | AdminSupportBundleSection[] |
AdminSupportBundleSection
| name | string |
| payload | any |
AdminSyncDiagnosticView
| id | string |
| seq | number |
| accountId | string |
| workspaceId | string |
| sourceId | string |
| sourceSyncId | string |
| workspaceSyncRunId | string | null |
| emittedAt | string |
| severity | AdapterDiagnosticSeverity |
| phase | string |
| code | string |
| message | string |
| remediation | string | null |
| coverageKey | string | null |
| providerScopeKey | string | null |
| resourceKey | string | null |
| connectionKey | string | null |
AdminTenantDeletionCancelResult
| request | AdminTenantDeletionDto | null |
| auditEventId | string | null |
AdminTenantDeletionDto
| id | string |
| accountId | string |
| requestedBy | string |
| requestedAt | string |
| graceEndsAt | string |
| status | string |
AdminTenantDeletionStartResult
| request | AdminTenantDeletionDto | null |
| auditEventId | string | null |
AdminTenantDeletionsListResult
| requests | AdminTenantDeletionDto[] |
AdminTenantDto
| id | string |
| slug | string |
| displayName | string |
| status | string |
| createdAt | string |
| updatedAt | string |
| suspendedAt | string | null |
AdminTenantGetResult
| tenant | AdminTenantDto | null |
AdminTenantReactivateResult
| tenant | AdminTenantDto | null |
| auditEventId | string | null |
AdminTenantSuspendResult
| tenant | AdminTenantDto | null |
| auditEventId | string | null |
AdminWarningDto
| code | string |
| message | string |
AdminWhoamiResult
| userId | string |
| accountId | string | null |
| roles | "billing-operator" | "platform-admin" | "runtime-operator" | "security-auditor" | "support-operator"[] |
| permissions | "analytics.read" | "audit.read" | "billing.read" | "billing.write" | "config.read" | "cost.read" | "entitlements.read" | "entitlements.write" | "flags.manage" | "flags.read" | "job.cancel" | "job.read" | "job.retry" | "license.manage" | "license.read" | "metrics.read" | "notification.read" | "notification.retry" | "partner.manage" | "partner.read" | "plan_catalog.read" | "plan_catalog.write" | "projection.read" | "provider.read" | "queue.read" | "sso.manage" | "sso.read" | "storage.read" | "support.read" | "tenant.manage" | "tenant.read" | "usage.adjust" | "usage.read"[] |
| apiVersion | string |
AlertNotificationSubject
| kind | "alert" |
| workspaceId? | WorkspaceId |
| alertId | string |
| displayName | string |
AnalyticsBucket
"day" | "week"
AnalyticsRollup
| tenantsCreated | number |
| syncRuns | { succeeded: number; partial: number; failed: number } |
| providerFailures | number |
| latestGraphSize? | GraphSizePoint |
| latestStorage? | StoragePoint |
BillingCadence
"annual" | "custom" | "monthly" | "one_time" | "quarterly"
BillingCreditGrantRecord
| id | string |
| accountId | AccountId |
| meterKey | string | null |
| amount | number |
| remaining | number |
| status | BillingCreditGrantStatus |
| reason | string |
| grantedAt | string |
| expiresAt | string | null |
BillingCreditGrantStatus
"active" | "consumed" | "expired" | "revoked"
BillingEntitlementGrantInput
| featureKey | string |
| kind | BillingEntitlementKind |
| value | boolean | string | number | map<string, any> |
| scope? | "account" | "provider" | "source" | "tenant" | "workspace" |
| softLimit? | number |
| hardLimit? | number |
| resetPeriod? | "billing_period" | "day" | "hour" | "month" | "none" |
BillingEntitlementKind
"boolean" | "duration_days" | "enum" | "json_policy" | "metered_budget" | "quantity" | "rate_limit" | "storage_bytes"
BillingEntitlementRecord
| featureKey | string |
| kind | BillingEntitlementKind |
| scope | BillingEntitlementScope |
| value | boolean | string | number | map<string, any> |
| softLimit | number | null |
| hardLimit | number | null |
| resetPeriod | BillingEntitlementResetPeriod |
| status | "allowed" | "conflicted" | "denied" | "expired" | "license_blocked" | "limited" | "not_configured" | "subscription_inactive" | "trial_withheld" | "unknown_feature" | null |
| source | "account_override" | "addon" | "deployment_license" | "deployment_profile" | "internal_default" | "migration_legacy" | "plan_version" | "subscription" | "support_override" | "trial" | "workspace_override" | null |
BillingEntitlementResetPeriod
"billing_period" | "day" | "hour" | "month" | "none"
BillingEntitlementScope
"account" | "provider" | "source" | "tenant" | "workspace"
BillingInvoiceRecord
| providerInvoiceId | string |
| providerCustomerId | string |
| providerSubscriptionId | string | null |
| status | string |
| currency | string |
| amountDue | number |
| amountPaid | number |
| amountRemaining | number |
| number | string | null |
| hostedInvoiceUrl | string | null |
| invoicePdfUrl | string | null |
| createdAt | string | null |
| periodStart | string | null |
| periodEnd | string | null |
BillingPaymentMethodRecord
| providerPaymentMethodId | string |
| providerCustomerId | string |
| type | string |
| cardBrand | string | null |
| cardLast4 | string | null |
| cardExpMonth | number | null |
| cardExpYear | number | null |
| createdAt | string | null |
BillingPlanRecord
| id | string |
| planKey | string |
| displayName | string |
| status | BillingPlanStatus |
| currentVersionId | string | null |
| createdAt | string |
| updatedAt | string |
BillingPlanStatus
"active" | "archived" | "draft"
BillingPlanVersionRecord
| id | string |
| planId | string |
| version | number |
| status | BillingPlanVersionStatus |
| entitlements | BillingEntitlementRecord[] |
| effectiveFrom | string |
| effectiveTo | string | null |
| createdAt | string |
| publishedAt | string | null |
BillingPlanVersionStatus
"draft" | "published" | "retired"
BillingProviderName
"aws_marketplace" | "chargebee" | "manual" | "stripe" | string
BillingProviderSkuRef
| provider | BillingProviderName |
| productId? | string |
| priceId? | string |
| sku? | string |
| lookupKey? | string |
BillingReconciliationRunRecord
| id | string |
| provider | string |
| accountId | AccountId | null |
| status | BillingReconciliationRunStatus |
| dryRun | boolean |
| mismatchCount | number |
| startedAt | string |
| completedAt | string | null |
| failureReason | string | null |
BillingReconciliationRunStatus
"cancelled" | "completed" | "failed" | "pending" | "running"
BillingSubscriptionRecord
| id | string |
| accountId | AccountId |
| billingCustomerId | string |
| planId | string |
| planName | string | null |
| planKey | string | null |
| planVersionId | string |
| provider | string |
| status | BillingSubscriptionStatus |
| currentPeriodStart | string | null |
| currentPeriodEnd | string | null |
| cancelAtPeriodEnd | boolean |
| trialEndsAt | string | null |
| createdAt | string |
| updatedAt | string |
| endedAt | string | null |
BillingSubscriptionStatus
"active" | "cancelled" | "expired" | "incomplete" | "past_due" | "paused" | "suspended" | "trialing"
BillingTrialRecord
| id | string |
| accountId | AccountId |
| planId | string |
| planVersionId | string |
| subscriptionId | string |
| status | BillingTrialStatus |
| startedAt | string |
| endsAt | string |
| convertedAt | string | null |
BillingTrialStatus
"active" | "cancelled" | "converted" | "expired"
CapabilityReport
| capabilities | CapabilityState[] |
| generatedAt | string |
CapabilityState
| capability | string |
| status | CapabilityStatus |
| detail | string |
| reason? | string |
CapabilityStatus
"degraded" | "disabled" | "enabled"
CatalogIntegrity
| canonicalHash | string |
| signature? | string | null |
| algorithm? | string |
CatalogProvenance
| source | CatalogSource |
| createdBy | string |
| createdAt | string |
| publishedBy? | string |
| publishedAt? | string | null |
| notes? | string |
CatalogSource
"admin_ui" | "import" | "migration" | "repository" | "system"
CheckCompatibilityRequestBody
| version? | number |
| context | CompatibilityContext |
CommercialCatalogSeedCatalogAction
"published" | "unchanged" | "would-publish"
CommercialCatalogSeedReport
| catalog | { catalogKey: string; action: CommercialCatalogSeedCatalogAction; version: number | null } |
| billingPlans | HostedPlanProjectionOutcome[] |
| registry | { features: number; meters: number } |
| plans | { created: number; updated: number; unchanged: number } |
CompatibilityContext
| deploymentKind | DeploymentKind |
| runtimeProfile? | string |
| licenseEdition? | string |
| region? | string |
| installedPackages? | string[] |
CompatibilityEvaluation
| compatible | boolean |
| reasons | string[] |
ConfigEntrySnapshot
| key | string |
| category | string |
| secret | boolean |
| set | boolean |
| source | ConfigEntrySource |
| value | string | null |
| fingerprint | string | null |
| description | string |
| unregistered | boolean |
ConfigEntrySource
"env" | "file" | "unset"
ConfiguredEdge
| fromType | string |
| edgeType | string |
| toType | string |
ConnectionTypeSample
| connections | number |
| observationRows | number |
| observationBytes | number |
| revisionRows | number |
| revisionBytes | number |
| dedupHits | number |
ContextNotificationSubject
| kind | "context" |
| workspaceId | WorkspaceId |
| contextId | string |
| displayName | string |
CostNotificationSubject
| kind | "cost" |
| workspaceId? | WorkspaceId |
| scope | string |
| displayName | string |
CostProjection
| months | MonthlyProjection[] |
| totals | CostTotals |
CostProjectionGetResult
| projection | CostProjection |
CostTotals
| storageGbAtEnd | number |
| computeHours | number |
| storageCostUsd | number |
| computeCostUsd | number |
| networkCostUsd | number |
| totalCostUsd | number |
CrawlInputSample
| provider | string |
| files | number |
| bytes | number |
| resourceCandidates | number |
| connectionCandidates | number |
CreateCatalogRequestBody
| catalogKey | string |
| displayName | string |
| description? | string |
| source? | "admin_ui" | "import" | "migration" | "repository" | "system" |
| effectiveFrom? | string |
| effectiveTo? | string | null |
| currencyDefaults? | CurrencyCode[] |
| features? | FeatureDefinition[] |
| meters? | MeterDefinition[] |
| planFamilies? | PlanFamilyDefinition[] |
| plans? | PlanDefinition[] |
| addons? | AddonDefinition[] |
| skus? | SkuDefinition[] |
CreatePlanRequestBody
| planKey | string |
| familyKey | string |
| displayName | string |
| description? | string |
| tier | PlanTier |
| lifecycle? | "active" | "deprecated" | "draft" | "hidden" | "retired" |
| visibleInSignup? | boolean |
| visibleInAdmin? | boolean |
| selfServePurchaseAllowed? | boolean |
| tags? | string[] |
| metadata? | kumo-contracts.JsonObject |
CreatePlanVersionRequestBody
| version? | number |
| cloneFromVersion? | number |
| effectiveFrom? | string |
| effectiveTo? | string | null |
| entitlementTemplates? | EntitlementTemplate[] |
| quotaTemplates? | QuotaTemplate[] |
| rateLimitTemplates? | RateLimitTemplate[] |
| includedAddons? | AddonKey[] |
| skuRefs? | SkuRef[] |
| migrationPolicy? | PlanMigrationPolicy |
| compatibility? | PlanCompatibility |
| display? | PlanDisplayMetadata |
CredentialNotificationSubject
| kind | "credential" |
| workspaceId? | WorkspaceId |
| credentialRef | string |
| sourceId? | SourceId |
| displayName | string |
CreditGrantCreateBody
| amount? | number |
| reason? | string |
| meterKey? | string |
| expiresAt? | string |
CurrencyCode
string
DataClassSample
| rows | number |
| bytes | number |
| dedupHits | number |
| avgBytesPerRow | number |
DefineFeatureRequestBody
| feature | FeatureDefinition |
DefineMeterRequestBody
| meter | MeterDefinition |
DeploymentKind
"agent" | "airgap" | "desktop" | "embedded" | "hosted_saas" | "self_hosted"
DiagnosticSeverity
"error" | "warning"
DiffCatalogsRequestBody
| fromCatalogId | PlanCatalogId |
| toCatalogId | PlanCatalogId |
DispatchOutcome
"delivered" | "failed_permanent" | "failed_retryable" | "skipped" | "suppressed"
DurationStats
| minMs | number |
| meanMs | number |
| medianMs | number |
| p95Ms | number |
| p99Ms | number |
| maxMs | number |
EdgeFireCount
| fromType | string |
| edgeType | string |
| toType | string |
| count | number |
EntitlementDiffChangeKind
"enabled_changed" | "gained" | "kind_changed" | "limit_changed" | "lost" | "reason_changed" | "unchanged" | "value_changed"
EntitlementDiffSeverity
"breaking" | "improvement" | "neutral"
EntitlementGrantId
string
EntitlementGrantReason
"addon" | "included" | "legacy" | "override" | "trial"
EntitlementOverrideId
string
EntitlementReasonCode
"ACCOUNT_SUSPENDED" | "DEPLOYMENT_KIND_INCOMPATIBLE" | "ENTITLEMENT_EXPIRED" | "ENTITLEMENT_NOT_YET_ACTIVE" | "FEATURE_CONFLICT" | "FEATURE_DENIED_BY_DEFAULT" | "FEATURE_DENIED_BY_OVERRIDE" | "FEATURE_GRANTED_BY_ADDON" | "FEATURE_GRANTED_BY_INTERNAL_DEFAULT" | "FEATURE_GRANTED_BY_MIGRATION" | "FEATURE_GRANTED_BY_OVERRIDE" | "FEATURE_GRANTED_BY_PLAN" | "FEATURE_GRANTED_BY_TRIAL" | "FEATURE_UNKNOWN" | "FEATURE_WITHHELD_DURING_TRIAL" | "LICENSE_DENIED" | "PLAN_VERSION_NOT_FOUND" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TRIAL_EXPIRED" | "WORKSPACE_ARCHIVED"
EntitlementResetPeriod
"annual" | "daily" | "monthly" | "none" | "weekly"
EntitlementTemplate
| featureKey | FeatureKey |
| kind | kumo-contracts.EntitlementKind |
| scope | kumo-contracts.EntitlementScope |
| value | FeatureValue |
| softLimit? | number | null |
| hardLimit? | number | null |
| resetPeriod? | "annual" | "daily" | "monthly" | "none" | "weekly" |
| grantReason | EntitlementGrantReason |
| notes? | string |
EntitlementTransitionPolicy
"immediate_grant_immediate_revoke" | "immediate_grant_period_end_revoke" | "preserve_until_migration" | "reset_to_target"
EntitlementValue
boolean | string | number | string[] | map<string, any>
EnvironmentId
string
EnvironmentNotificationSubject
| kind | "environment" |
| workspaceId | WorkspaceId |
| environmentId | EnvironmentId |
| environmentRevisionId? | EnvironmentRevisionId |
| displayName | string |
EnvironmentRevisionId
string
ExportBody
| windowStartsAt? | string |
| windowEndsAt? | string |
| format? | "csv" | "json" |
| bySubject? | boolean |
| accountId? | string |
| meterKeys? | string[] |
ExternalNotificationRecipient
| kind | "external" |
| accountId | AccountId |
| channel | NotificationChannel |
| address | string |
FeatureCategory
"admin" | "alerts" | "automation" | "compliance" | "diagrams" | "diff" | "distribution" | "graph" | "identity" | "integrations" | "providers" | "reporting" | "security" | "support" | "views"
FeatureDefineResult
| feature | FeatureDefinition |
FeatureDefinition
| featureKey | FeatureKey |
| displayName | string |
| description? | string |
| category | FeatureCategory |
| valueKind | FeatureValueKind |
| defaultValue | FeatureValue |
| maturity | FeatureMaturity |
| lifecycle | FeatureLifecycle |
| enforcementMode | FeatureEnforcementMode |
| ownerPackage? | string |
| trial? | "granted" | "withheld" |
| dependencies | FeatureKey[] |
| conflicts | FeatureKey[] |
| docsUrl? | string |
| metadata | kumo-contracts.JsonObject |
FeatureEnforcementMode
"admin_only" | "advisory" | "hard_gate" | "license_backed" | "quota_backed" | "soft_gate"
FeatureGetResult
| feature | FeatureDefinition | null |
FeatureKey
string
FeatureLifecycle
"active" | "deprecated" | "draft" | "retired"
FeatureMaturity
"beta" | "deprecated" | "experimental" | "stable"
FeatureValue
boolean | string | number | string[] | kumo-contracts.JsonObject | null
FeatureValueKind
"boolean" | "decimal" | "enum" | "integer" | "json" | "string"
FeaturesListResult
| features | FeatureDefinition[] |
GraphSizePoint
| resourceCount | number |
| connectionCount | number |
| observedAt | string |
HistogramSample
| count | number |
| minValue | number |
| meanValue | number |
| medianValue | number |
| p95Value | number |
| p99Value | number |
| maxValue | number |
| sumValue | number |
HostedPlanProjectionAction
"created" | "unchanged" | "updated" | "would-create" | "would-update"
HostedPlanProjectionOutcome
| planKey | string |
| billingPlanKey | string |
| action | HostedPlanProjectionAction |
JobAttempt
| id | JobAttemptId |
| jobId | JobId |
| attemptNumber | number |
| workerId | string |
| leaseToken | JobLeaseToken |
| status | "cancelled" | "failed" | "running" | "stale" | "succeeded" |
| startedAt | string |
| leaseExpiresAt | string |
| completedAt | string | null |
| failure | JobFailure | null |
JobAttemptId
string
JobCancellation
| requestedAt | string |
| requestedBy | JobRequester |
| reason | string |
JobFailure
| code | string |
| message | string |
| retryable | boolean |
| category | "authorization" | "bug" | "cancelled" | "conflict" | "not_found" | "provider" | "storage" | "timeout" | "unknown" | "validation" |
| details? | kumo-jobs.JsonObject |
| stackPreview? | string |
JobId
string
JobLeaseToken
string
JobProgress
| stage | string |
| message? | string |
| percent? | number |
| current? | number |
| total? | number |
| unit? | string |
| updatedAt | string |
| details? | kumo-jobs.JsonObject |
JobRequester
object | object | object
JobScope
object | object | object
KumoSupportBundleManifestV1
| kind | "kumo.importExport.supportBundleManifest" |
| manifestVersion | 1 |
| bundleId | string |
| createdAt | string |
| scope | KumoSupportBundleScopeV1 |
| sections | string[] |
| redaction | KumoSupportBundleRedactionSummaryV1 |
KumoSupportBundleRedactionSummaryV1
| deterministic | boolean |
| redactedFieldsCount? | number |
| restrictedSectionsCount? | number |
| policyIds? | string[] |
KumoSupportBundleScopeV1
| tenantId? | string |
| accountId? | string |
| workspaceId? | string |
| sourceId? | string |
LicenseActivationApplyInputDto
| receiptText | string |
LicenseActivationRequestDto
| schema | string |
| requestId | string |
| customerId | string |
| customerContact? | string |
| fingerprint | { schema: string; installationId: string; deploymentKind: string; generatedAt: string; hostHints?: object } |
| requestedEdition? | string |
| requestedFeatures? | string[] |
| notes? | string |
| createdAt | string |
LicenseActivationRequestInputDto
| customerId | string |
| customerContact? | string |
| requestedEdition? | string |
| requestedFeatures? | string[] |
| notes? | string |
LicenseDiagnostics
| installed | boolean |
| status | LicenseStatus |
| licenseId? | string |
| customerId? | string |
| customerName? | string |
| edition? | "community" | "developer" | "enterprise" | "oem" | "pro" | "self-hosted" | "trial" |
| planId? | string |
| plan? | LicensePlanClaim |
| deployment? | LicensedDeployment |
| issuedAt? | string |
| notBefore? | string |
| expiresAt? | string | null |
| daysUntilExpiry? | number | null |
| features | LicenseFeatureDiagnostic[] |
| limits | LicenseLimitDiagnostic[] |
| warnings | LicenseWarning[] |
| lastVerifiedAt? | string |
| activeKeyId? | string |
| lockout? | LicenseLockout |
LicenseFeature
"admin:job-retry" | "admin:license-diagnostics" | "admin:storage-inspection" | "analytics:admin" | "diffs:generate" | "distribution:airgap" | "distribution:white-label" | "object-storage:external" | "provider:aws" | "provider:azure" | "provider:gcp" | "provider:github" | "provider:kubernetes" | "provider:terraform" | "runtime:desktop" | "runtime:embedded" | "runtime:hosted-api" | "runtime:hosted-worker" | "runtime:self-hosted" | "sdk:embedded" | "sdk:provider-authoring" | "views:export" | "views:generate"
LicenseFeatureDiagnostic
| feature | LicenseFeature |
| allowed | boolean |
| expiresAt? | string |
| source | "default" | "license" | "override" |
LicenseInstallInputDto
| documentText | string |
LicenseLimitDiagnostic
| limit | "maxAccounts" | "maxApiReplicas" | "maxConnectionsPerWorkspace" | "maxEmbeddedInstallations" | "maxProviderScopes" | "maxResourcesPerWorkspace" | "maxSourceSyncsPerMonth" | "maxSources" | "maxStorageBytes" | "maxUsers" | "maxViewGenerationsPerMonth" | "maxWorkers" | "maxWorkspaceGraphRevisions" | "maxWorkspaces" |
| licensed | number | null |
| observed | number | null |
| status | "exceeded" | "near_limit" | "ok" | "unknown" |
LicenseLockout
| reason | "claim_required" | "expired" | "read_only" |
| detail | string |
LicenseMintTestInputDto
| edition? | string |
| customerId? | string |
| customerName? | string |
| expiresAt? | string | null |
| features? | { feature: string; mode?: "allow" | "deny" }[] |
LicensePlanClaim
| key | string |
| family | string |
LicenseStatus
"customer_mismatch" | "deployment_mismatch" | "expired" | "expired_in_grace" | "installation_mismatch" | "invalid_signature" | "missing" | "not_yet_valid" | "runtime_mode_denied" | "unknown_error" | "unsupported_schema" | "valid" | "valid_with_warnings"
LicenseWarning
| code | "expiring_soon" | "expiring_soon_hard" | "in_grace_period" | "metadata_unknown_field" | "oem_metadata_missing" | "support_expired" | "usage_near_limit" |
| message | string |
| at? | number |
LicensedDeployment
| kind | "airgapped" | "embedded-container" | "embedded-library" | "embedded-sidecar" | "hosted" | "provider-sdk" | "self-hosted-kubernetes" | "self-hosted-vm" | "standalone-docker" | "white-label-oem" |
| allowedRuntimeModes | string[] |
| allowOffline | boolean |
| allowAirgap | boolean |
| allowOemRedistribution | boolean |
MarketplaceSkuRef
| marketplace | "aws_marketplace" | "azure_marketplace" | "gcp_marketplace" | string |
| productCode? | string |
| dimension? | string |
| offerId? | string |
MeasuredBaseline
| resourceCount | number |
| bytesByDataClass | { view_revisions: number; events: number; resource_observations: number; resource_revisions: number; connection_observations: number; connection_revisions: number; source_snapshots: number; workspace_graph_revisions: number; environment_revisions: number; content_blobs: number } |
| rowsByDataClass | { view_revisions: number; events: number; resource_observations: number; resource_revisions: number; connection_observations: number; connection_revisions: number; source_snapshots: number; workspace_graph_revisions: number; environment_revisions: number; content_blobs: number } |
| pgStorageBytesByDataClass? | { view_revisions?: number; events?: number; resource_observations?: number; resource_revisions?: number; connection_observations?: number; connection_revisions?: number; source_snapshots?: number; workspace_graph_revisions?: number; environment_revisions?: number; content_blobs?: number } |
| elapsedMs | number |
MeterAggregation
"average" | "current" | "max" | "sum"
MeterDefineResult
| meter | MeterDefinition |
MeterDefinition
| meterKey | MeterKey |
| displayName | string |
| description? | string |
| unit | MeterUnit |
| aggregation | MeterAggregation |
| resetPeriod | MeterResetPeriod |
| subjectScope | kumo-contracts.EntitlementScope |
| sourcePackage? | string |
| exactness | MeterExactness |
| auditRequired | boolean |
MeterExactness
"estimated" | "eventual" | "exact"
MeterGetResult
| meter | MeterDefinition | null |
MeterKey
string
MeterResetPeriod
"annual" | "daily" | "monthly" | "none" | "weekly"
MeterUnit
"bytes" | "count" | "credits" | "jobs" | "requests" | "resources" | "seconds" | "sources" | "users" | "workspaces"
MetersListResult
| meters | MeterDefinition[] |
MetricsReport
| attributes | map<string, boolean | string | number> |
| phases | PhaseSample[] |
| dataClasses | { view_revisions: DataClassSample; events: DataClassSample; resource_observations: DataClassSample; resource_revisions: DataClassSample; connection_observations: DataClassSample; connection_revisions: DataClassSample; source_snapshots: DataClassSample; workspace_graph_revisions: DataClassSample; environment_revisions: DataClassSample; content_blobs: DataClassSample } |
| totals | MetricsTotals |
| resourceTypes? | map<string, ResourceTypeSample> |
| connectionTypes? | map<string, ConnectionTypeSample> |
| crawlInputs? | map<string, CrawlInputSample> |
| pg? | PgStatementSample |
| pgPool? | PgPoolSample |
| process? | ProcessSample |
| pgStorage? | StorageUsageSnapshot |
| edgeFireCounts? | EdgeFireCount[] |
| configuredEdges? | ConfiguredEdge[] |
| graphStateHashes? | string[] |
| counters? | map<string, number> |
| histograms? | map<string, HistogramSample> |
| perWorkspace? | map<string, WorkspaceSample> |
| processTimeline? | ResourceTimelineSample[] |
| pgPoolTimeline? | PgPoolTimelineSample[] |
| queueTimeline? | QueueTimelineSample[] |
| progressTimeline? | ProgressTimelineSample[] |
MetricsReportGetResult
| report | MetricsReport |
MetricsTotals
| rows | number |
| bytes | number |
| dedupHits | number |
| elapsedMs | number |
MigrationResolution
| allowed | boolean |
| target? | PlanMigrationTarget |
| reason? | string |
MonthlyProjection
| monthIndex | number |
| resources | number |
| storageBytes | number |
| storageGb | number |
| storageCostUsd | number |
| computeHours | number |
| computeCostUsd | number |
| networkGb | number |
| networkCostUsd | number |
| totalCostUsd | number |
MutateBody
| reason? | string |
NormalizedEntitlement
| featureKey | FeatureKey |
| kind | kumo-contracts.EntitlementKind |
| scope | kumo-contracts.EntitlementScope |
| value | FeatureValue |
| softLimit | number | null |
| hardLimit | number | null |
| resetPeriod | EntitlementResetPeriod |
| grantReason | EntitlementGrantReason |
| sources | string[] |
NormalizedQuota
| meterKey | MeterKey |
| scope | kumo-contracts.EntitlementScope |
| softLimit | number | null |
| hardLimit | number | null |
| resetPeriod | MeterResetPeriod |
| overageBehavior | OverageBehavior |
| enforcementPoint | QuotaEnforcementPoint |
| sources | string[] |
NotificationChannel
"cli" | "desktop" | "email" | "in_app" | "mobile_push" | "slack" | "webhook"
NotificationDeliveryAttemptDto
| id | string |
| deliveryId | string |
| attemptedAt | string |
| status | string |
| providerMessageId | string | null |
| errorCode | string | null |
| errorMessage | string | null |
| latencyMs | number | null |
NotificationDeliveryDto
| id | string |
| notificationId | string |
| recipientNotificationId | string | null |
| channel | string |
| destination | NotificationDestination |
| status | string |
| idempotencyKey | string |
| attemptCount | number |
| scheduledAt | string |
| lastAttemptedAt | string | null |
| deliveredAt | string | null |
| failedAt | string | null |
| failure? | NotificationDeliveryFailure | null |
NotificationDeliveryFailure
| code | string |
| message | string |
| retryable | boolean |
| providerCode? | string |
NotificationDeliveryTrailDto
| delivery | NotificationDeliveryDto |
| attempts | NotificationDeliveryAttemptDto[] |
NotificationDestination
| channel | NotificationChannel |
| address | string |
| displayName? | string |
NotificationDiagnosticDto
| severity | string |
| code | string |
| message | string |
| recipient? | UserNotificationRecipient | TeamNotificationRecipient | WorkspaceNotificationRecipient | ExternalNotificationRecipient | null |
| channel | string | null |
NotificationDto
| id | string |
| accountId | string |
| workspaceId | string | null |
| kind | string |
| severity | string |
| urgency | string |
| title | string |
| summary | string |
| subject | NotificationSubject |
| links | NotificationLink[] |
| evidence | NotificationEvidence[] |
| threadKey | string | null |
| dedupeKey | string |
| createdAt | string |
| occurredAt | string |
| state | string |
NotificationEvidence
| kind | string |
| label | string |
| ref? | string |
| sensitive? | boolean |
| detail? | map<string, any> |
NotificationLink
| kind | NotificationLinkKind |
| label | string |
| href | string |
| requiresPermission? | string |
NotificationLinkKind
"alert" | "context" | "credential" | "diff" | "environment" | "external" | "graph_revision" | "report" | "resource" | "settings" | "source" | "sync_run" | "view" | "workspace"
NotificationRecipient
UserNotificationRecipient | TeamNotificationRecipient | WorkspaceNotificationRecipient | ExternalNotificationRecipient
NotificationSubject
WorkspaceNotificationSubject | EnvironmentNotificationSubject | ContextNotificationSubject | ViewNotificationSubject | SourceNotificationSubject | ResourceNotificationSubject | ReportNotificationSubject | AlertNotificationSubject | CostNotificationSubject | CredentialNotificationSubject | SystemNotificationSubject
OverageBehavior
"allow_with_overage" | "degrade" | "deny" | "require_admin_override" | "warn"
OverrideBody
| kind? | "allowlist" | "configuration" | "credit" | "deny" | "flag" | "limit" |
| value? | boolean | string | number | string[] | map<string, any> |
| softLimit? | number | null |
| hardLimit? | number | null |
| resetPeriod? | "billing_period" | "day" | "hour" | "month" | "none" |
| effectiveFrom? | string |
| effectiveTo? | string | null |
| reason? | string |
| reference? | string | null |
Partner
| partnerId | string |
| name | string |
| status | PartnerStatus |
| domains | string[] |
| branding | PartnerBranding |
| provisioning | PartnerProvisioningPolicy |
| createdAt | string (date-time) |
| updatedAt | string (date-time) |
PartnerBranding
| productName | string |
| logoUrl | string | null |
| faviconUrl | string | null |
| supportEmail | string | null |
| themeTokens | map<string, string> |
PartnerProvisioningPolicy
| planKey | string |
| trialDays | number |
| defaultRoleKey | string |
PartnerStatus
"active" | "disabled"
PgPoolSample
| maxCount | number |
| peakTotal | number |
| peakInUse | number |
| peakIdle | number |
| peakWaiting | number |
| samples | number |
PgPoolTimelineSample
| tMs | number |
| maxCount | number |
| totalCount | number |
| inUseCount | number |
| idleCount | number |
| waitingCount | number |
PgStatementSample
| totalStatements | number |
| byKind | map<string, number> |
PhaseSample
| name | string |
| startedAtMs | number |
| endedAtMs | number |
| durationMs | number |
| samples | number |
| cpuUserMs? | number |
| cpuSystemMs? | number |
| durationStats | DurationStats |
PlanAudience
"internal" | "oem" | "partner" | "sales_led" | "self_hosted" | "self_serve"
PlanCatalog
| catalogId | PlanCatalogId |
| catalogKey | string |
| version | number |
| status | PlanCatalogStatus |
| displayName | string |
| description? | string |
| features | FeatureDefinition[] |
| meters | MeterDefinition[] |
| planFamilies | PlanFamilyDefinition[] |
| plans | PlanDefinition[] |
| addons | AddonDefinition[] |
| skus | SkuDefinition[] |
| currencyDefaults | CurrencyCode[] |
| effectiveFrom | string |
| effectiveTo? | string | null |
| provenance | CatalogProvenance |
| integrity | CatalogIntegrity |
PlanCatalogChange
| kind | PlanCatalogChangeKind |
| breaking | boolean |
| target | PlanCatalogChangeTarget |
| key | string |
| detail | string |
PlanCatalogChangeKind
"added" | "changed" | "removed"
PlanCatalogChangeTarget
"addon" | "catalog" | "entitlement" | "feature" | "meter" | "migration_path" | "plan" | "plan_version" | "quota" | "sku"
PlanCatalogCreateResult
| catalog | PlanCatalog |
PlanCatalogDiagnostic
| severity | DiagnosticSeverity |
| code | PlanCatalogDiagnosticCode |
| message | string |
| path? | string |
| subject? | string |
PlanCatalogDiagnosticCode
"addon_unknown_feature_or_meter" | "advisory_only_entitlement" | "conflicting_feature_grants" | "deprecated_addon_in_published_plan" | "deprecated_feature_in_active_plan" | "duplicate_addon_key" | "duplicate_feature_key" | "duplicate_meter_key" | "duplicate_plan_key" | "duplicate_plan_version" | "duplicate_sku_key" | "feature_dependency_cycle" | "feature_without_owner_package" | "hard_limit_below_soft_limit" | "invalid_trial_days" | "legacy_plan_still_active" | "migration_target_unknown" | "multiple_signup_default_trials" | "plan_admin_visible_signup_hidden" | "plan_unknown_family" | "plan_version_without_migration_targets" | "published_version_without_checksum" | "published_version_without_effective_from" | "quota_without_limit" | "retired_feature_in_published_plan" | "self_hosted_plan_without_compatible_deployment" | "self_serve_plan_without_sku" | "sku_unknown_plan_or_addon" | "sku_without_provider_ref" | "unknown_addon_reference" | "unknown_feature_reference" | "unknown_meter_reference" | "version_plan_key_mismatch"
PlanCatalogDiffOutput
PlanCatalogDiffResult
| fromCatalogId | PlanCatalogId |
| toCatalogId | PlanCatalogId |
| changes | PlanCatalogChange[] |
| breaking | boolean |
| requiresMigration | boolean |
| summary | PlanCatalogDiffSummary |
PlanCatalogDiffSummary
| total | number |
| breaking | number |
| nonBreaking | number |
| added | number |
| removed | number |
| changed | number |
PlanCatalogGetResult
| catalog | PlanCatalog | null |
PlanCatalogId
string
PlanCatalogStatus
"deprecated" | "draft" | "invalid" | "published" | "retired"
PlanCatalogValidateResult
| report | PlanCatalogValidationReport |
| catalogId? | PlanCatalogId |
PlanCatalogValidationReport
| valid | boolean |
| errors | PlanCatalogDiagnostic[] |
| warnings | PlanCatalogDiagnostic[] |
PlanCompatibility
| deploymentKinds | DeploymentKind[] |
| runtimeProfiles | string[] |
| licenseEditions | string[] |
| regions? | string[] |
| providerFamilies? | string[] |
| requiresPackages? | string[] |
| conflictsWithPackages? | string[] |
PlanCompatibilityCheckResult
| planKey | string |
| version | number |
| evaluation | CompatibilityEvaluation |
PlanCreateBody
| planKey? | string |
| displayName? | string |
PlanCreateResult
| plan | PlanDefinition |
PlanDefinition
| planKey | string |
| familyKey | string |
| displayName | string |
| description? | string |
| tier | PlanTier |
| lifecycle | PlanLifecycle |
| currentVersion | number |
| visibleInSignup | boolean |
| visibleInAdmin | boolean |
| selfServePurchaseAllowed | boolean |
| trial? | { days: number; signupDefault: boolean } |
| versions | PlanVersionDefinition[] |
| tags | string[] |
| metadata | kumo-contracts.JsonObject |
PlanDisplayMetadata
| marketingName? | string |
| tagline? | string |
| sortOrder | number |
| highlighted | boolean |
| badge? | string |
| featureBullets? | string[] |
| priceCaption? | string |
PlanFamilyDefinition
| familyKey | string |
| displayName | string |
| description? | string |
| audience | PlanAudience |
| allowedDeploymentKinds | DeploymentKind[] |
| defaultPlanKey? | string |
| sortOrder | number |
PlanGetResult
| plan | PlanDefinition | null |
PlanLifecycle
"active" | "deprecated" | "draft" | "hidden" | "retired"
PlanMigrationBlock
| targetPlanKey | string |
| targetVersion? | "current" | number |
| reason | string |
PlanMigrationKind
"downgrade" | "lateral" | "legacy_migration" | "upgrade"
PlanMigrationPathResolveResult
| fromPlanKey | string |
| fromVersion | number |
| resolution | MigrationResolution |
| pinnedTargetVersion? | number |
PlanMigrationPolicy
| allowedTargets | PlanMigrationTarget[] |
| blockedTargets | PlanMigrationBlock[] |
| prorationPolicy | ProrationPolicy |
| entitlementTransition | EntitlementTransitionPolicy |
| quotaTransition | QuotaTransitionPolicy |
| requiresAdminApproval | boolean |
| requiresCustomerAcceptance | boolean |
PlanMigrationTarget
| targetPlanKey | string |
| targetVersion? | "current" | number |
| kind | PlanMigrationKind |
| effectiveTiming | PlanMigrationTiming |
PlanMigrationTiming
"immediate" | "manual_date" | "period_end"
PlanSelector
| planKey | string |
| version? | number |
| familyKey? | string |
PlanTier
"business" | "embedded" | "enterprise" | "free" | "internal" | "self_hosted" | "starter" | "team" | "trial"
PlanVersionDefinition
| planKey | string |
| version | number |
| status | PlanVersionStatus |
| effectiveFrom | string |
| effectiveTo? | string | null |
| publishedAt? | string | null |
| entitlementTemplates | EntitlementTemplate[] |
| quotaTemplates | QuotaTemplate[] |
| rateLimitTemplates | RateLimitTemplate[] |
| includedAddons | AddonKey[] |
| skuRefs | SkuRef[] |
| migrationPolicy | PlanMigrationPolicy |
| compatibility | PlanCompatibility |
| display | PlanDisplayMetadata |
| checksum? | string |
PlanVersionDeprecateResult
| planVersion | PlanVersionDefinition |
PlanVersionDraftBody
| entitlements? | BillingEntitlementGrantInput[] |
| effectiveFrom? | string |
PlanVersionDraftCreateResult
| planVersion | PlanVersionDefinition |
PlanVersionId
string
PlanVersionPublishBody
| makeCurrent? | boolean |
PlanVersionPublishResult
| planVersion | PlanVersionDefinition |
PlanVersionResolveResult
| resolved | ResolvedPlanTemplates |
PlanVersionStatus
"deprecated" | "draft" | "published" | "retired"
PricingModel
"custom_quote" | "free" | "one_time" | "recurring_flat" | "recurring_per_seat" | "usage_based"
ProcessConfigSnapshot
| processKind | string |
| instanceId | string |
| bootedAt | string |
| reportedAt | string |
| entries | ConfigEntrySnapshot[] |
ProcessSample
| rssBytesPeak | number |
| rssBytesFinal | number |
| heapUsedBytesPeak | number |
| heapUsedBytesFinal | number |
| heapTotalBytesFinal | number |
| cpuUserMs | number |
| cpuSystemMs | number |
ProgressTimelineSample
| tMs | number |
| resources | number |
| connections | number |
| views | number |
| environments | number |
| resourceRevisions | number |
| connectionRevisions | number |
| viewRevisions | number |
| environmentRevisions | number |
| pgStatements | number |
| filesSucceeded | number |
ProjectCostsBody
| scenarioInputs? | ScenarioInputs |
| baseline? | MeasuredBaseline |
ProrationPolicy
"billing_provider" | "catalog_rule" | "manual" | "none"
ProviderScopeId
string
PublishPlanVersionRequestBody
| setCurrent? | boolean |
QueueTimelineSample
| tMs | number |
| sourceUploadsPending | number |
| sourceUploadsActive | number |
| crawlResultsPending | number |
| crawlResultsActive | number |
| wgrPostSyncPending | number |
| wgrPostSyncActive | number |
QuotaEnforcementPoint
"agent_job" | "alert_evaluate" | "api_request" | "graph_diff" | "none" | "report_generate" | "resource_persist" | "source_create" | "sync_start" | "view_export" | "view_generate" | "workspace_create"
QuotaTemplate
| meterKey | MeterKey |
| scope | kumo-contracts.EntitlementScope |
| softLimit? | number | null |
| hardLimit? | number | null |
| resetPeriod | MeterResetPeriod |
| overageBehavior | OverageBehavior |
| enforcementPoint | QuotaEnforcementPoint |
QuotaTransitionPolicy
"keep_current_usage_recalculate_limits" | "preserve_until_period_end" | "reset_all"
RateLimitTemplate
| meterKey | MeterKey |
| scope | kumo-contracts.EntitlementScope |
| limit | number |
| window | RateLimitWindow |
| overageBehavior | OverageBehavior |
RateLimitWindow
"day" | "hour" | "minute" | "second"
ReasonBody
| reason? | string |
RebuildBody
| apply? | boolean |
| accountId? | string |
| meterKeys? | string[] |
RecipientNotificationDto
| id | string |
| notificationId | string |
| recipient | NotificationRecipient |
| visibility | string |
| readState | string |
| lifecycleState | string |
| deliveredChannels | string[] |
| createdAt | string |
| readAt | string | null |
| dismissedAt | string | null |
ReconciliationRunStartBody
| accountId? | string |
| dryRun? | boolean |
ReportNotificationSubject
| kind | "report" |
| workspaceId? | WorkspaceId |
| reportId | string |
| reportRevisionId? | string |
| displayName | string |
ResolveMigrationPathRequestBody
| fromVersion? | number |
| targetPlanKey | string |
| targetVersion? | "current" | number |
ResolvedPlanTemplates
| planKey | string |
| version | number |
| entitlements | NormalizedEntitlement[] |
| quotas | NormalizedQuota[] |
| rateLimits | RateLimitTemplate[] |
ResourceNotificationSubject
| kind | "resource" |
| workspaceId | WorkspaceId |
| resourceId | string |
| displayName | string |
ResourceTimelineSample
| tMs | number |
| rssBytes | number |
| heapUsedBytes | number |
| heapTotalBytes | number |
| cpuUserMs | number |
| cpuSystemMs | number |
| eventLoopDelayMeanMs? | number |
| eventLoopDelayMaxMs? | number |
ResourceTypeSample
| resources | number |
| observationRows | number |
| observationBytes | number |
| revisionRows | number |
| revisionBytes | number |
| dedupHits | number |
RetryBody
| reason? | string |
ReverseBody
| entryId? | string |
| reason? | string |
| idempotencyKey? | string |
SamlConfigurationId
string
ScenarioInputs
| accountCount | number |
| resourcesPerAccount | number |
| annualGrowthRate | number |
| syncsPerMonth | number |
| monthsToProject | number |
| retentionMonths | number |
| churnRatePerSync | number |
| compressionRatio | number |
| indexOverhead | number |
| replicaFactor | number |
| backupFactor | number |
| safetyMargin | number |
| storagePricePerGbMonth | number |
| computePricePerHour | number |
| egressPricePerGb | number |
| secondsPerRecord? | number |
SetBody
| enabled? | any |
| reason? | any |
SkuDefinition
| skuKey | SkuKey |
| displayName | string |
| description? | string |
| planKey? | string |
| planVersion? | number |
| addonKey? | string |
| providerRefs | BillingProviderSkuRef[] |
| marketplaceRefs | MarketplaceSkuRef[] |
| pricingModel | PricingModel |
| billingCadences | BillingCadence[] |
| currency? | CurrencyCode |
| taxCategory? | string |
| revenueCategory? | string |
| metadata | kumo-contracts.JsonObject |
SkuKey
string
SkuRef
| skuKey | SkuKey |
SnapshotCreateBody
| accountId? | string |
| workspaceId? | string |
| label? | string |
| notes? | string |
| at? | string |
SnapshotDiffBody
| fromSnapshotId? | string |
| toSnapshotId? | string |
| accountId? | string |
| workspaceId? | string |
| beforeAt? | string |
| afterAt? | string |
| includeUnchanged? | boolean |
SnapshotPgStorageBody
| analyze? | boolean |
SourceId
string
SourceNotificationSubject
| kind | "source" |
| workspaceId | WorkspaceId |
| sourceId | SourceId |
| sourceSyncId? | SourceSyncId |
| displayName | string |
SourceSyncId
string
StorageHistoryPoint
| measuredAt | string |
| databaseBytes | number |
| kumoBytes | number |
StoragePoint
| bytesTotal | number |
| observedAt | string |
StorageTableSize
| table | string |
| liveRows | number |
| heapBytes | number |
| indexBytes | number |
| toastBytes | number |
| totalBytes | number |
StorageUsageSnapshot
| databaseBytes | number |
| tables | StorageTableSize[] |
| totals | { heapBytes: number; indexBytes: number; toastBytes: number; totalBytes: number } |
StorageUsageSnapshotGetResult
| snapshot | StorageUsageSnapshot |
| capacityBytes | number | null |
SubscriptionAssignBody
| planKey? | string |
| currentPeriodStart? | string |
| currentPeriodEnd? | string | null |
SubscriptionId
string
SubscriptionStatus
"active" | "cancelled" | "expired" | "incomplete" | "past_due" | "paused" | "suspended" | "trialing"
SystemNotificationSubject
| kind | "system" |
| workspaceId? | WorkspaceId |
| displayName | string |
TeamNotificationRecipient
| kind | "team" |
| teamId | string |
| accountId | AccountId |
TrialStartBody
| planKey? | string |
| days? | number |
| endsAt? | string |
UpdateBody
| name? | string |
| status? | "active" | "disabled" |
| domains? | string[] |
| branding? | PartnerBranding |
| provisioning? | PartnerProvisioningPolicy |
UsageAdjustment
| id | UsageAdjustmentId |
| accountId | AccountId |
| subject | UsageSubject |
| meterKey | UsageMeterKey |
| meterVersion | number |
| window | UsageWindow |
| quantity | UsageQuantity |
| reason | string |
| ledgerEntryId | UsageLedgerEntryId |
| adjustedEntryId? | UsageLedgerEntryId |
| createdAt | string |
UsageAdjustmentId
string
UsageCounterKey
| subject | UsageSubject |
| meterKey | UsageMeterKey |
| meterVersion | number |
| window | UsageWindow |
UsageDiagnostic
| severity | "error" | "info" | "warning" |
| code | UsageDiagnosticCode |
| message | string |
| meterKey? | "agent.job.completed" | "api.request.count" | "environment.evaluation.completed" | "graph.connection_observed" | "graph.diff_generated" | "graph.resource_observed" | "graph.workspace_revision_created" | "report.generation.completed" | "source.sync.completed" | "source.sync.compute_seconds" | "source.sync.failed" | "source.sync.provider_api_call_estimate" | "storage.artifact_byte_hours" | "storage.export_byte_hours" | "storage.snapshot_byte_hours" | "view.export.completed" | "view.generation.completed" | "view.generation.compute_seconds" | "worker.compute_seconds" | string |
| subject? | UsageSubject |
| idempotencyKey? | UsageIdempotencyKey |
UsageDiagnosticCode
"ADJUSTMENT_REQUIRES_REASON" | "COUNTER_DRIFT_DETECTED" | "COUNTER_LIMIT_EXCEEDED" | "ENTRY_ALREADY_REVERSED" | "EVENT_PUBLISH_FAILED" | "IDEMPOTENCY_CONFLICT" | "IDEMPOTENCY_DUPLICATE" | "LATE_USAGE_RECORDED" | "LEDGER_ENTRY_NOT_FOUND" | "METER_NOT_FOUND" | "METER_VERSION_NOT_ACTIVE" | "MIRROR_WRITE_FAILED" | "NEGATIVE_USAGE_NOT_ALLOWED" | "QUANTITY_INVALID" | "RECONCILIATION_MISMATCH" | "RESERVATION_ALREADY_COMMITTED" | "RESERVATION_ALREADY_RELEASED" | "RESERVATION_EXPIRED" | "RESERVATION_NOT_FOUND" | "SUBJECT_INVALID" | "UNIT_MISMATCH" | "WINDOW_UNRESOLVED"
UsageExport
| id | UsageExportId |
| accountId | AccountId |
| window | UsageWindow |
| format | UsageExportFormat |
| meterKeys | UsageMeterKey[] |
| lines | UsageExportLine[] |
| entryCount | number |
| firstSequence? | string |
| lastSequence? | string |
| generatedAt | string |
UsageExportFormat
"csv" | "json"
UsageExportId
string
UsageExportLine
| meterKey | UsageMeterKey |
| unit | UsageUnit |
| subjectKey? | string |
| gross | string |
| adjustments | string |
| net | string |
| entryCount | number |
UsageIdempotencyKey
string
UsageLedgerEntryId
string
UsageMeterKey
"agent.job.completed" | "api.request.count" | "environment.evaluation.completed" | "graph.connection_observed" | "graph.diff_generated" | "graph.resource_observed" | "graph.workspace_revision_created" | "report.generation.completed" | "source.sync.completed" | "source.sync.compute_seconds" | "source.sync.failed" | "source.sync.provider_api_call_estimate" | "storage.artifact_byte_hours" | "storage.export_byte_hours" | "storage.snapshot_byte_hours" | "view.export.completed" | "view.generation.completed" | "view.generation.compute_seconds" | "worker.compute_seconds" | string
UsageQuantity
| value | string |
| unit | UsageUnit |
| scale? | number |
UsageRebuildCountersResult
| checked | number |
| drifted | number |
| applied | number |
| findings | UsageReconciliationFinding[] |
| diagnostics | UsageDiagnostic[] |
UsageReconciliationFinding
| kind | "missing_counter" | "orphan_counter" | "value_drift" |
| counterKey | UsageCounterKey |
| field? | "adjusted" | "committed" | "reserved" | "used" |
| stored? | string |
| rebuilt? | string |
UsageReconciliationRun
| id | UsageReconciliationRunId |
| accountId | AccountId |
| checkedCounters | number |
| consistent | boolean |
| findings | UsageReconciliationFinding[] |
| startedAt | string |
| completedAt | string |
UsageReconciliationRunId
string
UsageSubject
| kind | UsageSubjectKind |
| accountId | AccountId |
| workspaceId? | WorkspaceId |
| sourceId? | SourceId |
| providerScopeId? | ProviderScopeId |
| environmentId? | EnvironmentId |
| viewId? | ViewId |
| userId? | UserId |
| agentId? | string |
UsageSubjectKind
"account" | "agent" | "environment" | "provider_scope" | "source" | "tenant" | "user" | "view" | "workspace"
UsageUnit
"api_request" | "byte" | "byte_hour" | "compute_second" | "connection" | "count" | "custom" | "gb_day" | "provider_api_call" | "report_generation" | "resource" | "revision" | "second" | "view_generation"
UsageWindow
| kind | UsageWindowKind |
| startsAt | string |
| endsAt | string |
| timezone? | string |
UsageWindowKind
"billing_period" | "day" | "hour" | "instant" | "month" | "rolling" | "week"
UserId
string
ViewId
string
ViewNotificationSubject
| kind | "view" |
| workspaceId | WorkspaceId |
| viewId | ViewId |
| viewRevisionId? | ViewRevisionId |
| displayName | string |
ViewRevisionId
string
WgrPostSyncJob
| id | WgrPostSyncJobId |
| workspaceId | WorkspaceId |
| workspaceGraphRevisionId | WorkspaceGraphRevisionId |
| status | WgrPostSyncJobStatus |
| attempts | number |
| maxAttempts | number |
| lastError | string | null |
| enqueuedAt | string (date-time) |
| claimedAt | string (date-time) | null |
| completedAt | string (date-time) | null |
| observedAt | string (date-time) |
| wallEnqueuedAt | string (date-time) |
WgrPostSyncJobGetResult
| job | WgrPostSyncJob | null |
WgrPostSyncJobId
string
WgrPostSyncJobRetryFailedResult
| requeued | true |
| auditEventId | string |
WgrPostSyncJobStatus
"done" | "failed" | "pending" | "running"
WgrPostSyncJobsCountByStatusResult
| count | number |
WgrPostSyncJobsListByStatusResult
| jobs | WgrPostSyncJob[] |
WorkspaceGraphRevisionId
string
WorkspaceId
string
WorkspaceNotificationRecipient
| kind | "workspace" |
| workspaceId | WorkspaceId |
| accountId | AccountId |
WorkspaceNotificationSubject
| kind | "workspace" |
| workspaceId | WorkspaceId |
| displayName | string |
WorkspaceSample
| timingsMs | map<string, { totalMs: number; samples: number; maxMs: number }> |
| counters | map<string, number> |
| totalMs | number |
kumo-contracts-admin.ActorContext
| userId | UserId |
| accountId | AccountId |
| workspaceId? | WorkspaceId |
kumo-contracts.EntitlementKind
"allowlist" | "configuration" | "credit" | "flag" | "limit"
kumo-contracts.EntitlementScope
"account" | "deployment" | "source" | "user" | "workspace"
kumo-contracts.JsonArray
kumo-contracts.JsonObject
map<string, kumo-contracts.JsonValue>
kumo-contracts.JsonValue
boolean | string | number | kumo-contracts.JsonObject | kumo-contracts.JsonArray | null
kumo-core-server-admin.CreateBody
| name? | string |
| domains? | string[] |
| branding? | PartnerBranding |
| provisioning? | PartnerProvisioningPolicy |
kumo-entitlements.EntitlementKind
"allowlist" | "configuration" | "credit" | "deny" | "flag" | "limit"
kumo-jobs.JsonArray
kumo-jobs.JsonObject
map<string, boolean | string | number | kumo-jobs.JsonObject | kumo-jobs.JsonArray | null>
kumo-jobs.JsonValue
boolean | string | number | kumo-jobs.JsonObject | kumo-jobs.JsonArray | null