Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however
internal consumers must provide a JWT id_token issued by our IdP.
The Project represents a deployable unit within our platform that includes both the functional components (files) and configuration. It serves as the backbone of custom or predefined functionalities, allowing organizations to create, update, and manage APIs and projects.
DynamicVariablesSchema is the JSON schema for the project's dynamic variables.
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Versori User Documentation","colors":{"primary":"#6EB0D8","light":"#6EB0D8","dark":"#6EB0D8"},"logo":{"light":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=be10819ca139d000a6edaef35334c0af","dark":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark-white.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=1568a99dadb6fa8dfc83009eba877497"},"favicon":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=1765cb3e4363526dd85cf7c576a8f68f","api":{"openapi":["openapi/connect-api-v1.yaml","openapi/embedded-api-v1.yaml","openapi/organisations-api-v1.yaml","openapi/switchboard-api-v1alpha1.yaml","openapi/platform-api.yaml"],"playground":{"display":"interactive","proxy":false},"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":["https://platform.versori.com/api"]}},"background":{"decoration":"gradient","color":{"light":"#ffffff","dark":"#151919"}},"search":{"prompt":"Search the docs..."},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"versori","hasAudioNarration":false,"actualSubdomain":"versori","customDomains":["docs.versori.com"],"gitSource":{"type":"github","owner":"versori","repo":"user-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad09d9413e5d952c6a7407c","collectionId":"314b2d25-0631-41c2-aeae-fdf8104d942c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad09d9413e5d952c6a7407c"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad09d9413e5d952c6a7407c","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":525},{"language":"default","tag":"Platform API","count":115},{"language":"default","tag":"Switchboard API","count":82},{"language":"default","tag":"Endpoints","count":62},{"language":"default","tag":"Connect API","count":41},{"language":"default","tag":"Organisations API","count":38},{"language":"default","tag":"Documentation","count":32},{"language":"default","tag":"projects","count":32},{"language":"default","tag":"User Guide","count":31},{"language":"default","tag":"CLI","count":27}]},"assistantConfig":{},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":true},"customCss":[{"filePath":"style.css","content":"#content-area.max-w-xl{max-width:64rem}.whitespace-pre-line{white-space:unset}"}],"page":{"pagePath":"api-reference/platform-api/projects/suspend-project","slug":"/api-reference/platform-api/projects/suspend-project","pageMetadata":{"title":"Suspend Project","description":"Suspend project will stop the project but not delete it. It can be deployed later again.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/suspend","href":"/api-reference/platform-api/projects/suspend-project","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Suspend project will stop the project but not delete it. It can be deployed later again.\"\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":"Suspend Project","description":"Suspend project will stop the project but not delete it. It can be deployed later again.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/suspend","href":"/api-reference/platform-api/projects/suspend-project","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"SuspendProject","summary":"Suspend Project","description":"Suspend project will stop the project but not delete it. It can be deployed later again.","tags":["projects"],"responses":{"200":"da7b1977-5cfd-4422-8cb2-fabd122f949f","default":"56dd3feb-59f9-49f7-ae06-bd566caaff82"},"method":"post","type":"path","servers":["d0eac863-e307-4ad7-a239-2c447e8ba4c0","0bedeed1-5e05-4d49-a0f1-0acdda0da1fe","731967af-8899-446e-b2cf-c9e6c5801b84"],"security":["ad977c79-c846-4804-9548-4d09cb6f8f14","b1012d3e-47bf-44f7-b929-7fdf4592103d"],"path":"/o/{organisation_id}/projects/{project_id}/suspend","baseUrlOptions":["https://platform.versori.com/api/v2","https://platform-staging.versori.com/api/v2","http://localhost:8901"],"title":"Suspend Project","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"e44d36cf-7010-43ee-bf17-56cd9b342088":{"name":"organisation_id","in":"path","required":true,"schema":{"type":"string","format":"ulid","x-go-type":"ulid.ULID","x-go-name":"OrganisationID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"","typeLabel":"string\u003culid>"}},"fbe93a1f-aa21-4576-a723-4ffae7cee436":{"name":"project_id","in":"path","required":true,"schema":{"type":"string","format":"ulid","x-go-type":"ulid.ULID","x-go-name":"ProjectID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"","typeLabel":"string\u003culid>"}},"00377867-269f-4052-a9db-71347f51042d":{"name":"environment","in":"query","required":true,"schema":{"type":"string","description":"The environment to suspend the project in.","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"da7b1977-5cfd-4422-8cb2-fabd122f949f":{"description":"OK","content":{"application/json":{"schema":{"description":"The Project represents a deployable unit within our platform that includes both the functional components (files) and configuration. It serves as the backbone of custom or predefined functionalities, allowing organizations to create, update, and manage APIs and projects.\n","type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the project.","format":"ulid","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"id","typeLabel":"string\u003culid>"},"environments":{"type":"array","description":"List of environments for the project.\n","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the environment.","format":"ulid","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"environments.items.[INDEX].id","typeLabel":"string\u003culid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"environments.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","description":"One of running|suspended|error|draft.","isRequired":true,"uniqueKey":"environments.items.[INDEX].status","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"environments.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"environments.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"publicUrl":{"type":"string","isRequired":true,"uniqueKey":"environments.items.[INDEX].publicUrl","typeLabel":"string"},"config":{"type":"object","properties":{"deploymentSpec":{"type":"object","properties":{"replicas":{"type":"integer","uniqueKey":"environments.items.[INDEX].config.deploymentSpec.replicas","typeLabel":"integer"},"autoscaling":{"type":"object","properties":{"maxReplicas":{"type":"integer","description":"The maximum number of replicas that can be created for this environment. When this is configured autoscaling will be enabled for the environment.","uniqueKey":"environments.items.[INDEX].config.deploymentSpec.autoscaling.maxReplicas","typeLabel":"integer"}},"x-go-type-skip-optional-pointer":true,"uniqueKey":"environments.items.[INDEX].config.deploymentSpec.autoscaling","typeLabel":"object"},"staticIP":{"type":"boolean","description":"If set to true it will configure the environment to use the static IP for the execution pool selected by the environment.\n","uniqueKey":"environments.items.[INDEX].config.deploymentSpec.staticIP","typeLabel":"boolean"},"resources":{"type":"object","properties":{"limits":{"type":"object","properties":{"cpu":{"type":"string","uniqueKey":"environments.items.[INDEX].config.deploymentSpec.resources.limits.cpu","typeLabel":"string"},"memory":{"type":"string","uniqueKey":"environments.items.[INDEX].config.deploymentSpec.resources.limits.memory","typeLabel":"string"}},"uniqueKey":"environments.items.[INDEX].config.deploymentSpec.resources.limits","typeLabel":"object"},"requests":{"type":"object","properties":{"cpu":{"type":"string","uniqueKey":"environments.items.[INDEX].config.deploymentSpec.resources.requests.cpu","typeLabel":"string"},"memory":{"type":"string","uniqueKey":"environments.items.[INDEX].config.deploymentSpec.resources.requests.memory","typeLabel":"string"}},"uniqueKey":"environments.items.[INDEX].config.deploymentSpec.resources.requests","typeLabel":"object"}},"uniqueKey":"environments.items.[INDEX].config.deploymentSpec.resources","typeLabel":"object"},"serviceAccountName":{"type":"string","uniqueKey":"environments.items.[INDEX].config.deploymentSpec.serviceAccountName","typeLabel":"string"}},"uniqueKey":"environments.items.[INDEX].config.deploymentSpec","typeLabel":"object"}},"isRequired":true,"uniqueKey":"environments.items.[INDEX].config","typeLabel":"object"},"executionPool":{"type":"string","description":"The name of the execution pool used to deploy this environment.","x-go-type-skip-optional-pointer":true,"uniqueKey":"environments.items.[INDEX].executionPool","typeLabel":"string"},"files":{"type":"array","description":"The currently deployed files for the environment.","items":{"type":"object","properties":{"filename":{"type":"string","description":"The name of the file.","isRequired":true,"uniqueKey":"environments.items.[INDEX].files.items.[INDEX].filename","typeLabel":"string"},"content":{"type":"string","description":"The content of the file.","isRequired":true,"uniqueKey":"environments.items.[INDEX].files.items.[INDEX].content","typeLabel":"string"}},"required":["filename","content"],"uniqueKey":"environments.items.[INDEX].files.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"environments.items.[INDEX].files","typeLabel":"object[]"},"labels":{"type":"object","description":"Labels is a map of key-value pairs that can be used to store arbitrary metadata about a resource.\nKeys must start with a letter and can only contain letters, numbers, and underscores.\nValues can be any string.\n","x-go-type":"map[string]string","x-go-type-skip-optional-pointer":true,"uniqueKey":"environments.items.[INDEX].labels","typeLabel":"object"},"deployedVersion":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the version.","format":"ulid","x-go-name":"ID","x-go-type":"ulid.ULID","x-go-type-skip-optional-pointer":true,"x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"environments.items.[INDEX].deployedVersion.id","typeLabel":"string\u003culid>"},"name":{"type":"string","x-go-type-skip-optional-pointer":true,"description":"The short name for this version. This name must be unique within this project.\n","isRequired":true,"uniqueKey":"environments.items.[INDEX].deployedVersion.name","typeLabel":"string"},"state":{"type":"string","description":"The state of the version.","enum":["draft","failed","ready","superseded"],"isRequired":true,"uniqueKey":"environments.items.[INDEX].deployedVersion.state","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"environments.items.[INDEX].deployedVersion.createdAt","typeLabel":"string\u003cdate-time>"},"description":{"type":"string","x-go-type-skip-optional-pointer":true,"description":"The description of this version.\n","uniqueKey":"environments.items.[INDEX].deployedVersion.description","typeLabel":"string"},"labels":{"type":"object","x-go-type-skip-optional-pointer":true,"x-go-type":"map[string]string","description":"Key-value pairs of strings.\n","uniqueKey":"environments.items.[INDEX].deployedVersion.labels","typeLabel":"object"}},"required":["id","name","state","createdAt"],"uniqueKey":"environments.items.[INDEX].deployedVersion","typeLabel":"object"}},"required":["id","name","status","createdAt","updatedAt","publicUrl","lastDeployedAt","config"],"uniqueKey":"environments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"environments","typeLabel":"object[]"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"currentFiles":{"type":"object","properties":{"files":{"type":"array","description":"The files associated with the project.","items":{"type":"object","properties":{"filename":{"type":"string","description":"The name of the file.","isRequired":true,"uniqueKey":"currentFiles.files.items.[INDEX].filename","typeLabel":"string"},"content":{"type":"string","description":"The content of the file.","isRequired":true,"uniqueKey":"currentFiles.files.items.[INDEX].content","typeLabel":"string"}},"required":["filename","content"],"uniqueKey":"currentFiles.files.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"currentFiles.files","typeLabel":"object[]"},"labels":{"type":"object","description":"The labels associated with the project. Labels are stored as key-value pairs.\nOnly string-string values are allowed\n","x-go-type":"map[string]string","x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"currentFiles.labels","typeLabel":"object"}},"required":["files","labels"],"isRequired":true,"uniqueKey":"currentFiles","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"settings":{"description":"ProjectSettings hold configuration for the project","type":"object","properties":{"acceptCodeChangesAutomatically":{"type":"boolean","uniqueKey":"settings.acceptCodeChangesAutomatically","typeLabel":"boolean"},"testingMockWithAI":{"description":"TestingMockWithAI is a flag that indicates whether the project should use AI to mock in the testing environment \nor use the connection configured on the project. It defaults to using the configured connections\n","type":"boolean","uniqueKey":"settings.testingMockWithAI","typeLabel":"boolean"},"planningChatVersion":{"description":"Version tag for the planning chat feature","type":"string","uniqueKey":"settings.planningChatVersion","typeLabel":"string"},"chatStoredInDB":{"description":"ChatStoredInDB is a flag that indicates whether chat messages are stored in the database\nrather than in NATS. Defaults to false (NATS).\n","type":"boolean","uniqueKey":"settings.chatStoredInDB","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"settings","typeLabel":"object"},"metadata":{"description":"ProjectMetadata hold metadata for the project","type":"object","properties":{"sentimentHistory":{"type":"array","items":{"description":"Sentiment is the sentiment of a project","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"metadata.sentimentHistory.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time>"},"sentimentScore":{"type":"integer","isRequired":true,"uniqueKey":"metadata.sentimentHistory.items.[INDEX].sentimentScore","typeLabel":"integer"},"messageId":{"type":"string","x-go-name":"MessageID","isRequired":true,"uniqueKey":"metadata.sentimentHistory.items.[INDEX].messageId","typeLabel":"string"}},"required":["timestamp","sentimentScore","messageId"],"uniqueKey":"metadata.sentimentHistory.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"metadata.sentimentHistory","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"metadata","typeLabel":"object"},"dynamicVariablesSchema":{"description":"DynamicVariablesSchema is the JSON schema for the project's dynamic variables.\n","type":"object","x-go-type-skip-optional-pointer":true,"x-go-type":"json.RawMessage","uniqueKey":"dynamicVariablesSchema","typeLabel":"object"}},"required":["id","name","environments","createdAt","updatedAt","currentFiles","settings","metadata"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","environments":[{"id":"\u003cstring>","name":"\u003cstring>","status":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","publicUrl":"\u003cstring>","config":{"deploymentSpec":{"replicas":123,"autoscaling":{"maxReplicas":123},"staticIP":true,"resources":{"limits":{"cpu":"\u003cstring>","memory":"\u003cstring>"},"requests":{"cpu":"\u003cstring>","memory":"\u003cstring>"}},"serviceAccountName":"\u003cstring>"}},"executionPool":"\u003cstring>","files":[{"filename":"\u003cstring>","content":"\u003cstring>"}],"labels":{},"deployedVersion":{"id":"\u003cstring>","name":"\u003cstring>","state":"draft","createdAt":"2023-11-07T05:31:56Z","description":"\u003cstring>","labels":{}}}],"name":"\u003cstring>","currentFiles":{"files":[{"filename":"\u003cstring>","content":"\u003cstring>"}],"labels":{}},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","settings":{"acceptCodeChangesAutomatically":true,"testingMockWithAI":true,"planningChatVersion":"\u003cstring>","chatStoredInDB":true},"metadata":{"sentimentHistory":[{"timestamp":"2023-11-07T05:31:56Z","sentimentScore":123,"messageId":"\u003cstring>"}]},"dynamicVariablesSchema":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"56dd3feb-59f9-49f7-ae06-bd566caaff82":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Code is a machine-readable error code.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Message is a human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"fields":{"type":"array","items":{"description":"ErrorField denotes a field which has an error.","type":"object","properties":{"field":{"type":"string","description":"Field is the name of the field which has an error, this may be a path to a nested field, including array\nelements. The format of this field is of the form: \"field1.field2[0].field3\"\n","isRequired":true,"uniqueKey":"fields.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Message is the error message for this specific field.","isRequired":true,"uniqueKey":"fields.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"fields","typeLabel":"object[]"},"details":{"type":"string","x-go-type-skip-optional-pointer":true,"uniqueKey":"details","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","fields":[{"field":"\u003cstring>","message":"\u003cstring>"}],"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ad977c79-c846-4804-9548-4d09cb6f8f14":{"bearerToken":{"description":"Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however\ninternal consumers must provide a JWT id_token issued by our IdP.\n","type":"http","scheme":"bearer","scopes":[]}},"b1012d3e-47bf-44f7-b929-7fdf4592103d":{"cookie":{"description":"Cookie authentication used by the Versori Platform.","type":"apiKey","in":"cookie","name":"cookie","scopes":[]}}},"servers":{"d0eac863-e307-4ad7-a239-2c447e8ba4c0":{"description":"Production","url":"https://platform.versori.com/api/v2"},"0bedeed1-5e05-4d49-a0f1-0acdda0da1fe":{"description":"Staging","url":"https://platform-staging.versori.com/api/v2"},"731967af-8899-446e-b2cf-c9e6c5801b84":{"description":"Development","url":"http://localhost:8901"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however\ninternal consumers must provide a JWT id_token issued by our IdP.\n","type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however\ninternal consumers must provide a JWT id_token issued by our IdP.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerToken","name":"Authorization"}],"title":"bearerToken"},{"schemes":[{"scheme":{"description":"Cookie authentication used by the Versori Platform.","type":"apiKey","in":"cookie","name":"cookie","scopes":[]},"schema":{"title":"cookie","type":"string","description":"Cookie authentication used by the Versori Platform.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"cookie","name":"cookie"}],"title":"cookie"}]},"originalFileLocation":"openapi/platform-api.yaml"},"subdomain":"versori","siteName":"Versori User Documentation","title":"Suspend Project - Versori User Documentation","navMaps":{"firstHrefInVersion":{"Latest":{"href":"/api-reference/platform-api/projects/suspend-project","matchLevel":0},"Legacy":{"href":"/legacy/welcome","matchLevel":4},"v2":{"href":"/v2/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-02-26T16:03:22.460Z","originalFileLocation":"api-reference/platform-api/projects/suspend-project.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=\"Suspend project will stop the project but not delete it. It can be deployed later again.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Versori User Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Suspend Project - Versori User Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Suspend project will stop the project but not delete it. It can be deployed later again.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Versori User Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.versori.com/api-reference/platform-api/projects/suspend-project\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://versori.mintlify.app/_mintlify/api/og/v2?division=projects\u0026amp;title=Suspend+Project\u0026amp;description=Suspend+project+will+stop+the+project+but+not+delete+it.+It+can+be+deployed+later+again.\u0026amp;theme=1ac70f2532992ffb34bd6aef\u0026amp;signature=4a22c327e7e880fc9c5337749d31458e5eda05db0b83b9d20383c3f6be0e295b\">\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=\"Suspend Project - Versori User Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Suspend project will stop the project but not delete it. It can be deployed later again.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://versori.mintlify.app/_mintlify/api/og/v2?division=projects\u0026amp;title=Suspend+Project\u0026amp;description=Suspend+project+will+stop+the+project+but+not+delete+it.+It+can+be+deployed+later+again.\u0026amp;theme=1ac70f2532992ffb34bd6aef\u0026amp;signature=4a22c327e7e880fc9c5337749d31458e5eda05db0b83b9d20383c3f6be0e295b\">\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/versori/JHvcKEOb4limbJz2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Versori User Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6EB0D8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.versori.com/api-reference/platform-api/projects/suspend-project\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/platform-api/projects/suspend-project.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.versori.com/#organization\",\"name\":\"Versori User Documentation\",\"url\":\"https://docs.versori.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=be10819ca139d000a6edaef35334c0af\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.versori.com#website\",\"name\":\"Versori User Documentation\",\"url\":\"https://docs.versori.com\",\"publisher\":{\"@id\":\"https://docs.versori.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.versori.com/api-reference/platform-api/projects/suspend-project#webpage\",\"url\":\"https://docs.versori.com/api-reference/platform-api/projects/suspend-project\",\"name\":\"Suspend Project\",\"description\":\"Suspend project will stop the project but not delete it. It can be deployed later again.\",\"dateModified\":\"2026-02-26T16:03:22.460Z\",\"isPartOf\":{\"@id\":\"https://docs.versori.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.versori.com/api-reference/platform-api/projects/suspend-project#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.versori.com/api-reference/platform-api/projects/suspend-project#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.versori.com/api-reference/platform-api/end_users/activates-a-user-on-an-environment\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"projects\",\"item\":\"https://docs.versori.com/api-reference/platform-api/projects/list-projects-for-organisation\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Suspend Project\",\"item\":\"https://docs.versori.com/api-reference/platform-api/projects/suspend-project\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.versori.com/api-reference/platform-api/projects/suspend-project#apireference\",\"headline\":\"Suspend Project\",\"name\":\"Suspend Project\",\"description\":\"Suspend project will stop the project but not delete it. It can be deployed later again.\",\"url\":\"https://docs.versori.com/api-reference/platform-api/projects/suspend-project\",\"mainEntityOfPage\":{\"@id\":\"https://docs.versori.com/api-reference/platform-api/projects/suspend-project#webpage\"},\"dateModified\":\"2026-02-26T16:03:22.460Z\",\"publisher\":{\"@id\":\"https://docs.versori.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.versori.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Versori User Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Versori User Documentation","nav":{"global":null,"versions":[{"version":"Latest","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/latest/home"}]},{"tab":"User Guide","pages":[{"title":"User Guide","href":"/latest/guides/getting-started/chat"}]},{"tab":"Run SDK","dropdowns":[{"dropdown":"Latest (0.4.x)","groups":[{"group":"Getting Started","expanded":true,"pages":[{"title":"Run SDK","sidebarTitle":"Introduction","href":"/latest/run-sdk/latest/introduction"},{"title":"Connections","href":"/latest/run-sdk/latest/connections"},{"group":"Workflows, Triggers and Tasks","pages":[{"title":"Workflows, Triggers and Tasks","sidebarTitle":"Overview","href":"/latest/run-sdk/latest/workflows"},{"title":"Inputs and outputs","href":"/latest/run-sdk/latest/workflows/inputs-outputs"},{"title":"Task Types","href":"/latest/run-sdk/latest/workflows/task-types"},{"title":"Background","href":"/latest/run-sdk/latest/workflows/background"},{"title":"Catch","href":"/latest/run-sdk/latest/workflows/catch"}]},{"title":"The Context Object","href":"/latest/run-sdk/latest/context"},{"title":"Durable Workflows","href":"/latest/run-sdk/latest/durable-workflows"}]},{"group":"Developers","pages":[{"title":"Developers Overview","sidebarTitle":"Overview","href":"/latest/run-sdk/latest/developers/overview"}]}]}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/latest/cli/introduction"}]},{"tab":"AI Tooling","pages":[{"title":"AI Tooling","href":"/latest/ai-tooling/cloud-agents"}]},{"tab":"API Reference","anchors":[{"anchor":"Overview","pages":[{"title":"Overview","href":"/latest/api-reference/getting-started"}]},{"anchor":"Platform API","icon":"cloud","pages":[{"title":"Getting Started","href":"/latest/api-reference/platform-api/getting-started"},{"group":"API Reference","pages":[{"group":"end_users","pages":[{"title":"Activates a User on an Environment.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/activations","href":"/api-reference/platform-api/end_users/activates-a-user-on-an-environment"},{"title":"List End Users","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/users","href":"/api-reference/platform-api/end_users/list-end-users"},{"title":"Create an End User","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/users","href":"/api-reference/platform-api/end_users/create-an-end-user"},{"title":"Retrieve an End User","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/users/{user_id}","href":"/api-reference/platform-api/end_users/retrieve-an-end-user"},{"title":"Delete an End User","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/users/{user_id}","href":"/api-reference/platform-api/end_users/delete-an-end-user"}]},{"group":"execution_pools","pages":[{"title":"List available execution pools.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/execution-pools","href":"/api-reference/platform-api/execution_pools/list-available-execution-pools"}]},{"group":"projects","pages":[{"title":"List projects for organisation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects","href":"/api-reference/platform-api/projects/list-projects-for-organisation"},{"title":"Create new project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects","href":"/api-reference/platform-api/projects/create-new-project"},{"title":"Get Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}","href":"/api-reference/platform-api/projects/get-project"},{"title":"Update Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}","href":"/api-reference/platform-api/projects/update-project"},{"title":"Delete Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/projects/{project_id}","href":"/api-reference/platform-api/projects/delete-project"},{"title":"Clone Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/clone","href":"/api-reference/platform-api/projects/clone-project"},{"title":"Clone Environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/environments/clone","href":"/api-reference/platform-api/projects/clone-environment"},{"title":"Sync Environments","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/environments/sync","href":"/api-reference/platform-api/projects/sync-environments"},{"title":"Get project variables","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/variables","href":"/api-reference/platform-api/projects/get-project-variables"},{"title":"Set the schema for the project variables","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/variables","href":"/api-reference/platform-api/projects/set-the-schema-for-the-project-variables"},{"title":"Patch the schema for the project's dynamic variables","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml patch /o/{organisation_id}/projects/{project_id}/variables","href":"/api-reference/platform-api/projects/patch-the-schema-for-the-projects-dynamic-variables"},{"title":"Add sentiment data to project history","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/sentiment","href":"/api-reference/platform-api/projects/add-sentiment-data-to-project-history"},{"title":"Get Files","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/files","href":"/api-reference/platform-api/projects/get-files"},{"title":"Update Files","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/files","href":"/api-reference/platform-api/projects/update-files"},{"title":"Patch Files","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml patch /o/{organisation_id}/projects/{project_id}/files","href":"/api-reference/platform-api/projects/patch-files"},{"title":"Change the execution pool of an environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/environments/execution-pools","href":"/api-reference/platform-api/projects/change-the-execution-pool-of-an-environment"},{"title":"Call Integration","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/environments/call","href":"/api-reference/platform-api/projects/call-integration"},{"title":"Deploy Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/deploy","href":"/api-reference/platform-api/projects/deploy-project"},{"title":"Deploy Project Version","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/versions/{version_id}/deploy","href":"/api-reference/platform-api/projects/deploy-project-version"},{"title":"Start Test Container","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/testing/start","href":"/api-reference/platform-api/projects/start-test-container"},{"title":"Start test workflow","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/testing/trigger/{trigger_name}","href":"/api-reference/platform-api/projects/start-test-workflow"},{"title":"Validate Project Files","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/validate","href":"/api-reference/platform-api/projects/validate-project-files"},{"title":"Get Project Logs","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/logs","href":"/api-reference/platform-api/projects/get-project-logs"},{"title":"Search project logs","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/logs","href":"/api-reference/platform-api/projects/search-project-logs"},{"title":"List project traces","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/traces","href":"/api-reference/platform-api/projects/list-project-traces"},{"title":"Get Trace","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/traces/{trace_id}","href":"/api-reference/platform-api/projects/get-trace"},{"title":"Get integration flows","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/workflows","href":"/api-reference/platform-api/projects/get-integration-flows"},{"title":"Get integration flow by name","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/workflows/{flow_name}","href":"/api-reference/platform-api/projects/get-integration-flow-by-name"},{"title":"Update integration flow","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/workflows/{flow_name}","href":"/api-reference/platform-api/projects/update-integration-flow"},{"title":"Delete integration flow","description":null,"deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/projects/{project_id}/workflows/{flow_name}","href":"/api-reference/platform-api/projects/delete-integration-flow"},{"title":"Suspend Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/suspend","href":"/api-reference/platform-api/projects/suspend-project"},{"title":"UpdateEnvironmentConfig updates the environment config for infrastructure.","description":null,"deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/environments/{environment_id}/config","href":"/api-reference/platform-api/projects/updateenvironmentconfig-updates-the-environment-config-for-infrastructure"}]},{"group":"versions","pages":[{"title":"Lists versions for a project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/versions","href":"/api-reference/platform-api/versions/lists-versions-for-a-project"},{"title":"Create a new version for a project.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/versions","href":"/api-reference/platform-api/versions/create-a-new-version-for-a-project"},{"title":"Get Files for a given version","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/versions/{version_id}/files","href":"/api-reference/platform-api/versions/get-files-for-a-given-version"}]},{"group":"connections","pages":[{"title":"List Connections","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/connections","href":"/api-reference/platform-api/connections/list-connections"},{"title":"Create a new connection.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/connections","href":"/api-reference/platform-api/connections/create-a-new-connection"},{"title":"Get a Connection by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/connections/{connection_id}","href":"/api-reference/platform-api/connections/get-a-connection-by-id"},{"title":"Update a Connection by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/connections/{connection_id}","href":"/api-reference/platform-api/connections/update-a-connection-by-id"},{"title":"Delete a Connection by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/connections/{connection_id}","href":"/api-reference/platform-api/connections/delete-a-connection-by-id"},{"title":"Link an existing connection to an environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/connections/{connection_id}/link","href":"/api-reference/platform-api/connections/link-an-existing-connection-to-an-environment"},{"title":"Unlink a connection from an environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/connections/{connection_id}/link","href":"/api-reference/platform-api/connections/unlink-a-connection-from-an-environment"},{"title":"Retrieve the connection for the activations.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environment-systems/{env_system_id}/activations/{activation_id}","href":"/api-reference/platform-api/connections/retrieve-the-connection-for-the-activations"},{"title":"List static connections for project environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/connections","href":"/api-reference/platform-api/connections/list-static-connections-for-project-environment"},{"title":"Initialise OAuth 2.0 Connection","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/oauth2/initialise","href":"/api-reference/platform-api/connections/initialise-oauth-20-connection"},{"title":"Initialise OAuth 1.0 Connection","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/oauth1/initialise","href":"/api-reference/platform-api/connections/initialise-oauth-10-connection"}]},{"group":"automations","pages":[{"title":"List Automations","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations","href":"/api-reference/platform-api/automations/list-automations"},{"title":"Create a new automation.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/automations","href":"/api-reference/platform-api/automations/create-a-new-automation"},{"title":"List Automation Runs","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations/{automation_id}/run","href":"/api-reference/platform-api/automations/list-automation-runs"},{"title":"Run an Automation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/automations/{automation_id}/run","href":"/api-reference/platform-api/automations/run-an-automation"},{"title":"Get an Automation by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations/{automation_id}","href":"/api-reference/platform-api/automations/get-an-automation-by-id"},{"title":"Update an Automation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/automations/{automation_id}","href":"/api-reference/platform-api/automations/update-an-automation"},{"title":"List Recordings","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations/{automation_id}/recordings","href":"/api-reference/platform-api/automations/list-recordings"},{"title":"Create a recording for an automation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/automations/{automation_id}/recordings","href":"/api-reference/platform-api/automations/create-a-recording-for-an-automation"},{"title":"Get an Automation Run by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations/{automation_id}/runs/{run_id}","href":"/api-reference/platform-api/automations/get-an-automation-run-by-id"},{"title":"Get a recording by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations/{automation_id}/recordings/{recording_id}","href":"/api-reference/platform-api/automations/get-a-recording-by-id"},{"title":"Create a transcription for a recording","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/automations/{automation_id}/recordings/{recording_id}","href":"/api-reference/platform-api/automations/create-a-transcription-for-a-recording"}]},{"group":"schedulers","pages":[{"title":"List Schedulers","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environments/{environment_id}/schedulers","href":"/api-reference/platform-api/schedulers/list-schedulers"},{"title":"Get a Scheduler by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environments/{environment_id}/schedulers/{scheduler_id}","href":"/api-reference/platform-api/schedulers/get-a-scheduler-by-id"}]},{"group":"API Reference","pages":[{"title":"Trigger a Scheduler once","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/environments/{environment_id}/schedulers/{scheduler_id}","href":"/api-reference/platform-api/trigger-a-scheduler-once"}]},{"group":"activations","pages":[{"title":"List Activations","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environments/{environment_id}/activations","href":"/api-reference/platform-api/activations/list-activations"},{"title":"Retrieve an Activation by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}","href":"/api-reference/platform-api/activations/retrieve-an-activation-by-id"},{"title":"Delete an Activation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}","href":"/api-reference/platform-api/activations/delete-an-activation"},{"title":"Set static variables for the static activation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml patch /o/{organisation_id}/environments/{environment_id}/variables","href":"/api-reference/platform-api/activations/set-static-variables-for-the-static-activation"},{"title":"Set dynamic variables for an activation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml patch /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}/variables","href":"/api-reference/platform-api/activations/set-dynamic-variables-for-an-activation"},{"title":"Set a dynamic variable by name","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}/variables/{variable_name}","href":"/api-reference/platform-api/activations/set-a-dynamic-variable-by-name"},{"title":"List Activations for User","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environment/{environment_id}/users/{external_user_id}/activations","href":"/api-reference/platform-api/activations/list-activations-for-user"}]},{"group":"systems","pages":[{"title":"Lists the systems for the organisation.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/systems","href":"/api-reference/platform-api/systems/lists-the-systems-for-the-organisation"},{"title":"Create a new system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems","href":"/api-reference/platform-api/systems/create-a-new-system"},{"title":"Get a system by ID.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/systems/{system_id}","href":"/api-reference/platform-api/systems/get-a-system-by-id"},{"title":"Update system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/systems/{system_id}","href":"/api-reference/platform-api/systems/update-system"},{"title":"Delete a system by ID.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/systems/{system_id}","href":"/api-reference/platform-api/systems/delete-a-system-by-id"},{"title":"Link system actions to project.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/projects/{project_id}/actions-link","href":"/api-reference/platform-api/systems/link-system-actions-to-project"},{"title":"Link system triggers to project.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/projects/{project_id}/triggers-link","href":"/api-reference/platform-api/systems/link-system-triggers-to-project"},{"title":"List actions for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/systems/{system_id}/actions","href":"/api-reference/platform-api/systems/list-actions-for-a-system"},{"title":"Create new actions for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/actions","href":"/api-reference/platform-api/systems/create-new-actions-for-a-system"},{"title":"Get an action for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/systems/{system_id}/actions/{action_id}","href":"/api-reference/platform-api/systems/get-an-action-for-a-system"},{"title":"Update an action for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/systems/{system_id}/actions/{action_id}","href":"/api-reference/platform-api/systems/update-an-action-for-a-system"},{"title":"Delete an action for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/systems/{system_id}/actions/{action_id}","href":"/api-reference/platform-api/systems/delete-an-action-for-a-system"},{"title":"List triggers for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/systems/{system_id}/triggers","href":"/api-reference/platform-api/systems/list-triggers-for-a-system"},{"title":"Create new triggers for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/triggers","href":"/api-reference/platform-api/systems/create-new-triggers-for-a-system"},{"title":"Adds or updates an auth scheme for the system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/systems/{system_id}/auth-scheme-configs/{auth_scheme_config_id}","href":"/api-reference/platform-api/systems/adds-or-updates-an-auth-scheme-for-the-system"},{"title":"Deletes an auth scheme for the system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/systems/{system_id}/auth-scheme-configs/{auth_scheme_config_id}","href":"/api-reference/platform-api/systems/deletes-an-auth-scheme-for-the-system"},{"title":"List project environment connection templates","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/connection-templates","href":"/api-reference/platform-api/systems/list-project-environment-connection-templates"},{"title":"Create a new connection template","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/connection-templates","href":"/api-reference/platform-api/systems/create-a-new-connection-template"},{"title":"Remove a system from a project environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/connection-templates/{template_id}","href":"/api-reference/platform-api/systems/remove-a-system-from-a-project-environment"},{"title":"Remove a connection template","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/projects/{project_id}/connection-templates/{template_id}","href":"/api-reference/platform-api/systems/remove-a-connection-template"}]},{"group":"issues","pages":[{"title":"List Issues","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/issues","href":"/api-reference/platform-api/issues/list-issues"},{"title":"Create a new issue.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/issues","href":"/api-reference/platform-api/issues/create-a-new-issue"},{"title":"Update an Issue","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml patch /o/{organisation_id}/issues/{issue_id}","href":"/api-reference/platform-api/issues/update-an-issue"}]},{"group":"notifications","pages":[{"title":"List notification channels for an organisation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/notification_channels","href":"/api-reference/platform-api/notifications/list-notification-channels-for-an-organisation"},{"title":"Post o notification channels","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/notification_channels","href":"/api-reference/platform-api/notifications/post-o-notification_channels"},{"title":"Delete a notification channel","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/notification_channels/{channel_id}","href":"/api-reference/platform-api/notifications/delete-a-notification-channel"},{"title":"List notifications for a project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /projects/{project_id}/notifications","href":"/api-reference/platform-api/notifications/list-notifications-for-a-project"},{"title":"Create a new project notification","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /projects/{project_id}/notifications","href":"/api-reference/platform-api/notifications/create-a-new-project-notification"},{"title":"Delete a project notification","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /projects/{project_id}/notifications/{notification_id}","href":"/api-reference/platform-api/notifications/delete-a-project-notification"}]},{"group":"metrics","pages":[{"title":"Get organisation metrics summary","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/metricssummary","href":"/api-reference/platform-api/metrics/get-organisation-metrics-summary"},{"title":"Get metrics summary for all projects","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/metricssummary","href":"/api-reference/platform-api/metrics/get-metrics-summary-for-all-projects"}]},{"group":"kv store","pages":[{"title":"List all stores for an organization","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/store","href":"/api-reference/platform-api/kv-store/list-all-stores-for-an-organization"},{"title":"Create a new store","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/store","href":"/api-reference/platform-api/kv-store/create-a-new-store"},{"title":"Get a value by key","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /store/{store}/kv/{key}","href":"/api-reference/platform-api/kv-store/get-a-value-by-key"},{"title":"Set a value for a key","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /store/{store}/kv/{key}","href":"/api-reference/platform-api/kv-store/set-a-value-for-a-key"},{"title":"Delete a key","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /store/{store}/kv/{key}","href":"/api-reference/platform-api/kv-store/delete-a-key"},{"title":"Set multiple key-value pairs","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /store/{store}/kv/batch","href":"/api-reference/platform-api/kv-store/set-multiple-key-value-pairs"},{"title":"Get multiple values by keys","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /store/{store}/kv/batch","href":"/api-reference/platform-api/kv-store/get-multiple-values-by-keys"},{"title":"Delete multiple keys","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /store/{store}/kv/batch","href":"/api-reference/platform-api/kv-store/delete-multiple-keys"},{"title":"List keys and values with filtering","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /store/{store}/kv/list","href":"/api-reference/platform-api/kv-store/list-keys-and-values-with-filtering"},{"title":"Count entries matching selector","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /store/{store}/kv/count","href":"/api-reference/platform-api/kv-store/count-entries-matching-selector"}]}]}]},{"anchor":"Organisations API","icon":"users","pages":[{"title":"Organisations API","href":"/latest/api-reference/organisations-api/getting-started"}]}]}]},{"version":"Legacy","pages":[{"title":"Legacy","href":"/legacy/welcome"}]},{"version":"v2","pages":[{"title":"v2","href":"/v2/introduction"}]}]},"title":"Suspend Project - Versori User Documentation","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}