Kumo.io

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.

476 routes351 tenant · 125 adminbearer auth · enveloped · cursor paginggenerated from CI-checked OpenAPI

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 202 with a Location to poll.
  • Tiers — stable routes follow the compatibility policy; preview routes may change between releases and say so here first.
Machine-readable: this page renders the same per-surface OpenAPI documents our CI drift-checks on every commit — the specs (and this page) regenerate from route registrations, so the reference cannot fall behind the server.

Tenant API

Account-scoped: paths carry {accountId} (yours), and workspace resources nest under {workspaceId}.

351
routes
70
areas
330
stable
0
preview

Environments · 39 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/environments

Query

limit?string
cursor?string
includeArchivedWorkspaces?string
includeRetired?string

Response 200 { data: EnvironmentByAccountItemDto[]; page; meta }

idstring
namestring
workspaceIdstring
workspaceNamestring
originstring
activeDefinitionIdstring | null
createdAtstring
retiredAtstring | null
providersstring[]
sourceCountnumber
membershipRuleany
evaluationEnvironmentEvaluationDto | null
sourceFreshnessEnvironmentSourceFreshnessDto | null
statusObjectStatus
workspaceStatusObjectStatus
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments

Query

limit?string
cursor?string
includeArchivedWorkspaces?string
includeRetired?string

Response 200 { data: ListEnvironmentsHttpResponseItem[]; page; meta }

idstring
workspaceIdstring
namestring
originstring
activeDefinitionIdstring | null
policyKeystring | null
anchorResourceIdstring | null
anchorCanonicalIdentityKeystring | null
createdAtstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments

Request body CreateEnvironmentBody

name?string

Response 201 { data: CreateEnvironmentHttpResponse; meta }

idstring
workspaceIdstring
namestring
originstring
activeDefinitionIdstring | null
createdAtstring
stable201
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}

Response 200 { data: GetEnvironmentHttpResponse; meta }

idstring
workspaceIdstring
namestring
originstring
activeDefinitionIdstring | null
policyKeystring | null
anchorResourceIdstring | null
anchorCanonicalIdentityKeystring | null
createdAtstring
activeDefinitionGetEnvironmentHttpDefinition | null
evaluationStateGetEnvironmentHttpEvaluationState
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/context-query/evaluate

Request body ContextQueryEvaluateBody

contextQuery?any
parameters?map<string, any>
environmentRevisionId?string

Response 200 { data: ContextQueryEvaluateResult; meta }

environmentIdEnvironmentId
environmentRevisionIdEnvironmentRevisionId
workspaceIdWorkspaceId
workspaceGraphRevisionIdWorkspaceGraphRevisionId
targetCountnumber
resourceCountnumber
connectionCountnumber
roleCountsmap<string, number>
resourcesContextQueryEvaluateResourceRow[]
connectionsContextQueryEvaluateConnectionRow[]
traceQueryExplainStep[]
diagnosticsstring[]
contextResultHashstring
structure?{ scopes: "account" | "provider" | "region" | null; parentCount: number; containerCount: number; scopeNodeCount: number }
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/context-query/frontier

Request body ContextFrontierResolveBody

contextQuery?any
parameters?map<string, any>
environmentRevisionId?string
limit?number

Response 200 { data: ContextFrontierResolveResult; meta }

entriesContextFrontierEntry[]
memberCountnumber
truncatedboolean
diagnosticsstring[]
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/cost-estimate

Response 200 { data: EnvironmentPricingEstimateResult; meta }

environmentIdstring
priceCatalogLoadedboolean
estimatesPricingSubtotal[]
resourceCountnumber
pricedResourceCountnumber
hoursPerMonthAssumednumber
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/definitions

Request body CreateEnvironmentDefinitionBody

dslBody?any
activate?boolean

Response 201 { data: CreateEnvironmentDefinitionHttpResponse; meta }

idstring
environmentIdstring
versionnumber
dslBodyany
createdAtstring
activatedboolean
stable201
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/revisions

Query

limit?string
cursor?string
includeArchivedWorkspaces?string
includeRetired?string

Response 200 { data: EnvironmentRevisionHttpItem[]; page; meta }

idstring
environmentIdstring
environmentDefinitionIdstring
workspaceGraphRevisionIdstring
targetSetIdstring
targetMembershipHashstring
statusstring
createdAtstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/revisions

Request body EvaluateEnvironmentBody

environmentDefinitionId?string
workspaceGraphRevisionId?string

Response 202 { data: EvaluateEnvironmentHttpResponse; meta }

idstring
environmentIdstring
environmentDefinitionIdstring
workspaceGraphRevisionIdstring
targetSetIdstring
targetResourceCountnumber
targetMembershipHashstring
statusstring
createdAtstring
stable202
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/revisions/{environmentRevisionId}

Response 200 { data: GetEnvironmentRevisionHttpResponse; meta }

idstring
environmentIdstring
environmentDefinitionIdstring
workspaceGraphRevisionIdstring
targetSetIdstring
targetMembershipHashstring
statusstring
createdAtstring
targetSetGetEnvironmentRevisionHttpTargetSet | null
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/revisions/{environmentRevisionId}/members

Query

limit?string
cursor?string
includeArchivedWorkspaces?string
includeRetired?string

Response 200 { data: EnvironmentRevisionMember[]; page; meta }

resourceIdResourceId
label{ canonicalIdentityKey: string; displayName: string; semanticType: string; providerType: string; lifecycleState: string } | null
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/source-model

Query

environmentRevisionId?string
hierarchy?string

Response 200 { data: EnvironmentSourceModelBuildHttpResponse; meta }

environmentIdstring
environmentRevisionIdstring
workspaceIdstring
workspaceGraphRevisionIdstring
resourceCountnumber
connectionCountnumber
sourceModelSourceModel
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/source-model

Request body ContextSourceModelBuildBody

contextQuery?any
parameters?map<string, any>
environmentRevisionId?string
hierarchyStyle?"containment" | "membership"

Response 200 { data: ContextSourceModelBuildResult; meta }

environmentIdEnvironmentId
environmentRevisionIdEnvironmentRevisionId
workspaceIdWorkspaceId
workspaceGraphRevisionIdWorkspaceGraphRevisionId
resourceCountnumber
connectionCountnumber
sourceModelSourceModel
contextResultHashstring
diagnosticsstring[]
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views

Query

limit?string
cursor?string

Response 200 { data: ViewHttpItem[]; page; meta }

idstring
environmentIdstring
namestring
originstring
createdAtstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views

Request body CreateViewBody

name?string

Response 200 { data: CreateViewHttpResponse; meta }

idstring
environmentIdstring
namestring
originstring
createdAtstring
createdboolean
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}

Response 200 { data: GetViewHttpResponse; meta }

idstring
environmentIdstring
namestring
originstring
createdAtstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/access-grants

Response 200 { data: ViewAccessGrantsListResult; meta }

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/access-grants

Request body CreateGrantBody

grantee?{ kind?: string; userId?: string; roleId?: string }

Response 200 { data: ViewAccessGrantCreateResult; meta }

grantViewAccessGrantSummary
existingboolean
stable200
DELETE
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/access-grants/{grantId}

Response 200 { data: ViewAccessGrantRevokeResult; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/configurations

Query

limit?string
cursor?string

Response 200 { data: ViewConfigurationHttpItem[]; page; meta }

idstring
viewIdstring
viewTemplateVersionIdstring
parametersmap<string, any>
configurationHashstring
createdAtstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/configurations

Request body CreateViewConfigurationBody

viewTemplateVersionId?string
parameters?map<string, any>

Response 200 { data: CreateViewConfigurationHttpResponse; meta }

idstring
viewIdstring
viewTemplateVersionIdstring
parametersmap<string, any>
configurationHashstring
createdAtstring
createdboolean
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/configurations/{viewConfigurationId}

Response 200 { data: GetViewConfigurationHttpResponse; meta }

idstring
viewIdstring
viewTemplateVersionIdstring
parametersmap<string, any>
configurationHashstring
createdAtstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions

Query

limit?string
cursor?string

Response 200 { data: ViewRevisionHttpItem[]; page; meta }

idstring
viewIdstring
viewConfigurationIdstring
viewTemplateVersionIdstring
environmentRevisionIdstring
workspaceGraphRevisionIdstring
inputHashstring
visualGraphModelHashstring
layoutHashstring
statusstring
artifactsViewRevisionArtifactHttpItem[]
createdAtstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions

Request body GenerateViewRevisionBody

viewConfigurationId?string
environmentRevisionId?string
regenerateStaleEngine?boolean

Response 202 { data: GenerateViewHttpResponse; meta }

viewRevisionIdstring
contextResultHashstring
semanticDiagramModelHashstring
visualGraphModelHashstring
layoutHashstring
inputHashstring
artifactCountnumber
svgHash?string
stable202
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}

Response 200 { data: GetViewRevisionHttpResponse; meta }

idstring
viewIdstring
viewConfigurationIdstring
viewTemplateVersionIdstring
environmentRevisionIdstring
workspaceGraphRevisionIdstring
inputHashstring
visualGraphModelHashstring
layoutHashstring
statusstring
artifactsGetViewRevisionArtifactHttpItem[]
createdAtstring
renderEngineFingerprintstring | null
renderEngineStaleboolean
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/artifacts/{kind}

Response 200 */* (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.drawio

Query

title?string
bg?string

Response 200 */* (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.mmd

Query

title?string
bg?string

Response 200 */* (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.pdf

Query

title?string
bg?string

Response 200 */* (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.png

Query

width?string
scale?string
bg?string

Response 200 */* (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/revisions/{viewRevisionId}/render.vsdx

Query

title?string
bg?string

Response 200 */* (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/shares

Response 200 { data: ViewSharesListResult; meta }

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/shares

Request body CreateShareBody

viewRevisionId?string
expiresAt?string

Response 200 { data: ViewShareCreateResult; meta }

shareViewShareSummary
tokenstring
stable200
DELETE
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/shares/{shareId}

Response 200 { data: ViewShareRevokeResult; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/source-model

Query

viewConfigurationId?string
environmentRevisionId?string
viewRevisionId?string

Response 200 { data: ViewSourceModelBuildHttpResponse; meta }

viewConfigurationIdstring
viewTemplateVersionIdstring
environmentRevisionIdstring
workspaceGraphRevisionIdstring
templateKeystring
templateVersionstring
resourceCountnumber
connectionCountnumber
sourceModelSourceModel
template?any
contextQuery?any
options?{ showRoutes?: boolean }
diagrammarEnabledboolean
stable200
DELETE
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/template-override

Response 200 { data: ClearViewTemplateOverrideHttpResponse; meta }

viewIdstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/{viewId}/template-override

Request body

template?any

Response 200 { data: SetViewTemplateOverrideHttpResponse; meta }

viewIdstring
updatedAtstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environments/{environmentId}/views/generate-default

Request body GenerateDefaultViewsBody

environmentRevisionId?string

Response 201 { data: GenerateDefaultViewsHttpResponse; meta }

stable201

Auth · 34 routes

MethodPathTier2xx
GET
/auth/hava

Query

assertion?string
redirect?string

Response 302 no body

stable
POST
/auth/saml/{realmAccountId}/acs

Request body AcsBody

SAMLResponse?string
RelayState?string

Response 200

outcome"authenticated"
handoffCodestring
principal{ email?: string; nameId: string }
samlConfigurationIdSamlConfigurationId
stable200
GET
/auth/saml/{realmAccountId}/login

Query

returnTo?string

Response 302 no body

stable
GET
/auth/saml/{realmAccountId}/metadata

Response 200 application/samlmetadata+xml (file or stream)

stable200
GET
/v1/auth/captcha

Response 200 { data: { enabled: boolean } | { enabled: boolean; provider: "recaptcha" | "turnstile"; siteKey: string } }

internal200
GET
/v1/auth/kumo/callback

Response 302 no body

stable
POST
/v1/auth/kumo/device

Response 200 DeviceLoginError | DeviceLoginStartResponse

stable200
POST
/v1/auth/kumo/device/token

Request body DeviceLoginTokenBody

device_code?string

Response 200 DeviceLoginError | DeviceLoginTokenResponse

stable200
GET
/v1/auth/kumo/end-session

Response 302 no body

stable
GET
/v1/auth/kumo/start

Response 302 no body

stable
POST
/v1/auth/login

Request body

emailstring
passwordstring
accountId?string
returnTo?string

Response 200 { data: object } | { data: object | object }

internal200
POST
/v1/auth/logout

Response 200 { data: { signedOut: boolean } }

signedOutboolean
internal200
GET
/v1/auth/me

Response 200 { data: { actor: kumo-contracts.ActorContext; session: object | null; profile: object | null; memberships: object[] }; meta }

actorkumo-contracts.ActorContext
session{ expiresAt: string (date-time); emailVerified: boolean; mfaEnabled: boolean } | null
profile{ displayName: string; email: string | null } | null
memberships{ accountId: string; accountName: string }[]
internal200
POST
/v1/auth/mfa/challenge

Request body

pendingTokenstring
codestring
returnTo?string

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 } }

internal200
POST
/v1/auth/mfa/disable

Request body

passwordstring
codestring

Response 200 { data: AuthMfaDisableResult }

disabledtrue
internal200
POST
/v1/auth/mfa/enroll/confirm

Request body

codestring
pendingToken?string
returnTo?string

Response 200 { data: { enabled: boolean; recoveryCodes: string[] } }

enabledboolean
recoveryCodesstring[]
internal200
POST
/v1/auth/mfa/enroll/start

Request body

pendingToken?string
accountLabel?string

Response 200 { data: AuthMfaEnrollStartResult }

secretBase32string
otpauthUristring
internal200
POST
/v1/auth/mfa/recovery-codes

Request body

codestring

Response 200 { data: AuthRecoveryCodesRegenerateResult }

recoveryCodesstring[]
internal200
GET
/v1/auth/oidc/{realmAccountId}/callback

Query

code?string
state?string

Response 302 no body

stable
GET
/v1/auth/oidc/{realmAccountId}/start

Response 302 no body

stable
POST
/v1/auth/partner-signup

Request body PartnerSignupBody

email?string
password?string
displayName?string
accountName?string
host?string

Response 201 { data: PartnerSignupProvisionResult; meta }

partnerIdstring
userIdstring
accountIdstring
planKeystring
trialEndsAtstring (date-time)
sessionToken?string
sessionExpiresAt?string (date-time)
stable201
POST
/v1/auth/password

Request body

currentPasswordstring
newPasswordstring

Response 200 { data: AuthPasswordChangeResult }

changedtrue
otherSessionsRevokednumber
internal200
POST
/v1/auth/password-reset/confirm

Request body

tokenstring
newPasswordstring

Response 200 { data: AuthPasswordResetConfirmResult }

resettrue
internal200
POST
/v1/auth/password-reset/request

Request body

emailstring
returnTo?string

Response 200 { data: AuthPasswordResetRequestResult }

acceptedtrue
internal200
POST
/v1/auth/session-handoff

Request body

codestring
returnTo?string

Response 200 { data: AuthSessionGrantWire }

stable200
GET
/v1/auth/sessions

Response 200 { data: { sessions: AuthSessionSummaryWire[] } }

internal200
POST
/v1/auth/sessions/{sessionId}/revoke

Response 200 { data: AuthSessionRevokeResult }

revokedboolean
internal200
POST
/v1/auth/signup

Request body

emailstring
passwordstring
displayNamestring
accountName?string
inviteToken?string
returnTo?string

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 } }

internal200
GET
/v1/auth/social

Response 200 { data: object; meta?: map<string, any> } | { data: object; meta?: map<string, any> }

internal200
GET
/v1/auth/social/callback

Query

code?string
state?string

Response 302 no body

stable
GET
/v1/auth/social/start

Response 302 no body

stable
POST
/v1/auth/switch-account

Request body

accountIdstring
returnTo?string

Response 200 { data: AuthSessionGrantWire }

stable200
POST
/v1/auth/verify-email

Request body

tokenstring

Response 200 { data: AuthEmailVerifyResult }

verifiedtrue
internal200
POST
/v1/auth/verify-email/resend

Request body

emailstring

Response 200 { data: AuthEmailVerifyResendResult }

acceptedtrue
internal200

Scim · 22 routes

MethodPathTier2xx
GET
/scim/v2/Groups

Response 200

schemasstring[]
totalResultsnumber
startIndexnumber
itemsPerPagenumber
ResourcesScimGroupResource[]
stable200
POST
/scim/v2/Groups

Request body any

Response 201 ScimGroupResource

schemasstring[]
idstring
externalId?string
displayNamestring
members?ScimGroupMember[]
metaScimMeta
stable201
DELETE
/scim/v2/Groups/{scimId}

Response 204 no body

stable204
GET
/scim/v2/Groups/{scimId}

Response 200 ScimGroupResource

schemasstring[]
idstring
externalId?string
displayNamestring
members?ScimGroupMember[]
metaScimMeta
stable200
PATCH
/scim/v2/Groups/{scimId}

Request body any

Response 200 ScimGroupResource

schemasstring[]
idstring
externalId?string
displayNamestring
members?ScimGroupMember[]
metaScimMeta
stable200
PUT
/scim/v2/Groups/{scimId}

Request body any

Response 200 ScimGroupResource

schemasstring[]
idstring
externalId?string
displayNamestring
members?ScimGroupMember[]
metaScimMeta
stable200
GET
/scim/v2/ResourceTypes

Response 200 ScimResourceType[]

stable200
GET
/scim/v2/Schemas

Response 200 ScimSchemaDefinition[]

stable200
GET
/scim/v2/Schemas/{scimId}

Response 200 ScimSchemaDefinition

idstring
namestring
descriptionstring
attributesScimSchemaAttribute[]
meta{ resourceType: "Schema"; location: string }
stable200
GET
/scim/v2/ServiceProviderConfig

Response 200 ScimServiceProviderConfig

schemasstring[]
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 }
stable200
GET
/scim/v2/Users

Response 200

schemasstring[]
totalResultsnumber
startIndexnumber
itemsPerPagenumber
ResourcesScimUserResource[]
stable200
POST
/scim/v2/Users

Request body any

Response 201 ScimUserResource

schemasstring[]
idstring
externalId?string
userNamestring
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[]
metaScimMeta
stable201
DELETE
/scim/v2/Users/{scimId}

Response 204 no body

stable204
GET
/scim/v2/Users/{scimId}

Response 200 ScimUserResource

schemasstring[]
idstring
externalId?string
userNamestring
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[]
metaScimMeta
stable200
PATCH
/scim/v2/Users/{scimId}

Request body any

Response 200 ScimUserResource

schemasstring[]
idstring
externalId?string
userNamestring
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[]
metaScimMeta
stable200
PUT
/scim/v2/Users/{scimId}

Request body any

Response 200 ScimUserResource

schemasstring[]
idstring
externalId?string
userNamestring
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[]
metaScimMeta
stable200
GET
/v1/accounts/{accountId}/scim/directories

Response 200 { data: { directories: map<string, any>[] }; meta }

directoriesmap<string, any>[]
stable200
POST
/v1/accounts/{accountId}/scim/directories

Request body DirectoryCreateBody

name?string
provider?string
initialToken?{ name?: string; expiresAt?: string }

Response 201 { data: { token?: map<string, any>; secret?: string; directory: map<string, any> }; meta }

token?map<string, any>
secret?string
directorymap<string, any>
stable201
POST
/v1/accounts/{accountId}/scim/directories/{directoryId}/disable

Response 200 { data: { directory: map<string, any> }; meta }

directorymap<string, any>
stable200
GET
/v1/accounts/{accountId}/scim/directories/{directoryId}/tokens

Response 200 { data: { tokens: map<string, any>[] }; meta }

tokensmap<string, any>[]
stable200
POST
/v1/accounts/{accountId}/scim/directories/{directoryId}/tokens

Request body TokenMintBody

name?string
expiresAt?string

Response 201 { data: { token: map<string, any>; secret: string }; meta }

tokenmap<string, any>
secretstring
stable201
DELETE
/v1/accounts/{accountId}/scim/directories/{directoryId}/tokens/{tokenId}

Response 200 { data: { revoked: boolean }; meta }

revokedboolean
stable200

Sources · 19 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/sources/{sourceId}/credential-health

Response 200 { data: CredentialHealthReportDto | null; meta }

stable200
POST
/v1/accounts/{accountId}/sources/{sourceId}/credential-health-check

Request body RunCheckBody

mode?string
force?boolean

Response 200 { data: CredentialHealthReportDto; meta?: map<string, any> } | { data: object; meta?: map<string, any> }

stable200
POST
/v1/accounts/{accountId}/sources/aws-external-id

Response 200 { data: AwsPendingExternalIdEnsureResult; meta }

externalIdstring
origin"existing" | "minted"
stable200
POST
/v1/accounts/{accountId}/sources/preflight

Request body ConnectBody

provider?string
providerKey?string
credentialKind?string
displayName?string
secretMaterial?string
credentialId?string
scopeIdentifier?string
discoveryParameters?map<string, any>
startSync?boolean

Response 200 { data: SourcePreflightResult; meta }

supportedboolean
identity?{ principal: string; scopeHint?: string; detail?: map<string, string> }
providerScopes{ key: string; displayName?: string; scopeKind?: string }[]
diagnostics{ severity: AdapterDiagnosticSeverity; code: string; message: string }[]
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources

Query

limit?string
cursor?string
includeArchived?string

Response 200 { data: ListSourcesHttpResponseItem[]; page; meta }

idstring
accountIdstring
workspaceIdstring
providerKeystring
displayNamestring
credentialReferenceIdstring
providerScopeIdstring | null
parametersmap<string, any> | null
createdAtstring
archivedAtstring | null
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources

Request body 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

Response 201 { data: CreateSourceHttpResponse; meta }

idstring
accountIdstring
workspaceIdstring
providerKeystring
displayNamestring
credentialReferenceIdstring
createdAtstring
providerScopeIdstring | null
providerScope?{ id: string; canonicalScopeKey: string; status: string }
stable201
DELETE
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}

Response 200 { data: SourceArchiveResult; meta }

sourceSource
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}

Response 200 { data: GetSourceHttpResponse; meta }

idstring
accountIdstring
workspaceIdstring
providerKeystring
displayNamestring
credentialReferenceIdstring
providerScopeIdstring | null
parametersmap<string, any> | null
createdAtstring
archivedAtstring | null
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/change-events

Request body IngestBody

eventsChangeEventBody[]
dedupeBucket?string

Response 202 { data: ChangeEventsIngestResult; meta }

matchedEventsnumber
unmatchedEventsnumber
subjectIdsnumber
scopeRequestsnumber
enqueuedboolean
stable202
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/cost/billing-exports

Response 200 { data: BillingExportsDto; meta }

workspaceIdstring
sourceIdstring
status"discovered" | "unavailable" | "unknown" | "unsupported"
exportsDiscoveredBillingExportDto[]
notesstring[]
observedAtstring | null
staleboolean
adopted{ name: string; bucket: string; adoptedAt: string } | null
generatedAtstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/cost/billing-exports/refresh

Response 200 { data: BillingExportsDto; meta }

workspaceIdstring
sourceIdstring
status"discovered" | "unavailable" | "unknown" | "unsupported"
exportsDiscoveredBillingExportDto[]
notesstring[]
observedAtstring | null
staleboolean
adopted{ name: string; bucket: string; adoptedAt: string } | null
generatedAtstring
stable200
PUT
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/parameters

Request body ParametersBody

parameters?map<string, any> | null

Response 200 { data: SourceParametersUpdateHttpResponse; meta }

idstring
accountIdstring
workspaceIdstring
providerKeystring
displayNamestring
credentialReferenceIdstring
providerScopeIdstring | null
createdAtstring
archivedAtstring | null
parameterskumo-contracts.JsonObject | null
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/sync

Request body SyncBody

triggerKind?"manual" | "scheduled" | "webhook"
parameters?map<string, any>
workspaceSyncRunId?any

Response 202 { data: RunSourceSyncHttpResponse; meta }

sourceSyncIdstring
sourceSnapshotIdstring
workspaceGraphRevisionIdstring | null
resourceRevisionsAppendednumber
connectionRevisionsAppendednumber
graphStateHashstring | null
stable202
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/syncs

Query

limit?string
cursor?string
includeArchived?string

Response 200 { data: SourceSyncsListHttpResponseItem[]; page; meta }

idstring
sourceIdstring
statusstring
triggerKindstring
plannedAtstring
startedAtstring | null
completedAtstring | null
rejectionReasonstring | null
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/syncs/{sourceSyncId}

Response 200 { data: SourceSyncGetHttpResponse; meta }

idstring
sourceIdstring
statusstring
triggerKindstring
plannedAtstring
startedAtstring | null
completedAtstring | null
rejectionReasonstring | null
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/syncs/{sourceSyncId}/diagnostics

Query

afterSeq?string
limit?string

Response 200 { data: SyncDiagnosticsListHttpResponse; meta }

itemsSyncDiagnosticWire[]
nextAfterSeqnumber | null
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/syncs/{sourceSyncId}/diagnostics/stream

Query

afterSeq?string
limit?string

Response 200 text/event-stream (file or stream)

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/{sourceId}/unarchive

Response 200 { data: SourceUnarchiveResult; meta }

sourceSource
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/sources/connect

Request body ConnectBody

provider?string
providerKey?string
credentialKind?string
displayName?string
secretMaterial?string
credentialId?string
scopeIdentifier?string
discoveryParameters?map<string, any>
startSync?boolean

Response 201 { data: SourceConnectResult; meta }

sourceIdstring
workspaceIdstring
providerKeystring
displayNamestring
credentialIdstring
providerScopeIdstring
providerScopeKeystring
providerScopeStatusstring
syncStartedboolean
workspaceSyncRunIdstring | null
discoveryDiagnosticsSourceConnectDiagnostic[]
stable201

Reports · 18 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/definitions

Query

limit?string
cursor?string
kind?string
status?string
enabled?string

Response 200 { data: ReportDefinition[]; page; meta }

reportDefinitionIdReportDefinitionId
accountIdAccountId
workspaceIdWorkspaceId
namestring
description?string
kindReportKind
scopeReportScope
sectionsReportSectionDefinition[]
defaultExportOptionsReportExportOptions
createdBykumo-contracts.ActorRef
createdAtstring
updatedAtstring
versionnumber
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/definitions

Request body ReportDefinitionCreateBody

workspaceId?WorkspaceId
namestring
description?string
kindReportKind
scopeReportScope
sections?ReportSectionDefinition[]
defaultExportOptions?ReportExportOptions
correlationId?string

Response 200 { data: ReportDefinition; meta }

reportDefinitionIdReportDefinitionId
accountIdAccountId
workspaceIdWorkspaceId
namestring
description?string
kindReportKind
scopeReportScope
sectionsReportSectionDefinition[]
defaultExportOptionsReportExportOptions
createdBykumo-contracts.ActorRef
createdAtstring
updatedAtstring
versionnumber
stable200
DELETE
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/definitions/{definitionId}

Response 200 { data: ReportDefinitionDeleteResult; meta }

deletedboolean
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/definitions/{definitionId}

Response 200 { data: ReportDefinition; meta }

reportDefinitionIdReportDefinitionId
accountIdAccountId
workspaceIdWorkspaceId
namestring
description?string
kindReportKind
scopeReportScope
sectionsReportSectionDefinition[]
defaultExportOptionsReportExportOptions
createdBykumo-contracts.ActorRef
createdAtstring
updatedAtstring
versionnumber
stable200
PATCH
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/definitions/{definitionId}

Request body ReportDefinitionUpdateBody

name?string
description?string
sections?ReportSectionDefinition[]
defaultExportOptions?ReportExportOptions
correlationId?string

Response 200 { data: ReportDefinition; meta }

reportDefinitionIdReportDefinitionId
accountIdAccountId
workspaceIdWorkspaceId
namestring
description?string
kindReportKind
scopeReportScope
sectionsReportSectionDefinition[]
defaultExportOptionsReportExportOptions
createdBykumo-contracts.ActorRef
createdAtstring
updatedAtstring
versionnumber
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/exports/{exportId}

Response 200 { data: ReportExportRequest; meta }

reportExportIdReportExportId
reportRunIdReportRunId
accountIdAccountId
workspaceIdWorkspaceId
requestedBykumo-contracts.ActorRef
requestedAtstring
startedAt?string
completedAt?string
failedAt?string
formatReportExportFormat
optionsReportExportOptions
redactionModeReportRedactionMode
statusReportExportStatus
artifactRef?ReportContentBlobRef
diagnosticsReportDiagnostic[]
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/exports/{exportId}/content

