Transition an approval to its next status (approve, reject, submit, cancel)
Publishes an eventType against an approval and returns its updated status.
Each eventType is only valid from specific current statuses — calling it from the wrong status is rejected, so check the approval’s current status first:
From status
eventType
Resulting status
PendingSubmission
RequestSubmitted
PendingReview
PendingReview
RequestApproved
Approved
PendingReview
RequestConditionalApproved
ConditionallyApproved
PendingReview
RequestCancelled
PendingSubmission
ConditionallyApproved
RequestApproved / FindingsApproved
Approved
ConditionallyApproved
RequestRejected / RequestCancelled
PendingSubmission
Approved
RequestRejected
PendingSubmission
Approved
RevalidationRequired
PendingExpiration
PendingExpiration
RequestApproved
Approved
PendingExpiration
RequestRejected
PendingSubmission
PendingExpiration
RevalidationExpired
Expired
Expired
RequestSubmitted
PendingReview
Expired
RequestApproved
Approved
Expired
RequestRejected
PendingSubmission
Calling an eventType that isn’t valid for the approval’s current status currently returns a generic 500 with a message like "invalid event RequestApproved for approval status PendingSubmission" — check status via GET /bundles/{id}/approvals first to avoid this.
approvalId comes from GET /bundles/{id}/approvals. If omitted, stageApprovalId is used to resolve it instead. stageApprovalId identifies the approval slot defined by the policy; each bundle that has the policy applied gets its own Approval instance for that slot, and stageApprovalId resolves to that bundle-specific approvalId. Get it from GET /policy-versions/{id} (stages[].approvals[].id), using the bundle’s actual policyVersionId from GET /bundles/{id}/approvals.
meta shape depends on eventType:
eventType
meta shape
---
---
RequestApproved
{"result"?: {"evidenceId": string, "content": {...}}} — optionally submit the final evidence in the same call as approving
RequestConditionalApproved
{"result"?: {...same as above...}, "requiredFindings": string[]} — requiredFindings (finding IDs) is required
all other event types
no defined fields — send {}
Related:
GET /bundles//approvals (get the current status before choosing an eventType)
POST /rpc/submit-result-to-policy (submit the evidence this approval depends on)
POST /rpc/update-approval (change who is assigned to approve, not the approval’s status)
POST
/
api
/
governance
/
v1
/
rpc
/
publish-approval-event
Transition an approval to its next status (approve, reject, submit, cancel)
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Domino","description":"Domino helps enterprises build, deliver, and govern mission-critical AI solutions with flexible orchestration, controlled access, reproducible results, and audit trails.","colors":{"primary":"#543FDE","light":"#9285EA","dark":"#3B23D1"},"logo":{"light":"https://mintcdn.com/dominodatalab-e871cec4/19RseDYFfO5uWRyQ/images/logos/domino-wordmark-dark.svg?fit=max\u0026auto=format\u0026n=19RseDYFfO5uWRyQ\u0026q=85\u0026s=8df203aa5f663fb75fdb93fc5f26945e","dark":"https://mintcdn.com/dominodatalab-e871cec4/19RseDYFfO5uWRyQ/images/logos/domino-wordmark-white.svg?fit=max\u0026auto=format\u0026n=19RseDYFfO5uWRyQ\u0026q=85\u0026s=716407d44c47494e1e51e4be36941315","href":"https://docs.domino.ai"},"favicon":"https://mintcdn.com/dominodatalab-e871cec4/iKtTg_TEyb2C09Em/images/logos/domino-new-logo.png?fit=max\u0026auto=format\u0026n=iKtTg_TEyb2C09Em\u0026q=85\u0026s=4027a7595818d7c56608daa159290776","appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FAFAFA","dark":"#000000"}},"navbar":{"links":[{"href":"/help/help","label":"Help"}],"primary":{"type":"button","label":"Request a demo","href":"https://domino.ai/demo"}},"footer":{"socials":{"x":"https://x.com/DominoDataLab","linkedin":"https://www.linkedin.com/company/domino-data-lab","github":"https://github.com/dominodatalab","podcast":"https://domino.ai/data-science-leaders-podcast","instagram":"https://www.instagram.com/dominodotai"}},"search":{"prompt":"Search the Domino documentation"},"seo":{"organization":{"id":"https://domino.ai/#organization","name":"Domino Data Lab","legalName":"Domino Data Lab, Inc.","url":"https://domino.ai","logo":"https://docs.domino.ai/images/logos/domino-new-logo.png","sameAs":["https://x.com/DominoDataLab","https://www.linkedin.com/company/domino-data-lab","https://github.com/dominodatalab","https://www.instagram.com/dominodotai"]}},"integrations":{"gtm":{"tagId":"GTM-WBDRPKT"}},"contextual":{"options":["copy","view","assistant","claude","vscode","chatgpt","download-spec","cursor"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dominodatalab-e871cec4","hasAudioNarration":true,"actualSubdomain":"dominodatalab-e871cec4","customDomains":["docs.domino.ai"],"gitSource":{"_id":"6ad7fa90692c7c940ff17a0c","type":"github","owner":"cerebrotech","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aebde5566e4e8efb7f1e00f","collectionId":"73522eb6-3807-4791-9e42-94716b0ec9cf","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebde5566e4e8efb7f1e00f"},"feedback":{"thumbs":true,"agentFeedback":true,"contextualFeedback":{"allowEmail":true}},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aebe2fa6d96a780464e2fee","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"Reference","count":1446},{"language":"default","tag":"API","count":1416},{"language":"default","tag":"Domino Platform API","count":1224},{"language":"default","tag":"Platform Capabilities","count":505},{"language":"default","tag":"Features","count":260},{"language":"default","tag":"Admin","count":249},{"language":"default","tag":"Core Concepts","count":245},{"language":"default","tag":"Flyte native API","count":120},{"language":"default","tag":"Data","count":102},{"language":"default","tag":"NetApp Volumes","count":86}],"searchSettings":{"maxResults":8,"isFiltersEnabled":true,"showContentSnippets":true}},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"email":"support@dominodatalab.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instinct-self-updating-docs","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"[data-component-name=\"mermaid-container\"],[data-component-name=\"mermaid-container\"]>div,[data-component-name=\"mermaid-container\"] svg{background:transparent!important;background-color:transparent!important}[data-component-name=\"mermaid-container\"] svg .cluster rect{fill:transparent!important;stroke:rgba(128, 128, 128, 0.45)!important;stroke-dasharray:4 4!important}.dark [data-component-name=\"mermaid-container\"] svg .cluster text,.dark [data-component-name=\"mermaid-container\"] svg .cluster span,.dark [data-component-name=\"mermaid-container\"] svg .cluster .nodeLabel,.dark [data-component-name=\"mermaid-container\"] svg .cluster-label foreignObject span,.dark [data-component-name=\"mermaid-container\"] svg .cluster-label foreignObject p{fill:#e5e7eb!important;color:#e5e7eb!important}.dark [data-component-name=\"mermaid-container\"] svg .edgeLabel foreignObject span,.dark [data-component-name=\"mermaid-container\"] svg .edgeLabel foreignObject p{color:#0f172a!important}.dark [data-component-name=\"mermaid-container\"] svg .messageText,.dark [data-component-name=\"mermaid-container\"] svg .messageText tspan,.dark [data-component-name=\"mermaid-container\"] svg .loopText,.dark [data-component-name=\"mermaid-container\"] svg .loopText tspan,.dark [data-component-name=\"mermaid-container\"] svg .sequenceNumber{fill:#EBEBEB!important;stroke:none!important}.dark [data-component-name=\"mermaid-container\"] svg .messageLine0,.dark [data-component-name=\"mermaid-container\"] svg .messageLine1{stroke:#A5A5B6!important}.dark [data-component-name=\"mermaid-container\"] svg .loopLine{stroke:#787891!important}.dark [data-component-name=\"mermaid-container\"] svg marker path{fill:#A5A5B6!important;stroke:#A5A5B6!important}.dark [data-component-name=\"mermaid-container\"] svg .edgePaths path,.dark [data-component-name=\"mermaid-container\"] svg path.flowchart-link,.dark [data-component-name=\"mermaid-container\"] svg .transition{stroke:#8F8FA3!important}.callout[class*=\"blue-\"]{background-color:#F0EEFC!important;border-color:#D1CBF6!important}.callout[class*=\"blue-\"] svg{color:#543FDE!important}.dark .callout[class*=\"blue-\"]{background-color:rgba(84, 63, 222, 0.18)!important;border-color:rgba(146, 133, 234, 0.45)!important}.dark .callout[class*=\"blue-\"] svg{color:#B2A8F0!important}.callout[class*=\"green-\"]{background-color:#EFFBF5!important;border-color:#ADEBCB!important}.callout[class*=\"green-\"] svg{color:#28A464!important}.dark .callout[class*=\"green-\"]{background-color:rgba(48, 197, 120, 0.15)!important;border-color:rgba(48, 197, 120, 0.35)!important}.dark .callout[class*=\"green-\"] svg{color:#8CE3B6!important}.callout[class*=\"yellow-\"]{background-color:#FDFBEB!important;border-color:#F6EDAF!important}.callout[class*=\"yellow-\"] svg{color:#CCB718!important}.dark .callout[class*=\"yellow-\"]{background-color:rgba(231, 211, 54, 0.12)!important;border-color:rgba(204, 183, 24, 0.35)!important}.dark .callout[class*=\"yellow-\"] svg{color:#F1E486!important}.callout[class*=\"red-\"]{background-color:#FEECEF!important;border-color:#FCC5CE!important}.callout[class*=\"red-\"] svg{color:#E90C31!important}.dark .callout[class*=\"red-\"]{background-color:rgba(233, 12, 49, 0.15)!important;border-color:rgba(244, 42, 75, 0.35)!important}.dark .callout[class*=\"red-\"] svg{color:#FA9EAD!important}.callout[class*=\"neutral-\"]{background-color:#F7F7F7!important;border-color:#D6D6D6!important}.callout[class*=\"neutral-\"] svg{color:#65657B!important}.dark .callout[class*=\"neutral-\"]{background-color:rgba(255, 255, 255, 0.06)!important;border-color:#40404F!important}.dark .callout[class*=\"neutral-\"] svg{color:#BCBCC8!important}[data-component-name=\"mermaid-container\"]>div>svg{margin-inline:auto}[data-component-name=\"mermaid-controls-wrapper\"]{background-color:rgba(0, 0, 0, 0.04);border-radius:0.5rem;padding:2px}.dark [data-component-name=\"mermaid-controls-wrapper\"]{background-color:rgba(255, 255, 255, 0.06)}[class~=\"max-w-8xl\"],[class*=\":max-w-8xl\"]{max-width:none!important}@media (min-width: 1024px){#content-area{width:100%!important;max-width:none!important;margin-inline:auto!important}}.mdx-content,.mdx-content.prose,.prose{max-width:none!important}.chat-assistant-floating-input{display:none!important}@media (min-width: 1024px){html[data-current-path^=\"/api-reference/\"] #sidebar-content,html[data-current-path^=\"/6.3/api-reference/\"] #sidebar-content,html[data-current-path^=\"/cloud/reference\"] #sidebar-content,html[data-current-path^=\"/6.3/reference\"] #sidebar-content{width:18rem}html[data-current-path^=\"/api-reference/\"] #body-content,html[data-current-path^=\"/6.3/api-reference/\"] #body-content,html[data-current-path^=\"/cloud/reference\"] #body-content,html[data-current-path^=\"/6.3/reference\"] #body-content{padding-left:18rem}}html[data-current-path$=\"/platform-capabilities/core-concepts\"] table{font-size:1rem;line-height:1.6}@media (min-width: 768px){html[data-current-path$=\"/platform-capabilities/core-concepts\"] td:first-child,html[data-current-path$=\"/platform-capabilities/core-concepts\"] th:first-child{min-width:17rem}}html[data-current-path$=\"/reference/environment-variables\"] td code{word-break:normal;overflow-wrap:normal}"}],"page":{"pagePath":"api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel","slug":"/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel","pageMetadata":{"title":"Transition an approval to its next status (approve, reject, submit, cancel)","description":"Publishes an `eventType` against an approval and returns its updated status.\nEach `eventType` is only valid from specific current statuses — calling it from the wrong status is rejected, so check the approval's current status first:\n| From status | eventType | Resulting status |\n|---|---|---|\n| `PendingSubmission` | `RequestSubmitted` | `PendingReview` |\n| `PendingReview` | `RequestApproved` | `Approved` |\n| `PendingReview` | `RequestConditionalApproved` | `ConditionallyApproved` |\n| `PendingReview` | `RequestCancelled` | `PendingSubmission` |\n| `ConditionallyApproved` | `RequestApproved` / `FindingsApproved` | `Approved` |\n| `ConditionallyApproved` | `RequestRejected` / `RequestCancelled` | `PendingSubmission` |\n| `Approved` | `RequestRejected` | `PendingSubmission` |\n| `Approved` | `RevalidationRequired` | `PendingExpiration` |\n| `PendingExpiration` | `RequestApproved` | `Approved` |\n| `PendingExpiration` | `RequestRejected` | `PendingSubmission` |\n| `PendingExpiration` | `RevalidationExpired` | `Expired` |\n| `Expired` | `RequestSubmitted` | `PendingReview` |\n| `Expired` | `RequestApproved` | `Approved` |\n| `Expired` | `RequestRejected` | `PendingSubmission` |\nCalling an `eventType` that isn't valid for the approval's current status currently returns a generic `500` with a message like `\"invalid event RequestApproved for approval status PendingSubmission\"` — check status via `GET /bundles/{id}/approvals` first to avoid this.\n`approvalId` comes from `GET /bundles/{id}/approvals`. If omitted, `stageApprovalId` is used to resolve it instead. `stageApprovalId` identifies the approval slot defined by the policy; each bundle that has the policy applied gets its own `Approval` instance for that slot, and `stageApprovalId` resolves to that bundle-specific `approvalId`. Get it from `GET /policy-versions/{id}` (`stages[].approvals[].id`), using the bundle's actual `policyVersionId` from `GET /bundles/{id}/approvals`.\n`meta` shape depends on `eventType`:\n| eventType | meta shape |\n|---|---|\n| `RequestApproved` | `{\"result\"?: {\"evidenceId\": string, \"content\": {...}}}` — optionally submit the final evidence in the same call as approving |\n| `RequestConditionalApproved` | `{\"result\"?: {...same as above...}, \"requiredFindings\": string[]}` — `requiredFindings` (finding IDs) is required |\n| all other event types | no defined fields — send `{}` |\nRelated:\n- GET /bundles/{id}/approvals (get the current status before choosing an eventType)\n- POST /rpc/submit-result-to-policy (submit the evidence this approval depends on)\n- POST /rpc/update-approval (change who is assigned to approve, not the approval's status)","deprecated":null,"version":null,"sidebarTitle":"Transition approval status","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/publish-approval-event","href":"/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n table: \"table\",\n tbody: \"tbody\",\n td: \"td\",\n th: \"th\",\n thead: \"thead\",\n tr: \"tr\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Publishes an \", _jsx(_components.code, {\n children: \"eventType\"\n }), \" against an approval and returns its updated status.\\nEach \", _jsx(_components.code, {\n children: \"eventType\"\n }), \" is only valid from specific current statuses — calling it from the wrong status is rejected, so check the approval’s current status first:\"]\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"From status\"\n }), _jsx(_components.th, {\n children: \"eventType\"\n }), _jsx(_components.th, {\n children: \"Resulting status\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingSubmission\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestSubmitted\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingReview\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingReview\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestApproved\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"Approved\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingReview\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestConditionalApproved\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"ConditionallyApproved\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingReview\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestCancelled\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingSubmission\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"ConditionallyApproved\"\n })\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"RequestApproved\"\n }), \" / \", _jsx(_components.code, {\n children: \"FindingsApproved\"\n })]\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"Approved\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"ConditionallyApproved\"\n })\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"RequestRejected\"\n }), \" / \", _jsx(_components.code, {\n children: \"RequestCancelled\"\n })]\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingSubmission\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"Approved\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestRejected\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingSubmission\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"Approved\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RevalidationRequired\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingExpiration\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingExpiration\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestApproved\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"Approved\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingExpiration\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestRejected\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingSubmission\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingExpiration\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RevalidationExpired\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"Expired\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"Expired\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestSubmitted\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingReview\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"Expired\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestApproved\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"Approved\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"Expired\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestRejected\"\n })\n }), _jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"PendingSubmission\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n children: [\"Calling an \", _jsx(_components.code, {\n children: \"eventType\"\n }), \" that isn’t valid for the approval’s current status currently returns a generic \", _jsx(_components.code, {\n children: \"500\"\n }), \" with a message like \", _jsx(_components.code, {\n children: \"\\\"invalid event RequestApproved for approval status PendingSubmission\\\"\"\n }), \" — check status via \", _jsx(_components.code, {\n children: \"GET /bundles/{id}/approvals\"\n }), \" first to avoid this.\"]\n }), _jsx(_components.td, {}), _jsx(_components.td, {})]\n }), _jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"approvalId\"\n }), \" comes from \", _jsx(_components.code, {\n children: \"GET /bundles/{id}/approvals\"\n }), \". If omitted, \", _jsx(_components.code, {\n children: \"stageApprovalId\"\n }), \" is used to resolve it instead. \", _jsx(_components.code, {\n children: \"stageApprovalId\"\n }), \" identifies the approval slot defined by the policy; each bundle that has the policy applied gets its own \", _jsx(_components.code, {\n children: \"Approval\"\n }), \" instance for that slot, and \", _jsx(_components.code, {\n children: \"stageApprovalId\"\n }), \" resolves to that bundle-specific \", _jsx(_components.code, {\n children: \"approvalId\"\n }), \". Get it from \", _jsx(_components.code, {\n children: \"GET /policy-versions/{id}\"\n }), \" (\", _jsx(_components.code, {\n children: \"stages[].approvals[].id\"\n }), \"), using the bundle’s actual \", _jsx(_components.code, {\n children: \"policyVersionId\"\n }), \" from \", _jsx(_components.code, {\n children: \"GET /bundles/{id}/approvals\"\n }), \".\"]\n }), _jsx(_components.td, {}), _jsx(_components.td, {})]\n }), _jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"meta\"\n }), \" shape depends on \", _jsx(_components.code, {\n children: \"eventType\"\n }), \":\"]\n }), _jsx(_components.td, {}), _jsx(_components.td, {})]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"eventType\"\n }), _jsx(_components.td, {\n children: \"meta shape\"\n }), _jsx(_components.td, {})]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"---\"\n }), _jsx(_components.td, {\n children: \"---\"\n }), _jsx(_components.td, {})]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestApproved\"\n })\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"{\\\"result\\\"?: {\\\"evidenceId\\\": string, \\\"content\\\": {...}}}\"\n }), \" — optionally submit the final evidence in the same call as approving\"]\n }), _jsx(_components.td, {})]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"RequestConditionalApproved\"\n })\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"{\\\"result\\\"?: {...same as above...}, \\\"requiredFindings\\\": string[]}\"\n }), \" — \", _jsx(_components.code, {\n children: \"requiredFindings\"\n }), \" (finding IDs) is required\"]\n }), _jsx(_components.td, {})]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"all other event types\"\n }), _jsxs(_components.td, {\n children: [\"no defined fields — send \", _jsx(_components.code, {\n children: \"{}\"\n })]\n }), _jsx(_components.td, {})]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"Related:\"\n }), _jsx(_components.td, {}), _jsx(_components.td, {})]\n })]\n })]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"GET /bundles/\", \"/approvals (get the current status before choosing an eventType)\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"POST /rpc/submit-result-to-policy (submit the evidence this approval depends on)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"POST /rpc/update-approval (change who is assigned to approve, not the approval’s status)\"\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Transition an approval to its next status (approve, reject, submit, cancel)","description":"Publishes an `eventType` against an approval and returns its updated status.\nEach `eventType` is only valid from specific current statuses — calling it from the wrong status is rejected, so check the approval's current status first:\n| From status | eventType | Resulting status |\n|---|---|---|\n| `PendingSubmission` | `RequestSubmitted` | `PendingReview` |\n| `PendingReview` | `RequestApproved` | `Approved` |\n| `PendingReview` | `RequestConditionalApproved` | `ConditionallyApproved` |\n| `PendingReview` | `RequestCancelled` | `PendingSubmission` |\n| `ConditionallyApproved` | `RequestApproved` / `FindingsApproved` | `Approved` |\n| `ConditionallyApproved` | `RequestRejected` / `RequestCancelled` | `PendingSubmission` |\n| `Approved` | `RequestRejected` | `PendingSubmission` |\n| `Approved` | `RevalidationRequired` | `PendingExpiration` |\n| `PendingExpiration` | `RequestApproved` | `Approved` |\n| `PendingExpiration` | `RequestRejected` | `PendingSubmission` |\n| `PendingExpiration` | `RevalidationExpired` | `Expired` |\n| `Expired` | `RequestSubmitted` | `PendingReview` |\n| `Expired` | `RequestApproved` | `Approved` |\n| `Expired` | `RequestRejected` | `PendingSubmission` |\nCalling an `eventType` that isn't valid for the approval's current status currently returns a generic `500` with a message like `\"invalid event RequestApproved for approval status PendingSubmission\"` — check status via `GET /bundles/{id}/approvals` first to avoid this.\n`approvalId` comes from `GET /bundles/{id}/approvals`. If omitted, `stageApprovalId` is used to resolve it instead. `stageApprovalId` identifies the approval slot defined by the policy; each bundle that has the policy applied gets its own `Approval` instance for that slot, and `stageApprovalId` resolves to that bundle-specific `approvalId`. Get it from `GET /policy-versions/{id}` (`stages[].approvals[].id`), using the bundle's actual `policyVersionId` from `GET /bundles/{id}/approvals`.\n`meta` shape depends on `eventType`:\n| eventType | meta shape |\n|---|---|\n| `RequestApproved` | `{\"result\"?: {\"evidenceId\": string, \"content\": {...}}}` — optionally submit the final evidence in the same call as approving |\n| `RequestConditionalApproved` | `{\"result\"?: {...same as above...}, \"requiredFindings\": string[]}` — `requiredFindings` (finding IDs) is required |\n| all other event types | no defined fields — send `{}` |\nRelated:\n- GET /bundles/{id}/approvals (get the current status before choosing an eventType)\n- POST /rpc/submit-result-to-policy (submit the evidence this approval depends on)\n- POST /rpc/update-approval (change who is assigned to approve, not the approval's status)","deprecated":null,"version":null,"sidebarTitle":"Transition approval status","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/publish-approval-event","href":"/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Publishes an `eventType` against an approval and returns its updated status.\nEach `eventType` is only valid from specific current statuses — calling it from the wrong status is rejected, so check the approval's current status first:\n| From status | eventType | Resulting status |\n|---|---|---|\n| `PendingSubmission` | `RequestSubmitted` | `PendingReview` |\n| `PendingReview` | `RequestApproved` | `Approved` |\n| `PendingReview` | `RequestConditionalApproved` | `ConditionallyApproved` |\n| `PendingReview` | `RequestCancelled` | `PendingSubmission` |\n| `ConditionallyApproved` | `RequestApproved` / `FindingsApproved` | `Approved` |\n| `ConditionallyApproved` | `RequestRejected` / `RequestCancelled` | `PendingSubmission` |\n| `Approved` | `RequestRejected` | `PendingSubmission` |\n| `Approved` | `RevalidationRequired` | `PendingExpiration` |\n| `PendingExpiration` | `RequestApproved` | `Approved` |\n| `PendingExpiration` | `RequestRejected` | `PendingSubmission` |\n| `PendingExpiration` | `RevalidationExpired` | `Expired` |\n| `Expired` | `RequestSubmitted` | `PendingReview` |\n| `Expired` | `RequestApproved` | `Approved` |\n| `Expired` | `RequestRejected` | `PendingSubmission` |\nCalling an `eventType` that isn't valid for the approval's current status currently returns a generic `500` with a message like `\"invalid event RequestApproved for approval status PendingSubmission\"` — check status via `GET /bundles/{id}/approvals` first to avoid this.\n`approvalId` comes from `GET /bundles/{id}/approvals`. If omitted, `stageApprovalId` is used to resolve it instead. `stageApprovalId` identifies the approval slot defined by the policy; each bundle that has the policy applied gets its own `Approval` instance for that slot, and `stageApprovalId` resolves to that bundle-specific `approvalId`. Get it from `GET /policy-versions/{id}` (`stages[].approvals[].id`), using the bundle's actual `policyVersionId` from `GET /bundles/{id}/approvals`.\n`meta` shape depends on `eventType`:\n| eventType | meta shape |\n|---|---|\n| `RequestApproved` | `{\"result\"?: {\"evidenceId\": string, \"content\": {...}}}` — optionally submit the final evidence in the same call as approving |\n| `RequestConditionalApproved` | `{\"result\"?: {...same as above...}, \"requiredFindings\": string[]}` — `requiredFindings` (finding IDs) is required |\n| all other event types | no defined fields — send `{}` |\nRelated:\n- GET /bundles/{id}/approvals (get the current status before choosing an eventType)\n- POST /rpc/submit-result-to-policy (submit the evidence this approval depends on)\n- POST /rpc/update-approval (change who is assigned to approve, not the approval's status)","tags":["Governance operations"],"summary":"Transition an approval to its next status (approve, reject, submit, cancel)","requestBody":"9f63a2e5-836c-4c70-ba31-8a7408c2e154","responses":{"200":"74b6f2c3-97da-4d15-ac68-ea0d9addc716","400":"bd11126b-f123-49a7-9ae4-2e70cb36c2e3","403":"24f6f784-2b10-4b68-82fa-7cfb10e2f7af","404":"0f795450-4408-4b4a-8bbf-b193217f42c1","423":"db75297d-8de2-447d-a5a5-7a0e1a76b8e2","500":"3d5ab793-479f-4a66-966f-9275667c8e55"},"x-audience":"public","x-internal":false,"x-scalar-stability":"stable","x-stability-level":"stable","x-mint":{"metadata":{"sidebarTitle":"Transition approval status"}},"method":"post","type":"path","servers":["31464763-7af3-4192-a281-49182c2e63b9"],"security":[],"path":"/api/governance/v1/rpc/publish-approval-event","baseUrlOptions":["https://mycluster.domino.tech"],"title":"Transition an approval to its next status (approve, reject, submit, cancel)","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bundleId","eventType","policyId","projectId"],"properties":{"bundleId":{"type":"string","isRequired":true,"uniqueKey":"bundleId","typeLabel":"string"},"eventType":{"type":"string","enum":["RequestSubmitted","RequestCancelled","RequestApproved","RequestConditionalApproved","RequestRejected","FindingsApproved","PolicyReactivated","RevalidationRequired","RevalidationExpired","PolicyVersionUpgraded"],"x-enum-varnames":["RequestSubmitted","RequestCancelled","RequestApproved","RequestConditionalApproved","RequestRejected","FindingsApproved","PolicyReactivated","RevalidationRequired","RevalidationExpired","PolicyVersionUpgraded"],"isRequired":true,"uniqueKey":"eventType","typeLabel":"enum\u003cstring>"},"policyId":{"type":"string","isRequired":true,"uniqueKey":"policyId","typeLabel":"string"},"projectId":{"type":"string","isRequired":true,"uniqueKey":"projectId","typeLabel":"string"},"approvalId":{"type":"string","uniqueKey":"approvalId","typeLabel":"string"},"meta":{"type":"object","uniqueKey":"meta","typeLabel":"object"},"stageApprovalId":{"type":"string","uniqueKey":"stageApprovalId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"bundleId":"\u003cstring>","policyId":"\u003cstring>","projectId":"\u003cstring>","approvalId":"\u003cstring>","meta":{},"stageApprovalId":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Request for publishing an approval event","required":true,"exampleType":"generated"},"responses":{"74b6f2c3-97da-4d15-ac68-ea0d9addc716":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"approvers":{"type":"array","items":{"type":"object","required":["editable","id","name","showByDefault"],"properties":{"editable":{"type":"boolean","isRequired":true,"uniqueKey":"approvers.items.[INDEX].editable","typeLabel":"boolean"},"id":{"type":"string","isRequired":true,"uniqueKey":"approvers.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"approvers.items.[INDEX].name","typeLabel":"string"},"showByDefault":{"type":"boolean","isRequired":true,"uniqueKey":"approvers.items.[INDEX].showByDefault","typeLabel":"boolean"},"fromOrganizationUserId":{"type":"string","uniqueKey":"approvers.items.[INDEX].fromOrganizationUserId","typeLabel":"string"},"isOrganizationUser":{"type":"boolean","uniqueKey":"approvers.items.[INDEX].isOrganizationUser","typeLabel":"boolean"}},"uniqueKey":"approvers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"approvers","typeLabel":"object[]"},"bundleId":{"type":"string","uniqueKey":"bundleId","typeLabel":"string"},"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"policyId":{"type":"string","uniqueKey":"policyId","typeLabel":"string"},"policyVersionId":{"type":"string","uniqueKey":"policyVersionId","typeLabel":"string"},"revalidation":{"type":"object","properties":{"createdAt":{"type":"string","uniqueKey":"revalidation.createdAt","typeLabel":"string"},"createdBy":{"type":"object","properties":{"firstName":{"type":"string","uniqueKey":"revalidation.createdBy.firstName","typeLabel":"string"},"id":{"type":"string","uniqueKey":"revalidation.createdBy.id","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"revalidation.createdBy.lastName","typeLabel":"string"},"userName":{"type":"string","uniqueKey":"revalidation.createdBy.userName","typeLabel":"string"}},"uniqueKey":"revalidation.createdBy","typeLabel":"object"},"firstApprovedAt":{"type":"string","uniqueKey":"revalidation.firstApprovedAt","typeLabel":"string"},"isOverride":{"type":"boolean","uniqueKey":"revalidation.isOverride","typeLabel":"boolean"},"nextDeadlineAt":{"type":"string","uniqueKey":"revalidation.nextDeadlineAt","typeLabel":"string"},"revalidationConfig":{"type":"object","required":["openWindowDaysBefore","recurring","type"],"properties":{"openWindowDaysBefore":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"revalidation.revalidationConfig.openWindowDaysBefore","typeLabel":"integer"},"recurring":{"type":"object","required":["every","unit"],"properties":{"every":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"revalidation.revalidationConfig.recurring.every","typeLabel":"integer"},"unit":{"type":"string","enum":["month","year"],"x-enum-varnames":["RevalidationUnitMonth","RevalidationUnitYear"],"isRequired":true,"uniqueKey":"revalidation.revalidationConfig.recurring.unit","typeLabel":"enum\u003cstring>"},"startDate":{"type":"string","uniqueKey":"revalidation.revalidationConfig.recurring.startDate","typeLabel":"string"}},"isRequired":true,"uniqueKey":"revalidation.revalidationConfig.recurring","typeLabel":"object"},"type":{"type":"string","enum":["absolute","relative"],"x-enum-varnames":["RevalidationTypeAbsolute","RevalidationTypeRelative"],"isRequired":true,"uniqueKey":"revalidation.revalidationConfig.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"revalidation.revalidationConfig","typeLabel":"object"},"revalidationPeriodStartsAt":{"type":"string","uniqueKey":"revalidation.revalidationPeriodStartsAt","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"revalidation.updatedAt","typeLabel":"string"},"updatedBy":{"type":"object","properties":{"firstName":{"type":"string","uniqueKey":"revalidation.updatedBy.firstName","typeLabel":"string"},"id":{"type":"string","uniqueKey":"revalidation.updatedBy.id","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"revalidation.updatedBy.lastName","typeLabel":"string"},"userName":{"type":"string","uniqueKey":"revalidation.updatedBy.userName","typeLabel":"string"}},"uniqueKey":"revalidation.updatedBy","typeLabel":"object"}},"uniqueKey":"revalidation","typeLabel":"object"},"stageApprovalId":{"type":"string","uniqueKey":"stageApprovalId","typeLabel":"string"},"status":{"type":"string","enum":["PendingSubmission","PendingReview","Approved","ConditionallyApproved","PendingExpiration","Expired"],"x-enum-varnames":["PendingSubmission","PendingReview","Approved","ConditionallyApproved","PendingExpiration","Expired"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"taskId":{"type":"string","uniqueKey":"taskId","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"updatedAt","typeLabel":"string"},"updatedBy":{"type":"object","uniqueKey":"updatedBy","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"approvers":[{"editable":true,"id":"\u003cstring>","name":"\u003cstring>","showByDefault":true,"fromOrganizationUserId":"\u003cstring>","isOrganizationUser":true}],"bundleId":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","policyId":"\u003cstring>","policyVersionId":"\u003cstring>","revalidation":{"createdAt":"\u003cstring>","createdBy":{"firstName":"\u003cstring>","id":"\u003cstring>","lastName":"\u003cstring>","userName":"\u003cstring>"},"firstApprovedAt":"\u003cstring>","isOverride":true,"nextDeadlineAt":"\u003cstring>","revalidationConfig":{"openWindowDaysBefore":2,"recurring":{"every":2,"unit":"month","startDate":"\u003cstring>"},"type":"absolute"},"revalidationPeriodStartsAt":"\u003cstring>","updatedAt":"\u003cstring>","updatedBy":{"firstName":"\u003cstring>","id":"\u003cstring>","lastName":"\u003cstring>","userName":"\u003cstring>"}},"stageApprovalId":"\u003cstring>","status":"PendingSubmission","taskId":"\u003cstring>","updatedAt":"\u003cstring>","updatedBy":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"bd11126b-f123-49a7-9ae4-2e70cb36c2e3":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Code is a stable machine-readable error identifier; absent on most errors.","enum":["BUNDLE_REQUIRES_POLICY"],"x-enum-varnames":["CodeBundleRequiresPolicy"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BUNDLE_REQUIRES_POLICY","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"24f6f784-2b10-4b68-82fa-7cfb10e2f7af":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Code is a stable machine-readable error identifier; absent on most errors.","enum":["BUNDLE_REQUIRES_POLICY"],"x-enum-varnames":["CodeBundleRequiresPolicy"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BUNDLE_REQUIRES_POLICY","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0f795450-4408-4b4a-8bbf-b193217f42c1":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Code is a stable machine-readable error identifier; absent on most errors.","enum":["BUNDLE_REQUIRES_POLICY"],"x-enum-varnames":["CodeBundleRequiresPolicy"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BUNDLE_REQUIRES_POLICY","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"db75297d-8de2-447d-a5a5-7a0e1a76b8e2":{"description":"Locked","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Code is a stable machine-readable error identifier; absent on most errors.","enum":["BUNDLE_REQUIRES_POLICY"],"x-enum-varnames":["CodeBundleRequiresPolicy"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BUNDLE_REQUIRES_POLICY","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3d5ab793-479f-4a66-966f-9275667c8e55":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Code is a stable machine-readable error identifier; absent on most errors.","enum":["BUNDLE_REQUIRES_POLICY"],"x-enum-varnames":["CodeBundleRequiresPolicy"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BUNDLE_REQUIRES_POLICY","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"31464763-7af3-4192-a281-49182c2e63b9":{"url":"https://mycluster.domino.tech","description":"Replace 'mycluster.domino.tech' with your Domino cluster hostname. For Domino Cloud customers, that is `your-subdomain`.domino.tech (e.g., acme.domino.tech). For self-hosted deployments, it is the hostname you reach the Domino UI at."}}},"originalFileLocation":"api-specs/cloud/public-api.json"},"subdomain":"dominodatalab-e871cec4","siteName":"Domino","title":"Transition an approval to its next status (approve, reject, submit, cancel) - Domino","relatedPagesConfig":{"enabled":true,"limit":4,"mode":"automatic"},"contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{"Cloud":{"href":"/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel","matchLevel":0},"6.3":{"href":"/6.3/platform-overview/domino-overview","matchLevel":4}},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Publishes an eventType against an approval and returns its updated status. Each eventType is only valid from specific current statuses — calling it from the wrong status is rejected, so check the approval\u0026#x27;s current status first: | From status | eventType | Resulting status | |---|---|---| | PendingSubmission | RequestSubmitted | PendingReview | | PendingReview | RequestApproved | Approved | | PendingReview | RequestConditionalApproved | ConditionallyApproved | | PendingReview | RequestCancelled | PendingSubmission | | ConditionallyApproved | RequestApproved / FindingsApproved | Approved | | ConditionallyApproved | RequestRejected / RequestCancelled | PendingSubmission | | Approved | RequestRejected | PendingSubmission | | Approved | RevalidationRequired | PendingExpiration | | PendingExpiration | RequestApproved | Approved | | PendingExpiration | RequestRejected | PendingSubmission | | PendingExpiration | RevalidationExpired | Expired | | Expired | RequestSubmitted | PendingReview | | Expired | RequestApproved | Approved | | Expired | RequestRejected | PendingSubmission | Calling an eventType that isn\u0026#x27;t valid for the approval\u0026#x27;s current status currently returns a generic 500 with a message like \u0026quot;invalid event RequestApproved for approval status PendingSubmission\u0026quot; — check status via GET /bundles/{id}/approvals first to avoid this. approvalId comes from GET /bundles/{id}/approvals. If omitted, stageApprovalId is used to resolve it instead. stageApprovalId identifies the approval slot defined by the policy; each bundle that has the policy applied gets its own Approval instance for that slot, and stageApprovalId resolves to that bundle-specific approvalId. Get it from GET /policy-versions/{id} (stages[].approvals[].id), using the bundle\u0026#x27;s actual policyVersionId from GET /bundles/{id}/approvals. meta shape depends on eventType: | eventType | meta shape | |---|---| | RequestApproved | {\u0026quot;result\u0026quot;?: {\u0026quot;evidenceId\u0026quot;: string, \u0026quot;content\u0026quot;: {...}}} — optionally submit the final evidence in the same call as approving | | RequestConditionalApproved | {\u0026quot;result\u0026quot;?: {...same as above...}, \u0026quot;requiredFindings\u0026quot;: string[]} — requiredFindings (finding IDs) is required | | all other event types | no defined fields — send {} | Related: - GET /bundles/{id}/approvals (get the current status before choosing an eventType) - POST /rpc/submit-result-to-policy (submit the evidence this approval depends on) - POST /rpc/update-approval (change who is assigned to approve, not the approval\u0026#x27;s status)\">\u003cmeta data-mint-head name=\"application-name\" content=\"Domino\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dominodatalab-e871cec4/KGOwUzMGKfHLwDvz/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/dominodatalab-e871cec4/KGOwUzMGKfHLwDvz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dominodatalab-e871cec4/KGOwUzMGKfHLwDvz/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dominodatalab-e871cec4/KGOwUzMGKfHLwDvz/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dominodatalab-e871cec4/KGOwUzMGKfHLwDvz/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dominodatalab-e871cec4/KGOwUzMGKfHLwDvz/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dominodatalab-e871cec4/KGOwUzMGKfHLwDvz/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dominodatalab-e871cec4/KGOwUzMGKfHLwDvz/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dominodatalab-e871cec4/KGOwUzMGKfHLwDvz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Transition an approval to its next status (approve, reject, submit, cancel) - Domino\">\u003cmeta data-mint-head property=\"og:description\" content=\"Publishes an eventType against an approval and returns its updated status. Each eventType is only valid from specific current statuses — calling it from the wrong status is rejected, so check the approval\u0026#x27;s current status first: | From status | eventType | Resulting status | |---|---|---| | PendingSubmission | RequestSubmitted | PendingReview | | PendingReview | RequestApproved | Approved | | PendingReview | RequestConditionalApproved | ConditionallyApproved | | PendingReview | RequestCancelled | PendingSubmission | | ConditionallyApproved | RequestApproved / FindingsApproved | Approved | | ConditionallyApproved | RequestRejected / RequestCancelled | PendingSubmission | | Approved | RequestRejected | PendingSubmission | | Approved | RevalidationRequired | PendingExpiration | | PendingExpiration | RequestApproved | Approved | | PendingExpiration | RequestRejected | PendingSubmission | | PendingExpiration | RevalidationExpired | Expired | | Expired | RequestSubmitted | PendingReview | | Expired | RequestApproved | Approved | | Expired | RequestRejected | PendingSubmission | Calling an eventType that isn\u0026#x27;t valid for the approval\u0026#x27;s current status currently returns a generic 500 with a message like \u0026quot;invalid event RequestApproved for approval status PendingSubmission\u0026quot; — check status via GET /bundles/{id}/approvals first to avoid this. approvalId comes from GET /bundles/{id}/approvals. If omitted, stageApprovalId is used to resolve it instead. stageApprovalId identifies the approval slot defined by the policy; each bundle that has the policy applied gets its own Approval instance for that slot, and stageApprovalId resolves to that bundle-specific approvalId. Get it from GET /policy-versions/{id} (stages[].approvals[].id), using the bundle\u0026#x27;s actual policyVersionId from GET /bundles/{id}/approvals. meta shape depends on eventType: | eventType | meta shape | |---|---| | RequestApproved | {\u0026quot;result\u0026quot;?: {\u0026quot;evidenceId\u0026quot;: string, \u0026quot;content\u0026quot;: {...}}} — optionally submit the final evidence in the same call as approving | | RequestConditionalApproved | {\u0026quot;result\u0026quot;?: {...same as above...}, \u0026quot;requiredFindings\u0026quot;: string[]} — requiredFindings (finding IDs) is required | | all other event types | no defined fields — send {} | Related: - GET /bundles/{id}/approvals (get the current status before choosing an eventType) - POST /rpc/submit-result-to-policy (submit the evidence this approval depends on) - POST /rpc/update-approval (change who is assigned to approve, not the approval\u0026#x27;s status)\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Domino\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.domino.ai/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dominodatalab-e871cec4.mintlify.app/_mintlify/api/og/v2?division=Governance+operations\u0026amp;title=Transition+an+approval+to+its+next+status+%28approve%2C+reject%2C+submit%2C+cancel%29\u0026amp;description=Publishes+an+%60eventType%60+against+an+approval+and+returns+its+updated+status.%0AEach+%60eventType%60+is+only+valid+from+specific+current+statuses+%E2%80%94+calling+it+from+the\u0026amp;theme=e2a3909a506094ea4997f210\u0026amp;signature=7ac5c4041fe8205865522521d328699ddec7887af5c3b59760f3c0ccaa7f8034\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Transition an approval to its next status (approve, reject, submit, cancel) - Domino\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Publishes an eventType against an approval and returns its updated status. Each eventType is only valid from specific current statuses — calling it from the wrong status is rejected, so check the approval\u0026#x27;s current status first: | From status | eventType | Resulting status | |---|---|---| | PendingSubmission | RequestSubmitted | PendingReview | | PendingReview | RequestApproved | Approved | | PendingReview | RequestConditionalApproved | ConditionallyApproved | | PendingReview | RequestCancelled | PendingSubmission | | ConditionallyApproved | RequestApproved / FindingsApproved | Approved | | ConditionallyApproved | RequestRejected / RequestCancelled | PendingSubmission | | Approved | RequestRejected | PendingSubmission | | Approved | RevalidationRequired | PendingExpiration | | PendingExpiration | RequestApproved | Approved | | PendingExpiration | RequestRejected | PendingSubmission | | PendingExpiration | RevalidationExpired | Expired | | Expired | RequestSubmitted | PendingReview | | Expired | RequestApproved | Approved | | Expired | RequestRejected | PendingSubmission | Calling an eventType that isn\u0026#x27;t valid for the approval\u0026#x27;s current status currently returns a generic 500 with a message like \u0026quot;invalid event RequestApproved for approval status PendingSubmission\u0026quot; — check status via GET /bundles/{id}/approvals first to avoid this. approvalId comes from GET /bundles/{id}/approvals. If omitted, stageApprovalId is used to resolve it instead. stageApprovalId identifies the approval slot defined by the policy; each bundle that has the policy applied gets its own Approval instance for that slot, and stageApprovalId resolves to that bundle-specific approvalId. Get it from GET /policy-versions/{id} (stages[].approvals[].id), using the bundle\u0026#x27;s actual policyVersionId from GET /bundles/{id}/approvals. meta shape depends on eventType: | eventType | meta shape | |---|---| | RequestApproved | {\u0026quot;result\u0026quot;?: {\u0026quot;evidenceId\u0026quot;: string, \u0026quot;content\u0026quot;: {...}}} — optionally submit the final evidence in the same call as approving | | RequestConditionalApproved | {\u0026quot;result\u0026quot;?: {...same as above...}, \u0026quot;requiredFindings\u0026quot;: string[]} — requiredFindings (finding IDs) is required | | all other event types | no defined fields — send {} | Related: - GET /bundles/{id}/approvals (get the current status before choosing an eventType) - POST /rpc/submit-result-to-policy (submit the evidence this approval depends on) - POST /rpc/update-approval (change who is assigned to approve, not the approval\u0026#x27;s status)\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dominodatalab-e871cec4.mintlify.app/_mintlify/api/og/v2?division=Governance+operations\u0026amp;title=Transition+an+approval+to+its+next+status+%28approve%2C+reject%2C+submit%2C+cancel%29\u0026amp;description=Publishes+an+%60eventType%60+against+an+approval+and+returns+its+updated+status.%0AEach+%60eventType%60+is+only+valid+from+specific+current+statuses+%E2%80%94+calling+it+from+the\u0026amp;theme=e2a3909a506094ea4997f210\u0026amp;signature=7ac5c4041fe8205865522521d328699ddec7887af5c3b59760f3c0ccaa7f8034\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/dominodatalab-e871cec4/KGOwUzMGKfHLwDvz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Domino\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#543FDE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.domino.ai/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://domino.ai/#organization\",\"name\":\"Domino Data Lab\",\"legalName\":\"Domino Data Lab, Inc.\",\"url\":\"https://domino.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.domino.ai/images/logos/domino-new-logo.png\"},\"sameAs\":[\"https://x.com/DominoDataLab\",\"https://www.linkedin.com/company/domino-data-lab\",\"https://github.com/dominodatalab\",\"https://www.instagram.com/dominodotai\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.domino.ai#website\",\"name\":\"Domino\",\"url\":\"https://docs.domino.ai\",\"publisher\":{\"@id\":\"https://domino.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.domino.ai/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel#webpage\",\"url\":\"https://docs.domino.ai/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel\",\"name\":\"Transition an approval to its next status (approve, reject, submit, cancel)\",\"description\":\"Publishes an eventType against an approval and returns its updated status. Each eventType is only valid from specific current statuses — calling it from the wrong status is rejected, so check the approval's current status first: | From status | eventType | Resulting status | |---|---|---| | PendingSubmission | RequestSubmitted | PendingReview | | PendingReview | RequestApproved | Approved | | PendingReview | RequestConditionalApproved | ConditionallyApproved | | PendingReview | RequestCancelled | PendingSubmission | | ConditionallyApproved | RequestApproved / FindingsApproved | Approved | | ConditionallyApproved | RequestRejected / RequestCancelled | PendingSubmission | | Approved | RequestRejected | PendingSubmission | | Approved | RevalidationRequired | PendingExpiration | | PendingExpiration | RequestApproved | Approved | | PendingExpiration | RequestRejected | PendingSubmission | | PendingExpiration | RevalidationExpired | Expired | | Expired | RequestSubmitted | PendingReview | | Expired | RequestApproved | Approved | | Expired | RequestRejected | PendingSubmission | Calling an eventType that isn't valid for the approval's current status currently returns a generic 500 with a message like \\\"invalid event RequestApproved for approval status PendingSubmission\\\" — check status via GET /bundles/{id}/approvals first to avoid this. approvalId comes from GET /bundles/{id}/approvals. If omitted, stageApprovalId is used to resolve it instead. stageApprovalId identifies the approval slot defined by the policy; each bundle that has the policy applied gets its own Approval instance for that slot, and stageApprovalId resolves to that bundle-specific approvalId. Get it from GET /policy-versions/{id} (stages[].approvals[].id), using the bundle's actual policyVersionId from GET /bundles/{id}/approvals. meta shape depends on eventType: | eventType | meta shape | |---|---| | RequestApproved | {\\\"result\\\"?: {\\\"evidenceId\\\": string, \\\"content\\\": {...}}} — optionally submit the final evidence in the same call as approving | | RequestConditionalApproved | {\\\"result\\\"?: {...same as above...}, \\\"requiredFindings\\\": string[]} — requiredFindings (finding IDs) is required | | all other event types | no defined fields — send {} | Related: - GET /bundles/{id}/approvals (get the current status before choosing an eventType) - POST /rpc/submit-result-to-policy (submit the evidence this approval depends on) - POST /rpc/update-approval (change who is assigned to approve, not the approval's status)\",\"isPartOf\":{\"@id\":\"https://docs.domino.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.domino.ai/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.domino.ai/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API\",\"item\":\"https://docs.domino.ai/cloud/reference/api/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Domino Platform API\",\"item\":\"https://docs.domino.ai/cloud/reference/api/domino-open-api\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Governance operations\",\"item\":\"https://docs.domino.ai/api-reference/governance-operations/[beta]-analyze-model-monitor-metrics\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Transition an approval to its next status (approve, reject, submit, cancel)\",\"item\":\"https://docs.domino.ai/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.domino.ai/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel#apireference\",\"headline\":\"Transition an approval to its next status (approve, reject, submit, cancel)\",\"name\":\"Transition an approval to its next status (approve, reject, submit, cancel)\",\"description\":\"Publishes an eventType against an approval and returns its updated status. Each eventType is only valid from specific current statuses — calling it from the wrong status is rejected, so check the approval's current status first: | From status | eventType | Resulting status | |---|---|---| | PendingSubmission | RequestSubmitted | PendingReview | | PendingReview | RequestApproved | Approved | | PendingReview | RequestConditionalApproved | ConditionallyApproved | | PendingReview | RequestCancelled | PendingSubmission | | ConditionallyApproved | RequestApproved / FindingsApproved | Approved | | ConditionallyApproved | RequestRejected / RequestCancelled | PendingSubmission | | Approved | RequestRejected | PendingSubmission | | Approved | RevalidationRequired | PendingExpiration | | PendingExpiration | RequestApproved | Approved | | PendingExpiration | RequestRejected | PendingSubmission | | PendingExpiration | RevalidationExpired | Expired | | Expired | RequestSubmitted | PendingReview | | Expired | RequestApproved | Approved | | Expired | RequestRejected | PendingSubmission | Calling an eventType that isn't valid for the approval's current status currently returns a generic 500 with a message like \\\"invalid event RequestApproved for approval status PendingSubmission\\\" — check status via GET /bundles/{id}/approvals first to avoid this. approvalId comes from GET /bundles/{id}/approvals. If omitted, stageApprovalId is used to resolve it instead. stageApprovalId identifies the approval slot defined by the policy; each bundle that has the policy applied gets its own Approval instance for that slot, and stageApprovalId resolves to that bundle-specific approvalId. Get it from GET /policy-versions/{id} (stages[].approvals[].id), using the bundle's actual policyVersionId from GET /bundles/{id}/approvals. meta shape depends on eventType: | eventType | meta shape | |---|---| | RequestApproved | {\\\"result\\\"?: {\\\"evidenceId\\\": string, \\\"content\\\": {...}}} — optionally submit the final evidence in the same call as approving | | RequestConditionalApproved | {\\\"result\\\"?: {...same as above...}, \\\"requiredFindings\\\": string[]} — requiredFindings (finding IDs) is required | | all other event types | no defined fields — send {} | Related: - GET /bundles/{id}/approvals (get the current status before choosing an eventType) - POST /rpc/submit-result-to-policy (submit the evidence this approval depends on) - POST /rpc/update-approval (change who is assigned to approve, not the approval's status)\",\"url\":\"https://docs.domino.ai/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel\",\"mainEntityOfPage\":{\"@id\":\"https://docs.domino.ai/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel#webpage\"},\"publisher\":{\"@id\":\"https://domino.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.domino.ai#website\"}}]}\u003c/script>","siteName":"Domino","nav":{"global":null,"versions":[{"version":"Cloud","tabs":[{"tab":"Platform Overview","pages":[{"title":"Platform Overview","href":"/cloud/platform-overview/domino-overview"}]},{"tab":"Platform Capabilities","pages":[{"title":"Platform Capabilities","href":"/platform-capabilities/core-concepts"}]},{"tab":"Admin","pages":[{"title":"Admin","href":"/cloud/admin"}]},{"tab":"Reference","pages":[{"title":"Reference","href":"/cloud/reference"},{"group":"API","boost":0.9,"root":{"title":"API","href":"/cloud/reference/api/index"},"pages":[{"title":"Domino API authentication","href":"/cloud/reference/api/domino-api-authentication"},{"group":"Domino Platform API","root":{"title":"Domino Platform API reference","href":"/cloud/reference/api/domino-open-api"},"pages":[{"group":"Projects","pages":[{"title":"Get Projects visible to user","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/projects/beta/projects","href":"/api-reference/projects/get-projects-visible-to-user"},{"title":"Create a project","deprecated":null,"version":null,"sidebarTitle":"Create Project (beta)","openapi":"/api-specs/cloud/public-api.json post /api/projects/beta/projects","href":"/api-reference/projects/create-a-project"},{"title":"Archive project by id","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/projects/beta/projects/{projectId}","href":"/api-reference/projects/archive-project-by-id"},{"title":"Get DFS head commit","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/projects/beta/projects/{projectId}/commits/latest","href":"/api-reference/projects/get-dfs-head-commit"},{"title":"Resolve a git reference to a commit SHA","deprecated":null,"version":null,"sidebarTitle":"Resolve Git ref","openapi":"/api-specs/cloud/public-api.json post /api/projects/beta/projects/{projectId}/commits/resolveGitRef","href":"/api-reference/projects/resolve-a-git-reference-to-a-commit-sha"},{"title":"Returns the contents of a file (deprecated, use v1 endpoint instead)","deprecated":null,"version":null,"sidebarTitle":"Get file contents (deprecated)","openapi":"/api-specs/cloud/public-api.json get /api/projects/beta/projects/{projectId}/files/{commitId}/{path}/content","href":"/api-reference/projects/returns-the-contents-of-a-file-deprecated-use-v1-endpoint-instead"},{"title":"Resolve a git reference to a commit SHA for an imported repository","deprecated":null,"version":null,"sidebarTitle":"Resolve Git ref in repository","openapi":"/api-specs/cloud/public-api.json post /api/projects/beta/projects/{projectId}/repositories/{repositoryId}/commits/resolveGitRef","href":"/api-reference/projects/resolve-a-git-reference-to-a-commit-sha-for-an-imported-repository"},{"title":"Get project result settings","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/projects/beta/projects/{projectId}/results-settings","href":"/api-reference/projects/get-project-result-settings"},{"title":"Update project result settings","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/projects/beta/projects/{projectId}/results-settings","href":"/api-reference/projects/update-project-result-settings"},{"title":"Get Project by Id","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/projects/v1/projects/{projectId}","href":"/api-reference/projects/get-project-by-id"},{"title":"Add a collaborator to this project","deprecated":null,"version":null,"sidebarTitle":"Add collaborator","openapi":"/api-specs/cloud/public-api.json post /api/projects/v1/projects/{projectId}/collaborators","href":"/api-reference/projects/add-a-collaborator-to-this-project"},{"title":"Remove a collaborator from project","deprecated":null,"version":null,"sidebarTitle":"Remove collaborator","openapi":"/api-specs/cloud/public-api.json delete /api/projects/v1/projects/{projectId}/collaborators/{collaboratorId}","href":"/api-reference/projects/remove-a-collaborator-from-project"},{"title":"Create a new project by copying an existing project and providing optional overrides.","deprecated":null,"version":null,"sidebarTitle":"Copy Project","openapi":"/api-specs/cloud/public-api.json post /api/projects/v1/projects/{projectId}/copy-project","href":"/api-reference/projects/create-a-new-project-by-copying-an-existing-project-and-providing-optional-overrides"},{"title":"Returns the contents of a file","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/projects/v1/projects/{projectId}/files/{commitId}/{path}/content","href":"/api-reference/projects/returns-the-contents-of-a-file"},{"title":"Get goals in this project","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/projects/v1/projects/{projectId}/goals","href":"/api-reference/projects/get-goals-in-this-project"},{"title":"Add a goal to this project","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/projects/v1/projects/{projectId}/goals","href":"/api-reference/projects/add-a-goal-to-this-project"},{"title":"Delete a project goal","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/projects/v1/projects/{projectId}/goals/{goalId}","href":"/api-reference/projects/delete-a-project-goal"},{"title":"Update project goal status","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/projects/v1/projects/{projectId}/goals/{goalId}","href":"/api-reference/projects/update-project-goal-status"},{"title":"Get all imported git repositories in this project","deprecated":null,"version":null,"sidebarTitle":"List imported repositories","openapi":"/api-specs/cloud/public-api.json get /api/projects/v1/projects/{projectId}/repositories","href":"/api-reference/projects/get-all-imported-git-repositories-in-this-project"},{"title":"Add an imported git repository to this project","deprecated":null,"version":null,"sidebarTitle":"Add imported repository","openapi":"/api-specs/cloud/public-api.json post /api/projects/v1/projects/{projectId}/repositories","href":"/api-reference/projects/add-an-imported-git-repository-to-this-project"},{"title":"Remove an imported repository from project","deprecated":null,"version":null,"sidebarTitle":"Remove imported repository","openapi":"/api-specs/cloud/public-api.json delete /api/projects/v1/projects/{projectId}/repositories/{repositoryId}","href":"/api-reference/projects/remove-an-imported-repository-from-project"},{"title":"Update the default git reference of a repository in a project","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/projects/v1/projects/{projectId}/repositories/{repositoryId}/default-ref","href":"/api-reference/projects/update-the-default-git-reference-of-a-repository-in-a-project"},{"title":"Get metadata about a file in a project's git repository","deprecated":null,"version":null,"sidebarTitle":"Get repository file metadata","openapi":"/api-specs/cloud/public-api.json get /api/projects/v1/projects/{projectId}/repositories/{repositoryId}/file-metadata","href":"/api-reference/projects/get-metadata-about-a-file-in-a-projects-git-repository"},{"title":"Get the name of the readme file in a project's git repository","deprecated":null,"version":null,"sidebarTitle":"Get repository readme name","openapi":"/api-specs/cloud/public-api.json get /api/projects/v1/projects/{projectId}/repositories/{repositoryId}/readme","href":"/api-reference/projects/get-the-name-of-the-readme-file-in-a-projects-git-repository"},{"title":"Get a rendered view of a file in a project's git repository","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/projects/v1/projects/{projectId}/repositories/{repositoryId}/rendered-file","href":"/api-reference/projects/get-a-rendered-view-of-a-file-in-a-projects-git-repository"},{"title":"Update project status","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/projects/v1/projects/{projectId}/status","href":"/api-reference/projects/update-project-status"},{"title":"Create a project","deprecated":null,"version":null,"sidebarTitle":"Create Project (v2)","openapi":"/api-specs/cloud/public-api.json post /api/projects/v2/projects","href":"/api-reference/projects/create-a-project-1"}]},{"group":"Project templates","pages":[{"title":"Create project template","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/develop/v1/customer-project-templates","href":"/api-reference/project-templates/create-project-template"},{"title":"Get customer project template by id","deprecated":null,"version":null,"sidebarTitle":"Get Project template","openapi":"/api-specs/cloud/public-api.json get /api/develop/v1/customer-project-templates/{id}","href":"/api-reference/project-templates/get-customer-project-template-by-id"},{"title":"Delete a customer project template by id.","deprecated":null,"version":null,"sidebarTitle":"Delete Project template","openapi":"/api-specs/cloud/public-api.json delete /api/develop/v1/customer-project-templates/{id}","href":"/api-reference/project-templates/delete-a-customer-project-template-by-id"},{"title":"Update a customer project template","deprecated":null,"version":null,"sidebarTitle":"Update Project template","openapi":"/api-specs/cloud/public-api.json patch /api/develop/v1/customer-project-templates/{id}","href":"/api-reference/project-templates/update-a-customer-project-template"},{"title":"List project templates","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/develop/v1/project-templates","href":"/api-reference/project-templates/list-project-templates"},{"title":"List project templates (v2)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/develop/v2/project-templates","href":"/api-reference/project-templates/list-project-templates-v2"}]},{"group":"Workspaces","pages":[{"title":"Create workspace session","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/projects/v1/projects/{projectId}/workspaces/{workspaceId}/sessions","href":"/api-reference/workspaces/create-workspace-session"},{"title":"Get writable project mount paths for a Workspace","deprecated":null,"version":null,"sidebarTitle":"Get writable Project mounts","openapi":"/api-specs/cloud/public-api.json get /api/workspace/v1/workspace/{workspaceId}/writable-project-mounts","href":"/api-reference/workspaces/get-writable-project-mount-paths-for-a-workspace"}]},{"group":"Jobs","pages":[{"title":"Get Jobs for a project","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/jobs/beta/jobs","href":"/api-reference/jobs/get-jobs-for-a-project"},{"title":"Get Job details","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/jobs/beta/jobs/{jobId}","href":"/api-reference/jobs/get-job-details"},{"title":"Get logs for a Job","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/jobs/beta/jobs/{jobId}/logs","href":"/api-reference/jobs/get-logs-for-a-job"},{"title":"Get linked goals for a job","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/jobs/v1/goals","href":"/api-reference/jobs/get-linked-goals-for-a-job"},{"title":"Link a goal to a job","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/jobs/v1/goals","href":"/api-reference/jobs/link-a-goal-to-a-job"},{"title":"Unlink goal from job","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/jobs/v1/goals/{goalId}","href":"/api-reference/jobs/unlink-goal-from-job"},{"title":"Start a Job","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/jobs/v1/jobs","href":"/api-reference/jobs/start-a-job"},{"title":"Add a tag to a Job","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/jobs/v1/jobs/{jobId}/tags","href":"/api-reference/jobs/add-a-tag-to-a-job"},{"title":"Remove a tag from a Job","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/jobs/v1/jobs/{jobId}/tags/{tagId}","href":"/api-reference/jobs/remove-a-tag-from-a-job"},{"title":"Resolve the default configuration a Job would run with","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/jobs/v1/projects/{projectId}/job-defaults","href":"/api-reference/jobs/resolve-the-default-configuration-a-job-would-run-with"}]},{"group":"HPC Jobs","pages":[{"title":"Get HPC Jobs for a project","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/hpc/v1/jobs","href":"/api-reference/hpc-jobs/get-hpc-jobs-for-a-project"},{"title":"Start an HPC Job","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/hpc/v1/jobs","href":"/api-reference/hpc-jobs/start-an-hpc-job"},{"title":"Cancel an HPC Job","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/hpc/v1/jobs/cancel","href":"/api-reference/hpc-jobs/cancel-an-hpc-job"},{"title":"Check whether Slurm submission is supported","deprecated":null,"version":null,"sidebarTitle":"Check Slurm submission support","openapi":"/api-specs/cloud/public-api.json get /api/hpc/v1/jobs/submit-supported","href":"/api-reference/hpc-jobs/check-whether-slurm-submission-is-supported"},{"title":"Get HPC Job details","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/hpc/v1/jobs/{jobId}","href":"/api-reference/hpc-jobs/get-hpc-job-details"},{"title":"Get logs for an HPC Job","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/hpc/v1/jobs/{jobId}/logs","href":"/api-reference/hpc-jobs/get-logs-for-an-hpc-job"}]},{"group":"Environments","pages":[{"title":"Get Environments visible to a user","deprecated":null,"version":null,"sidebarTitle":"List visible environments","openapi":"/api-specs/cloud/public-api.json get /api/environments/beta/environments","href":"/api-reference/environments/get-environments-visible-to-a-user"},{"title":"Create an environment","deprecated":true,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/environments/beta/environments","href":"/api-reference/environments/create-an-environment"},{"title":"Create a Revision of an Environment","deprecated":true,"version":null,"sidebarTitle":"Create environment revision","openapi":"/api-specs/cloud/public-api.json post /api/environments/beta/environments/{environmentId}/revisions","href":"/api-reference/environments/create-a-revision-of-an-environment"},{"title":"Update the restricted revision of an environment","deprecated":null,"version":null,"sidebarTitle":"Update restricted revision","openapi":"/api-specs/cloud/public-api.json patch /api/environments/beta/environments/{environmentId}/revisions/{revisionId}","href":"/api-reference/environments/update-the-restricted-revision-of-an-environment"},{"title":"Get an environment","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/environments/v1/environments/{environmentId}","href":"/api-reference/environments/get-an-environment"},{"title":"Archive an environment","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/environments/v1/environments/{environmentId}","href":"/api-reference/environments/archive-an-environment"},{"title":"Update an environment description","deprecated":null,"version":null,"sidebarTitle":"Update environment description","openapi":"/api-specs/cloud/public-api.json put /api/environments/v1/environments/{environmentId}/description","href":"/api-reference/environments/update-an-environment-description"},{"title":"Rename an environment","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/environments/v1/environments/{environmentId}/name","href":"/api-reference/environments/rename-an-environment"},{"title":"Create an environment (V2)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/environments/v2/environments","href":"/api-reference/environments/create-an-environment-v2"},{"title":"Create a Revision of an Environment (V2)","deprecated":null,"version":null,"sidebarTitle":"Create environment revision (v2)","openapi":"/api-specs/cloud/public-api.json post /api/environments/v2/environments/{environmentId}/revisions","href":"/api-reference/environments/create-a-revision-of-an-environment-v2"}]},{"group":"Hardware Tiers","pages":[{"title":"Get all hardware tiers","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/hardwaretiers/v1/hardwaretiers","href":"/api-reference/hardware-tiers/get-all-hardware-tiers"},{"title":"Update a hardware tier","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/hardwaretiers/v1/hardwaretiers","href":"/api-reference/hardware-tiers/update-a-hardware-tier"},{"title":"Create a hardware tier","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/hardwaretiers/v1/hardwaretiers","href":"/api-reference/hardware-tiers/create-a-hardware-tier"},{"title":"Get a hardware tier by Id","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/hardwaretiers/v1/hardwaretiers/{hardwareTierId}","href":"/api-reference/hardware-tiers/get-a-hardware-tier-by-id"},{"title":"Archive a hardware tier","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/hardwaretiers/v1/hardwaretiers/{hardwareTierId}","href":"/api-reference/hardware-tiers/archive-a-hardware-tier"}]},{"group":"Datasets","pages":[{"title":"Deprecated - Get Datasets accessible to the user","deprecated":null,"version":null,"sidebarTitle":"List Datasets (deprecated)","openapi":"/api-specs/cloud/public-api.json get /api/datasetrw/v1/datasets","href":"/api-reference/datasets/deprecated--get-datasets-accessible-to-the-user"},{"title":"Create a Dataset","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/datasetrw/v1/datasets","href":"/api-reference/datasets/create-a-dataset"},{"title":"Get Dataset by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/datasetrw/v1/datasets/{datasetId}","href":"/api-reference/datasets/get-dataset-by-id"},{"title":"Delete Dataset","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/datasetrw/v1/datasets/{datasetId}","href":"/api-reference/datasets/delete-dataset"},{"title":"Update Dataset metadata","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/datasetrw/v1/datasets/{datasetId}","href":"/api-reference/datasets/update-dataset-metadata"},{"title":"Get Dataset grants by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/datasetrw/v1/datasets/{datasetId}/grants","href":"/api-reference/datasets/get-dataset-grants-by-id"},{"title":"Add a grant to a Dataset's existing sequence of grants","deprecated":null,"version":null,"sidebarTitle":"Add Dataset grant","openapi":"/api-specs/cloud/public-api.json post /api/datasetrw/v1/datasets/{datasetId}/grants","href":"/api-reference/datasets/add-a-grant-to-a-datasets-existing-sequence-of-grants"},{"title":"Remove a grant from a Dataset's existing sequence of grants","deprecated":null,"version":null,"sidebarTitle":"Remove Dataset grant","openapi":"/api-specs/cloud/public-api.json delete /api/datasetrw/v1/datasets/{datasetId}/grants","href":"/api-reference/datasets/remove-a-grant-from-a-datasets-existing-sequence-of-grants"},{"title":"Get Snapshots belonging to a Dataset","deprecated":null,"version":null,"sidebarTitle":"List Dataset snapshots","openapi":"/api-specs/cloud/public-api.json get /api/datasetrw/v1/datasets/{datasetId}/snapshots","href":"/api-reference/datasets/get-snapshots-belonging-to-a-dataset"},{"title":"Create a Dataset Snapshot","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/datasetrw/v1/datasets/{datasetId}/snapshots","href":"/api-reference/datasets/create-a-dataset-snapshot"},{"title":"Tag a Snapshot in this Dataset","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/datasetrw/v1/datasets/{datasetId}/tags","href":"/api-reference/datasets/tag-a-snapshot-in-this-dataset"},{"title":"Remove a tag from a Dataset","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/datasetrw/v1/datasets/{datasetId}/tags/{tagName}","href":"/api-reference/datasets/remove-a-tag-from-a-dataset"},{"title":"Get a Dataset Snapshot","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/datasetrw/v1/snapshots/{snapshotId}","href":"/api-reference/datasets/get-a-dataset-snapshot"},{"title":"Get Datasets the user has access to","deprecated":null,"version":null,"sidebarTitle":"List Datasets (v2)","openapi":"/api-specs/cloud/public-api.json get /api/datasetrw/v2/datasets","href":"/api-reference/datasets/get-datasets-the-user-has-access-to"},{"title":"Get shared datasets that a project uses","deprecated":null,"version":null,"sidebarTitle":"List shared Datasets","openapi":"/api-specs/cloud/public-api.json get /api/projects/v1/projects/{projectId}/shared-datasets","href":"/api-reference/datasets/get-shared-datasets-that-a-project-uses"},{"title":"Link a shared dataset to this project","deprecated":null,"version":null,"sidebarTitle":"Link shared Dataset","openapi":"/api-specs/cloud/public-api.json post /api/projects/v1/projects/{projectId}/shared-datasets","href":"/api-reference/datasets/link-a-shared-dataset-to-this-project"},{"title":"Unlink a shared dataset from this project","deprecated":null,"version":null,"sidebarTitle":"Unlink shared Dataset","openapi":"/api-specs/cloud/public-api.json delete /api/projects/v1/projects/{projectId}/shared-datasets/{datasetId}","href":"/api-reference/datasets/unlink-a-shared-dataset-from-this-project"},{"title":"Attempts to rename file or directory","deprecated":null,"version":null,"sidebarTitle":"Rename Dataset file","openapi":"/api-specs/cloud/public-api.json put /webvfs/datasetrw/dataset/{datasetId}/rename-file","href":"/api-reference/datasets/attempts-to-rename-file-or-directory"},{"title":"Upload one resumable chunk to a Dataset snapshot","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /webvfs/datasetrw/datasets/{datasetId}/snapshot/file","href":"/api-reference/datasets/upload-one-resumable-chunk-to-a-dataset-snapshot"},{"title":"Cancels the upload process to a Dataset","deprecated":null,"version":null,"sidebarTitle":"Cancel Dataset upload","openapi":"/api-specs/cloud/public-api.json get /webvfs/datasetrw/datasets/{datasetId}/snapshot/file/cancel/{uploadKey}","href":"/api-reference/datasets/cancels-the-upload-process-to-a-dataset"},{"title":"Attempts to move the uploaded files to the Dataset","deprecated":null,"version":null,"sidebarTitle":"Complete Dataset upload","openapi":"/api-specs/cloud/public-api.json get /webvfs/datasetrw/datasets/{datasetId}/snapshot/file/end/{uploadKey}","href":"/api-reference/datasets/attempts-to-move-the-uploaded-files-to-the-dataset"},{"title":"Start process to upload a file(s) to the Dataset","deprecated":null,"version":null,"sidebarTitle":"Start Dataset upload","openapi":"/api-specs/cloud/public-api.json post /webvfs/datasetrw/datasets/{datasetId}/snapshot/file/start","href":"/api-reference/datasets/start-process-to-upload-a-files-to-the-dataset"},{"title":"Returns whether or not this upload chunk has already been sent","deprecated":null,"version":null,"sidebarTitle":"Check upload chunk status","openapi":"/api-specs/cloud/public-api.json get /webvfs/datasetrw/datasets/{datasetId}/snapshot/file/test","href":"/api-reference/datasets/returns-whether-or-not-this-upload-chunk-has-already-been-sent"},{"title":"Get file names in snapshot","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /webvfs/datasetrw/files/{snapshotId}","href":"/api-reference/datasets/get-file-names-in-snapshot"},{"title":"Download archive file from Domino to local","deprecated":null,"version":null,"sidebarTitle":"Download snapshot archive","openapi":"/api-specs/cloud/public-api.json get /webvfs/datasetrw/snapshot/{snapshotId}/download-local/{taskKey}","href":"/api-reference/datasets/download-archive-file-from-domino-to-local"},{"title":"Get snapshot file metadata at path","deprecated":null,"version":null,"sidebarTitle":"Get snapshot file metadata","openapi":"/api-specs/cloud/public-api.json get /webvfs/datasetrw/snapshot/{snapshotId}/file/meta","href":"/api-reference/datasets/get-snapshot-file-metadata-at-path"},{"title":"Get snapshot file raw content at specified path","deprecated":null,"version":null,"sidebarTitle":"Get snapshot file content","openapi":"/api-specs/cloud/public-api.json get /webvfs/datasetrw/snapshot/{snapshotId}/file/raw","href":"/api-reference/datasets/get-snapshot-file-raw-content-at-specified-path"},{"title":"Deletes files from snapshot","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /webvfs/datasetrw/snapshot/{snapshotId}/files","href":"/api-reference/datasets/deletes-files-from-snapshot"},{"title":"Get file names in a snapshot at a specific subpath recursively","deprecated":null,"version":null,"sidebarTitle":"List snapshot files recursively","openapi":"/api-specs/cloud/public-api.json get /webvfs/datasetrw/snapshot/{snapshotId}/files/recursive","href":"/api-reference/datasets/get-file-names-in-a-snapshot-at-a-specific-subpath-recursively"}]},{"group":"Data Sources","pages":[{"title":"Get Data Source Audit Data","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/datasource/v1/audit","href":"/api-reference/data-sources/get-data-source-audit-data"},{"title":"Get all active Data Sources the user has access to","deprecated":null,"version":null,"sidebarTitle":"List accessible Data Sources","openapi":"/api-specs/cloud/public-api.json get /api/datasource/v1/datasources","href":"/api-reference/data-sources/get-all-active-data-sources-the-user-has-access-to"},{"title":"Create a Data Source","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/datasource/v1/datasources","href":"/api-reference/data-sources/create-a-data-source"},{"title":"Get Data Source by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/datasource/v1/datasources/{dataSourceId}","href":"/api-reference/data-sources/get-data-source-by-id"},{"title":"Delete Data Source with specified ID","deprecated":null,"version":null,"sidebarTitle":"Delete Data Source","openapi":"/api-specs/cloud/public-api.json delete /api/datasource/v1/datasources/{dataSourceId}","href":"/api-reference/data-sources/delete-data-source-with-specified-id"},{"title":"Update Data Source with specified ID","deprecated":null,"version":null,"sidebarTitle":"Update Data Source","openapi":"/api-specs/cloud/public-api.json patch /api/datasource/v1/datasources/{dataSourceId}","href":"/api-reference/data-sources/update-data-source-with-specified-id"},{"title":"List monitoring Data Sources","deprecated":null,"version":null,"sidebarTitle":"List monitoring Data Sources","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/datasources","href":"/api-reference/data-sources/get-model-monitorv2apidatasources"},{"title":"Create monitoring Data Source","deprecated":null,"version":null,"sidebarTitle":"Create monitoring Data Source","openapi":"/api-specs/cloud/public-api.json put /model-monitor/v2/api/datasource","href":"/api-reference/data-sources/put-model-monitorv2apidatasource"},{"title":"Delete monitoring Data Source","deprecated":null,"version":null,"sidebarTitle":"Delete monitoring Data Source","openapi":"/api-specs/cloud/public-api.json delete /model-monitor/v2/api/datasource","href":"/api-reference/data-sources/delete-model-monitorv2apidatasource"}]},{"group":"GenAI","pages":[{"title":"Get the default environment for Gen AI endpoints","deprecated":null,"version":null,"sidebarTitle":"Get default endpoint environment","openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/default-endpoint-environment","href":"/api-reference/genai/get-the-default-environment-for-gen-ai-endpoints"},{"title":"Get all Gen AI endpoints accessible by the user","deprecated":null,"version":null,"sidebarTitle":"List accessible GenAI endpoints","openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/endpoints","href":"/api-reference/genai/get-all-gen-ai-endpoints-accessible-by-the-user"},{"title":"Create a new Gen AI Endpoint","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/gen-ai/beta/endpoints","href":"/api-reference/genai/create-a-new-gen-ai-endpoint"},{"title":"Get endpoint by id","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/endpoints/{endpointId}","href":"/api-reference/genai/get-endpoint-by-id"},{"title":"Delete a Gen AI Endpoint","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/gen-ai/beta/endpoints/{endpointId}","href":"/api-reference/genai/delete-a-gen-ai-endpoint"},{"title":"Get the collaborators for a Gen AI Endpoint","deprecated":null,"version":null,"sidebarTitle":"List endpoint collaborators","openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/endpoints/{endpointId}/collaborators","href":"/api-reference/genai/get-the-collaborators-for-a-gen-ai-endpoint"},{"title":"Get the versions for a Gen AI Endpoint","deprecated":null,"version":null,"sidebarTitle":"List endpoint versions","openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/endpoints/{endpointId}/versions","href":"/api-reference/genai/get-the-versions-for-a-gen-ai-endpoint"},{"title":"Get a Gen AI Endpoint Version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/endpoints/{endpointId}/versions/{versionNumber}","href":"/api-reference/genai/get-a-gen-ai-endpoint-version"},{"title":"Patch a Gen AI Endpoint version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/gen-ai/beta/endpoints/{endpointId}/versions/{versionNumber}","href":"/api-reference/genai/patch-a-gen-ai-endpoint-version"},{"title":"Get pod resource usage metrics for a model endpoint version","deprecated":null,"version":null,"sidebarTitle":"Get pod resource metrics","openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/endpoints/{endpointId}/versions/{versionNumber}/pod-resource-metrics","href":"/api-reference/genai/get-pod-resource-usage-metrics-for-a-model-endpoint-version"},{"title":"Get Gen AI Endpoint Version Real Time Logs","deprecated":null,"version":null,"sidebarTitle":"Get version real-time logs","openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/endpoints/{endpointId}/versions/{versionNumber}/realTimeLogs","href":"/api-reference/genai/get-gen-ai-endpoint-version-real-time-logs"},{"title":"Get request metrics for a model endpoint version","deprecated":null,"version":null,"sidebarTitle":"Get request metrics","openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/endpoints/{endpointId}/versions/{versionNumber}/request-metrics","href":"/api-reference/genai/get-request-metrics-for-a-model-endpoint-version"},{"title":"Start a Gen AI Endpoint Version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/gen-ai/beta/endpoints/{endpointId}/versions/{versionNumber}/start","href":"/api-reference/genai/start-a-gen-ai-endpoint-version"},{"title":"Stop a Gen AI Endpoint Version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/gen-ai/beta/endpoints/{endpointId}/versions/{versionNumber}/stop","href":"/api-reference/genai/stop-a-gen-ai-endpoint-version"},{"title":"Get vLLM latency metrics for a model endpoint version","deprecated":null,"version":null,"sidebarTitle":"Get vLLM latency metrics","openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/endpoints/{endpointId}/versions/{versionNumber}/vllm-latency-metrics","href":"/api-reference/genai/get-vllm-latency-metrics-for-a-model-endpoint-version"},{"title":"Get vLLM token metrics for a model endpoint version","deprecated":null,"version":null,"sidebarTitle":"Get vLLM token metrics","openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/endpoints/{endpointId}/versions/{versionNumber}/vllm-token-metrics","href":"/api-reference/genai/get-vllm-token-metrics-for-a-model-endpoint-version"},{"title":"Check if a vanity URL is available","deprecated":null,"version":null,"sidebarTitle":"Check vanity URL availability","openapi":"/api-specs/cloud/public-api.json get /api/gen-ai/beta/vanity-url-availability/{vanityUrl}","href":"/api-reference/genai/check-if-a-vanity-url-is-available"}]},{"group":"AI Systems","pages":[{"title":"Service Version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/model-services/v1/aisystem/version","href":"/api-reference/ai-systems/service-version"},{"title":"Get evaluation histogram data","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/model-services/v1/aisystem/{system_id}/version/{version_id}/chart/histogram/eval_name/{eval_name}","href":"/api-reference/ai-systems/get-evaluation-histogram-data"},{"title":"Get metrics timeseries","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/model-services/v1/aisystem/{system_id}/version/{version_id}/chart/timeseries/metric/{metric}","href":"/api-reference/ai-systems/get-metrics-timeseries"},{"title":"Get trace count timeseries","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/model-services/v1/aisystem/{system_id}/version/{version_id}/chart/timeseries/trace-count","href":"/api-reference/ai-systems/get-trace-count-timeseries"},{"title":"Get labels for metric and label evaluations","deprecated":null,"version":null,"sidebarTitle":"Get evaluation labels","openapi":"/api-specs/cloud/public-api.json get /api/model-services/v1/aisystem/{system_id}/version/{version_id}/evaluation-labels","href":"/api-reference/ai-systems/get-labels-for-metric-and-label-evaluations"},{"title":"Get filterable fields","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/model-services/v1/aisystem/{system_id}/version/{version_id}/filters","href":"/api-reference/ai-systems/get-filterable-fields"},{"title":"List traces","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/model-services/v1/aisystem/{system_id}/version/{version_id}/traces","href":"/api-reference/ai-systems/list-traces"},{"title":"Get version timeline","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/model-services/v1/aisystem/{system_id}/versions","href":"/api-reference/ai-systems/get-version-timeline"}]},{"group":"MLflow experiments and runs","pages":[{"title":"Create experiment","deprecated":null,"version":null,"sidebarTitle":"Create experiment","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/experiments/create","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowexperimentscreate"},{"title":"Delete experiment","deprecated":null,"version":null,"sidebarTitle":"Delete experiment","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/experiments/delete","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowexperimentsdelete"},{"title":"Get experiment","deprecated":null,"version":null,"sidebarTitle":"Get experiment","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/experiments/get","href":"/api-reference/mlflow-experiments-and-runs/get-api20mlflowexperimentsget"},{"title":"Get experiment by name","deprecated":null,"version":null,"sidebarTitle":"Get experiment by name","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/experiments/get-by-name","href":"/api-reference/mlflow-experiments-and-runs/get-api20mlflowexperimentsget-by-name"},{"title":"Restore experiment","deprecated":null,"version":null,"sidebarTitle":"Restore experiment","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/experiments/restore","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowexperimentsrestore"},{"title":"Search experiments","deprecated":null,"version":null,"sidebarTitle":"Search experiments","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/experiments/search","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowexperimentssearch"},{"title":"Set experiment tag","deprecated":null,"version":null,"sidebarTitle":"Set experiment tag","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/experiments/set-experiment-tag","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowexperimentsset-experiment-tag"},{"title":"Update experiment","deprecated":null,"version":null,"sidebarTitle":"Update experiment","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/experiments/update","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowexperimentsupdate"},{"title":"Get metric history","deprecated":null,"version":null,"sidebarTitle":"Get metric history","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/metrics/get-history","href":"/api-reference/mlflow-experiments-and-runs/get-api20mlflowmetricsget-history"},{"title":"Create run","deprecated":null,"version":null,"sidebarTitle":"Create run","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/create","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunscreate"},{"title":"Delete run","deprecated":null,"version":null,"sidebarTitle":"Delete run","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/delete","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunsdelete"},{"title":"Delete run tag","deprecated":null,"version":null,"sidebarTitle":"Delete run tag","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/delete-tag","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunsdelete-tag"},{"title":"Get run","deprecated":null,"version":null,"sidebarTitle":"Get run","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/runs/get","href":"/api-reference/mlflow-experiments-and-runs/get-api20mlflowrunsget"},{"title":"Log run batch","deprecated":null,"version":null,"sidebarTitle":"Log run batch","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/log-batch","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunslog-batch"},{"title":"Log run inputs","deprecated":null,"version":null,"sidebarTitle":"Log run inputs","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/log-inputs","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunslog-inputs"},{"title":"Log run metric","deprecated":null,"version":null,"sidebarTitle":"Log run metric","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/log-metric","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunslog-metric"},{"title":"Log run model","deprecated":null,"version":null,"sidebarTitle":"Log run model","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/log-model","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunslog-model"},{"title":"Log run parameter","deprecated":null,"version":null,"sidebarTitle":"Log run parameter","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/log-parameter","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunslog-parameter"},{"title":"Restore run","deprecated":null,"version":null,"sidebarTitle":"Restore run","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/restore","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunsrestore"},{"title":"Search runs","deprecated":null,"version":null,"sidebarTitle":"Search runs","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/search","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunssearch"},{"title":"Set run tag","deprecated":null,"version":null,"sidebarTitle":"Set run tag","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/set-tag","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunsset-tag"},{"title":"Update run","deprecated":null,"version":null,"sidebarTitle":"Update run","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/update","href":"/api-reference/mlflow-experiments-and-runs/post-api20mlflowrunsupdate"},{"title":"Log Outputs","deprecated":null,"version":null,"sidebarTitle":"Log run outputs","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/runs/outputs","href":"/api-reference/mlflow-experiments-and-runs/log-outputs"}]},{"group":"MLflow models","pages":[{"title":"Get model version by alias","deprecated":null,"version":null,"sidebarTitle":"Get model version by alias","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/registered-models/alias","href":"/api-reference/mlflow-models/get-api20mlflowregistered-modelsalias"},{"title":"Set registered model alias","deprecated":null,"version":null,"sidebarTitle":"Set registered model alias","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/registered-models/alias","href":"/api-reference/mlflow-models/post-api20mlflowregistered-modelsalias"},{"title":"Delete registered model alias","deprecated":null,"version":null,"sidebarTitle":"Delete registered model alias","openapi":"/api-specs/cloud/public-api.json delete /api/2.0/mlflow/registered-models/alias","href":"/api-reference/mlflow-models/delete-api20mlflowregistered-modelsalias"},{"title":"Create registered model","deprecated":null,"version":null,"sidebarTitle":"Create registered model","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/registered-models/create","href":"/api-reference/mlflow-models/post-api20mlflowregistered-modelscreate"},{"title":"Delete registered model","deprecated":null,"version":null,"sidebarTitle":"Delete registered model","openapi":"/api-specs/cloud/public-api.json delete /api/2.0/mlflow/registered-models/delete","href":"/api-reference/mlflow-models/delete-api20mlflowregistered-modelsdelete"},{"title":"Delete registered model tag","deprecated":null,"version":null,"sidebarTitle":"Delete registered model tag","openapi":"/api-specs/cloud/public-api.json delete /api/2.0/mlflow/registered-models/delete-tag","href":"/api-reference/mlflow-models/delete-api20mlflowregistered-modelsdelete-tag"},{"title":"Get registered model","deprecated":null,"version":null,"sidebarTitle":"Get registered model","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/registered-models/get","href":"/api-reference/mlflow-models/get-api20mlflowregistered-modelsget"},{"title":"Get latest model versions","deprecated":null,"version":null,"sidebarTitle":"Get latest model versions","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/registered-models/get-latest-versions","href":"/api-reference/mlflow-models/post-api20mlflowregistered-modelsget-latest-versions"},{"title":"Rename registered model","deprecated":null,"version":null,"sidebarTitle":"Rename registered model","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/registered-models/rename","href":"/api-reference/mlflow-models/post-api20mlflowregistered-modelsrename"},{"title":"Search registered models","deprecated":null,"version":null,"sidebarTitle":"Search registered models","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/registered-models/search","href":"/api-reference/mlflow-models/get-api20mlflowregistered-modelssearch"},{"title":"Set registered model tag","deprecated":null,"version":null,"sidebarTitle":"Set registered model tag","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/registered-models/set-tag","href":"/api-reference/mlflow-models/post-api20mlflowregistered-modelsset-tag"},{"title":"Update registered model","deprecated":null,"version":null,"sidebarTitle":"Update registered model","openapi":"/api-specs/cloud/public-api.json patch /api/2.0/mlflow/registered-models/update","href":"/api-reference/mlflow-models/patch-api20mlflowregistered-modelsupdate"},{"title":"Create model version","deprecated":null,"version":null,"sidebarTitle":"Create model version","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/model-versions/create","href":"/api-reference/mlflow-models/post-api20mlflowmodel-versionscreate"},{"title":"Delete model version","deprecated":null,"version":null,"sidebarTitle":"Delete model version","openapi":"/api-specs/cloud/public-api.json delete /api/2.0/mlflow/model-versions/delete","href":"/api-reference/mlflow-models/delete-api20mlflowmodel-versionsdelete"},{"title":"Delete model version tag","deprecated":null,"version":null,"sidebarTitle":"Delete model version tag","openapi":"/api-specs/cloud/public-api.json delete /api/2.0/mlflow/model-versions/delete-tag","href":"/api-reference/mlflow-models/delete-api20mlflowmodel-versionsdelete-tag"},{"title":"Get model version","deprecated":null,"version":null,"sidebarTitle":"Get model version","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/model-versions/get","href":"/api-reference/mlflow-models/get-api20mlflowmodel-versionsget"},{"title":"Search model versions","deprecated":null,"version":null,"sidebarTitle":"Search model versions","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/model-versions/search","href":"/api-reference/mlflow-models/get-api20mlflowmodel-versionssearch"},{"title":"Set model version tag","deprecated":null,"version":null,"sidebarTitle":"Set model version tag","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/model-versions/set-tag","href":"/api-reference/mlflow-models/post-api20mlflowmodel-versionsset-tag"},{"title":"Transition model version stage","deprecated":null,"version":null,"sidebarTitle":"Transition model version stage","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/model-versions/transition-stage","href":"/api-reference/mlflow-models/post-api20mlflowmodel-versionstransition-stage"},{"title":"Update model version","deprecated":null,"version":null,"sidebarTitle":"Update model version","openapi":"/api-specs/cloud/public-api.json patch /api/2.0/mlflow/model-versions/update","href":"/api-reference/mlflow-models/patch-api20mlflowmodel-versionsupdate"},{"title":"Create Logged Model","deprecated":null,"version":null,"sidebarTitle":"Create logged model","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/logged-models","href":"/api-reference/mlflow-models/create-logged-model"},{"title":"Get Logged Model","deprecated":null,"version":null,"sidebarTitle":"Get logged model","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/logged-models/{model_id}","href":"/api-reference/mlflow-models/get-logged-model"},{"title":"Delete a Logged Model","deprecated":null,"version":null,"sidebarTitle":"Delete logged model","openapi":"/api-specs/cloud/public-api.json delete /api/2.0/mlflow/logged-models/{model_id}","href":"/api-reference/mlflow-models/delete-a-logged-model"},{"title":"Finalize Logged Model","deprecated":null,"version":null,"sidebarTitle":"Finalize logged model","openapi":"/api-specs/cloud/public-api.json patch /api/2.0/mlflow/logged-models/{model_id}","href":"/api-reference/mlflow-models/finalize-logged-model"},{"title":"Search LoggedModels","deprecated":null,"version":null,"sidebarTitle":"Search logged models","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/logged-models/search","href":"/api-reference/mlflow-models/search-loggedmodels"},{"title":"Set Logged Model Tag","deprecated":null,"version":null,"sidebarTitle":"Set logged model tags","openapi":"/api-specs/cloud/public-api.json patch /api/2.0/mlflow/logged-models/{model_id}/tags","href":"/api-reference/mlflow-models/set-logged-model-tag"},{"title":"Delete Logged Model Tag","deprecated":null,"version":null,"sidebarTitle":"Delete logged model tag","openapi":"/api-specs/cloud/public-api.json delete /api/2.0/mlflow/logged-models/{model_id}/tags/{tag_key}","href":"/api-reference/mlflow-models/delete-logged-model-tag"}]},{"group":"MLflow artifacts","pages":[{"title":"List run artifacts","deprecated":null,"version":null,"sidebarTitle":"List run artifacts","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/artifacts/list","href":"/api-reference/mlflow-artifacts/get-api20mlflowartifactslist"},{"title":"download file","deprecated":null,"version":null,"sidebarTitle":"Download artifact","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow-artifacts/artifacts/{path}","href":"/api-reference/mlflow-artifacts/download-file"},{"title":"upload file","deprecated":null,"version":null,"sidebarTitle":"Upload artifact","openapi":"/api-specs/cloud/public-api.json put /api/2.0/mlflow-artifacts/artifacts/{path}","href":"/api-reference/mlflow-artifacts/upload-file"},{"title":"abort multipart file upload","deprecated":null,"version":null,"sidebarTitle":"Abort multipart upload","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow-artifacts/mpu/abort/{artifact_path}","href":"/api-reference/mlflow-artifacts/abort-multipart-file-upload"},{"title":"create multipart file upload","deprecated":null,"version":null,"sidebarTitle":"Create multipart upload","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow-artifacts/mpu/create/{artifact_path}","href":"/api-reference/mlflow-artifacts/create-multipart-file-upload"},{"title":"complete multipart file upload","deprecated":null,"version":null,"sidebarTitle":"Complete multipart upload","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow-artifacts/mpu/complete/{artifact_path}","href":"/api-reference/mlflow-artifacts/complete-multipart-file-upload"}]},{"group":"MLflow traces","pages":[{"title":"Start a trace V3","deprecated":null,"version":null,"sidebarTitle":"Start trace (v3)","openapi":"/api-specs/cloud/public-api.json post /api/3.0/mlflow/traces","href":"/api-reference/mlflow-traces/start-a-trace-v3"},{"title":"Search Traces V3","deprecated":null,"version":null,"sidebarTitle":"Search traces (v3)","openapi":"/api-specs/cloud/public-api.json post /api/3.0/mlflow/traces/search","href":"/api-reference/mlflow-traces/search-traces-v3"},{"title":"Get trace info","deprecated":null,"version":null,"sidebarTitle":"Get trace info","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/traces/{request_id}/info","href":"/api-reference/mlflow-traces/get-api20mlflowtraces-info"},{"title":"Search traces","deprecated":null,"version":null,"sidebarTitle":"Search traces","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/traces","href":"/api-reference/mlflow-traces/search-traces"},{"title":"Start trace","deprecated":null,"version":null,"sidebarTitle":"Start trace","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/traces","href":"/api-reference/mlflow-traces/post-api20mlflowtraces"},{"title":"Get Trace v3","deprecated":null,"version":null,"sidebarTitle":"Get trace (v3)","openapi":"/api-specs/cloud/public-api.json get /api/2.0/mlflow/traces/{trace_id}","href":"/api-reference/mlflow-traces/get-trace-v3"},{"title":"End trace","deprecated":null,"version":null,"sidebarTitle":"End trace","openapi":"/api-specs/cloud/public-api.json patch /api/2.0/mlflow/traces/{trace_id}","href":"/api-reference/mlflow-traces/patch-api20mlflowtraces"},{"title":"Delete a trace tag","deprecated":null,"version":null,"sidebarTitle":"Delete trace tag","openapi":"/api-specs/cloud/public-api.json delete /api/2.0/mlflow/traces/{trace_id}/tags","href":"/api-reference/mlflow-traces/delete-a-trace-tag"},{"title":"Set a trace tag","deprecated":null,"version":null,"sidebarTitle":"Set trace tag","openapi":"/api-specs/cloud/public-api.json patch /api/2.0/mlflow/traces/{trace_id}/tags","href":"/api-reference/mlflow-traces/set-a-trace-tag"},{"title":"Delete multiple traces","deprecated":null,"version":null,"sidebarTitle":"Delete traces","openapi":"/api-specs/cloud/public-api.json post /api/2.0/mlflow/traces/delete-traces","href":"/api-reference/mlflow-traces/delete-multiple-traces"}]},{"group":"Apps","pages":[{"title":"List Apps","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps","href":"/api-reference/apps/list-apps"},{"title":"Create App","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/beta/apps","href":"/api-reference/apps/create-app"},{"title":"Get Project Filter Options","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/projectFilterOptions","href":"/api-reference/apps/get-project-filter-options"},{"title":"Get Publisher Filter Options","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/publisherFilterOptions","href":"/api-reference/apps/get-publisher-filter-options"},{"title":"Get App by Vanity URL","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/vanityUrls/{vanityUrl}","href":"/api-reference/apps/get-app-by-vanity-url"},{"title":"Get App","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/{appId}","href":"/api-reference/apps/get-app"},{"title":"Delete App","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/apps/beta/apps/{appId}","href":"/api-reference/apps/delete-app"},{"title":"Update App","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/apps/beta/apps/{appId}","href":"/api-reference/apps/update-app"},{"title":"Request Access to App","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/beta/apps/{appId}/access/requests","href":"/api-reference/apps/request-access-to-app"},{"title":"Return all subjects (users and organizations) and their corresponding assigned roles for the given app","deprecated":null,"version":null,"sidebarTitle":"List App role assignments","openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/{appId}/roles","href":"/api-reference/apps/return-all-subjects-users-and-organizations-and-their-corresponding-assigned-roles-for-the-given-app"},{"title":"Replace all subject (user or organization) role assignments for the given app","deprecated":null,"version":null,"sidebarTitle":"Replace App role assignments","openapi":"/api-specs/cloud/public-api.json put /api/apps/beta/apps/{appId}/roles","href":"/api-reference/apps/replace-all-subject-user-or-organization-role-assignments-for-the-given-app"},{"title":"Get App Thumbnail","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/{appId}/thumbnail","href":"/api-reference/apps/get-app-thumbnail"},{"title":"Upsert App Thumbnail","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/beta/apps/{appId}/thumbnail","href":"/api-reference/apps/upsert-app-thumbnail"},{"title":"Delete App Thumbnail","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/apps/beta/apps/{appId}/thumbnail","href":"/api-reference/apps/delete-app-thumbnail"},{"title":"Get App Thumbnail Metadata","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/{appId}/thumbnail/metadata","href":"/api-reference/apps/get-app-thumbnail-metadata"},{"title":"Get App Views","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/{appId}/views","href":"/api-reference/apps/get-app-views"},{"title":"List Apps (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/v1/apps","href":"/api-reference/apps/list-apps-v1"},{"title":"Create App (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/v1/apps","href":"/api-reference/apps/create-app-v1"},{"title":"Create or ensure a draft App for a workspace (v1)","deprecated":null,"version":null,"sidebarTitle":"Create draft App (v1)","openapi":"/api-specs/cloud/public-api.json post /api/apps/v1/apps/drafts","href":"/api-reference/apps/create-or-ensure-a-draft-app-for-a-workspace-v1"},{"title":"Get App (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/v1/apps/{appId}","href":"/api-reference/apps/get-app-v1"},{"title":"Delete App (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/apps/v1/apps/{appId}","href":"/api-reference/apps/delete-app-v1"},{"title":"Update App (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/apps/v1/apps/{appId}","href":"/api-reference/apps/update-app-v1"},{"title":"Publish content from a draft App (v1)","deprecated":null,"version":null,"sidebarTitle":"Publish draft App (v1)","openapi":"/api-specs/cloud/public-api.json post /api/apps/v1/apps/{appId}/publish","href":"/api-reference/apps/publish-content-from-a-draft-app-v1"}]},{"group":"App versions","pages":[{"title":"List App Versions","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/{appId}/versions","href":"/api-reference/app-versions/list-app-versions"},{"title":"Create App Version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/beta/apps/{appId}/versions","href":"/api-reference/app-versions/create-app-version"},{"title":"Get App Version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/{appId}/versions/{versionId}","href":"/api-reference/app-versions/get-app-version"},{"title":"Update App Version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/apps/beta/apps/{appId}/versions/{versionId}","href":"/api-reference/app-versions/update-app-version"},{"title":"Start App Version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/beta/apps/{appId}/versions/{versionId}/start","href":"/api-reference/app-versions/start-app-version"},{"title":"Stop App Version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/beta/apps/{appId}/versions/{versionId}/stop","href":"/api-reference/app-versions/stop-app-version"},{"title":"List App Versions (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/v1/apps/{appId}/versions","href":"/api-reference/app-versions/list-app-versions-v1"},{"title":"Create App Version (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/v1/apps/{appId}/versions","href":"/api-reference/app-versions/create-app-version-v1"},{"title":"Create App Version and Start (v1)","deprecated":null,"version":null,"sidebarTitle":"Create and start version (v1)","openapi":"/api-specs/cloud/public-api.json post /api/apps/v1/apps/{appId}/versions/createAndStart","href":"/api-reference/app-versions/create-app-version-and-start-v1"},{"title":"Get App Version (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/v1/apps/{appId}/versions/{versionId}","href":"/api-reference/app-versions/get-app-version-v1"},{"title":"Update App Version (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/apps/v1/apps/{appId}/versions/{versionId}","href":"/api-reference/app-versions/update-app-version-v1"},{"title":"Live Sync App Version (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/v1/apps/{appId}/versions/{versionId}/liveSync","href":"/api-reference/app-versions/live-sync-app-version-v1"},{"title":"Start App Version (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/v1/apps/{appId}/versions/{versionId}/start","href":"/api-reference/app-versions/start-app-version-v1"},{"title":"Stop App Version (v1)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/v1/apps/{appId}/versions/{versionId}/stop","href":"/api-reference/app-versions/stop-app-version-v1"}]},{"group":"App instances","pages":[{"title":"List App Instances","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/{appId}/versions/{versionId}/instances","href":"/api-reference/app-instances/list-app-instances"},{"title":"Get App Instance","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/{appId}/versions/{versionId}/instances/{instanceId}","href":"/api-reference/app-instances/get-app-instance"},{"title":"Stop App Instance","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/apps/beta/apps/{appId}/versions/{versionId}/instances/{instanceId}","href":"/api-reference/app-instances/stop-app-instance"},{"title":"Get App Instance Logs","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/{appId}/versions/{versionId}/instances/{instanceId}/logs","href":"/api-reference/app-instances/get-app-instance-logs"},{"title":"Get App Instance Real Time Logs","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/apps/beta/apps/{appId}/versions/{versionId}/instances/{instanceId}/realTimeLogs","href":"/api-reference/app-instances/get-app-instance-real-time-logs"},{"title":"Record App Instance View","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/apps/beta/apps/{appId}/versions/{versionId}/instances/{instanceId}/views","href":"/api-reference/app-instances/record-app-instance-view"}]},{"group":"Model APIs","pages":[{"title":"Request a prediction from an Async model","deprecated":null,"version":null,"sidebarTitle":"Request async prediction","openapi":"/api-specs/cloud/public-api.json post /api/modelApis/async/v1/{asyncModelId}","href":"/api-reference/model-apis/request-a-prediction-from-an-async-model"},{"title":"Retrieve the result of an Async Model prediction","deprecated":null,"version":null,"sidebarTitle":"Get async prediction result","openapi":"/api-specs/cloud/public-api.json get /api/modelApis/async/v1/{asyncModelId}/{asyncPredictionId}","href":"/api-reference/model-apis/retrieve-the-result-of-an-async-model-prediction"},{"title":"Save Model API visibility and named collaborators in one request","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/modelServing/beta/modelApis/{modelApiId}/access","href":"/api-reference/model-apis/save-model-api-visibility-and-named-collaborators-in-one-request"},{"title":"See who can access a Model API","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/modelServing/beta/modelApis/{modelApiId}/collaborators","href":"/api-reference/model-apis/see-who-can-access-a-model-api"},{"title":"Grant a user or organization Model API access","deprecated":null,"version":null,"sidebarTitle":"Grant Model API access","openapi":"/api-specs/cloud/public-api.json post /api/modelServing/beta/modelApis/{modelApiId}/collaborators","href":"/api-reference/model-apis/grant-a-user-or-organization-model-api-access"},{"title":"Read one Model API collaborator's role","deprecated":null,"version":null,"sidebarTitle":"Get collaborator role","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/beta/modelApis/{modelApiId}/collaborators/{collaboratorId}","href":"/api-reference/model-apis/read-one-model-api-collaborators-role"},{"title":"Change a Model API collaborator's role","deprecated":null,"version":null,"sidebarTitle":"Change collaborator role","openapi":"/api-specs/cloud/public-api.json put /api/modelServing/beta/modelApis/{modelApiId}/collaborators/{collaboratorId}","href":"/api-reference/model-apis/change-a-model-api-collaborators-role"},{"title":"Revoke a collaborator's access to a Model API","deprecated":null,"version":null,"sidebarTitle":"Revoke collaborator access","openapi":"/api-specs/cloud/public-api.json delete /api/modelServing/beta/modelApis/{modelApiId}/collaborators/{collaboratorId}","href":"/api-reference/model-apis/revoke-a-collaborators-access-to-a-model-api"},{"title":"Ask whether your Bearer token may invoke this Model API","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/modelServing/beta/modelApis/{modelApiId}/consumer/access","href":"/api-reference/model-apis/ask-whether-your-bearer-token-may-invoke-this-model-api"},{"title":"Read who can discover and invoke a Model API","deprecated":null,"version":null,"sidebarTitle":"Get Model API visibility","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/beta/modelApis/{modelApiId}/visibility","href":"/api-reference/model-apis/read-who-can-discover-and-invoke-a-model-api"},{"title":"Change who can discover and invoke a Model API","deprecated":null,"version":null,"sidebarTitle":"Change Model API visibility","openapi":"/api-specs/cloud/public-api.json put /api/modelServing/beta/modelApis/{modelApiId}/visibility","href":"/api-reference/model-apis/change-who-can-discover-and-invoke-a-model-api"},{"title":"List Model APIs","deprecated":null,"version":null,"sidebarTitle":"List Model APIs","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelApis","href":"/api-reference/model-apis/get-apimodelservingv1modelapis"},{"title":"Create Model API","deprecated":null,"version":null,"sidebarTitle":"Create Model API","openapi":"/api-specs/cloud/public-api.json post /api/modelServing/v1/modelApis","href":"/api-reference/model-apis/post-apimodelservingv1modelapis"},{"title":"Get Model API","deprecated":null,"version":null,"sidebarTitle":"Get Model API","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelApis/{modelApiId}","href":"/api-reference/model-apis/get-apimodelservingv1modelapis-1"},{"title":"Update Model API","deprecated":null,"version":null,"sidebarTitle":"Update Model API","openapi":"/api-specs/cloud/public-api.json put /api/modelServing/v1/modelApis/{modelApiId}","href":"/api-reference/model-apis/put-apimodelservingv1modelapis"},{"title":"Delete Model API","deprecated":null,"version":null,"sidebarTitle":"Delete Model API","openapi":"/api-specs/cloud/public-api.json delete /api/modelServing/v1/modelApis/{modelApiId}","href":"/api-reference/model-apis/delete-apimodelservingv1modelapis"},{"title":"List Model API versions","deprecated":null,"version":null,"sidebarTitle":"List Model API versions","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelApis/{modelApiId}/versions","href":"/api-reference/model-apis/get-apimodelservingv1modelapis-versions"},{"title":"Create Model API version","deprecated":null,"version":null,"sidebarTitle":"Create Model API version","openapi":"/api-specs/cloud/public-api.json post /api/modelServing/v1/modelApis/{modelApiId}/versions","href":"/api-reference/model-apis/post-apimodelservingv1modelapis-versions"},{"title":"Get Model API version","deprecated":null,"version":null,"sidebarTitle":"Get Model API version","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelApis/{modelApiId}/versions/{modelApiVersionId}","href":"/api-reference/model-apis/get-apimodelservingv1modelapis-versions-1"},{"title":"Get Model API version build logs","deprecated":null,"version":null,"sidebarTitle":"Get version build logs","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelApis/{modelApiId}/versions/{modelApiVersionId}/buildLogs","href":"/api-reference/model-apis/get-apimodelservingv1modelapis-versions-buildlogs"},{"title":"Get Model API version export logs","deprecated":null,"version":null,"sidebarTitle":"Get version export logs","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelApis/{modelApiId}/versions/{modelApiVersionId}/exportLogs","href":"/api-reference/model-apis/get-apimodelservingv1modelapis-versions-exportlogs"},{"title":"Get Model API version instance logs","deprecated":null,"version":null,"sidebarTitle":"Get version instance logs","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelApis/{modelApiId}/versions/{modelApiVersionId}/instanceLogs","href":"/api-reference/model-apis/get-apimodelservingv1modelapis-versions-instancelogs"}]},{"group":"Registered models","pages":[{"title":"Get Registered Models visible to user","deprecated":null,"version":null,"sidebarTitle":"List registered models","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v1","href":"/api-reference/registered-models/get-registered-models-visible-to-user"},{"title":"[DEPRECATED] Create a new Registered Model from an experiment run","deprecated":true,"version":null,"sidebarTitle":"Register model (deprecated)","openapi":"/api-specs/cloud/public-api.json post /api/registeredmodels/v1","href":"/api-reference/registered-models/[deprecated]-create-a-new-registered-model-from-an-experiment-run"},{"title":"Request access to a project","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/registeredmodels/v1/access/{projectId}","href":"/api-reference/registered-models/request-access-to-a-project"},{"title":"Get unregistered models for an experiment","deprecated":null,"version":null,"sidebarTitle":"List unregistered models","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v1/experiments/{experimentId}/unregistered-models","href":"/api-reference/registered-models/get-unregistered-models-for-an-experiment"},{"title":"Get a list of Registered Models' names visible to user","deprecated":null,"version":null,"sidebarTitle":"List registered model names","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v1/names","href":"/api-reference/registered-models/get-a-list-of-registered-models-names-visible-to-user"},{"title":"Get Registered Models visible to user","deprecated":null,"version":null,"sidebarTitle":"List registered models (UI)","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v1/ui","href":"/api-reference/registered-models/get-registered-models-visible-to-user-1"},{"title":"Get a specific Registered Model","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v1/{modelName}","href":"/api-reference/registered-models/get-a-specific-registered-model"},{"title":"Update a Registered Model","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/registeredmodels/v1/{modelName}","href":"/api-reference/registered-models/update-a-registered-model"},{"title":"Returns list of Model APIs deployed from a specific Registered Model","deprecated":null,"version":null,"sidebarTitle":"List Model APIs for model","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v1/{modelName}/modelapis","href":"/api-reference/registered-models/returns-list-of-model-apis-deployed-from-a-specific-registered-model"},{"title":"Get all versions of a Registered Model","deprecated":null,"version":null,"sidebarTitle":"List model versions","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v1/{modelName}/versions","href":"/api-reference/registered-models/get-all-versions-of-a-registered-model"},{"title":"[DEPRECATED] Create a new version of a Registered Model","deprecated":true,"version":null,"sidebarTitle":"Create version (deprecated)","openapi":"/api-specs/cloud/public-api.json post /api/registeredmodels/v1/{modelName}/versions","href":"/api-reference/registered-models/[deprecated]-create-a-new-version-of-a-registered-model"},{"title":"Get model image build logs","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v1/{modelName}/versions/{modelVersion}/builds/{buildId}/logs","href":"/api-reference/registered-models/get-model-image-build-logs"},{"title":"Download model image build logs","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v1/{modelName}/versions/{modelVersion}/builds/{buildId}/logs/download","href":"/api-reference/registered-models/download-model-image-build-logs"},{"title":"Get a specific version of a Registered Model","deprecated":null,"version":null,"sidebarTitle":"Get model version","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v1/{modelName}/versions/{version}","href":"/api-reference/registered-models/get-a-specific-version-of-a-registered-model"},{"title":"Returns list of Model APIs deployed from a specific Registered Model Version","deprecated":null,"version":null,"sidebarTitle":"List Model APIs for version","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v1/{modelName}/versions/{version}/modelapis","href":"/api-reference/registered-models/returns-list-of-model-apis-deployed-from-a-specific-registered-model-version"},{"title":"Get Registered Models visible to user (v2)","deprecated":null,"version":null,"sidebarTitle":"List registered models (v2)","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v2","href":"/api-reference/registered-models/get-registered-models-visible-to-user-v2"},{"title":"Register a model from various sources","deprecated":null,"version":null,"sidebarTitle":"Register model (v2)","openapi":"/api-specs/cloud/public-api.json post /api/registeredmodels/v2","href":"/api-reference/registered-models/register-a-model-from-various-sources"},{"title":"Get Registered Models visible to user (v2)","deprecated":null,"version":null,"sidebarTitle":"List registered models (UI, v2)","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v2/ui","href":"/api-reference/registered-models/get-registered-models-visible-to-user-v2-1"},{"title":"Get versions of a Registered Model (V2)","deprecated":null,"version":null,"sidebarTitle":"List model versions (v2)","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v2/{modelName}/versions","href":"/api-reference/registered-models/get-versions-of-a-registered-model-v2"},{"title":"Get a specific version of a Registered Model (V2)","deprecated":null,"version":null,"sidebarTitle":"Get model version (v2)","openapi":"/api-specs/cloud/public-api.json get /api/registeredmodels/v2/{modelName}/versions/{version}","href":"/api-reference/registered-models/get-a-specific-version-of-a-registered-model-v2"}]},{"group":"Model deployment","pages":[{"title":"Gets all Deployment Target Types","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/admin/v1/deploymentTargetTypes","href":"/api-reference/model-deployment/gets-all-deployment-target-types"},{"title":"Gets a Deployment Target Type","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/admin/v1/deploymentTargetTypes/{deploymentTargetTypeId}","href":"/api-reference/model-deployment/gets-a-deployment-target-type"},{"title":"Gets all non-archived Deployment Targets based on the provided filters","deprecated":null,"version":null,"sidebarTitle":"List deployment targets","openapi":"/api-specs/cloud/public-api.json get /api/admin/v1/deploymentTargets","href":"/api-reference/model-deployment/gets-all-non-archived-deployment-targets-based-on-the-provided-filters"},{"title":"Creates a new Deployment Target","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/admin/v1/deploymentTargets","href":"/api-reference/model-deployment/creates-a-new-deployment-target"},{"title":"Gets all selectable non-archived Deployment Targets based on the provided filters","deprecated":null,"version":null,"sidebarTitle":"List selectable deployment targets","openapi":"/api-specs/cloud/public-api.json get /api/admin/v1/deploymentTargets/selectable","href":"/api-reference/model-deployment/gets-all-selectable-non-archived-deployment-targets-based-on-the-provided-filters"},{"title":"Gets a Deployment Target","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/admin/v1/deploymentTargets/{deploymentTargetId}","href":"/api-reference/model-deployment/gets-a-deployment-target"},{"title":"Deletes a Deployment Target","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/admin/v1/deploymentTargets/{deploymentTargetId}","href":"/api-reference/model-deployment/deletes-a-deployment-target"},{"title":"Updates a Deployment Target","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/admin/v1/deploymentTargets/{deploymentTargetId}","href":"/api-reference/model-deployment/updates-a-deployment-target"},{"title":"Gets all non-archived Resource Configurations based on the provided filters","deprecated":null,"version":null,"sidebarTitle":"List resource configurations","openapi":"/api-specs/cloud/public-api.json get /api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations","href":"/api-reference/model-deployment/gets-all-non-archived-resource-configurations-based-on-the-provided-filters"},{"title":"Creates a new Resource Configuration","deprecated":null,"version":null,"sidebarTitle":"Create resource configuration","openapi":"/api-specs/cloud/public-api.json post /api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations","href":"/api-reference/model-deployment/creates-a-new-resource-configuration"},{"title":"Gets a Resource Configuration","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations/{resourceConfigurationId}","href":"/api-reference/model-deployment/gets-a-resource-configuration"},{"title":"Deletes a Resource Configuration","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations/{resourceConfigurationId}","href":"/api-reference/model-deployment/deletes-a-resource-configuration"},{"title":"Updates a Resource Configuration","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations/{resourceConfigurationId}","href":"/api-reference/model-deployment/updates-a-resource-configuration"},{"title":"Gets the effective configuration for model deployments using the resource configuration","deprecated":null,"version":null,"sidebarTitle":"Get effective deployment schema","openapi":"/api-specs/cloud/public-api.json get /api/admin/v1/deploymentTargets/{deploymentTargetId}/resourceConfigurations/{resourceConfigurationId}/effectiveModelDeploymentSchema","href":"/api-reference/model-deployment/gets-the-effective-configuration-for-model-deployments-using-the-resource-configuration"},{"title":"Retrieve all Model Deployments","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelDeployments","href":"/api-reference/model-deployment/retrieve-all-model-deployments"},{"title":"Create a new Model Deployment","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/modelServing/v1/modelDeployments","href":"/api-reference/model-deployment/create-a-new-model-deployment"},{"title":"Retrieve a specific Model Deployment","deprecated":null,"version":null,"sidebarTitle":"Get model deployment","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelDeployments/{modelDeploymentId}","href":"/api-reference/model-deployment/retrieve-a-specific-model-deployment"},{"title":"Delete model deployment","deprecated":null,"version":null,"sidebarTitle":"Delete model deployment","openapi":"/api-specs/cloud/public-api.json delete /api/modelServing/v1/modelDeployments/{modelDeploymentId}","href":"/api-reference/model-deployment/delete-apimodelservingv1modeldeployments"},{"title":"Update a Model Deployment","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/modelServing/v1/modelDeployments/{modelDeploymentId}","href":"/api-reference/model-deployment/update-a-model-deployment"},{"title":"Retrieve all temporary credentials for a specific Model Deployment","deprecated":null,"version":null,"sidebarTitle":"List temporary credentials","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelDeployments/{modelDeploymentId}/credentials","href":"/api-reference/model-deployment/retrieve-all-temporary-credentials-for-a-specific-model-deployment"},{"title":"Retrieve temporary credentials of a specific Model Deployment for a specific operation type","deprecated":null,"version":null,"sidebarTitle":"Get credentials for operation","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelDeployments/{modelDeploymentId}/credentials/{operationType}","href":"/api-reference/model-deployment/retrieve-temporary-credentials-of-a-specific-model-deployment-for-a-specific-operation-type"},{"title":"Retrieve the logs for a specific Model Deployment","deprecated":null,"version":null,"sidebarTitle":"Get model deployment logs","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelDeployments/{modelDeploymentId}/logs/{logSuffix}","href":"/api-reference/model-deployment/retrieve-the-logs-for-a-specific-model-deployment"},{"title":"Start model deployment","deprecated":null,"version":null,"sidebarTitle":"Start model deployment","openapi":"/api-specs/cloud/public-api.json post /api/modelServing/v1/modelDeployments/{modelDeploymentId}/start","href":"/api-reference/model-deployment/post-apimodelservingv1modeldeployments-start"},{"title":"Stop model deployment","deprecated":null,"version":null,"sidebarTitle":"Stop model deployment","openapi":"/api-specs/cloud/public-api.json post /api/modelServing/v1/modelDeployments/{modelDeploymentId}/stop","href":"/api-reference/model-deployment/post-apimodelservingv1modeldeployments-stop"},{"title":"Retrieve all versions of a specific Model Deployment","deprecated":null,"version":null,"sidebarTitle":"List model deployment versions","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelDeployments/{modelDeploymentId}/versions","href":"/api-reference/model-deployment/retrieve-all-versions-of-a-specific-model-deployment"},{"title":"Retrieve a specific version of a Model Deployment","deprecated":null,"version":null,"sidebarTitle":"Get model deployment version","openapi":"/api-specs/cloud/public-api.json get /api/modelServing/v1/modelDeployments/{modelDeploymentId}/versions/{version}","href":"/api-reference/model-deployment/retrieve-a-specific-version-of-a-model-deployment"}]},{"group":"Extensions","pages":[{"title":"List Extensions","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/extensions/beta/extensions","href":"/api-reference/extensions/list-extensions"},{"title":"Create an Extension","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/extensions/beta/extensions","href":"/api-reference/extensions/create-an-extension"},{"title":"List Extensions for UI consumption","deprecated":null,"version":null,"sidebarTitle":"List extensions for UI","openapi":"/api-specs/cloud/public-api.json get /api/extensions/beta/extensions-ui","href":"/api-reference/extensions/list-extensions-for-ui-consumption"},{"title":"Get an Extension for UI consumption","deprecated":null,"version":null,"sidebarTitle":"Get extension for UI","openapi":"/api-specs/cloud/public-api.json get /api/extensions/beta/extensions-ui/{extensionId}","href":"/api-reference/extensions/get-an-extension-for-ui-consumption"},{"title":"Get an Extension by id","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/extensions/beta/extensions/{extensionId}","href":"/api-reference/extensions/get-an-extension-by-id"},{"title":"Soft delete an Extension by id","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/extensions/beta/extensions/{extensionId}","href":"/api-reference/extensions/soft-delete-an-extension-by-id"},{"title":"Patch an Extension by id","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/extensions/beta/extensions/{extensionId}","href":"/api-reference/extensions/patch-an-extension-by-id"},{"title":"Increment views for an Extension by one","deprecated":null,"version":null,"sidebarTitle":"Increment extension views","openapi":"/api-specs/cloud/public-api.json post /api/extensions/beta/extensions/{extensionId}/views","href":"/api-reference/extensions/increment-views-for-an-extension-by-one"},{"title":"List Domino Official Extension install options","deprecated":null,"version":null,"sidebarTitle":"List official install options","openapi":"/api-specs/cloud/public-api.json get /api/extensions/beta/official-install-menu","href":"/api-reference/extensions/list-domino-official-extension-install-options"},{"title":"Initiate a Domino Official Extension install or upgrade","deprecated":null,"version":null,"sidebarTitle":"Start official install or upgrade","openapi":"/api-specs/cloud/public-api.json post /api/extensions/beta/official-installs","href":"/api-reference/extensions/initiate-a-domino-official-extension-install-or-upgrade"},{"title":"Get a Domino Official Extension install by id","deprecated":null,"version":null,"sidebarTitle":"Get official install","openapi":"/api-specs/cloud/public-api.json get /api/extensions/beta/official-installs/{id}","href":"/api-reference/extensions/get-a-domino-official-extension-install-by-id"},{"title":"Cancel a Domino Official Extension install or upgrade","deprecated":null,"version":null,"sidebarTitle":"Cancel official install","openapi":"/api-specs/cloud/public-api.json post /api/extensions/beta/official-installs/{id}/cancel","href":"/api-reference/extensions/cancel-a-domino-official-extension-install-or-upgrade"},{"title":"Retry a Domino Official Extension install or upgrade","deprecated":null,"version":null,"sidebarTitle":"Retry official install","openapi":"/api-specs/cloud/public-api.json post /api/extensions/beta/official-installs/{id}/retry","href":"/api-reference/extensions/retry-a-domino-official-extension-install-or-upgrade"},{"title":"Uninstall a Domino Official Extension","deprecated":null,"version":null,"sidebarTitle":"Uninstall official extension","openapi":"/api-specs/cloud/public-api.json post /api/extensions/beta/official-installs/{id}/uninstall","href":"/api-reference/extensions/uninstall-a-domino-official-extension"},{"title":"Get the live diff for a completed extension install snapshot","deprecated":null,"version":null,"sidebarTitle":"Get install snapshot live diff","openapi":"/api-specs/cloud/public-api.json get /api/extensions/beta/official-installs/{installId}/snapshots/{snapshotId}/liveDiff","href":"/api-reference/extensions/get-the-live-diff-for-a-completed-extension-install-snapshot"}]},{"group":"Cost and billing","pages":[{"title":"Get the cost allocation over a time window","deprecated":null,"version":null,"sidebarTitle":"Get cost allocation (v1)","openapi":"/api-specs/cloud/public-api.json get /api/cost/v1/allocation","href":"/api-reference/cost-and-billing/get-the-cost-allocation-over-a-time-window"},{"title":"Get the cost allocation summary over a time window","deprecated":null,"version":null,"sidebarTitle":"Get cost allocation summary (v1)","openapi":"/api-specs/cloud/public-api.json get /api/cost/v1/allocation/summary","href":"/api-reference/cost-and-billing/get-the-cost-allocation-summary-over-a-time-window"},{"title":"Get the asset cost over a time window","deprecated":null,"version":null,"sidebarTitle":"Get asset cost (v1)","openapi":"/api-specs/cloud/public-api.json get /api/cost/v1/asset","href":"/api-reference/cost-and-billing/get-the-asset-cost-over-a-time-window"},{"title":"Set AWS Billing API Configuration","deprecated":null,"version":null,"sidebarTitle":"Set AWS billing configuration","openapi":"/api-specs/cloud/public-api.json put /api/cost/v1/athenaConfigs","href":"/api-reference/cost-and-billing/set-aws-billing-api-configuration"},{"title":"Get billing tags setting","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/cost/v1/billingtagSettings","href":"/api-reference/cost-and-billing/get-billing-tags-setting"},{"title":"Update billing tags setting","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/cost/v1/billingtagSettings","href":"/api-reference/cost-and-billing/update-billing-tags-setting"},{"title":"Get mode setting of the billing tags","deprecated":null,"version":null,"sidebarTitle":"Get billing tag mode","openapi":"/api-specs/cloud/public-api.json get /api/cost/v1/billingtagSettings/mode","href":"/api-reference/cost-and-billing/get-mode-setting-of-the-billing-tags"},{"title":"Update mode setting of the billing tags","deprecated":null,"version":null,"sidebarTitle":"Update billing tag mode","openapi":"/api-specs/cloud/public-api.json put /api/cost/v1/billingtagSettings/mode","href":"/api-reference/cost-and-billing/update-mode-setting-of-the-billing-tags"},{"title":"Get notifications setting of the billing tags","deprecated":null,"version":null,"sidebarTitle":"Get billing tag notifications","openapi":"/api-specs/cloud/public-api.json get /api/cost/v1/billingtagSettings/notifications","href":"/api-reference/cost-and-billing/get-notifications-setting-of-the-billing-tags"},{"title":"Update notifications setting of the billing tags","deprecated":null,"version":null,"sidebarTitle":"Update billing tag notifications","openapi":"/api-specs/cloud/public-api.json put /api/cost/v1/billingtagSettings/notifications","href":"/api-reference/cost-and-billing/update-notifications-setting-of-the-billing-tags"},{"title":"Get usable billing codes","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/cost/v1/billingtags","href":"/api-reference/cost-and-billing/get-usable-billing-codes"},{"title":"Upsert billing codes","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/cost/v1/billingtags","href":"/api-reference/cost-and-billing/upsert-billing-codes"},{"title":"Get billing tag by tag name","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/cost/v1/billingtags/{tag}","href":"/api-reference/cost-and-billing/get-billing-tag-by-tag-name"},{"title":"Deactivate billing tag","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/cost/v1/billingtags/{tag}","href":"/api-reference/cost-and-billing/deactivate-billing-tag"},{"title":"Get the cloud cost data","deprecated":null,"version":null,"sidebarTitle":"Get cloud cost (v1)","openapi":"/api-specs/cloud/public-api.json get /api/cost/v1/cloudCost","href":"/api-reference/cost-and-billing/get-the-cloud-cost-data"},{"title":"Get the activation status of the cost feature","deprecated":null,"version":null,"sidebarTitle":"Get cost activation status","openapi":"/api-specs/cloud/public-api.json get /api/cost/v1/costActivationStatus","href":"/api-reference/cost-and-billing/get-the-activation-status-of-the-cost-feature"},{"title":"Add kubecost license key","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/cost/v1/licenseKey","href":"/api-reference/cost-and-billing/add-kubecost-license-key"},{"title":"Get the cost allocation over a time window","deprecated":null,"version":null,"sidebarTitle":"Get cost allocation (v2)","openapi":"/api-specs/cloud/public-api.json get /api/cost/v2/allocation","href":"/api-reference/cost-and-billing/get-the-cost-allocation-over-a-time-window-1"},{"title":"Get accumulated cost allocation over a time window","deprecated":null,"version":null,"sidebarTitle":"Get accumulated allocation (v2)","openapi":"/api-specs/cloud/public-api.json get /api/cost/v2/allocation/accumulated","href":"/api-reference/cost-and-billing/get-accumulated-cost-allocation-over-a-time-window"},{"title":"Get the cost allocation summary over a time window","deprecated":null,"version":null,"sidebarTitle":"Get cost allocation summary (v2)","openapi":"/api-specs/cloud/public-api.json get /api/cost/v2/allocation/summary","href":"/api-reference/cost-and-billing/get-the-cost-allocation-summary-over-a-time-window-1"},{"title":"Get accumulated cost allocation summary over a time window","deprecated":null,"version":null,"sidebarTitle":"Get accumulated allocation summary","openapi":"/api-specs/cloud/public-api.json get /api/cost/v2/allocation/summary/accumulated","href":"/api-reference/cost-and-billing/get-accumulated-cost-allocation-summary-over-a-time-window"},{"title":"Get the asset cost over a time window","deprecated":null,"version":null,"sidebarTitle":"Get asset cost (v2)","openapi":"/api-specs/cloud/public-api.json get /api/cost/v2/asset","href":"/api-reference/cost-and-billing/get-the-asset-cost-over-a-time-window-1"},{"title":"Get accumulated asset cost over a time window","deprecated":null,"version":null,"sidebarTitle":"Get accumulated asset cost","openapi":"/api-specs/cloud/public-api.json get /api/cost/v2/asset/accumulated","href":"/api-reference/cost-and-billing/get-accumulated-asset-cost-over-a-time-window"},{"title":"Get the cloud cost data","deprecated":null,"version":null,"sidebarTitle":"Get cloud cost (v2)","openapi":"/api-specs/cloud/public-api.json get /api/cost/v2/cloudCost","href":"/api-reference/cost-and-billing/get-the-cloud-cost-data-1"},{"title":"Get the accumulated cloud cost data","deprecated":null,"version":null,"sidebarTitle":"Get accumulated cloud cost","openapi":"/api-specs/cloud/public-api.json get /api/cost/v2/cloudCost/accumulated","href":"/api-reference/cost-and-billing/get-the-accumulated-cloud-cost-data"}]},{"group":"Users and organizations","pages":[{"title":"Get the Organizations for a user","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/organizations/v1/organizations","href":"/api-reference/users-and-organizations/get-the-organizations-for-a-user"},{"title":"Create an organization","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/organizations/v1/organizations","href":"/api-reference/users-and-organizations/create-an-organization"},{"title":"Get all organizations. Only accessible to admin users.","deprecated":null,"version":null,"sidebarTitle":"List all organizations (admin)","openapi":"/api-specs/cloud/public-api.json get /api/organizations/v1/organizations/all","href":"/api-reference/users-and-organizations/get-all-organizations-only-accessible-to-admin-users"},{"title":"Get an organization by Id","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/organizations/v1/organizations/{organizationId}","href":"/api-reference/users-and-organizations/get-an-organization-by-id"},{"title":"Add a user to an org","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/organizations/v1/organizations/{organizationId}/user","href":"/api-reference/users-and-organizations/add-a-user-to-an-org"},{"title":"Remove a user from an org","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/organizations/v1/organizations/{organizationId}/user","href":"/api-reference/users-and-organizations/remove-a-user-from-an-org"},{"title":"Get git credential accessor for a User","deprecated":null,"version":null,"sidebarTitle":"Get Git credential accessor","openapi":"/api-specs/cloud/public-api.json get /api/users/beta/credentials/{userId}","href":"/api-reference/users-and-organizations/get-git-credential-accessor-for-a-user"},{"title":"Get the current user","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/users/v1/self","href":"/api-reference/users-and-organizations/get-the-current-user"},{"title":"Get a user by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/users/v1/user/{userId}","href":"/api-reference/users-and-organizations/get-a-user-by-id"},{"title":"Get roles assigned to a user","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/users/v1/user/{userId}/roles","href":"/api-reference/users-and-organizations/get-roles-assigned-to-a-user"},{"title":"Set roles for a user","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/users/v1/user/{userId}/roles","href":"/api-reference/users-and-organizations/set-roles-for-a-user"},{"title":"Update git credential accessor for a User","deprecated":null,"version":null,"sidebarTitle":"Update Git credential accessor","openapi":"/api-specs/cloud/public-api.json put /api/users/v1/user/{userId}/tokenCredentials/{credentialId}","href":"/api-reference/users-and-organizations/update-git-credential-accessor-for-a-user"},{"title":"Get all users visible to the current user","deprecated":null,"version":null,"sidebarTitle":"List visible users","openapi":"/api-specs/cloud/public-api.json get /api/users/v1/users","href":"/api-reference/users-and-organizations/get-all-users-visible-to-the-current-user"}]},{"group":"Service accounts","pages":[{"title":"List service accounts","deprecated":null,"version":null,"sidebarTitle":"List service accounts","openapi":"/api-specs/cloud/public-api.json get /api/serviceAccounts/v1/serviceAccounts","href":"/api-reference/service-accounts/get-apiserviceaccountsv1serviceaccounts"},{"title":"Create service account","deprecated":null,"version":null,"sidebarTitle":"Create service account","openapi":"/api-specs/cloud/public-api.json post /api/serviceAccounts/v1/serviceAccounts","href":"/api-reference/service-accounts/post-apiserviceaccountsv1serviceaccounts"},{"title":"Activate service account","deprecated":null,"version":null,"sidebarTitle":"Activate service account","openapi":"/api-specs/cloud/public-api.json post /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/activate","href":"/api-reference/service-accounts/post-apiserviceaccountsv1serviceaccounts-activate"},{"title":"Deactivate service account","deprecated":null,"version":null,"sidebarTitle":"Deactivate service account","openapi":"/api-specs/cloud/public-api.json post /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/deactivate","href":"/api-reference/service-accounts/post-apiserviceaccountsv1serviceaccounts-deactivate"},{"title":"List service account Git credentials","deprecated":null,"version":null,"sidebarTitle":"List Git credentials","openapi":"/api-specs/cloud/public-api.json get /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/gitcredentials","href":"/api-reference/service-accounts/get-apiserviceaccountsv1serviceaccounts-gitcredentials"},{"title":"Remove Git credentials from service account","deprecated":null,"version":null,"sidebarTitle":"Remove Git credentials","openapi":"/api-specs/cloud/public-api.json delete /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/gitcredentials/{credentialId}","href":"/api-reference/service-accounts/delete-apiserviceaccountsv1serviceaccounts-gitcredentials"},{"title":"Add password Git credentials to service account","deprecated":null,"version":null,"sidebarTitle":"Add password Git credentials","openapi":"/api-specs/cloud/public-api.json post /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/passwordgitcredentials","href":"/api-reference/service-accounts/post-apiserviceaccountsv1serviceaccounts-passwordgitcredentials"},{"title":"Reset service account password","deprecated":null,"version":null,"sidebarTitle":"Reset password","openapi":"/api-specs/cloud/public-api.json post /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/resetpassword","href":"/api-reference/service-accounts/post-apiserviceaccountsv1serviceaccounts-resetpassword"},{"title":"Add SSH Git credentials to service account","deprecated":null,"version":null,"sidebarTitle":"Add SSH Git credentials","openapi":"/api-specs/cloud/public-api.json post /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/sshgitcredentials","href":"/api-reference/service-accounts/post-apiserviceaccountsv1serviceaccounts-sshgitcredentials"},{"title":"Add token Git credentials to service account","deprecated":null,"version":null,"sidebarTitle":"Add token Git credentials","openapi":"/api-specs/cloud/public-api.json post /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/tokengitcredentials","href":"/api-reference/service-accounts/post-apiserviceaccountsv1serviceaccounts-tokengitcredentials"},{"title":"List service account tokens","deprecated":null,"version":null,"sidebarTitle":"List tokens","openapi":"/api-specs/cloud/public-api.json get /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/tokens","href":"/api-reference/service-accounts/get-apiserviceaccountsv1serviceaccounts-tokens"},{"title":"Create service account token","deprecated":null,"version":null,"sidebarTitle":"Create token","openapi":"/api-specs/cloud/public-api.json post /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/tokens","href":"/api-reference/service-accounts/post-apiserviceaccountsv1serviceaccounts-tokens"},{"title":"Get service account token","deprecated":null,"version":null,"sidebarTitle":"Get token","openapi":"/api-specs/cloud/public-api.json get /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/tokens/{tokenName}","href":"/api-reference/service-accounts/get-apiserviceaccountsv1serviceaccounts-tokens-1"},{"title":"Delete service account token","deprecated":null,"version":null,"sidebarTitle":"Delete token","openapi":"/api-specs/cloud/public-api.json delete /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/tokens/{tokenName}","href":"/api-reference/service-accounts/delete-apiserviceaccountsv1serviceaccounts-tokens"},{"title":"Invalidate service account token","deprecated":null,"version":null,"sidebarTitle":"Invalidate token","openapi":"/api-specs/cloud/public-api.json post /api/serviceAccounts/v1/serviceAccounts/{serviceAccountIdpId}/tokens/{tokenName}/invalidate","href":"/api-reference/service-accounts/post-apiserviceaccountsv1serviceaccounts-tokens-invalidate"}]},{"group":"Personal Access Tokens","pages":[{"title":"Retrieves a list of personal access tokens","deprecated":null,"version":null,"sidebarTitle":"List tokens","openapi":"/api-specs/cloud/public-api.json get /api/pat/v1/tokens","href":"/api-reference/personal-access-tokens/retrieves-a-list-of-personal-access-tokens"},{"title":"Create a personal access token","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/pat/v1/tokens","href":"/api-reference/personal-access-tokens/create-a-personal-access-token"},{"title":"Delete all their personal access token","deprecated":null,"version":null,"sidebarTitle":"Delete all tokens","openapi":"/api-specs/cloud/public-api.json delete /api/pat/v1/tokens","href":"/api-reference/personal-access-tokens/delete-all-their-personal-access-token"},{"title":"Delete a list of personal access tokens","deprecated":null,"version":null,"sidebarTitle":"Delete tokens in bulk","openapi":"/api-specs/cloud/public-api.json post /api/pat/v1/tokens/delete/bulk","href":"/api-reference/personal-access-tokens/delete-a-list-of-personal-access-tokens"},{"title":"Retrieves the min and max expiration time allowed for a personal access token","deprecated":null,"version":null,"sidebarTitle":"Get token expiration policy","openapi":"/api-specs/cloud/public-api.json get /api/pat/v1/tokens/expiration-policy","href":"/api-reference/personal-access-tokens/retrieves-the-min-and-max-expiration-time-allowed-for-a-personal-access-token"},{"title":"Retrieves the scopes that can be granted to a personal access token","deprecated":null,"version":null,"sidebarTitle":"Get grantable token scopes","openapi":"/api-specs/cloud/public-api.json get /api/pat/v1/tokens/grantable-scopes","href":"/api-reference/personal-access-tokens/retrieves-the-scopes-that-can-be-granted-to-a-personal-access-token"},{"title":"Invalidate all their personal access token","deprecated":null,"version":null,"sidebarTitle":"Invalidate all tokens","openapi":"/api-specs/cloud/public-api.json post /api/pat/v1/tokens/invalidate","href":"/api-reference/personal-access-tokens/invalidate-all-their-personal-access-token"},{"title":"Invalidate a list of personal access tokens","deprecated":null,"version":null,"sidebarTitle":"Invalidate tokens in bulk","openapi":"/api-specs/cloud/public-api.json post /api/pat/v1/tokens/invalidate/bulk","href":"/api-reference/personal-access-tokens/invalidate-a-list-of-personal-access-tokens"},{"title":"Delete a personal access token","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/pat/v1/tokens/{patId}","href":"/api-reference/personal-access-tokens/delete-a-personal-access-token"},{"title":"Invalidate a personal access token","deprecated":null,"version":null,"sidebarTitle":"Invalidate token","openapi":"/api-specs/cloud/public-api.json post /api/pat/v1/tokens/{patId}/invalidate","href":"/api-reference/personal-access-tokens/invalidate-a-personal-access-token"}]},{"group":"Personal Access Tokens (admin)","pages":[{"title":"Retrieves a list of personal access tokens","deprecated":null,"version":null,"sidebarTitle":"List all users' tokens","openapi":"/api-specs/cloud/public-api.json get /api/pat/v1/users/tokens","href":"/api-reference/personal-access-tokens-admin/retrieves-a-list-of-personal-access-tokens"},{"title":"Delete a list of personal access tokens","deprecated":null,"version":null,"sidebarTitle":"Delete users' tokens in bulk","openapi":"/api-specs/cloud/public-api.json post /api/pat/v1/users/tokens/delete/bulk","href":"/api-reference/personal-access-tokens-admin/delete-a-list-of-personal-access-tokens"},{"title":"Invalidate a list of personal access tokens","deprecated":null,"version":null,"sidebarTitle":"Invalidate users' tokens in bulk","openapi":"/api-specs/cloud/public-api.json post /api/pat/v1/users/tokens/invalidate/bulk","href":"/api-reference/personal-access-tokens-admin/invalidate-a-list-of-personal-access-tokens"},{"title":"Retrieves a list of personal access tokens","deprecated":null,"version":null,"sidebarTitle":"List tokens for user","openapi":"/api-specs/cloud/public-api.json get /api/pat/v1/users/{userId}/tokens","href":"/api-reference/personal-access-tokens-admin/retrieves-a-list-of-personal-access-tokens-1"},{"title":"Delete all personal access token of a User","deprecated":null,"version":null,"sidebarTitle":"Delete all tokens for user","openapi":"/api-specs/cloud/public-api.json delete /api/pat/v1/users/{userId}/tokens","href":"/api-reference/personal-access-tokens-admin/delete-all-personal-access-token-of-a-user"},{"title":"Invalidate all personal access tokens of a User","deprecated":null,"version":null,"sidebarTitle":"Invalidate all tokens for user","openapi":"/api-specs/cloud/public-api.json post /api/pat/v1/users/{userId}/tokens/invalidate","href":"/api-reference/personal-access-tokens-admin/invalidate-all-personal-access-tokens-of-a-user"},{"title":"Delete a personal access token of a User","deprecated":null,"version":null,"sidebarTitle":"Delete token for user","openapi":"/api-specs/cloud/public-api.json delete /api/pat/v1/users/{userId}/tokens/{patId}","href":"/api-reference/personal-access-tokens-admin/delete-a-personal-access-token-of-a-user"},{"title":"Invalidate a personal access token of a User","deprecated":null,"version":null,"sidebarTitle":"Invalidate token for user","openapi":"/api-specs/cloud/public-api.json post /api/pat/v1/users/{userId}/tokens/{patId}/invalidate","href":"/api-reference/personal-access-tokens-admin/invalidate-a-personal-access-token-of-a-user"}]},{"group":"Audit Trail","pages":[{"title":"List audit events","deprecated":null,"version":null,"sidebarTitle":"List audit events","openapi":"/api-specs/cloud/public-api.json get /api/audittrail/v1/auditevents","href":"/api-reference/audit-trail/get-apiaudittrailv1auditevents"},{"title":"Get distinct field values","deprecated":null,"version":null,"sidebarTitle":"Get distinct field values","openapi":"/api-specs/cloud/public-api.json get /api/audittrail/v1/fieldValues","href":"/api-reference/audit-trail/get-apiaudittrailv1fieldvalues"},{"title":"Search audit events","deprecated":null,"version":null,"sidebarTitle":"Search audit events","openapi":"/api-specs/cloud/public-api.json post /api/audittrail/v1/search","href":"/api-reference/audit-trail/post-apiaudittrailv1search"}]},{"group":"Custom metrics","pages":[{"title":"Send a metric alert","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/metricAlerts/v1","href":"/api-reference/custom-metrics/send-a-metric-alert"},{"title":"Log metric values","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/metricValues/v1","href":"/api-reference/custom-metrics/log-metric-values"},{"title":"Retrieve metric values","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/metricValues/v1/{modelMonitoringId}/{metric}","href":"/api-reference/custom-metrics/retrieve-metric-values"}]},{"group":"PPM","pages":[{"title":"Get Admin Config","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/v4/ppm/admin/config","href":"/api-reference/ppm/get-admin-config"},{"title":"Create Admin Config","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/v4/ppm/admin/config","href":"/api-reference/ppm/create-admin-config"},{"title":"Delete Admin Config","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/v4/ppm/admin/config/{configId}","href":"/api-reference/ppm/delete-admin-config"},{"title":"Update Admin Config","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/v4/ppm/admin/config/{configId}","href":"/api-reference/ppm/update-admin-config"},{"title":"Get Workspace PPM Config with Repository Detection","deprecated":null,"version":null,"sidebarTitle":"Get Workspace PPM config","openapi":"/api-specs/cloud/public-api.json get /api/v4/ppm/projects/{projectId}/workspaces/{workspaceId}/config","href":"/api-reference/ppm/get-workspace-ppm-config-with-repository-detection"},{"title":"Search PPM Snapshots with Workspace Repository Targeting","deprecated":null,"version":null,"sidebarTitle":"Search PPM snapshots","openapi":"/api-specs/cloud/public-api.json post /api/v4/ppm/search","href":"/api-reference/ppm/search-ppm-snapshots-with-workspace-repository-targeting"},{"title":"Render PPM Installation Snippet","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/v4/ppm/snippet","href":"/api-reference/ppm/render-ppm-installation-snippet"}]},{"group":"Model Monitoring models","pages":[{"title":"Get prediction traffic","deprecated":null,"version":null,"sidebarTitle":"Get prediction traffic","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/get-prediction-traffic","href":"/api-reference/model-monitoring-models/get-model-monitorv2apimodelget-prediction-traffic"},{"title":"Get ground truth traffic","deprecated":null,"version":null,"sidebarTitle":"Get ground truth traffic","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/traffic/ground-truth","href":"/api-reference/model-monitoring-models/get-model-monitorv2apimodel-trafficground-truth"},{"title":"Register dataset config","deprecated":null,"version":null,"sidebarTitle":"Register dataset config","openapi":"/api-specs/cloud/public-api.json put /model-monitor/v2/api/model/{model_id}/register-dataset/{dataset_type}","href":"/api-reference/model-monitoring-models/put-model-monitorv2apimodel-register-dataset"},{"title":"Get model","deprecated":null,"version":null,"sidebarTitle":"Get model","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model","href":"/api-reference/model-monitoring-models/get-model-monitorv2apimodel"},{"title":"Register model","deprecated":null,"version":null,"sidebarTitle":"Register model","openapi":"/api-specs/cloud/public-api.json put /model-monitor/v2/api/model","href":"/api-reference/model-monitoring-models/put-model-monitorv2apimodel"},{"title":"Delete model","deprecated":null,"version":null,"sidebarTitle":"Delete model","openapi":"/api-specs/cloud/public-api.json delete /model-monitor/v2/api/model","href":"/api-reference/model-monitoring-models/delete-model-monitorv2apimodel"},{"title":"Update model","deprecated":null,"version":null,"sidebarTitle":"Update model","openapi":"/api-specs/cloud/public-api.json patch /model-monitor/v2/api/model","href":"/api-reference/model-monitoring-models/patch-model-monitorv2apimodel"},{"title":"List models","deprecated":null,"version":null,"sidebarTitle":"List models","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/models","href":"/api-reference/model-monitoring-models/get-model-monitorv2apimodels"},{"title":"Get model summary","deprecated":null,"version":null,"sidebarTitle":"Get model summary","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/get_model_summary","href":"/api-reference/model-monitoring-models/get-model-monitorv2apiget_model_summary"},{"title":"Get model variables summary","deprecated":null,"version":null,"sidebarTitle":"Get model variables summary","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/variables/summary","href":"/api-reference/model-monitoring-models/get-model-monitorv2apimodel-variablessummary"},{"title":"Update model visibility","deprecated":null,"version":null,"sidebarTitle":"Update model visibility","openapi":"/api-specs/cloud/public-api.json put /model-monitor/v2/api/model/{model_id}/visibility","href":"/api-reference/model-monitoring-models/put-model-monitorv2apimodel-visibility"},{"title":"List model collaborators","deprecated":null,"version":null,"sidebarTitle":"List model collaborators","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/collaborators","href":"/api-reference/model-monitoring-models/get-model-monitorv2apimodel-collaborators"},{"title":"Update collaborator role","deprecated":null,"version":null,"sidebarTitle":"Update collaborator role","openapi":"/api-specs/cloud/public-api.json put /model-monitor/v2/api/model/{model_id}/collaborators","href":"/api-reference/model-monitoring-models/put-model-monitorv2apimodel-collaborators"},{"title":"Add model collaborators","deprecated":null,"version":null,"sidebarTitle":"Add collaborators","openapi":"/api-specs/cloud/public-api.json post /model-monitor/v2/api/model/{model_id}/collaborators","href":"/api-reference/model-monitoring-models/post-model-monitorv2apimodel-collaborators"},{"title":"Remove model collaborator","deprecated":null,"version":null,"sidebarTitle":"Remove collaborator","openapi":"/api-specs/cloud/public-api.json delete /model-monitor/v2/api/model/{model_id}/collaborators","href":"/api-reference/model-monitoring-models/delete-model-monitorv2apimodel-collaborators"},{"title":"List model tags","deprecated":null,"version":null,"sidebarTitle":"List model tags","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/tags","href":"/api-reference/model-monitoring-models/get-model-monitorv2apimodel-tags"},{"title":"Add model tags","deprecated":null,"version":null,"sidebarTitle":"Add model tags","openapi":"/api-specs/cloud/public-api.json post /model-monitor/v2/api/model/{model_id}/tags","href":"/api-reference/model-monitoring-models/post-model-monitorv2apimodel-tags"},{"title":"Remove model tag","deprecated":null,"version":null,"sidebarTitle":"Remove model tag","openapi":"/api-specs/cloud/public-api.json delete /model-monitor/v2/api/model/{model_id}/tags","href":"/api-reference/model-monitoring-models/delete-model-monitorv2apimodel-tags"},{"title":"Archive model tag","deprecated":null,"version":null,"sidebarTitle":"Archive model tag","openapi":"/api-specs/cloud/public-api.json patch /model-monitor/v2/api/model-tag/{tag_id}/archive","href":"/api-reference/model-monitoring-models/patch-model-monitorv2apimodel-tag-archive"},{"title":"Unarchive model tag","deprecated":null,"version":null,"sidebarTitle":"Unarchive model tag","openapi":"/api-specs/cloud/public-api.json patch /model-monitor/v2/api/model-tag/{tag_id}/unarchive","href":"/api-reference/model-monitoring-models/patch-model-monitorv2apimodel-tag-unarchive"},{"title":"Get summary for workbench model versions","deprecated":null,"version":null,"sidebarTitle":"Get workbench version summary","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/workbench/model/version/summary","href":"/api-reference/model-monitoring-models/get-summary-for-workbench-model-versions"}]},{"group":"Model Monitoring drift and quality","pages":[{"title":"Analyze drift","deprecated":null,"version":null,"sidebarTitle":"Analyze drift","openapi":"/api-specs/cloud/public-api.json post /model-monitor/v2/api/model/{model_id}/analyse-drift","href":"/api-reference/model-monitoring-drift-and-quality/post-model-monitorv2apimodel-analyse-drift"},{"title":"Get drift user query","deprecated":null,"version":null,"sidebarTitle":"Get drift user query","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/drift-user-query","href":"/api-reference/model-monitoring-drift-and-quality/get-model-monitorv2apimodel-drift-user-query"},{"title":"Get drift scheduler query","deprecated":null,"version":null,"sidebarTitle":"Get drift scheduler query","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/drift-scheduler-query","href":"/api-reference/model-monitoring-drift-and-quality/get-model-monitorv2apimodel-drift-scheduler-query"},{"title":"Get column drift trend","deprecated":null,"version":null,"sidebarTitle":"Get column drift trend","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/{column_id}/drift-trend","href":"/api-reference/model-monitoring-drift-and-quality/get-model-monitorv2apimodel-drift-trend"},{"title":"Save drift scheduler query","deprecated":null,"version":null,"sidebarTitle":"Save drift scheduler query","openapi":"/api-specs/cloud/public-api.json post /model-monitor/v2/api/model/{model_id}/save-scheduler-query","href":"/api-reference/model-monitoring-drift-and-quality/post-model-monitorv2apimodel-save-scheduler-query"},{"title":"Get drift check history","deprecated":null,"version":null,"sidebarTitle":"Get drift check history","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/drift-schedule-checks-history","href":"/api-reference/model-monitoring-drift-and-quality/get-model-monitorv2apimodel-drift-schedule-checks-history"},{"title":"Get scheduled drift check data","deprecated":null,"version":null,"sidebarTitle":"Get scheduled drift check data","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/{scheduler_id}/scheduled-check-drift-data","href":"/api-reference/model-monitoring-drift-and-quality/get-model-monitorv2apimodel-scheduled-check-drift-data"},{"title":"List dataset jobs","deprecated":null,"version":null,"sidebarTitle":"List dataset jobs","openapi":"/api-specs/cloud/public-api.json post /model-monitor/v2/api/{model_id}/dataset-jobs","href":"/api-reference/model-monitoring-drift-and-quality/post-model-monitorv2api-dataset-jobs"},{"title":"Get dataset timeline","deprecated":null,"version":null,"sidebarTitle":"Get dataset timeline","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/dataset-timeline","href":"/api-reference/model-monitoring-drift-and-quality/get-model-monitorv2apimodel-dataset-timeline"},{"title":"Analyze model quality","deprecated":null,"version":null,"sidebarTitle":"Analyze model quality","openapi":"/api-specs/cloud/public-api.json post /model-monitor/v2/api/model/{model_id}/analyze-model-quality","href":"/api-reference/model-monitoring-drift-and-quality/post-model-monitorv2apimodel-analyze-model-quality"},{"title":"Get quality user query","deprecated":null,"version":null,"sidebarTitle":"Get quality user query","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/model-quality-user-query","href":"/api-reference/model-monitoring-drift-and-quality/get-model-monitorv2apimodel-model-quality-user-query"},{"title":"Get model quality trend","deprecated":null,"version":null,"sidebarTitle":"Get model quality trend","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/model-quality-trend","href":"/api-reference/model-monitoring-drift-and-quality/get-model-monitorv2apimodel-model-quality-trend"},{"title":"Get quality scheduler query","deprecated":null,"version":null,"sidebarTitle":"Get quality scheduler query","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/model-quality-scheduler-query","href":"/api-reference/model-monitoring-drift-and-quality/get-model-monitorv2apimodel-model-quality-scheduler-query"},{"title":"Save quality scheduler query","deprecated":null,"version":null,"sidebarTitle":"Save quality scheduler query","openapi":"/api-specs/cloud/public-api.json post /model-monitor/v2/api/model/{model_id}/model-quality-scheduler-query","href":"/api-reference/model-monitoring-drift-and-quality/post-model-monitorv2apimodel-model-quality-scheduler-query"},{"title":"Get quality check history","deprecated":null,"version":null,"sidebarTitle":"Get quality check history","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{model_id}/model-quality-scheduled-checks-history","href":"/api-reference/model-monitoring-drift-and-quality/get-model-monitorv2apimodel-model-quality-scheduled-checks-history"},{"title":"Get scheduled quality check data","deprecated":null,"version":null,"sidebarTitle":"Get scheduled quality check data","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/model/{scheduled_check_id}/model-quality-scheduled-check-data","href":"/api-reference/model-monitoring-drift-and-quality/get-model-monitorv2apimodel-model-quality-scheduled-check-data"}]},{"group":"Model Monitoring settings","pages":[{"title":"Get global settings.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/setting/global","href":"/api-reference/model-monitoring-settings/get-global-settings"},{"title":"Update global settings.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /model-monitor/v2/api/setting/global","href":"/api-reference/model-monitoring-settings/update-global-settings"},{"title":"Get the existing user setting for the given user.","deprecated":null,"version":null,"sidebarTitle":"Get user settings","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/setting/user","href":"/api-reference/model-monitoring-settings/get-the-existing-user-setting-for-the-given-user"},{"title":"Update the existing user setting for the user.","deprecated":null,"version":null,"sidebarTitle":"Update user settings","openapi":"/api-specs/cloud/public-api.json post /model-monitor/v2/api/setting/user","href":"/api-reference/model-monitoring-settings/update-the-existing-user-setting-for-the-user"},{"title":"Get drift default settings","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/setting/default/drift","href":"/api-reference/model-monitoring-settings/get-drift-default-settings"},{"title":"Update the drift default settings.","deprecated":null,"version":null,"sidebarTitle":"Update drift defaults","openapi":"/api-specs/cloud/public-api.json put /model-monitor/v2/api/setting/default/drift","href":"/api-reference/model-monitoring-settings/update-the-drift-default-settings"},{"title":"Get model quality metric default settings","deprecated":null,"version":null,"sidebarTitle":"Get quality metric defaults","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/setting/default/metric","href":"/api-reference/model-monitoring-settings/get-model-quality-metric-default-settings"},{"title":"Update the model quality metric default settings.","deprecated":null,"version":null,"sidebarTitle":"Update quality metric defaults","openapi":"/api-specs/cloud/public-api.json put /model-monitor/v2/api/setting/default/metric","href":"/api-reference/model-monitoring-settings/update-the-model-quality-metric-default-settings"},{"title":"Fetch alert config for the given model.","deprecated":null,"version":null,"sidebarTitle":"Get model alert config","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/notification/model-config/{model_id}","href":"/api-reference/model-monitoring-settings/fetch-alert-config-for-the-given-model"},{"title":"Create or Update the existing model alert config.","deprecated":null,"version":null,"sidebarTitle":"Set model alert config","openapi":"/api-specs/cloud/public-api.json post /model-monitor/v2/api/notification/model-config/{model_id}","href":"/api-reference/model-monitoring-settings/create-or-update-the-existing-model-alert-config"},{"title":"Fetch channel config for notifications in DMM.","deprecated":null,"version":null,"sidebarTitle":"Get notification channel config","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/notification/channel-config","href":"/api-reference/model-monitoring-settings/fetch-channel-config-for-notifications-in-dmm"},{"title":"Create or Update existing channel config for notifications in DMM.","deprecated":null,"version":null,"sidebarTitle":"Set notification channel config","openapi":"/api-specs/cloud/public-api.json post /model-monitor/v2/api/notification/channel-config","href":"/api-reference/model-monitoring-settings/create-or-update-existing-channel-config-for-notifications-in-dmm"},{"title":"Pauses schedule job","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /model-monitor/api/scheduler/{schedulerJobId}/unschedule_scheduler_job","href":"/api-reference/model-monitoring-settings/pauses-schedule-job"},{"title":"Updates scheduler job of a model","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /model-monitor/api/scheduler/update_scheduler_config","href":"/api-reference/model-monitoring-settings/updates-scheduler-job-of-a-model"},{"title":"Gets schedule check data by schedule job ID","deprecated":null,"version":null,"sidebarTitle":"Get schedule check by ID","openapi":"/api-specs/cloud/public-api.json get /model-monitor/api/scheduler/{scheduleCheckId}/get_schedule_check_by_id","href":"/api-reference/model-monitoring-settings/gets-schedule-check-data-by-schedule-job-id"},{"title":"Creates a schedule check for a model drift","deprecated":null,"version":null,"sidebarTitle":"Create drift schedule check","openapi":"/api-specs/cloud/public-api.json post /model-monitor/api/scheduler/create_drift_schedule_check","href":"/api-reference/model-monitoring-settings/creates-a-schedule-check-for-a-model-drift"},{"title":"Gets schedule check job for model drift.","deprecated":null,"version":null,"sidebarTitle":"Get drift schedule check","openapi":"/api-specs/cloud/public-api.json get /model-monitor/api/scheduler/{modelId}/get_drift_schedule_check","href":"/api-reference/model-monitoring-settings/gets-schedule-check-job-for-model-drift"},{"title":"Creates a schedule check for model quality.","deprecated":null,"version":null,"sidebarTitle":"Create quality schedule check","openapi":"/api-specs/cloud/public-api.json post /model-monitor/api/scheduler/create_quality_schedule_check","href":"/api-reference/model-monitoring-settings/creates-a-schedule-check-for-model-quality"},{"title":"Gets schedule check job for model quality","deprecated":null,"version":null,"sidebarTitle":"Get quality schedule check","openapi":"/api-specs/cloud/public-api.json get /model-monitor/api/scheduler/{modelId}/get_quality_schedule_check","href":"/api-reference/model-monitoring-settings/gets-schedule-check-job-for-model-quality"},{"title":"Sends test mail","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /model-monitor/api/scheduler/test_email","href":"/api-reference/model-monitoring-settings/sends-test-mail"}]},{"group":"Model Monitoring authentication","pages":[{"title":"Ping","deprecated":null,"version":null,"sidebarTitle":"Ping","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/ping","href":"/api-reference/model-monitoring-authentication/get-model-monitorv2apiping"},{"title":"Log in","deprecated":null,"version":null,"sidebarTitle":"Log in","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/auth/login","href":"/api-reference/model-monitoring-authentication/get-model-monitorv2apiauthlogin"},{"title":"Log out","deprecated":null,"version":null,"sidebarTitle":"Log out","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/auth/logout","href":"/api-reference/model-monitoring-authentication/get-model-monitorv2apiauthlogout"},{"title":"Get current user","deprecated":null,"version":null,"sidebarTitle":"Get current user","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/auth/user/current","href":"/api-reference/model-monitoring-authentication/get-model-monitorv2apiauthusercurrent"},{"title":"Get API key report","deprecated":null,"version":null,"sidebarTitle":"Get API key report","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/auth/api_key_report","href":"/api-reference/model-monitoring-authentication/get-model-monitorv2apiauthapi_key_report"},{"title":"Get OIDC details","deprecated":true,"version":null,"sidebarTitle":"Get OIDC details","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/auth/get_oidc_details","href":"/api-reference/model-monitoring-authentication/get-model-monitorv2apiauthget_oidc_details"},{"title":"Generate user API key","deprecated":true,"version":null,"sidebarTitle":"Generate user API key","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/auth/user/generate_api_key","href":"/api-reference/model-monitoring-authentication/get-model-monitorv2apiauthusergenerate_api_key"},{"title":"Get user API key","deprecated":null,"version":null,"sidebarTitle":"Get user API key","openapi":"/api-specs/cloud/public-api.json get /model-monitor/v2/api/auth/user/api_key","href":"/api-reference/model-monitoring-authentication/get-model-monitorv2apiauthuserapi_key"},{"title":"Revoke user API key","deprecated":null,"version":null,"sidebarTitle":"Revoke user API key","openapi":"/api-specs/cloud/public-api.json put /model-monitor/v2/api/auth/user/revoke_api_key","href":"/api-reference/model-monitoring-authentication/put-model-monitorv2apiauthuserrevoke_api_key"}]},{"group":"Governance bundles","pages":[{"title":"List attachment overviews","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/attachment-overviews","href":"/api-reference/governance-bundles/list-attachment-overviews"},{"title":"List bundle stages (Stage View)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/bundle-stages","href":"/api-reference/governance-bundles/list-bundle-stages-stage-view"},{"title":"Bulk reassign bundle stages","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/bundle-stages/bulk-reassign","href":"/api-reference/governance-bundles/bulk-reassign-bundle-stages"},{"title":"List bundles","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/bundles","href":"/api-reference/governance-bundles/list-bundles"},{"title":"Create a bundle to collect evidence for a governed entity","deprecated":null,"version":null,"sidebarTitle":"Create bundle","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/bundles","href":"/api-reference/governance-bundles/create-a-bundle-to-collect-evidence-for-a-governed-entity"},{"title":"Bulk update bundles","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/bundles/bulk-update","href":"/api-reference/governance-bundles/bulk-update-bundles"},{"title":"Get bundle by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/bundles/{id}","href":"/api-reference/governance-bundles/get-bundle-by-id"},{"title":"Delete bundle by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/governance/v1/bundles/{id}","href":"/api-reference/governance-bundles/delete-bundle-by-id"},{"title":"Update bundle by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/governance/v1/bundles/{id}","href":"/api-reference/governance-bundles/update-bundle-by-id"},{"title":"Get the current status of every approval in a bundle","deprecated":null,"version":null,"sidebarTitle":"List bundle approval statuses","openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/bundles/{id}/approvals","href":"/api-reference/governance-bundles/get-the-current-status-of-every-approval-in-a-bundle"},{"title":"Create revalidation config for an approval","deprecated":null,"version":null,"sidebarTitle":"Create approval revalidation","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/bundles/{id}/approvals/{approvalId}/revalidation","href":"/api-reference/governance-bundles/create-revalidation-config-for-an-approval"},{"title":"Delete revalidation config from an approval","deprecated":null,"version":null,"sidebarTitle":"Delete approval revalidation","openapi":"/api-specs/cloud/public-api.json delete /api/governance/v1/bundles/{id}/approvals/{approvalId}/revalidation","href":"/api-reference/governance-bundles/delete-revalidation-config-from-an-approval"},{"title":"Update revalidation config for an approval","deprecated":null,"version":null,"sidebarTitle":"Update approval revalidation","openapi":"/api-specs/cloud/public-api.json patch /api/governance/v1/bundles/{id}/approvals/{approvalId}/revalidation","href":"/api-reference/governance-bundles/update-revalidation-config-for-an-approval"},{"title":"Archive all monitored models for a bundle","deprecated":null,"version":null,"sidebarTitle":"Archive bundle monitored models","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/bundles/{id}/archive-endpoints","href":"/api-reference/governance-bundles/archive-all-monitored-models-for-a-bundle"},{"title":"Attach a Domino object to a bundle","deprecated":null,"version":null,"sidebarTitle":"Attach object to bundle","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/bundles/{id}/attachments","href":"/api-reference/governance-bundles/attach-a-domino-object-to-a-bundle"},{"title":"Delete attachment","deprecated":true,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/governance/v1/bundles/{id}/attachments/{attachmentID}","href":"/api-reference/governance-bundles/delete-attachment"},{"title":"Get bundle gates","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/bundles/{id}/gates","href":"/api-reference/governance-bundles/get-bundle-gates"},{"title":"Set monitored model as governed","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/bundles/{id}/register-endpoint","href":"/api-reference/governance-bundles/set-monitored-model-as-governed"},{"title":"Download a PDF report for a bundle","deprecated":null,"version":null,"sidebarTitle":"Download bundle PDF report","openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/bundles/{id}/report","href":"/api-reference/governance-bundles/download-a-pdf-report-for-a-bundle"},{"title":"Update bundle stage by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/governance/v1/bundles/{id}/stages/{stageID}","href":"/api-reference/governance-bundles/update-bundle-stage-by-id"},{"title":"Update monitored model entry","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/governance/v1/bundles/{id}/update-endpoint/{endpointID}","href":"/api-reference/governance-bundles/update-monitored-model-entry"},{"title":"Add a policy to govern a bundle","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/add-policies-to-bundle","href":"/api-reference/governance-bundles/add-a-policy-to-govern-a-bundle"},{"title":"Bulk add attachments to bundles","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/bulk-add-attachments","href":"/api-reference/governance-bundles/bulk-add-attachments-to-bundles"},{"title":"Delete an attachment along with its drafts and results","deprecated":null,"version":null,"sidebarTitle":"Delete attachment and results","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/delete-attachment-and-results","href":"/api-reference/governance-bundles/delete-an-attachment-along-with-its-drafts-and-results"},{"title":"Replace a bundle's primary policy with a different policy","deprecated":null,"version":null,"sidebarTitle":"Replace bundle primary policy","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/replace-bundle-primary-policy","href":"/api-reference/governance-bundles/replace-a-bundles-primary-policy-with-a-different-policy"},{"title":"Update approval by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/update-approval","href":"/api-reference/governance-bundles/update-approval-by-id"},{"title":"Update the policy of a bundle","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/governance/v1/rpc/update-bundle-policy","href":"/api-reference/governance-bundles/update-the-policy-of-a-bundle"},{"title":"Replace a policy version in a bundle","deprecated":null,"version":null,"sidebarTitle":"Replace bundle policy version","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/upgrade-bundle-policy","href":"/api-reference/governance-bundles/replace-a-policy-version-in-a-bundle"}]},{"group":"Governance policies","pages":[{"title":"Create or update a policy","deprecated":true,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/governance/v1/policies","href":"/api-reference/governance-policies/create-or-update-a-policy"},{"title":"Create a policy","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/policies","href":"/api-reference/governance-policies/create-a-policy"},{"title":"Get a policy's full structure, including evidence and the content shape each artifact expects","deprecated":null,"version":null,"sidebarTitle":"Get policy structure","openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/policies/{id}","href":"/api-reference/governance-policies/get-a-policys-full-structure-including-evidence-and-the-content-shape-each-artifact-expects"},{"title":"Update the policy meta by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/governance/v1/policies/{id}","href":"/api-reference/governance-policies/update-the-policy-meta-by-id"},{"title":"Delete policy by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/governance/v1/policies/{id}","href":"/api-reference/governance-policies/delete-policy-by-id"},{"title":"Get the policy definition YAML by ID","deprecated":null,"version":null,"sidebarTitle":"Get policy definition YAML","openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/policies/{id}/definition","href":"/api-reference/governance-policies/get-the-policy-definition-yaml-by-id"},{"title":"Create or update a policy definition through yaml","deprecated":null,"version":null,"sidebarTitle":"Create or update policy YAML","openapi":"/api-specs/cloud/public-api.json put /api/governance/v1/policies/{id}/definition","href":"/api-reference/governance-policies/create-or-update-a-policy-definition-through-yaml"},{"title":"Publish, draft, or archive a policy","deprecated":null,"version":null,"sidebarTitle":"Update policy status","openapi":"/api-specs/cloud/public-api.json put /api/governance/v1/policies/{id}/status","href":"/api-reference/governance-policies/publish-draft-or-archive-a-policy"},{"title":"List Policy Versions","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/policies/{id}/versions","href":"/api-reference/governance-policies/list-policy-versions"},{"title":"Create a policy version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/policies/{id}/versions","href":"/api-reference/governance-policies/create-a-policy-version"},{"title":"List policy enforcers","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/policy-enforcers","href":"/api-reference/governance-policies/list-policy-enforcers"},{"title":"Create a policy enforcer","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/policy-enforcers","href":"/api-reference/governance-policies/create-a-policy-enforcer"},{"title":"Update a policy enforcer","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /api/governance/v1/policy-enforcers/{id}","href":"/api-reference/governance-policies/update-a-policy-enforcer"},{"title":"List policy overviews","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/policy-overviews","href":"/api-reference/governance-policies/list-policy-overviews"},{"title":"Get the policy version by version tag","deprecated":null,"version":null,"sidebarTitle":"Get policy version","openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/policy-versions/{id}","href":"/api-reference/governance-policies/get-the-policy-version-by-version-tag"},{"title":"Get the policy version definition by version tag","deprecated":null,"version":null,"sidebarTitle":"Get policy version definition","openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/policy-versions/{id}/definition","href":"/api-reference/governance-policies/get-the-policy-version-definition-by-version-tag"},{"title":"Create or update a policy version definition through yaml","deprecated":null,"version":null,"sidebarTitle":"Create or update version YAML","openapi":"/api-specs/cloud/public-api.json put /api/governance/v1/policy-versions/{id}/definition","href":"/api-reference/governance-policies/create-or-update-a-policy-version-definition-through-yaml"},{"title":"Diff two policy versions","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/policy-versions/{id}/diff/{targetId}","href":"/api-reference/governance-policies/diff-two-policy-versions"},{"title":"Draft a policy version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/draft-latest-published-policy-version","href":"/api-reference/governance-policies/draft-a-policy-version"},{"title":"Publish a policy version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/publish-policy-version","href":"/api-reference/governance-policies/publish-a-policy-version"}]},{"group":"Governance evidence and results","pages":[{"title":"List Findings","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/bundles/{id}/findings","href":"/api-reference/governance-evidence-and-results/list-findings"},{"title":"List evidence template paginated","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/evidence-templates","href":"/api-reference/governance-evidence-and-results/list-evidence-template-paginated"},{"title":"Get evidence template by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/evidence-templates/{id}","href":"/api-reference/governance-evidence-and-results/get-evidence-template-by-id"},{"title":"Upsert evidence template","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/governance/v1/evidence-templates/{id}","href":"/api-reference/governance-evidence-and-results/upsert-evidence-template"},{"title":"Delete evidence template by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/governance/v1/evidence-templates/{id}","href":"/api-reference/governance-evidence-and-results/delete-evidence-template-by-id"},{"title":"Get evidence template definition YAML by ID","deprecated":null,"version":null,"sidebarTitle":"Get evidence template YAML","openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/evidence-templates/{id}/definition","href":"/api-reference/governance-evidence-and-results/get-evidence-template-definition-yaml-by-id"},{"title":"Update evidence template definition by ID","deprecated":null,"version":null,"sidebarTitle":"Update evidence template YAML","openapi":"/api-specs/cloud/public-api.json put /api/governance/v1/evidence-templates/{id}/definition","href":"/api-reference/governance-evidence-and-results/update-evidence-template-definition-by-id"},{"title":"Update evidence template status by ID","deprecated":null,"version":null,"sidebarTitle":"Update evidence template status","openapi":"/api-specs/cloud/public-api.json put /api/governance/v1/evidence-templates/{id}/status","href":"/api-reference/governance-evidence-and-results/update-evidence-template-status-by-id"},{"title":"Create new finding","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/findings","href":"/api-reference/governance-evidence-and-results/create-new-finding"},{"title":"Get finding by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/findings/{id}","href":"/api-reference/governance-evidence-and-results/get-finding-by-id"},{"title":"Update the finding by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/governance/v1/findings/{id}","href":"/api-reference/governance-evidence-and-results/update-the-finding-by-id"},{"title":"List results","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/results","href":"/api-reference/governance-evidence-and-results/list-results"},{"title":"Submit a final result for an artifact (does not recompute classification)","deprecated":null,"version":null,"sidebarTitle":"Submit final result","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/results","href":"/api-reference/governance-evidence-and-results/submit-a-final-result-for-an-artifact-does-not-recompute-classification"},{"title":"Read back the latest submitted result(s) for a bundle","deprecated":null,"version":null,"sidebarTitle":"Get latest submitted results","openapi":"/api-specs/cloud/public-api.json get /api/governance/v1/results/latest","href":"/api-reference/governance-evidence-and-results/read-back-the-latest-submitted-results-for-a-bundle"},{"title":"Bulk update finding severity or due date","deprecated":null,"version":null,"sidebarTitle":"Bulk update findings","openapi":"/api-specs/cloud/public-api.json put /api/governance/v1/rpc/bulk-edit-findings","href":"/api-reference/governance-evidence-and-results/bulk-update-finding-severity-or-due-date"}]},{"group":"Governance operations","pages":[{"title":"[BETA] Analyze model monitor metrics","deprecated":null,"version":null,"sidebarTitle":"Analyze monitor metrics (beta)","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/analyze-monitor-model","href":"/api-reference/governance-operations/[beta]-analyze-model-monitor-metrics"},{"title":"Attach each App's mandatory policies to its governed bundle","deprecated":null,"version":null,"sidebarTitle":"Attach App enforced policies","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/attach-app-enforced-policies","href":"/api-reference/governance-operations/attach-each-apps-mandatory-policies-to-its-governed-bundle"},{"title":"Clone a bundle into a new, standalone bundle","deprecated":null,"version":null,"sidebarTitle":"Clone bundle","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/clone-bundle","href":"/api-reference/governance-operations/clone-a-bundle-into-a-new-standalone-bundle"},{"title":"Get a bundle's evidence, results, and approval progress against one of its applied policies","deprecated":null,"version":null,"sidebarTitle":"Compute bundle policy progress","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/compute-policy","href":"/api-reference/governance-operations/get-a-bundles-evidence-results-and-approval-progress-against-one-of-its-applied-policies"},{"title":"Copy the transferable results from one bundle to another","deprecated":null,"version":null,"sidebarTitle":"Copy bundle results","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/copy-bundle","href":"/api-reference/governance-operations/copy-the-transferable-results-from-one-bundle-to-another"},{"title":"Diff policies between two bundles","description":"Compare the policies of two bundles, returning structural diffs and optionally evidence result diffs","deprecated":null,"version":null,"sidebarTitle":"Diff bundle policies","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/diff-bundle-policies","href":"/api-reference/governance-operations/diff-policies-between-two-bundles"},{"title":"Transition an approval to its next status (approve, reject, submit, cancel)","deprecated":null,"version":null,"sidebarTitle":"Transition approval status","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/publish-approval-event","href":"/api-reference/governance-operations/transition-an-approval-to-its-next-status-approve-reject-submit-cancel"},{"title":"Reset bundle results, drafts, approvals, stage assignees, and optionally detach attachments","description":"Resets all results, drafts, approvals, stage assignees, and stage/classification for the specified policy versions within a bundle. Optionally detach specified attachments. Accepts reason and relatedFindingId for audit purposes.","deprecated":null,"version":null,"sidebarTitle":"Reset bundle","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/reset-bundle","href":"/api-reference/governance-operations/reset-bundle-results-drafts-approvals-stage-assignees-and-optionally-detach-attachments"},{"title":"Snapshot a bundle into an evidence-restricted copy and revoke the source's gated approvals","deprecated":null,"version":null,"sidebarTitle":"Snapshot bundle","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/snapshot-bundle","href":"/api-reference/governance-operations/snapshot-a-bundle-into-an-evidence-restricted-copy-and-revoke-the-sources-gated-approvals"},{"title":"Submit final evidence for one artifact and get the bundle's updated state","deprecated":null,"version":null,"sidebarTitle":"Submit result to policy","openapi":"/api-specs/cloud/public-api.json post /api/governance/v1/rpc/submit-result-to-policy","href":"/api-reference/governance-operations/submit-final-evidence-for-one-artifact-and-get-the-bundles-updated-state"}]},{"group":"NetApp Volumes","pages":[{"title":"Get if user has all provided volume permissions","deprecated":null,"version":null,"sidebarTitle":"Check volume permissions","openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/account/authz/permissions/volume/:id","href":"/api-reference/netapp-volumes/get-if-user-has-all-provided-volume-permissions"},{"title":"Attach volume to project","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/attach-volume-to-project","href":"/api-reference/netapp-volumes/attach-volume-to-project"},{"title":"Bulk attaches volumes to target project and allows for authorized user impersonation","deprecated":null,"version":null,"sidebarTitle":"Bulk attach volumes to Project","openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/bulk-attach-volumes-to-project","href":"/api-reference/netapp-volumes/bulk-attaches-volumes-to-target-project-and-allows-for-authorized-user-impersonation"},{"title":"Bulk copies volumes and contents to target project and allows for authorized user impersonation","deprecated":null,"version":null,"sidebarTitle":"Bulk copy volumes to Project","openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/bulk-copy-volumes-to-project","href":"/api-reference/netapp-volumes/bulk-copies-volumes-and-contents-to-target-project-and-allows-for-authorized-user-impersonation"},{"title":"Check whether requesting user is over allowed volume limit","deprecated":null,"version":null,"sidebarTitle":"Check volume limit","openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/check-is-over-limit","href":"/api-reference/netapp-volumes/check-whether-requesting-user-is-over-allowed-volume-limit"},{"title":"Delete volume by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/delete-volume","href":"/api-reference/netapp-volumes/delete-volume-by-id"},{"title":"Detach volume from project","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/detach-volume-from-project","href":"/api-reference/netapp-volumes/detach-volume-from-project"},{"title":"Get volume mounts by project ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/get-volume-mounts","href":"/api-reference/netapp-volumes/get-volume-mounts-by-project-id"},{"title":"Mark volume for deletion","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/mark-volume-for-deletion","href":"/api-reference/netapp-volumes/mark-volume-for-deletion"},{"title":"Restore volume to active state","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/restore-volume","href":"/api-reference/netapp-volumes/restore-volume-to-active-state"},{"title":"Get domino staging volume name","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/staging-volume","href":"/api-reference/netapp-volumes/get-domino-staging-volume-name"},{"title":"List volumes","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/volumes","href":"/api-reference/netapp-volumes/list-volumes"},{"title":"Create new volume","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/volumes","href":"/api-reference/netapp-volumes/create-new-volume"},{"title":"List accessible volume IDs","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/volumes/ids","href":"/api-reference/netapp-volumes/list-accessible-volume-ids"},{"title":"Get a volume by unique name","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/volumes/unique-name/{uniqueName}","href":"/api-reference/netapp-volumes/get-a-volume-by-unique-name"},{"title":"Get volume by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/volumes/{id}","href":"/api-reference/netapp-volumes/get-volume-by-id"},{"title":"Update Volume","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json patch /remotefs/v1/volumes/{id}","href":"/api-reference/netapp-volumes/update-volume"},{"title":"Get the connection snippets for a given volume to access as a datasource","deprecated":null,"version":null,"sidebarTitle":"Get volume connection snippets","openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/volumes/{id}/connection-snippets","href":"/api-reference/netapp-volumes/get-the-connection-snippets-for-a-given-volume-to-access-as-a-datasource"},{"title":"Get grants by Volume ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/volumes/{id}/grants","href":"/api-reference/netapp-volumes/get-grants-by-volume-id"},{"title":"Update grants by Volume ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /remotefs/v1/volumes/{id}/grants","href":"/api-reference/netapp-volumes/update-grants-by-volume-id"},{"title":"Download volume archive file from Domino to local","deprecated":null,"version":null,"sidebarTitle":"Download volume archive","openapi":"/api-specs/cloud/public-api.json post /webvfs/remotefs/v1/rpc/download-archive","href":"/api-reference/netapp-volumes/download-volume-archive-file-from-domino-to-local"},{"title":"Get volume snapshot file raw content at subpath for previewing with truncation","deprecated":null,"version":null,"sidebarTitle":"Preview snapshot file","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/snapshots/{id}/files/preview/{path}","href":"/api-reference/netapp-volumes/get-volume-snapshot-file-raw-content-at-subpath-for-previewing-with-truncation"},{"title":"Get file names in a volume","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/files","href":"/api-reference/netapp-volumes/get-file-names-in-a-volume"},{"title":"Deletes files from a volume","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /webvfs/remotefs/v1/volumes/{id}/files","href":"/api-reference/netapp-volumes/deletes-files-from-a-volume"},{"title":"Attempts to rename volume file or directory","deprecated":null,"version":null,"sidebarTitle":"Rename volume file","openapi":"/api-specs/cloud/public-api.json patch /webvfs/remotefs/v1/volumes/{id}/files","href":"/api-reference/netapp-volumes/attempts-to-rename-volume-file-or-directory"},{"title":"Check if a file(s) already exist in a Volume","deprecated":null,"version":null,"sidebarTitle":"Check for file collisions","openapi":"/api-specs/cloud/public-api.json post /webvfs/remotefs/v1/volumes/{id}/files/check-collision","href":"/api-reference/netapp-volumes/check-if-a-files-already-exist-in-a-volume"},{"title":"Get volume file metadata content at specified path","deprecated":null,"version":null,"sidebarTitle":"Get volume file metadata","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/files/metadata","href":"/api-reference/netapp-volumes/get-volume-file-metadata-content-at-specified-path"},{"title":"Get volume file raw content at subpath for previewing with truncation","deprecated":null,"version":null,"sidebarTitle":"Preview volume file","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/files/preview/{path}","href":"/api-reference/netapp-volumes/get-volume-file-raw-content-at-subpath-for-previewing-with-truncation"},{"title":"Get non-directory volume file raw content at specified path","deprecated":null,"version":null,"sidebarTitle":"Get volume file content","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/files/raw","href":"/api-reference/netapp-volumes/get-non-directory-volume-file-raw-content-at-specified-path"},{"title":"Get volume file raw content at subpath","deprecated":null,"version":null,"sidebarTitle":"Get volume file at path","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/files/raw/{path}","href":"/api-reference/netapp-volumes/get-volume-file-raw-content-at-subpath"},{"title":"Get file names in a volume recursively","deprecated":null,"version":null,"sidebarTitle":"List volume files recursively","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/files/recursive","href":"/api-reference/netapp-volumes/get-file-names-in-a-volume-recursively"},{"title":"Get volume object URL","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/key-urls/{key}","href":"/api-reference/netapp-volumes/get-volume-object-url"},{"title":"List keys in a volume","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/keys","href":"/api-reference/netapp-volumes/list-keys-in-a-volume"},{"title":"Retrieves the content of a key in a volume","deprecated":null,"version":null,"sidebarTitle":"Get volume key content","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/keys/{key}","href":"/api-reference/netapp-volumes/retrieves-the-content-of-a-key-in-a-volume"},{"title":"Write content to a specified volume key","deprecated":null,"version":null,"sidebarTitle":"Write volume key content","openapi":"/api-specs/cloud/public-api.json put /webvfs/remotefs/v1/volumes/{id}/keys/{key}","href":"/api-reference/netapp-volumes/write-content-to-a-specified-volume-key"},{"title":"Upload one resumable chunk to a NetApp volume","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /webvfs/remotefs/v1/volumes/{id}/uploads","href":"/api-reference/netapp-volumes/upload-one-resumable-chunk-to-a-netapp-volume"},{"title":"Start process to upload a file(s) to a Volume","deprecated":null,"version":null,"sidebarTitle":"Start volume upload","openapi":"/api-specs/cloud/public-api.json post /webvfs/remotefs/v1/volumes/{id}/uploads/start","href":"/api-reference/netapp-volumes/start-process-to-upload-a-files-to-a-volume"},{"title":"Returns whether this upload chunk has already been sent","deprecated":null,"version":null,"sidebarTitle":"Check upload chunk status","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/uploads/status","href":"/api-reference/netapp-volumes/returns-whether-this-upload-chunk-has-already-been-sent"},{"title":"Cancels the upload process to a volume","deprecated":null,"version":null,"sidebarTitle":"Cancel volume upload","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/uploads/{uploadID}","href":"/api-reference/netapp-volumes/cancels-the-upload-process-to-a-volume"},{"title":"Completes the volume file upload session","deprecated":null,"version":null,"sidebarTitle":"Complete volume upload","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/uploads/{uploadID}/complete","href":"/api-reference/netapp-volumes/completes-the-volume-file-upload-session"}]},{"group":"NetApp Volumes snapshots","pages":[{"title":"Create new snapshot from a run","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/create-snapshot-from-run","href":"/api-reference/netapp-volumes-snapshots/create-new-snapshot-from-a-run"},{"title":"Delete snapshot by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/delete-snapshot","href":"/api-reference/netapp-volumes-snapshots/delete-snapshot-by-id"},{"title":"Restore snapshot to active state","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/rpc/restore-snapshot","href":"/api-reference/netapp-volumes-snapshots/restore-snapshot-to-active-state"},{"title":"List snapshots","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/snapshots","href":"/api-reference/netapp-volumes-snapshots/list-snapshots"},{"title":"Create new snapshot","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/snapshots","href":"/api-reference/netapp-volumes-snapshots/create-new-snapshot"},{"title":"Get snapshot by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/snapshots/{id}","href":"/api-reference/netapp-volumes-snapshots/get-snapshot-by-id"},{"title":"Update Snapshot by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /remotefs/v1/snapshots/{id}","href":"/api-reference/netapp-volumes-snapshots/update-snapshot-by-id"},{"title":"Add snapshot tag","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/snapshots/{id}/tags","href":"/api-reference/netapp-volumes-snapshots/add-snapshot-tag"},{"title":"Delete snapshot tag","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /remotefs/v1/snapshots/{id}/tags/{name}","href":"/api-reference/netapp-volumes-snapshots/delete-snapshot-tag"},{"title":"Get snapshot by volume ID and snapshot version","deprecated":null,"version":null,"sidebarTitle":"Get snapshot by version","openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/volumes/{id}/snapshots/{version}","href":"/api-reference/netapp-volumes-snapshots/get-snapshot-by-volume-id-and-snapshot-version"},{"title":"Get file names in a volume snapshot","deprecated":null,"version":null,"sidebarTitle":"List snapshot files","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/snapshots/{id}/files","href":"/api-reference/netapp-volumes-snapshots/get-file-names-in-a-volume-snapshot"},{"title":"Get volume snapshot file metadata content at specified path","deprecated":null,"version":null,"sidebarTitle":"Get snapshot file metadata","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/snapshots/{id}/files/metadata","href":"/api-reference/netapp-volumes-snapshots/get-volume-snapshot-file-metadata-content-at-specified-path"},{"title":"Get non-directory volume snapshot file raw content at specified path","deprecated":null,"version":null,"sidebarTitle":"Get snapshot file content","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/snapshots/{id}/files/raw","href":"/api-reference/netapp-volumes-snapshots/get-non-directory-volume-snapshot-file-raw-content-at-specified-path"},{"title":"Get volume snapshot file raw content at subpath","deprecated":null,"version":null,"sidebarTitle":"Get snapshot file at path","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/snapshots/{id}/files/raw/{path}","href":"/api-reference/netapp-volumes-snapshots/get-volume-snapshot-file-raw-content-at-subpath"},{"title":"Get file names in a snapshot recursively","deprecated":null,"version":null,"sidebarTitle":"List snapshot files recursively","openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/snapshots/{id}/files/recursive","href":"/api-reference/netapp-volumes-snapshots/get-file-names-in-a-snapshot-recursively"},{"title":"Get volume snapshot object URL","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/snapshots/{version}/key-urls/{key}","href":"/api-reference/netapp-volumes-snapshots/get-volume-snapshot-object-url"},{"title":"List keys in a volume snapshot","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/snapshots/{version}/keys","href":"/api-reference/netapp-volumes-snapshots/list-keys-in-a-volume-snapshot"},{"title":"Get volume snapshot object","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /webvfs/remotefs/v1/volumes/{id}/snapshots/{version}/keys/{key}","href":"/api-reference/netapp-volumes-snapshots/get-volume-snapshot-object"}]},{"group":"NetApp Volumes filesystems","pages":[{"title":"List filesystem","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/filesystems","href":"/api-reference/netapp-volumes-filesystems/list-filesystem"},{"title":"Create new filesystem","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/filesystems","href":"/api-reference/netapp-volumes-filesystems/create-new-filesystem"},{"title":"Get filesystem by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/filesystems/{id}","href":"/api-reference/netapp-volumes-filesystems/get-filesystem-by-id"},{"title":"Update filesystem","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /remotefs/v1/filesystems/{id}","href":"/api-reference/netapp-volumes-filesystems/update-filesystem"},{"title":"Delete filesystem by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /remotefs/v1/filesystems/{id}","href":"/api-reference/netapp-volumes-filesystems/delete-filesystem-by-id"},{"title":"List available PVCs in the domino-compute namespace with the netapp-storage label","deprecated":null,"version":null,"sidebarTitle":"List NetApp root PVCs","openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/root-pvcs","href":"/api-reference/netapp-volumes-filesystems/list-available-pvcs-in-the-domino-compute-namespace-with-the-netapp-storage-label"}]},{"group":"NetApp Volumes transfers","pages":[{"title":"Gets all permissions for requesting user","deprecated":null,"version":null,"sidebarTitle":"List user permissions","openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/account/authz/permissions/authorizedactions","href":"/api-reference/netapp-volumes-transfers/gets-all-permissions-for-requesting-user"},{"title":"List data transfers","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/data-transfers","href":"/api-reference/netapp-volumes-transfers/list-data-transfers"},{"title":"Create new data transfer","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/data-transfers","href":"/api-reference/netapp-volumes-transfers/create-new-data-transfer"},{"title":"Get data transfer by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/data-transfers/{id}","href":"/api-reference/netapp-volumes-transfers/get-data-transfer-by-id"},{"title":"Callback for data transfer from filetask","deprecated":null,"version":null,"sidebarTitle":"Data transfer callback","openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/data-transfers/{id}/callback","href":"/api-reference/netapp-volumes-transfers/callback-for-data-transfer-from-filetask"},{"title":"Create download archive","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /remotefs/v1/downloads","href":"/api-reference/netapp-volumes-transfers/create-download-archive"},{"title":"Get download task status","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/downloads/{id}","href":"/api-reference/netapp-volumes-transfers/get-download-task-status"},{"title":"Get import blobs task update","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /remotefs/v1/tasks/import-blobs/{key}/update","href":"/api-reference/netapp-volumes-transfers/get-import-blobs-task-update"}]},{"group":"Tags","pages":[{"title":"Get configuration limits","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/config","href":"/api-reference/tags/get-configuration-limits"},{"title":"Get entities by multiple tags","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/entities","href":"/api-reference/tags/get-entities-by-multiple-tags"},{"title":"Get tags for multiple entities","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/entity-tags","href":"/api-reference/tags/get-tags-for-multiple-entities"},{"title":"Delete all tags for an entity","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/taxonomy/v1/entity-tags","href":"/api-reference/tags/delete-all-tags-for-an-entity"},{"title":"List namespaces","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/namespaces","href":"/api-reference/tags/list-namespaces"},{"title":"Create a new namespace","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/namespaces","href":"/api-reference/tags/create-a-new-namespace"},{"title":"Bulk delete namespaces","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/namespaces/bulk-delete","href":"/api-reference/tags/bulk-delete-namespaces"},{"title":"Get a namespace by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/namespaces/{namespaceId}","href":"/api-reference/tags/get-a-namespace-by-id"},{"title":"Update a namespace","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/taxonomy/v1/namespaces/{namespaceId}","href":"/api-reference/tags/update-a-namespace"},{"title":"Delete a namespace","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/taxonomy/v1/namespaces/{namespaceId}","href":"/api-reference/tags/delete-a-namespace"},{"title":"Copy all tags from one entity to another","deprecated":null,"version":null,"sidebarTitle":"Copy entity tags","openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/rpc/copy-entity-tags","href":"/api-reference/tags/copy-all-tags-from-one-entity-to-another"},{"title":"Export taxonomy to file","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/rpc/export-to-file","href":"/api-reference/tags/export-taxonomy-to-file"},{"title":"Import from file","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/rpc/import-from-file","href":"/api-reference/tags/import-from-file"},{"title":"Merge tags","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/rpc/merge-tags","href":"/api-reference/tags/merge-tags"},{"title":"Tag an entity","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/rpc/tag-entity","href":"/api-reference/tags/tag-an-entity"},{"title":"Untag an entity","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/rpc/untag-entity","href":"/api-reference/tags/untag-an-entity"},{"title":"Validate import file","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/rpc/validate-file","href":"/api-reference/tags/validate-import-file"},{"title":"List tags","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a new tag","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/tags","href":"/api-reference/tags/create-a-new-tag"},{"title":"Autocomplete tags","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/tags/autocomplete","href":"/api-reference/tags/autocomplete-tags"},{"title":"Bulk delete tags","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/tags/bulk-delete","href":"/api-reference/tags/bulk-delete-tags"},{"title":"Get a tag by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/tags/{tagId}","href":"/api-reference/tags/get-a-tag-by-id"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/taxonomy/v1/tags/{tagId}","href":"/api-reference/tags/update-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/taxonomy/v1/tags/{tagId}","href":"/api-reference/tags/delete-a-tag"},{"title":"Get entities by tag","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/tags/{tagId}/entities","href":"/api-reference/tags/get-entities-by-tag"},{"title":"Get full taxonomy tree","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/taxonomy","href":"/api-reference/tags/get-full-taxonomy-tree"}]},{"group":"Properties","pages":[{"title":"List properties","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/properties","href":"/api-reference/properties/list-properties"},{"title":"Create a new property","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/properties","href":"/api-reference/properties/create-a-new-property"},{"title":"Get a property by ID","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/properties/{propertyId}","href":"/api-reference/properties/get-a-property-by-id"},{"title":"Update a property","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json put /api/taxonomy/v1/properties/{propertyId}","href":"/api-reference/properties/update-a-property"},{"title":"Delete a property","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json delete /api/taxonomy/v1/properties/{propertyId}","href":"/api-reference/properties/delete-a-property"},{"title":"List property groups","deprecated":null,"version":null,"openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/property-groups","href":"/api-reference/properties/list-property-groups"},{"title":"Get property values for an entity","deprecated":null,"version":null,"sidebarTitle":"Get entity property values","openapi":"/api-specs/cloud/public-api.json get /api/taxonomy/v1/property-values/{entityType}/{entityId}","href":"/api-reference/properties/get-property-values-for-an-entity"},{"title":"Clear all property values for an entity","deprecated":null,"version":null,"sidebarTitle":"Clear entity property values","openapi":"/api-specs/cloud/public-api.json delete /api/taxonomy/v1/property-values/{entityType}/{entityId}","href":"/api-reference/properties/clear-all-property-values-for-an-entity"},{"title":"Set or clear property values for an entity","deprecated":null,"version":null,"sidebarTitle":"Set entity property values","openapi":"/api-specs/cloud/public-api.json patch /api/taxonomy/v1/property-values/{entityType}/{entityId}","href":"/api-reference/properties/set-or-clear-property-values-for-an-entity"},{"title":"Copy all property values from one entity to another","deprecated":null,"version":null,"sidebarTitle":"Copy property values","openapi":"/api-specs/cloud/public-api.json post /api/taxonomy/v1/rpc/copy-property-values","href":"/api-reference/properties/copy-all-property-values-from-one-entity-to-another"}]}]},{"group":"Domino Data API","root":{"title":"Domino Data API","href":"/cloud/reference/api/data_api/index"},"pages":[{"title":"Install the Data API","href":"/cloud/reference/api/data_api/install_the_data_api"},{"title":"Authentication","href":"/cloud/reference/api/data_api/authentication"},{"group":"Data Source use cases","root":{"title":"Data Source use cases","href":"/cloud/reference/api/data_api/datasource_usecases/index"},"pages":[{"title":"Access Datasets via Datasource proxy","href":"/cloud/reference/api/data_api/datasource_usecases/access-datasets-via-proxy"},{"title":"Query a tabular store","href":"/cloud/reference/api/data_api/datasource_usecases/simple_query"},{"title":"Read/Write to an object store","href":"/cloud/reference/api/data_api/datasource_usecases/object_store"},{"title":"Write to a local file","href":"/cloud/reference/api/data_api/datasource_usecases/write_to_file"},{"title":"Custom authentication","href":"/cloud/reference/api/data_api/datasource_usecases/custom_auth"},{"title":"Configuration override","href":"/cloud/reference/api/data_api/datasource_usecases/config_override"}]},{"group":"TrainingSets use cases","root":{"title":"TrainingSets use cases","href":"/cloud/reference/api/data_api/trainingsets_usecases/index"},"pages":[{"title":"Create TrainingSets","href":"/cloud/reference/api/data_api/trainingsets_usecases/create_trainingset"},{"title":"Retrieve TrainingSets","href":"/cloud/reference/api/data_api/trainingsets_usecases/get_trainingset"},{"title":"Update TrainingSet","href":"/cloud/reference/api/data_api/trainingsets_usecases/update_trainingset"},{"title":"Delete TrainingSets","href":"/cloud/reference/api/data_api/trainingsets_usecases/delete_trainingset"},{"title":"Custom authentication","href":"/cloud/reference/api/data_api/trainingsets_usecases/custom-auth"}]}]},{"group":"Model Monitoring API","root":{"title":"Model Monitoring API","href":"/cloud/reference/api/model_monitoring/index"},"pages":[{"title":"Model Monitoring API reference","href":"/cloud/reference/api/model_monitoring/dmm-api"},{"title":"Model Monitoring custom metrics Python SDK","sidebarTitle":"Model Monitoring custom metrics SDK","href":"/cloud/reference/api/model_monitoring/custom-metrics"}]},{"title":"Domino NetApp Volumes API","href":"/cloud/reference/api/domino-volumes-api"},{"group":"Workspace File Audit Trail API","root":{"title":"Workspace File Audit Trail API","href":"/cloud/reference/api/workspace-file-audit-trail-api"},"pages":[{"group":"Events","pages":[{"title":"Get event download URLs","deprecated":null,"version":null,"openapi":"/api-specs/cloud/workspace-file-audit-trail-api.json get /events/download-urls","href":"/api-reference/events/get-event-download-urls"},{"title":"Process workspace audit events","deprecated":null,"version":null,"openapi":"/api-specs/cloud/workspace-file-audit-trail-api.json put /process","href":"/api-reference/events/process-workspace-audit-events"},{"title":"Get processing status","deprecated":null,"version":null,"openapi":"/api-specs/cloud/workspace-file-audit-trail-api.json get /process/latest","href":"/api-reference/events/get-processing-status"},{"title":"Get processing status","deprecated":null,"version":null,"openapi":"/api-specs/cloud/workspace-file-audit-trail-api.json get /process/{id}","href":"/api-reference/events/get-processing-status-1"}]}]},{"title":"Flyte API","href":"/cloud/reference/api/flyte/index"},{"group":"Flyte native API","root":{"title":"Flyte native API","href":"/cloud/reference/api/flyte/flyte-native-api"},"pages":[{"group":"Launch plans","pages":[{"title":"Fetch the active version of a LaunchPlan.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/active_launch_plans/{id.project}/{id.domain}/{id.name}","href":"/api-reference/launch-plans/fetch-the-active-version-of-a-launchplan"},{"title":"List active versions of LaunchPlan.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/active_launch_plans/{project}/{domain}","href":"/api-reference/launch-plans/list-active-versions-of-launchplan"},{"title":"Fetch a list of NamedEntityIdentifier of launch plan objects.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/launch_plan_ids/{project}/{domain}","href":"/api-reference/launch-plans/fetch-a-list-of-namedentityidentifier-of-launch-plan-objects"},{"title":"Create and upload a LaunchPlan definition","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json post /api/v1/launch_plans","href":"/api-reference/launch-plans/create-and-upload-a-launchplan-definition"},{"title":"Fetch a list of LaunchPlan definitions.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/launch_plans/{id.project}/{id.domain}","href":"/api-reference/launch-plans/fetch-a-list-of-launchplan-definitions"},{"title":"Fetch a list of LaunchPlan definitions (by name)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/launch_plans/{id.project}/{id.domain}/{id.name}","href":"/api-reference/launch-plans/fetch-a-list-of-launchplan-definitions-by-name"},{"title":"Fetch a LaunchPlan definition.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}","href":"/api-reference/launch-plans/fetch-a-launchplan-definition"},{"title":"Updates the status of a registered LaunchPlan.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json put /api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}","href":"/api-reference/launch-plans/updates-the-status-of-a-registered-launchplan"}]},{"group":"Children","pages":[{"title":"Fetch a list of NodeExecution launched by the reference TaskExecution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/children/task_executions/{task_execution_id.node_execution_id.execution_id.project}/{task_execution_id.node_execution_id.execution_id.domain}/{task_execution_id.node_execution_id.execution_id.name}/{task_execution_id.node_execution_id.node_id}/{task_execution_id.task_id.project}/{task_execution_id.task_id.domain}/{task_execution_id.task_id.name}/{task_execution_id.task_id.version}/{task_execution_id.retry_attempt}","href":"/api-reference/children/fetch-a-list-of-nodeexecution-launched-by-the-reference-taskexecution"}]},{"group":"Data","pages":[{"title":"Fetches input and output data for a Execution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/data/executions/{id.project}/{id.domain}/{id.name}","href":"/api-reference/data/fetches-input-and-output-data-for-a-execution"},{"title":"Fetches input and output data for a NodeExecution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/data/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}","href":"/api-reference/data/fetches-input-and-output-data-for-a-nodeexecution"},{"title":"Fetches input and output data for a TaskExecution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/data/task_executions/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt}","href":"/api-reference/data/fetches-input-and-output-data-for-a-taskexecution"}]},{"group":"Description entities","pages":[{"title":"Fetch a DescriptionEntity object.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/description_entities/{id.resource_type}/{id.project}/{id.domain}/{id.name}/{id.version}","href":"/api-reference/description-entities/fetch-a-descriptionentity-object"},{"title":"Fetch a list of DescriptionEntity definitions.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/description_entities/{resource_type}/{id.project}/{id.domain}","href":"/api-reference/description-entities/fetch-a-list-of-descriptionentity-definitions"},{"title":"Fetch a list of DescriptionEntity definitions (by name)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/description_entities/{resource_type}/{id.project}/{id.domain}/{id.name}","href":"/api-reference/description-entities/fetch-a-list-of-descriptionentity-definitions-by-name"}]},{"group":"Domains","pages":[{"title":"Get domains","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/domains","href":"/api-reference/domains/get-domains"}]},{"group":"Events","pages":[{"title":"Indicates a NodeExecutionEvent has occurred.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json post /api/v1/events/nodes","href":"/api-reference/events/indicates-a-nodeexecutionevent-has-occurred"},{"title":"Indicates a TaskExecutionEvent has occurred.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json post /api/v1/events/tasks","href":"/api-reference/events/indicates-a-taskexecutionevent-has-occurred"},{"title":"Indicates a WorkflowExecutionEvent has occurred.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json post /api/v1/events/workflows","href":"/api-reference/events/indicates-a-workflowexecutionevent-has-occurred"}]},{"group":"Executions","pages":[{"title":"Triggers the creation of a Execution","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json post /api/v1/executions","href":"/api-reference/executions/triggers-the-creation-of-a-execution"},{"title":"Recreates a previously-run workflow execution that will only start executing from the last known","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json post /api/v1/executions/recover","href":"/api-reference/executions/recreates-a-previously-run-workflow-execution-that-will-only-start-executing-from-the-last-known"},{"title":"Triggers the creation of an identical Execution","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json post /api/v1/executions/relaunch","href":"/api-reference/executions/triggers-the-creation-of-an-identical-execution"},{"title":"Fetch a list of Execution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/executions/{id.project}/{id.domain}","href":"/api-reference/executions/fetch-a-list-of-execution"},{"title":"Fetches a Execution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/executions/{id.project}/{id.domain}/{id.name}","href":"/api-reference/executions/fetches-a-execution"},{"title":"Update execution belonging to project domain Execution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json put /api/v1/executions/{id.project}/{id.domain}/{id.name}","href":"/api-reference/executions/update-execution-belonging-to-project-domain-execution"},{"title":"Terminates an in-progress Execution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json delete /api/v1/executions/{id.project}/{id.domain}/{id.name}","href":"/api-reference/executions/terminates-an-in-progress-execution"}]},{"group":"Matchable attributes","pages":[{"title":"Lists custom MatchableAttributesConfiguration for a specific resource type.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/matchable_attributes","href":"/api-reference/matchable-attributes/lists-custom-matchableattributesconfiguration-for-a-specific-resource-type"}]},{"group":"Metrics","pages":[{"title":"Fetches runtime metrics for a Execution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/metrics/executions/{id.project}/{id.domain}/{id.name}","href":"/api-reference/metrics/fetches-runtime-metrics-for-a-execution"}]},{"group":"Named entities","pages":[{"title":"Returns a NamedEntity object.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}","href":"/api-reference/named-entities/returns-a-namedentity-object"},{"title":"Updates a NamedEntity object.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json put /api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}","href":"/api-reference/named-entities/updates-a-namedentity-object"},{"title":"Returns a list of NamedEntity objects.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/named_entities/{resource_type}/{project}/{domain}","href":"/api-reference/named-entities/returns-a-list-of-namedentity-objects"}]},{"group":"Node executions","pages":[{"title":"Fetches a NodeExecution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}","href":"/api-reference/node-executions/fetches-a-nodeexecution"},{"title":"Fetches a DynamicNodeWorkflowResponse.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}/dynamic_workflow","href":"/api-reference/node-executions/fetches-a-dynamicnodeworkflowresponse"},{"title":"Fetch a list of NodeExecution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/node_executions/{workflow_execution_id.project}/{workflow_execution_id.domain}/{workflow_execution_id.name}","href":"/api-reference/node-executions/fetch-a-list-of-nodeexecution"}]},{"group":"Project attributes","pages":[{"title":"Creates or updates custom MatchableAttributesConfiguration at the project level","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json put /api/v1/project_attributes/{attributes.project}","href":"/api-reference/project-attributes/creates-or-updates-custom-matchableattributesconfiguration-at-the-project-level"},{"title":"Fetches custom MatchableAttributesConfiguration for a project and domain.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/project_attributes/{project}","href":"/api-reference/project-attributes/fetches-custom-matchableattributesconfiguration-for-a-project-and-domain"},{"title":"Deletes custom MatchableAttributesConfiguration for a project and domain.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json delete /api/v1/project_attributes/{project}","href":"/api-reference/project-attributes/deletes-custom-matchableattributesconfiguration-for-a-project-and-domain"}]},{"group":"Project domain attributes","pages":[{"title":"Creates or updates custom MatchableAttributesConfiguration for a project and domain.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json put /api/v1/project_domain_attributes/{attributes.project}/{attributes.domain}","href":"/api-reference/project-domain-attributes/creates-or-updates-custom-matchableattributesconfiguration-for-a-project-and-domain"},{"title":"Fetches custom MatchableAttributesConfiguration for a project and domain.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/project_domain_attributes/{project}/{domain}","href":"/api-reference/project-domain-attributes/fetches-custom-matchableattributesconfiguration-for-a-project-and-domain"},{"title":"Deletes custom MatchableAttributesConfiguration for a project and domain.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json delete /api/v1/project_domain_attributes/{project}/{domain}","href":"/api-reference/project-domain-attributes/deletes-custom-matchableattributesconfiguration-for-a-project-and-domain"}]},{"group":"Projects","pages":[{"title":"Fetches a list of Project","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/projects","href":"/api-reference/projects/fetches-a-list-of-project"},{"title":"Registers a Project with the Flyte deployment.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json post /api/v1/projects","href":"/api-reference/projects/registers-a-project-with-the-flyte-deployment"},{"title":"Fetches a Project","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/projects/{id}","href":"/api-reference/projects/fetches-a-project"},{"title":"Updates an existing Project","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json put /api/v1/projects/{id}","href":"/api-reference/projects/updates-an-existing-project"}]},{"group":"Task executions","pages":[{"title":"Fetches a TaskExecution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/task_executions/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt}","href":"/api-reference/task-executions/fetches-a-taskexecution"},{"title":"Fetches a list of TaskExecution.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/task_executions/{node_execution_id.execution_id.project}/{node_execution_id.execution_id.domain}/{node_execution_id.execution_id.name}/{node_execution_id.node_id}","href":"/api-reference/task-executions/fetches-a-list-of-taskexecution"}]},{"group":"Tasks","pages":[{"title":"Fetch a list of NamedEntityIdentifier of task objects.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/task_ids/{project}/{domain}","href":"/api-reference/tasks/fetch-a-list-of-namedentityidentifier-of-task-objects"},{"title":"Create and upload a Task definition","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json post /api/v1/tasks","href":"/api-reference/tasks/create-and-upload-a-task-definition"},{"title":"Fetch a list of Task definitions.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/tasks/{id.project}/{id.domain}","href":"/api-reference/tasks/fetch-a-list-of-task-definitions"},{"title":"Fetch a list of Task definitions (by name)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/tasks/{id.project}/{id.domain}/{id.name}","href":"/api-reference/tasks/fetch-a-list-of-task-definitions-by-name"},{"title":"Fetch a Task definition.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/tasks/{id.project}/{id.domain}/{id.name}/{id.version}","href":"/api-reference/tasks/fetch-a-task-definition"}]},{"group":"Version","pages":[{"title":"Get version","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/version","href":"/api-reference/version/get-version"}]},{"group":"Workflow attributes","pages":[{"title":"Creates or updates custom MatchableAttributesConfiguration for a project, domain and workflow.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json put /api/v1/workflow_attributes/{attributes.project}/{attributes.domain}/{attributes.workflow}","href":"/api-reference/workflow-attributes/creates-or-updates-custom-matchableattributesconfiguration-for-a-project-domain-and-workflow"},{"title":"Fetches custom MatchableAttributesConfiguration for a project, domain and workflow.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/workflow_attributes/{project}/{domain}/{workflow}","href":"/api-reference/workflow-attributes/fetches-custom-matchableattributesconfiguration-for-a-project-domain-and-workflow"},{"title":"Deletes custom MatchableAttributesConfiguration for a project, domain and workflow.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json delete /api/v1/workflow_attributes/{project}/{domain}/{workflow}","href":"/api-reference/workflow-attributes/deletes-custom-matchableattributesconfiguration-for-a-project-domain-and-workflow"}]},{"group":"Workflows","pages":[{"title":"Fetch a list of NamedEntityIdentifier of workflow objects.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/workflow_ids/{project}/{domain}","href":"/api-reference/workflows/fetch-a-list-of-namedentityidentifier-of-workflow-objects"},{"title":"Create and upload a Workflow definition","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json post /api/v1/workflows","href":"/api-reference/workflows/create-and-upload-a-workflow-definition"},{"title":"Fetch a list of Workflow definitions.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/workflows/{id.project}/{id.domain}","href":"/api-reference/workflows/fetch-a-list-of-workflow-definitions"},{"title":"Fetch a list of Workflow definitions (by name)","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/workflows/{id.project}/{id.domain}/{id.name}","href":"/api-reference/workflows/fetch-a-list-of-workflow-definitions-by-name"},{"title":"Fetch a Workflow definition.","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-native-api.json get /api/v1/workflows/{id.project}/{id.domain}/{id.name}/{id.version}","href":"/api-reference/workflows/fetch-a-workflow-definition"}]}]},{"group":"Flyte extensions API","root":{"title":"Flyte extensions API","href":"/cloud/reference/api/flyte/flyte-extensions-api"},"pages":[{"group":"Artifacts","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json get /artifacts/v1/artifacts","href":"/api-reference/artifacts/list"},{"title":"Generate Client Code","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json get /artifacts/v1/artifacts/{artifact-id}/versions/{execution-name}/code","href":"/api-reference/artifacts/generate-client-code"}]},{"group":"Bookmarks","pages":[{"title":"Get a single bookmark","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json get /artifacts/v1/artifacts/{artifact-id}/bookmarks/{execution-name}","href":"/api-reference/bookmarks/get-a-single-bookmark"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json delete /artifacts/v1/artifacts/{artifact-id}/bookmarks/{execution-name}","href":"/api-reference/bookmarks/delete"},{"title":"Get a single artifact file","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json get /artifacts/v1/artifacts/{artifact-id}/bookmarks/{execution-name}/files/{file-name}","href":"/api-reference/bookmarks/get-a-single-artifact-file"},{"title":"List","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json get /artifacts/v1/bookmarks","href":"/api-reference/bookmarks/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json post /artifacts/v1/bookmarks","href":"/api-reference/bookmarks/create"},{"title":"Bulk update","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json post /artifacts/v1/bookmarks/bulk-update","href":"/api-reference/bookmarks/bulk-update"}]},{"group":"Exports","pages":[{"title":"Prepare artifact version for export","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json get /artifacts/v1/artifacts/{artifact-id}/versions/{execution-name}/export-types/{export-type}/exports/{export-target-id}/prepare","href":"/api-reference/exports/prepare-artifact-version-for-export"},{"title":"List","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json get /artifacts/v1/exports","href":"/api-reference/exports/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json post /artifacts/v1/exports-callback","href":"/api-reference/exports/create"}]},{"group":"Blob","pages":[{"title":"Retrieve contents","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json get /artifacts/v1/blobs/render","href":"/api-reference/blob/retrieve-contents"},{"title":"Retrieve size","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json get /artifacts/v1/blobs/size","href":"/api-reference/blob/retrieve-size"}]},{"group":"Execution","pages":[{"title":"Re run with overrides","deprecated":null,"version":null,"openapi":"/api-specs/cloud/flyte-extensions-api.json post /executions/v1/execution/{execution-id}/rerunWithOverrides","href":"/api-reference/execution/re-run-with-overrides"}]}]}]},{"group":"CLI","pages":[{"title":"Domino CLI","href":"/cloud/reference/cli/index"},{"title":"Install the Domino Command Line Interface (CLI)","sidebarTitle":"Install the Domino CLI","href":"/cloud/reference/cli/install-the-cli"},{"title":"Domino CLI reference","href":"/cloud/reference/cli/cli-reference"},{"title":"Download files with the CLI","href":"/cloud/reference/cli/download-files-with-the-cli"},{"title":"Force-restore a local Project","href":"/cloud/reference/cli/force-restore-a-local-project"},{"title":"Move a Project between deployments","sidebarTitle":"Move Project between deployments","href":"/cloud/reference/cli/move-project-between-deployments"},{"title":"Use the Domino CLI behind a proxy","sidebarTitle":"Use Domino CLI behind proxy","href":"/cloud/reference/cli/use-the-cli-behind-a-proxy"}]},{"title":"API reference for the Agents Python SDK","sidebarTitle":"Experiment \u0026 agent SDK","href":"/cloud/reference/experiment-agent-sdk/python-sdk-agents"},{"title":"R package","href":"/cloud/reference/r-package/domino-r-package"},{"group":"Python SDK","pages":[{"title":"The python-domino library","href":"/cloud/reference/python-sdk/python-domino"},{"title":"Python Wrapper for Domino API","href":"/cloud/reference/python-sdk/python-wrapper-for-domino-api"}]},{"title":"Default environment variables","sidebarTitle":"Default environment variables","href":"/cloud/reference/environment-variables"},{"title":"Domino skills reference","sidebarTitle":"Skills","href":"/cloud/reference/skills"},{"title":"Glossary","href":"/cloud/reference/glossary"}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/cloud/examples/blueprints"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/cloud-release"}]},{"tab":"Knowledge Base","hidden":true,"searchable":true,"pages":[{"title":"Knowledge Base","href":"/knowledge-base"}]}]},{"version":"6.3","pages":[{"title":"6.3","href":"/6.3/platform-overview/domino-overview"}]}]},"basePath":"","title":"Transition an approval to its next status (approve, reject, submit, cancel) - Domino","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2bfc744e19","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","NarrationPlayer-YDlRqDT3.js","types-CiTgMxws.js","shallow-CmQhqCJn.js","Page-BAvA99GL.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}