Named deployment and configuration contexts for a project — development, staging, production, or custom.
The Scrums.com API is planned and not yet publicly available. Endpoints and behaviour are subject to change before release.
Environments represent named deployment and configuration contexts within a project. Each environment holds its own variables, resources, and deployment state. Standard environment types include development, staging, and production, with support for custom named environments.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Scrums.com Docs","description":"Documentation for the Scrums.com Enterprise AI Software Engineering Orchestration Platform (SEOP). Scrums.com is the enterprise AI platform for software engineering: deploy AI agents, models, AI engineers and infrastructure from one catalog, then govern and measure all of it on one platform. Software Engineering. Sorted.","colors":{"primary":"#145aff","light":"#4a7fff","dark":"#0d3eb3"},"logo":{"light":"https://mintcdn.com/scrumscom/n1nBGJuSy2RrQUfP/logo/docs-logo-white.svg?fit=max\u0026auto=format\u0026n=n1nBGJuSy2RrQUfP\u0026q=85\u0026s=b817f112d42f537094394d0e00455074","dark":"https://mintcdn.com/scrumscom/n1nBGJuSy2RrQUfP/logo/docs-logo-white.svg?fit=max\u0026auto=format\u0026n=n1nBGJuSy2RrQUfP\u0026q=85\u0026s=b817f112d42f537094394d0e00455074","href":"https://www.scrums.com"},"favicon":"https://mintcdn.com/scrumscom/6AP6JVTPk022p4QK/favicon.png?fit=max\u0026auto=format\u0026n=6AP6JVTPk022p4QK\u0026q=85\u0026s=ce075766557211d58afb1225e9b1ede7","appearance":{"default":"system"},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://status.scrums.com","label":"Status"},{"href":"mailto:support@scrums.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://www.scrums.com/sign-up"}},"footer":{"socials":{"x":"https://x.com/scrumsdotcom","linkedin":"https://www.linkedin.com/company/scrumsdotcom","youtube":"https://www.youtube.com/@scrumsdotcom"},"links":[{"header":"Enterprise AI Platform","items":[{"label":"Platform (SEOP)","href":"https://www.scrums.com/platform"},{"label":"AI Agent Gateway","href":"https://www.scrums.com/platform/ai-gateway"},{"label":"DORA Metrics","href":"https://www.scrums.com/platform/dora-metrics"},{"label":"Developer Productivity","href":"https://www.scrums.com/platform/developer-productivity"},{"label":"Engineering Capacity Planning","href":"https://www.scrums.com/platform/engineering-capacity-planning"},{"label":"AI Agent Harness","href":"https://www.scrums.com/platform/agent-harness"},{"label":"Pricing","href":"https://www.scrums.com/pricing"}]},{"header":"AI Development","items":[{"label":"AI Development Services","href":"https://www.scrums.com/ai-development"},{"label":"AI Agent Development","href":"https://www.scrums.com/ai-development/ai-agent-development"},{"label":"Generative AI Development","href":"https://www.scrums.com/ai-development/generative-ai-development"},{"label":"Custom Software Development","href":"https://www.scrums.com/ai-development/custom-software-development"},{"label":"Mobile App Development","href":"https://www.scrums.com/ai-development/mobile-app-development"},{"label":"Scopes","href":"https://www.scrums.com/ai-development/scopes"}]},{"header":"Hire Engineers","items":[{"label":"Hire AI Developers","href":"https://www.scrums.com/hire"},{"label":"Engineers","href":"https://www.scrums.com/hire/engineers"},{"label":"Dedicated Development Team","href":"https://www.scrums.com/hire/teams"},{"label":"Staff Augmentation","href":"https://www.scrums.com/hire/staff-augmentation"},{"label":"Forward Deployed Engineers","href":"https://www.scrums.com/hire/forward-deployed-engineers"},{"label":"AI Catalog","href":"https://www.scrums.com/catalog"}]},{"header":"Company","items":[{"label":"About Us","href":"https://www.scrums.com/about-us"},{"label":"Contact Us","href":"https://www.scrums.com/contact-us"},{"label":"Blog","href":"https://www.scrums.com/blog"},{"label":"Careers","href":"https://www.scrums.com/careers"},{"label":"Legal Policies","href":"https://www.scrums.com/legal"},{"label":"Scrums.com Status","href":"https://status.scrums.com"}]}]},"search":{"prompt":"Search the Scrums.com Enterprise AI Platform docs"},"seo":{"metatags":{"og:site_name":"Scrums.com Docs","keywords":"Scrums.com, enterprise AI platform for software engineering, Software Engineering Orchestration Platform, SEOP, AI gateway, DORA metrics, developer productivity platform, engineering capacity planning, AI agent harness, MCP gateway, AI development services, hire AI engineers"},"organization":{"name":"Scrums.com","url":"https://www.scrums.com","sameAs":["https://x.com/scrumsdotcom","https://www.linkedin.com/company/scrumsdotcom","https://www.youtube.com/@scrumsdotcom"]},"indexing":"navigable"},"fonts":{"heading":{"family":"IBM Plex Mono"},"body":{"family":"IBM Plex Sans"}},"integrations":{"gtm":{"tagId":"GTM-TMGKR55"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"instructions":["Scrums.com is the enterprise AI platform for software engineering. SEOP, the Enterprise AI Software Engineering Orchestration Platform, is the architecture of the platform: one control plane for AI agents, models, engineers and infrastructure.","Write the entity name as Scrums.com. Never write the bare word Scrums.","Platform capabilities are documented under /platform. Delivery Plans (under /ai-development) and Hire Engineers are documented under Platform Services. The AI Catalog is documented under /catalog. Each docs page links to its page on https://www.scrums.com."]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"scrumscom","hasAudioNarration":false,"actualSubdomain":"scrumscom","customDomains":["www.scrums.com"],"gitSource":{"type":"github","owner":"scrumsdotcom","repo":"scrums","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6b001b3441fcdaa6a1cbf74d","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API \u0026 CLI","count":47},{"language":"default","tag":"Core Platform","count":24},{"language":"default","tag":"Integrations","count":23},{"language":"default","tag":"Enterprise AI Platform","count":17},{"language":"default","tag":"Get Started","count":17},{"language":"default","tag":"Platform Services","count":14},{"language":"default","tag":"AI Catalog","count":10},{"language":"default","tag":"Overview","count":9},{"language":"default","tag":"Hire Engineers","count":8},{"language":"default","tag":"Getting Started","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--navbar-bg: #0d46db;--footer-bg: #041745;--navbar-fg-muted: rgba(255, 255, 255, 0.8);--navbar-border: rgba(255, 255, 255, 0.18);--footer-fg-muted: rgba(255, 255, 255, 0.72);--navbar-underline: #fff;--font-mono: \"IBM Plex Mono\", ui-monospace, SFMono-Regular, Menlo, monospace}#navbar-transition{background-color:var(--navbar-bg)!important;border-bottom-color:var(--navbar-border)!important}#navbar{color:#fff}#navbar [class*=\"text-gray-\"]{color:var(--navbar-fg-muted)!important}#navbar [class*=\"fill-gray-\"]{fill:var(--navbar-fg-muted)!important}#navbar a:hover [class*=\"text-gray-\"],#navbar button:hover [class*=\"text-gray-\"],#navbar [class*=\"text-gray-\"]:hover{color:#fff!important}#navbar .font-semibold[class*=\"text-gray-9\"]{color:#fff!important}#navbar .nav-tabs-item{color:var(--navbar-fg-muted)!important}#navbar .nav-tabs-item:hover,#navbar .nav-tabs-item[data-active=\"true\"]{color:#fff!important}#navbar .nav-tabs-item[data-active=\"true\"]>div,#navbar .nav-tabs-item:hover>div{background-color:var(--navbar-underline)!important}#search-bar-entry{background-color:rgba(255, 255, 255, 0.12)!important;color:var(--navbar-fg-muted)!important;filter:none!important;--tw-ring-color: rgba(255, 255, 255, 0.25) !important}#search-bar-entry:hover{background-color:rgba(255, 255, 255, 0.18)!important;--tw-ring-color: rgba(255, 255, 255, 0.4) !important}#theme-preference-menu-trigger:hover svg{color:#fff!important}#topbar-cta-button a>span:first-child{background-color:#fff!important}#topbar-cta-button a span,#topbar-cta-button a svg{color:var(--navbar-bg)!important}#footer{background-color:var(--footer-bg)!important;border-top-color:rgba(255, 255, 255, 0.12)!important}#footer [class*=\"text-gray-\"]{color:var(--footer-fg-muted)!important}#footer [class~=\"text-gray-950\"]{color:#fff!important}#footer a:hover,#footer a:hover [class*=\"text-gray-\"]{color:#fff!important}#footer [class~=\"bg-gray-100\"]{background-color:rgba(255, 255, 255, 0.12)!important}#footer svg[class*=\"bg-gray-\"]{background-color:var(--footer-fg-muted)!important}#footer a:hover svg[class*=\"bg-gray-\"]{background-color:#fff!important}#footer button[class~=\"bg-gray-200\"]{background-color:rgba(255, 255, 255, 0.14)!important}#footer [class~=\"text-gray-950\"]{font-family:var(--font-mono)}#footer p[class*=\"font-semibold\"]{white-space:normal!important;overflow-wrap:anywhere}#footer .footer-tagline{font-family:var(--font-mono);max-width:30rem}#footer .footer-tagline-title{font-size:1.0625rem;line-height:1.4;font-weight:600;color:#fff;margin:0 0 0.5rem}#footer .footer-tagline-sub{font-size:0.8125rem;line-height:1.6;font-weight:400;color:var(--footer-fg-muted);margin:0}@media (min-width: 768px){#footer .footer-brand-col{justify-content:flex-start!important;row-gap:1.75rem!important}}@media (min-width: 1024px){#footer .footer-tagline{max-width:20rem}}@media (max-width: 1023px){#footer .footer-brand-row{flex-direction:column!important}}@media (max-width: 767px){#footer .footer-brand-col{flex-wrap:wrap;row-gap:1.5rem}#footer .footer-tagline{flex-basis:100%;text-align:center}}"}]}
{"page":{"pagePath":"api-reference/core/environments","slug":"/api-reference/core/environments","pageMetadata":{"title":"Environments","description":"Named deployment and configuration contexts for a project — development, staging, production, or custom.","href":"/api-reference/core/environments"},"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: \"Named deployment and configuration contexts for a project — development, staging, production, or custom.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[`The Scrums.com API is `,_jsx(_components.strong,{children:`planned and not yet publicly available`}),`. Endpoints and behaviour are subject to change before release.`]})}),`\n`,_jsxs(_components.p,{children:[`Environments represent named deployment and configuration contexts within a project. Each environment holds its own variables, resources, and deployment state. Standard environment types include `,_jsx(_components.code,{children:`development`}),`, `,_jsx(_components.code,{children:`staging`}),`, and `,_jsx(_components.code,{children:`production`}),`, with support for custom named environments.`]}),`\n`,_jsx(Heading,{level:`2`,id:`base-path`,children:`Base path`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`/v1/projects/{project_id}/environments`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`endpoints`,children:`Endpoints`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Method`}),_jsx(_components.th,{children:`Path`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/projects/{project_id}/environments`})}),_jsx(_components.td,{children:`List environments for a project`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`POST`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/projects/{project_id}/environments`})}),_jsx(_components.td,{children:`Create an environment`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/environments/{id}`})}),_jsx(_components.td,{children:`Get an environment`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`PATCH`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/environments/{id}`})}),_jsx(_components.td,{children:`Update an environment`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`DELETE`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/environments/{id}`})}),_jsx(_components.td,{children:`Delete an environment`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/environments/{id}/variables`})}),_jsx(_components.td,{children:`List environment variables`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`PUT`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/environments/{id}/variables`})}),_jsx(_components.td,{children:`Set environment variables`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`attributes`,children:`Attributes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`id`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Unique identifier`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`project_id`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Parent project reference`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`name`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Display name`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`slug`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`URL-safe identifier (e.g. `,_jsx(_components.code,{children:`production`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`type`})}),_jsx(_components.td,{children:`enum`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`development`}),`, `,_jsx(_components.code,{children:`staging`}),`, `,_jsx(_components.code,{children:`production`}),`, `,_jsx(_components.code,{children:`custom`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`protected`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Restricts direct deployments if true`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`created_at`})}),_jsx(_components.td,{children:`datetime`}),_jsx(_components.td,{children:`ISO 8601 timestamp`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`updated_at`})}),_jsx(_components.td,{children:`datetime`}),_jsx(_components.td,{children:`ISO 8601 timestamp`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`relationships`,children:`Relationships`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Environments belong to `,_jsx(_components.a,{href:`/api-reference/core/projects`,children:`Projects`}),` and are associated with `,_jsx(_components.a,{href:`/api-reference/core/resources`,children:`Resources`}),` and `,_jsx(_components.a,{href:`/api-reference/core/usage-records`,children:`Usage Records`}),`.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Environments","description":"Named deployment and configuration contexts for a project — development, staging, production, or custom.","href":"/api-reference/core/environments"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base path","slug":"base-path","depth":2,"children":[]},{"title":"Endpoints","slug":"endpoints","depth":2,"children":[]},{"title":"Attributes","slug":"attributes","depth":2,"children":[]},{"title":"Relationships","slug":"relationships","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/scrumscom/0cbbf323de558e79/footer-tagline.js"],"subdomain":"scrumscom","siteName":"Scrums.com Docs","title":"Environments - Scrums.com Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-15T20:08:15.607Z","gitLastModified":"2026-10-02T13:13:09.000Z","originalFileLocation":"api-reference/core/environments.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=\"Named deployment and configuration contexts for a project — development, staging, production, or custom.\">\u003cmeta data-mint-head name=\"keywords\" content=\"Scrums.com, enterprise AI platform for software engineering, Software Engineering Orchestration Platform, SEOP, AI gateway, DORA metrics, developer productivity platform, engineering capacity planning, AI agent harness, MCP gateway, AI development services, hire AI engineers\">\u003cmeta data-mint-head name=\"application-name\" content=\"Scrums.com Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/scrumscom/MLKgil8wiM0iy1Q1/_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=\"/docs/mintlify-assets/_mintlify/favicons/scrumscom/MLKgil8wiM0iy1Q1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/scrumscom/MLKgil8wiM0iy1Q1/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/scrumscom/MLKgil8wiM0iy1Q1/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/scrumscom/MLKgil8wiM0iy1Q1/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/scrumscom/MLKgil8wiM0iy1Q1/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/scrumscom/MLKgil8wiM0iy1Q1/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/scrumscom/MLKgil8wiM0iy1Q1/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/scrumscom/MLKgil8wiM0iy1Q1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Environments - Scrums.com Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Named deployment and configuration contexts for a project — development, staging, production, or custom.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Scrums.com Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.scrums.com/docs/api-reference/core/environments\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://scrumscom.mintlify.site/docs/_mintlify/api/og/v2?division=Core+Platform\u0026amp;title=Environments\u0026amp;description=Named+deployment+and+configuration+contexts+for+a+project+%E2%80%94+development%2C+staging%2C+production%2C+or+custom.\u0026amp;theme=087ff90cf5503e09b7c27fb2\u0026amp;signature=266e336098a3076c7d40a34befed300c3b9484708d235d5491618f8f495f3fa1\">\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=\"Environments - Scrums.com Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Named deployment and configuration contexts for a project — development, staging, production, or custom.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scrumscom.mintlify.site/docs/_mintlify/api/og/v2?division=Core+Platform\u0026amp;title=Environments\u0026amp;description=Named+deployment+and+configuration+contexts+for+a+project+%E2%80%94+development%2C+staging%2C+production%2C+or+custom.\u0026amp;theme=087ff90cf5503e09b7c27fb2\u0026amp;signature=266e336098a3076c7d40a34befed300c3b9484708d235d5491618f8f495f3fa1\">\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=\"/docs/mintlify-assets/_mintlify/favicons/scrumscom/MLKgil8wiM0iy1Q1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Scrums.com Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#145aff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.scrums.com/docs/api-reference/core/environments\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/core/environments.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.scrums.com/#organization\",\"name\":\"Scrums.com\",\"url\":\"https://www.scrums.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/scrumscom/n1nBGJuSy2RrQUfP/logo/docs-logo-white.svg?fit=max\u0026auto=format\u0026n=n1nBGJuSy2RrQUfP\u0026q=85\u0026s=b817f112d42f537094394d0e00455074\"},\"sameAs\":[\"https://x.com/scrumsdotcom\",\"https://www.linkedin.com/company/scrumsdotcom\",\"https://www.youtube.com/@scrumsdotcom\"]},{\"@type\":\"WebSite\",\"@id\":\"https://www.scrums.com/docs#website\",\"name\":\"Scrums.com Docs\",\"url\":\"https://www.scrums.com/docs\",\"publisher\":{\"@id\":\"https://www.scrums.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.scrums.com/docs/api-reference/core/environments#webpage\",\"url\":\"https://www.scrums.com/docs/api-reference/core/environments\",\"name\":\"Environments\",\"description\":\"Named deployment and configuration contexts for a project — development, staging, production, or custom.\",\"dateModified\":\"2026-10-02T13:13:09.000Z\",\"isPartOf\":{\"@id\":\"https://www.scrums.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.scrums.com/docs/api-reference/core/environments#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.scrums.com/docs/api-reference/core/environments#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core Platform\",\"item\":\"https://www.scrums.com/docs/api-reference/core/accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Environments\",\"item\":\"https://www.scrums.com/docs/api-reference/core/environments\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://www.scrums.com/docs/api-reference/core/environments#article\",\"headline\":\"Environments\",\"name\":\"Environments\",\"description\":\"Named deployment and configuration contexts for a project — development, staging, production, or custom.\",\"url\":\"https://www.scrums.com/docs/api-reference/core/environments\",\"mainEntityOfPage\":{\"@id\":\"https://www.scrums.com/docs/api-reference/core/environments#webpage\"},\"dateModified\":\"2026-10-02T13:13:09.000Z\",\"publisher\":{\"@id\":\"https://www.scrums.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.scrums.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Scrums.com Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Scrums.com\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/core/environments.md","siteName":"Scrums.com Docs","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":""}]},{"tab":"Enterprise AI Platform","pages":[{"title":"Enterprise AI Platform","href":"/platform/overview"}]},{"tab":"AI Catalog","pages":[{"title":"AI Catalog","href":"/catalog/overview"}]},{"tab":"Platform Services","pages":[{"title":"Platform Services","href":"/ai-development"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/integrations"}]},{"tab":"API \u0026 CLI","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"group":"Organizations","pages":[{"title":"Organizations","href":"/api-reference/core/organizations"},{"title":"List organizations","openapi":"GET /orgs","href":"/api-reference/endpoints/organizations/list-orgs"}]},{"group":"Workspaces","pages":[{"title":"Workspaces","href":"/api-reference/core/workspaces"},{"title":"List workspaces","openapi":"GET /workspaces","href":"/api-reference/endpoints/workspaces/list-workspaces"}]},{"group":"Service Lines","pages":[{"title":"Service Lines","href":"/api-reference/core/service-lines"},{"title":"List Service Lines","openapi":"GET /service-lines","href":"/api-reference/endpoints/service-lines/list-service-lines"},{"title":"Create a Service Line","openapi":"POST /service-lines","href":"/api-reference/endpoints/service-lines/create-service-line"},{"title":"Get a Service Line","openapi":"GET /service-lines/{lin_code}","href":"/api-reference/endpoints/service-lines/get-service-line"},{"title":"Get Service Line usage","openapi":"GET /service-lines/{lin_code}/usage","href":"/api-reference/endpoints/service-lines/get-service-line-usage"}]},{"group":"Core Platform","pages":[{"title":"Accounts","href":"/api-reference/core/accounts"},{"title":"Agents","href":"/api-reference/core/agents"},{"title":"API Keys","href":"/api-reference/core/api-keys"},{"title":"Artifacts","href":"/api-reference/core/artifacts"},{"title":"Audit Logs","href":"/api-reference/core/audit-logs"},{"title":"Billing \u0026 Invoices","href":"/api-reference/core/billing-invoices"},{"title":"Capacity \u0026 Allocation","description":"Capacity pools and resource allocation across Service Lines. Manage supply, demand, and utilisation for talent, infrastructure, and agent resources.","href":"/api-reference/core/capacity"},{"title":"Environments","href":"/api-reference/core/environments"},{"title":"Events","description":"The immutable platform event stream. Events record every significant state change and action across all Service Lines, resources, and actors.","href":"/api-reference/core/events"},{"title":"Execution API","href":"/api-reference/core/execution"},{"title":"Incidents \u0026 Alerts","href":"/api-reference/core/incidents"},{"title":"Integrations API","sidebarTitle":"Integrations","href":"/api-reference/core/integrations"},{"title":"Invoices","href":"/api-reference/core/invoices"},{"title":"Memberships","href":"/api-reference/core/memberships"},{"title":"Plans","href":"/api-reference/core/plans"},{"title":"Policies","href":"/api-reference/core/policies"},{"title":"Projects","href":"/api-reference/core/projects"},{"title":"Resources API","sidebarTitle":"Resources","href":"/api-reference/core/resources"},{"title":"Subscriptions","href":"/api-reference/core/subscriptions"},{"title":"Tasks \u0026 Work Items","href":"/api-reference/core/tasks"},{"title":"Usage \u0026 Metering","href":"/api-reference/core/usage-metering"},{"title":"Usage Records","href":"/api-reference/core/usage-records"},{"title":"Users \u0026 Roles","href":"/api-reference/core/users"},{"title":"Webhooks","href":"/api-reference/core/webhooks"}]},{"group":"Observability \u0026 Metrics","pages":[{"title":"Observability \u0026 Metrics","href":"/api-reference/core/observability"},{"title":"Get workspace health","openapi":"GET /observability/health","href":"/api-reference/endpoints/observability/get-health"}]},{"group":"ODS","pages":[{"title":"ODS API","href":"/api-reference/product/ods"},{"title":"Submit an ODS request","openapi":"POST /capabilities/ods/requests","href":"/api-reference/endpoints/ods/create-ods-request"}]},{"group":"Talent Marketplace","pages":[{"title":"Talent Marketplace API","href":"/api-reference/product/talent"},{"title":"Create a talent request","openapi":"POST /talent/requests","href":"/api-reference/endpoints/talent/create-talent-request"}]},{"group":"AI Agent Gateway","pages":[{"title":"AI Agent Gateway API","href":"/api-reference/product/agent-gateway"},{"title":"Trigger an agent run","openapi":"POST /agents/{agent_id}/runs","href":"/api-reference/endpoints/agents/create-agent-run"}]},{"group":"Product Lines","pages":[{"title":"Managed Services API","href":"/api-reference/product/managed-services"},{"title":"Platforms \u0026 Infrastructure API","href":"/api-reference/product/infrastructure"},{"title":"Developer Intelligence API","href":"/api-reference/product/intelligence"}]},{"group":"Machine-Readable Company Data","pages":[{"title":"Scrums.com Entity Graph","href":"/company/entity-graph"}]},{"group":"CLI","pages":[{"title":"CLI","href":"/cli/introduction"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Environments - Scrums.com Docs","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":[],"chunks":[]}