Response 200 */* (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/exports/{exportId}/download

Query

expiresIn?string

Response 200 { data: ReportArtifactGetDownloadUrlResult; meta }

urlstring
expiresAtstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runs

Query

limit?string
cursor?string
kind?string
status?string
enabled?string

Response 200 { data: ReportRun[]; page; meta }

reportRunIdReportRunId
reportDefinitionId?ReportDefinitionId
reportDefinitionVersion?number
accountIdAccountId
workspaceIdWorkspaceId
kindReportKind
scopeReportScope
statusReportRunStatus
requestedBykumo-contracts.ActorRef
requestedAtstring
startedAt?string
completedAt?string
failedAt?string
inputHashstring
modelHash?string
sourceStateReportSourceState
authorizationProjectionReportAuthorizationProjection
modelRef?ReportContentBlobRef
summary?ReportRunSummary
diagnosticsReportDiagnostic[]
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runs

Request body 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

Response 200 { data: ReportRunStartResultDto; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runs/{runId}

Response 200 { data: ReportRun; meta }

reportRunIdReportRunId
reportDefinitionId?ReportDefinitionId
reportDefinitionVersion?number
accountIdAccountId
workspaceIdWorkspaceId
kindReportKind
scopeReportScope
statusReportRunStatus
requestedBykumo-contracts.ActorRef
requestedAtstring
startedAt?string
completedAt?string
failedAt?string
inputHashstring
modelHash?string
sourceStateReportSourceState
authorizationProjectionReportAuthorizationProjection
modelRef?ReportContentBlobRef
summary?ReportRunSummary
diagnosticsReportDiagnostic[]
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runs/{runId}/cancel

Response 200 { data: ReportRun; meta }

reportRunIdReportRunId
reportDefinitionId?ReportDefinitionId
reportDefinitionVersion?number
accountIdAccountId
workspaceIdWorkspaceId
kindReportKind
scopeReportScope
statusReportRunStatus
requestedBykumo-contracts.ActorRef
requestedAtstring
startedAt?string
completedAt?string
failedAt?string
inputHashstring
modelHash?string
sourceStateReportSourceState
authorizationProjectionReportAuthorizationProjection
modelRef?ReportContentBlobRef
summary?ReportRunSummary
diagnosticsReportDiagnostic[]
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runs/{runId}/exports

Request body ReportExportStartBody

formatReportExportFormat
options?ReportExportOptions
mode?"inline" | "queued"
correlationId?string

Response 200 { data: ReportExportStartResultDto; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/runs/{runId}/model

Response 200 { data: ReportModel; meta }

schemaVersion1
reportRunIdReportRunId
kindReportKind
titlestring
accountReportAccountSummary
workspaceReportWorkspaceSummary
subjectReportSubject
generatedAtstring
generatedBykumo-contracts.ActorRef
sourceStateReportSourceState
sectionsReportSection[]
findingsReportFinding[]
metricsReportMetric[]
evidenceReportEvidence[]
recommendationsReportRecommendation[]
diagnosticsReportDiagnostic[]
redactionReportRedactionSummary
provenanceReportProvenance
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/schedules

Query

limit?string
cursor?string
kind?string
status?string
enabled?string

Response 200 { data: ReportSchedule[]; page; meta }

reportScheduleIdReportScheduleId
reportDefinitionIdReportDefinitionId
accountIdAccountId
workspaceIdWorkspaceId
cronstring
timezonestring
deliveryReportDeliveryTarget[]
exportFormatsReportExportFormat[]
enabledboolean
nextRunAt?string
lastRunAt?string
createdAtstring
updatedAtstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/schedules

Request body ReportScheduleCreateBody

reportDefinitionIdReportDefinitionId
workspaceId?WorkspaceId
cronstring
timezonestring
deliveryReportDeliveryTarget[]
exportFormats?ReportExportFormat[]
enabled?boolean
correlationId?string

Response 200 { data: ReportSchedule; meta }

reportScheduleIdReportScheduleId
reportDefinitionIdReportDefinitionId
accountIdAccountId
workspaceIdWorkspaceId
cronstring
timezonestring
deliveryReportDeliveryTarget[]
exportFormatsReportExportFormat[]
enabledboolean
nextRunAt?string
lastRunAt?string
createdAtstring
updatedAtstring
stable200
DELETE
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/schedules/{scheduleId}

Response 200 { data: ReportScheduleDeleteResult; meta }

deletedboolean
stable200
PATCH
/v1/accounts/{accountId}/workspaces/{workspaceId}/reports/schedules/{scheduleId}

Request body ReportScheduleUpdateBody

cron?string
timezone?string
delivery?ReportDeliveryTarget[]
exportFormats?ReportExportFormat[]
enabled?boolean

Response 200 { data: ReportSchedule; meta }

reportScheduleIdReportScheduleId
reportDefinitionIdReportDefinitionId
accountIdAccountId
workspaceIdWorkspaceId
cronstring
timezonestring
deliveryReportDeliveryTarget[]
exportFormatsReportExportFormat[]
enabledboolean
nextRunAt?string
lastRunAt?string
createdAtstring
updatedAtstring
stable200

Cost · 16 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/allocation-rules

Query

from?string
to?string
currency?string
basis?string

Response 200 { data: CostAllocationRulesListResult; meta }

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/allocation-rules

Request body 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 }

Response 200 { data: { rule: CostAllocationRule }; meta }

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/allocation-runs

Request body AllocationRunBody

window?{ startInclusive?: string; endExclusive?: string }
currency?string
includeEstimates?boolean

Response 200 { data: CostAllocationRunResult; meta }

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/analyze

Request body 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

Response 200 { data: WorkspaceCostAnalyzeResult; meta }

workspaceIdWorkspaceId
windowCostWindow
currencystring
summaryCostSummary
rollupsCostRollup[]
wasteWasteFinding[]
recommendationsCostRecommendation[]
coverageCostCoverageResult
diagnosticsCostDiagnostic[]
generatedAtstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/billing-exports

Response 200 { data: BillingExportsListDto; meta }

workspaceIdstring
itemsBillingExportsDto[]
generatedAtstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/billing-exports/ingest

Response 200 { data: BillingExportsIngestQueuedDto; meta }

workspaceIdstring
jobIdstring
queuedAtstring
alreadyQueuedboolean
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/changes

Query

compareFrom?string
compareTo?string
by?string
from?string
to?string
currency?string
basis?string

Response 200 { data: CostChangeAnalyzeResult; meta }

workspaceIdWorkspaceId
windowCostWindow
comparisonWindowCostWindow
currencystring
totalBeforeMoneyOrRedacted
totalAfterMoneyOrRedacted
deltasCostChangeDelta[]
anomalousCountnumber
diagnosticsCostDiagnostic[]
generatedAtstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/forecast

Query

method?string
horizonDays?string
from?string
to?string
currency?string
basis?string

Response 200 { data: CostForecastGenerateResult; meta }

forecastCostForecast
diagnosticsCostDiagnostic[]
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/overlay

Query

top?string
compareFrom?string
compareTo?string
from?string
to?string
currency?string
basis?string

Response 200 { data: CostOverlay; meta }

workspaceIdWorkspaceId
windowCostWindow
currencystring
nodesobject
legendCostOverlayLegendItem[]
cacheKeystring
generatedAtstring
diagnosticsCostDiagnostic[]
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/recommendations

Query

kinds?string
severities?string
statuses?string
limit?string
cursor?string

Response 200 { data: CostRecommendation[]; page; meta }

idCostRecommendationId
workspaceIdWorkspaceId
subjectCostSubject
kindCostRecommendationKind
titlestring
summarystring
estimatedMonthlySavingsMoney | null
implementationRisk"high" | "low" | "medium" | "unknown"
reversibility"easy" | "hard" | "moderate" | "unknown"
confidenceCostConfidence
evidenceCostEvidence[]
assumptionsCostAssumption[]
actionsCostRecommendationAction[]
statusCostRecommendationStatus
createdAtstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/reports

Query

kinds?string
limit?string
cursor?string

Response 200 { data: CostReport[]; page; meta }

idCostReportId
workspaceIdWorkspaceId
kindCostReportKind
titlestring
windowCostWindow
summaryCostSummary
sectionsCostReportSection[]
basisCostBasis
currencystring
generatedAtstring
generatedBykumo-cost-analysis.ActorRef
evidenceCostEvidence[]
diagnosticsCostDiagnostic[]
fingerprintstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/reports

Request body ReportCreateBody

kind?string
window?{ startInclusive?: string; endExclusive?: string }
title?string
basis?string
currency?string
includeForecast?boolean
forecastMethod?string

Response 200 { data: { report: CostReport }; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/reports/{reportId}

Response 200 { data: { report: CostReport }; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/rollups

Query

by?string
tagKey?string
from?string
to?string
currency?string
basis?string

Response 200 { data: CostRollupsDto; meta }

workspaceIdstring
windowCostWindow
currencystring
rollupsCostRollup[]
diagnosticsCostDiagnostic[]
status"analysed" | "not_analysed"
analyzedAtstring | null
generatedAtstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/summary

Query

from?string
to?string
currency?string
basis?string

Response 200 { data: CostSummaryDto; meta }

workspaceIdstring
windowCostWindow
currencystring
summaryCostSummary | null
coverageCostCoverageResult | null
diagnosticsCostDiagnostic[]
status"analysed" | "not_analysed"
analyzedAtstring | null
generatedAtstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/cost/waste

Query

kinds?string
severities?string
statuses?string
limit?string
cursor?string

Response 200 { data: WasteFinding[]; page; meta }

idWasteFindingId
workspaceIdWorkspaceId
subjectCostSubject
kindWasteFindingKind
titlestring
summarystring
estimatedMonthlyWasteMoney | null
actualWindowWasteMoney | null
severityCostSeverity
confidenceCostConfidence
evidenceCostEvidence[]
recommendationIdsCostRecommendationId[]
firstDetectedAtstring
lastDetectedAtstring
statusWasteFindingStatus
stable200

Sso · 11 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/sso/oidc

Response 200 { data: { configuration: AuthOidcConfigView | null }; meta }

configurationAuthOidcConfigView | null
stable200
PUT
/v1/accounts/{accountId}/sso/oidc

Request body OidcConfigBody

issuer?string
clientId?string
clientSecret?string
scopes?string[]
emailClaim?string
status?"active" | "disabled"

Response 200 { data: { configuration: AuthOidcConfigView }; meta }

configurationAuthOidcConfigView
stable200
GET
/v1/accounts/{accountId}/sso/saml

Query

status?string

Response 200 { data: { configurations: SsoSamlConfigurationDto[] }; meta }

configurationsSsoSamlConfigurationDto[]
stable200
POST
/v1/accounts/{accountId}/sso/saml

Request body ConfigurationCreateBody

displayName?string
serviceProvider?SamlServiceProviderConfig
identityProvider?SamlIdentityProviderConfig
attributeMapping?SamlAttributeMapping
provisioningPolicy?SamlProvisioningPolicy
securityPolicy?SamlSecurityPolicy

Response 201 { data: { configuration: SsoSamlConfigurationDto }; meta }

stable201
DELETE
/v1/accounts/{accountId}/sso/saml/{configurationId}

Response 200 { data: { deleted: string }; meta }

deletedstring
stable200
GET
/v1/accounts/{accountId}/sso/saml/{configurationId}

Response 200 { data: { configuration: SsoSamlConfigurationDto }; meta }

stable200
PATCH
/v1/accounts/{accountId}/sso/saml/{configurationId}

Request body ConfigurationUpdateBody

displayName?string
serviceProvider?SamlServiceProviderConfig
identityProvider?SamlIdentityProviderConfig
attributeMapping?SamlAttributeMapping
provisioningPolicy?SamlProvisioningPolicy
securityPolicy?SamlSecurityPolicy

Response 200 { data: { configuration: SsoSamlConfigurationDto }; meta }

stable200
POST
/v1/accounts/{accountId}/sso/saml/{configurationId}/activate

Response 200 { data: { deactivated?: SsoSamlConfigurationDto; configuration: SsoSamlConfigurationDto }; meta }

stable200
POST
/v1/accounts/{accountId}/sso/saml/{configurationId}/disable

Response 200 { data: { configuration: SsoSamlConfigurationDto }; meta }

stable200
GET
/v1/accounts/{accountId}/sso/saml/sp-metadata

Response 200 application/xml; charset=utf-8 (file or stream)

stable200
GET
/v1/accounts/{accountId}/sso/setup

Response 200 { data: SsoSetupValues; meta }

saml{ entityId: string; assertionConsumerServiceUrl: string }
oidc{ redirectUri: string }
stable200

Export · 8 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/export/archive

Query

format?string
kinds?string

Response 200 */* (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/export/connections.csv

Query

asOf?string
asOf.workspaceGraphRevisionId?string

Response 200 text/csv; charset=utf-8 (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/export/connections.json

Query

asOf?string
asOf.workspaceGraphRevisionId?string

Response 200 */* (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/export/jobs/{jobId}/download

Response 200 application/zip (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/export/resources.csv

Query

asOf?string
asOf.workspaceGraphRevisionId?string

Response 200 text/csv; charset=utf-8 (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/export/resources.json

Query

asOf?string
asOf.workspaceGraphRevisionId?string

Response 200 */* (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/export/workspace.zip

Query

asOf?string
asOf.workspaceGraphRevisionId?string

Response 200 application/zip (file or stream)

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/export/workspace.zip/jobs

Query

asOf?string
asOf.workspaceGraphRevisionId?string

Response 202 { data: { jobId: string; statusPath: string; downloadPath: string }; meta }

jobIdstring
statusPathstring
downloadPathstring
stable202

Source credentials · 8 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/source-credentials

Query

limit?string
cursor?string

Response 200 { data: ListSourceCredentialsHttpResponseItem[]; page; meta }

idstring
accountIdstring
displayNamestring
credentialKindstring
secretRefstring
createdAtstring
stable200
POST
/v1/accounts/{accountId}/source-credentials

Request body kumo-core-server.SourceCredentialsRoute.CreateBody

displayName?string
credentialKind?string
secretRef?string
secretStoreKey?string
secretMaterial?string
provider?string
metadata?any

Response 201 { data: CreateSourceCredentialHttpResponse; meta }

idstring
accountIdstring
displayNamestring
credentialKindstring
secretRefstring
createdAtstring
stable201
DELETE
/v1/accounts/{accountId}/source-credentials/{credentialId}

Response 200 { data: DeleteSourceCredentialHttpResponse; meta }

credentialIdstring
deletedtrue
stable200
GET
/v1/accounts/{accountId}/source-credentials/{credentialId}

Response 200 { data: GetSourceCredentialHttpResponse; meta }

idstring
accountIdstring
displayNamestring
credentialKindstring
secretRefstring
createdAtstring
stable200
POST
/v1/accounts/{accountId}/source-credentials/{credentialId}/rotate

Request body RotateBody

secretRef?string
secretStoreKey?string
credentialKind?string
displayName?string
secretMaterial?any

Response 200 { data: RotateSourceCredentialHttpResponse; meta }

idstring
accountIdstring
displayNamestring
credentialKindstring
secretRefstring
createdAtstring
stable200
GET
/v1/accounts/{accountId}/source-credentials/{sourceCredentialReferenceId}/health

Response 200 { data: CredentialHealthReportDto | null; meta }

stable200
POST
/v1/accounts/{accountId}/source-credentials/{sourceCredentialReferenceId}/health-check

Request body RunCheckBody

mode?string
force?boolean

Response 200 { data: CredentialHealthReportDto; meta?: map<string, any> } | { data: object; meta?: map<string, any> }

stable200
GET
/v1/accounts/{accountId}/source-credentials/{sourceCredentialReferenceId}/health-reports

Query

limit?string
cursor?string

Response 200 { data: CredentialHealthReportDto[]; page; meta }

stable200

Change intelligence · 7 routes

MethodPathTier2xx
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/analyze

Request body kumo-core-server.ChangeIntelligenceRoute.AnalyzeBody

from?string
to?string
lenses?ChangeLens[]
maxChanges?number
includeSuppressed?boolean

Response 200 { data: ChangeIntelligenceAnalyzeResult; meta }

workspaceIdWorkspaceId
windowChangeWindow
summaryChangeSummary
changesChangeItem[]
storiesChangeStory[]
suppressedSuppressedChange[]
diagnosticsChangeDiagnostic[]
truncated{ analysed: number; shown: number } | null
generatedAtstring
analysisVersionstring
inputHashstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/changes

Query

order?string
severities?string
categories?string
subjectKinds?string
since?string
until?string
limit?string
cursor?string

Response 200 { data: WorkspaceChangesListResult; meta }

itemsChangeItem[]
nextCursorstring | null
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/changes/{changeId}/explain

Query

includeRawEvidence?string

Response 200 { data: ChangeExplainResult; meta }

foundboolean
changeChangeItem | null
explanationstring[]
rawDiffRefsRawDiffRef[]
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/correlate

Request body 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

Response 200 { data: ChangeCorrelationSearchResult; meta }

window{ since: string | null; until: string | null }
itemsChangeItem[]
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/digest

Request body DigestBody

mode?"cost" | "daily_workspace" | "deployment" | "incident" | "security" | "source_sync" | "weekly_account"
since?string
until?string
maxHighlights?number

Response 200 { data: ChangeDigestBuildResult; meta }

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/materialize

Request body MaterializeBody

force?boolean
from?string
to?string
lenses?ChangeLens[]
maxChanges?number
includeSuppressed?boolean

Response 200 { data: ChangeIntelligenceMaterializeResult; meta }

resultChangeIntelligenceAnalyzeResult
fromCacheboolean
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/change-intelligence/resources/{resourceId}/timeline

Query

since?string
until?string
limit?string

Response 200 { data: ResourceChangeTimelineResult; meta }

resourceIdResourceId
itemsChangeItem[]
stable200

Graph diffs · 7 routes

MethodPathTier2xx
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs

Request body kumo-core-server.GraphDiffsRoute.CreateBody

from?{ workspaceGraphRevisionId?: string }
to?{ workspaceGraphRevisionId?: string }
force?boolean

Response 200 { data: { summary: GraphDiffSummaryDto; cacheHit: boolean }; meta }

summaryGraphDiffSummaryDto
cacheHitboolean
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}

Response 200 { data: GraphDiffSummaryDto; meta }

artifactIdstring
fromWorkspaceGraphRevisionIdstring
toWorkspaceGraphRevisionIdstring
statusstring
totalChangesnumber
resources{ added: number; removed: number; changed: number }
connections{ added: number; removed: number; changed: number }
severitiesmap<string, number>
categoriesmap<string, number>
warningsGraphDiffWarningDto[]
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}/changes

Query

limit?string
cursor?string
categories?string
severities?string
changeKinds?string
text?string
includeRedacted?string
includeNonAuthoritative?string

Response 200 { data: GraphDiffChangeDto[]; page; meta }

idstring
kindstring
categorystring
severitystring
titlestring
descriptionstring
subjectGraphDiffChangeSubjectDto
fieldsGraphDiffFieldChangeDto[]
authorityGraphDiffAuthorityDto
redactedboolean
explainUrl?string
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}/changes/{changeId}/explain

Query

depth?"evidence" | "full" | "summary"

Response 200 { data: GraphDiffExplanation; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}/export

Query

format?"csv" | "json"

