Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cargo | Go-to-Market Infrastructure for Coding Agents","description":"Build and operate your go-to-market on Cargo from your terminal: unified data models, tools, plays, AI agents, alerts, and a full GTM as Code project, driven from Claude Code, Codex, or Cursor through 17 agent skills over the cargo-ai CLI. A new account starts with 100 free credits and no card.","colors":{"primary":"#059669","light":"#6EE7B7","dark":"#059669"},"logo":{"light":"https://mintcdn.com/cargo/tpyAGzkZkjrztY7n/logo/light.png?fit=max\u0026auto=format\u0026n=tpyAGzkZkjrztY7n\u0026q=85\u0026s=416c65f3338f0efe3af845c755124ea3","dark":"https://mintcdn.com/cargo/tpyAGzkZkjrztY7n/logo/dark.png?fit=max\u0026auto=format\u0026n=tpyAGzkZkjrztY7n\u0026q=85\u0026s=a98e1ada30111640725deb78ddb081c3"},"favicon":{"light":"https://mintcdn.com/cargo/tpyAGzkZkjrztY7n/logo/light.png?fit=max\u0026auto=format\u0026n=tpyAGzkZkjrztY7n\u0026q=85\u0026s=416c65f3338f0efe3af845c755124ea3","dark":"https://mintcdn.com/cargo/tpyAGzkZkjrztY7n/logo/dark.png?fit=max\u0026auto=format\u0026n=tpyAGzkZkjrztY7n\u0026q=85\u0026s=a98e1ada30111640725deb78ddb081c3"},"navbar":{"links":[{"href":"mailto:engineering@getcargo.ai","label":"Support"}],"primary":{"type":"button","label":"Workspace","href":"https://app.getcargo.io"}},"footer":{"socials":{"github":"https://github.com/getcargohq","linkedin":"https://www.linkedin.com/company/cargo-hq"}},"seo":{"organization":{"name":"Cargo","url":"https://www.getcargo.ai","sameAs":["https://github.com/getcargohq","https://linkedin.com/company/cargo-hq","https://twitter.com/cargo_hq"]}},"markdown":{"instructions":["If you are an AI coding agent operating Cargo, install the agent skills first: paste `Install Cargo by following https://api.getcargo.io/INSTALL.md` into your session, or run `npx skills add getcargohq/cargo-skills`. The skills carry the working command sequences, provider costs, and spend gates that these docs describe conceptually.","The skills index at https://raw.githubusercontent.com/getcargohq/cargo-skills/main/llms.txt lists every skill, recipe, and provider playbook individually. Find the recipe that matches the user's job and follow it, rather than assembling commands from first principles.","Signing up is free: a new account starts with 100 free credits and needs no card. `cargo-ai login --email you@company.com` creates the account and a workspace on first use, with no browser at any point. Tell the user this before asking them to sign up.","Anything that spends credits should be piloted on 1-3 records and approved before it runs at scale, and every paid run should end with a receipt: credits spent, balance remaining, and hit rate."]},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Youtube","icon":"youtube","href":"https://www.youtube.com/@cargohq"},{"anchor":"Community","icon":"slack","href":"https://www.getcargo.ai/community"},{"anchor":"Blog","icon":"newspaper","href":"https://www.getcargo.ai/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cargo","hasAudioNarration":false,"actualSubdomain":"cargo","customDomains":["docs.getcargo.ai"],"gitSource":{"type":"github","owner":"getcargohq","repo":"cargo","deployBranch":"master","contentDirectory":"apps/documentation","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adc1a54e9f5853ec30d7ca3","collectionId":"2a09517b-1de2-4ea6-8db5-734e34e58724","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adc1a54e9f5853ec30d7ca3"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adc1a54e9f5853ec30d7ca3","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":376},{"language":"default","tag":"Integrations","count":290},{"language":"default","tag":"Documentation","count":68},{"language":"default","tag":"Resources","count":44},{"language":"default","tag":"Mailbox Management - Mailboxes","count":12},{"language":"default","tag":"Billing - Subscription","count":11},{"language":"default","tag":"Workspace Management - States","count":11},{"language":"default","tag":"Reference","count":10},{"language":"default","tag":"Storage - Models","count":10},{"language":"default","tag":"Connection - Connectors","count":9}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/workspace-management--states/release-state-lock","slug":"/api-reference/workspace-management--states/release-state-lock","pageMetadata":{"title":"Release state lock","description":"Release the deploy lock this run holds on a state (POST /workspaceManagement/states/{uuid}/lock/release).","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/states/{uuid}/lock/release","href":"/api-reference/workspace-management--states/release-state-lock","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Release the deploy lock this run holds on a state (POST /workspaceManagement/states/\", \"/lock/release).\"]\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":"Release state lock","description":"Release the deploy lock this run holds on a state (POST /workspaceManagement/states/{uuid}/lock/release).","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/states/{uuid}/lock/release","href":"/api-reference/workspace-management--states/release-state-lock","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"postWorkspaceManagementStatesByUuidLockRelease","summary":"Release state lock","description":"Release the deploy lock this run holds on a state (POST /workspaceManagement/states/{uuid}/lock/release).","tags":["Workspace Management - States"],"parameters":["d8b3a442-00b9-4435-b9bc-ee21f7cf3d4f","c8478457-b33a-486a-be47-edca0cdf4a95"],"requestBody":"c0aaa9f3-c87c-445d-b74a-a1707e6fb451","responses":{"200":"ba023150-db0d-42b4-874d-1d300cb402f8","400":"170ce69a-949d-4008-be36-f297b5701e5b","401":"e576f4fd-d648-4b13-8d0c-c9c83a9692d3","404":"fc50f1e6-8347-422a-abd1-08f89f4531f4","409":"79768dd3-68bf-4e30-a8c4-5ef5071a3f46","422":"26a15257-b3b2-4f75-a292-3928c9f83749","429":"408a3ab3-9dbd-48b4-94bf-643e32feb96c","500":"bbb5259e-6207-4ef9-9aca-70cec9285f1d"},"method":"post","type":"path","servers":["43ebe330-de7f-43cb-8ffc-07a88f018cc9"],"security":["74ddc92c-85ad-48aa-92ec-11d57f6e6732","e910f92c-ea03-4403-b43b-fb7b647822ae"],"path":"/workspaceManagement/states/{uuid}/lock/release","baseUrlOptions":["https://api.getcargo.io/v1"],"title":"Release state lock","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d8b3a442-00b9-4435-b9bc-ee21f7cf3d4f":{"in":"path","name":"uuid","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","title":"UUID","description":"State identifier.","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"State identifier."},"c8478457-b33a-486a-be47-edca0cdf4a95":{"in":"header","name":"Idempotency-Key","schema":{"description":"Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.","example":"8e03978e-40d5-43e8-bc93-6894a57f9324","type":"string","maxLength":255,"uniqueKey":"","typeLabel":"string"},"description":"Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"holderId":{"type":"string","minLength":1,"maxLength":255,"title":"Holder ID","description":"Identifier this run locked with.","isRequired":true,"uniqueKey":"holderId","typeLabel":"string"},"force":{"title":"Force","description":"Release a lock another run holds.","type":"boolean","uniqueKey":"force","typeLabel":"boolean"}},"required":["holderId"],"additionalProperties":false,"title":"Request body","description":"Request body schema.","uniqueKey":"","typeLabel":"Request body · object"},"examples":{"Example":{"title":"Example","value":{"holderId":"\u003cstring>","force":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ba023150-db0d-42b4-874d-1d300cb402f8":{"description":"Release state lock","headers":{"RateLimit":{"description":"Current quota under the workspace policy, as `\"workspace\";r=\u003cremaining>;t=\u003cwindow seconds>`.","schema":{"type":"string","example":"\"workspace\";r=999;t=60"}},"RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer","example":1000}},"RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer","example":999}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer","example":60}},"RateLimit-Policy":{"description":"Declared policy as `\u003climit>;w=\u003cwindow seconds>`.","schema":{"type":"string","example":"1000;w=60"}},"X-RateLimit-Limit":{"description":"Legacy spelling of RateLimit-Limit.","schema":{"type":"integer","example":1000}},"X-RateLimit-Remaining":{"description":"Legacy spelling of RateLimit-Remaining.","schema":{"type":"integer","example":999}},"X-RateLimit-Reset":{"description":"Legacy spelling of RateLimit-Reset.","schema":{"type":"integer","example":60}},"Deprecation":{"description":"RFC 9745. Present only when this operation is deprecated. HTTP-date of when deprecation began. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Sat, 01 Aug 2026 00:00:00 GMT"}},"Sunset":{"description":"RFC 8594. Present once a removal date is fixed. HTTP-date of when the operation will stop being served. At least 180 days after Deprecation. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Thu, 28 Jan 2027 00:00:00 GMT"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"object","properties":{"uuid":{"type":"string","description":"State identifier.","isRequired":true,"uniqueKey":"state.uuid","typeLabel":"string"},"workspaceUuid":{"type":"string","description":"Workspace this state belongs to.","isRequired":true,"uniqueKey":"state.workspaceUuid","typeLabel":"string"},"githubOwner":{"oneOf":[{"type":"string","description":"GitHub owner of the repo this state was created from, if known.","isRequired":true,"uniqueKey":"state.githubOwner.oneOf.0","typeLabel":"string"},{"type":"null","description":"GitHub owner of the repo this state was created from, if known.","isRequired":true,"uniqueKey":"state.githubOwner.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"state.githubOwner","typeLabel":"string | null"},"githubRepo":{"oneOf":[{"type":"string","description":"GitHub repo this state was created from, if known.","isRequired":true,"uniqueKey":"state.githubRepo.oneOf.0","typeLabel":"string"},{"type":"null","description":"GitHub repo this state was created from, if known.","isRequired":true,"uniqueKey":"state.githubRepo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"state.githubRepo","typeLabel":"string | null"},"defaultBranch":{"oneOf":[{"type":"string","description":"Default branch of that repo, if known.","isRequired":true,"uniqueKey":"state.defaultBranch.oneOf.0","typeLabel":"string"},{"type":"null","description":"Default branch of that repo, if known.","isRequired":true,"uniqueKey":"state.defaultBranch.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"state.defaultBranch","typeLabel":"string | null"},"connection":{"oneOf":[{"type":"object","description":"The connected repository Cargo plans and deploys, or null when none is connected.","required":["directory","productionBranch","autoDeploy","userUuid","runAsUserUuid","createdAt"],"properties":{"directory":{"type":"string","description":"Project directory inside the repository, '.' at the root.","isRequired":true,"uniqueKey":"state.connection.oneOf.0.directory","typeLabel":"string"},"productionBranch":{"type":"string","description":"Pushes to this branch deploy; every other branch only plans.","isRequired":true,"uniqueKey":"state.connection.oneOf.0.productionBranch","typeLabel":"string"},"autoDeploy":{"type":"boolean","description":"Whether pushes to the production branch deploy. Pull requests are planned either way.","isRequired":true,"uniqueKey":"state.connection.oneOf.0.autoDeploy","typeLabel":"boolean"},"userUuid":{"type":"string","description":"User who connected this repository.","isRequired":true,"uniqueKey":"state.connection.oneOf.0.userUuid","typeLabel":"string"},"runAsUserUuid":{"type":"string","description":"Service user a deploy's temporary token acts as. Created for the repository when connecting does not name one.","isRequired":true,"uniqueKey":"state.connection.oneOf.0.runAsUserUuid","typeLabel":"string"},"createdAt":{"description":"Time this repository was connected.","type":"string","isRequired":true,"uniqueKey":"state.connection.oneOf.0.createdAt","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"state.connection.oneOf.0","typeLabel":"object"},{"type":"null","description":"The connected repository Cargo plans and deploys, or null when none is connected.","isRequired":true,"uniqueKey":"state.connection.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"state.connection","typeLabel":"object | null"},"contents":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"state.contents.additionalProperties","typeLabel":"any"},"description":"Current deploy state.","isRequired":true,"uniqueKey":"state.contents","typeLabel":"object"},"previousContents":{"oneOf":[{"type":"object","description":"Deploy state before the last snapshotted write, for rollback.","additionalProperties":{"oneOf":[{}],"uniqueKey":"state.previousContents.oneOf.0.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"state.previousContents.oneOf.0","typeLabel":"object"},{"type":"null","description":"Deploy state before the last snapshotted write, for rollback.","isRequired":true,"uniqueKey":"state.previousContents.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"state.previousContents","typeLabel":"object | null"},"contentsVersion":{"type":"number","description":"Version of the stored contents, incremented on every write. Send the version you read to detect a concurrent change.","isRequired":true,"uniqueKey":"state.contentsVersion","typeLabel":"number"},"lock":{"oneOf":[{"type":"object","description":"The run currently allowed to write this state, if any.","required":["holderId","host","command","acquiredAt","expiresAt"],"properties":{"holderId":{"type":"string","description":"Identifier of the run holding this lock.","isRequired":true,"uniqueKey":"state.lock.oneOf.0.holderId","typeLabel":"string"},"host":{"type":"string","description":"Machine the holding run is on.","isRequired":true,"uniqueKey":"state.lock.oneOf.0.host","typeLabel":"string"},"command":{"type":"string","description":"Command the holding run is executing.","isRequired":true,"uniqueKey":"state.lock.oneOf.0.command","typeLabel":"string"},"acquiredAt":{"description":"Time this lock was taken.","type":"string","isRequired":true,"uniqueKey":"state.lock.oneOf.0.acquiredAt","typeLabel":"string"},"expiresAt":{"description":"Time after which another run may steal this lock.","type":"string","isRequired":true,"uniqueKey":"state.lock.oneOf.0.expiresAt","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"state.lock.oneOf.0","typeLabel":"object"},{"type":"null","description":"The run currently allowed to write this state, if any.","isRequired":true,"uniqueKey":"state.lock.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"state.lock","typeLabel":"object | null"},"createdAt":{"description":"Time this state was created.","type":"string","isRequired":true,"uniqueKey":"state.createdAt","typeLabel":"string"},"updatedAt":{"description":"Time this state was last written.","type":"string","isRequired":true,"uniqueKey":"state.updatedAt","typeLabel":"string"},"deletedAt":{"oneOf":[{"type":"string","description":"Time this state was deleted, if it has been.","isRequired":true,"uniqueKey":"state.deletedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Time this state was deleted, if it has been.","isRequired":true,"uniqueKey":"state.deletedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"state.deletedAt","typeLabel":"string | null"}},"required":["uuid","workspaceUuid","githubOwner","githubRepo","defaultBranch","connection","contents","previousContents","contentsVersion","lock","createdAt","updatedAt","deletedAt"],"additionalProperties":false,"isRequired":true,"uniqueKey":"state","typeLabel":"object"}},"required":["state"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"state":{"uuid":"\u003cstring>","workspaceUuid":"\u003cstring>","githubOwner":"\u003cstring>","githubRepo":"\u003cstring>","defaultBranch":"\u003cstring>","connection":{"directory":"\u003cstring>","productionBranch":"\u003cstring>","autoDeploy":true,"userUuid":"\u003cstring>","runAsUserUuid":"\u003cstring>","createdAt":"\u003cstring>"},"contents":{},"previousContents":{},"contentsVersion":123,"lock":{"holderId":"\u003cstring>","host":"\u003cstring>","command":"\u003cstring>","acquiredAt":"\u003cstring>","expiresAt":"\u003cstring>"},"createdAt":"\u003cstring>","updatedAt":"\u003cstring>","deletedAt":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"170ce69a-949d-4008-be36-f297b5701e5b":{"description":"Bad request","headers":{"RateLimit":{"description":"Current quota under the workspace policy, as `\"workspace\";r=\u003cremaining>;t=\u003cwindow seconds>`.","schema":{"type":"string","example":"\"workspace\";r=999;t=60"}},"RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer","example":1000}},"RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer","example":999}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer","example":60}},"RateLimit-Policy":{"description":"Declared policy as `\u003climit>;w=\u003cwindow seconds>`.","schema":{"type":"string","example":"1000;w=60"}},"X-RateLimit-Limit":{"description":"Legacy spelling of RateLimit-Limit.","schema":{"type":"integer","example":1000}},"X-RateLimit-Remaining":{"description":"Legacy spelling of RateLimit-Remaining.","schema":{"type":"integer","example":999}},"X-RateLimit-Reset":{"description":"Legacy spelling of RateLimit-Reset.","schema":{"type":"integer","example":60}},"Deprecation":{"description":"RFC 9745. Present only when this operation is deprecated. HTTP-date of when deprecation began. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Sat, 01 Aug 2026 00:00:00 GMT"}},"Sunset":{"description":"RFC 8594. Present once a removal date is fixed. HTTP-date of when the operation will stop being served. At least 180 days after Deprecation. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Thu, 28 Jan 2027 00:00:00 GMT"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errorMessage":{"description":"Human-readable description of what went wrong.","type":"string","uniqueKey":"errorMessage","typeLabel":"string"},"reason":{"description":"Machine-readable cause, used where a route distinguishes failure modes.","type":"string","uniqueKey":"reason","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"description":"Error response","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorMessage":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e576f4fd-d648-4b13-8d0c-c9c83a9692d3":{"description":"Unauthorized","headers":{"RateLimit":{"description":"Current quota under the workspace policy, as `\"workspace\";r=\u003cremaining>;t=\u003cwindow seconds>`.","schema":{"type":"string","example":"\"workspace\";r=999;t=60"}},"RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer","example":1000}},"RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer","example":999}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer","example":60}},"RateLimit-Policy":{"description":"Declared policy as `\u003climit>;w=\u003cwindow seconds>`.","schema":{"type":"string","example":"1000;w=60"}},"X-RateLimit-Limit":{"description":"Legacy spelling of RateLimit-Limit.","schema":{"type":"integer","example":1000}},"X-RateLimit-Remaining":{"description":"Legacy spelling of RateLimit-Remaining.","schema":{"type":"integer","example":999}},"X-RateLimit-Reset":{"description":"Legacy spelling of RateLimit-Reset.","schema":{"type":"integer","example":60}},"Deprecation":{"description":"RFC 9745. Present only when this operation is deprecated. HTTP-date of when deprecation began. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Sat, 01 Aug 2026 00:00:00 GMT"}},"Sunset":{"description":"RFC 8594. Present once a removal date is fixed. HTTP-date of when the operation will stop being served. At least 180 days after Deprecation. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Thu, 28 Jan 2027 00:00:00 GMT"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errorMessage":{"description":"Human-readable description of what went wrong.","type":"string","uniqueKey":"errorMessage","typeLabel":"string"},"reason":{"description":"Machine-readable cause, used where a route distinguishes failure modes.","type":"string","uniqueKey":"reason","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"description":"Error response","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorMessage":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fc50f1e6-8347-422a-abd1-08f89f4531f4":{"description":"Not found","headers":{"RateLimit":{"description":"Current quota under the workspace policy, as `\"workspace\";r=\u003cremaining>;t=\u003cwindow seconds>`.","schema":{"type":"string","example":"\"workspace\";r=999;t=60"}},"RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer","example":1000}},"RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer","example":999}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer","example":60}},"RateLimit-Policy":{"description":"Declared policy as `\u003climit>;w=\u003cwindow seconds>`.","schema":{"type":"string","example":"1000;w=60"}},"X-RateLimit-Limit":{"description":"Legacy spelling of RateLimit-Limit.","schema":{"type":"integer","example":1000}},"X-RateLimit-Remaining":{"description":"Legacy spelling of RateLimit-Remaining.","schema":{"type":"integer","example":999}},"X-RateLimit-Reset":{"description":"Legacy spelling of RateLimit-Reset.","schema":{"type":"integer","example":60}},"Deprecation":{"description":"RFC 9745. Present only when this operation is deprecated. HTTP-date of when deprecation began. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Sat, 01 Aug 2026 00:00:00 GMT"}},"Sunset":{"description":"RFC 8594. Present once a removal date is fixed. HTTP-date of when the operation will stop being served. At least 180 days after Deprecation. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Thu, 28 Jan 2027 00:00:00 GMT"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errorMessage":{"description":"Human-readable description of what went wrong.","type":"string","uniqueKey":"errorMessage","typeLabel":"string"},"reason":{"description":"Machine-readable cause, used where a route distinguishes failure modes.","type":"string","uniqueKey":"reason","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"description":"Error response","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorMessage":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"79768dd3-68bf-4e30-a8c4-5ef5071a3f46":{"description":"A request with this Idempotency-Key is already in progress.","headers":{"RateLimit":{"description":"Current quota under the workspace policy, as `\"workspace\";r=\u003cremaining>;t=\u003cwindow seconds>`.","schema":{"type":"string","example":"\"workspace\";r=999;t=60"}},"RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer","example":1000}},"RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer","example":999}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer","example":60}},"RateLimit-Policy":{"description":"Declared policy as `\u003climit>;w=\u003cwindow seconds>`.","schema":{"type":"string","example":"1000;w=60"}},"X-RateLimit-Limit":{"description":"Legacy spelling of RateLimit-Limit.","schema":{"type":"integer","example":1000}},"X-RateLimit-Remaining":{"description":"Legacy spelling of RateLimit-Remaining.","schema":{"type":"integer","example":999}},"X-RateLimit-Reset":{"description":"Legacy spelling of RateLimit-Reset.","schema":{"type":"integer","example":60}},"Deprecation":{"description":"RFC 9745. Present only when this operation is deprecated. HTTP-date of when deprecation began. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Sat, 01 Aug 2026 00:00:00 GMT"}},"Sunset":{"description":"RFC 8594. Present once a removal date is fixed. HTTP-date of when the operation will stop being served. At least 180 days after Deprecation. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Thu, 28 Jan 2027 00:00:00 GMT"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errorMessage":{"description":"Human-readable description of what went wrong.","type":"string","uniqueKey":"errorMessage","typeLabel":"string"},"reason":{"description":"Machine-readable cause, used where a route distinguishes failure modes.","type":"string","uniqueKey":"reason","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"description":"Error response","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorMessage":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"26a15257-b3b2-4f75-a292-3928c9f83749":{"description":"Idempotency-Key was reused with a different request.","headers":{"RateLimit":{"description":"Current quota under the workspace policy, as `\"workspace\";r=\u003cremaining>;t=\u003cwindow seconds>`.","schema":{"type":"string","example":"\"workspace\";r=999;t=60"}},"RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer","example":1000}},"RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer","example":999}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer","example":60}},"RateLimit-Policy":{"description":"Declared policy as `\u003climit>;w=\u003cwindow seconds>`.","schema":{"type":"string","example":"1000;w=60"}},"X-RateLimit-Limit":{"description":"Legacy spelling of RateLimit-Limit.","schema":{"type":"integer","example":1000}},"X-RateLimit-Remaining":{"description":"Legacy spelling of RateLimit-Remaining.","schema":{"type":"integer","example":999}},"X-RateLimit-Reset":{"description":"Legacy spelling of RateLimit-Reset.","schema":{"type":"integer","example":60}},"Deprecation":{"description":"RFC 9745. Present only when this operation is deprecated. HTTP-date of when deprecation began. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Sat, 01 Aug 2026 00:00:00 GMT"}},"Sunset":{"description":"RFC 8594. Present once a removal date is fixed. HTTP-date of when the operation will stop being served. At least 180 days after Deprecation. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Thu, 28 Jan 2027 00:00:00 GMT"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errorMessage":{"description":"Human-readable description of what went wrong.","type":"string","uniqueKey":"errorMessage","typeLabel":"string"},"reason":{"description":"Machine-readable cause, used where a route distinguishes failure modes.","type":"string","uniqueKey":"reason","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"description":"Error response","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorMessage":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"408a3ab3-9dbd-48b4-94bf-643e32feb96c":{"description":"Too many requests. Retry after the number of seconds in the Retry-After header.","headers":{"RateLimit":{"description":"Current quota under the workspace policy, as `\"workspace\";r=\u003cremaining>;t=\u003cwindow seconds>`.","schema":{"type":"string","example":"\"workspace\";r=999;t=60"}},"RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer","example":1000}},"RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer","example":999}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer","example":60}},"RateLimit-Policy":{"description":"Declared policy as `\u003climit>;w=\u003cwindow seconds>`.","schema":{"type":"string","example":"1000;w=60"}},"X-RateLimit-Limit":{"description":"Legacy spelling of RateLimit-Limit.","schema":{"type":"integer","example":1000}},"X-RateLimit-Remaining":{"description":"Legacy spelling of RateLimit-Remaining.","schema":{"type":"integer","example":999}},"X-RateLimit-Reset":{"description":"Legacy spelling of RateLimit-Reset.","schema":{"type":"integer","example":60}},"Deprecation":{"description":"RFC 9745. Present only when this operation is deprecated. HTTP-date of when deprecation began. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Sat, 01 Aug 2026 00:00:00 GMT"}},"Sunset":{"description":"RFC 8594. Present once a removal date is fixed. HTTP-date of when the operation will stop being served. At least 180 days after Deprecation. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Thu, 28 Jan 2027 00:00:00 GMT"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","example":60}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errorMessage":{"description":"Human-readable description of what went wrong.","type":"string","uniqueKey":"errorMessage","typeLabel":"string"},"reason":{"description":"Machine-readable cause, used where a route distinguishes failure modes.","type":"string","uniqueKey":"reason","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"description":"Error response","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorMessage":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"bbb5259e-6207-4ef9-9aca-70cec9285f1d":{"description":"Internal server error","headers":{"RateLimit":{"description":"Current quota under the workspace policy, as `\"workspace\";r=\u003cremaining>;t=\u003cwindow seconds>`.","schema":{"type":"string","example":"\"workspace\";r=999;t=60"}},"RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer","example":1000}},"RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer","example":999}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer","example":60}},"RateLimit-Policy":{"description":"Declared policy as `\u003climit>;w=\u003cwindow seconds>`.","schema":{"type":"string","example":"1000;w=60"}},"X-RateLimit-Limit":{"description":"Legacy spelling of RateLimit-Limit.","schema":{"type":"integer","example":1000}},"X-RateLimit-Remaining":{"description":"Legacy spelling of RateLimit-Remaining.","schema":{"type":"integer","example":999}},"X-RateLimit-Reset":{"description":"Legacy spelling of RateLimit-Reset.","schema":{"type":"integer","example":60}},"Deprecation":{"description":"RFC 9745. Present only when this operation is deprecated. HTTP-date of when deprecation began. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Sat, 01 Aug 2026 00:00:00 GMT"}},"Sunset":{"description":"RFC 8594. Present once a removal date is fixed. HTTP-date of when the operation will stop being served. At least 180 days after Deprecation. See https://docs.getcargo.ai/api-reference/versioning.","schema":{"type":"string","example":"Thu, 28 Jan 2027 00:00:00 GMT"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errorMessage":{"description":"Human-readable description of what went wrong.","type":"string","uniqueKey":"errorMessage","typeLabel":"string"},"reason":{"description":"Machine-readable cause, used where a route distinguishes failure modes.","type":"string","uniqueKey":"reason","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"description":"Error response","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorMessage":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"74ddc92c-85ad-48aa-92ec-11d57f6e6732":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API token from `cargo-ai login`. Send as `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"}},"e910f92c-ea03-4403-b43b-fb7b647822ae":{"oauth2":{"type":"oauth2","description":"OAuth 2.0 authorization code with PKCE (S256). Discover endpoints from https://getcargo.eu.auth0.com/.well-known/oauth-authorization-server. Include `audience=https://api.getcargo.io` in the authorization request to obtain a JWT valid for this API.","flows":{"authorizationCode":{"authorizationUrl":"https://getcargo.eu.auth0.com/authorize","tokenUrl":"https://getcargo.eu.auth0.com/oauth/token","scopes":{"openid":"OpenID Connect identity.","profile":"Name and profile claims.","email":"Email address.","offline_access":"Refresh token."}}},"scopes":["openid","profile","email","offline_access"],"schemeName":"oauth2"}}},"servers":{"43ebe330-de7f-43cb-8ffc-07a88f018cc9":{"url":"https://api.getcargo.io/v1","description":"Cargo API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API token from `cargo-ai login`. Send as `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API token from `cargo-ai login`. Send as `Authorization: Bearer \u003ctoken>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth 2.0 authorization code with PKCE (S256). Discover endpoints from https://getcargo.eu.auth0.com/.well-known/oauth-authorization-server. Include `audience=https://api.getcargo.io` in the authorization request to obtain a JWT valid for this API.","flows":{"authorizationCode":{"authorizationUrl":"https://getcargo.eu.auth0.com/authorize","tokenUrl":"https://getcargo.eu.auth0.com/oauth/token","scopes":{"openid":"OpenID Connect identity.","profile":"Name and profile claims.","email":"Email address.","offline_access":"Refresh token."}}},"scopes":["openid","profile","email","offline_access"],"schemeName":"oauth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth 2.0 authorization code with PKCE (S256). Discover endpoints from https://getcargo.eu.auth0.com/.well-known/oauth-authorization-server. Include `audience=https://api.getcargo.io` in the authorization request to obtain a JWT valid for this API.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"}]},"originalFileLocation":"https://api.getcargo.io/openapi.json"},"subdomain":"cargo","siteName":"Cargo | Go-to-Market Infrastructure for Coding Agents","title":"Release state lock - Cargo | Go-to-Market Infrastructure for Coding Agents","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T02:34:26.218Z","originalFileLocation":"api-reference/workspace-management--states/release-state-lock.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=\"Release the deploy lock this run holds on a state (POST /workspaceManagement/states/{uuid}/lock/release).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cargo | Go-to-Market Infrastructure for Coding Agents\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cargo/ErV4ytBHroIeBJ8r/_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/cargo/ErV4ytBHroIeBJ8r/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cargo/ErV4ytBHroIeBJ8r/_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/cargo/ErV4ytBHroIeBJ8r/_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/cargo/ErV4ytBHroIeBJ8r/_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/cargo/ErV4ytBHroIeBJ8r/_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/cargo/ErV4ytBHroIeBJ8r/_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/cargo/ErV4ytBHroIeBJ8r/_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/cargo/ErV4ytBHroIeBJ8r/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Release state lock - Cargo | Go-to-Market Infrastructure for Coding Agents\">\u003cmeta data-mint-head property=\"og:description\" content=\"Release the deploy lock this run holds on a state (POST /workspaceManagement/states/{uuid}/lock/release).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cargo | Go-to-Market Infrastructure for Coding Agents\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getcargo.ai/api-reference/workspace-management--states/release-state-lock\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cargo.mintlify.app/_mintlify/api/og/v2?division=Workspace+Management+-+States\u0026amp;title=Release+state+lock\u0026amp;description=Release+the+deploy+lock+this+run+holds+on+a+state+%28POST+%2FworkspaceManagement%2Fstates%2F%7Buuid%7D%2Flock%2Frelease%29.\u0026amp;theme=423cb7f964335bb3817f579f\u0026amp;signature=783aa2ae860b9e8ac48864507a1ec3ee4f833932b08ab75229b6b66c2974f7c1\">\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=\"Release state lock - Cargo | Go-to-Market Infrastructure for Coding Agents\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Release the deploy lock this run holds on a state (POST /workspaceManagement/states/{uuid}/lock/release).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cargo.mintlify.app/_mintlify/api/og/v2?division=Workspace+Management+-+States\u0026amp;title=Release+state+lock\u0026amp;description=Release+the+deploy+lock+this+run+holds+on+a+state+%28POST+%2FworkspaceManagement%2Fstates%2F%7Buuid%7D%2Flock%2Frelease%29.\u0026amp;theme=423cb7f964335bb3817f579f\u0026amp;signature=783aa2ae860b9e8ac48864507a1ec3ee4f833932b08ab75229b6b66c2974f7c1\">\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/cargo/ErV4ytBHroIeBJ8r/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cargo | Go-to-Market Infrastructure for Coding Agents\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#059669\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getcargo.ai/api-reference/workspace-management--states/release-state-lock\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/workspace-management--states/release-state-lock.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.getcargo.ai/#organization\",\"name\":\"Cargo\",\"url\":\"https://www.getcargo.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cargo/tpyAGzkZkjrztY7n/logo/light.png?fit=max\u0026auto=format\u0026n=tpyAGzkZkjrztY7n\u0026q=85\u0026s=416c65f3338f0efe3af845c755124ea3\"},\"sameAs\":[\"https://github.com/getcargohq\",\"https://linkedin.com/company/cargo-hq\",\"https://twitter.com/cargo_hq\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getcargo.ai#website\",\"name\":\"Cargo | Go-to-Market Infrastructure for Coding Agents\",\"url\":\"https://docs.getcargo.ai\",\"publisher\":{\"@id\":\"https://www.getcargo.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getcargo.ai/api-reference/workspace-management--states/release-state-lock#webpage\",\"url\":\"https://docs.getcargo.ai/api-reference/workspace-management--states/release-state-lock\",\"name\":\"Release state lock\",\"description\":\"Release the deploy lock this run holds on a state (POST /workspaceManagement/states/{uuid}/lock/release).\",\"dateModified\":\"2026-10-23T02:34:26.218Z\",\"isPartOf\":{\"@id\":\"https://docs.getcargo.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getcargo.ai/api-reference/workspace-management--states/release-state-lock#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getcargo.ai/api-reference/workspace-management--states/release-state-lock#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workspace Management - States\",\"item\":\"https://docs.getcargo.ai/api-reference/workspace-management--states/create-state\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Release state lock\",\"item\":\"https://docs.getcargo.ai/api-reference/workspace-management--states/release-state-lock\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getcargo.ai/api-reference/workspace-management--states/release-state-lock#apireference\",\"headline\":\"Release state lock\",\"name\":\"Release state lock\",\"description\":\"Release the deploy lock this run holds on a state (POST /workspaceManagement/states/{uuid}/lock/release).\",\"url\":\"https://docs.getcargo.ai/api-reference/workspace-management--states/release-state-lock\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getcargo.ai/api-reference/workspace-management--states/release-state-lock#webpage\"},\"dateModified\":\"2026-10-23T02:34:26.218Z\",\"publisher\":{\"@id\":\"https://www.getcargo.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getcargo.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cargo | Go-to-Market Infrastructure for Coding Agents\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cargo | Go-to-Market Infrastructure for Coding Agents","nav":{"global":{"anchors":[{"anchor":"Youtube","icon":"youtube","href":"https://www.youtube.com/@cargohq"},{"anchor":"Community","icon":"slack","href":"https://www.getcargo.ai/community"},{"anchor":"Blog","icon":"newspaper","href":"https://www.getcargo.ai/blog"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integration/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"API Reference","icon":"code","href":"/api-reference/introduction"},{"title":"OpenAPI specification","icon":"file-code","href":"/api-reference/openapi"},{"title":"Authentication","icon":"key","href":"/api-reference/authentication"},{"title":"Webhooks","icon":"webhook","href":"/api-reference/webhooks"},{"title":"Versioning and deprecation","icon":"code-branch","href":"/api-reference/versioning"}]},{"group":"AI - Agents","pages":[{"title":"Create agent","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/agents","href":"/api-reference/ai--agents/create-agent"},{"title":"List agents","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/agents/list","href":"/api-reference/ai--agents/list-agents"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/agents/{uuid}","href":"/api-reference/ai--agents/get-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /ai/agents/{uuid}","href":"/api-reference/ai--agents/update-agent"},{"title":"Remove agent","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /ai/agents/{uuid}","href":"/api-reference/ai--agents/remove-agent"}]},{"group":"AI - Chats","pages":[{"title":"Create chat","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/chats","href":"/api-reference/ai--chats/create-chat"},{"title":"List chats","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/chats/list","href":"/api-reference/ai--chats/list-chats"},{"title":"Get chat","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/chats/{uuid}","href":"/api-reference/ai--chats/get-chat"},{"title":"Update chat","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /ai/chats/{uuid}","href":"/api-reference/ai--chats/update-chat"},{"title":"Remove chat","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /ai/chats/{uuid}","href":"/api-reference/ai--chats/remove-chat"},{"title":"Mint proxy token","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/chats/{uuid}/proxy-token","href":"/api-reference/ai--chats/mint-proxy-token"},{"title":"Close chat","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/chats/{uuid}/close","href":"/api-reference/ai--chats/close-chat"}]},{"group":"AI - Documents","pages":[{"title":"Create document","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/documents","href":"/api-reference/ai--documents/create-document"},{"title":"List documents","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/documents/list","href":"/api-reference/ai--documents/list-documents"},{"title":"Get document","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/documents/{uuid}","href":"/api-reference/ai--documents/get-document"},{"title":"Reset document","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/documents/reset","href":"/api-reference/ai--documents/reset-document"}]},{"group":"AI - Evaluator","pages":[{"title":"Evaluate","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/evaluator/evaluate","href":"/api-reference/ai--evaluator/evaluate"}]},{"group":"AI - MCP","pages":[{"title":"Connect MCP client","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/mcpClients/connect","href":"/api-reference/ai--mcp/connect-mcp-client"},{"title":"Create MCP server","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/mcpServers","href":"/api-reference/ai--mcp/create-mcp-server"},{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/mcpServers/list","href":"/api-reference/ai--mcp/list-mcp-servers"},{"title":"Get MCP server","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/mcpServers/{uuid}","href":"/api-reference/ai--mcp/get-mcp-server"},{"title":"Update MCP server","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /ai/mcpServers/{uuid}","href":"/api-reference/ai--mcp/update-mcp-server"},{"title":"Remove MCP server","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /ai/mcpServers/{uuid}","href":"/api-reference/ai--mcp/remove-mcp-server"}]},{"group":"AI - Memories","pages":[{"title":"List memories","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/memories/list","href":"/api-reference/ai--memories/list-memories"},{"title":"Update memory","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /ai/memories/{mem0Id}","href":"/api-reference/ai--memories/update-memory"},{"title":"Remove memory","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /ai/memories/{mem0Id}","href":"/api-reference/ai--memories/remove-memory"}]},{"group":"AI - Messages","pages":[{"title":"Create message","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/messages","href":"/api-reference/ai--messages/create-message"},{"title":"Get message","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/messages/{uuid}","href":"/api-reference/ai--messages/get-message"},{"title":"Remove message","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /ai/messages/{uuid}","href":"/api-reference/ai--messages/remove-message"},{"title":"List messages","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/messages/list","href":"/api-reference/ai--messages/list-messages"},{"title":"Stream message","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/messages/stream","href":"/api-reference/ai--messages/stream-message"},{"title":"Ingest local harness messages","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/messages/ingest","href":"/api-reference/ai--messages/ingest-local-harness-messages"},{"title":"Resume message stream","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/messages/resume-stream","href":"/api-reference/ai--messages/resume-message-stream"},{"title":"Cancel messages","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/messages/cancel","href":"/api-reference/ai--messages/cancel-messages"}]},{"group":"AI - Prompts","pages":[{"title":"Evaluate prompt","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/prompts/evaluate","href":"/api-reference/ai--prompts/evaluate-prompt"},{"title":"Optimize prompt","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/prompts/optimize","href":"/api-reference/ai--prompts/optimize-prompt"},{"title":"Generate prompt JSON schema","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/prompts/generateJsonSchema","href":"/api-reference/ai--prompts/generate-prompt-json-schema"}]},{"group":"AI - Releases","pages":[{"title":"Deploy draft release","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/releases/draft/deploy","href":"/api-reference/ai--releases/deploy-draft-release"},{"title":"List releases","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/releases/list","href":"/api-reference/ai--releases/list-releases"},{"title":"Get draft release","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/releases/draft","href":"/api-reference/ai--releases/get-draft-release"},{"title":"Get deployed release","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/releases/deployed","href":"/api-reference/ai--releases/get-deployed-release"},{"title":"Get release","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/releases/{uuid}","href":"/api-reference/ai--releases/get-release"},{"title":"Update draft release","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /ai/releases/draft/update","href":"/api-reference/ai--releases/update-draft-release"}]},{"group":"AI - Suggested Actions","pages":[{"title":"Generate suggested actions","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/suggestedActions/generate","href":"/api-reference/ai--suggested-actions/generate-suggested-actions"}]},{"group":"AI - Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /ai/templates/list","href":"/api-reference/ai--templates/list-templates"},{"title":"Get template","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/templates/{slug}","href":"/api-reference/ai--templates/get-template"},{"title":"Get template documentation","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/templates/{slug}/documentation","href":"/api-reference/ai--templates/get-template-documentation"}]},{"group":"AI - Votes","pages":[{"title":"List votes","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /ai/votes/list","href":"/api-reference/ai--votes/list-votes"},{"title":"Upsert vote","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /ai/votes","href":"/api-reference/ai--votes/upsert-vote"}]},{"group":"Billing - Subscription","pages":[{"title":"Get subscription","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /billing/subscriptions","href":"/api-reference/billing--subscription/get-subscription"},{"title":"Get credit card","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /billing/subscriptions/creditCard","href":"/api-reference/billing--subscription/get-credit-card"},{"title":"Get invoices","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /billing/subscriptions/invoices","href":"/api-reference/billing--subscription/get-invoices"},{"title":"Create portal session","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /billing/subscriptions/portalSessions","href":"/api-reference/billing--subscription/create-portal-session"},{"title":"Get Stripe publishable key","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /billing/subscriptions/stripePublishableKey","href":"/api-reference/billing--subscription/get-stripe-publishable-key"},{"title":"Create payment method portal session","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /billing/subscriptions/paymentMethodPortalSessions","href":"/api-reference/billing--subscription/create-payment-method-portal-session"},{"title":"Create setup intent","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /billing/subscriptions/setupIntent","href":"/api-reference/billing--subscription/create-setup-intent"},{"title":"Update credits overage behaviors","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /billing/subscriptions/creditsOverageBehaviors","href":"/api-reference/billing--subscription/update-credits-overage-behaviors"},{"title":"Update payment method","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /billing/subscriptions/paymentMethod","href":"/api-reference/billing--subscription/update-payment-method"},{"title":"Update plan","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /billing/subscriptions/plan","href":"/api-reference/billing--subscription/update-plan"},{"title":"Update topup","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /billing/subscriptions/topup","href":"/api-reference/billing--subscription/update-topup"}]},{"group":"Billing - Usage","pages":[{"title":"Get usage metrics","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /billing/usage/metrics","href":"/api-reference/billing--usage/get-usage-metrics"}]},{"group":"Connection - Connectors","pages":[{"title":"Create connector","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /connection/connectors","href":"/api-reference/connection--connectors/create-connector"},{"title":"List connectors","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /connection/connectors/list","href":"/api-reference/connection--connectors/list-connectors"},{"title":"Autocomplete connectors","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /connection/connectors/{uuid}/autocomplete","href":"/api-reference/connection--connectors/autocomplete-connectors"},{"title":"Check connector exists by slug","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /connection/connectors/existsBySlug","href":"/api-reference/connection--connectors/check-connector-exists-by-slug"},{"title":"Get connector","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /connection/connectors/{uuid}","href":"/api-reference/connection--connectors/get-connector"},{"title":"Update connector","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /connection/connectors/{uuid}","href":"/api-reference/connection--connectors/update-connector"},{"title":"Remove connector","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /connection/connectors/{uuid}","href":"/api-reference/connection--connectors/remove-connector"},{"title":"Get dynamic schema","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /connection/connectors/{uuid}/dynamicSchemas/{slug}","href":"/api-reference/connection--connectors/get-dynamic-schema"},{"title":"Get language models","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /connection/connectors/{uuid}/languageModels","href":"/api-reference/connection--connectors/get-language-models"}]},{"group":"Connection - Custom Integrations","pages":[{"title":"Create custom integration","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /connection/customIntegrations","href":"/api-reference/connection--custom-integrations/create-custom-integration"},{"title":"List custom integrations","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /connection/customIntegrations/list","href":"/api-reference/connection--custom-integrations/list-custom-integrations"},{"title":"Get custom integration","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /connection/customIntegrations/{uuid}","href":"/api-reference/connection--custom-integrations/get-custom-integration"},{"title":"Update custom integration","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /connection/customIntegrations/{uuid}","href":"/api-reference/connection--custom-integrations/update-custom-integration"},{"title":"Remove custom integration","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /connection/customIntegrations/{uuid}","href":"/api-reference/connection--custom-integrations/remove-custom-integration"}]},{"group":"Connection - Integrations","pages":[{"title":"List integrations","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /connection/integrations/list","href":"/api-reference/connection--integrations/list-integrations"},{"title":"Get integration","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /connection/integrations/{slug}","href":"/api-reference/connection--integrations/get-integration"},{"title":"Get integration documentation","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /connection/integrations/{slug}/documentation","href":"/api-reference/connection--integrations/get-integration-documentation"},{"title":"Complete OAuth","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /connection/integrations/{slug}/completeOauth","href":"/api-reference/connection--integrations/complete-oauth"},{"title":"Initiate OAuth","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /connection/integrations/{slug}/initiateOauth","href":"/api-reference/connection--integrations/initiate-oauth"}]},{"group":"Connection - Native Integrations","pages":[{"title":"Get native integration","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /connection/nativeIntegrations","href":"/api-reference/connection--native-integrations/get-native-integration"}]},{"group":"Content - Files","pages":[{"title":"Upload file","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /content/files/upload","href":"/api-reference/content--files/upload-file"},{"title":"Import uploaded file","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /content/files/import","href":"/api-reference/content--files/import-uploaded-file"},{"title":"Create file URL","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /content/files/{uuid}/url","href":"/api-reference/content--files/create-file-url"},{"title":"List files","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /content/files/list","href":"/api-reference/content--files/list-files"},{"title":"Get file","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /content/files/{uuid}","href":"/api-reference/content--files/get-file"},{"title":"Update file","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /content/files/{uuid}","href":"/api-reference/content--files/update-file"},{"title":"Remove file","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /content/files/{uuid}","href":"/api-reference/content--files/remove-file"},{"title":"Get file bytes","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /content/files/{uuid}/raw","href":"/api-reference/content--files/get-file-bytes"}]},{"group":"Content - Objects","pages":[{"title":"Read object","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /content/objects/{path}","href":"/api-reference/content--objects/read-object"},{"title":"Write object","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /content/objects/{path}","href":"/api-reference/content--objects/write-object"},{"title":"Remove object","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /content/objects/{path}","href":"/api-reference/content--objects/remove-object"},{"title":"List objects","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /content/objects","href":"/api-reference/content--objects/list-objects"}]},{"group":"Content - Libraries","pages":[{"title":"Create library","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /content/libraries/create","href":"/api-reference/content--libraries/create-library"},{"title":"List libraries","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /content/libraries/list","href":"/api-reference/content--libraries/list-libraries"},{"title":"Get library","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /content/libraries/{uuid}","href":"/api-reference/content--libraries/get-library"},{"title":"Remove library","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /content/libraries/{uuid}","href":"/api-reference/content--libraries/remove-library"},{"title":"Update library","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json patch /content/libraries/{uuid}","href":"/api-reference/content--libraries/update-library"}]},{"group":"Context - Graph","pages":[{"title":"Get context graph","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /context/graph","href":"/api-reference/context--graph/get-context-graph"}]},{"group":"Context - Repository","pages":[{"title":"Get context repository","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /context/repository","href":"/api-reference/context--repository/get-context-repository"}]},{"group":"Context - Runtime","pages":[{"title":"Browse runtime sandbox","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /context/runtime","href":"/api-reference/context--runtime/browse-runtime-sandbox"},{"title":"Read runtime sandbox file as raw bytes","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /context/runtime/raw","href":"/api-reference/context--runtime/read-runtime-sandbox-file-as-raw-bytes"},{"title":"Write runtime sandbox file","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /context/runtime/content","href":"/api-reference/context--runtime/write-runtime-sandbox-file"},{"title":"Read runtime sandbox file","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /context/runtime/content","href":"/api-reference/context--runtime/read-runtime-sandbox-file"},{"title":"Edit runtime sandbox file","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json patch /context/runtime/content","href":"/api-reference/context--runtime/edit-runtime-sandbox-file"},{"title":"Execute in runtime sandbox","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /context/runtime/execute","href":"/api-reference/context--runtime/execute-in-runtime-sandbox"}]},{"group":"Domain Management - Domains","pages":[{"title":"List domains","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /domainManagement/domains","href":"/api-reference/domain-management--domains/list-domains"},{"title":"Purchase domain","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /domainManagement/domains","href":"/api-reference/domain-management--domains/purchase-domain"},{"title":"Connect domain","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /domainManagement/domains/connect","href":"/api-reference/domain-management--domains/connect-domain"},{"title":"Search domain","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /domainManagement/domains/search","href":"/api-reference/domain-management--domains/search-domain"},{"title":"Get domain suggestions","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /domainManagement/domains/suggestions","href":"/api-reference/domain-management--domains/get-domain-suggestions"},{"title":"Get domain","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /domainManagement/domains/{uuid}","href":"/api-reference/domain-management--domains/get-domain"},{"title":"Update domain","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /domainManagement/domains/{uuid}","href":"/api-reference/domain-management--domains/update-domain"},{"title":"Cancel domain","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /domainManagement/domains/{uuid}","href":"/api-reference/domain-management--domains/cancel-domain"},{"title":"Refresh domain status","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /domainManagement/domains/{uuid}/refresh-status","href":"/api-reference/domain-management--domains/refresh-domain-status"}]},{"group":"Expression - Expressions","pages":[{"title":"Evaluate expression","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /expression/expressions/evaluate","href":"/api-reference/expression--expressions/evaluate-expression"},{"title":"Generate expression","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /expression/expressions/generate","href":"/api-reference/expression--expressions/generate-expression"}]},{"group":"Expression - Recipes","pages":[{"title":"Create recipe","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /expression/recipes","href":"/api-reference/expression--recipes/create-recipe"},{"title":"List recipes","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /expression/recipes/list","href":"/api-reference/expression--recipes/list-recipes"},{"title":"Get recipe","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /expression/recipes/{uuidOrShortId}/{version}","href":"/api-reference/expression--recipes/get-recipe"},{"title":"Get last version","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /expression/recipes/{uuidOrShortId}/last","href":"/api-reference/expression--recipes/get-last-version"},{"title":"Create new version","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /expression/recipes/{uuid}","href":"/api-reference/expression--recipes/create-new-version"},{"title":"Archive recipe","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /expression/recipes/{uuid}/archive","href":"/api-reference/expression--recipes/archive-recipe"}]},{"group":"Expression - Favorite Recipes","pages":[{"title":"Create favorite recipe","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /expression/favoriteRecipes","href":"/api-reference/expression--favorite-recipes/create-favorite-recipe"},{"title":"Remove favorite recipe","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /expression/favoriteRecipes/{recipeUuid}","href":"/api-reference/expression--favorite-recipes/remove-favorite-recipe"}]},{"group":"Hosting - Apps","pages":[{"title":"Create app","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/apps","href":"/api-reference/hosting--apps/create-app"},{"title":"List apps","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/apps/list","href":"/api-reference/hosting--apps/list-apps"},{"title":"Get app","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /hosting/apps/{uuid}","href":"/api-reference/hosting--apps/get-app"},{"title":"Update app","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /hosting/apps/{uuid}","href":"/api-reference/hosting--apps/update-app"},{"title":"Remove app","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /hosting/apps/{uuid}","href":"/api-reference/hosting--apps/remove-app"}]},{"group":"Hosting - Workers","pages":[{"title":"Create worker","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/workers","href":"/api-reference/hosting--workers/create-worker"},{"title":"List workers","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/workers/list","href":"/api-reference/hosting--workers/list-workers"},{"title":"Get worker","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /hosting/workers/{uuid}","href":"/api-reference/hosting--workers/get-worker"},{"title":"Update worker","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /hosting/workers/{uuid}","href":"/api-reference/hosting--workers/update-worker"},{"title":"Remove worker","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /hosting/workers/{uuid}","href":"/api-reference/hosting--workers/remove-worker"}]},{"group":"Hosting - Deployments","pages":[{"title":"Create deployment","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/deployments","href":"/api-reference/hosting--deployments/create-deployment"},{"title":"List deployments","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/deployments/list","href":"/api-reference/hosting--deployments/list-deployments"},{"title":"Count deployments","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/deployments/count","href":"/api-reference/hosting--deployments/count-deployments"},{"title":"Get promoted deployment","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /hosting/deployments/promoted","href":"/api-reference/hosting--deployments/get-promoted-deployment"},{"title":"Promote deployment","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/deployments/promote","href":"/api-reference/hosting--deployments/promote-deployment"},{"title":"Cancel deployment","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/deployments/cancel","href":"/api-reference/hosting--deployments/cancel-deployment"},{"title":"Get deployment","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /hosting/deployments/{uuid}","href":"/api-reference/hosting--deployments/get-deployment"},{"title":"Get deployment build log URL","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /hosting/deployments/{uuid}/build-log-url","href":"/api-reference/hosting--deployments/get-deployment-build-log-url"},{"title":"Get deployment source archive URL","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /hosting/deployments/{uuid}/source-archive-url","href":"/api-reference/hosting--deployments/get-deployment-source-archive-url"}]},{"group":"Hosting - Env Vars","pages":[{"title":"List env vars","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /hosting/env-vars","href":"/api-reference/hosting--env-vars/list-env-vars"},{"title":"Create env var","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/env-vars","href":"/api-reference/hosting--env-vars/create-env-var"},{"title":"Remove env var","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /hosting/env-vars/{uuid}","href":"/api-reference/hosting--env-vars/remove-env-var"},{"title":"Update env var","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json patch /hosting/env-vars/{uuid}","href":"/api-reference/hosting--env-vars/update-env-var"}]},{"group":"Hosting - Custom Domains","pages":[{"title":"List custom domains","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /hosting/custom-domains/list","href":"/api-reference/hosting--custom-domains/list-custom-domains"},{"title":"Attach custom domain","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/custom-domains","href":"/api-reference/hosting--custom-domains/attach-custom-domain"},{"title":"Get custom domain","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /hosting/custom-domains/{uuid}","href":"/api-reference/hosting--custom-domains/get-custom-domain"},{"title":"Detach custom domain","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /hosting/custom-domains/{uuid}","href":"/api-reference/hosting--custom-domains/detach-custom-domain"},{"title":"Refresh custom domain status","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/custom-domains/{uuid}/refresh-status","href":"/api-reference/hosting--custom-domains/refresh-custom-domain-status"}]},{"group":"Hosting - Analytics","pages":[{"title":"List analytics events","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/analytics/list","href":"/api-reference/hosting--analytics/list-analytics-events"},{"title":"Count analytics events","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/analytics/count","href":"/api-reference/hosting--analytics/count-analytics-events"}]},{"group":"Hosting - Logs","pages":[{"title":"Get log","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/logs/get","href":"/api-reference/hosting--logs/get-log"},{"title":"List logs","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/logs/list","href":"/api-reference/hosting--logs/list-logs"},{"title":"Count logs","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /hosting/logs/count","href":"/api-reference/hosting--logs/count-logs"}]},{"group":"OAuth - Grants","pages":[{"title":"List OAuth grants","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /oauth/grants/list","href":"/api-reference/oauth--grants/list-oauth-grants"},{"title":"Revoke OAuth grant","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /oauth/grants/{grantUuid}","href":"/api-reference/oauth--grants/revoke-oauth-grant"}]},{"group":"Mailbox Management - Mailboxes","pages":[{"title":"List mailboxes","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /mailboxManagement/mailboxes","href":"/api-reference/mailbox-management--mailboxes/list-mailboxes"},{"title":"Create mailbox","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /mailboxManagement/mailboxes","href":"/api-reference/mailbox-management--mailboxes/create-mailbox"},{"title":"Get mailbox","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /mailboxManagement/mailboxes/{uuid}","href":"/api-reference/mailbox-management--mailboxes/get-mailbox"},{"title":"Update mailbox","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /mailboxManagement/mailboxes/{uuid}","href":"/api-reference/mailbox-management--mailboxes/update-mailbox"},{"title":"Delete mailbox","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /mailboxManagement/mailboxes/{uuid}","href":"/api-reference/mailbox-management--mailboxes/delete-mailbox"},{"title":"Refresh mailbox status","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /mailboxManagement/mailboxes/{uuid}/refresh-status","href":"/api-reference/mailbox-management--mailboxes/refresh-mailbox-status"},{"title":"Get mailbox warm-up stats","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /mailboxManagement/mailboxes/{uuid}/warmup","href":"/api-reference/mailbox-management--mailboxes/get-mailbox-warm-up-stats"},{"title":"Start mailbox warm-up","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /mailboxManagement/mailboxes/{uuid}/warmup","href":"/api-reference/mailbox-management--mailboxes/start-mailbox-warm-up"},{"title":"Stop mailbox warm-up","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /mailboxManagement/mailboxes/{uuid}/warmup","href":"/api-reference/mailbox-management--mailboxes/stop-mailbox-warm-up"},{"title":"Update mailbox warm-up","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json patch /mailboxManagement/mailboxes/{uuid}/warmup","href":"/api-reference/mailbox-management--mailboxes/update-mailbox-warm-up"},{"title":"Get mailbox send allowance","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /mailboxManagement/mailboxes/{uuid}/send-allowance","href":"/api-reference/mailbox-management--mailboxes/get-mailbox-send-allowance"},{"title":"Get mailbox pricing","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /mailboxManagement/pricing","href":"/api-reference/mailbox-management--mailboxes/get-mailbox-pricing"}]},{"group":"Mailbox Management - Messages","pages":[{"title":"List messages","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /mailboxManagement/messages","href":"/api-reference/mailbox-management--messages/list-messages"},{"title":"Get message","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /mailboxManagement/messages/{uuid}","href":"/api-reference/mailbox-management--messages/get-message"}]},{"group":"Mailbox Management - Threads","pages":[{"title":"List threads","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /mailboxManagement/threads","href":"/api-reference/mailbox-management--threads/list-threads"},{"title":"Get thread","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /mailboxManagement/threads/{uuid}","href":"/api-reference/mailbox-management--threads/get-thread"}]},{"group":"Mailbox Management - Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /mailboxManagement/events","href":"/api-reference/mailbox-management--events/list-events"}]},{"group":"Mailbox Management - Suppressions","pages":[{"title":"List suppressions","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /mailboxManagement/suppressions","href":"/api-reference/mailbox-management--suppressions/list-suppressions"},{"title":"Suppress an address","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /mailboxManagement/suppressions","href":"/api-reference/mailbox-management--suppressions/suppress-an-address"}]},{"group":"Orchestration - Actions","pages":[{"title":"Execute action","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/actions/execute","href":"/api-reference/orchestration--actions/execute-action"},{"title":"Execute action batch","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/actions/execute-batch","href":"/api-reference/orchestration--actions/execute-action-batch"},{"title":"List actions","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/actions/list","href":"/api-reference/orchestration--actions/list-actions"},{"title":"Get action output schema","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/actions/get-output-schema","href":"/api-reference/orchestration--actions/get-action-output-schema"}]},{"group":"Orchestration - Batches","pages":[{"title":"Create batch","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/batches","href":"/api-reference/orchestration--batches/create-batch"},{"title":"List batches","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/batches/list","href":"/api-reference/orchestration--batches/list-batches"},{"title":"Get batch","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/batches/{uuid}","href":"/api-reference/orchestration--batches/get-batch"},{"title":"Cancel batch","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/batches/{uuid}/cancel","href":"/api-reference/orchestration--batches/cancel-batch"},{"title":"Download batch","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/batches/{uuid}/download","href":"/api-reference/orchestration--batches/download-batch"},{"title":"Preview batch","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/batches/preview","href":"/api-reference/orchestration--batches/preview-batch"}]},{"group":"Orchestration - Nodes","pages":[{"title":"Compute node","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/nodes/compute","href":"/api-reference/orchestration--nodes/compute-node"},{"title":"Execute node","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/nodes/execute","href":"/api-reference/orchestration--nodes/execute-node"},{"title":"Validate nodes","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/nodes/validate","href":"/api-reference/orchestration--nodes/validate-nodes"}]},{"group":"Orchestration - Plays","pages":[{"title":"Create play","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/plays","href":"/api-reference/orchestration--plays/create-play"},{"title":"List plays","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/plays/list","href":"/api-reference/orchestration--plays/list-plays"},{"title":"Get play","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/plays/{uuid}","href":"/api-reference/orchestration--plays/get-play"},{"title":"Update play","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /orchestration/plays/{uuid}","href":"/api-reference/orchestration--plays/update-play"},{"title":"Remove play","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /orchestration/plays/{uuid}","href":"/api-reference/orchestration--plays/remove-play"}]},{"group":"Orchestration - Spans","pages":[{"title":"List spans","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/spans/list","href":"/api-reference/orchestration--spans/list-spans"},{"title":"Count spans","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/spans/count","href":"/api-reference/orchestration--spans/count-spans"}]},{"group":"Orchestration - Query","pages":[{"title":"Execute SQL query","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/query","href":"/api-reference/orchestration--query/execute-sql-query"}]},{"group":"Orchestration - Records","pages":[{"title":"List records","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/records/list","href":"/api-reference/orchestration--records/list-records"},{"title":"Count records","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/records/count","href":"/api-reference/orchestration--records/count-records"},{"title":"Download records","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/records/download","href":"/api-reference/orchestration--records/download-records"},{"title":"Download record outputs","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/records/download-outputs","href":"/api-reference/orchestration--records/download-record-outputs"},{"title":"Get record metrics","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/records/metrics","href":"/api-reference/orchestration--records/get-record-metrics"},{"title":"Cancel records","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/records/cancel","href":"/api-reference/orchestration--records/cancel-records"}]},{"group":"Orchestration - Releases","pages":[{"title":"Deploy draft release","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/releases/draft/deploy","href":"/api-reference/orchestration--releases/deploy-draft-release"},{"title":"List releases","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/releases/list","href":"/api-reference/orchestration--releases/list-releases"},{"title":"Get draft release","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/releases/draft","href":"/api-reference/orchestration--releases/get-draft-release"},{"title":"Get deployed release","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/releases/deployed","href":"/api-reference/orchestration--releases/get-deployed-release"},{"title":"Get release","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/releases/{uuid}","href":"/api-reference/orchestration--releases/get-release"},{"title":"Update draft release","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/releases/draft/update","href":"/api-reference/orchestration--releases/update-draft-release"}]},{"group":"Orchestration - Runs","pages":[{"title":"Create run","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/runs","href":"/api-reference/orchestration--runs/create-run"},{"title":"List runs","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/runs/list","href":"/api-reference/orchestration--runs/list-runs"},{"title":"Count runs","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/runs/count","href":"/api-reference/orchestration--runs/count-runs"},{"title":"Download runs","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/runs/download","href":"/api-reference/orchestration--runs/download-runs"},{"title":"Download run outputs","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/runs/download-outputs","href":"/api-reference/orchestration--runs/download-run-outputs"},{"title":"Get run metrics","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/runs/metrics","href":"/api-reference/orchestration--runs/get-run-metrics"},{"title":"Get run","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/runs/{uuid}","href":"/api-reference/orchestration--runs/get-run"},{"title":"Cancel runs","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/runs/cancel","href":"/api-reference/orchestration--runs/cancel-runs"}]},{"group":"Orchestration - Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/templates/list","href":"/api-reference/orchestration--templates/list-templates"},{"title":"Get template","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/templates/{slug}","href":"/api-reference/orchestration--templates/get-template"},{"title":"Get template documentation","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/templates/{slug}/documentation","href":"/api-reference/orchestration--templates/get-template-documentation"}]},{"group":"Orchestration - Tools","pages":[{"title":"Create tool","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/tools","href":"/api-reference/orchestration--tools/create-tool"},{"title":"List tools","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/tools/list","href":"/api-reference/orchestration--tools/list-tools"},{"title":"Get tool","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/tools/{uuid}","href":"/api-reference/orchestration--tools/get-tool"},{"title":"Update tool","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /orchestration/tools/{uuid}","href":"/api-reference/orchestration--tools/update-tool"},{"title":"Remove tool","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /orchestration/tools/{uuid}","href":"/api-reference/orchestration--tools/remove-tool"}]},{"group":"Orchestration - Traces","pages":[{"title":"List traces","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/traces/list","href":"/api-reference/orchestration--traces/list-traces"},{"title":"Count traces","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /orchestration/traces/count","href":"/api-reference/orchestration--traces/count-traces"},{"title":"Get trace","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/traces/{uuid}","href":"/api-reference/orchestration--traces/get-trace"}]},{"group":"Orchestration - Workflows","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/workflows/list","href":"/api-reference/orchestration--workflows/list-workflows"},{"title":"Get workflow","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /orchestration/workflows/{uuid}","href":"/api-reference/orchestration--workflows/get-workflow"}]},{"group":"Revenue Organization - Allocations","pages":[{"title":"List allocations","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /revenueOrganization/allocations/list","href":"/api-reference/revenue-organization--allocations/list-allocations"},{"title":"Get allocation","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /revenueOrganization/allocations/{uuid}","href":"/api-reference/revenue-organization--allocations/get-allocation"},{"title":"Remove allocation","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /revenueOrganization/allocations/{uuid}","href":"/api-reference/revenue-organization--allocations/remove-allocation"},{"title":"Sync allocations","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /revenueOrganization/allocations/sync","href":"/api-reference/revenue-organization--allocations/sync-allocations"}]},{"group":"Revenue Organization - Capacities","pages":[{"title":"Create capacity","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /revenueOrganization/capacities","href":"/api-reference/revenue-organization--capacities/create-capacity"},{"title":"List capacities","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /revenueOrganization/capacities/list","href":"/api-reference/revenue-organization--capacities/list-capacities"},{"title":"Get capacity","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /revenueOrganization/capacities/{uuid}","href":"/api-reference/revenue-organization--capacities/get-capacity"},{"title":"Update capacity","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /revenueOrganization/capacities/{uuid}","href":"/api-reference/revenue-organization--capacities/update-capacity"},{"title":"Remove capacity","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /revenueOrganization/capacities/{uuid}","href":"/api-reference/revenue-organization--capacities/remove-capacity"}]},{"group":"Revenue Organization - Members","pages":[{"title":"List members","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /revenueOrganization/members/list","href":"/api-reference/revenue-organization--members/list-members"},{"title":"Get member","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /revenueOrganization/members/{uuid}","href":"/api-reference/revenue-organization--members/get-member"},{"title":"Update member","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /revenueOrganization/members/{uuid}","href":"/api-reference/revenue-organization--members/update-member"},{"title":"Sync members","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /revenueOrganization/members/sync","href":"/api-reference/revenue-organization--members/sync-members"},{"title":"Archive member","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /revenueOrganization/members/{uuid}/archive","href":"/api-reference/revenue-organization--members/archive-member"},{"title":"Unarchive member","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /revenueOrganization/members/{uuid}/unarchive","href":"/api-reference/revenue-organization--members/unarchive-member"}]},{"group":"Revenue Organization - Territories","pages":[{"title":"Create territory","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /revenueOrganization/territories","href":"/api-reference/revenue-organization--territories/create-territory"},{"title":"List territories","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /revenueOrganization/territories/list","href":"/api-reference/revenue-organization--territories/list-territories"},{"title":"Get territory","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /revenueOrganization/territories/{uuid}","href":"/api-reference/revenue-organization--territories/get-territory"},{"title":"Update territory","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /revenueOrganization/territories/{uuid}","href":"/api-reference/revenue-organization--territories/update-territory"},{"title":"Remove territory","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /revenueOrganization/territories/{uuid}","href":"/api-reference/revenue-organization--territories/remove-territory"}]},{"group":"Segmentation - Changes","pages":[{"title":"List changes","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /segmentation/changes/list","href":"/api-reference/segmentation--changes/list-changes"},{"title":"Get change","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /segmentation/changes/{uuid}","href":"/api-reference/segmentation--changes/get-change"},{"title":"Fetch change data","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /segmentation/changes/{uuid}/fetch","href":"/api-reference/segmentation--changes/fetch-change-data"},{"title":"Download change data","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /segmentation/changes/{uuid}/download","href":"/api-reference/segmentation--changes/download-change-data"}]},{"group":"Segmentation - Records","pages":[{"title":"Fetch records","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /segmentation/records/fetch","href":"/api-reference/segmentation--records/fetch-records"}]},{"group":"Segmentation - Segments","pages":[{"title":"Create segment","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /segmentation/segments","href":"/api-reference/segmentation--segments/create-segment"},{"title":"List segments","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /segmentation/segments/list","href":"/api-reference/segmentation--segments/list-segments"},{"title":"Get segment","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /segmentation/segments/{uuid}","href":"/api-reference/segmentation--segments/get-segment"},{"title":"Update segment","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /segmentation/segments/{uuid}","href":"/api-reference/segmentation--segments/update-segment"},{"title":"Remove segment","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /segmentation/segments/{uuid}","href":"/api-reference/segmentation--segments/remove-segment"},{"title":"Fetch segment data","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /segmentation/segments/fetch","href":"/api-reference/segmentation--segments/fetch-segment-data"},{"title":"Download segment data","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /segmentation/segments/download","href":"/api-reference/segmentation--segments/download-segment-data"},{"title":"Get segment metrics","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /segmentation/segments/{uuid}/metrics","href":"/api-reference/segmentation--segments/get-segment-metrics"}]},{"group":"Storage - Columns","pages":[{"title":"Update column","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /storage/columns","href":"/api-reference/storage--columns/update-column"},{"title":"Create column","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/columns","href":"/api-reference/storage--columns/create-column"},{"title":"Remove column","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /storage/columns","href":"/api-reference/storage--columns/remove-column"},{"title":"List model columns","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/columns/list","href":"/api-reference/storage--columns/list-model-columns"},{"title":"Autocomplete columns","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/columns/autocomplete","href":"/api-reference/storage--columns/autocomplete-columns"},{"title":"Check column exists by slug","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/columns/existsBySlug","href":"/api-reference/storage--columns/check-column-exists-by-slug"},{"title":"Reorder columns","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /storage/columns/reorder","href":"/api-reference/storage--columns/reorder-columns"},{"title":"Insert custom column values","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/columns/insertCustomValues","href":"/api-reference/storage--columns/insert-custom-column-values"},{"title":"Insert custom column values (bulk)","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/columns/insertCustomValuesBulk","href":"/api-reference/storage--columns/insert-custom-column-values-bulk"}]},{"group":"Storage - Datasets","pages":[{"title":"List datasets","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/datasets/list","href":"/api-reference/storage--datasets/list-datasets"},{"title":"Get dataset","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/datasets/{uuid}","href":"/api-reference/storage--datasets/get-dataset"}]},{"group":"Storage - Models","pages":[{"title":"Create model","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/models","href":"/api-reference/storage--models/create-model"},{"title":"List models","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/models/list","href":"/api-reference/storage--models/list-models"},{"title":"Check model exists by slug","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/models/existsBySlug","href":"/api-reference/storage--models/check-model-exists-by-slug"},{"title":"Get model","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/models/{uuid}","href":"/api-reference/storage--models/get-model"},{"title":"Update model","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /storage/models/{uuid}","href":"/api-reference/storage--models/update-model"},{"title":"Remove model","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /storage/models/{uuid}","href":"/api-reference/storage--models/remove-model"},{"title":"Get model DDL","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/models/{uuid}/ddl","href":"/api-reference/storage--models/get-model-ddl"},{"title":"Preview model","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/models/preview","href":"/api-reference/storage--models/preview-model"},{"title":"Preview model count","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/models/previewCount","href":"/api-reference/storage--models/preview-model-count"},{"title":"Refresh model","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/models/{uuid}/refresh","href":"/api-reference/storage--models/refresh-model"}]},{"group":"Storage - Records","pages":[{"title":"Get record","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/records/get","href":"/api-reference/storage--records/get-record"},{"title":"List records","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/records/list","href":"/api-reference/storage--records/list-records"},{"title":"Create record","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/records/create","href":"/api-reference/storage--records/create-record"},{"title":"Create records (bulk)","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/records/createBulk","href":"/api-reference/storage--records/create-records-bulk"},{"title":"Update record","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /storage/records/update","href":"/api-reference/storage--records/update-record"},{"title":"Update records (bulk)","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /storage/records/updateBulk","href":"/api-reference/storage--records/update-records-bulk"},{"title":"Remove record","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /storage/records/remove","href":"/api-reference/storage--records/remove-record"},{"title":"Remove records (bulk)","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /storage/records/removeBulk","href":"/api-reference/storage--records/remove-records-bulk"}]},{"group":"Storage - Query","pages":[{"title":"Execute SQL query","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/query","href":"/api-reference/storage--query/execute-sql-query"},{"title":"Download SQL query results","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/query/download","href":"/api-reference/storage--query/download-sql-query-results"}]},{"group":"Storage - Relationships","pages":[{"title":"List relationships","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/relationships/list","href":"/api-reference/storage--relationships/list-relationships"},{"title":"Get relationship","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/relationships/{uuid}","href":"/api-reference/storage--relationships/get-relationship"},{"title":"Set relationship","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/relationships","href":"/api-reference/storage--relationships/set-relationship"}]},{"group":"Storage - Runs","pages":[{"title":"List runs","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /storage/runs/list","href":"/api-reference/storage--runs/list-runs"},{"title":"Create run","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/runs","href":"/api-reference/storage--runs/create-run"},{"title":"Cancel run","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /storage/runs/{uuid}/cancel","href":"/api-reference/storage--runs/cancel-run"}]},{"group":"System of Record Integration - Clients","pages":[{"title":"List clients","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /systemOfRecordIntegration/clients/list","href":"/api-reference/system-of-record-integration--clients/list-clients"},{"title":"Query client","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /systemOfRecordIntegration/clients/query","href":"/api-reference/system-of-record-integration--clients/query-client"},{"title":"Fetch client data","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /systemOfRecordIntegration/clients/fetch","href":"/api-reference/system-of-record-integration--clients/fetch-client-data"},{"title":"Download client data","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /systemOfRecordIntegration/clients/download","href":"/api-reference/system-of-record-integration--clients/download-client-data"},{"title":"Get client documentation","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /systemOfRecordIntegration/clients/{slug}/documentation","href":"/api-reference/system-of-record-integration--clients/get-client-documentation"}]},{"group":"System of Record Integration - Logs","pages":[{"title":"List logs","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /systemOfRecordIntegration/logs/list","href":"/api-reference/system-of-record-integration--logs/list-logs"},{"title":"Get log metrics","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /systemOfRecordIntegration/logs/metrics","href":"/api-reference/system-of-record-integration--logs/get-log-metrics"}]},{"group":"System of Record Integration - Systems of Record","pages":[{"title":"List systems of record","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /systemOfRecordIntegration/systemOfRecords","href":"/api-reference/system-of-record-integration--systems-of-record/list-systems-of-record"},{"title":"Create system of record","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /systemOfRecordIntegration/systemOfRecords","href":"/api-reference/system-of-record-integration--systems-of-record/create-system-of-record"},{"title":"Get system of record","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /systemOfRecordIntegration/systemOfRecords/{uuid}","href":"/api-reference/system-of-record-integration--systems-of-record/get-system-of-record"},{"title":"Update system of record","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /systemOfRecordIntegration/systemOfRecords/{uuid}","href":"/api-reference/system-of-record-integration--systems-of-record/update-system-of-record"},{"title":"Remove system of record","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /systemOfRecordIntegration/systemOfRecords/{uuid}","href":"/api-reference/system-of-record-integration--systems-of-record/remove-system-of-record"},{"title":"Migrate system of record","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /systemOfRecordIntegration/systemOfRecords/{uuid}/migrate","href":"/api-reference/system-of-record-integration--systems-of-record/migrate-system-of-record"},{"title":"Cutover system of record","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /systemOfRecordIntegration/systemOfRecords/{uuid}/cutover","href":"/api-reference/system-of-record-integration--systems-of-record/cutover-system-of-record"}]},{"group":"User Management - Users","pages":[{"title":"Get current user","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /userManagement/users/current","href":"/api-reference/user-management--users/get-current-user"},{"title":"Update current user","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /userManagement/users/current","href":"/api-reference/user-management--users/update-current-user"}]},{"group":"Workspace Management - Files","pages":[{"title":"Fetch file","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/files/fetch","href":"/api-reference/workspace-management--files/fetch-file"},{"title":"List file columns","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/files/listColumns","href":"/api-reference/workspace-management--files/list-file-columns"},{"title":"Upload file","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/files/upload","href":"/api-reference/workspace-management--files/upload-file"},{"title":"Create multipart upload","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/files/multipart/create","href":"/api-reference/workspace-management--files/create-multipart-upload"},{"title":"Sign multipart upload part","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/files/multipart/sign","href":"/api-reference/workspace-management--files/sign-multipart-upload-part"},{"title":"Complete multipart upload","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/files/multipart/complete","href":"/api-reference/workspace-management--files/complete-multipart-upload"},{"title":"Abort multipart upload","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/files/multipart/abort","href":"/api-reference/workspace-management--files/abort-multipart-upload"}]},{"group":"Workspace Management - Folders","pages":[{"title":"Create folder","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/folders","href":"/api-reference/workspace-management--folders/create-folder"},{"title":"List folders","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/folders/list","href":"/api-reference/workspace-management--folders/list-folders"},{"title":"Get folder","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/folders/{uuid}","href":"/api-reference/workspace-management--folders/get-folder"},{"title":"Update folder","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /workspaceManagement/folders/{uuid}","href":"/api-reference/workspace-management--folders/update-folder"},{"title":"Remove folder","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /workspaceManagement/folders/{uuid}","href":"/api-reference/workspace-management--folders/remove-folder"}]},{"group":"Workspace Management - States","pages":[{"title":"Create state","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/states","href":"/api-reference/workspace-management--states/create-state"},{"title":"List states","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/states/list","href":"/api-reference/workspace-management--states/list-states"},{"title":"Get state","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/states/{uuid}","href":"/api-reference/workspace-management--states/get-state"},{"title":"Update state","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /workspaceManagement/states/{uuid}","href":"/api-reference/workspace-management--states/update-state"},{"title":"Remove state","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /workspaceManagement/states/{uuid}","href":"/api-reference/workspace-management--states/remove-state"},{"title":"Acquire state lock","description":"Take the deploy lock on a state. Refused while another run holds an unexpired lock, unless forced (POST /workspaceManagement/states/{uuid}/lock/acquire).","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/states/{uuid}/lock/acquire","href":"/api-reference/workspace-management--states/acquire-state-lock"},{"title":"Release state lock","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/states/{uuid}/lock/release","href":"/api-reference/workspace-management--states/release-state-lock"},{"title":"Connect repository","description":"Connect a GitHub repository to this project, so Cargo plans its pull requests and deploys its production branch as a service user. Refused unless the Cargo GitHub app is installed on the repository and the workspace's GitHub account administers it, when the project is already connected, and when that repository directory is connected elsewhere. (POST /workspaceManagement/states/{uuid}/connection).","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/states/{uuid}/connection","href":"/api-reference/workspace-management--states/connect-repository"},{"title":"Disconnect repository","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /workspaceManagement/states/{uuid}/connection","href":"/api-reference/workspace-management--states/disconnect-repository"},{"title":"List deploy workflows","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/states/{uuid}/connection/deployWorkflows","href":"/api-reference/workspace-management--states/list-deploy-workflows"},{"title":"List runs","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/states/{uuid}/runs","href":"/api-reference/workspace-management--states/list-runs"}]},{"group":"Workspace Management - Roles","pages":[{"title":"List roles","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/roles","href":"/api-reference/workspace-management--roles/list-roles"},{"title":"Create role","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/roles","href":"/api-reference/workspace-management--roles/create-role"},{"title":"List roles","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/roles/list","href":"/api-reference/workspace-management--roles/list-roles-1"},{"title":"Check role exists by slug","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/roles/existsBySlug","href":"/api-reference/workspace-management--roles/check-role-exists-by-slug"},{"title":"Get role","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/roles/{uuid}","href":"/api-reference/workspace-management--roles/get-role"},{"title":"Remove role","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /workspaceManagement/roles/{uuid}","href":"/api-reference/workspace-management--roles/remove-role"},{"title":"Update role","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json patch /workspaceManagement/roles/{uuid}","href":"/api-reference/workspace-management--roles/update-role"}]},{"group":"Workspace Management - Reports","pages":[{"title":"Create report","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/reports","href":"/api-reference/workspace-management--reports/create-report"}]},{"group":"Workspace Management - Sessions","pages":[{"title":"Upsert session","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/sessions","href":"/api-reference/workspace-management--sessions/upsert-session"}]},{"group":"Workspace Management - Environment Variables","pages":[{"title":"List environment variables","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/env-vars","href":"/api-reference/workspace-management--environment-variables/list-environment-variables"},{"title":"Create environment variable","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/env-vars","href":"/api-reference/workspace-management--environment-variables/create-environment-variable"},{"title":"Remove environment variable","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /workspaceManagement/env-vars/{uuid}","href":"/api-reference/workspace-management--environment-variables/remove-environment-variable"},{"title":"Update environment variable","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json patch /workspaceManagement/env-vars/{uuid}","href":"/api-reference/workspace-management--environment-variables/update-environment-variable"}]},{"group":"Workspace Management - Tokens","pages":[{"title":"Create token","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/tokens","href":"/api-reference/workspace-management--tokens/create-token"},{"title":"List tokens","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/tokens/list","href":"/api-reference/workspace-management--tokens/list-tokens"},{"title":"Remove token","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /workspaceManagement/tokens/{uuid}","href":"/api-reference/workspace-management--tokens/remove-token"},{"title":"Update token","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json patch /workspaceManagement/tokens/{uuid}","href":"/api-reference/workspace-management--tokens/update-token"}]},{"group":"Workspace Management - Users","pages":[{"title":"Create user","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/users","href":"/api-reference/workspace-management--users/create-user"},{"title":"Remove user","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /workspaceManagement/users","href":"/api-reference/workspace-management--users/remove-user"},{"title":"List users","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/users/list","href":"/api-reference/workspace-management--users/list-users"},{"title":"Get current user","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/users/current","href":"/api-reference/workspace-management--users/get-current-user"},{"title":"Update user","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /workspaceManagement/users/{uuid}","href":"/api-reference/workspace-management--users/update-user"},{"title":"Upsert user permissions","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/users/permissions","href":"/api-reference/workspace-management--users/upsert-user-permissions"},{"title":"Remove user permission","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json delete /workspaceManagement/users/{userUuid}/permissions","href":"/api-reference/workspace-management--users/remove-user-permission"}]},{"group":"Workspace Management - Workspaces","pages":[{"title":"Create workspace","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json post /workspaceManagement/workspaces","href":"/api-reference/workspace-management--workspaces/create-workspace"},{"title":"List workspaces","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/workspaces/list","href":"/api-reference/workspace-management--workspaces/list-workspaces"},{"title":"Get workspace login providers","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/workspaces/loginProviders","href":"/api-reference/workspace-management--workspaces/get-workspace-login-providers"},{"title":"Get current workspace","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json get /workspaceManagement/workspaces/current","href":"/api-reference/workspace-management--workspaces/get-current-workspace"},{"title":"Update current workspace","deprecated":null,"version":null,"openapi":"https://api.getcargo.io/openapi.json put /workspaceManagement/workspaces/current","href":"/api-reference/workspace-management--workspaces/update-current-workspace"}]}]}]},"title":"Release state lock - Cargo | Go-to-Market Infrastructure for Coding Agents","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}