Response 200 */* (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}/overlay

Response 200 { data: GraphDiffOverlayDto; meta }

artifactIdstring
legendGraphDiffLegendItemDto[]
resourceTreatmentsmap<string, GraphDiffVisualTreatmentDto>
connectionTreatmentsmap<string, GraphDiffVisualTreatmentDto>
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/graph-diffs/{artifactId}/summary

Response 200 { data: GraphDiffSummaryDto; meta }

artifactIdstring
fromWorkspaceGraphRevisionIdstring
toWorkspaceGraphRevisionIdstring
statusstring
totalChangesnumber
resources{ added: number; removed: number; changed: number }
connections{ added: number; removed: number; changed: number }
severitiesmap<string, number>
categoriesmap<string, number>
warningsGraphDiffWarningDto[]
stable200

Webhook subscriptions · 7 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/webhook-subscriptions

Response 200 { data: WebhookSubscriptionListResult; meta }

subscriptionsWebhookSubscription[]
stable200
POST
/v1/accounts/{accountId}/webhook-subscriptions

Request body CreateWebhookSubscriptionRequestBody

urlstring
description?string
eventTypesstring[]

Response 201 { data: WebhookSubscriptionCreateResult; meta }

subscriptionWebhookSubscription
signingSecretstring
stable201
DELETE
/v1/accounts/{accountId}/webhook-subscriptions/{subscriptionId}

Response 200 { data: WebhookSubscriptionDeleteResult; meta }

idstring
stable200
GET
/v1/accounts/{accountId}/webhook-subscriptions/{subscriptionId}

Response 200 { data: WebhookSubscriptionGetResult; meta }

stable200
PATCH
/v1/accounts/{accountId}/webhook-subscriptions/{subscriptionId}

Request body UpdateWebhookSubscriptionRequestBody | null

Response 200 { data: WebhookSubscriptionUpdateResult; meta }

stable200
GET
/v1/accounts/{accountId}/webhook-subscriptions/{subscriptionId}/deliveries

Query

limit?string

Response 200 { data: WebhookDeliveryListResult; meta }

stable200
POST
/v1/accounts/{accountId}/webhook-subscriptions/{subscriptionId}/rotate-secret

Response 200 { data: WebhookSubscriptionRotateSecretResult; meta }

subscriptionWebhookSubscription
signingSecretstring
stable200

Billing · 6 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/billing/entitlements

Query

workspaceId?string

Response 200 { data: { subject: QuotaSubject; planId: PlanId | null; planVersionId: PlanVersionId | null; subscriptionId: SubscriptionId | null; entitlements: BillingEntitlementRecord[]; warnings: string[] }; meta }

subjectQuotaSubject
planIdPlanId | null
planVersionIdPlanVersionId | null
subscriptionIdSubscriptionId | null
entitlementsBillingEntitlementRecord[]
warningsstring[]
stable200
GET
/v1/accounts/{accountId}/billing/features/{featureKey}

Query

workspaceId?string

Response 200 { data: { featureKey: FeatureKey; enabled: boolean; entitlement: BillingEntitlementRecord | null }; meta }

featureKeyFeatureKey
enabledboolean
entitlementBillingEntitlementRecord | null
stable200
GET
/v1/accounts/{accountId}/billing/plans

Query

familyKey?string

Response 200 { data: { plans: SelfServePlan[] }; meta }

stable200
POST
/v1/accounts/{accountId}/billing/quota/check

Request body QuotaCheckBody

featureKey?string
workspaceId?string
requestedQuantity?number

Response 200 { data: BillingQuotaDecisionRecord; meta }

kindBillingQuotaDecisionKind
featureKeystring
subjectBillingQuotaSubjectRecord
requestedQuantitynumber
currentUsagenumber | null
softLimitnumber | null
hardLimitnumber | null
resetAtstring | null
reasonstring
reasonCodestring | null
evaluatedAtstring
stable200
GET
/v1/accounts/{accountId}/billing/subscriptions

Response 200 { data: { subscriptions: BillingSubscriptionRecord[] }; meta }

stable200
GET
/v1/accounts/{accountId}/billing/subscriptions/{subscriptionId}

Response 200 { data: BillingSubscriptionRecord; meta }

idstring
accountIdAccountId
billingCustomerIdstring
planIdstring
planNamestring | null
planKeystring | null
planVersionIdstring
providerstring
statusBillingSubscriptionStatus
currentPeriodStartstring | null
currentPeriodEndstring | null
cancelAtPeriodEndboolean
trialEndsAtstring | null
createdAtstring
updatedAtstring
endedAtstring | null
stable200

Integrations · 6 routes

MethodPathTier2xx
DELETE
/v1/accounts/{accountId}/integrations/slack

Response 200 { data: { disconnected: boolean }; meta }

disconnectedboolean
stable200
GET
/v1/accounts/{accountId}/integrations/slack

Response 200 { data: object; meta?: map<string, any> } | { data: object; meta?: map<string, any> }

stable200
GET
/v1/accounts/{accountId}/integrations/slack/channels

Response 200 { data: { channels: SlackChannelInfo[] }; meta }

stable200
POST
/v1/accounts/{accountId}/integrations/slack/oauth/start

Response 200 { data: { authorizeUrl: string }; meta }

authorizeUrlstring
stable200
GET
/v1/integrations/slack/callback

Query

code?string
state?string
error?string

Response 302 no body

stable
POST
/v1/integrations/slack/commands

Response 200 SlackCommandResponse

response_type"ephemeral"
textstring
stable200

Notifications · 6 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/notifications

Query

workspace?string
unreadOnly?string
includeDismissed?string
limit?string
cursor?string

Response 200 { data: NotificationInboxItemDto[]; page; meta }

recipientNotificationRecipientNotificationDto
notificationNotificationDto
stable200
GET
/v1/accounts/{accountId}/notifications/{notificationId}

Response 200 { data: NotificationDto; meta }

idstring
accountIdstring
workspaceIdstring | null
kindstring
severitystring
urgencystring
titlestring
summarystring
subjectNotificationSubject
linksNotificationLink[]
evidenceNotificationEvidence[]
threadKeystring | null
dedupeKeystring
createdAtstring
occurredAtstring
statestring
stable200
POST
/v1/accounts/{accountId}/notifications/items/{recipientNotificationId}/dismiss

Response 200 { data: { alreadyDismissed: boolean }; meta }

alreadyDismissedboolean
stable200
POST
/v1/accounts/{accountId}/notifications/items/{recipientNotificationId}/read

Response 200 { data: { alreadyRead: boolean }; meta }

alreadyReadboolean
stable200
POST
/v1/accounts/{accountId}/notifications/read-all

Query

workspace?string
unreadOnly?string
includeDismissed?string
limit?string
cursor?string

Response 200 { data: { markedCount: number }; meta }

markedCountnumber
stable200
GET
/v1/accounts/{accountId}/notifications/unread-count

Query

workspace?string
unreadOnly?string
includeDismissed?string
limit?string
cursor?string

Response 200 { data: { count: number }; meta }

countnumber
stable200

Provider scopes · 6 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/provider-scopes

Query

limit?string
cursor?string
includeArchived?string

Response 200 { data: ListProviderScopesHttpResponseItem[]; page; meta }

idstring
accountIdstring
providerKeystring
canonicalScopeKeystring
displayNamestring
createdAtstring
statusstring
scopeKindstring | null
parentProviderScopeIdstring | null
resourceCount?number
provisionedResourceCount?number
unclassifiedResourceCount?number
isOrganizationPayer?boolean
organizationId?string | null
attributesmap<string, any>
stable200
POST
/v1/accounts/{accountId}/provider-scopes

Request body CreateProviderScopeBody

provider?string
providerKey?string
canonicalScopeKey?string
displayName?string
name?string

Response 201 { data: CreateProviderScopeHttpResponse; meta }

idstring
accountIdstring
providerKeystring
canonicalScopeKeystring
displayNamestring
createdAtstring
stable201
GET
/v1/accounts/{accountId}/provider-scopes/{providerScopeId}

Response 200 { data: GetProviderScopeHttpResponse; meta }

idstring
accountIdstring
providerKeystring
canonicalScopeKeystring
displayNamestring
createdAtstring
stable200
GET
/v1/accounts/{accountId}/provider-scopes/{providerScopeId}/credential-health

Response 200 { data: CredentialHealthReportDto | null; meta }

stable200
POST
/v1/accounts/{accountId}/provider-scopes/{providerScopeId}/credential-health-check

Response 200 no body

stable200
POST
/v1/accounts/{accountId}/provider-scopes/discover

Request body DiscoverProviderScopesBody

provider?string
providerKey?string
credentialReferenceId?string
parameters?map<string, any>

Response 200 { data: DiscoverProviderScopesHttpResponse; meta }

supportedboolean
providerScopesDiscoveredProviderScopeHttpItem[]
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 }[]
stable200

Resources · 6 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/resources

Query

asOf?string
asOf.workspaceGraphRevisionId?string
filter.semanticType?string
limit?string

Response 200 { data: ListResourcesAtRevisionHttpResponseItem[]; page; meta }

idstring
workspaceIdstring
canonicalIdentityKeystring
semanticTypestring
providerTypestring
lifecycleStatestring
currentRevisionIdstring
displayNamestring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/resources/{resourceId}

Query

asOf?string
asOf.workspaceGraphRevisionId?string

Response 200 { data: GetResourceAtRevisionHttpResponse; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/resources/{resourceId}/connections

Query

filter.direction?"both" | "in" | "out"
filter.connectionType?string
limit?string
asOf?string
asOf.workspaceGraphRevisionId?string

Response 200 { data: ListResourceConnectionsAtRevisionHttpResponseItem[]; page; meta }

connectionIdstring
connectionTypestring
direction"in" | "out"
revisionIdstring
otherResourceIdstring | null
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/resources/{resourceId}/cost/explain

Query

from?string
to?string
currency?string
basis?string

Response 200 { data: ResourceCostExplainResult; meta }

explanationResourceCostExplanation
generatedAtstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/resources/{resourceId}/cost/price-match

Response 200 { data: PriceMatchExplainResult; meta }

matchPriceMatch
candidatesConsiderednumber
generatedAtstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/resources/{resourceId}/pricing

Response 200 { data: ResourcePricingGetResult; meta }

resourceIdstring
pricedboolean
currencystring | null
hourlynumber | null
monthlynumber | null
unitstring | null
hoursPerMonthAssumednumber
stable200

Sync runs · 6 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runs

Query

limit?string
cursor?string

Response 200 { data: ListWorkspaceSyncRunsHttpResponseItem[]; page; meta }

idstring
workspaceIdstring
accountIdstring
statusstring
triggerKindstring
finalizationPolicystring
baseWorkspaceGraphRevisionIdstring | null
finalWorkspaceGraphRevisionIdstring | null
expectedSourceCountnumber
completedSourceCountnumber
acceptedSourceCountnumber
rejectedSourceCountnumber
partialSourceCountnumber
createdAtstring
startedAtstring | null
completedAtstring | null
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runs

Request body StartBody

finalizationPolicy?"accept_partial" | "strict"
triggerKind?string
leaseTtlMs?number | null
reason?string
sourceSelection?any
syncKind?string

Response 202 { data: StartWorkspaceSyncRunHttpResponse; meta }

workspaceSyncRunIdstring
memberSourceIdsstring[]
stable202
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runs/{workspaceSyncRunId}

Response 200 { data: GetWorkspaceSyncRunHttpResponse; meta }

idstring
workspaceIdstring
accountIdstring
statusstring
triggerKindstring
finalizationPolicystring
baseWorkspaceGraphRevisionIdstring | null
finalWorkspaceGraphRevisionIdstring | null
expectedSourceCountnumber
completedSourceCountnumber
acceptedSourceCountnumber
rejectedSourceCountnumber
partialSourceCountnumber
createdAtstring
startedAtstring | null
completedAtstring | null
leaseExpiresAtstring | null
sourceFailuresWorkspaceSyncRunSourceFailure[]
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runs/{workspaceSyncRunId}/diagnostics

Query

afterSeq?string
limit?string

Response 200 { data: WorkspaceSyncRunDiagnosticsListHttpResponse; meta }

itemsSyncDiagnosticWire[]
nextAfterSeqnumber | null
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runs/{workspaceSyncRunId}/diagnostics/stream

Query

afterSeq?string
limit?string

Response 200 text/event-stream (file or stream)

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/sync-runs/{workspaceSyncRunId}/finalize

Response 200 { data: FinalizeWorkspaceSyncRunHttpResponse; meta }

statusstring
workspaceGraphRevisionIdstring | null
acceptedCountnumber
partialCountnumber
rejectedCountnumber
stable200

Usage · 6 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/usage/current

Query

workspaceId?string
meterKey?string | string[]
includeReserved?string
breakdown?string

Response 200 { data: { counters: UsageCounterViewDto[] }; meta }

stable200
GET
/v1/accounts/{accountId}/usage/export

Query

windowStartsAt?string
windowEndsAt?string
format?string
bySubject?string
meterKey?string | string[]

Response 200 { data: { export: UsageExport; content: string }; meta }

exportUsageExport
contentstring
stable200
GET
/v1/accounts/{accountId}/usage/exports/{exportId}

Response 200 { data: { export: UsageExport; content: string }; meta }

exportUsageExport
contentstring
stable200
GET
/v1/accounts/{accountId}/usage/ledger

Query

meterKey?string | string[]
entryKind?string | string[]
occurredFrom?string
occurredTo?string
afterSequence?string
limit?string

Response 200 { data: UsageLedgerPageDto; meta }

entriesUsageLedgerEntryDto[]
nextAfterSequence?string
stable200
GET
/v1/accounts/{accountId}/usage/meters

Query

billableOnly?string

Response 200 { data: { meters: UsageMeterDefinition[] }; meta }

stable200
GET
/v1/accounts/{accountId}/usage/reservations

Query

status?string
meterKey?string | string[]
limit?string

Response 200 { data: { reservations: UsageReservation[] }; meta }

reservationsUsageReservation[]
stable200

View templates · 6 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/view-templates

Query

limit?string
cursor?string

Response 200 { data: ViewTemplateHttpItem[]; page; meta }

idstring
accountIdstring | null
templateKeystring
displayNamestring
createdAtstring
stable200
POST
/v1/accounts/{accountId}/view-templates

Request body CreateTemplateBody

templateKey?string
displayName?string

Response 200 { data: ViewTemplateCreateHttpResponse; meta }

idstring
accountIdstring | null
templateKeystring
displayNamestring
createdAtstring
createdboolean
stable200
GET
/v1/accounts/{accountId}/view-templates/{viewTemplateId}

Response 200 { data: GetViewTemplateHttpResponse; meta }

idstring
accountIdstring | null
templateKeystring
displayNamestring
createdAtstring
stable200
GET
/v1/accounts/{accountId}/view-templates/{viewTemplateId}/versions

Query

limit?string
cursor?string

Response 200 { data: ViewTemplateVersionHttpItem[]; page; meta }

idstring
viewTemplateIdstring
versionstring
statusstring
templateHashstring
createdAtstring
stable200
POST
/v1/accounts/{accountId}/view-templates/{viewTemplateId}/versions

Request body CreateVersionBody

version?string
body?any
status?"deprecated" | "draft" | "published"

Response 201 { data: ViewTemplateVersionCreateHttpResponse; meta }

idstring
viewTemplateIdstring
versionstring
statusstring
templateHashstring
createdAtstring
stable201
GET
/v1/accounts/{accountId}/view-templates/{viewTemplateId}/versions/{viewTemplateVersionId}

Response 200 { data: GetViewTemplateVersionHttpResponse; meta }

idstring
viewTemplateIdstring
versionstring
statusstring
resolvedBodyany
templateHashstring
createdAtstring
stable200

Alert targets · 5 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/alert-targets

Query

workspace?string

Response 200 { data: { targets: AlertTargetDto[] }; meta }

stable200
POST
/v1/accounts/{accountId}/alert-targets

Request body TargetCreateBody

name?string
workspaceId?string
channel?"email" | "slack" | "webhook"
destination?string
enabled?boolean
minSeverity?"critical" | "high" | "info" | "low" | "medium"

Response 201 { data: AlertTargetDto; meta }

targetIdstring
accountIdstring
workspaceIdstring | null
namestring
enabledboolean
channelstring
destinationRedactedstring
minSeverity?"critical" | "high" | "info" | "low" | "medium"
stable201
DELETE
/v1/accounts/{accountId}/alert-targets/{targetId}

Response 200 { data: { deleted: boolean }; meta }

deletedboolean
stable200
PATCH
/v1/accounts/{accountId}/alert-targets/{targetId}

Request body TargetUpdateBody

name?string
enabled?boolean
channel?"email" | "slack" | "webhook"
destination?string
minSeverity?"critical" | "high" | "info" | "low" | "medium" | null

Response 200 { data: AlertTargetDto; meta }

targetIdstring
accountIdstring
workspaceIdstring | null
namestring
enabledboolean
channelstring
destinationRedactedstring
minSeverity?"critical" | "high" | "info" | "low" | "medium"
stable200
POST
/v1/accounts/{accountId}/alert-targets/{targetId}/test

Response 200 { data: AlertTargetTestResult; meta }

deliveredboolean
error?string
stable200

Roles · 5 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/roles

Response 200 { data: { roles: IamRoleRecord[] }; meta }

stable200
POST
/v1/accounts/{accountId}/roles

Request body CreateRoleBody

key?string
displayName?string
description?string
permissions?string[]
status?"active" | "draft"

Response 201 { data: { role: IamRoleRecord }; meta }

stable201
DELETE
/v1/accounts/{accountId}/roles/{roleId}

Response 200 { data: { role: IamRoleRecord; transitioned: boolean }; meta }

roleIamRoleRecord
transitionedboolean
stable200
GET
/v1/accounts/{accountId}/roles/{roleId}

Response 200 { data: { role: IamRoleRecord; permissions: string[] }; meta }

roleIamRoleRecord
permissionsstring[]
stable200
PATCH
/v1/accounts/{accountId}/roles/{roleId}

Request body UpdateRoleBody

permissions?string[]
displayName?string
description?string

Response 200 { data: { role: IamRoleRecord }; meta }

stable200
MethodPathTier2xx
GET
/v1/accounts/{accountId}/search

Query

q?string
kind?string
workspaceId?string
providerKey?string
semanticType?string
lifecycleState?string
region?string
attributes?string
includeArchived?string
limit?string
cursor?string
sort?string
dir?string

Response 200 { data: SearchResultPage; meta }

hitsSearchHit[]
facetsSearchFacet[]
totalnumber
nextCursorstring | null
stable200
GET
/v1/accounts/{accountId}/search/saved-views

Response 200 { data: { items: SavedView[] }; meta }

itemsSavedView[]
stable200
POST
/v1/accounts/{accountId}/search/saved-views

Request body SavedViewCreateBody

namestring
querystring

Response 200 { data: { view: SavedView; created: boolean }; meta }

viewSavedView
createdboolean
stable200
DELETE
/v1/accounts/{accountId}/search/saved-views/{savedViewId}

Response 200 { data: { deleted: true }; meta }

deletedtrue
stable200
PATCH
/v1/accounts/{accountId}/search/saved-views/{savedViewId}

Request body SavedViewUpdateBody

name?string
query?string

Response 200 { data: { view: SavedView }; meta }

stable200

Workspaces · 5 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces

Query

limit?string
cursor?string
includeArchived?string

Response 200 { data: WorkspaceListItemDto[]; page; meta }

idstring
accountIdstring
namestring
createdAtstring
archivedAtstring | null
stable200
POST
/v1/accounts/{accountId}/workspaces

Request body CreateWorkspaceBody

name?string
displayName?string

Response 201 { data: CreateWorkspaceHttpResponse; meta }

idstring
accountIdstring
namestring
createdAtstring
created?boolean
stable201
DELETE
/v1/accounts/{accountId}/workspaces/{workspaceId}

Response 200 { data: WorkspaceArchiveResult; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}

Response 200 { data: WorkspaceDto; meta }

idstring
accountIdstring
namestring
createdAtstring
archivedAtstring | null
stable200
POST
/v1/accounts/{accountId}/workspaces/demo

Request body ProvisionDemoWorkspaceBody

workspaceName?string

Response 201 { data: DemoWorkspaceProvisionHttpResponse; meta }

workspaceIdstring
sourceIdstring
workspaceGraphRevisionIdstring | null
resourceCountnumber
connectionCountnumber
reusedExistingWorkspaceboolean
stable201

Alert rules · 4 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/alert-rules

Query

workspace?string

Response 200 { data: { rules: AlertRuleDto[] }; meta }

stable200
POST
/v1/accounts/{accountId}/alert-rules

Request body RuleCreateBody

name?string
workspaceId?string
condition?AlertRuleCondition
enabled?boolean
severity?"critical" | "high" | "info" | "low" | "medium"

Response 201 { data: AlertRuleDto; meta }

ruleIdstring
accountIdstring
workspaceIdstring | null
namestring
enabledboolean
conditionAlertRuleConditionDto
severity?"critical" | "high" | "info" | "low" | "medium"
stable201
DELETE
/v1/accounts/{accountId}/alert-rules/{ruleId}

Response 200 { data: { deleted: boolean }; meta }

deletedboolean
stable200
PATCH
/v1/accounts/{accountId}/alert-rules/{ruleId}

Request body RuleUpdateBody

name?string
enabled?boolean
condition?AlertRuleCondition
severity?"critical" | "high" | "info" | "low" | "medium" | null

Response 200 { data: AlertRuleDto; meta }

ruleIdstring
accountIdstring
workspaceIdstring | null
namestring
enabledboolean
conditionAlertRuleConditionDto
severity?"critical" | "high" | "info" | "low" | "medium"
stable200

Jobs · 4 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/jobs

Query

status?string
kind?string
limit?string
cursor?string

Response 200 { data: map<string, any>[]; page; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/jobs/{jobId}

Response 200 { data: map<string, any>; meta }

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/jobs/{jobId}/cancel

Request body CancelBody

reason?string

Response 200 { data: map<string, any>; meta }

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/jobs/{jobId}/retry

Response 200 { data: map<string, any>; meta }

stable200

Me · 4 routes

MethodPathTier2xx
GET
/v1/me

Response 200 { data: { type: string; userId?: UserId; accountId?: AccountId }; meta }

typestring
userId?UserId
accountId?AccountId
stable200
GET
/v1/me/features

Response 200 { data: TenantFeaturesResponseDto; meta }

featuresTenantFeatureAvailabilityDto[]
evaluatedAtstring
cacheKeystring
stable200
GET
/v1/me/features/{featureKey}

Response 200 { data: TenantFeatureResponseDto; meta }

featureTenantFeatureAvailabilityDto
evaluatedAtstring
cacheKeystring
stable200
GET
/v1/me/license

Response 200 { data: { installed: boolean; status: string }; meta }

installedboolean
statusstring
stable200

Operations · 4 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/operations

Query

limit?string
cursor?string
filter.status?string
filter.type?string
filter.workspace?string
filter.source?string

Response 200 { data: OperationHttpItem[]; page; meta }

idstring
workspaceIdstring | null
sourceIdstring | null
type"operation"
operationTypestring
statusstring
target{ type: string; id: string }
resultmap<string, any> | null
failurestring | null
createdAtstring
startedAtstring | null
completedAtstring | null
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/operations

Query

limit?string
cursor?string
filter.status?string
filter.type?string
filter.workspace?string
filter.source?string

Response 200 { data: OperationHttpItem[]; page; meta }

idstring
workspaceIdstring | null
sourceIdstring | null
type"operation"
operationTypestring
statusstring
target{ type: string; id: string }
resultmap<string, any> | null
failurestring | null
createdAtstring
startedAtstring | null
completedAtstring | null
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/operations/{operationId}

Response 200 { data: GetOperationHttpResponse; meta }

idstring
workspaceIdstring | null
type"operation"
operationTypestring
statusstring
target{ type: string; id: string }
resultmap<string, any> | null
createdAtstring
startedAtstring | null
completedAtstring | null
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/operations/{operationId}/cancellation

Response 200 { data: CancelOperationHttpResponse; meta }

idstring
type"operation"
operationTypestring
statusstring
target{ type: string; id: string }
resultmap<string, any> | null
createdAtstring
startedAtstring | null
completedAtstring | null
stable200

Read models · 4 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/read-models/counts

Query

revisionId?string

Response 200 { data: WorkspaceGraphCounts | null; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/read-models/resources

Query

revisionId?string
environmentId?string
semanticType?string
providerKey?string
search?string
limit?string
cursor?string

Response 200 { data: ResourceSummary[]; page; meta }

resourceIdResourceId
workspaceIdWorkspaceId
revisionIdWorkspaceGraphRevisionId
semanticTypestring
displayNamestring
providerKeyProviderKey
regionstring | null
environmentIdEnvironmentId | null
sensitiveboolean
updatedAtstring
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/read-models/resources/{resourceId}/adjacency

Response 200 { data: AdjacencyEntry | null; meta }

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/read-models/sources

Response 200 { data: SourceSyncStatus[]; meta }

workspaceIdWorkspaceId
sourceIdSourceId
providerKeyProviderKey
lastSyncRunIdWorkspaceSyncRunId | null
stateSourceSyncState
coverageSourceSyncCoverage
startedAtstring | null
finishedAtstring | null
resourceCountnumber
errorCountnumber
stable200

Retention policies · 4 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/retention-policies

Query

limit?string
cursor?string

Response 200 { data: RetentionPolicyRecordHttpItem[]; page; meta }

idstring
accountIdstring
namestring
targetstring
retainForDaysnumber
minimumKeptnumber
createdAtstring
stable200
POST
/v1/accounts/{accountId}/retention-policies

Request body kumo-core-server.RetentionPoliciesRoute.CreateBody

name?string
target?string
retainForDays?number
minimumKept?number

Response 201 { data: CreateRetentionPolicyHttpResponse; meta }

idstring
accountIdstring
namestring
targetstring
retainForDaysnumber
minimumKeptnumber
createdAtstring
stable201
DELETE
/v1/accounts/{accountId}/retention-policies/{retentionPolicyId}

Response 200 { data: DeleteRetentionPolicyHttpResponse; meta }

deletedboolean
stable200
GET
/v1/accounts/{accountId}/retention-policies/{retentionPolicyId}

Response 200 { data: GetRetentionPolicyHttpResponse; meta }

idstring
accountIdstring
namestring
targetstring
retainForDaysnumber
minimumKeptnumber
createdAtstring
stable200

Sensitive field policies · 4 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/sensitive-field-policies

Query

limit?string
cursor?string

Response 200 { data: SensitiveFieldPolicyRecordHttpItem[]; page; meta }

idstring
accountIdstring
namestring
attributePathGlobsstring[]
actionstring
createdAtstring
stable200
POST
/v1/accounts/{accountId}/sensitive-field-policies

Request body kumo-core-server.SensitiveFieldPoliciesRoute.CreateBody

name?string
attributePathGlobs?string[]
action?string

Response 201 { data: CreateSensitiveFieldPolicyHttpResponse; meta }

idstring
accountIdstring
namestring
attributePathGlobsstring[]
actionstring
createdAtstring
stable201
DELETE
/v1/accounts/{accountId}/sensitive-field-policies/{sensitiveFieldPolicyId}

Response 200 { data: DeleteSensitiveFieldPolicyHttpResponse; meta }

deletedboolean
stable200
GET
/v1/accounts/{accountId}/sensitive-field-policies/{sensitiveFieldPolicyId}

Response 200 { data: GetSensitiveFieldPolicyHttpResponse; meta }

idstring
accountIdstring
namestring
attributePathGlobsstring[]
actionstring
createdAtstring
stable200

Annotations · 3 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/annotations

Query

surfaceKind?string
surfaceId?string

Response 200 { data: { items: Annotation[] }; meta }

itemsAnnotation[]
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/annotations

Request body kumo-core-server.AnnotationsRoute.CreateBody

surface?AnnotationSurface
body?{ kind: "note"; text: string; anchorNodeId: string | null } | { kind: "connection"; fromNodeId: string; toNodeId: string; label: string | null }

Response 201 { data: Annotation; meta }

idAnnotationId
accountIdAccountId
workspaceIdWorkspaceId
surfaceAnnotationSurface
bodyAnnotationBody
authorIdstring
createdAtstring
updatedAtstring
stable201
DELETE
/v1/accounts/{accountId}/workspaces/{workspaceId}/annotations/{annotationId}

Response 200 { data: { deleted: boolean }; meta }

deletedboolean
stable200

Api tokens · 3 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/api-tokens

Response 200 { data: { tokens: IamApiTokenRecord[] }; meta }

stable200
POST
/v1/accounts/{accountId}/api-tokens

Request body TokenCreateBody

displayName?string
scope?string
expiresAt?string

Response 201 { data: { token: IamApiTokenRecord; secret: string }; meta }

tokenIamApiTokenRecord
secretstring
stable201
DELETE
/v1/accounts/{accountId}/api-tokens/{apiKeyId}

Response 200 { data: { token: IamApiTokenRecord; transitioned: boolean }; meta }

tokenIamApiTokenRecord
transitionedboolean
stable200

Import · 3 routes

MethodPathTier2xx
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/import/apply

Request body ApplyBody

idempotencyKey?string
archive?string
conflictMode?string

Response 200 { data: { result: ApplyImportPlanResult }; meta }

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/import/inspect

Request body InspectBody

archive?string
conflictMode?string

Response 200 { data: { plan: KumoImportPlanV1 }; meta }

stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/import/jobs

Request body ApplyBody

idempotencyKey?string
archive?string
conflictMode?string

Response 202 { data: { jobId: string; statusPath: string }; meta }

jobIdstring
statusPathstring
stable202

Notification subscriptions · 3 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/notification-subscriptions

Query

workspace?string
unreadOnly?string
includeDismissed?string
limit?string
cursor?string

Response 200 { data: { subscriptions: NotificationSubscriptionDto[] }; meta }

stable200
POST
/v1/accounts/{accountId}/notification-subscriptions

Request body SubscriptionCreateBody

workspaceId?string
subscriber?UserNotificationRecipient | TeamNotificationRecipient | WorkspaceNotificationRecipient | ExternalNotificationRecipient
selector?NotificationSubjectSelector
kinds?NotificationKind[]
channels?NotificationChannel[]
minimumSeverity?"critical" | "error" | "info" | "success" | "warning"

Response 201 { data: NotificationSubscriptionDto; meta }

idstring
accountIdstring
workspaceIdstring | null
subscriberNotificationRecipient
selectorNotificationSubjectSelector
kindsstring[]
channelsstring[]
minimumSeveritystring
enabledboolean
createdAtstring
stable201
DELETE
/v1/accounts/{accountId}/notification-subscriptions/{subscriptionId}

Response 200 { data: { deleted: boolean }; meta }

deletedboolean
stable200

Provider scope bindings · 3 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/provider-scope-bindings

Query

limit?string
cursor?string

Response 200 { data: ListProviderScopeBindingsHttpResponseItem[]; page; meta }

idstring
workspaceIdstring
providerScopeIdstring
createdAtstring
stable200
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/provider-scope-bindings

Request body CreateBindingBody

providerScopeId?string

Response 201 { data: CreateProviderScopeBindingHttpResponse; meta }

idstring
workspaceIdstring
providerScopeIdstring
createdAtstring
stable201
DELETE
/v1/accounts/{accountId}/workspaces/{workspaceId}/provider-scope-bindings/{bindingId}

Response 204 no body

stable204

Role assignments · 3 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/role-assignments

Query

limit?string
cursor?string

Response 200 { data: IamRoleAssignmentRecord[]; page; meta }

idstring
principalKindstring
principalIdstring
roleIdstring
scopeKindstring
scopeLabelstring
statusstring
createdBystring
createdAtstring
expiresAtstring | null
revokedAtstring | null
stable200
POST
/v1/accounts/{accountId}/role-assignments

Request body AssignBody

roleId?string
principalId?string
principalKind?string
workspaceId?string
expiresAt?string

Response 201 { data: { assignment: IamRoleAssignmentRecord; created: boolean }; meta }

assignmentIamRoleAssignmentRecord
createdboolean
stable201
DELETE
/v1/accounts/{accountId}/role-assignments/{assignmentId}

Response 200 { data: { assignment: IamRoleAssignmentRecord; transitioned: boolean }; meta }

assignmentIamRoleAssignmentRecord
transitionedboolean
stable200

Alerts · 2 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/alerts

Query

limit?string
cursor?string
workspace?string

Response 200 { data: AlertDto[]; page; meta }

ruleIdstring
ruleNamestring
accountIdstring
workspaceIdstring | null
sourcestring
severitySeverity
subjectLabelstring
kindstring
categorystring | null
dedupKeystring
firedAtstring | null
statusstring
acknowledgedAtstring | null
acknowledgedBystring | null
stable200
POST
/v1/accounts/{accountId}/alerts/acknowledge

Request body AlertAcknowledgeBody

dedupKey?string
status?"acknowledged" | "active"

Response 200 { data: AlertDto; meta }

ruleIdstring
ruleNamestring
accountIdstring
workspaceIdstring | null
sourcestring
severitySeverity
subjectLabelstring
kindstring
categorystring | null
dedupKeystring
firedAtstring | null
statusstring
acknowledgedAtstring | null
acknowledgedBystring | null
stable200

Auth policy · 2 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/auth-policy

Response 200 { data: AuthAccountPolicyGetResult; meta }

requireMfaboolean
requireSsoboolean
ssoEnforcedboolean
stable200
PUT
/v1/accounts/{accountId}/auth-policy

Request body PolicyBody

requireMfa?any
requireSso?any

Response 200 { data: AuthAccountPolicyGetResult; meta }

requireMfaboolean
requireSsoboolean
ssoEnforcedboolean
stable200

Events · 2 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/events/stream

Query

afterSeq?string

Response 200 text/event-stream (file or stream)

stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/events/stream

Query

afterSeq?string

Response 200 text/event-stream (file or stream)

stable200

Graph revisions · 2 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/graph-revisions

Query

limit?string
cursor?string

Response 200 { data: ListWorkspaceGraphRevisionsHttpResponseItem[]; page; meta }

idstring
workspaceIdstring
sequencenumber
producedBySnapshotIdstring
snapshotVectorstring[]
graphStateHashstring
createdAtstring
qualityRevisionQualityHttpDto | null
stable200
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/graph-revisions/{wgrId}

Response 200 { data: GetWorkspaceGraphRevisionHttpResponse; meta }

idstring
workspaceIdstring
sequencenumber
graphStateHashstring
producedBySnapshotIdstring
snapshotVectorstring[]
resourceRevisionCountnumber
connectionRevisionCountnumber
createdAtstring
stable200

Notification preferences · 2 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/notification-preferences

Query

workspace?string
unreadOnly?string
includeDismissed?string
limit?string
cursor?string

Response 200 { data: { preferences: NotificationPreferenceDto[] }; meta }

stable200
PUT
/v1/accounts/{accountId}/notification-preferences

Request body PreferencesUpdateBody

Response 200 { data: { preferences: NotificationPreferenceDto[] }; meta }

stable200

Ops · 2 routes

MethodPathTier2xx
GET
/v1/ops/pipeline-runs

Query

limit?string
cursor?string

Response 200 { data: PipelineRunHttpSummaryItem[]; page; meta }

idstring
accountIdstring | null
labelstring
createdAtstring
statusstring
modestring
filesnumber
succeedednumber
failednumber
durationMsnumber
hasReportboolean
internal200
GET
/v1/ops/pipeline-runs/{pipelineRunId}

Response 200 { data: GetPipelineRunHttpResponse; meta }

idstring
accountIdstring | null
labelstring
createdAtstring
statusstring
modestring
filesnumber
succeedednumber
failednumber
durationMsnumber
metricsmap<string, any>
reportmap<string, any> | null
internal200

Shared views · 2 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/shared-views

Response 200 { data: ViewAccessGrantsReceivedListResult; meta }

stable200
GET
/v1/accounts/{accountId}/shared-views/{grantId}/render

Query

format?string

Response 200 */* (file or stream)

stable200

Template overrides · 2 routes

MethodPathTier2xx
DELETE
/v1/accounts/{accountId}/template-overrides/{templateKey}

Response 200 { data: ClearAccountTemplateOverrideHttpResponse; meta }

templateKeystring
stable200
POST
/v1/accounts/{accountId}/template-overrides/{templateKey}

Request body

template?any

Response 200 { data: SetAccountTemplateOverrideHttpResponse; meta }

templateKeystring
updatedAtstring
stable200

Access · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/access

Query

workspaceActions?string
accountActions?string

Response 200 { data: WorkspaceAccessDto; meta }

workspaceIdstring
workspaceActionsmap<string, boolean>
accountActionsmap<string, boolean>
stable200

Audit log · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/audit-log

Query

workspaceId?string
eventType?string
outcome?string
severity?string
since?string
until?string
limit?string
cursor?string

Response 200 { data: TenantAuditRecordDto[]; page; meta }

idstring
eventTypestring
outcomestring
severitystring
occurredAtstring
recordedAtstring
actor{ kind: string; principalId: string | null; userId: string | null; displayName: string | null; authMethod: string | null; impersonated: boolean }
scopeKindstring
workspaceIdstring | null
target{ type: string; id: string | null; displayName: string | null } | null
reasonstring | null
sourcePackagestring
stable200

Compactions · 1 routes

MethodPathTier2xx
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/compactions

Request body CompactionBody

cutoff?string
minimumKept?number
apply?boolean

Response 200 { data: CompactRevisionsHttpResponse; meta }

workspaceIdstring
cutoffstring
minimumKeptnumber
appliedboolean
candidatesCompactRevisionsCandidateHttpItem[]
compactedResourceRevisionCountnumber
compactedConnectionRevisionCountnumber
stable200

Connections · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/connections/{connectionId}

Query

at?string
asOf?string
asOf.workspaceGraphRevisionId?string

Response 200 { data: GetConnectionAtRevisionHttpResponse; meta?: map<string, any> } | { data: GetConnectionAtTimestampHttpResponse; meta?: map<string, any> }

stable200

Credential health · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/credential-health/reports/{reportId}

Response 200 { data: null; meta?: map<string, any> } | { data: CredentialHealthReportDto; meta?: map<string, any> }

stable200

Embed · 1 routes

MethodPathTier2xx
GET
/embed/{token}

Query

format?string

Response 200 text/html; charset=utf-8 (file or stream)

stable200

Environment query · 1 routes

MethodPathTier2xx
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/environment-query/preview

Request body EnvironmentQueryPreviewBody

dslBody?any
workspaceGraphRevisionId?string

Response 200 { data: EnvironmentQueryPreviewHttpResponse; meta }

targetResourceCountnumber
targetConnectionCountnumber
stable200

Features · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/features

Response 200 { data: TenantFeaturesResponseDto; meta }

featuresTenantFeatureAvailabilityDto[]
evaluatedAtstring
cacheKeystring
stable200

Healthz · 1 routes

MethodPathTier2xx
GET
/v1/healthz

Response 200

statusstring
stable200

Invites · 1 routes

MethodPathTier2xx
POST
/v1/accounts/{accountId}/invites

Request body InviteBody

email?string
roleId?string

Response 201 { data: AuthInviteCreateResult; meta }

inviteTokenstring
expiresAtstring
mailSentboolean
stable201

Lineage · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/lineage/{subjectKind}/{subjectId}

Response 200 { data: GraphDiffLineageChainDto; meta }

subject{ kind: string; id: string }
hopsGraphDiffLineageHopDto[]
stable200

Members · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/members

Query

limit?string
cursor?string

Response 200 { data: AccountMemberSummary[]; page; meta }

userIdstring
displayNamestring
emailstring | null
membershipKindstring
statusstring
invitedAtstring | null
acceptedAtstring | null
createdAtstring | null
stable200

Notification test · 1 routes

MethodPathTier2xx
POST
/v1/accounts/{accountId}/notification-test

Request body TestSendBody

channel?"cli" | "desktop" | "email" | "in_app" | "mobile_push" | "slack" | "webhook"
address?string

Response 200 { data: { status?: "delivered" | "permanent_failure" | "retryable_failure"; sent: boolean }; meta }

status?"delivered" | "permanent_failure" | "retryable_failure"
sentboolean
stable200

Partner branding · 1 routes

MethodPathTier2xx
GET
/v1/partner-branding

Query

host?string

Response 200 { data: PartnerBrandingResolveResult; meta }

partner{ partnerId: string; branding: PartnerBranding } | null
experimental200

Permission catalog · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/permission-catalog

Response 200 { data: { permissions: IamPermissionRecord[] }; meta }

permissionsIamPermissionRecord[]
stable200

Providers · 1 routes

MethodPathTier2xx
GET
/v1/providers/aws/ambient-identity

Response 200 { data: { identity: any }; meta }

identityany
stable200

Readyz · 1 routes

MethodPathTier2xx
GET
/v1/readyz

Response 200

statusstring
stable200

Resource attribute values · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/resource-attribute-values

Query

attribute?string
asOf?string
asOf.workspaceGraphRevisionId?string
filter.semanticType?string
limit?string

Response 200 { data: ResourceAttributeValuesListHttpResponse; meta }

stable200

Retention applications · 1 routes

MethodPathTier2xx
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/retention-applications

Request body RetentionApplicationBody

policies?RetentionPolicyHttpInput[]
retentionPolicyIds?string[]
apply?boolean

Response 200 { data: ApplyRetentionPoliciesHttpResponse; meta }

stable200

Share · 1 routes

MethodPathTier2xx
GET
/share/{token}

Query

format?string

Response 200 */* (file or stream)

stable200

Source model · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/workspaces/{workspaceId}/source-model

Query

asOf?string
asOf.workspaceGraphRevisionId?string
hierarchy?string

Response 200 { data: WorkspaceSourceModelBuildHttpResponse; meta }

workspaceIdstring
workspaceGraphRevisionIdstring
resourceCountnumber
connectionCountnumber
sourceModelSourceModel
stable200

Unarchive · 1 routes

MethodPathTier2xx
POST
/v1/accounts/{accountId}/workspaces/{workspaceId}/unarchive

Response 200 { data: WorkspaceUnarchiveResult; meta }

workspaceWorkspaceProjection
archivedSourceIdsSourceId[]
stable200

Version · 1 routes

MethodPathTier2xx
GET
/v1/version

Response 200

releaseStage?string
versionstring
stable200

Views · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/views

Query

limit?string
cursor?string

Response 200 { data: ViewByAccountItemDto[]; page; meta }

idstring
namestring
originstring
environmentIdstring
environmentNamestring
workspaceIdstring
workspaceNamestring
createdAtstring
providersstring[]
stable200

Webhook event types · 1 routes

MethodPathTier2xx
GET
/v1/accounts/{accountId}/webhook-event-types

Response 200 { data: WebhookEventTypeListResult; meta }

eventTypesstring[]
stable200

Schemas · 740 types

AccountCostSubject
kind"account"
providerstring | null
providerAccountIdstring
AccountId

string

AccountMemberSummary
userIdstring
displayNamestring
emailstring | null
membershipKindstring
statusstring
invitedAtstring | null
acceptedAtstring | null
createdAtstring | null
AcsBody
SAMLResponse?string
RelayState?string
AdapterDiagnosticSeverity

"error" | "fatal" | "info" | "warning"

AdjacencyEntry
AdjacentNeighbor
connectionIdConnectionId
otherResourceIdResourceId
connectionTypestring
AlertAcknowledgeBody
dedupKey?string
status?"acknowledged" | "active"
AlertDto
ruleIdstring
ruleNamestring
accountIdstring
workspaceIdstring | null
sourcestring
severitySeverity
subjectLabelstring
kindstring
categorystring | null
dedupKeystring
firedAtstring | null
statusstring
acknowledgedAtstring | null
acknowledgedBystring | null
AlertNotificationSubject
kind"alert"
workspaceId?WorkspaceId
alertIdstring
displayNamestring
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
ruleIdstring
accountIdstring
workspaceIdstring | null
namestring
enabledboolean
conditionAlertRuleConditionDto
severity?"critical" | "high" | "info" | "low" | "medium"
AlertSignalSource

"cost_anomaly" | "credential_health" | "graph_diff"

AlertTargetDto
targetIdstring
accountIdstring
workspaceIdstring | null
namestring
enabledboolean
channelstring
destinationRedactedstring
minSeverity?"critical" | "high" | "info" | "low" | "medium"
AlertTargetTestResult
deliveredboolean
error?string
AllocationRunBody
window?{ startInclusive?: string; endExclusive?: string }
currency?string
includeEstimates?boolean
AllocationStatus

"allocated" | "direct" | "shared" | "unallocated" | "unknown"

Annotation
idAnnotationId
accountIdAccountId
workspaceIdWorkspaceId
surfaceAnnotationSurface
bodyAnnotationBody
authorIdstring
createdAtstring
updatedAtstring
AnnotationBody

object | object

AnnotationId

string

AnnotationSurface
kind"environment" | "view"
idstring
ApiTokenScope

"read" | "read_write"

ApplyActionOutcome
actionIdstring
status"created" | "failed" | "rejected" | "skipped" | "updated"
error?string
ApplyBody
idempotencyKey?string
archive?string
conflictMode?string
ApplyImportPlanResult
okboolean
creatednumber
updatednumber
skippednumber
rejectednumber
failednumber
outcomesApplyActionOutcome[]
rejectedReason?string
commitError?string
ApplyRetentionPoliciesHttpResponse
AssignBody
roleId?string
principalId?string
principalKind?string
workspaceId?string
expiresAt?string
AuthAccountPolicyGetResult
requireMfaboolean
requireSsoboolean
ssoEnforcedboolean
AuthEmailVerifyResendResult
acceptedtrue
AuthEmailVerifyResult
verifiedtrue
AuthInviteCreateResult
inviteTokenstring
expiresAtstring
mailSentboolean
AuthMfaDisableResult
disabledtrue
AuthMfaEnrollStartResult
secretBase32string
otpauthUristring
AuthOidcConfigView
accountIdAccountId
issuerstring
clientIdstring
hasClientSecretboolean
scopesstring[]
emailClaimstring
status"active" | "disabled"
updatedAtstring (date-time)
AuthPasswordChangeResult
changedtrue
otherSessionsRevokednumber
AuthPasswordResetConfirmResult
resettrue
AuthPasswordResetRequestResult
acceptedtrue
AuthRecoveryCodesRegenerateResult
recoveryCodesstring[]
AuthSessionGrantWire

object | object

AuthSessionRevokeResult
revokedboolean
AuthSessionSummaryWire
idstring
currentboolean
createdAtstring
lastSeenAtstring
expiresAtstring
methodsstring[]
AwsPendingExternalIdEnsureResult
externalIdstring
origin"existing" | "minted"
BillingEntitlementKind

"boolean" | "duration_days" | "enum" | "json_policy" | "metered_budget" | "quantity" | "rate_limit" | "storage_bytes"

BillingEntitlementRecord
featureKeystring
kindBillingEntitlementKind
scopeBillingEntitlementScope
valueboolean | string | number | map<string, any>
softLimitnumber | null
hardLimitnumber | null
resetPeriodBillingEntitlementResetPeriod
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
workspaceIdstring
sourceIdstring
status"discovered" | "unavailable" | "unknown" | "unsupported"
exportsDiscoveredBillingExportDto[]
notesstring[]
observedAtstring | null
staleboolean
adopted{ name: string; bucket: string; adoptedAt: string } | null
generatedAtstring
BillingExportsIngestQueuedDto
workspaceIdstring
jobIdstring
queuedAtstring
alreadyQueuedboolean
BillingExportsListDto
workspaceIdstring
itemsBillingExportsDto[]
generatedAtstring
BillingQuotaDecisionKind

"allow" | "allow_with_warning" | "billing_unavailable" | "deny" | "unknown_feature" | "unknown_subject"

BillingQuotaDecisionRecord
kindBillingQuotaDecisionKind
featureKeystring
subjectBillingQuotaSubjectRecord
requestedQuantitynumber
currentUsagenumber | null
softLimitnumber | null
hardLimitnumber | null
resetAtstring | null
reasonstring
reasonCodestring | null
evaluatedAtstring
BillingQuotaSubjectRecord
accountIdAccountId
workspaceIdWorkspaceId | null
scopeBillingEntitlementScope
BillingSubscriptionRecord
idstring
accountIdAccountId
billingCustomerIdstring
planIdstring
planNamestring | null
planKeystring | null
planVersionIdstring
providerstring
statusBillingSubscriptionStatus
currentPeriodStartstring | null
currentPeriodEndstring | null
cancelAtPeriodEndboolean
trialEndsAtstring | null
createdAtstring
updatedAtstring
endedAtstring | null
BillingSubscriptionStatus

"active" | "cancelled" | "expired" | "incomplete" | "past_due" | "paused" | "suspended" | "trialing"

BlastRadiusResultRef
blastRadiusResultIdstring
CancelBody
reason?string
CancelOperationHttpResponse
idstring
type"operation"
operationTypestring
statusstring
target{ type: string; id: string }
resultmap<string, any> | null
createdAtstring
startedAtstring | null
completedAtstring | null
ChangeAtom
idChangeAtomId
subjectChangeSubject
kindChangeAtomKind
fieldPathstring | null
beforeRedactedChangeValue
afterRedactedChangeValue
rawDiffRefRawDiffRef
evidenceRefsChangeEvidenceRef[]
detectedAtstring
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
kindChangeCauseKind
summarystring
confidenceChangeConfidence
evidenceRefsChangeEvidenceRef[]
hypothesesChangeCauseHypothesis[]
ChangeCauseHypothesis
kindChangeCauseKind
summarystring
confidencenumber
evidenceRefsChangeEvidenceRef[]
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
ChangeConfidenceLevel

"high" | "low" | "medium"

ChangeConfidenceReason
messagestring
contributionnumber
evidenceRefsChangeEvidenceRef[]
ChangeCorrelationSearchResult
window{ since: string | null; until: string | null }
itemsChangeItem[]
ChangeDiagnostic
codestring
messagestring
severity"error" | "info" | "warning"
ChangeDigest
modeChangeDigestMode
workspaceIdWorkspaceId
window{ since: string | null; until: string | null }
titlestring
headlinestring
totalChangesnumber
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 }
highlightsChangeDigestHighlight[]
generatedAtstring
ChangeDigestBuildResult
ChangeDigestHighlight
changeIdChangeItemId
severitySeverity
categoryChangeCategory
titlestring
subjectKeystring
ChangeDigestMode

"cost" | "daily_workspace" | "deployment" | "incident" | "security" | "source_sync" | "weekly_account"

ChangeEventBody
eventSourcestring
eventNamestring
payload?map<string, any>
ChangeEventsIngestResult
matchedEventsnumber
unmatchedEventsnumber
subjectIdsnumber
scopeRequestsnumber
enqueuedboolean
ChangeEvidence
idChangeEvidenceId
kindChangeEvidenceKind
sourceId?SourceId
sourceSnapshotId?SourceSnapshotId
sourceSyncRunId?string
crawlResultId?CrawlResultId
workspaceGraphRevisionId?WorkspaceGraphRevisionId
resourceRevisionId?ResourceRevisionId
connectionRevisionId?ConnectionRevisionId
provider?string
providerScopeId?ProviderScopeId
observedAtstring | null
summarystring
confidencenumber
redactionChangeEvidenceRedaction
metadatamap<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
redactedboolean
reasonstring | null
ChangeEvidenceRef
ChangeExplainResult
foundboolean
changeChangeItem | null
explanationstring[]
rawDiffRefsRawDiffRef[]
ChangeImpact
scorenumber
levelSeverity
dimensionsChangeImpactDimensions
affectedImpactedTarget[]
blastRadiusRef?BlastRadiusResultRef
explanationChangeImpactReason[]
ChangeImpactDimensions
topologynumber
securitynumber
reliabilitynumber
costnumber
compliancenumber
ownershipnumber
userFacingnumber
operationalnumber
ChangeImpactReason
messagestring
evidenceRefsChangeEvidenceRef[]
ChangeIntelligenceAnalyzeResult
workspaceIdWorkspaceId
windowChangeWindow
summaryChangeSummary
changesChangeItem[]
storiesChangeStory[]
suppressedSuppressedChange[]
diagnosticsChangeDiagnostic[]
truncated{ analysed: number; shown: number } | null
generatedAtstring
analysisVersionstring
inputHashstring
ChangeIntelligenceMaterializeResult
resultChangeIntelligenceAnalyzeResult
fromCacheboolean
ChangeItem
idChangeItemId
fingerprintstring
workspaceIdWorkspaceId
subjectChangeSubject
titlestring
summarystring
kindstring
categoryChangeCategory
atomsChangeAtom[]
evidenceChangeEvidence[]
sourceAttributionChangeSourceAttribution
causeChangeCause
impactChangeImpact
severityChangeSeverity
confidenceChangeConfidence
firstObservedAtstring
lastObservedAtstring
tagsstring[]
warningsChangeWarning[]
ChangeItemId

string

ChangeLens

"all" | "cost" | "drift" | "exposure" | "operations" | "ownership" | "reliability" | "security" | "topology" | "views"

ChangeNarrativeStep
textstring
changeItemIds?ChangeItemId[]
evidenceRefs?ChangeEvidenceRef[]
ChangeRecommendation
titlestring
detailstring | null
priority"high" | "low" | "medium"
relatedChangeIds?ChangeItemId[]
ChangeSeverity
levelSeverity
scorenumber
reasonsChangeSeverityReason[]
ChangeSeverityReason
codeChangeSeverityReasonCode
messagestring
contributionnumber
evidenceRefsChangeEvidenceRef[]
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
attributionClassstring
sourceId?SourceId
sourceSyncRunId?string
providerScopeId?ProviderScopeId
provider?string
multiSourceCorroboratedboolean
observedAtstring | null
ChangeStory
idChangeStoryId
workspaceIdWorkspaceId
windowChangeWindow
titlestring
summarystring
narrativeChangeNarrativeStep[]
primaryChangeIdsChangeItemId[]
relatedChangeIdsChangeItemId[]
severityChangeSeverity
confidenceChangeConfidence
impactChangeImpact
evidenceRefsChangeEvidenceRef[]
recommendedNextActionsChangeRecommendation[]
generatedAtstring
ChangeStoryId

string

ChangeSubject

ResourceChangeSubject | ConnectionChangeSubject | WorkspaceChangeSubject | SourceChangeSubject | EnvironmentChangeSubject | ViewChangeSubject | PolicyChangeSubject

ChangeSummary
totalChangesnumber
totalSuppressednumber
addedResourcesnumber
removedResourcesnumber
changedResourcesnumber
addedConnectionsnumber
removedConnectionsnumber
changedConnectionsnumber
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 }
headlinestring
bulletsstring[]
highestSeverity"critical" | "high" | "info" | "low" | "medium" | null
highestImpactScorenumber
ChangeWarning
codeChangeWarningCode
messagestring
severity"info" | "warning"
ChangeWarningCode

"LOW_CONFIDENCE" | "NON_AUTHORITATIVE_SOURCE" | "PARTIAL_COVERAGE" | "PROVIDER_DIAGNOSTIC" | "REDACTED_EVIDENCE" | "SUPPRESSED_NOISE"

ChangeWindow
workspaceIdWorkspaceId
fromWorkspaceGraphRevisionIdWorkspaceGraphRevisionId
toWorkspaceGraphRevisionIdWorkspaceGraphRevisionId
fromTimestampstring | null
toTimestampstring | null
label?string
ChargeType

"credit" | "discount" | "marketplace" | "other" | "refund" | "reservation_fee" | "savings_plan_fee" | "support" | "tax" | "usage"

ClearAccountTemplateOverrideHttpResponse
templateKeystring
ClearViewTemplateOverrideHttpResponse
viewIdstring
CompactRevisionsCandidateHttpItem
kindstring
entityIdstring
revisionIdstring
validFromstring
validTostring | null
CompactRevisionsHttpResponse
workspaceIdstring
cutoffstring
minimumKeptnumber
appliedboolean
candidatesCompactRevisionsCandidateHttpItem[]
compactedResourceRevisionCountnumber
compactedConnectionRevisionCountnumber
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
idstring
kind"edge"
typestring
directed?boolean
sourceEndpoint
targetEndpoint
labels?string[]
data?map<string, any>
view?map<string, any>
meta?map<string, any>
ConnectionChangeSubject
kind"connection"
connectionIdConnectionId
connectionTypestring
sourceResourceId?ResourceId
targetResourceId?ResourceId
sourceDisplayName?string | null
targetDisplayName?string | null
ConnectionCostSubject
kind"connection"
connectionIdConnectionId
connectionTypestring | null
ConnectionDto
idstring
connectionTypestring
fromResourceIdstring
toResourceIdstring
ConnectionId

string

ConnectionObservationId

string

ConnectionRevisionId

string

ContextEdgeId

ConnectionId | ScopeMembershipEdgeId

ContextFrontierEntry
fromSemanticTypestring
toSemanticTypestring
connectionTypestring
direction"in" | "out"
resourceCountnumber
ContextFrontierResolveBody
contextQuery?any
parameters?map<string, any>
environmentRevisionId?string
limit?number
ContextFrontierResolveResult
entriesContextFrontierEntry[]
memberCountnumber
truncatedboolean
diagnosticsstring[]
ContextNodeId

ResourceId | ScopeNodeId

ContextNotificationSubject
kind"context"
workspaceIdWorkspaceId
contextIdstring
displayNamestring
ContextQueryEvaluateBody
contextQuery?any
parameters?map<string, any>
environmentRevisionId?string
ContextQueryEvaluateConnectionRow
idContextEdgeId
connectionTypestring
fromResourceIdContextNodeId
toResourceIdContextNodeId
virtual?true
ContextQueryEvaluateResourceRow
idContextNodeId
roleContextResourceRole
semanticTypestring
displayNamestring
parentId?ResourceId | ScopeNodeId
container?boolean
virtual?true
ContextQueryEvaluateResult
environmentIdEnvironmentId
environmentRevisionIdEnvironmentRevisionId
workspaceIdWorkspaceId
workspaceGraphRevisionIdWorkspaceGraphRevisionId
targetCountnumber
resourceCountnumber
connectionCountnumber
roleCountsmap<string, number>
resourcesContextQueryEvaluateResourceRow[]
connectionsContextQueryEvaluateConnectionRow[]
traceQueryExplainStep[]
diagnosticsstring[]
contextResultHashstring
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
environmentIdEnvironmentId
environmentRevisionIdEnvironmentRevisionId
workspaceIdWorkspaceId
workspaceGraphRevisionIdWorkspaceGraphRevisionId
resourceCountnumber
connectionCountnumber
sourceModelSourceModel
contextResultHashstring
diagnosticsstring[]
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
idCostAllocationRuleId
workspaceIdWorkspaceId
versionnumber
namestring
description?string
selectorCostSubjectSelector
allocateToCostAllocationTarget
methodCostAllocationMethod
splitTargets?CostAllocationTarget[]
prioritynumber
effectiveFromstring
effectiveTostring | null
createdBykumo-cost-analysis.ActorRef
createdAtstring
CostAllocationRuleId

string

CostAllocationRulesListResult
CostAllocationRun
idCostAllocationRunId
workspaceIdWorkspaceId
windowCostWindow
ruleVersionsApplied{ ruleId: CostAllocationRuleId; version: number; matchedLineCount: number }[]
allocatedTotalMoney
unallocatedTotalMoney
diagnosticsCostDiagnostic[]
executedAtstring
executedBykumo-cost-analysis.ActorRef
CostAllocationRunId

string

CostAllocationRunResult
CostAllocationTarget

object | object | object | object | object

CostAssumption
keystring
descriptionstring
valuestring
CostBasis

"actual_amortized" | "actual_blended" | "actual_net_unblended" | "actual_public_on_demand" | "actual_unblended" | "allocated" | "estimated_rate_card" | "estimated_usage_based" | "forecast"

CostChangeAnalyzeResult
workspaceIdWorkspaceId
windowCostWindow
comparisonWindowCostWindow
currencystring
totalBeforeMoneyOrRedacted
totalAfterMoneyOrRedacted
deltasCostChangeDelta[]
anomalousCountnumber
diagnosticsCostDiagnostic[]
generatedAtstring
CostChangeClassification

"anomalous" | "expected" | "unknown"

CostChangeDelta
CostChangeDriver
kindCostChangeDriverKind
summarystring
CostChangeDriverKind

"allocation" | "discount" | "price" | "topology" | "unknown" | "usage"

CostConfidence
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
workspaceIdWorkspaceId
windowCostWindow
resourceCountnumber
resourcesWithActualsnumber
resourcesWithEstimatesnumber
unpricedResourceCountnumber
actualCoverageRationumber
providersWithActualsstring[]
evidenceCostEvidence[]
CostDiagnostic
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
idCostEvidenceId
kindCostEvidenceKind
sourceId?SourceId
provider?string
providerAccountId?string
providerScopeId?ProviderScopeId
priceCatalogItemId?PriceCatalogItemId
costIngestionRunId?CostIngestionRunId
resourceId?ResourceId
resourceRevisionId?ResourceRevisionId
workspaceGraphRevisionId?WorkspaceGraphRevisionId
summarystring
observedAtstring | null
confidencenumber
redactionCostEvidenceRedaction
metadatamap<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
idCostForecastId
workspaceIdWorkspaceId
subjectCostSubject
generatedAtstring
trainingWindowCostWindow
forecastWindowCostWindow
methodForecastMethod
pointsForecastPoint[]
totalMoney
confidenceCostConfidence
assumptionsCostAssumption[]
CostForecastGenerateResult
forecastCostForecast
diagnosticsCostDiagnostic[]
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
scopestring
displayNamestring
CostOverlay
workspaceIdWorkspaceId
windowCostWindow
currencystring
nodesobject
legendCostOverlayLegendItem[]
cacheKeystring
generatedAtstring
diagnosticsCostDiagnostic[]
CostOverlayBadgeKind

"cost" | "cost_delta" | "recommendation" | "top_cost" | "unallocated" | "waste"

CostOverlayLegendItem
kindCostOverlayBadgeKind
labelstring
countnumber
CostOwner
ownerKeystring
kind"cost_center" | "service" | "team" | "unknown" | "user"
displayNamestring | null
CostProvenance
sourceKind"allocation" | "billing_export" | "cost_api" | "estimate" | "manual" | "synthetic" | "unknown"
sourceRefstring | null
ingestionRunIdCostIngestionRunId | null
importedAtstring | null
correctionOfResourceCostFactId | null
CostRecommendation
idCostRecommendationId
workspaceIdWorkspaceId
subjectCostSubject
kindCostRecommendationKind
titlestring
summarystring
estimatedMonthlySavingsMoney | null
implementationRisk"high" | "low" | "medium" | "unknown"
reversibility"easy" | "hard" | "moderate" | "unknown"
confidenceCostConfidence
evidenceCostEvidence[]
assumptionsCostAssumption[]
actionsCostRecommendationAction[]
statusCostRecommendationStatus
createdAtstring
CostRecommendationAction
kind"cli_hint" | "manual_step" | "review"
descriptionstring
requiresHumanValidationboolean
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
idCostReportId
workspaceIdWorkspaceId
kindCostReportKind
titlestring
windowCostWindow
summaryCostSummary
sectionsCostReportSection[]
basisCostBasis
currencystring
generatedAtstring
generatedBykumo-cost-analysis.ActorRef
evidenceCostEvidence[]
diagnosticsCostDiagnostic[]
fingerprintstring
CostReportChartSeries
labelstring
points{ x: string; y: string }[]
CostReportChartSpec
kind"bar" | "line" | "pie" | "sparkline"
titlestring
seriesCostReportChartSeries[]
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
CostReportSection
idstring
titlestring
summarystring
rowsCostReportRow[]
chartsCostReportChartSpec[]
evidenceCostEvidence[]
diagnosticsCostDiagnostic[]
CostRollup
groupByCostGroupBy
tagKeystring | null
windowCostWindow
currencystring
rowsCostRollupRow[]
totalMoney
CostRollupRow
keystring
displayNamestring | null
subjectResourceCostSubject | ConnectionCostSubject | WorkspaceCostSubject | EnvironmentCostSubject | ProviderScopeCostSubject | SourceCostSubject | OwnerCostSubject | TeamCostSubject | ServiceCostSubject | TagCostSubject | AccountCostSubject | null
actualMoney | null
estimatedMoney | null
allocatedMoney | null
totalMoney
sharePctnumber
factCountnumber
estimateCountnumber
CostRollupsDto
workspaceIdstring
windowCostWindow
currencystring
rollupsCostRollup[]
diagnosticsCostDiagnostic[]
status"analysed" | "not_analysed"
analyzedAtstring | null
generatedAtstring
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
actualCostMoney | RedactedMoney | null
estimatedCostMoney | RedactedMoney | null
totalCostMoneyOrRedacted
unallocatedCostMoney | RedactedMoney | null
estimatedMonthlyWasteMoney | RedactedMoney | null
resourceCountnumber
resourcesWithActualsnumber
resourcesWithEstimatesnumber
unpricedResourceCountnumber
confidenceCostConfidence
CostSummaryDto
workspaceIdstring
windowCostWindow
currencystring
summaryCostSummary | null
coverageCostCoverageResult | null
diagnosticsCostDiagnostic[]
status"analysed" | "not_analysed"
analyzedAtstring | null
generatedAtstring
CostWindow
startInclusivestring
endExclusivestring
granularityCostWindowGranularity
CostWindowGranularity

"custom" | "day" | "hour" | "month" | "quarter" | "year"

CoverageAuthoritySliceDto
providerKeyCredentialHealthProviderKey
serviceKeystring
resourceTypestring
location?string
scope?string
statusCoverageAuthorityStatus
deletionAuthorityboolean
diffAuthorityboolean
alertAuthorityboolean
diagnosticCodesstring[]
CoverageAuthorityStatus

"authoritative" | "non-authoritative" | "not-requested" | "unknown"

CrawlResultId

string

CreateBindingBody
providerScopeId?string
CreateEnvironmentBody
name?string
CreateEnvironmentDefinitionBody
dslBody?any
activate?boolean
CreateEnvironmentDefinitionHttpResponse
idstring
environmentIdstring
versionnumber
dslBodyany
createdAtstring
activatedboolean
CreateEnvironmentHttpResponse
idstring
workspaceIdstring
namestring
originstring
activeDefinitionIdstring | null
createdAtstring
CreateGrantBody
grantee?{ kind?: string; userId?: string; roleId?: string }
CreateProviderScopeBindingHttpResponse
idstring
workspaceIdstring
providerScopeIdstring
createdAtstring
CreateProviderScopeBody
provider?string
providerKey?string
canonicalScopeKey?string
displayName?string
name?string
CreateProviderScopeHttpResponse
idstring
accountIdstring
providerKeystring
canonicalScopeKeystring
displayNamestring
createdAtstring
CreateRetentionPolicyHttpResponse
idstring
accountIdstring
namestring
targetstring
retainForDaysnumber
minimumKeptnumber
createdAtstring
CreateRoleBody
key?string
displayName?string
description?string
permissions?string[]
status?"active" | "draft"
CreateSensitiveFieldPolicyHttpResponse
idstring
accountIdstring
namestring
attributePathGlobsstring[]
actionstring
createdAtstring
CreateShareBody
viewRevisionId?string
expiresAt?string
CreateSourceCredentialHttpResponse
idstring
accountIdstring
displayNamestring
credentialKindstring
secretRefstring
createdAtstring
CreateSourceHttpResponse
idstring
accountIdstring
workspaceIdstring
providerKeystring
displayNamestring
credentialReferenceIdstring
createdAtstring
providerScopeIdstring | 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
idstring
viewIdstring
viewTemplateVersionIdstring
parametersmap<string, any>
configurationHashstring
createdAtstring
createdboolean
CreateViewHttpResponse
idstring
environmentIdstring
namestring
originstring
createdAtstring
createdboolean
CreateWebhookSubscriptionRequestBody
urlstring
description?string
eventTypesstring[]
CreateWorkspaceBody
name?string
displayName?string
CreateWorkspaceHttpResponse
idstring
accountIdstring
namestring
createdAtstring
created?boolean
CredentialHealthDecisionDto
kindCredentialHealthDecisionKind
reasonstring
safeToSyncboolean
safeToDeleteMissingResourcesboolean
requiresUserActionboolean
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
idstring
severityCredentialHealthSeverity
categoryCredentialHealthFindingCategory
codestring
titlestring
detailstring
providerKeyCredentialHealthProviderKey
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
CredentialHealthSeverity

"error" | "fatal" | "info" | "warning"

CredentialHealthStatus

"blocked" | "degraded" | "healthy" | "stale" | "unknown"

CredentialHealthSummaryDto
probeCountnumber
passedProbeCountnumber
failedProbeCountnumber
warningProbeCountnumber
timeoutProbeCountnumber
authoritativeSliceCountnumber
nonAuthoritativeSliceCountnumber
unknownSliceCountnumber
errorFindingCountnumber
warningFindingCountnumber
CredentialNotificationSubject
kind"credential"
workspaceId?WorkspaceId
credentialRefstring
sourceId?SourceId
displayNamestring
CredentialSubjectDto
providerKeyCredentialHealthProviderKey
displayNamestring
providerAccountId?string
providerTenantId?string
providerSubscriptionIds?string[]
providerProjectIds?string[]
providerPrincipalId?string
providerPrincipalArn?string
providerPrincipalEmail?string
clusterIdentity?string
DeleteRetentionPolicyHttpResponse
deletedboolean
DeleteSensitiveFieldPolicyHttpResponse
deletedboolean
DeleteSourceCredentialHttpResponse
credentialIdstring
deletedtrue
DemoWorkspaceProvisionHttpResponse
workspaceIdstring
sourceIdstring
workspaceGraphRevisionIdstring | null
resourceCountnumber
connectionCountnumber
reusedExistingWorkspaceboolean
DeviceLoginError
errorstring
error_description?string
DeviceLoginStartResponse
device_codestring
user_codestring
verification_uristring
verification_uri_completestring
expires_innumber
intervalnumber
DeviceLoginTokenBody
device_code?string
DeviceLoginTokenResponse
access_tokenstring
token_type"Bearer"
scope"read_write"
token_idstring
key_prefixstring
display_namestring
expires_atstring | null
DigestBody
mode?"cost" | "daily_workspace" | "deployment" | "incident" | "security" | "source_sync" | "weekly_account"
since?string
until?string
maxHighlights?number
DigestSchedule
cadence"daily" | "weekly"
hournumber
dayOfWeek?number
timezonestring
DirectoryCreateBody
name?string
provider?string
initialToken?{ name?: string; expiresAt?: string }
DiscoverProviderScopesBody
provider?string
providerKey?string
credentialReferenceId?string
parameters?map<string, any>
DiscoverProviderScopesHttpResponse
supportedboolean
providerScopesDiscoveredProviderScopeHttpItem[]
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
namestring
bucketstring
prefixstring
regionstring
apistring
formatstring
DiscoveredProviderScopeHttpItem
idstring
accountIdstring
providerKeystring
canonicalScopeKeystring
displayNamestring
statusstring
scopeKindstring | null
parentProviderScopeIdstring | null
createdAtstring
updatedAtstring
isNewboolean
Endpoint
nodestring
port?string
role?string
EntitlementGrantReason

"addon" | "included" | "legacy" | "override" | "trial"

EntitlementTemplate
featureKeyFeatureKey
kindkumo-contracts.EntitlementKind
scopekumo-contracts.EntitlementScope
valueFeatureValue
softLimit?number | null
hardLimit?number | null
resetPeriod?"annual" | "daily" | "monthly" | "none" | "weekly"
grantReasonEntitlementGrantReason
notes?string
Entity
idstring
kind"node"
typestring
role?string
parent?string | null
labels?string[]
data?map<string, any>
view?map<string, any>
meta?map<string, any>
EnvironmentByAccountItemDto
idstring
namestring
workspaceIdstring
workspaceNamestring
originstring
activeDefinitionIdstring | null
createdAtstring
retiredAtstring | null
providersstring[]
sourceCountnumber
membershipRuleany
evaluationEnvironmentEvaluationDto | null
sourceFreshnessEnvironmentSourceFreshnessDto | null
statusObjectStatus
workspaceStatusObjectStatus
EnvironmentChangeSubject
kind"environment"
environmentIdEnvironmentId
EnvironmentCostSubject
kind"environment"
environmentIdEnvironmentId
displayNamestring | null
EnvironmentEvaluationDto
resourceCountnumber
evaluatedAtstring
statusstring
workspaceGraphRevisionIdstring
behindLatestGraphboolean
chainState"failed" | "pending" | "running" | null
EnvironmentId

string

EnvironmentNotificationSubject
kind"environment"
workspaceIdWorkspaceId
environmentIdEnvironmentId
environmentRevisionId?EnvironmentRevisionId
displayNamestring
EnvironmentPricingEstimateResult
environmentIdstring
priceCatalogLoadedboolean
estimatesPricingSubtotal[]
resourceCountnumber
pricedResourceCountnumber
hoursPerMonthAssumednumber
EnvironmentQueryPreviewBody
dslBody?any
workspaceGraphRevisionId?string
EnvironmentQueryPreviewHttpResponse
targetResourceCountnumber
targetConnectionCountnumber
EnvironmentRevisionHttpItem
idstring
environmentIdstring
environmentDefinitionIdstring
workspaceGraphRevisionIdstring
targetSetIdstring
targetMembershipHashstring
statusstring
createdAtstring
EnvironmentRevisionId

string

EnvironmentRevisionMember
resourceIdResourceId
label{ canonicalIdentityKey: string; displayName: string; semanticType: string; providerType: string; lifecycleState: string } | null
EnvironmentSourceFreshnessDto
observedAtstring | null
syncStatusstring
syncInProgressboolean
coveragestring | null
EnvironmentSourceModelBuildHttpResponse
environmentIdstring
environmentRevisionIdstring
workspaceIdstring
workspaceGraphRevisionIdstring
resourceCountnumber
connectionCountnumber
sourceModelSourceModel
EvaluateEnvironmentBody
environmentDefinitionId?string
workspaceGraphRevisionId?string
EvaluateEnvironmentHttpResponse
idstring
environmentIdstring
environmentDefinitionIdstring
workspaceGraphRevisionIdstring
targetSetIdstring
targetResourceCountnumber
targetMembershipHashstring
statusstring
createdAtstring
ExternalNotificationRecipient
kind"external"
accountIdAccountId
channelNotificationChannel
addressstring
FeatureKey

string

FeatureValue

boolean | string | number | string[] | kumo-contracts.JsonObject | null

FinalizeWorkspaceSyncRunHttpResponse
statusstring
workspaceGraphRevisionIdstring | null
acceptedCountnumber
partialCountnumber
rejectedCountnumber
ForecastMethod

"last_30d_run_rate" | "last_7d_run_rate" | "linear_trend" | "manual" | "month_to_date_extrapolation" | "seasonal_weekday"

ForecastPoint
windowCostWindow
amountMoney
lowerBoundMoney | null
upperBoundMoney | null
GenerateDefaultViewsBody
environmentRevisionId?string
GenerateDefaultViewsHttpResponse
GenerateViewHttpResponse
viewRevisionIdstring
contextResultHashstring
semanticDiagramModelHashstring
visualGraphModelHashstring
layoutHashstring
inputHashstring
artifactCountnumber
svgHash?string
GenerateViewRevisionBody
viewConfigurationId?string
environmentRevisionId?string
regenerateStaleEngine?boolean
GeneratedDefaultViewHttpItem
templateKeystring
viewRevisionIdstring
GetConnectionAtRevisionHttpResponse

object | object

GetConnectionAtTimestampHttpResponse

object | object

GetEnvironmentHttpDefinition
idstring
environmentIdstring
versionnumber
dslBodyany
createdAtstring
GetEnvironmentHttpEvaluationFailure
kind"evaluation" | "post-sync-chain"
failedAtstring
workspaceGraphRevisionIdstring
environmentRevisionIdstring | null
errorstring | null
GetEnvironmentHttpEvaluationState
latestUsableRevisionIdstring | null
latestUsableEvaluatedAtstring | null
updating"evaluation" | "sync" | null
failureGetEnvironmentHttpEvaluationFailure | null
GetEnvironmentHttpResponse
idstring
workspaceIdstring
namestring
originstring
activeDefinitionIdstring | null
policyKeystring | null
anchorResourceIdstring | null
anchorCanonicalIdentityKeystring | null
createdAtstring
activeDefinitionGetEnvironmentHttpDefinition | null
evaluationStateGetEnvironmentHttpEvaluationState
GetEnvironmentRevisionHttpResponse
idstring
environmentIdstring
environmentDefinitionIdstring
workspaceGraphRevisionIdstring
targetSetIdstring
targetMembershipHashstring
statusstring
createdAtstring
targetSetGetEnvironmentRevisionHttpTargetSet | null
GetEnvironmentRevisionHttpTargetSet
idstring
targetMembershipHashstring
resourceIdsstring[]
connectionIdsstring[]
GetOperationHttpResponse
idstring
workspaceIdstring | null
type"operation"
operationTypestring
statusstring
target{ type: string; id: string }
resultmap<string, any> | null
createdAtstring
startedAtstring | null
completedAtstring | null
GetPipelineRunHttpResponse
idstring
accountIdstring | null
labelstring
createdAtstring
statusstring
modestring
filesnumber
succeedednumber
failednumber
durationMsnumber
metricsmap<string, any>
reportmap<string, any> | null
GetProviderScopeHttpResponse
idstring
accountIdstring
providerKeystring
canonicalScopeKeystring
displayNamestring
createdAtstring
GetResourceAtRevisionHttpResponse

object | object

GetRetentionPolicyHttpResponse
idstring
accountIdstring
namestring
targetstring
retainForDaysnumber
minimumKeptnumber
createdAtstring
GetSensitiveFieldPolicyHttpResponse
idstring
accountIdstring
namestring
attributePathGlobsstring[]
actionstring
createdAtstring
GetSourceCredentialHttpResponse
idstring
accountIdstring
displayNamestring
credentialKindstring
secretRefstring
createdAtstring
GetSourceHttpResponse
idstring
accountIdstring
workspaceIdstring
providerKeystring
displayNamestring
credentialReferenceIdstring
providerScopeIdstring | null
parametersmap<string, any> | null
createdAtstring
archivedAtstring | null
GetViewConfigurationHttpResponse
idstring
viewIdstring
viewTemplateVersionIdstring
parametersmap<string, any>
configurationHashstring
createdAtstring
GetViewHttpResponse
idstring
environmentIdstring
namestring
originstring
createdAtstring
GetViewRevisionArtifactHttpItem
kindstring
contentBlobShastring
artifactHashstring
contentTypestring
byteLengthnumber
GetViewRevisionHttpResponse
idstring
viewIdstring
viewConfigurationIdstring
viewTemplateVersionIdstring
environmentRevisionIdstring
workspaceGraphRevisionIdstring
inputHashstring
visualGraphModelHashstring
layoutHashstring
statusstring
artifactsGetViewRevisionArtifactHttpItem[]
createdAtstring
renderEngineFingerprintstring | null
renderEngineStaleboolean
GetViewTemplateHttpResponse
idstring
accountIdstring | null
templateKeystring
displayNamestring
createdAtstring
GetViewTemplateVersionHttpResponse
idstring
viewTemplateIdstring
versionstring
statusstring
resolvedBodyany
templateHashstring
createdAtstring
GetWorkspaceGraphRevisionHttpResponse
idstring
workspaceIdstring
sequencenumber
graphStateHashstring
producedBySnapshotIdstring
snapshotVectorstring[]
resourceRevisionCountnumber
connectionRevisionCountnumber
createdAtstring
GetWorkspaceSyncRunHttpResponse
idstring
workspaceIdstring
accountIdstring
statusstring
triggerKindstring
finalizationPolicystring
baseWorkspaceGraphRevisionIdstring | null
finalWorkspaceGraphRevisionIdstring | null
expectedSourceCountnumber
completedSourceCountnumber
acceptedSourceCountnumber
rejectedSourceCountnumber
partialSourceCountnumber
createdAtstring
startedAtstring | null
completedAtstring | null
leaseExpiresAtstring | null
sourceFailuresWorkspaceSyncRunSourceFailure[]
GraphDiffAuthorityDto
statusstring
deletionAuthorityboolean
reasons{ code: string; message: string }[]
GraphDiffChangeDto
idstring
kindstring
categorystring
severitystring
titlestring
descriptionstring
subjectGraphDiffChangeSubjectDto
fieldsGraphDiffFieldChangeDto[]
authorityGraphDiffAuthorityDto
redactedboolean
explainUrl?string
GraphDiffChangeId

string

GraphDiffChangeSubjectDto
kindstring
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
codestring
messagestring
refsGraphDiffEvidenceRef[]
GraphDiffExplanation
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
pathstring
beforeany
afterany
classificationstring
importancestring
redactedboolean
sensitiveboolean
GraphDiffLegendItemDto
labelstring
statusstring
countnumber
GraphDiffLineageChainDto
subject{ kind: string; id: string }
hopsGraphDiffLineageHopDto[]
GraphDiffLineageHopDto
kindstring
refstring
at?string
label?string
GraphDiffOverlayDto
artifactIdstring
legendGraphDiffLegendItemDto[]
resourceTreatmentsmap<string, GraphDiffVisualTreatmentDto>
connectionTreatmentsmap<string, GraphDiffVisualTreatmentDto>
GraphDiffSummaryDto
artifactIdstring
fromWorkspaceGraphRevisionIdstring
toWorkspaceGraphRevisionIdstring
statusstring
totalChangesnumber
resources{ added: number; removed: number; changed: number }
connections{ added: number; removed: number; changed: number }
severitiesmap<string, number>
categoriesmap<string, number>
warningsGraphDiffWarningDto[]
GraphDiffVisualTreatmentDto
statusstring
emphasisstring
badgesstring[]
tooltipstring
GraphDiffWarningDto
codestring
messagestring
severitystring
IamApiTokenRecord
idstring
displayNamestring
keyPrefixstring
statusstring
scopeApiTokenScope
createdBystring
createdAtstring
expiresAtstring
lastUsedAtstring | null
revokedAtstring | null
IamPermissionRecord
keystring
displayNamestring
descriptionstring
namespacestring
sensitivitystring
allowedScopesstring[]
IamRoleAssignmentRecord
idstring
principalKindstring
principalIdstring
roleIdstring
scopeKindstring
scopeLabelstring
statusstring
createdBystring
createdAtstring
expiresAtstring | null
revokedAtstring | null
IamRoleRecord
idstring
keystring
displayNamestring
descriptionstring
statusstring
systemboolean
ImpactedTarget
kind"alert" | "connection" | "environment" | "owner" | "report" | "resource" | "service" | "source" | "team" | "view"
idstring
displayNamestring | null
relationship"derived" | "direct" | "downstream" | "same_environment" | "same_owner" | "upstream"
confidencenumber
IngestBody
eventsChangeEventBody[]
dedupeBucket?string
InspectBody
archive?string
conflictMode?string
InviteBody
email?string
roleId?string
KumoArchiveFormat

"ndjson" | "zip"

KumoExportManifestEntryV1
entryIdstring
objectKindKumoImportExportObjectKind
logicalId?string
pathstring
contentType"application/json" | "application/octet-stream" | "application/pdf" | "application/x-ndjson" | "image/png" | "image/svg+xml"
schemaVersionnumber
sizeBytes?number
sha256string
redactionLevelKumoRedactionLevel
sensitivityKumoSensitivityLevel
importabilityKumoImportabilityLevel
dependencies?{ objectKind: KumoImportExportObjectKind; logicalId: string }[]
KumoExportProvenanceV1
contentHash?string
workspaceGraphRevisionId?string
viewTemplateVersionIds?string[]
notes?string[]
KumoExportSelectionV1
objectKindsKumoImportExportObjectKind[]
includeLogicalObjectsboolean
includeArtifactsboolean
includeRenderedArtifactsboolean
includeDiagnosticsboolean
includeRawSnapshotsboolean
includeProviderOutputboolean
includeAuditTrailboolean
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
objectKindKumoImportExportObjectKind
sourceObjectIdstring
existingObjectId?string
reasonstring
requiresPermission?string
KumoImportExportManifestV1
kind"kumo.importExport.manifest"
manifestVersion1
exportIdstring
operationKindKumoImportExportOperationKind
archiveFormatKumoArchiveFormat
createdAtstring
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 }
compatibilityKumoManifestCompatibilityV1
redactionKumoManifestRedactionV1
selectionKumoExportSelectionV1
provenanceKumoExportProvenanceV1
contentsKumoExportManifestEntryV1[]
integrityKumoManifestIntegrityV1
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
actionIdstring
actionKindKumoImportActionKind
objectKindKumoImportExportObjectKind
sourceObjectId?string
targetObjectId?string
reasonstring
requiresConfirmation?boolean
requiresPermission?string
warnings?string[]
KumoImportPlanV1
kind"kumo.importExport.importPlan"
planVersion1
importPlanIdstring
archiveManifestKumoImportExportManifestV1
target{ tenantId: string; accountId: string; workspaceId?: string }
conflictModeKumoImportConflictMode
scopeRemappingKumoScopeRemappingPlanV1
actionsKumoImportPlanActionV1[]
conflictsKumoImportConflictV1[]
warningsKumoImportWarningV1[]
validationKumoValidationResultV1
createdAtstring
createdByActorIdstring
KumoImportWarningV1
codestring
messagestring
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
supportedManifestMajorsnumber[]
objectSchemaVersionsmap<string, number>
artifactSchemaVersions?map<string, number>
importerVersions?map<string, string>
KumoManifestIntegrityV1
hashAlgorithm"sha256"
manifestSha256?string
aggregateSha256?string
entriesSha256?map<string, string>
KumoManifestRedactionV1
levelKumoRedactionLevel
policyIds?string[]
deterministicboolean
redactedFieldsCount?number
restrictedEntriesCount?number
KumoObjectIdRemapV1
objectKindKumoImportExportObjectKind
sourceObjectIdstring
targetObjectIdstring
reason"artifact_rebound" | "conflict" | "credential_reference_unresolved" | "local_id_regenerated" | "new_scope"
KumoRedactionLevel

"fixture" | "redacted" | "restricted" | "unredacted"

KumoScopeRemappingPlanV1
sourceTenantId?string
sourceAccountId?string
sourceWorkspaceId?string
targetTenantIdstring
targetAccountIdstring
targetWorkspaceId?string
objectIdRemapsKumoObjectIdRemapV1[]
strippedFieldsKumoStrippedFieldV1[]
requiredPermissionsstring[]
warningsKumoImportWarningV1[]
KumoSensitivityLevel

"public" | "restricted" | "secret" | "sensitive" | "tenant"

KumoStrippedFieldV1
objectKindKumoImportExportObjectKind
objectId?string
fieldPathstring
reasonstring
KumoValidationIssueV1
severityKumoValidationSeverity
codestring
messagestring
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
okboolean
phases{ phase: KumoValidationPhase; ok: boolean; issues: KumoValidationIssueV1[] }[]
KumoValidationSeverity

"error" | "fatal" | "info" | "warning"

ListEnvironmentsHttpResponseItem
idstring
workspaceIdstring
namestring
originstring
activeDefinitionIdstring | null
policyKeystring | null
anchorResourceIdstring | null
anchorCanonicalIdentityKeystring | null
createdAtstring
ListProviderScopeBindingsHttpResponseItem
idstring
workspaceIdstring
providerScopeIdstring
createdAtstring
ListProviderScopesHttpResponseItem
idstring
accountIdstring
providerKeystring
canonicalScopeKeystring
displayNamestring
createdAtstring
statusstring
scopeKindstring | null
parentProviderScopeIdstring | null
resourceCount?number
provisionedResourceCount?number
unclassifiedResourceCount?number
isOrganizationPayer?boolean
organizationId?string | null
attributesmap<string, any>
ListResourceConnectionsAtRevisionHttpResponseItem
connectionIdstring
connectionTypestring
direction"in" | "out"
revisionIdstring
otherResourceIdstring | null
ListResourcesAtRevisionHttpResponseItem
idstring
workspaceIdstring
canonicalIdentityKeystring
semanticTypestring
providerTypestring
lifecycleStatestring
currentRevisionIdstring
displayNamestring
ListSourceCredentialsHttpResponseItem
idstring
accountIdstring
displayNamestring
credentialKindstring
secretRefstring
createdAtstring
ListSourcesHttpResponseItem
idstring
accountIdstring
workspaceIdstring
providerKeystring
displayNamestring
credentialReferenceIdstring
providerScopeIdstring | null
parametersmap<string, any> | null
createdAtstring
archivedAtstring | null
ListWorkspaceGraphRevisionsHttpResponseItem
idstring
workspaceIdstring
sequencenumber
producedBySnapshotIdstring
snapshotVectorstring[]
graphStateHashstring
createdAtstring
qualityRevisionQualityHttpDto | null
ListWorkspaceSyncRunsHttpResponseItem
idstring
workspaceIdstring
accountIdstring
statusstring
triggerKindstring
finalizationPolicystring
baseWorkspaceGraphRevisionIdstring | null
finalWorkspaceGraphRevisionIdstring | null
expectedSourceCountnumber
completedSourceCountnumber
acceptedSourceCountnumber
rejectedSourceCountnumber
partialSourceCountnumber
createdAtstring
startedAtstring | null
completedAtstring | null
MaterializeBody
force?boolean
from?string
to?string
lenses?ChangeLens[]
maxChanges?number
includeSuppressed?boolean
Money
amountstring
currencystring
MoneyOrRedacted

Money | RedactedMoney

NotificationChannel

"cli" | "desktop" | "email" | "in_app" | "mobile_push" | "slack" | "webhook"

NotificationDeliveryMode

"digest" | "immediate" | "in_app_only" | "muted"

NotificationDto
idstring
accountIdstring
workspaceIdstring | null
kindstring
severitystring
urgencystring
titlestring
summarystring
subjectNotificationSubject
linksNotificationLink[]
evidenceNotificationEvidence[]
threadKeystring | null
dedupeKeystring
createdAtstring
occurredAtstring
statestring
NotificationEvidence
kindstring
labelstring
ref?string
sensitive?boolean
detail?map<string, any>
NotificationInboxItemDto
recipientNotificationRecipientNotificationDto
notificationNotificationDto
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"

NotificationLinkKind

"alert" | "context" | "credential" | "diff" | "environment" | "external" | "graph_revision" | "report" | "resource" | "settings" | "source" | "sync_run" | "view" | "workspace"

NotificationPreferenceDto
idstring
accountIdstring
userIdstring
scopeNotificationPreferenceScope
channelstring
kindstring
enabledboolean
minimumSeveritystring | null
deliveryModestring
quietHours?QuietHours | null
digestSchedule?DigestSchedule | null
createdAtstring
updatedAtstring
NotificationPreferenceScope

object | object

NotificationPreferenceUpdateSpec
scopeNotificationPreferenceScope
channelNotificationChannel
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"
enabledboolean
minimumSeverity?"critical" | "error" | "info" | "success" | "warning"
deliveryModeNotificationDeliveryMode
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
idstring
accountIdstring
workspaceIdstring | null
subscriberNotificationRecipient
selectorNotificationSubjectSelector
kindsstring[]
channelsstring[]
minimumSeveritystring
enabledboolean
createdAtstring
ObjectStatus
stateObjectStatusState
reasonstring
needsAttentionboolean
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
idstring
workspaceIdstring | null
sourceIdstring | null
type"operation"
operationTypestring
statusstring
target{ type: string; id: string }
resultmap<string, any> | null
failurestring | null
createdAtstring
startedAtstring | null
completedAtstring | null
OwnerCostSubject
kind"owner"
ownerKeystring
displayNamestring | null
ParametersBody
parameters?map<string, any> | null
PartnerBranding
productNamestring
logoUrlstring | null
faviconUrlstring | null
supportEmailstring | null
themeTokensmap<string, string>
PartnerBrandingResolveResult
partner{ partnerId: string; branding: PartnerBranding } | null
PartnerSignupBody
email?string
password?string
displayName?string
accountName?string
host?string
PartnerSignupProvisionResult
partnerIdstring
userIdstring
accountIdstring
planKeystring
trialEndsAtstring (date-time)
sessionToken?string
sessionExpiresAt?string (date-time)
PipelineRunHttpSummaryItem
idstring
accountIdstring | null
labelstring
createdAtstring
statusstring
modestring
filesnumber
succeedednumber
failednumber
durationMsnumber
hasReportboolean
PlanId

string

PlanTier

"business" | "embedded" | "enterprise" | "free" | "internal" | "self_hosted" | "starter" | "team" | "trial"

PlanVersionId

string

PolicyBody
requireMfa?any
requireSso?any
PolicyChangeSubject
kind"policy"
policyIdPolicyId
PolicyId

string

PreferencesUpdateBody
PriceCatalogId

string

PriceCatalogItemId

string

PriceCatalogItemRef
priceCatalogItemIdPriceCatalogItemId
catalogIdPriceCatalogId
skustring
rateMoney
unitPricingUnit
purchaseOptionPurchaseOption
PriceMatch
resourceIdResourceId
priceCatalogItemIdPriceCatalogItemId | null
statusPriceMatchStatus
matchedOnPriceMatchField[]
missingFieldsstring[]
confidenceCostConfidence
evidenceCostEvidence[]
PriceMatchExplainResult
matchPriceMatch
candidatesConsiderednumber
generatedAtstring
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
currencystring
hourlynumber
monthlynumber
unitstring | 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"
providerScopeIdProviderScopeId
ProviderScopeId

string

ProvisionDemoWorkspaceBody
workspaceName?string
PurchaseOption

"committed_use" | "custom_contract" | "enterprise_agreement" | "on_demand" | "reserved" | "savings_plan" | "spot" | "unknown"

QueryExplainStep
stepIdstring
stepTypestring
inputCardinalitynumber
outputCardinalitynumber
durationMicrosnumber
notes?string
QuietHours
timezonestring
startHournumber
endHournumber
days?number[]
QuotaCheckBody
featureKey?string
workspaceId?string
requestedQuantity?number
QuotaSubject
RawDiffRef
graphDiffArtifactIdstring
graphDiffChangeIdstring
RecipientNotificationDto
idstring
notificationIdstring
recipientNotificationRecipient
visibilitystring
readStatestring
lifecycleStatestring
deliveredChannelsstring[]
createdAtstring
readAtstring | null
dismissedAtstring | null
RedactedChangeValue

object | object | object

RedactedMoney
kind"redacted_money"
currencystring | null
reason"not_authorized" | "policy" | "sensitive"
ReportAccountSummary
accountIdAccountId
namestring
plan?string
environment?string
ReportArtifactBlock
kind"artifact"
blockIdstring
titlestring
artifactKind"attachment" | "diagram" | "image"
href?string
contentHash?string
sourceEvidenceRefs?ReportEvidenceRef[]
ReportArtifactGetDownloadUrlResult
urlstring
expiresAtstring
ReportAuthorizationProjection
redactionModeReportRedactionMode
allowSensitiveEvidenceboolean
maskedFields?string[]
decisionId?string
policyVersion?string
evaluatedAt?string
ReportBlock

ReportMarkdownBlock | ReportMetricGridBlock | ReportTableBlock | ReportChartBlock | ReportFindingListBlock | ReportResourceListBlock | ReportEvidenceListBlock | ReportArtifactBlock | ReportCalloutBlock

ReportCalloutBlock
kind"callout"
blockIdstring
tone"danger" | "empty" | "info" | "success" | "warning"
title?string
bodystring
sourceEvidenceRefs?ReportEvidenceRef[]
ReportChartBlock
kind"chart"
blockIdstring
chartReportChartSpec
dataReportChartDataset
fallbackTableReportTableBlock
sourceEvidenceRefsReportEvidenceRef[]
ReportChartDataPoint
labelstring
valuenumber
series?string
ReportChartDataset
ReportChartSpec
chartType"bar" | "line" | "map" | "pie" | "stacked_bar"
title?string
xLabel?string
yLabel?string
ReportConnectionRef
connectionIdConnectionId
labelstring
connectionType?string
ReportContentBlobRef
storestring
keystring
contentHashstring
contentType?string
sizeBytes?number
ReportCreateBody
kind?string
window?{ startInclusive?: string; endExclusive?: string }
title?string
basis?string
currency?string
includeForecast?boolean
forecastMethod?string
ReportDefinition
reportDefinitionIdReportDefinitionId
accountIdAccountId
workspaceIdWorkspaceId
namestring
description?string
kindReportKind
scopeReportScope
sectionsReportSectionDefinition[]
defaultExportOptionsReportExportOptions
createdBykumo-contracts.ActorRef
createdAtstring
updatedAtstring
versionnumber
ReportDefinitionCreateBody
workspaceId?WorkspaceId
namestring
description?string
kindReportKind
scopeReportScope
sections?ReportSectionDefinition[]
defaultExportOptions?ReportExportOptions
correlationId?string
ReportDefinitionDeleteResult
deletedboolean
ReportDefinitionId

string

ReportDefinitionUpdateBody
name?string
description?string
sections?ReportSectionDefinition[]
defaultExportOptions?ReportExportOptions
correlationId?string
ReportDeliveryTarget

object | object | object | object | object

ReportDiagnostic
severity"error" | "info" | "warning"
codeReportDiagnosticCode
messagestring
sectionId?string
findingId?ReportFindingId
evidenceId?ReportEvidenceId
safeForUserboolean
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
evidenceIdReportEvidenceId
kind"connection_revision" | "cost_fact" | "credential_health_check" | "diff_result" | "manual_note" | "metric_fact" | "policy_decision" | "provider_observation" | "resource_revision" | "source_snapshot" | "view_artifact"
titlestring
summary?string
refsReportEvidenceTargetRef[]
observedAt?string
generatedAt?string
provider?string
sourceId?SourceId
sourceSnapshotId?SourceSnapshotId
attributes?ReportJsonObject
redactionReportEvidenceRedaction
ReportEvidenceId

string

ReportEvidenceListBlock
kind"evidence_list"
blockIdstring
evidenceRefsReportEvidenceRef[]
ReportEvidenceRedaction
mode"field_redaction" | "none" | "placeholder"
redactedFields?string[]
note?string
ReportEvidenceRef
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"
idstring
label?string
ReportExportFormat

"csv" | "html" | "json" | "markdown" | "pdf"

ReportExportId

string

ReportExportOptions
includeSections?string[]
excludeSections?string[]
includeEvidenceAppendixboolean
includeDiagnosticsboolean
includeRedactedPlaceholdersboolean
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
reportExportIdReportExportId
reportRunIdReportRunId
accountIdAccountId
workspaceIdWorkspaceId
requestedBykumo-contracts.ActorRef
requestedAtstring
startedAt?string
completedAt?string
failedAt?string
formatReportExportFormat
optionsReportExportOptions
redactionModeReportRedactionMode
statusReportExportStatus
artifactRef?ReportContentBlobRef
diagnosticsReportDiagnostic[]
ReportExportStartBody
formatReportExportFormat
options?ReportExportOptions
mode?"inline" | "queued"
correlationId?string
ReportExportStartResultDto
ReportExportStatus

"expired" | "failed" | "queued" | "rendering" | "succeeded" | "uploading"

ReportFinding
findingIdReportFindingId
kindReportFindingKind
severityReportFindingSeverity
statusReportFindingStatus
titlestring
summarystring
detail?string
affectedResourcesReportResourceRef[]
affectedConnections?ReportConnectionRef[]
evidenceRefsReportEvidenceRef[]
recommendationRefs?ReportRecommendationRef[]
sourceReportFindingSource
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"
blockIdstring
findingRefsReportFindingRef[]
ReportFindingRef
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"
blockIdstring
markdownstring
sourceEvidenceRefs?ReportEvidenceRef[]
ReportMetric
metricIdstring
labelstring
valueboolean | string | number | null
unit?string
kindReportMetricKind
qualityReportMetricQuality
sourceEvidenceRefsReportEvidenceRef[]
ReportMetricGridBlock
kind"metric_grid"
blockIdstring
metricRefsReportMetricRef[]
ReportMetricKind

"bytes" | "count" | "currency" | "duration" | "percentage" | "score" | "status"

ReportMetricQuality

"actual" | "derived" | "estimated" | "partial" | "unknown"

ReportMetricRef
metricIdstring
ReportModel
schemaVersion1
reportRunIdReportRunId
kindReportKind
titlestring
accountReportAccountSummary
workspaceReportWorkspaceSummary
subjectReportSubject
generatedAtstring
generatedBykumo-contracts.ActorRef
sourceStateReportSourceState
sectionsReportSection[]
findingsReportFinding[]
metricsReportMetric[]
evidenceReportEvidence[]
recommendationsReportRecommendation[]
diagnosticsReportDiagnostic[]
redactionReportRedactionSummary
provenanceReportProvenance
ReportNotificationSubject
kind"report"
workspaceId?WorkspaceId
reportIdstring
reportRevisionId?string
displayNamestring
ReportProvenance
inputHashstring
modelHashstring
generatorVersionstring
schemaVersion1
sourceHashesReportSourceHash[]
ReportRecommendation
recommendationIdstring
titlestring
textstring
ReportRecommendationRef
recommendationIdstring
titlestring
ReportRedactionMode

"field_redaction" | "metadata_only" | "none" | "safe_external" | "unauthorized_projection"

ReportRedactionSummary
modeReportRedactionMode
redactedFieldsnumber
omittedResourcesnumber
omittedConnectionsnumber
omittedFindingsnumber
evidencePlaceholdersnumber
diagnosticsReportDiagnostic[]
ReportResourceListBlock
kind"resource_list"
blockIdstring
resourcesReportResourceRef[]
sourceEvidenceRefsReportEvidenceRef[]
ReportResourceRef
resourceIdResourceId
labelstring
provider?string
resourceType?string
region?string
ReportRun
reportRunIdReportRunId
reportDefinitionId?ReportDefinitionId
reportDefinitionVersion?number
accountIdAccountId
workspaceIdWorkspaceId
kindReportKind
scopeReportScope
statusReportRunStatus
requestedBykumo-contracts.ActorRef
requestedAtstring
startedAt?string
completedAt?string
failedAt?string
inputHashstring
modelHash?string
sourceStateReportSourceState
authorizationProjectionReportAuthorizationProjection
modelRef?ReportContentBlobRef
summary?ReportRunSummary
diagnosticsReportDiagnostic[]
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
ReportRunStatus

"cancelled" | "expired" | "failed" | "queued" | "running" | "succeeded"

ReportRunSummary
sectionCountnumber
findingCountnumber
criticalFindingCountnumber
highFindingCountnumber
metricCountnumber
evidenceCountnumber
resourceCount?number
redactionModeReportRedactionMode
ReportSchedule
reportScheduleIdReportScheduleId
reportDefinitionIdReportDefinitionId
accountIdAccountId
workspaceIdWorkspaceId
cronstring
timezonestring
deliveryReportDeliveryTarget[]
exportFormatsReportExportFormat[]
enabledboolean
nextRunAt?string
lastRunAt?string
createdAtstring
updatedAtstring
ReportScheduleCreateBody
reportDefinitionIdReportDefinitionId
workspaceId?WorkspaceId
cronstring
timezonestring
deliveryReportDeliveryTarget[]
exportFormats?ReportExportFormat[]
enabled?boolean
correlationId?string
ReportScheduleDeleteResult
deletedboolean
ReportScheduleId

string

ReportScheduleUpdateBody
cron?string
timezone?string
delivery?ReportDeliveryTarget[]
exportFormats?ReportExportFormat[]
enabled?boolean
ReportScope

object | object | object | object | object

ReportSection
sectionIdstring
kindReportSectionKind
titlestring
summary?string
statusReportSectionStatus
blocksReportBlock[]
findings?ReportFindingRef[]
metrics?ReportMetricRef[]
evidence?ReportEvidenceRef[]
diagnosticsReportDiagnostic[]
ReportSectionDefinition
sectionIdstring
kindReportSectionKind
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
labelstring
hashstring
ReportSourceState
scopeKind"comparison" | "environment" | "source" | "view" | "workspace"
resolvedAtstring
workspaceIdWorkspaceId
graphRevisionId?WorkspaceGraphRevisionId
environmentId?EnvironmentId
environmentRevisionId?EnvironmentRevisionId
sourceId?SourceId
sourceSnapshotId?SourceSnapshotId
viewId?ViewId
viewRevisionId?ViewRevisionId
baseGraphRevisionId?WorkspaceGraphRevisionId
targetGraphRevisionId?WorkspaceGraphRevisionId
sourceHashesReportSourceHash[]
ReportSubject
kind"comparison" | "environment" | "source" | "view" | "workspace"
idstring
labelstring
ReportTableBlock
kind"table"
blockIdstring
columnsReportTableColumn[]
rowsReportTableRow[]
sourceEvidenceRefsReportEvidenceRef[]
ReportTableColumn
keystring
labelstring
align?"center" | "left" | "right"
kind?"currency" | "number" | "percentage" | "status" | "text" | "timestamp"
ReportTableRow
cellsmap<string, ReportJson>
ReportWorkspaceSummary
workspaceIdWorkspaceId
namestring
description?string
ResourceAttributeValuesListHttpResponse
ResourceAttributeValuesListHttpResponseValue
valuestring
countnumber
ResourceChangeSubject
kind"resource"
resourceIdResourceId
resourceTypestring
displayNamestring | null
providerstring | null
regionstring | null
authorityDomain?"actual_configuration" | "business_metadata" | "cost_metadata" | "desired_configuration" | "manual_annotation" | "runtime_observed" | "security_finding"
ResourceChangeTimelineResult
resourceIdResourceId
itemsChangeItem[]
ResourceCostEstimate
idResourceCostEstimateId
workspaceIdWorkspaceId
subjectCostSubject
windowCostWindow
amountMoney
methodCostEstimateMethod
assumptionsCostAssumption[]
matchedPriceItemsPriceCatalogItemRef[]
confidenceCostConfidence
evidenceCostEvidence[]
generatedAtstring
ResourceCostEstimateId

string

ResourceCostExplainResult
explanationResourceCostExplanation
generatedAtstring
ResourceCostExplanation
subjectResourceCostSubject
windowCostWindow
actualTotalMoney | null
factsResourceCostFact[]
estimateResourceCostEstimate | null
priceMatchPriceMatch | null
ownerCostOwner | null
appliedAllocationRules{ ruleId: CostAllocationRuleId; version: number; name: string }[]
assumptionsCostAssumption[]
evidenceCostEvidence[]
confidenceCostConfidence
diagnosticsCostDiagnostic[]
ResourceCostFact
idResourceCostFactId
workspaceIdWorkspaceId
subjectCostSubject
windowCostWindow
providerstring
sourceIdSourceId | null
namespacestring
keystring
amountMoney
costBasisCostBasis
chargeTypeChargeType
allocationStatusAllocationStatus
confidenceCostConfidence
provenanceCostProvenance
tagsmap<string, string>
dimensionsmap<string, string>
createdAtstring
ResourceCostFactId

string

ResourceCostSubject
kind"resource"
resourceIdResourceId
resourceTypestring
providerstring | null
regionstring | null
displayNamestring | null
ResourceDto
idstring
workspaceIdstring
canonicalIdentityKeystring
semanticTypestring
providerTypestring
coverageKeystring
lifecycleStatestring
ResourceId

string

ResourceNotificationSubject
kind"resource"
workspaceIdWorkspaceId
resourceIdstring
displayNamestring
ResourceObservationId

string

ResourcePricingGetResult
resourceIdstring
pricedboolean
currencystring | null
hourlynumber | null
monthlynumber | null
unitstring | null
hoursPerMonthAssumednumber
ResourceRevisionId

string

ResourceSummary
resourceIdResourceId
workspaceIdWorkspaceId
revisionIdWorkspaceGraphRevisionId
semanticTypestring
displayNamestring
providerKeyProviderKey
regionstring | null
environmentIdEnvironmentId | null
sensitiveboolean
updatedAtstring
RetentionApplicationBody
policies?RetentionPolicyHttpInput[]
retentionPolicyIds?string[]
apply?boolean
RetentionCandidateHttpItem
targetstring
idstring
ageDaysnumber
reasonstring
RetentionCompactionOutcomeHttpItem
policyNamestring
appliedboolean
candidatesCountnumber
compactedResourceRevisionCountnumber
compactedConnectionRevisionCountnumber
RetentionPolicyHttpInput
idstring
namestring
targetRetentionTarget
retainForDaysnumber
minimumKeptnumber
RetentionPolicyHttpItem
idstring
namestring
targetstring
retainForDaysnumber
minimumKeptnumber
RetentionPolicyRecordHttpItem
idstring
accountIdstring
namestring
targetstring
retainForDaysnumber
minimumKeptnumber
createdAtstring
RetentionTarget

"compact_revisions" | "observations" | "revisions" | "snapshots" | "view_revisions"

RevisionQualityHttpDto
coveragestring
freshnessstring
perKey{ coverageKey: string; authority: string }[]
RotateBody
secretRef?string
secretStoreKey?string
credentialKind?string
displayName?string
secretMaterial?any
RotateSourceCredentialHttpResponse
idstring
accountIdstring
displayNamestring
credentialKindstring
secretRefstring
createdAtstring
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
sourceSyncIdstring
sourceSnapshotIdstring
workspaceGraphRevisionIdstring | null
resourceRevisionsAppendednumber
connectionRevisionsAppendednumber
graphStateHashstring | null
SamlAttributeMapping
subjectSamlAttributeSource
emailSamlAttributeSource
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
certificateIdstring
fingerprintSha256string
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
groupstring
accountRole?string
workspaceRole?string
workspaceId?string
SamlIdentityProviderConfig
entityIdstring
ssoUrlstring
sloUrl?string
certificatesSamlCertificateDescriptor[]
metadataSourceSamlMetadataSource
acceptedBindingsSamlBinding[]
SamlMetadataSource

object | object | object

SamlProvisioningMode

"auto_link_existing_email" | "disabled" | "existing_user_only" | "just_in_time_user"

SamlProvisioningPolicy
modeSamlProvisioningMode
defaultAccountRole?string
defaultWorkspaceRole?string
groupRoleMappingsSamlGroupRoleMapping[]
requiredGroups?string[]
blockedGroups?string[]
emailDomainAllowlist?string[]
requireVerifiedEmailboolean
SamlSecurityPolicy
maxClockSkewSecondsnumber
maxAssertionAgeSecondsnumber
requireEncryptedAssertionsboolean
requireSignedAssertionsboolean
requireSignedResponseboolean
allowIdpInitiatedLoginboolean
allowUnsolicitedRelayStateboolean
replayWindowSecondsnumber
allowedAudiencesstring[]
allowedRecipientsstring[]
allowedDestinationsstring[]
certificateRolloverModeSamlCertificateRolloverMode
SamlServiceProviderConfig
entityIdstring
assertionConsumerServiceUrlstring
singleLogoutServiceUrl?string
nameIdFormat?"emailAddress" | "entity" | "kerberos" | "persistent" | "transient" | "unspecified" | "windowsDomainQualifiedName"
authnRequestSignedboolean
wantAssertionsSignedboolean
wantResponseSignedboolean
signingKeyRef?SecretRef
signingCertificateRef?SecretRef
allowedBindingsSamlBinding[]
SavedView
idstring
accountIdAccountId
ownerUserIdUserId
namestring
querystring
createdAtstring
updatedAtstring
SavedViewCreateBody
namestring
querystring
SavedViewUpdateBody
name?string
query?string
ScimAddressAttribute
type?string
formatted?string
streetAddress?string
locality?string
region?string
postalCode?string
country?string
primary?boolean
ScimGroupMember
valuestring
$ref?string
display?string
type?"Group" | "User"
ScimGroupRef
valuestring
$ref?string
display?string
type?"direct" | "indirect"
ScimGroupResource
schemasstring[]
idstring
externalId?string
displayNamestring
members?ScimGroupMember[]
metaScimMeta
ScimMeta
resourceType"Group" | "User"
createdTimestampIso
lastModifiedTimestampIso
locationstring
version?string
ScimMultiValueAttribute
valuestring
type?string
primary?boolean
display?string
$ref?string
ScimResourceType
schemasstring[]
idstring
namestring
endpointstring
descriptionstring
schemastring
schemaExtensions?{ schema: string; required: boolean }[]
meta{ resourceType: "ResourceType"; location: string }
ScimSchemaAttribute
namestring
type"boolean" | "complex" | "dateTime" | "reference" | "string"
multiValuedboolean
requiredboolean
caseExact?boolean
mutability?"immutable" | "readOnly" | "readWrite" | "writeOnly"
returned?"always" | "default" | "never" | "request"
uniqueness?"global" | "none" | "server"
subAttributes?ScimSchemaAttribute[]
ScimSchemaDefinition
idstring
namestring
descriptionstring
attributesScimSchemaAttribute[]
meta{ resourceType: "Schema"; location: string }
ScimServiceProviderConfig
schemasstring[]
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
schemasstring[]
idstring
externalId?string
userNamestring
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[]
metaScimMeta
ScopeMembershipEdgeId

string

ScopeNodeId

string

SearchEntityKind

"connection" | "diagnostic" | "job" | "resource" | "source" | "view"

SearchFacet
fieldstring
valuesSearchFacetValue[]
SearchFacetValue
valuestring
countnumber
SearchHit
idstring
kindSearchEntityKind
workspaceIdWorkspaceId | null
titlestring
subtitlestring | null
snippetstring | null
scorenumber
providerKeyProviderKey | null
semanticTypestring | null
lifecycleStatestring | null
regionstring | null
updatedAtstring
SearchResultPage
hitsSearchHit[]
facetsSearchFacet[]
totalnumber
nextCursorstring | null
SecretRef

string

SelfServeCadence

"annual" | "monthly" | "quarterly"

SelfServePlan
planKeystring
familyKeystring
displayNamestring
description?string
tierPlanTier
currentVersionnumber
cadencesSelfServeCadence[]
entitlementsEntitlementTemplate[]
trial?{ days: number; signupDefault: boolean }
SensitiveFieldPolicyRecordHttpItem
idstring
accountIdstring
namestring
attributePathGlobsstring[]
actionstring
createdAtstring
ServiceCostSubject
kind"service"
providerstring | null
servicestring
SetAccountTemplateOverrideHttpResponse
templateKeystring
updatedAtstring
SetViewTemplateOverrideHttpResponse
viewIdstring
updatedAtstring
Severity

"critical" | "high" | "info" | "low" | "medium"

SlackChannelInfo
idstring
namestring
isPrivateboolean
SlackCommandResponse
response_type"ephemeral"
textstring
Source
idSourceId
accountIdAccountId
workspaceIdWorkspaceId
providerKeystring
displayNamestring
credentialReferenceIdSourceCredentialReferenceId
createdAtstring (date-time)
providerScopeIdProviderScopeId | null
archivedAtstring (date-time) | null
parameterskumo-contracts.JsonObject | null
isArchivedboolean
SourceArchiveResult
sourceSource
SourceChangeSubject
kind"source"
sourceIdSourceId
SourceConnectDiagnostic
severitystring
codestring
messagestring
SourceConnectResult
sourceIdstring
workspaceIdstring
providerKeystring
displayNamestring
credentialIdstring
providerScopeIdstring
providerScopeKeystring
providerScopeStatusstring
syncStartedboolean
workspaceSyncRunIdstring | null
discoveryDiagnosticsSourceConnectDiagnostic[]
SourceCostSubject
kind"source"
sourceIdSourceId
SourceCredentialReferenceId

string

SourceId

string

SourceModel
schemaVersionstring
id?string
type?string
data?map<string, any>
meta?map<string, any>
nodesEntity[]
edgesConnection[]
SourceNotificationSubject
kind"source"
workspaceIdWorkspaceId
sourceIdSourceId
sourceSyncId?SourceSyncId
displayNamestring
SourceParametersUpdateHttpResponse
idstring
accountIdstring
workspaceIdstring
providerKeystring
displayNamestring
credentialReferenceIdstring
providerScopeIdstring | null
createdAtstring
archivedAtstring | null
parameterskumo-contracts.JsonObject | null
SourcePreflightResult
supportedboolean
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
idstring
sourceIdstring
statusstring
triggerKindstring
plannedAtstring
startedAtstring | null
completedAtstring | null
rejectionReasonstring | null
SourceSyncId

string

SourceSyncState

"failed" | "never" | "partial" | "running" | "succeeded"

SourceSyncStatus
workspaceIdWorkspaceId
sourceIdSourceId
providerKeyProviderKey
lastSyncRunIdWorkspaceSyncRunId | null
stateSourceSyncState
coverageSourceSyncCoverage
startedAtstring | null
finishedAtstring | null
resourceCountnumber
errorCountnumber
SourceSyncsListHttpResponseItem
idstring
sourceIdstring
statusstring
triggerKindstring
plannedAtstring
startedAtstring | null
completedAtstring | null
rejectionReasonstring | null
SourceUnarchiveResult
sourceSource
SsoSamlConfigurationDto
idstring
statusSamlConfigurationStatus
displayNamestring
serviceProviderSamlServiceProviderConfig
identityProviderSamlIdentityProviderConfig
attributeMappingSamlAttributeMapping
provisioningPolicySamlProvisioningPolicy
securityPolicySamlSecurityPolicy
createdAtstring
updatedAtstring
activatedAt?string
disabledAt?string
versionnumber
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
workspaceSyncRunIdstring
memberSourceIdsstring[]
SubscriptionCreateBody
workspaceId?string
subscriber?UserNotificationRecipient | TeamNotificationRecipient | WorkspaceNotificationRecipient | ExternalNotificationRecipient
selector?NotificationSubjectSelector
kinds?NotificationKind[]
channels?NotificationChannel[]
minimumSeverity?"critical" | "error" | "info" | "success" | "warning"
SubscriptionId

string

SuppressedChange
subjectChangeSubject
atomKindChangeAtomKind
fieldPathstring | null
reasonstring
SyncBody
triggerKind?"manual" | "scheduled" | "webhook"
parameters?map<string, any>
workspaceSyncRunId?any
SyncDiagnosticWire
idstring
seqnumber
accountIdstring
workspaceIdstring
sourceIdstring
sourceSyncIdstring
workspaceSyncRunIdstring | null
emittedAtstring
severitystring
phasestring
codestring
messagestring
remediationstring | null
coverageKeystring | null
providerScopeKeystring | null
resourceKeystring | null
connectionKeystring | null
detailsmap<string, any> | null
SyncDiagnosticsListHttpResponse
itemsSyncDiagnosticWire[]
nextAfterSeqnumber | null
SystemNotificationSubject
kind"system"
workspaceId?WorkspaceId
displayNamestring
TagCostSubject
kind"tag"
tagKeystring
tagValuestring
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"
teamKeystring
displayNamestring | null
TeamNotificationRecipient
kind"team"
teamIdstring
accountIdAccountId
TenantAuditRecordDto
idstring
eventTypestring
outcomestring
severitystring
occurredAtstring
recordedAtstring
actor{ kind: string; principalId: string | null; userId: string | null; displayName: string | null; authMethod: string | null; impersonated: boolean }
scopeKindstring
workspaceIdstring | null
target{ type: string; id: string | null; displayName: string | null } | null
reasonstring | null
sourcePackagestring
TenantFeatureAvailabilityDto
featureKeystring
enabledboolean
visibleboolean
reasonCodeTenantFeatureReasonCode
reasonMessagestring
kindTenantFeatureKind
softLimitnumber | null
hardLimitnumber | null
upgradeHintstring | 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
featureTenantFeatureAvailabilityDto
evaluatedAtstring
cacheKeystring
TenantFeaturesResponseDto
featuresTenantFeatureAvailabilityDto[]
evaluatedAtstring
cacheKeystring
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
enabledboolean
UsageAdjustmentId

string

UsageAggregation

"distinct_count" | "duration_accrual" | "high_watermark" | "last" | "max" | "storage_accrual" | "sum"

UsageCounterDto
accountIdAccountId
idUsageCounterId
subjectUsageSubject
createdAtstring
updatedAtstring
meterKeyUsageMeterKey
meterVersionnumber
windowUsageWindow
usedUsageQuantity
reservedUsageQuantity
committedUsageQuantity
adjustedUsageQuantity
lastLedgerSequencestring
UsageCounterId

string

UsageCounterViewDto
counterUsageCounterDto
effectiveUsedstring
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"
refstring
note?string
UsageExport
idUsageExportId
accountIdAccountId
windowUsageWindow
formatUsageExportFormat
meterKeysUsageMeterKey[]
linesUsageExportLine[]
entryCountnumber
firstSequence?string
lastSequence?string
generatedAtstring
UsageExportFormat

"csv" | "json"

UsageExportId

string

UsageExportLine
meterKeyUsageMeterKey
unitUsageUnit
subjectKey?string
grossstring
adjustmentsstring
netstring
entryCountnumber
UsageIdempotencyKey

string

UsageJson

boolean | string | number | UsageJson[] | map<string, UsageJson> | null

UsageLedgerEntryDto
accountIdAccountId
idUsageLedgerEntryId
sourceUsageSourceRef
quantityUsageQuantity
subjectUsageSubject
evidenceUsageEvidenceRef[]
meterKeyUsageMeterKey
meterVersionnumber
windowUsageWindow
entryKindUsageLedgerEntryKind
effectiveQuantityUsageQuantity
dimensionsUsageDimensions
idempotencyKeyUsageIdempotencyKey
occurredAtstring
recordedAtstring
reversedEntryId?UsageLedgerEntryId
adjustmentForEntryId?UsageLedgerEntryId
metadata?boolean | string | number | UsageJson[] | map<string, UsageJson> | null
sequencestring
UsageLedgerEntryId

string

UsageLedgerEntryKind

"adjustment" | "counter_rebuild_marker" | "reservation_committed" | "reservation_created" | "reservation_expired" | "reservation_released" | "reversal" | "usage"

UsageLedgerPageDto
entriesUsageLedgerEntryDto[]
nextAfterSequence?string
UsageMeterDefinition
keyUsageMeterKey
versionnumber
displayNamestring
descriptionstring
unitUsageUnit
aggregationUsageAggregation
windowingUsageWindowing
subjectKindUsageSubjectKind
dimensionality"actorKind" | "actorRole" | "connectionType" | "featureKey" | "jobId" | "jobKind" | "planKey" | "provider" | "providerAccountId" | "providerRegion" | "resourceType" | "runtimeProfile" | "sourceId" | "sourceKind" | "viewTemplateId" | "workspaceId"[]
billableboolean
quotaImpactingboolean
exportableboolean
effectiveFromstring
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
valuestring
unitUsageUnit
scale?number
UsageReconciliationRunId

string

UsageReservation
idUsageReservationId
accountIdAccountId
subjectUsageSubject
meterKeyUsageMeterKey
meterVersionnumber
windowUsageWindow
quantityUsageQuantity
committedQuantity?UsageQuantity
statusUsageReservationStatus
idempotencyKeyUsageIdempotencyKey
expiresAtstring
sourceUsageSourceRef
createdAtstring
committedAt?string
releasedAt?string
expiredAt?string
UsageReservationId

string

UsageReservationStatus

"active" | "committed" | "expired" | "released"

UsageSourceRef

object | object | object | object | object | object

UsageSubject
kindUsageSubjectKind
accountIdAccountId
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
kindUsageWindowKind
startsAtstring
endsAtstring
timezone?string
UsageWindowKind

"billing_period" | "day" | "hour" | "instant" | "month" | "rolling" | "week"

UsageWindowing
kindUsageWindowKind
timezone?string
UserId

string

UserNotificationRecipient
kind"user"
userIdUserId
accountIdAccountId
ViewAccessGrantCreateResult
grantViewAccessGrantSummary
existingboolean
ViewAccessGrantId

string

ViewAccessGrantReceived
grantViewAccessGrantSummary
viewNamestring
via"role" | "user"
ViewAccessGrantRevokeResult
ViewAccessGrantSummary
idViewAccessGrantId
accountIdAccountId
workspaceIdWorkspaceId
environmentIdEnvironmentId
viewIdViewId
granteeViewAccessGrantee
createdByUserIdUserId
createdAtstring (date-time)
revokedAtstring (date-time) | null
ViewAccessGrantee

object | object

ViewAccessGrantsListResult
ViewAccessGrantsReceivedListResult
ViewByAccountItemDto
idstring
namestring
originstring
environmentIdstring
environmentNamestring
workspaceIdstring
workspaceNamestring
createdAtstring
providersstring[]
ViewChangeSubject
kind"view"
viewIdViewId
ViewConfigurationHttpItem
idstring
viewIdstring
viewTemplateVersionIdstring
parametersmap<string, any>
configurationHashstring
createdAtstring
ViewHttpItem
idstring
environmentIdstring
namestring
originstring
createdAtstring
ViewId

string

ViewNotificationSubject
kind"view"
workspaceIdWorkspaceId
viewIdViewId
viewRevisionId?ViewRevisionId
displayNamestring
ViewRevisionArtifactHttpItem
kindstring
contentBlobShastring
artifactHashstring
contentTypestring
byteLengthnumber
ViewRevisionHttpItem
idstring
viewIdstring
viewConfigurationIdstring
viewTemplateVersionIdstring
environmentRevisionIdstring
workspaceGraphRevisionIdstring
inputHashstring
visualGraphModelHashstring
layoutHashstring
statusstring
artifactsViewRevisionArtifactHttpItem[]
createdAtstring
ViewRevisionId

string

ViewShareCreateResult
shareViewShareSummary
tokenstring
ViewShareId

string

ViewShareRevokeResult
ViewShareSummary
idViewShareId
accountIdAccountId
workspaceIdWorkspaceId
environmentIdEnvironmentId
viewIdViewId
targetViewShareTarget
createdByUserIdUserId
createdAtstring (date-time)
expiresAtstring (date-time) | null
revokedAtstring (date-time) | null
ViewShareTarget

object | object

ViewSharesListResult
ViewSourceModelBuildHttpResponse
viewConfigurationIdstring
viewTemplateVersionIdstring
environmentRevisionIdstring
workspaceGraphRevisionIdstring
templateKeystring
templateVersionstring
resourceCountnumber
connectionCountnumber
sourceModelSourceModel
template?any
contextQuery?any
options?{ showRoutes?: boolean }
diagrammarEnabledboolean
ViewTemplateCreateHttpResponse
idstring
accountIdstring | null
templateKeystring
displayNamestring
createdAtstring
createdboolean
ViewTemplateHttpItem
idstring
accountIdstring | null
templateKeystring
displayNamestring
createdAtstring
ViewTemplateId

string

ViewTemplateVersionCreateHttpResponse
idstring
viewTemplateIdstring
versionstring
statusstring
templateHashstring
createdAtstring
ViewTemplateVersionHttpItem
idstring
viewTemplateIdstring
versionstring
statusstring
templateHashstring
createdAtstring
WasteFinding
idWasteFindingId
workspaceIdWorkspaceId
subjectCostSubject
kindWasteFindingKind
titlestring
summarystring
estimatedMonthlyWasteMoney | null
actualWindowWasteMoney | null
severityCostSeverity
confidenceCostConfidence
evidenceCostEvidence[]
recommendationIdsCostRecommendationId[]
firstDetectedAtstring
lastDetectedAtstring
statusWasteFindingStatus
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
WebhookDeliverySummary
idstring
subscriptionIdstring
accountIdAccountId
eventIdstring
eventTypestring
status"dead" | "delivered" | "failed" | "pending"
attemptsnumber
maxAttemptsnumber
nextAttemptAtTimestampIso | null
lastErrorstring | null
createdAtTimestampIso
updatedAtTimestampIso
WebhookEventTypeListResult
eventTypesstring[]
WebhookSubscription
idstring
accountIdAccountId
urlstring
description?string
enabledboolean
eventTypesstring[]
secretRefstring
createdAtTimestampIso
updatedAtTimestampIso
disabledAt?TimestampIso | null
WebhookSubscriptionCreateResult
subscriptionWebhookSubscription
signingSecretstring
WebhookSubscriptionDeleteResult
idstring
WebhookSubscriptionGetResult
WebhookSubscriptionListResult
subscriptionsWebhookSubscription[]
WebhookSubscriptionRotateSecretResult
subscriptionWebhookSubscription
signingSecretstring
WebhookSubscriptionUpdateResult
WorkspaceAccessDto
workspaceIdstring
workspaceActionsmap<string, boolean>
accountActionsmap<string, boolean>
WorkspaceArchiveResult
WorkspaceChangeSubject
kind"workspace"
workspaceIdWorkspaceId
WorkspaceChangesListResult
itemsChangeItem[]
nextCursorstring | null
WorkspaceCostAnalyzeResult
workspaceIdWorkspaceId
windowCostWindow
currencystring
summaryCostSummary
rollupsCostRollup[]
wasteWasteFinding[]
recommendationsCostRecommendation[]
coverageCostCoverageResult
diagnosticsCostDiagnostic[]
generatedAtstring
WorkspaceCostSubject
kind"workspace"
workspaceIdWorkspaceId
WorkspaceDto
idstring
accountIdstring
namestring
createdAtstring
archivedAtstring | null
WorkspaceGraphCounts
workspaceIdWorkspaceId
revisionIdWorkspaceGraphRevisionId
resourceCountnumber
connectionCountnumber
environmentCountnumber
countsBySemanticTypemap<string, number>
computedAtstring
WorkspaceGraphRevisionId

string

WorkspaceId

string

WorkspaceListItemDto
idstring
accountIdstring
namestring
createdAtstring
archivedAtstring | null
WorkspaceNotificationRecipient
kind"workspace"
workspaceIdWorkspaceId
accountIdAccountId
WorkspaceNotificationSubject
kind"workspace"
workspaceIdWorkspaceId
displayNamestring
WorkspaceProjection
idWorkspaceId
accountIdAccountId
namestring
createdAtstring (date-time)
archivedAtstring (date-time) | null
isArchivedboolean
WorkspaceSourceModelBuildHttpResponse
workspaceIdstring
workspaceGraphRevisionIdstring
resourceCountnumber
connectionCountnumber
sourceModelSourceModel
WorkspaceSyncRunDiagnosticsListHttpResponse
itemsSyncDiagnosticWire[]
nextAfterSeqnumber | null
WorkspaceSyncRunId

string

WorkspaceSyncRunSourceFailure
sourceIdstring
status"cancelled" | "partial" | "rejected"
reasonstring | null
WorkspaceUnarchiveResult
workspaceWorkspaceProjection
archivedSourceIdsSourceId[]
kumo-billing.EntitlementScope

"account" | "provider" | "source" | "tenant" | "workspace"

kumo-contracts.ActorContext
userIdUserId
accountIdAccountId
workspaceId?WorkspaceId
credentialScope?"read" | "read_write"
kumo-contracts.ActorRef
kind"api_key" | "scheduler" | "service" | "system" | "user"
idstring
displayName?string
kumo-contracts.EntitlementKind

"allowlist" | "configuration" | "credit" | "flag" | "limit"

kumo-contracts.EntitlementScope

"account" | "deployment" | "source" | "user" | "workspace"

kumo-contracts.JsonArray

kumo-contracts.JsonValue[]

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
kumo-cost-analysis.ActorRef
userIdUserId
accountIdAccountId

Admin API

Control-plane, operator-facing: tenant lifecycle, jobs, provider health, licensing, billing administration. Separate server, separate credentials.

125
routes
36
areas
125
stable
0
preview

Billing · 23 routes

MethodPathTier2xx
GET
/v1/admin/billing/accounts/{accountId}/credit-grants

Response 200 { data: { grants: BillingCreditGrantRecord[] }; meta }

stable200
POST
/v1/admin/billing/accounts/{accountId}/credit-grants

Request body CreditGrantCreateBody

amount?number
reason?string
meterKey?string
expiresAt?string

Response 201 { data: BillingCreditGrantRecord; meta }

idstring
accountIdAccountId
meterKeystring | null
amountnumber
remainingnumber
statusBillingCreditGrantStatus
reasonstring
grantedAtstring
expiresAtstring | null
stable201
GET
/v1/admin/billing/accounts/{accountId}/invoices

Query

limit?string

Response 200 { data: { invoices: BillingInvoiceRecord[] }; meta }

stable200
GET
/v1/admin/billing/accounts/{accountId}/payment-methods

Response 200 { data: { paymentMethods: BillingPaymentMethodRecord[] }; meta }

stable200
POST
/v1/admin/billing/accounts/{accountId}/subscription-sync

Response 200 { data: { observed: number; changes: object[] }; meta }

observednumber
changes{ subscriptionId: SubscriptionId; previousStatus: "active" | "cancelled" | "expired" | "incomplete" | "past_due" | "paused" | "suspended" | "trialing" | null; status: SubscriptionStatus }[]
stable200
GET
/v1/admin/billing/accounts/{accountId}/subscriptions

Response 200 { data: { subscriptions: BillingSubscriptionRecord[] }; meta }

stable200
POST
/v1/admin/billing/accounts/{accountId}/subscriptions

Request body SubscriptionAssignBody

planKey?string
currentPeriodStart?string
currentPeriodEnd?string | null

Response 200 { data: { subscription: BillingSubscriptionRecord; changed: boolean }; meta }

subscriptionBillingSubscriptionRecord
changedboolean
stable200
GET
/v1/admin/billing/accounts/{accountId}/trial

Response 200 { data: { trial: BillingTrialRecord | null }; meta }

trialBillingTrialRecord | null
stable200
POST
/v1/admin/billing/accounts/{accountId}/trial

Request body TrialStartBody

planKey?string
days?number
endsAt?string

Response 201 { data: { trial: BillingTrialRecord; subscription: BillingSubscriptionRecord }; meta }

stable201
POST
/v1/admin/billing/credit-grants/{creditGrantId}/expire

Response 200 { data: BillingCreditGrantRecord; meta }

idstring
accountIdAccountId
meterKeystring | null
amountnumber
remainingnumber
statusBillingCreditGrantStatus
reasonstring
grantedAtstring
expiresAtstring | null
stable200
POST
/v1/admin/billing/plan-versions/{planVersionId}/publish

Request body PlanVersionPublishBody

makeCurrent?boolean

Response 200 { data: { planVersion: BillingPlanVersionRecord; planCurrentVersionId: PlanVersionId | null }; meta }

planVersionBillingPlanVersionRecord
planCurrentVersionIdPlanVersionId | null
stable200
GET
/v1/admin/billing/plans

Response 200 { data: { plans: BillingPlanRecord[] }; meta }

stable200
POST
/v1/admin/billing/plans

Request body PlanCreateBody

planKey?string
displayName?string

Response 201 { data: BillingPlanRecord; meta }

idstring
planKeystring
displayNamestring
statusBillingPlanStatus
currentVersionIdstring | null
createdAtstring
updatedAtstring
stable201
GET
/v1/admin/billing/plans/{planId}

Response 200 { data: BillingPlanRecord; meta }

idstring
planKeystring
displayNamestring
statusBillingPlanStatus
currentVersionIdstring | null
createdAtstring
updatedAtstring
stable200
POST
/v1/admin/billing/plans/{planId}/activate

Response 200 { data: BillingPlanRecord; meta }

idstring
planKeystring
displayNamestring
statusBillingPlanStatus
currentVersionIdstring | null
createdAtstring
updatedAtstring
stable200
GET
/v1/admin/billing/plans/{planId}/versions

Response 200 { data: { planVersions: BillingPlanVersionRecord[] }; meta }

stable200
POST
/v1/admin/billing/plans/{planId}/versions

Request body PlanVersionDraftBody

entitlements?BillingEntitlementGrantInput[]
effectiveFrom?string

Response 201 { data: BillingPlanVersionRecord; meta }

idstring
planIdstring
versionnumber
statusBillingPlanVersionStatus
entitlementsBillingEntitlementRecord[]
effectiveFromstring
effectiveTostring | null
createdAtstring
publishedAtstring | null
stable201
GET
/v1/admin/billing/reconciliation-runs

Response 200 { data: { runs: BillingReconciliationRunRecord[] }; meta }

stable200
POST
/v1/admin/billing/reconciliation-runs

Request body ReconciliationRunStartBody

accountId?string
dryRun?boolean

Response 201 { data: { run: BillingReconciliationRunRecord; accounts: number; accountFailures: number }; meta }

runBillingReconciliationRunRecord
accountsnumber
accountFailuresnumber
stable201
GET
/v1/admin/billing/reconciliation-runs/{runId}

Response 200 { data: BillingReconciliationRunRecord; meta }

idstring
providerstring
accountIdAccountId | null
statusBillingReconciliationRunStatus
dryRunboolean
mismatchCountnumber
startedAtstring
completedAtstring | null
failureReasonstring | null
stable200
POST
/v1/admin/billing/seed-plans

Response 200 { data: CommercialCatalogSeedReport; meta }

catalog{ catalogKey: string; action: CommercialCatalogSeedCatalogAction; version: number | null }
billingPlansHostedPlanProjectionOutcome[]
registry{ features: number; meters: number }
plans{ created: number; updated: number; unchanged: number }
stable200
POST
/v1/admin/billing/trials/{trialStateId}/convert

Response 200 { data: { trial: BillingTrialRecord; subscription: BillingSubscriptionRecord }; meta }

stable200
POST
/v1/admin/billing/trials/{trialStateId}/expire

Response 200 { data: { trial: BillingTrialRecord; subscription: BillingSubscriptionRecord }; meta }

stable200

Entitlements · 12 routes

MethodPathTier2xx
GET
/v1/admin/entitlements/accounts/{accountId}

Response 200 { data: AdminEntitlementsResolveResponseDto; meta }

accountIdstring
workspaceIdstring | null
entitlementsAdminEntitlementDto[]
warningsAdminWarningDto[]
evaluatedAtstring
cacheKeystring
stable200
GET
/v1/admin/entitlements/accounts/{accountId}/explain/{featureKey}

Response 200 { data: AdminEntitlementExplainResponseDto; meta }

accountIdstring
featureKeystring
entitlementAdminEntitlementDto | null
summarystring
stepsAdminEntitlementExplainStepDto[]
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 }
stable200
GET
/v1/admin/entitlements/accounts/{accountId}/features/{featureKey}

Response 200 { data: AdminFeatureAccessResponseDto; meta }

accountIdstring
featureKeystring
allowedboolean
reasonCodeEntitlementReasonCode
reasonMessagestring
entitlementAdminEntitlementDto | null
gatesAdminGateResultDto[]
evaluatedAtstring
cacheKeystring
stable200
GET
/v1/admin/entitlements/accounts/{accountId}/overrides

Response 200 { data: AdminOverridesListResponseDto; meta }

grantsAdminOverrideGrantDto[]
versionstring | null
updatedAtstring | null
stable200
DELETE
/v1/admin/entitlements/accounts/{accountId}/overrides/{featureKey}

Request body

reason?string

Response 200 { data: { removed: boolean; overrideVersion: string | null }; meta }

removedboolean
overrideVersionstring | null
stable200
POST
/v1/admin/entitlements/accounts/{accountId}/overrides/{featureKey}

Request body 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

Response 200 { data: { overrideId: EntitlementOverrideId; grantId: EntitlementGrantId; overrideVersion: string }; meta }

overrideIdEntitlementOverrideId
grantIdEntitlementGrantId
overrideVersionstring
stable200
POST
/v1/admin/entitlements/snapshots

Request body SnapshotCreateBody

accountId?string
workspaceId?string
label?string
notes?string
at?string

Response 201 { data: AdminSnapshotCreateResponseDto; meta }

snapshotIdstring
accountIdstring
workspaceIdstring | null
evaluatedAtstring
createdAtstring
labelstring | null
entitlementCountnumber
stable201
POST
/v1/admin/entitlements/snapshots/diff

Request body SnapshotDiffBody

fromSnapshotId?string
toSnapshotId?string
accountId?string
workspaceId?string
beforeAt?string
afterAt?string
includeUnchanged?boolean

Response 200 { data: AdminSnapshotDiffResponseDto; meta }

fromSnapshotIdstring | null
toSnapshotIdstring | null
accountIdstring
workspaceIdstring | null
evaluatedAtstring
entriesAdminSnapshotDiffEntryDto[]
summary{ totalChanges: number; breakingCount: number; improvementCount: number; neutralCount: number; gainedCount: number; lostCount: number; changedCount: number }
stable200
GET
/v1/admin/entitlements/workspaces/{workspaceId}

Query

accountId?string

Response 200 { data: AdminEntitlementsResolveResponseDto; meta }

accountIdstring
workspaceIdstring | null
entitlementsAdminEntitlementDto[]
warningsAdminWarningDto[]
evaluatedAtstring
cacheKeystring
stable200
GET
/v1/admin/entitlements/workspaces/{workspaceId}/overrides

Query

accountId?string

Response 200 { data: AdminOverridesListResponseDto; meta }

grantsAdminOverrideGrantDto[]
versionstring | null
updatedAtstring | null
stable200
DELETE
/v1/admin/entitlements/workspaces/{workspaceId}/overrides/{featureKey}

Request body

accountId?string
reason?string

Response 200 { data: { removed: boolean; overrideVersion: string | null }; meta }

removedboolean
overrideVersionstring | null
stable200
POST
/v1/admin/entitlements/workspaces/{workspaceId}/overrides/{featureKey}

Request body

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
accountId?string

Response 200 { data: { overrideId: EntitlementOverrideId; grantId: EntitlementGrantId; overrideVersion: string }; meta }

overrideIdEntitlementOverrideId
grantIdEntitlementGrantId
overrideVersionstring
stable200

Plans · 9 routes

MethodPathTier2xx
GET
/v1/admin/plans

Query

familyKey?string
lifecycle?string
limit?string
cursor?string

Response 200 { data: PlanDefinition[]; page; meta }

planKeystring
familyKeystring
displayNamestring
description?string
tierPlanTier
lifecyclePlanLifecycle
currentVersionnumber
visibleInSignupboolean
visibleInAdminboolean
selfServePurchaseAllowedboolean
trial?{ days: number; signupDefault: boolean }
versionsPlanVersionDefinition[]
tagsstring[]
metadatakumo-contracts.JsonObject
stable200
POST
/v1/admin/plans

Request body CreatePlanRequestBody

planKeystring
familyKeystring
displayNamestring
description?string
tierPlanTier
lifecycle?"active" | "deprecated" | "draft" | "hidden" | "retired"
visibleInSignup?boolean
visibleInAdmin?boolean
selfServePurchaseAllowed?boolean
tags?string[]
metadata?kumo-contracts.JsonObject

Response 201 { data: PlanCreateResult; meta }

stable201
POST
/v1/admin/plans/{fromPlanKey}/migration-path

Request body ResolveMigrationPathRequestBody

fromVersion?number
targetPlanKeystring
targetVersion?"current" | number

Response 200 { data: PlanMigrationPathResolveResult; meta }

fromPlanKeystring
fromVersionnumber
resolutionMigrationResolution
pinnedTargetVersion?number
stable200
GET
/v1/admin/plans/{planKey}

Response 200 { data: PlanGetResult; meta }

planPlanDefinition | null
stable200
POST
/v1/admin/plans/{planKey}/compatibility-check

Request body CheckCompatibilityRequestBody

version?number
contextCompatibilityContext

Response 200 { data: PlanCompatibilityCheckResult; meta }

planKeystring
versionnumber
evaluationCompatibilityEvaluation
stable200
POST
/v1/admin/plans/{planKey}/versions

Request body 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

Response 201 { data: PlanVersionDraftCreateResult; meta }

stable201
POST
/v1/admin/plans/{planKey}/versions/{version}/deprecate

Response 200 { data: PlanVersionDeprecateResult; meta }

stable200
POST
/v1/admin/plans/{planKey}/versions/{version}/publish

Request body PublishPlanVersionRequestBody

setCurrent?boolean

Response 200 { data: PlanVersionPublishResult; meta }

stable200
GET
/v1/admin/plans/{planKey}/versions/{version}/resolve

Response 200 { data: PlanVersionResolveResult; meta }

stable200

Accounts · 7 routes

MethodPathTier2xx
GET
/v1/admin/accounts

Query

search?string
status?string
limit?string
cursor?string

Response 200 { data: AdminTenantDto[]; page; meta }

idstring
slugstring
displayNamestring
statusstring
createdAtstring
updatedAtstring
suspendedAtstring | null
stable200
GET
/v1/admin/accounts/{accountId}

Response 200 { data: AdminTenantGetResult; meta }

tenantAdminTenantDto | null
stable200
DELETE
/v1/admin/accounts/{accountId}/deletion

Request body ReasonBody

reason?string

Response 200 { data: AdminTenantDeletionCancelResult; meta }

requestAdminTenantDeletionDto | null
auditEventIdstring | null
stable200
POST
/v1/admin/accounts/{accountId}/deletion

Request body ReasonBody

reason?string

Response 200 { data: AdminTenantDeletionStartResult; meta }

requestAdminTenantDeletionDto | null
auditEventIdstring | null
stable200
POST
/v1/admin/accounts/{accountId}/reactivate

Request body ReasonBody

reason?string

Response 200 { data: AdminTenantReactivateResult; meta }

tenantAdminTenantDto | null
auditEventIdstring | null
stable200
GET
/v1/admin/accounts/{accountId}/summary

Response 200 { data: AdminAccountSummaryGetResult; meta }

stable200
POST
/v1/admin/accounts/{accountId}/suspend

Request body ReasonBody

reason?string

Response 200 { data: AdminTenantSuspendResult; meta }

tenantAdminTenantDto | null
auditEventIdstring | null
stable200

License · 7 routes

MethodPathTier2xx
DELETE
/v1/admin/license

Response 200 { data: LicenseDiagnostics; meta }

installedboolean
statusLicenseStatus
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
featuresLicenseFeatureDiagnostic[]
limitsLicenseLimitDiagnostic[]
warningsLicenseWarning[]
lastVerifiedAt?string
activeKeyId?string
lockout?LicenseLockout
stable200
GET
/v1/admin/license

Response 200 { data: LicenseDiagnostics; meta }

installedboolean
statusLicenseStatus
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
featuresLicenseFeatureDiagnostic[]
limitsLicenseLimitDiagnostic[]
warningsLicenseWarning[]
lastVerifiedAt?string
activeKeyId?string
lockout?LicenseLockout
stable200
POST
/v1/admin/license

Request body LicenseInstallInputDto

documentTextstring

Response 200 { data: LicenseDiagnostics; meta }

installedboolean
statusLicenseStatus
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
featuresLicenseFeatureDiagnostic[]
limitsLicenseLimitDiagnostic[]
warningsLicenseWarning[]
lastVerifiedAt?string
activeKeyId?string
lockout?LicenseLockout
stable200
POST
/v1/admin/license/activation-apply

Request body LicenseActivationApplyInputDto

receiptTextstring

Response 200 { data: LicenseDiagnostics; meta }

installedboolean
statusLicenseStatus
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
featuresLicenseFeatureDiagnostic[]
limitsLicenseLimitDiagnostic[]
warningsLicenseWarning[]
lastVerifiedAt?string
activeKeyId?string
lockout?LicenseLockout
stable200
POST
/v1/admin/license/activation-request

Request body LicenseActivationRequestInputDto

customerIdstring
customerContact?string
requestedEdition?string
requestedFeatures?string[]
notes?string

Response 200 { data: LicenseActivationRequestDto; meta }

schemastring
requestIdstring
customerIdstring
customerContact?string
fingerprint{ schema: string; installationId: string; deploymentKind: string; generatedAt: string; hostHints?: object }
requestedEdition?string
requestedFeatures?string[]
notes?string
createdAtstring
stable200
GET
/v1/admin/license/fingerprint

Response 200 { data: AdminInstallationFingerprintDto; meta }

schemastring
installationIdstring
deploymentKindstring
generatedAtstring
hostHints?{ clusterUidHash?: string; machineIdHash?: string; namespace?: string }
stable200
POST
/v1/admin/license/mint-test

Request body LicenseMintTestInputDto

edition?string
customerId?string
customerName?string
expiresAt?string | null
features?{ feature: string; mode?: "allow" | "deny" }[]

Response 200 { data: { documentText: string; licenseId: string; signedByKeyId: string }; meta }

documentTextstring
licenseIdstring
signedByKeyIdstring
stable200

Plan catalogs · 7 routes

MethodPathTier2xx
GET
/v1/admin/plan-catalogs

Query

catalogKey?string
status?string
limit?string
cursor?string

Response 200 { data: PlanCatalog[]; page; meta }

catalogIdPlanCatalogId
catalogKeystring
versionnumber
statusPlanCatalogStatus
displayNamestring
description?string
featuresFeatureDefinition[]
metersMeterDefinition[]
planFamiliesPlanFamilyDefinition[]
plansPlanDefinition[]
addonsAddonDefinition[]
skusSkuDefinition[]
currencyDefaultsCurrencyCode[]
effectiveFromstring
effectiveTo?string | null
provenanceCatalogProvenance
integrityCatalogIntegrity
stable200
POST
/v1/admin/plan-catalogs

Request body CreateCatalogRequestBody

catalogKeystring
displayNamestring
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[]

Response 201 { data: PlanCatalogCreateResult; meta }

stable201
GET
/v1/admin/plan-catalogs/{catalogId}

Response 200 { data: PlanCatalogGetResult; meta }

catalogPlanCatalog | null
stable200
POST
/v1/admin/plan-catalogs/{catalogId}/deprecate

Response 200 { data: { auditEventId: string }; meta }

auditEventIdstring
stable200
POST
/v1/admin/plan-catalogs/{catalogId}/publish

Response 200 { data: { auditEventId: string }; meta }

auditEventIdstring
stable200
POST
/v1/admin/plan-catalogs/{catalogId}/validate

Response 200 { data: PlanCatalogValidateResult; meta }

stable200
POST
/v1/admin/plan-catalogs/diff

Request body DiffCatalogsRequestBody

fromCatalogIdPlanCatalogId
toCatalogIdPlanCatalogId

Response 200 { data: PlanCatalogDiffOutput; meta }

stable200

Auth · 6 routes

MethodPathTier2xx
GET
/v1/admin/auth/oidc/callback

Query

code?string
state?string

Response 200

subjectstring
handoffCodestring
stable200
GET
/v1/admin/auth/oidc/login

Response 302 no body

stable
POST
/v1/admin/auth/saml/{realmId}/acs

Request body AcsBody

SAMLResponse?string
RelayState?string

Response 200

outcome"authenticated"
principal{ email?: string; nameId: string }
samlConfigurationIdSamlConfigurationId
handoffCodestring
stable200
GET
/v1/admin/auth/saml/{realmId}/login

Query

returnTo?string

Response 302 no body

stable
GET
/v1/admin/auth/saml/{realmId}/metadata

Response 200 application/samlmetadata+xml (file or stream)

stable200
POST
/v1/admin/auth/saml/session-handoff

Request body

code?string

Response 200

tokenstring
subjectstring
stable200

Usage · 6 routes

MethodPathTier2xx
POST
/v1/admin/usage/adjust

Request body AdjustBody

accountId?string
workspaceId?string
meterKey?string
quantity?UsageQuantity
reason?string
windowStartsAt?string
windowEndsAt?string
adjustedEntryId?string
idempotencyKey?string

Response 200 { data: { diagnostics: UsageDiagnostic[]; adjustment?: UsageAdjustment; accepted: boolean; duplicate: boolean }; meta }

diagnosticsUsageDiagnostic[]
adjustment?UsageAdjustment
acceptedboolean
duplicateboolean
stable200
POST
/v1/admin/usage/export

Request body ExportBody

windowStartsAt?string
windowEndsAt?string
format?"csv" | "json"
bySubject?boolean
accountId?string
meterKeys?string[]

Response 200 { data: { export: UsageExport; content: string }; meta }

exportUsageExport
contentstring
stable200
POST
/v1/admin/usage/rebuild-counters

Request body RebuildBody

apply?boolean
accountId?string
meterKeys?string[]

Response 200 { data: UsageRebuildCountersResult; meta }

checkednumber
driftednumber
appliednumber
findingsUsageReconciliationFinding[]
diagnosticsUsageDiagnostic[]
stable200
POST
/v1/admin/usage/reconcile

Request body AccountBody

accountId?string
meterKeys?string[]

Response 200 { data: { run: UsageReconciliationRun; diagnostics: UsageDiagnostic[] }; meta }

stable200
GET
/v1/admin/usage/reconciliation-runs

Query

accountId?string
limit?string

Response 200 { data: UsageReconciliationRun[]; page; meta }

idUsageReconciliationRunId
accountIdAccountId
checkedCountersnumber
consistentboolean
findingsUsageReconciliationFinding[]
startedAtstring
completedAtstring
stable200
POST
/v1/admin/usage/reverse

Request body ReverseBody

entryId?string
reason?string
idempotencyKey?string

Response 200 { data: { diagnostics: UsageDiagnostic[]; reversalEntryId?: UsageLedgerEntryId; accepted: boolean; duplicate: boolean }; meta }

diagnosticsUsageDiagnostic[]
reversalEntryId?UsageLedgerEntryId
acceptedboolean
duplicateboolean
stable200

Jobs · 5 routes

MethodPathTier2xx
GET
/v1/admin/jobs

Query

status?string
kind?string
queue?string
accountId?string
workspaceId?string
limit?string
cursor?string

Response 200 { data: AdminJobDto[]; page; meta }

idstring
kindstring
queuestring | null
status"cancelled" | "cancelling" | "dead_lettered" | "failed" | "queued" | "running" | "scheduled" | "succeeded"
scopeJobScope
requestedByJobRequester
attemptNumbernumber
attemptsExhaustedboolean
leasedBystring | null
leaseExpiresAtstring | null
progressJobProgress | null
cancellationJobCancellation | null
failureJobFailure | null
createdAtstring
updatedAtstring
startedAtstring | null
completedAtstring | null
notBeforestring | null
stable200
GET
/v1/admin/jobs/{jobId}

Response 200 { data: AdminJobGetResult; meta }

jobAdminJobDto | null
attemptsJobAttempt[]
stable200
POST
/v1/admin/jobs/{jobId}/cancel

Request body MutateBody

reason?string

Response 200 { data: AdminJobCancelResult; meta }

jobAdminJobDto
auditEventIdstring
stable200
POST
/v1/admin/jobs/{jobId}/retry

Request body MutateBody

reason?string

Response 200 { data: AdminJobRetryResult; meta }

jobAdminJobDto
auditEventIdstring
stable200
GET
/v1/admin/jobs/queue-health

Query

queue?string
accountId?string
workspaceId?string

Response 200 { data: AdminQueueHealthResult; meta }

countsByStatus{ cancelled: number; running: number; failed: number; succeeded: number; queued: number; scheduled: number; cancelling: number; dead_lettered: number }
stable200

Notifications · 4 routes

MethodPathTier2xx
GET
/v1/admin/notifications/deliveries

Query

status?string
channel?string
notificationId?string
failed?string
limit?string

Response 200 { data: NotificationDeliveryDto[]; page; meta }

idstring
notificationIdstring
recipientNotificationIdstring | null
channelstring
destinationNotificationDestination
statusstring
idempotencyKeystring
attemptCountnumber
scheduledAtstring
lastAttemptedAtstring | null
deliveredAtstring | null
failedAtstring | null
failure?NotificationDeliveryFailure | null
stable200
GET
/v1/admin/notifications/deliveries/{deliveryId}

Response 200 { data: NotificationDeliveryTrailDto; meta }

stable200
POST
/v1/admin/notifications/deliveries/{deliveryId}/retry

Response 200 { data: { delivery: NotificationDeliveryDto; outcome: DispatchOutcome; retried: boolean }; meta }

deliveryNotificationDeliveryDto
outcomeDispatchOutcome
retriedboolean
stable200
GET
/v1/admin/notifications/diagnostics

Query

notificationId?string

Response 200 { data: { notification: NotificationDto; recipients: RecipientNotificationDto[]; deliveries: NotificationDeliveryTrailDto[]; diagnostics: NotificationDiagnosticDto[] }; meta }

stable200

Partners · 4 routes

MethodPathTier2xx
GET
/v1/admin/partners

Response 200 { data: { partners: Partner[] }; meta }

partnersPartner[]
stable200
POST
/v1/admin/partners

Request body kumo-core-server-admin.CreateBody

name?string
domains?string[]
branding?PartnerBranding
provisioning?PartnerProvisioningPolicy

Response 201 { data: { partner: Partner }; meta }

partnerPartner
stable201
PATCH
/v1/admin/partners/{partnerId}

Request body UpdateBody

name?string
status?"active" | "disabled"
domains?string[]
branding?PartnerBranding
provisioning?PartnerProvisioningPolicy

Response 200 { data: { partner: Partner }; meta }

partnerPartner
stable200
GET
/v1/admin/partners/{partnerId}/accounts

Query

limit?string

Response 200 { data: { partnerId: string; accounts: object[] }; meta }

partnerIdstring
accounts{ accountId: string; userId: string; attributedAt: string }[]
stable200

Post sync jobs · 4 routes

MethodPathTier2xx
GET
/v1/admin/post-sync-jobs

Query

status?string
limit?string

Response 200 { data: WgrPostSyncJobsListByStatusResult; meta }

stable200
GET
/v1/admin/post-sync-jobs/{jobId}

Response 200 { data: WgrPostSyncJobGetResult; meta }

jobWgrPostSyncJob | null
stable200
POST
/v1/admin/post-sync-jobs/{jobId}/retry

Request body RetryBody

reason?string

Response 200 { data: WgrPostSyncJobRetryFailedResult; meta }

requeuedtrue
auditEventIdstring
stable200
GET
/v1/admin/post-sync-jobs/count

Query

status?string

Response 200 { data: WgrPostSyncJobsCountByStatusResult; meta }

countnumber
stable200

Features · 3 routes

MethodPathTier2xx
GET
/v1/admin/features

Query

category?string

Response 200 { data: FeaturesListResult; meta }

stable200
POST
/v1/admin/features

Request body DefineFeatureRequestBody

Response 201 { data: FeatureDefineResult; meta }

stable201
GET
/v1/admin/features/{featureKey}

Response 200 { data: FeatureGetResult; meta }

featureFeatureDefinition | null
stable200

Meters · 3 routes

MethodPathTier2xx
GET
/v1/admin/meters

Query

subjectScope?string

Response 200 { data: MetersListResult; meta }

stable200
POST
/v1/admin/meters

Request body DefineMeterRequestBody

Response 201 { data: MeterDefineResult; meta }

stable201
GET
/v1/admin/meters/{meterKey}

Response 200 { data: MeterGetResult; meta }

meterMeterDefinition | null
stable200

Analytics · 2 routes

MethodPathTier2xx
GET
/v1/admin/analytics

Query

since?string
until?string
accountId?string

Response 200 { data: AdminAnalyticsRollupGetResult; meta }

stable200
GET
/v1/admin/analytics/series

Query

bucket?string
since?string
until?string
accountId?string

Response 200 { data: AdminAnalyticsSeriesGetResult; meta }

stable200

Feature flags · 2 routes

MethodPathTier2xx
GET
/v1/admin/feature-flags/{accountId}

Response 200 { data: AdminFeatureFlagsListResult; meta }

stable200
PUT
/v1/admin/feature-flags/{accountId}/{key}

Request body SetBody

enabled?any
reason?any

Response 200 { data: AdminFeatureFlagSetResult; meta }

flagAdminFeatureFlagStateDto
auditEventIdstring
stable200

Storage · 2 routes

MethodPathTier2xx
GET
/v1/admin/storage/history

Query

limit?string

Response 200 { data: AdminStorageHistoryGetResult; meta }

stable200
POST
/v1/admin/storage/snapshots

Request body SnapshotPgStorageBody

analyze?boolean

Response 200 { data: StorageUsageSnapshotGetResult; meta }

snapshotStorageUsageSnapshot
capacityBytesnumber | null
stable200

Account deletions · 1 routes

MethodPathTier2xx
GET
/v1/admin/account-deletions

Query

limit?string

Response 200 { data: AdminTenantDeletionsListResult; meta }

stable200

Audit · 1 routes

MethodPathTier2xx
GET
/v1/admin/audit

Query

accountId?string
actorUserId?string
actorPrincipalId?string
eventTypes?string
outcomes?string
severities?string
targetType?string
targetId?string
since?string
until?string
limit?string
cursor?string

Response 200 { data: AdminAuditRecordDto[]; page; meta }

idstring
eventTypestring
outcomestring
severitystring
actorKindstring
actorUserIdstring | null
actorPrincipalIdstring | null
actorDisplayNamestring | null
accountIdstring | null
workspaceIdstring | null
targetTypestring | null
targetIdstring | null
reasonstring | null
occurredAtstring
recordedAtstring
stable200

Authorization denials · 1 routes

MethodPathTier2xx
GET
/v1/admin/authorization-denials

Query

filter.actorUserId?string
filter.action?string
filter.accountId?string
filter.since?string
filter.limit?string
filter.cursor?string

Response 200 { data: AuthorizationDenialRecord[]; page; meta }

stable200

Capabilities · 1 routes

MethodPathTier2xx
GET
/v1/admin/capabilities

Response 200 { data: CapabilityReport; meta }

capabilitiesCapabilityState[]
generatedAtstring
stable200

Config · 1 routes

MethodPathTier2xx
GET
/v1/admin/config

Response 200 { data: AdminConfigSnapshotsListResult; meta }

stable200

Cost projections · 1 routes

MethodPathTier2xx
POST
/v1/admin/cost-projections

Request body ProjectCostsBody

scenarioInputs?ScenarioInputs
baseline?MeasuredBaseline

Response 200 { data: CostProjectionGetResult; meta }

projectionCostProjection
stable200

Diagnostics · 1 routes

MethodPathTier2xx
GET
/v1/admin/diagnostics

Response 200 { data: AdminRuntimeDiagnosticsGetResult; meta }

stable200

Healthz · 1 routes

MethodPathTier2xx
GET
/v1/admin/healthz

Response 200

statusstring
stable200

Metrics · 1 routes

MethodPathTier2xx
GET
/v1/admin/metrics

Response 200 { data: MetricsReportGetResult; meta }

stable200

Migrations · 1 routes

MethodPathTier2xx
GET
/v1/admin/migrations

Response 200 { data: AdminMigrationStatusGetResult; meta }

stable200

Overview · 1 routes

MethodPathTier2xx
GET
/v1/admin/overview

Response 200 { data: AdminOverviewGetResult; meta }

stable200

Projections · 1 routes

MethodPathTier2xx
GET
/v1/admin/projections/health

Query

limit?string

Response 200 { data: AdminProjectionHealthGetResult; meta }

stable200

Provider health · 1 routes

MethodPathTier2xx
GET
/v1/admin/provider-health

Response 200 { data: AdminProviderHealthGetResult; meta }

stable200

Readyz · 1 routes

MethodPathTier2xx
GET
/v1/admin/readyz

Response 200

statusstring
stable200

Slo · 1 routes

MethodPathTier2xx
GET
/v1/admin/slo

Response 200 { data: AdminSloSnapshotGetResult; meta }

snapshotAdminSloDto
stable200

Support bundle · 1 routes

MethodPathTier2xx
GET
/v1/admin/support-bundle

Response 200 { data: AdminSupportBundle; meta }

stable200

Sync diagnostics · 1 routes

MethodPathTier2xx
GET
/v1/admin/sync-diagnostics

Query

minSeverity?string
accountId?string
cursor?string
limit?string

Response 200 { data: AdminSyncDiagnosticView[]; page; meta }

idstring
seqnumber
accountIdstring
workspaceIdstring
sourceIdstring
sourceSyncIdstring
workspaceSyncRunIdstring | null
emittedAtstring
severityAdapterDiagnosticSeverity
phasestring
codestring
messagestring
remediationstring | null
coverageKeystring | null
providerScopeKeystring | null
resourceKeystring | null
connectionKeystring | null
stable200

Telemetry · 1 routes

MethodPathTier2xx
POST
/v1/admin/telemetry

Request body

events?any

Response 204 no body

stable204

Whoami · 1 routes

MethodPathTier2xx
GET
/v1/admin/whoami

Response 200 { data: AdminWhoamiResult; meta }

userIdstring
accountIdstring | 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"[]
apiVersionstring
stable200

Schemas · 382 types

AccountBody
accountId?string
meterKeys?string[]
AccountId

string

AcsBody
SAMLResponse?string
RelayState?string
AdapterDiagnosticSeverity

"error" | "fatal" | "info" | "warning"

AddonDefinition
addonKeyAddonKey
displayNamestring
description?string
lifecycleAddonLifecycle
compatiblePlansPlanSelector[]
incompatiblePlansPlanSelector[]
entitlementTemplatesEntitlementTemplate[]
quotaTemplatesQuotaTemplate[]
skuRefsSkuRef[]
stackableboolean
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
accountIdstring
workspaceCountnumber
providerScopeCountnumber
latestSyncStatusstring | null
latestSyncAtstring | null
workspacesAdminAccountWorkspaceSummary[]
AdminAccountSummaryGetResult
AdminAccountWorkspaceSummary
idstring
namestring
latestSyncStatusstring | null
latestSyncAtstring | null
AdminAnalyticsRollupGetResult
AdminAnalyticsSeriesBucket
startstring
endstring
rollupAnalyticsRollup
AdminAnalyticsSeriesGetResult
AdminAuditRecordDto
idstring
eventTypestring
outcomestring
severitystring
actorKindstring
actorUserIdstring | null
actorPrincipalIdstring | null
actorDisplayNamestring | null
accountIdstring | null
workspaceIdstring | null
targetTypestring | null
targetIdstring | null
reasonstring | null
occurredAtstring
recordedAtstring
AdminConfigSnapshotsListResult
AdminDiagnostic
codestring
severityAdminDiagnosticSeverity
componentstring
summarystring
remediation?string
detail?map<string, AdminDiagnosticDetailValue>
AdminDiagnosticDetailValue

boolean | string | number

AdminDiagnosticReport
diagnosticsAdminDiagnostic[]
worst?"error" | "fatal" | "info" | "warning"
counts{ warning: number; info: number; error: number; fatal: number }
healthyboolean
generatedAt?string
AdminDiagnosticSeverity

"error" | "fatal" | "info" | "warning"

AdminEntitlementDto
featureKeystring
enabledboolean
statusstring
reasonstring
reasonCodeEntitlementReasonCode
kindkumo-entitlements.EntitlementKind
valueboolean | string | number | string[] | map<string, any> | null
softLimitnumber | null
hardLimitnumber | null
resetPeriodstring | null
winningGrantIdstring | null
appliedGrantIdsstring[]
suppressedGrantIdsstring[]
gatesAdminGateResultDto[]
warningsAdminWarningDto[]
evaluatedAtstring
validUntilstring | null
AdminEntitlementExplainResponseDto
accountIdstring
featureKeystring
entitlementAdminEntitlementDto | null
summarystring
stepsAdminEntitlementExplainStepDto[]
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
ordernumber
kindstring
messagestring
grantIdstring | null
reasonCodestring | null
AdminEntitlementsResolveResponseDto
accountIdstring
workspaceIdstring | null
entitlementsAdminEntitlementDto[]
warningsAdminWarningDto[]
evaluatedAtstring
cacheKeystring
AdminFeatureAccessResponseDto
accountIdstring
featureKeystring
allowedboolean
reasonCodeEntitlementReasonCode
reasonMessagestring
entitlementAdminEntitlementDto | null
gatesAdminGateResultDto[]
evaluatedAtstring
cacheKeystring
AdminFeatureFlagSetResult
flagAdminFeatureFlagStateDto
auditEventIdstring
AdminFeatureFlagStateDto
keystring
descriptionstring
enabledboolean
source"default" | "override"
defaultEnabledboolean
updatedAtstring | null
updatedBystring | null
AdminFeatureFlagsListResult
AdminGateResultDto
gatestring
allowedboolean
reasonCodestring
messagestring
AdminInstallationFingerprintDto
schemastring
installationIdstring
deploymentKindstring
generatedAtstring
hostHints?{ clusterUidHash?: string; machineIdHash?: string; namespace?: string }
AdminJobCancelResult
jobAdminJobDto
auditEventIdstring
AdminJobDto
idstring
kindstring
queuestring | null
status"cancelled" | "cancelling" | "dead_lettered" | "failed" | "queued" | "running" | "scheduled" | "succeeded"
scopeJobScope
requestedByJobRequester
attemptNumbernumber
attemptsExhaustedboolean
leasedBystring | null
leaseExpiresAtstring | null
progressJobProgress | null
cancellationJobCancellation | null
failureJobFailure | null
createdAtstring
updatedAtstring
startedAtstring | null
completedAtstring | null
notBeforestring | null
AdminJobGetResult
jobAdminJobDto | null
attemptsJobAttempt[]
AdminJobRetryResult
jobAdminJobDto
auditEventIdstring
AdminMigrationRecord
versionstring
hasChecksumboolean
AdminMigrationStatus
backend"postgres" | "unavailable"
appliedCountnumber
latestVersionstring | null
migrationsAdminMigrationRecord[]
AdminMigrationStatusGetResult
AdminOverrideGrantDto
grantIdstring
overrideIdstring
featureKeystring
kindkumo-entitlements.EntitlementKind
valueEntitlementValue
softLimitnumber | null
hardLimitnumber | null
effectiveFromstring
effectiveTostring | null
createdAtstring
createdBystring | null
reasonstring | null
referencestring | null
AdminOverridesListResponseDto
grantsAdminOverrideGrantDto[]
versionstring | null
updatedAtstring | null
AdminOverviewDiagnosticsSummary
recentErrorsnumber
AdminOverviewGetResult
AdminOverviewJobsSummary
failednumber
AdminOverviewLicenseSummary
installedboolean
statusstring
daysUntilExpirynumber | null
warningCountnumber
AdminOverviewProvidersSummary
totalnumber
healthynumber
degradednumber
blockednumber
healthyPctnumber
AdminProjectionHealthDto
AdminProjectionHealthGetResult
AdminProjectionHealthSummary
workspacesnumber
upToDatenumber
behindnumber
missingnumber
AdminProjectionLaneHealth
workspaceIdstring
projectionNamestring
statusAdminProjectionReconcileStatus
headSequencenumber | null
checkpointSequencenumber | null
lagSequencesnumber | null
lagMsnumber | null
AdminProjectionReconcileStatus

"behind" | "missing" | "upToDate"

AdminProviderHealthEntry
providerKeystring
countsByStatusAdminProviderHealthStatusCounts
totalnumber
AdminProviderHealthGetResult
AdminProviderHealthRollupDto
AdminProviderHealthStatusCounts
healthynumber
degradednumber
blockednumber
unknownnumber
stalenumber
AdminQueueHealthResult
countsByStatus{ cancelled: number; running: number; failed: number; succeeded: number; queued: number; scheduled: number; cancelling: number; dead_lettered: number }
AdminRuntimeDiagnosticsGetResult
AdminSloDto
generatedAtstring
slosAdminSloMetric[]
summaryAdminSloSummary
AdminSloMetric
namestring
areastring
titlestring
unitstring
comparisonstring
warnThresholdnumber
breachThresholdnumber
descriptionstring
valuenumber | null
statusAdminSloStatus
detail?string
metric?string
wiredboolean
AdminSloSnapshotGetResult
snapshotAdminSloDto
AdminSloStatus

"breach" | "ok" | "unknown" | "warn"

AdminSloSummary
totalnumber
oknumber
warnnumber
breachnumber
unknownnumber
wirednumber
AdminSnapshotCreateResponseDto
snapshotIdstring
accountIdstring
workspaceIdstring | null
evaluatedAtstring
createdAtstring
labelstring | null
entitlementCountnumber
AdminSnapshotDiffDetailDto
fieldstring
beforeany
afterany
AdminSnapshotDiffEntryDto
featureKeystring
changeKindEntitlementDiffChangeKind
severityEntitlementDiffSeverity
summarystring
beforeEnabledboolean | null
afterEnabledboolean | null
detailsAdminSnapshotDiffDetailDto[]
AdminSnapshotDiffResponseDto
fromSnapshotIdstring | null
toSnapshotIdstring | null
accountIdstring
workspaceIdstring | null
evaluatedAtstring
entriesAdminSnapshotDiffEntryDto[]
summary{ totalChanges: number; breakingCount: number; improvementCount: number; neutralCount: number; gainedCount: number; lostCount: number; changedCount: number }
AdminStorageHistoryGetResult
AdminSupportBundle
AdminSupportBundleSection
namestring
payloadany
AdminSyncDiagnosticView
idstring
seqnumber
accountIdstring
workspaceIdstring
sourceIdstring
sourceSyncIdstring
workspaceSyncRunIdstring | null
emittedAtstring
severityAdapterDiagnosticSeverity
phasestring
codestring
messagestring
remediationstring | null
coverageKeystring | null
providerScopeKeystring | null
resourceKeystring | null
connectionKeystring | null
AdminTenantDeletionCancelResult
requestAdminTenantDeletionDto | null
auditEventIdstring | null
AdminTenantDeletionDto
idstring
accountIdstring
requestedBystring
requestedAtstring
graceEndsAtstring
statusstring
AdminTenantDeletionStartResult
requestAdminTenantDeletionDto | null
auditEventIdstring | null
AdminTenantDeletionsListResult
AdminTenantDto
idstring
slugstring
displayNamestring
statusstring
createdAtstring
updatedAtstring
suspendedAtstring | null
AdminTenantGetResult
tenantAdminTenantDto | null
AdminTenantReactivateResult
tenantAdminTenantDto | null
auditEventIdstring | null
AdminTenantSuspendResult
tenantAdminTenantDto | null
auditEventIdstring | null
AdminWarningDto
codestring
messagestring
AdminWhoamiResult
userIdstring
accountIdstring | 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"[]
apiVersionstring
AlertNotificationSubject
kind"alert"
workspaceId?WorkspaceId
alertIdstring
displayNamestring
AnalyticsBucket

"day" | "week"

AnalyticsRollup
tenantsCreatednumber
syncRuns{ succeeded: number; partial: number; failed: number }
providerFailuresnumber
latestGraphSize?GraphSizePoint
latestStorage?StoragePoint
AuthorizationAction

"account.read" | "account.write" | "alert.manage" | "alert.read" | "annotation.manage" | "annotation.read" | "audit.read" | "billing.manage" | "billing.read" | "change.read" | "cost.read" | "environment.evaluate" | "graph.read" | "integration.manage" | "integration.read" | "member.manage" | "member.read" | "notification.manage" | "notification.read" | "policy.write" | "report.manage" | "report.read" | "retention.apply" | "scim.manage" | "search.read" | "source.sync" | "sso.manage" | "sso.read" | "usage.read" | "view.render" | "workspace.manage" | "workspace.read"

AuthorizationDenialRecord
AuthorizationDenialScope

object | object | object

BillingCadence

"annual" | "custom" | "monthly" | "one_time" | "quarterly"

BillingCreditGrantRecord
idstring
accountIdAccountId
meterKeystring | null
amountnumber
remainingnumber
statusBillingCreditGrantStatus
reasonstring
grantedAtstring
expiresAtstring | null
BillingCreditGrantStatus

"active" | "consumed" | "expired" | "revoked"

BillingEntitlementGrantInput
featureKeystring
kindBillingEntitlementKind
valueboolean | 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
featureKeystring
kindBillingEntitlementKind
scopeBillingEntitlementScope
valueboolean | string | number | map<string, any>
softLimitnumber | null
hardLimitnumber | null
resetPeriodBillingEntitlementResetPeriod
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
providerInvoiceIdstring
providerCustomerIdstring
providerSubscriptionIdstring | null
statusstring
currencystring
amountDuenumber
amountPaidnumber
amountRemainingnumber
numberstring | null
hostedInvoiceUrlstring | null
invoicePdfUrlstring | null
createdAtstring | null
periodStartstring | null
periodEndstring | null
BillingPaymentMethodRecord
providerPaymentMethodIdstring
providerCustomerIdstring
typestring
cardBrandstring | null
cardLast4string | null
cardExpMonthnumber | null
cardExpYearnumber | null
createdAtstring | null
BillingPlanRecord
idstring
planKeystring
displayNamestring
statusBillingPlanStatus
currentVersionIdstring | null
createdAtstring
updatedAtstring
BillingPlanStatus

"active" | "archived" | "draft"

BillingPlanVersionRecord
idstring
planIdstring
versionnumber
statusBillingPlanVersionStatus
entitlementsBillingEntitlementRecord[]
effectiveFromstring
effectiveTostring | null
createdAtstring
publishedAtstring | null
BillingPlanVersionStatus

"draft" | "published" | "retired"

BillingProviderName

"aws_marketplace" | "chargebee" | "manual" | "stripe" | string

BillingProviderSkuRef
providerBillingProviderName
productId?string
priceId?string
sku?string
lookupKey?string
BillingReconciliationRunRecord
idstring
providerstring
accountIdAccountId | null
statusBillingReconciliationRunStatus
dryRunboolean
mismatchCountnumber
startedAtstring
completedAtstring | null
failureReasonstring | null
BillingReconciliationRunStatus

"cancelled" | "completed" | "failed" | "pending" | "running"

BillingSubscriptionRecord
idstring
accountIdAccountId
billingCustomerIdstring
planIdstring
planNamestring | null
planKeystring | null
planVersionIdstring
providerstring
statusBillingSubscriptionStatus
currentPeriodStartstring | null
currentPeriodEndstring | null
cancelAtPeriodEndboolean
trialEndsAtstring | null
createdAtstring
updatedAtstring
endedAtstring | null
BillingSubscriptionStatus

"active" | "cancelled" | "expired" | "incomplete" | "past_due" | "paused" | "suspended" | "trialing"

BillingTrialRecord
idstring
accountIdAccountId
planIdstring
planVersionIdstring
subscriptionIdstring
statusBillingTrialStatus
startedAtstring
endsAtstring
convertedAtstring | null
BillingTrialStatus

"active" | "cancelled" | "converted" | "expired"

CapabilityReport
capabilitiesCapabilityState[]
generatedAtstring
CapabilityState
capabilitystring
statusCapabilityStatus
detailstring
reason?string
CapabilityStatus

"degraded" | "disabled" | "enabled"

CatalogIntegrity
canonicalHashstring
signature?string | null
algorithm?string
CatalogProvenance
sourceCatalogSource
createdBystring
createdAtstring
publishedBy?string
publishedAt?string | null
notes?string
CatalogSource

"admin_ui" | "import" | "migration" | "repository" | "system"

CheckCompatibilityRequestBody
version?number
contextCompatibilityContext
CommercialCatalogSeedCatalogAction

"published" | "unchanged" | "would-publish"

CommercialCatalogSeedReport
catalog{ catalogKey: string; action: CommercialCatalogSeedCatalogAction; version: number | null }
billingPlansHostedPlanProjectionOutcome[]
registry{ features: number; meters: number }
plans{ created: number; updated: number; unchanged: number }
CompatibilityContext
deploymentKindDeploymentKind
runtimeProfile?string
licenseEdition?string
region?string
installedPackages?string[]
CompatibilityEvaluation
compatibleboolean
reasonsstring[]
ConfigEntrySnapshot
keystring
categorystring
secretboolean
setboolean
sourceConfigEntrySource
valuestring | null
fingerprintstring | null
descriptionstring
unregisteredboolean
ConfigEntrySource

"env" | "file" | "unset"

ConfiguredEdge
fromTypestring
edgeTypestring
toTypestring
ConnectionTypeSample
connectionsnumber
observationRowsnumber
observationBytesnumber
revisionRowsnumber
revisionBytesnumber
dedupHitsnumber
ContextNotificationSubject
kind"context"
workspaceIdWorkspaceId
contextIdstring
displayNamestring
CostNotificationSubject
kind"cost"
workspaceId?WorkspaceId
scopestring
displayNamestring
CostProjection
CostProjectionGetResult
projectionCostProjection
CostTotals
storageGbAtEndnumber
computeHoursnumber
storageCostUsdnumber
computeCostUsdnumber
networkCostUsdnumber
totalCostUsdnumber
CrawlInputSample
providerstring
filesnumber
bytesnumber
resourceCandidatesnumber
connectionCandidatesnumber
CreateCatalogRequestBody
catalogKeystring
displayNamestring
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
planKeystring
familyKeystring
displayNamestring
description?string
tierPlanTier
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
credentialRefstring
sourceId?SourceId
displayNamestring
CreditGrantCreateBody
amount?number
reason?string
meterKey?string
expiresAt?string
CurrencyCode

string

DataClassSample
rowsnumber
bytesnumber
dedupHitsnumber
avgBytesPerRownumber
DefineFeatureRequestBody
DefineMeterRequestBody
DeploymentKind

"agent" | "airgap" | "desktop" | "embedded" | "hosted_saas" | "self_hosted"

DiagnosticSeverity

"error" | "warning"

DiffCatalogsRequestBody
fromCatalogIdPlanCatalogId
toCatalogIdPlanCatalogId
DispatchOutcome

"delivered" | "failed_permanent" | "failed_retryable" | "skipped" | "suppressed"

DurationStats
minMsnumber
meanMsnumber
medianMsnumber
p95Msnumber
p99Msnumber
maxMsnumber
EdgeFireCount
fromTypestring
edgeTypestring
toTypestring
countnumber
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
featureKeyFeatureKey
kindkumo-contracts.EntitlementKind
scopekumo-contracts.EntitlementScope
valueFeatureValue
softLimit?number | null
hardLimit?number | null
resetPeriod?"annual" | "daily" | "monthly" | "none" | "weekly"
grantReasonEntitlementGrantReason
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"
workspaceIdWorkspaceId
environmentIdEnvironmentId
environmentRevisionId?EnvironmentRevisionId
displayNamestring
EnvironmentRevisionId

string

ExportBody
windowStartsAt?string
windowEndsAt?string
format?"csv" | "json"
bySubject?boolean
accountId?string
meterKeys?string[]
ExternalNotificationRecipient
kind"external"
accountIdAccountId
channelNotificationChannel
addressstring
FeatureCategory

"admin" | "alerts" | "automation" | "compliance" | "diagrams" | "diff" | "distribution" | "graph" | "identity" | "integrations" | "providers" | "reporting" | "security" | "support" | "views"

FeatureDefineResult
FeatureDefinition
featureKeyFeatureKey
displayNamestring
description?string
categoryFeatureCategory
valueKindFeatureValueKind
defaultValueFeatureValue
maturityFeatureMaturity
lifecycleFeatureLifecycle
enforcementModeFeatureEnforcementMode
ownerPackage?string
trial?"granted" | "withheld"
dependenciesFeatureKey[]
conflictsFeatureKey[]
docsUrl?string
metadatakumo-contracts.JsonObject
FeatureEnforcementMode

"admin_only" | "advisory" | "hard_gate" | "license_backed" | "quota_backed" | "soft_gate"

FeatureGetResult
featureFeatureDefinition | 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
GraphSizePoint
resourceCountnumber
connectionCountnumber
observedAtstring
HistogramSample
countnumber
minValuenumber
meanValuenumber
medianValuenumber
p95Valuenumber
p99Valuenumber
maxValuenumber
sumValuenumber
HostedPlanProjectionAction

"created" | "unchanged" | "updated" | "would-create" | "would-update"

HostedPlanProjectionOutcome
planKeystring
billingPlanKeystring
actionHostedPlanProjectionAction
JobAttempt
idJobAttemptId
jobIdJobId
attemptNumbernumber
workerIdstring
leaseTokenJobLeaseToken
status"cancelled" | "failed" | "running" | "stale" | "succeeded"
startedAtstring
leaseExpiresAtstring
completedAtstring | null
failureJobFailure | null
JobAttemptId

string

JobCancellation
requestedAtstring
requestedByJobRequester
reasonstring
JobFailure
codestring
messagestring
retryableboolean
category"authorization" | "bug" | "cancelled" | "conflict" | "not_found" | "provider" | "storage" | "timeout" | "unknown" | "validation"
details?kumo-jobs.JsonObject
stackPreview?string
JobId

string

JobLeaseToken

string

JobProgress
stagestring
message?string
percent?number
current?number
total?number
unit?string
updatedAtstring
details?kumo-jobs.JsonObject
JobRequester

object | object | object

JobScope

object | object | object

KumoSupportBundleManifestV1
kind"kumo.importExport.supportBundleManifest"
manifestVersion1
bundleIdstring
createdAtstring
scopeKumoSupportBundleScopeV1
sectionsstring[]
redactionKumoSupportBundleRedactionSummaryV1
KumoSupportBundleRedactionSummaryV1
deterministicboolean
redactedFieldsCount?number
restrictedSectionsCount?number
policyIds?string[]
KumoSupportBundleScopeV1
tenantId?string
accountId?string
workspaceId?string
sourceId?string
LicenseActivationApplyInputDto
receiptTextstring
LicenseActivationRequestDto
schemastring
requestIdstring
customerIdstring
customerContact?string
fingerprint{ schema: string; installationId: string; deploymentKind: string; generatedAt: string; hostHints?: object }
requestedEdition?string
requestedFeatures?string[]
notes?string
createdAtstring
LicenseActivationRequestInputDto
customerIdstring
customerContact?string
requestedEdition?string
requestedFeatures?string[]
notes?string
LicenseDiagnostics
installedboolean
statusLicenseStatus
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
featuresLicenseFeatureDiagnostic[]
limitsLicenseLimitDiagnostic[]
warningsLicenseWarning[]
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
featureLicenseFeature
allowedboolean
expiresAt?string
source"default" | "license" | "override"
LicenseInstallInputDto
documentTextstring
LicenseLimitDiagnostic
limit"maxAccounts" | "maxApiReplicas" | "maxConnectionsPerWorkspace" | "maxEmbeddedInstallations" | "maxProviderScopes" | "maxResourcesPerWorkspace" | "maxSourceSyncsPerMonth" | "maxSources" | "maxStorageBytes" | "maxUsers" | "maxViewGenerationsPerMonth" | "maxWorkers" | "maxWorkspaceGraphRevisions" | "maxWorkspaces"
licensednumber | null
observednumber | null
status"exceeded" | "near_limit" | "ok" | "unknown"
LicenseLockout
reason"claim_required" | "expired" | "read_only"
detailstring
LicenseMintTestInputDto
edition?string
customerId?string
customerName?string
expiresAt?string | null
features?{ feature: string; mode?: "allow" | "deny" }[]
LicensePlanClaim
keystring
familystring
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"
messagestring
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"
allowedRuntimeModesstring[]
allowOfflineboolean
allowAirgapboolean
allowOemRedistributionboolean
MarketplaceSkuRef
marketplace"aws_marketplace" | "azure_marketplace" | "gcp_marketplace" | string
productCode?string
dimension?string
offerId?string
MeasuredBaseline
resourceCountnumber
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 }
elapsedMsnumber
MeterAggregation

"average" | "current" | "max" | "sum"

MeterDefineResult
MeterDefinition
meterKeyMeterKey
displayNamestring
description?string
unitMeterUnit
aggregationMeterAggregation
resetPeriodMeterResetPeriod
subjectScopekumo-contracts.EntitlementScope
sourcePackage?string
exactnessMeterExactness
auditRequiredboolean
MeterExactness

"estimated" | "eventual" | "exact"

MeterGetResult
meterMeterDefinition | null
MeterKey

string

MeterResetPeriod

"annual" | "daily" | "monthly" | "none" | "weekly"

MeterUnit

"bytes" | "count" | "credits" | "jobs" | "requests" | "resources" | "seconds" | "sources" | "users" | "workspaces"

MetersListResult
MetricsReport
attributesmap<string, boolean | string | number>
phasesPhaseSample[]
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 }
totalsMetricsTotals
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
MetricsTotals
rowsnumber
bytesnumber
dedupHitsnumber
elapsedMsnumber
MigrationResolution
allowedboolean
target?PlanMigrationTarget
reason?string
MonthlyProjection
monthIndexnumber
resourcesnumber
storageBytesnumber
storageGbnumber
storageCostUsdnumber
computeHoursnumber
computeCostUsdnumber
networkGbnumber
networkCostUsdnumber
totalCostUsdnumber
MutateBody
reason?string
NormalizedEntitlement
featureKeyFeatureKey
kindkumo-contracts.EntitlementKind
scopekumo-contracts.EntitlementScope
valueFeatureValue
softLimitnumber | null
hardLimitnumber | null
resetPeriodEntitlementResetPeriod
grantReasonEntitlementGrantReason
sourcesstring[]
NormalizedQuota
meterKeyMeterKey
scopekumo-contracts.EntitlementScope
softLimitnumber | null
hardLimitnumber | null
resetPeriodMeterResetPeriod
overageBehaviorOverageBehavior
enforcementPointQuotaEnforcementPoint
sourcesstring[]
NotificationChannel

"cli" | "desktop" | "email" | "in_app" | "mobile_push" | "slack" | "webhook"

NotificationDeliveryAttemptDto
idstring
deliveryIdstring
attemptedAtstring
statusstring
providerMessageIdstring | null
errorCodestring | null
errorMessagestring | null
latencyMsnumber | null
NotificationDeliveryDto
idstring
notificationIdstring
recipientNotificationIdstring | null
channelstring
destinationNotificationDestination
statusstring
idempotencyKeystring
attemptCountnumber
scheduledAtstring
lastAttemptedAtstring | null
deliveredAtstring | null
failedAtstring | null
failure?NotificationDeliveryFailure | null
NotificationDeliveryFailure
codestring
messagestring
retryableboolean
providerCode?string
NotificationDeliveryTrailDto
NotificationDestination
channelNotificationChannel
addressstring
displayName?string
NotificationDiagnosticDto
severitystring
codestring
messagestring
recipient?UserNotificationRecipient | TeamNotificationRecipient | WorkspaceNotificationRecipient | ExternalNotificationRecipient | null
channelstring | null
NotificationDto
idstring
accountIdstring
workspaceIdstring | null
kindstring
severitystring
urgencystring
titlestring
summarystring
subjectNotificationSubject
linksNotificationLink[]
evidenceNotificationEvidence[]
threadKeystring | null
dedupeKeystring
createdAtstring
occurredAtstring
statestring
NotificationEvidence
kindstring
labelstring
ref?string
sensitive?boolean
detail?map<string, any>
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
partnerIdstring
namestring
statusPartnerStatus
domainsstring[]
brandingPartnerBranding
provisioningPartnerProvisioningPolicy
createdAtstring (date-time)
updatedAtstring (date-time)
PartnerBranding
productNamestring
logoUrlstring | null
faviconUrlstring | null
supportEmailstring | null
themeTokensmap<string, string>
PartnerProvisioningPolicy
planKeystring
trialDaysnumber
defaultRoleKeystring
PartnerStatus

"active" | "disabled"

PgPoolSample
maxCountnumber
peakTotalnumber
peakInUsenumber
peakIdlenumber
peakWaitingnumber
samplesnumber
PgPoolTimelineSample
tMsnumber
maxCountnumber
totalCountnumber
inUseCountnumber
idleCountnumber
waitingCountnumber
PgStatementSample
totalStatementsnumber
byKindmap<string, number>
PhaseSample
namestring
startedAtMsnumber
endedAtMsnumber
durationMsnumber
samplesnumber
cpuUserMs?number
cpuSystemMs?number
durationStatsDurationStats
PlanAudience

"internal" | "oem" | "partner" | "sales_led" | "self_hosted" | "self_serve"

PlanCatalog
catalogIdPlanCatalogId
catalogKeystring
versionnumber
statusPlanCatalogStatus
displayNamestring
description?string
featuresFeatureDefinition[]
metersMeterDefinition[]
planFamiliesPlanFamilyDefinition[]
plansPlanDefinition[]
addonsAddonDefinition[]
skusSkuDefinition[]
currencyDefaultsCurrencyCode[]
effectiveFromstring
effectiveTo?string | null
provenanceCatalogProvenance
integrityCatalogIntegrity
PlanCatalogChange
kindPlanCatalogChangeKind
breakingboolean
targetPlanCatalogChangeTarget
keystring
detailstring
PlanCatalogChangeKind

"added" | "changed" | "removed"

PlanCatalogChangeTarget

"addon" | "catalog" | "entitlement" | "feature" | "meter" | "migration_path" | "plan" | "plan_version" | "quota" | "sku"

PlanCatalogCreateResult
PlanCatalogDiagnostic
severityDiagnosticSeverity
codePlanCatalogDiagnosticCode
messagestring
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
fromCatalogIdPlanCatalogId
toCatalogIdPlanCatalogId
changesPlanCatalogChange[]
breakingboolean
requiresMigrationboolean
summaryPlanCatalogDiffSummary
PlanCatalogDiffSummary
totalnumber
breakingnumber
nonBreakingnumber
addednumber
removednumber
changednumber
PlanCatalogGetResult
catalogPlanCatalog | null
PlanCatalogId

string

PlanCatalogStatus

"deprecated" | "draft" | "invalid" | "published" | "retired"

PlanCatalogValidateResult
PlanCatalogValidationReport
validboolean
errorsPlanCatalogDiagnostic[]
warningsPlanCatalogDiagnostic[]
PlanCompatibility
deploymentKindsDeploymentKind[]
runtimeProfilesstring[]
licenseEditionsstring[]
regions?string[]
providerFamilies?string[]
requiresPackages?string[]
conflictsWithPackages?string[]
PlanCompatibilityCheckResult
planKeystring
versionnumber
evaluationCompatibilityEvaluation
PlanCreateBody
planKey?string
displayName?string
PlanCreateResult
PlanDefinition
planKeystring
familyKeystring
displayNamestring
description?string
tierPlanTier
lifecyclePlanLifecycle
currentVersionnumber
visibleInSignupboolean
visibleInAdminboolean
selfServePurchaseAllowedboolean
trial?{ days: number; signupDefault: boolean }
versionsPlanVersionDefinition[]
tagsstring[]
metadatakumo-contracts.JsonObject
PlanDisplayMetadata
marketingName?string
tagline?string
sortOrdernumber
highlightedboolean
badge?string
featureBullets?string[]
priceCaption?string
PlanFamilyDefinition
familyKeystring
displayNamestring
description?string
audiencePlanAudience
allowedDeploymentKindsDeploymentKind[]
defaultPlanKey?string
sortOrdernumber
PlanGetResult
planPlanDefinition | null
PlanLifecycle

"active" | "deprecated" | "draft" | "hidden" | "retired"

PlanMigrationBlock
targetPlanKeystring
targetVersion?"current" | number
reasonstring
PlanMigrationKind

"downgrade" | "lateral" | "legacy_migration" | "upgrade"

PlanMigrationPathResolveResult
fromPlanKeystring
fromVersionnumber
resolutionMigrationResolution
pinnedTargetVersion?number
PlanMigrationPolicy
allowedTargetsPlanMigrationTarget[]
blockedTargetsPlanMigrationBlock[]
prorationPolicyProrationPolicy
entitlementTransitionEntitlementTransitionPolicy
quotaTransitionQuotaTransitionPolicy
requiresAdminApprovalboolean
requiresCustomerAcceptanceboolean
PlanMigrationTarget
targetPlanKeystring
targetVersion?"current" | number
kindPlanMigrationKind
effectiveTimingPlanMigrationTiming
PlanMigrationTiming

"immediate" | "manual_date" | "period_end"

PlanSelector
planKeystring
version?number
familyKey?string
PlanTier

"business" | "embedded" | "enterprise" | "free" | "internal" | "self_hosted" | "starter" | "team" | "trial"

PlanVersionDefinition
planKeystring
versionnumber
statusPlanVersionStatus
effectiveFromstring
effectiveTo?string | null
publishedAt?string | null
entitlementTemplatesEntitlementTemplate[]
quotaTemplatesQuotaTemplate[]
rateLimitTemplatesRateLimitTemplate[]
includedAddonsAddonKey[]
skuRefsSkuRef[]
migrationPolicyPlanMigrationPolicy
compatibilityPlanCompatibility
displayPlanDisplayMetadata
checksum?string
PlanVersionDeprecateResult
PlanVersionDraftBody
entitlements?BillingEntitlementGrantInput[]
effectiveFrom?string
PlanVersionDraftCreateResult
PlanVersionId

string

PlanVersionPublishBody
makeCurrent?boolean
PlanVersionPublishResult
PlanVersionResolveResult
PlanVersionStatus

"deprecated" | "draft" | "published" | "retired"

PricingModel

"custom_quote" | "free" | "one_time" | "recurring_flat" | "recurring_per_seat" | "usage_based"

ProcessConfigSnapshot
processKindstring
instanceIdstring
bootedAtstring
reportedAtstring
entriesConfigEntrySnapshot[]
ProcessSample
rssBytesPeaknumber
rssBytesFinalnumber
heapUsedBytesPeaknumber
heapUsedBytesFinalnumber
heapTotalBytesFinalnumber
cpuUserMsnumber
cpuSystemMsnumber
ProgressTimelineSample
tMsnumber
resourcesnumber
connectionsnumber
viewsnumber
environmentsnumber
resourceRevisionsnumber
connectionRevisionsnumber
viewRevisionsnumber
environmentRevisionsnumber
pgStatementsnumber
filesSucceedednumber
ProjectCostsBody
scenarioInputs?ScenarioInputs
baseline?MeasuredBaseline
ProrationPolicy

"billing_provider" | "catalog_rule" | "manual" | "none"

ProviderScopeId

string

PublishPlanVersionRequestBody
setCurrent?boolean
QueueTimelineSample
tMsnumber
sourceUploadsPendingnumber
sourceUploadsActivenumber
crawlResultsPendingnumber
crawlResultsActivenumber
wgrPostSyncPendingnumber
wgrPostSyncActivenumber
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
meterKeyMeterKey
scopekumo-contracts.EntitlementScope
softLimit?number | null
hardLimit?number | null
resetPeriodMeterResetPeriod
overageBehaviorOverageBehavior
enforcementPointQuotaEnforcementPoint
QuotaTransitionPolicy

"keep_current_usage_recalculate_limits" | "preserve_until_period_end" | "reset_all"

RateLimitTemplate
RateLimitWindow

"day" | "hour" | "minute" | "second"

ReasonBody
reason?string
RebuildBody
apply?boolean
accountId?string
meterKeys?string[]
RecipientNotificationDto
idstring
notificationIdstring
recipientNotificationRecipient
visibilitystring
readStatestring
lifecycleStatestring
deliveredChannelsstring[]
createdAtstring
readAtstring | null
dismissedAtstring | null
ReconciliationRunStartBody
accountId?string
dryRun?boolean
ReportNotificationSubject
kind"report"
workspaceId?WorkspaceId
reportIdstring
reportRevisionId?string
displayNamestring
ResolveMigrationPathRequestBody
fromVersion?number
targetPlanKeystring
targetVersion?"current" | number
ResolvedPlanTemplates
planKeystring
versionnumber
entitlementsNormalizedEntitlement[]
quotasNormalizedQuota[]
rateLimitsRateLimitTemplate[]
ResourceNotificationSubject
kind"resource"
workspaceIdWorkspaceId
resourceIdstring
displayNamestring
ResourceTimelineSample
tMsnumber
rssBytesnumber
heapUsedBytesnumber
heapTotalBytesnumber
cpuUserMsnumber
cpuSystemMsnumber
eventLoopDelayMeanMs?number
eventLoopDelayMaxMs?number
ResourceTypeSample
resourcesnumber
observationRowsnumber
observationBytesnumber
revisionRowsnumber
revisionBytesnumber
dedupHitsnumber
RetryBody
reason?string
ReverseBody
entryId?string
reason?string
idempotencyKey?string
SamlConfigurationId

string

ScenarioInputs
accountCountnumber
resourcesPerAccountnumber
annualGrowthRatenumber
syncsPerMonthnumber
monthsToProjectnumber
retentionMonthsnumber
churnRatePerSyncnumber
compressionRationumber
indexOverheadnumber
replicaFactornumber
backupFactornumber
safetyMarginnumber
storagePricePerGbMonthnumber
computePricePerHournumber
egressPricePerGbnumber
secondsPerRecord?number
SetBody
enabled?any
reason?any
SkuDefinition
skuKeySkuKey
displayNamestring
description?string
planKey?string
planVersion?number
addonKey?string
providerRefsBillingProviderSkuRef[]
marketplaceRefsMarketplaceSkuRef[]
pricingModelPricingModel
billingCadencesBillingCadence[]
currency?CurrencyCode
taxCategory?string
revenueCategory?string
metadatakumo-contracts.JsonObject
SkuKey

string

SkuRef
skuKeySkuKey
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"
workspaceIdWorkspaceId
sourceIdSourceId
sourceSyncId?SourceSyncId
displayNamestring
SourceSyncId

string

StorageHistoryPoint
measuredAtstring
databaseBytesnumber
kumoBytesnumber
StoragePoint
bytesTotalnumber
observedAtstring
StorageTableSize
tablestring
liveRowsnumber
heapBytesnumber
indexBytesnumber
toastBytesnumber
totalBytesnumber
StorageUsageSnapshot
databaseBytesnumber
tablesStorageTableSize[]
totals{ heapBytes: number; indexBytes: number; toastBytes: number; totalBytes: number }
StorageUsageSnapshotGetResult
snapshotStorageUsageSnapshot
capacityBytesnumber | 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
displayNamestring
TeamNotificationRecipient
kind"team"
teamIdstring
accountIdAccountId
TrialStartBody
planKey?string
days?number
endsAt?string
UpdateBody
name?string
status?"active" | "disabled"
domains?string[]
branding?PartnerBranding
provisioning?PartnerProvisioningPolicy
UsageAdjustment
idUsageAdjustmentId
accountIdAccountId
subjectUsageSubject
meterKeyUsageMeterKey
meterVersionnumber
windowUsageWindow
quantityUsageQuantity
reasonstring
ledgerEntryIdUsageLedgerEntryId
adjustedEntryId?UsageLedgerEntryId
createdAtstring
UsageAdjustmentId

string

UsageCounterKey
subjectUsageSubject
meterKeyUsageMeterKey
meterVersionnumber
windowUsageWindow
UsageDiagnostic
severity"error" | "info" | "warning"
codeUsageDiagnosticCode
messagestring
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
idUsageExportId
accountIdAccountId
windowUsageWindow
formatUsageExportFormat
meterKeysUsageMeterKey[]
linesUsageExportLine[]
entryCountnumber
firstSequence?string
lastSequence?string
generatedAtstring
UsageExportFormat

"csv" | "json"

UsageExportId

string

UsageExportLine
meterKeyUsageMeterKey
unitUsageUnit
subjectKey?string
grossstring
adjustmentsstring
netstring
entryCountnumber
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
valuestring
unitUsageUnit
scale?number
UsageRebuildCountersResult
checkednumber
driftednumber
appliednumber
findingsUsageReconciliationFinding[]
diagnosticsUsageDiagnostic[]
UsageReconciliationFinding
kind"missing_counter" | "orphan_counter" | "value_drift"
counterKeyUsageCounterKey
field?"adjusted" | "committed" | "reserved" | "used"
stored?string
rebuilt?string
UsageReconciliationRun
idUsageReconciliationRunId
accountIdAccountId
checkedCountersnumber
consistentboolean
findingsUsageReconciliationFinding[]
startedAtstring
completedAtstring
UsageReconciliationRunId

string

UsageSubject
kindUsageSubjectKind
accountIdAccountId
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
kindUsageWindowKind
startsAtstring
endsAtstring
timezone?string
UsageWindowKind

"billing_period" | "day" | "hour" | "instant" | "month" | "rolling" | "week"

UserId

string

UserNotificationRecipient
kind"user"
userIdUserId
accountIdAccountId
ViewId

string

ViewNotificationSubject
kind"view"
workspaceIdWorkspaceId
viewIdViewId
viewRevisionId?ViewRevisionId
displayNamestring
ViewRevisionId

string

WgrPostSyncJob
idWgrPostSyncJobId
workspaceIdWorkspaceId
workspaceGraphRevisionIdWorkspaceGraphRevisionId
statusWgrPostSyncJobStatus
attemptsnumber
maxAttemptsnumber
lastErrorstring | null
enqueuedAtstring (date-time)
claimedAtstring (date-time) | null
completedAtstring (date-time) | null
observedAtstring (date-time)
wallEnqueuedAtstring (date-time)
WgrPostSyncJobGetResult
jobWgrPostSyncJob | null
WgrPostSyncJobId

string

WgrPostSyncJobRetryFailedResult
requeuedtrue
auditEventIdstring
WgrPostSyncJobStatus

"done" | "failed" | "pending" | "running"

WgrPostSyncJobsCountByStatusResult
countnumber
WgrPostSyncJobsListByStatusResult
WorkspaceGraphRevisionId

string

WorkspaceId

string

WorkspaceNotificationRecipient
kind"workspace"
workspaceIdWorkspaceId
accountIdAccountId
WorkspaceNotificationSubject
kind"workspace"
workspaceIdWorkspaceId
displayNamestring
WorkspaceSample
timingsMsmap<string, { totalMs: number; samples: number; maxMs: number }>
countersmap<string, number>
totalMsnumber
kumo-contracts-admin.ActorContext
userIdUserId
accountIdAccountId
workspaceId?WorkspaceId
kumo-contracts.EntitlementKind

"allowlist" | "configuration" | "credit" | "flag" | "limit"

kumo-contracts.EntitlementScope

"account" | "deployment" | "source" | "user" | "workspace"

kumo-contracts.JsonArray

kumo-contracts.JsonValue[]

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.JsonValue[]

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

See your own cloud in Kumo.io. Read-only access. Nothing in your account changes.

Free Trial