The autoscaling strategy. The dedicated.c-0.25vcpu-512mb and dedicated.c-0.5vcpu-1gb sizes only support none.
Available options:
none,
custom,
auto
max_replicas
integer
The maximum number of replicas the instance can scale to. Only applicable to the custom scaling type, and rejected when used with auto.
Example:
10
min_replicas
integer
The minimum number of replicas the instance runs. Only applicable to the custom scaling type, and rejected when used with auto.
Example:
1
hibernation_timeout
integer | null
Number of minutes before the application hibernates. Set to null to disable hibernation, or omit it to avoid changing the hibernation settings.
Takes precedence over the deprecated uses_sleep_mode and sleep_timeout fields.
Example:
5
uses_sleep_mode
boolean
deprecated
Use hibernation_timeout instead.
sleep_timeout
integer
deprecated
Use hibernation_timeout instead.
Required range: 1 <= x <= 60
uses_scheduler
boolean
sleep_with_app
boolean
Whether worker replicas scale to zero alongside the app cluster, waking when they receive traffic. Only applicable to worker (service) instances.
Example:
true
uses_octane
boolean
uses_inertia_ssr
boolean
scaling_cpu_threshold_percentage
integer | null
Required range: 50 <= x <= 95
scaling_memory_threshold_percentage
integer | null
Required range: 50 <= x <= 95
visibility_timeout
integer | null
How long a message stays hidden from other workers while one is processing it. Only available when the
organization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.
Example:
180
shutdown_timeout
integer | null
The time a worker has to finish its current job before being forcefully shut down. Only available when the
organization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.
Example:
90
probes
object | null
Custom health checks for the app's web process, keyed by startup, readiness, and liveness. Each check and each of its
fields (path, port, delay, interval, timeout, tries) is optional and falls back to the platform default. A path selects HTTP and a port alone selects TCP.
Timing overrides without a path or port keep the default handler. Only applicable to app instances; ignored otherwise. Replaces all existing checks, set to null to
remove them, or omit it to keep the current checks. The startup check may take at most 600 seconds (delay + interval × tries).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Laravel Cloud","colors":{"primary":"#0057FF","light":"#71A8FF","dark":"#0057FF"},"logo":{"light":"https://mintcdn.com/cloud/MkfTsQSKGENWqY-2/logo/laravel-logo-light.png?fit=max\u0026auto=format\u0026n=MkfTsQSKGENWqY-2\u0026q=85\u0026s=f508d8e9c4e3c842e83d055cc376daa1","dark":"https://mintcdn.com/cloud/MkfTsQSKGENWqY-2/logo/laravel-logo-dark.png?fit=max\u0026auto=format\u0026n=MkfTsQSKGENWqY-2\u0026q=85\u0026s=fcfe00a4914f5e3ad791b606c3e75795","href":"https://cloud.laravel.com/"},"favicon":"https://mintcdn.com/cloud/83RcCEaWR6PzmMFO/favicons/favicon-dark.png?fit=max\u0026auto=format\u0026n=83RcCEaWR6PzmMFO\u0026q=85\u0026s=edd5608e08efe6ae6a4ca1b44232d2af","navbar":{"links":[],"primary":{"type":"button","label":"Get Started","href":"https://cloud.laravel.com"}},"footer":{"socials":{"x":"https://x.com/laravel","github":"https://github.com/laravel","youtube":"https://www.youtube.com/laravelphp"}},"seo":{"metatags":{"robots":"noindex"}},"integrations":{"fathom":{"siteId":"KZRWMQWT"}},"banner":{"content":"Deploy Next and Nuxt frontends alongside your Laravel apps, all from one unified platform. \u003ca href='https://laravel.com/blog/deploy-nextjs-and-nuxt-apps-on-laravel-cloud'>Learn more →\u003c/a>","dismissible":true},"contextual":{"options":["copy","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cloud","hasAudioNarration":false,"actualSubdomain":"cloud","customDomains":["cloud.laravel.com"],"gitSource":{"type":"github","owner":"laravel","repo":"cloud-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b00b674dd2e37468e2e03f8","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API","count":148},{"language":"default","tag":"Endpoints","count":144},{"language":"default","tag":"Documentation","count":69},{"language":"default","tag":"Knowledge Base","count":21},{"language":"default","tag":"Environments","count":18},{"language":"default","tag":"Basics","count":17},{"language":"default","tag":"Instances","count":14},{"language":"default","tag":"Monitoring","count":11},{"language":"default","tag":"Private Cloud","count":10},{"language":"default","tag":"Metrics","count":9}]},"assistantConfig":{"enableAskAiButton":true,"enableAskAiSearchBar":false,"deflection":{"enabled":false,"showHelpButton":false}},"basePath":"/cloud/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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":false},"customCss":[{"filePath":"styles.css","content":"/* latin-ext */\n@font-face {\n font-family: 'Instrument Sans';\n font-style: normal;\n font-weight: 400 500;\n font-stretch: 100%;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/instrumentsans/v4/pxiTypc9vsFDm051Uf6KVwgkfoSxQ0GsQv8ToedPibnr0She1YmV.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Instrument Sans';\n font-style: normal;\n font-weight: 400 500;\n font-stretch: 100%;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/instrumentsans/v4/pxiTypc9vsFDm051Uf6KVwgkfoSxQ0GsQv8ToedPibnr0SZe1Q.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300 600;\n font-display: swap;\n src: url(/cloud/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nbody{font-family:\"Instrument Sans\";font-weight:400}h1,h2,h3,h4{font-family:\"Instrument Sans\"!important;font-weight:500!important;letter-spacing:-0.025em!important}code,pre{font-family:'Geist Mono', ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace}b,strong,.font-semibold{font-weight:500!important}.prose :where(a):not(:where([class~=not-prose],[class~=not-prose] *)){font-weight:500!important;color:rgb(var(--primary))!important}.dark .prose :where(a):not(:where([class~=not-prose],[class~=not-prose] *)){color:rgb(var(--primary-light))!important}.table-auto{table-layout:auto}table.table-fixed{table-layout:fixed!important}table{table-layout:auto!important;display:table}th{text-align:left}td>p.icon{margin:0}.short{p {\n margin-top: 0;\n margin-bottom: 0;\n }}.pr-16{padding-right:4em}.max-w-none{max-width:none!important}.align-top{vertical-align:top}.italic{font-style:italic}.pr-20{padding-right:5rem}.max-h-50vh{max-height:50vh}.select-arrow{background-image:url(\"data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 20 20'%3e%3cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' d='M6 8l4 4 4-4'/%3e%3c/svg%3e\");background-size:1.5em 1.5em;background-position:right 0.5rem center;background-repeat:no-repeat}#banner a{color:rgb(var(--white))!important;white-space:nowrap}#banner>div>p{white-space:normal;padding-top:0.125rem;padding-bottom:0.125rem;overflow:hidden;display:-webkit-box;-webkit-box-orient:vertical;line-clamp:3;-webkit-line-clamp:3}#banner:has(>button){padding-right:2.5rem}@media screen and (min-width: 768px){#banner{height:auto}#banner:has(>button){padding-left:2.5rem}}#topbar-cta-button a>span:first-child{background-color:rgb(22 25 30)}.dark #topbar-cta-button a>span:first-child{background-color:rgb(255 255 255)}.dark #topbar-cta-button a,.dark #topbar-cta-button a *{color:rgb(22 25 30)!important}.callout [data-component-part=\"callout-icon\"]:empty{display:none}"}]}
{"page":{"pagePath":"api/instances/update-instance","slug":"/api/instances/update-instance","pageMetadata":{"title":"Update instance","description":"Update an instance.","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /instances/{instance}","href":"/api/instances/update-instance","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: \"Update an instance.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Callout}=_components;if(!Callout)_missingMdxReference(`Callout`,true);return _jsx(Callout,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Required permission:`}),` `,_jsx(_components.code,{children:`environment_instance.edit`})]})})}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":"Update instance","description":"Update an instance.","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /instances/{instance}","href":"/api/instances/update-instance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/cloud/docs/_mintlify/custom/cloud/412bdbfbeb58e5da/gtag.js","/cloud/docs/_mintlify/custom/cloud/1a6e9e638535d772/plain.js","/cloud/docs/_mintlify/custom/cloud/f2ef70ddf7841ac3/rudderstack.js","/cloud/docs/_mintlify/custom/cloud/d55d837bfb92372f/scripts/fetch-ips.js"],"openApiReferenceData":{"operation":{"operationId":"public.instances.update","description":"Update an instance.","summary":"Update instance","tags":["Instances"],"parameters":["e0ed9e51-a058-4507-8d7f-41eb6e443aae"],"requestBody":"f22d9ec1-1e1a-4eb4-bc33-480fc46546a4","responses":{"200":"6858b14a-adfb-46f8-adc5-08ba69aff33d","403":"c49295ef-613a-46a7-bcc9-870bbaf70d55","404":"a2c84cff-96dc-4431-b708-1c5e9fa2e11f","422":"03eb0523-1e4b-4064-8705-ebd8c95a27d5"},"x-mint":{"content":"\u003cCallout>\n**Required permission:** `environment_instance.edit`\n\u003c/Callout>"},"method":"patch","type":"path","servers":["50ce4a97-515e-4c97-9895-7f81adc7e954"],"security":["0af7a3bb-31a6-4f3e-8df2-26b0ea3c7a87"],"path":"/instances/{instance}","baseUrlOptions":["https://cloud.laravel.com/api"],"title":"Update instance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e0ed9e51-a058-4507-8d7f-41eb6e443aae":{"name":"instance","in":"path","required":true,"description":"The instance identifier","schema":{"type":"string","isRequired":true,"description":"The instance identifier","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":40,"uniqueKey":"name","typeLabel":"string"},"size":{"type":"string","enum":["flex-512mb","flex-1gb","flex-2gb","flex.c-1vcpu-256mb","flex.g-1vcpu-512mb","flex.m-1vcpu-1gb","flex.c-2vcpu-512mb","flex.g-2vcpu-1gb","flex.m-2vcpu-2gb","flex.c-4vcpu-1gb","flex.g-4vcpu-2gb","flex.m-4vcpu-4gb","flex.c-8vcpu-2gb","flex.g-8vcpu-4gb","flex.m-8vcpu-8gb","pro.c-1vcpu-1gb","pro.g-1vcpu-2gb","pro.m-1vcpu-4gb","pro.c-2vcpu-2gb","pro.g-2vcpu-4gb","pro.m-2vcpu-8gb","pro.c-4vcpu-4gb","pro.g-4vcpu-8gb","pro.m-4vcpu-16gb","pro.c-8vcpu-8gb","pro.g-8vcpu-16gb","pro.m-8vcpu-32gb","dedicated.c-0.25vcpu-512mb","dedicated.c-0.5vcpu-1gb","dedicated.c-1vcpu-2gb","dedicated.g-1vcpu-4gb","dedicated.m-1vcpu-8gb","dedicated.c-2vcpu-4gb","dedicated.g-2vcpu-8gb","dedicated.m-2vcpu-16gb","dedicated.c-4vcpu-8gb","dedicated.g-4vcpu-16gb","dedicated.m-4vcpu-32gb","dedicated.c-8vcpu-16gb","dedicated.g-8vcpu-32gb","dedicated.m-8vcpu-64gb","mq-pro-256mb","mq-pro-512mb","mq-pro-1gb","mq-pro-2gb","mq-pro-4gb","mq-pro-8gb","mq-dedicated-256mb","mq-dedicated-512mb","mq-dedicated-1gb","mq-dedicated-2gb","mq-dedicated-4gb","mq-dedicated-8gb","mq-dedicated-16gb","mq.flex.256mb","mq.flex.512mb","mq.flex.1gb","mq.flex.2gb","mq.pro.256mb","mq.pro.512mb","mq.pro.1gb","mq.pro.2gb","mq.pro.4gb","mq.pro.8gb","mq.dedicated.flex.256mb","mq.dedicated.flex.512mb","mq.dedicated.flex.1gb","mq.dedicated.flex.2gb","mq.dedicated.pro.256mb","mq.dedicated.pro.512mb","mq.dedicated.pro.1gb","mq.dedicated.pro.2gb","mq.dedicated.pro.4gb","mq.dedicated.pro.8gb","mq.dedicated.pro.16gb"],"title":"InstanceSize","uniqueKey":"size","typeLabel":"enum\u003cstring>"},"scaling_type":{"type":"string","enum":["none","custom","auto"],"title":"InstanceScalingType","description":"The autoscaling strategy. The `dedicated.c-0.25vcpu-512mb` and `dedicated.c-0.5vcpu-1gb` sizes only support `none`.","uniqueKey":"scaling_type","typeLabel":"enum\u003cstring>"},"max_replicas":{"type":"integer","description":"The maximum number of replicas the instance can scale to. Only applicable to the `custom` scaling type, and rejected when used with `auto`.","examples":[10],"uniqueKey":"max_replicas","typeLabel":"integer"},"min_replicas":{"type":"integer","description":"The minimum number of replicas the instance runs. Only applicable to the `custom` scaling type, and rejected when used with `auto`.","examples":[1],"uniqueKey":"min_replicas","typeLabel":"integer"},"hibernation_timeout":{"oneOf":[{"type":"integer","description":"Number of minutes before the application hibernates. Set to null to disable hibernation, or omit it to avoid changing the hibernation settings.\nTakes precedence over the deprecated uses_sleep_mode and sleep_timeout fields.","examples":[5],"uniqueKey":"hibernation_timeout.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of minutes before the application hibernates. Set to null to disable hibernation, or omit it to avoid changing the hibernation settings.\nTakes precedence over the deprecated uses_sleep_mode and sleep_timeout fields.","examples":[5],"uniqueKey":"hibernation_timeout.oneOf.1","typeLabel":"null"}],"uniqueKey":"hibernation_timeout","typeLabel":"integer | null"},"uses_sleep_mode":{"type":"boolean","description":"Use hibernation_timeout instead.","deprecated":true,"uniqueKey":"uses_sleep_mode","typeLabel":"boolean"},"sleep_timeout":{"type":"integer","description":"Use hibernation_timeout instead.","deprecated":true,"minimum":1,"maximum":60,"uniqueKey":"sleep_timeout","typeLabel":"integer"},"uses_scheduler":{"type":"boolean","uniqueKey":"uses_scheduler","typeLabel":"boolean"},"sleep_with_app":{"type":"boolean","description":"Whether worker replicas scale to zero alongside the app cluster, waking when they receive traffic. Only applicable to worker (service) instances.","examples":[true],"uniqueKey":"sleep_with_app","typeLabel":"boolean"},"uses_octane":{"type":"boolean","uniqueKey":"uses_octane","typeLabel":"boolean"},"uses_inertia_ssr":{"type":"boolean","uniqueKey":"uses_inertia_ssr","typeLabel":"boolean"},"scaling_cpu_threshold_percentage":{"oneOf":[{"type":"integer","minimum":50,"maximum":95,"uniqueKey":"scaling_cpu_threshold_percentage.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":50,"maximum":95,"uniqueKey":"scaling_cpu_threshold_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"scaling_cpu_threshold_percentage","typeLabel":"integer | null"},"scaling_memory_threshold_percentage":{"oneOf":[{"type":"integer","minimum":50,"maximum":95,"uniqueKey":"scaling_memory_threshold_percentage.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":50,"maximum":95,"uniqueKey":"scaling_memory_threshold_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"scaling_memory_threshold_percentage","typeLabel":"integer | null"},"visibility_timeout":{"oneOf":[{"type":"integer","description":"How long a message stays hidden from other workers while one is processing it. Only available when the\norganization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.","examples":[180],"uniqueKey":"visibility_timeout.oneOf.0","typeLabel":"integer"},{"type":"null","description":"How long a message stays hidden from other workers while one is processing it. Only available when the\norganization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.","examples":[180],"uniqueKey":"visibility_timeout.oneOf.1","typeLabel":"null"}],"uniqueKey":"visibility_timeout","typeLabel":"integer | null"},"shutdown_timeout":{"oneOf":[{"type":"integer","description":"The time a worker has to finish its current job before being forcefully shut down. Only available when the\norganization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.","examples":[90],"uniqueKey":"shutdown_timeout.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time a worker has to finish its current job before being forcefully shut down. Only available when the\norganization has the advanced managed queues entitlement; ignored otherwise, and the platform manages it.","examples":[90],"uniqueKey":"shutdown_timeout.oneOf.1","typeLabel":"null"}],"uniqueKey":"shutdown_timeout","typeLabel":"integer | null"},"probes":{"oneOf":[{"type":"object","description":"Custom health checks for the app's web process, keyed by `startup`, `readiness`, and `liveness`. Each check and each of its\nfields (`path`, `port`, `delay`, `interval`, `timeout`, `tries`) is optional and falls back to the platform default. A path selects HTTP and a port alone selects TCP.\nTiming overrides without a path or port keep the default handler. Only applicable to app instances; ignored otherwise. Replaces all existing checks, set to null to\nremove them, or omit it to keep the current checks. The startup check may take at most 600 seconds (delay + interval × tries).","examples":[{"startup":{"path":"/up","tries":60},"readiness":{"path":"/up"}}],"properties":{"startup":{"oneOf":[{"type":"object","properties":{"path":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.path.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.path.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.startup.oneOf.0.path","typeLabel":"string | null"},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.port.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":65535,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.port.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.startup.oneOf.0.port","typeLabel":"integer | null"},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.delay.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"maximum":600,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.delay.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.startup.oneOf.0.delay","typeLabel":"integer | null"},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.interval.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":300,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.startup.oneOf.0.interval","typeLabel":"integer | null"},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.timeout.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":120,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.timeout.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.startup.oneOf.0.timeout","typeLabel":"integer | null"},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.tries.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":1000,"uniqueKey":"probes.oneOf.0.startup.oneOf.0.tries.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.startup.oneOf.0.tries","typeLabel":"integer | null"}},"uniqueKey":"probes.oneOf.0.startup.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"path":{"oneOf":[{"type":"string","maxLength":255},{"type":"null","maxLength":255}]},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535},{"type":"null","minimum":1,"maximum":65535}]},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600},{"type":"null","minimum":0,"maximum":600}]},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300},{"type":"null","minimum":1,"maximum":300}]},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120},{"type":"null","minimum":1,"maximum":120}]},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null","minimum":1,"maximum":1000}]}},"uniqueKey":"probes.oneOf.0.startup.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.startup","typeLabel":"object | null"},"readiness":{"oneOf":[{"type":"object","properties":{"path":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.path.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.path.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.path","typeLabel":"string | null"},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.port.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":65535,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.port.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.port","typeLabel":"integer | null"},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.delay.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"maximum":600,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.delay.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.delay","typeLabel":"integer | null"},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.interval.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":300,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.interval","typeLabel":"integer | null"},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.timeout.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":120,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.timeout.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.timeout","typeLabel":"integer | null"},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.tries.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":1000,"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.tries.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.readiness.oneOf.0.tries","typeLabel":"integer | null"}},"uniqueKey":"probes.oneOf.0.readiness.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"path":{"oneOf":[{"type":"string","maxLength":255},{"type":"null","maxLength":255}]},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535},{"type":"null","minimum":1,"maximum":65535}]},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600},{"type":"null","minimum":0,"maximum":600}]},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300},{"type":"null","minimum":1,"maximum":300}]},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120},{"type":"null","minimum":1,"maximum":120}]},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null","minimum":1,"maximum":1000}]}},"uniqueKey":"probes.oneOf.0.readiness.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.readiness","typeLabel":"object | null"},"liveness":{"oneOf":[{"type":"object","properties":{"path":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.path.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.path.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.path","typeLabel":"string | null"},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.port.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":65535,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.port.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.port","typeLabel":"integer | null"},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.delay.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"maximum":600,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.delay.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.delay","typeLabel":"integer | null"},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.interval.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":300,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.interval","typeLabel":"integer | null"},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.timeout.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":120,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.timeout.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.timeout","typeLabel":"integer | null"},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.tries.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":1000,"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.tries.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.liveness.oneOf.0.tries","typeLabel":"integer | null"}},"uniqueKey":"probes.oneOf.0.liveness.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"path":{"oneOf":[{"type":"string","maxLength":255},{"type":"null","maxLength":255}]},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535},{"type":"null","minimum":1,"maximum":65535}]},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600},{"type":"null","minimum":0,"maximum":600}]},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300},{"type":"null","minimum":1,"maximum":300}]},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120},{"type":"null","minimum":1,"maximum":120}]},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null","minimum":1,"maximum":1000}]}},"uniqueKey":"probes.oneOf.0.liveness.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes.oneOf.0.liveness","typeLabel":"object | null"}},"uniqueKey":"probes.oneOf.0","typeLabel":"object"},{"type":"null","description":"Custom health checks for the app's web process, keyed by `startup`, `readiness`, and `liveness`. Each check and each of its\nfields (`path`, `port`, `delay`, `interval`, `timeout`, `tries`) is optional and falls back to the platform default. A path selects HTTP and a port alone selects TCP.\nTiming overrides without a path or port keep the default handler. Only applicable to app instances; ignored otherwise. Replaces all existing checks, set to null to\nremove them, or omit it to keep the current checks. The startup check may take at most 600 seconds (delay + interval × tries).","examples":[{"startup":{"path":"/up","tries":60},"readiness":{"path":"/up"}}],"properties":{"startup":{"oneOf":[{"type":"object","properties":{"path":{"oneOf":[{"type":"string","maxLength":255},{"type":"null","maxLength":255}]},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535},{"type":"null","minimum":1,"maximum":65535}]},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600},{"type":"null","minimum":0,"maximum":600}]},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300},{"type":"null","minimum":1,"maximum":300}]},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120},{"type":"null","minimum":1,"maximum":120}]},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null","minimum":1,"maximum":1000}]}}},{"type":"null","properties":{"path":{"oneOf":[{"type":"string","maxLength":255},{"type":"null","maxLength":255}]},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535},{"type":"null","minimum":1,"maximum":65535}]},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600},{"type":"null","minimum":0,"maximum":600}]},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300},{"type":"null","minimum":1,"maximum":300}]},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120},{"type":"null","minimum":1,"maximum":120}]},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null","minimum":1,"maximum":1000}]}}}]},"readiness":{"oneOf":[{"type":"object","properties":{"path":{"oneOf":[{"type":"string","maxLength":255},{"type":"null","maxLength":255}]},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535},{"type":"null","minimum":1,"maximum":65535}]},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600},{"type":"null","minimum":0,"maximum":600}]},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300},{"type":"null","minimum":1,"maximum":300}]},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120},{"type":"null","minimum":1,"maximum":120}]},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null","minimum":1,"maximum":1000}]}}},{"type":"null","properties":{"path":{"oneOf":[{"type":"string","maxLength":255},{"type":"null","maxLength":255}]},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535},{"type":"null","minimum":1,"maximum":65535}]},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600},{"type":"null","minimum":0,"maximum":600}]},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300},{"type":"null","minimum":1,"maximum":300}]},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120},{"type":"null","minimum":1,"maximum":120}]},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null","minimum":1,"maximum":1000}]}}}]},"liveness":{"oneOf":[{"type":"object","properties":{"path":{"oneOf":[{"type":"string","maxLength":255},{"type":"null","maxLength":255}]},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535},{"type":"null","minimum":1,"maximum":65535}]},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600},{"type":"null","minimum":0,"maximum":600}]},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300},{"type":"null","minimum":1,"maximum":300}]},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120},{"type":"null","minimum":1,"maximum":120}]},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null","minimum":1,"maximum":1000}]}}},{"type":"null","properties":{"path":{"oneOf":[{"type":"string","maxLength":255},{"type":"null","maxLength":255}]},"port":{"oneOf":[{"type":"integer","minimum":1,"maximum":65535},{"type":"null","minimum":1,"maximum":65535}]},"delay":{"oneOf":[{"type":"integer","minimum":0,"maximum":600},{"type":"null","minimum":0,"maximum":600}]},"interval":{"oneOf":[{"type":"integer","minimum":1,"maximum":300},{"type":"null","minimum":1,"maximum":300}]},"timeout":{"oneOf":[{"type":"integer","minimum":1,"maximum":120},{"type":"null","minimum":1,"maximum":120}]},"tries":{"oneOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null","minimum":1,"maximum":1000}]}}}]}},"uniqueKey":"probes.oneOf.1","typeLabel":"null"}],"uniqueKey":"probes","typeLabel":"object | null"}},"title":"UpdateInstanceRequest","uniqueKey":"","typeLabel":"UpdateInstanceRequest · object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","max_replicas":10,"min_replicas":1,"hibernation_timeout":5,"uses_sleep_mode":true,"sleep_timeout":30,"uses_scheduler":true,"sleep_with_app":true,"uses_octane":true,"uses_inertia_ssr":true,"scaling_cpu_threshold_percentage":72,"scaling_memory_threshold_percentage":72,"visibility_timeout":180,"shutdown_timeout":90,"probes":{"startup":{"path":"/up","tries":60},"readiness":{"path":"/up"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6858b14a-adfb-46f8-adc5-08ba69aff33d":{"description":"`InstanceResource`","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"type":{"type":"string","enum":["instances"],"isRequired":true,"uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"attributes":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"data.attributes.name","typeLabel":"string"},"type":{"type":"string","enum":["app","service","queue","managed_queue"],"title":"InstanceType","isRequired":true,"uniqueKey":"data.attributes.type","typeLabel":"enum\u003cstring>"},"size":{"type":"string","enum":["flex-512mb","flex-1gb","flex-2gb","flex.c-1vcpu-256mb","flex.g-1vcpu-512mb","flex.m-1vcpu-1gb","flex.c-2vcpu-512mb","flex.g-2vcpu-1gb","flex.m-2vcpu-2gb","flex.c-4vcpu-1gb","flex.g-4vcpu-2gb","flex.m-4vcpu-4gb","flex.c-8vcpu-2gb","flex.g-8vcpu-4gb","flex.m-8vcpu-8gb","pro.c-1vcpu-1gb","pro.g-1vcpu-2gb","pro.m-1vcpu-4gb","pro.c-2vcpu-2gb","pro.g-2vcpu-4gb","pro.m-2vcpu-8gb","pro.c-4vcpu-4gb","pro.g-4vcpu-8gb","pro.m-4vcpu-16gb","pro.c-8vcpu-8gb","pro.g-8vcpu-16gb","pro.m-8vcpu-32gb","dedicated.c-0.25vcpu-512mb","dedicated.c-0.5vcpu-1gb","dedicated.c-1vcpu-2gb","dedicated.g-1vcpu-4gb","dedicated.m-1vcpu-8gb","dedicated.c-2vcpu-4gb","dedicated.g-2vcpu-8gb","dedicated.m-2vcpu-16gb","dedicated.c-4vcpu-8gb","dedicated.g-4vcpu-16gb","dedicated.m-4vcpu-32gb","dedicated.c-8vcpu-16gb","dedicated.g-8vcpu-32gb","dedicated.m-8vcpu-64gb","mq-pro-256mb","mq-pro-512mb","mq-pro-1gb","mq-pro-2gb","mq-pro-4gb","mq-pro-8gb","mq-dedicated-256mb","mq-dedicated-512mb","mq-dedicated-1gb","mq-dedicated-2gb","mq-dedicated-4gb","mq-dedicated-8gb","mq-dedicated-16gb","mq.flex.256mb","mq.flex.512mb","mq.flex.1gb","mq.flex.2gb","mq.pro.256mb","mq.pro.512mb","mq.pro.1gb","mq.pro.2gb","mq.pro.4gb","mq.pro.8gb","mq.dedicated.flex.256mb","mq.dedicated.flex.512mb","mq.dedicated.flex.1gb","mq.dedicated.flex.2gb","mq.dedicated.pro.256mb","mq.dedicated.pro.512mb","mq.dedicated.pro.1gb","mq.dedicated.pro.2gb","mq.dedicated.pro.4gb","mq.dedicated.pro.8gb","mq.dedicated.pro.16gb"],"title":"InstanceSize","isRequired":true,"uniqueKey":"data.attributes.size","typeLabel":"enum\u003cstring>"},"scaling_type":{"type":"string","enum":["none","custom","auto"],"title":"InstanceScalingType","isRequired":true,"uniqueKey":"data.attributes.scaling_type","typeLabel":"enum\u003cstring>"},"min_replicas":{"type":"integer","isRequired":true,"uniqueKey":"data.attributes.min_replicas","typeLabel":"integer"},"max_replicas":{"type":"integer","isRequired":true,"uniqueKey":"data.attributes.max_replicas","typeLabel":"integer"},"queue_status":{"oneOf":[{"type":"string","title":"SqsQueueStatus","description":"Current lifecycle status of the managed queue. Null for non-queue instances.","enum":["creating","updating","available","deleting","deleted","unknown"],"isRequired":true,"uniqueKey":"data.attributes.queue_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"data.attributes.queue_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.queue_status","typeLabel":"enum\u003cstring> | null"},"queue_type":{"oneOf":[{"type":"string","title":"SqsQueueType","description":"Whether the managed queue is a standard or FIFO queue. Null for non-queue instances.","enum":["standard","fifo"],"isRequired":true,"uniqueKey":"data.attributes.queue_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"data.attributes.queue_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.queue_type","typeLabel":"enum\u003cstring> | null"},"paused":{"oneOf":[{"type":"boolean","description":"Whether the managed queue is currently paused. Null for non-queue instances.","isRequired":true,"uniqueKey":"data.attributes.paused.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the managed queue is currently paused. Null for non-queue instances.","isRequired":true,"uniqueKey":"data.attributes.paused.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.paused","typeLabel":"boolean | null"},"retire_at":{"oneOf":[{"type":"string","description":"When the instance is scheduled to be retired because its size is being discontinued.","isRequired":true,"uniqueKey":"data.attributes.retire_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the instance is scheduled to be retired because its size is being discontinued.","isRequired":true,"uniqueKey":"data.attributes.retire_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.retire_at","typeLabel":"string | null"},"retired_at":{"oneOf":[{"type":"string","description":"When the instance was retired because its size is no longer supported. Retired instances stop processing jobs until you upgrade.","isRequired":true,"uniqueKey":"data.attributes.retired_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the instance was retired because its size is no longer supported. Retired instances stop processing jobs until you upgrade.","isRequired":true,"uniqueKey":"data.attributes.retired_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.retired_at","typeLabel":"string | null"},"is_default":{"oneOf":[{"type":"boolean","description":"Whether this is the environment's default managed queue. Null for non-queue instances.","isRequired":true,"uniqueKey":"data.attributes.is_default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether this is the environment's default managed queue. Null for non-queue instances.","isRequired":true,"uniqueKey":"data.attributes.is_default.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.is_default","typeLabel":"boolean | null"},"visibility_timeout":{"oneOf":[{"type":"integer","description":"How long, in seconds (0–43200), a received job stays hidden from other workers before it becomes available again. Null for non-queue instances.","isRequired":true,"uniqueKey":"data.attributes.visibility_timeout.oneOf.0","typeLabel":"integer"},{"type":"null","description":"How long, in seconds (0–43200), a received job stays hidden from other workers before it becomes available again. Null for non-queue instances.","isRequired":true,"uniqueKey":"data.attributes.visibility_timeout.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.visibility_timeout","typeLabel":"integer | null"},"polling_interval":{"oneOf":[{"type":"integer","description":"How often, in seconds (1–60), the queue is polled for new jobs. Null for non-queue instances.","isRequired":true,"uniqueKey":"data.attributes.polling_interval.oneOf.0","typeLabel":"integer"},{"type":"null","description":"How often, in seconds (1–60), the queue is polled for new jobs. Null for non-queue instances.","isRequired":true,"uniqueKey":"data.attributes.polling_interval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.polling_interval","typeLabel":"integer | null"},"shutdown_timeout":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"data.attributes.shutdown_timeout.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"data.attributes.shutdown_timeout.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.shutdown_timeout","typeLabel":"integer | null"},"uses_scheduler":{"type":"boolean","isRequired":true,"uniqueKey":"data.attributes.uses_scheduler","typeLabel":"boolean"},"sleep_with_app":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"data.attributes.sleep_with_app.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"data.attributes.sleep_with_app.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.sleep_with_app","typeLabel":"boolean | null"},"hibernation_timeout":{"oneOf":[{"type":"integer","description":"Minutes of inactivity before the app hibernates. Null when hibernation is off, and for non-app instances.","isRequired":true,"uniqueKey":"data.attributes.hibernation_timeout.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Minutes of inactivity before the app hibernates. Null when hibernation is off, and for non-app instances.","isRequired":true,"uniqueKey":"data.attributes.hibernation_timeout.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.hibernation_timeout","typeLabel":"integer | null"},"uses_octane":{"oneOf":[{"type":"boolean","description":"Whether the app is served by Laravel Octane. Null for non-app instances.","isRequired":true,"uniqueKey":"data.attributes.uses_octane.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the app is served by Laravel Octane. Null for non-app instances.","isRequired":true,"uniqueKey":"data.attributes.uses_octane.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.uses_octane","typeLabel":"boolean | null"},"uses_inertia_ssr":{"oneOf":[{"type":"boolean","description":"Whether the app runs an Inertia SSR server. Null for non-app instances.","isRequired":true,"uniqueKey":"data.attributes.uses_inertia_ssr.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the app runs an Inertia SSR server. Null for non-app instances.","isRequired":true,"uniqueKey":"data.attributes.uses_inertia_ssr.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.uses_inertia_ssr","typeLabel":"boolean | null"},"scaling_cpu_threshold_percentage":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"data.attributes.scaling_cpu_threshold_percentage.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"data.attributes.scaling_cpu_threshold_percentage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.scaling_cpu_threshold_percentage","typeLabel":"integer | null"},"scaling_memory_threshold_percentage":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"data.attributes.scaling_memory_threshold_percentage.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"data.attributes.scaling_memory_threshold_percentage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.scaling_memory_threshold_percentage","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.attributes.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.attributes.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.attributes.created_at","typeLabel":"string\u003cdate-time> | null"},"probes":{"oneOf":[{"type":"object","description":"Custom health checks for the app's web process, keyed by `startup`, `readiness`, and `liveness`. Unset checks and\nfields use the platform defaults. A path selects HTTP and a port alone selects TCP. Timing overrides without a path or port keep the default handler. Null when no custom checks are set, and for non-app instances.","properties":{"startup":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"data.attributes.probes.oneOf.0.startup.path","typeLabel":"string"},"port":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.startup.port","typeLabel":"integer"},"delay":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.startup.delay","typeLabel":"integer"},"interval":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.startup.interval","typeLabel":"integer"},"timeout":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.startup.timeout","typeLabel":"integer"},"tries":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.startup.tries","typeLabel":"integer"}},"uniqueKey":"data.attributes.probes.oneOf.0.startup","typeLabel":"object"},"readiness":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"data.attributes.probes.oneOf.0.readiness.path","typeLabel":"string"},"port":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.readiness.port","typeLabel":"integer"},"delay":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.readiness.delay","typeLabel":"integer"},"interval":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.readiness.interval","typeLabel":"integer"},"timeout":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.readiness.timeout","typeLabel":"integer"},"tries":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.readiness.tries","typeLabel":"integer"}},"uniqueKey":"data.attributes.probes.oneOf.0.readiness","typeLabel":"object"},"liveness":{"type":"object","properties":{"path":{"type":"string","uniqueKey":"data.attributes.probes.oneOf.0.liveness.path","typeLabel":"string"},"port":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.liveness.port","typeLabel":"integer"},"delay":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.liveness.delay","typeLabel":"integer"},"interval":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.liveness.interval","typeLabel":"integer"},"timeout":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.liveness.timeout","typeLabel":"integer"},"tries":{"type":"integer","uniqueKey":"data.attributes.probes.oneOf.0.liveness.tries","typeLabel":"integer"}},"uniqueKey":"data.attributes.probes.oneOf.0.liveness","typeLabel":"object"}},"uniqueKey":"data.attributes.probes.oneOf.0","typeLabel":"object"},{"type":"null","description":"Custom health checks for the app's web process, keyed by `startup`, `readiness`, and `liveness`. Unset checks and\nfields use the platform defaults. A path selects HTTP and a port alone selects TCP. Timing overrides without a path or port keep the default handler. Null when no custom checks are set, and for non-app instances.","properties":{"startup":{"type":"object","properties":{"path":{"type":"string"},"port":{"type":"integer"},"delay":{"type":"integer"},"interval":{"type":"integer"},"timeout":{"type":"integer"},"tries":{"type":"integer"}}},"readiness":{"type":"object","properties":{"path":{"type":"string"},"port":{"type":"integer"},"delay":{"type":"integer"},"interval":{"type":"integer"},"timeout":{"type":"integer"},"tries":{"type":"integer"}}},"liveness":{"type":"object","properties":{"path":{"type":"string"},"port":{"type":"integer"},"delay":{"type":"integer"},"interval":{"type":"integer"},"timeout":{"type":"integer"},"tries":{"type":"integer"}}}},"uniqueKey":"data.attributes.probes.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attributes.probes","typeLabel":"object | null"}},"required":["name","type","size","scaling_type","min_replicas","max_replicas","queue_status","queue_type","paused","retire_at","retired_at","is_default","visibility_timeout","polling_interval","shutdown_timeout","uses_scheduler","sleep_with_app","hibernation_timeout","uses_octane","uses_inertia_ssr","scaling_cpu_threshold_percentage","scaling_memory_threshold_percentage","created_at"],"uniqueKey":"data.attributes","typeLabel":"object"},"relationships":{"type":"object","properties":{"environment":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","title":"EnvironmentResourceIdentifier","required":["type","id"],"properties":{"type":{"type":"string","enum":["environments"],"isRequired":true,"uniqueKey":"data.relationships.environment.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"data.relationships.environment.data.oneOf.0.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.relationships.environment.data.oneOf.0","typeLabel":"EnvironmentResourceIdentifier · object"},{"type":"null","isRequired":true,"uniqueKey":"data.relationships.environment.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.relationships.environment.data","typeLabel":"EnvironmentResourceIdentifier · object | null"}},"required":["data"],"uniqueKey":"data.relationships.environment","typeLabel":"object"},"backgroundProcesses":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["background_processes"],"isRequired":true,"uniqueKey":"data.relationships.backgroundProcesses.data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"data.relationships.backgroundProcesses.data.items.[INDEX].id","typeLabel":"string"}},"required":["type","id"],"title":"BackgroundProcessResourceIdentifier","uniqueKey":"data.relationships.backgroundProcesses.data.items.[INDEX]","typeLabel":"BackgroundProcessResourceIdentifier · object"},"isRequired":true,"uniqueKey":"data.relationships.backgroundProcesses.data","typeLabel":"BackgroundProcessResourceIdentifier · object[]"}},"required":["data"],"uniqueKey":"data.relationships.backgroundProcesses","typeLabel":"object"},"scheduledCommands":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["scheduled_commands"],"isRequired":true,"uniqueKey":"data.relationships.scheduledCommands.data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"data.relationships.scheduledCommands.data.items.[INDEX].id","typeLabel":"string"}},"required":["type","id"],"title":"ScheduledCommandResourceIdentifier","uniqueKey":"data.relationships.scheduledCommands.data.items.[INDEX]","typeLabel":"ScheduledCommandResourceIdentifier · object"},"isRequired":true,"uniqueKey":"data.relationships.scheduledCommands.data","typeLabel":"ScheduledCommandResourceIdentifier · object[]"}},"required":["data"],"uniqueKey":"data.relationships.scheduledCommands","typeLabel":"object"}},"uniqueKey":"data.relationships","typeLabel":"object"}},"required":["id","type"],"title":"InstanceResource","isRequired":true,"uniqueKey":"data","typeLabel":"InstanceResource · object"},"included":{"type":"array","items":{"oneOf":[{"type":"object","title":"EnvironmentResource","required":["id","type","links"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.id","typeLabel":"string"},"type":{"type":"string","enum":["environments"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.links.self.href","typeLabel":"string\u003curi>"},"rel":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.0.links.self.rel","typeLabel":"string"},"describedby":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.0.links.self.describedby","typeLabel":"string"},"title":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.0.links.self.title","typeLabel":"string"},"type":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.0.links.self.type","typeLabel":"string"},"hreflang":{"oneOf":[{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.0.links.self.hreflang.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.0.links.self.hreflang.oneOf.1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"included.items.[INDEX].oneOf.0.links.self.hreflang.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"included.items.[INDEX].oneOf.0.links.self.hreflang","typeLabel":"string | string[]"},"meta":{"type":"object","uniqueKey":"included.items.[INDEX].oneOf.0.links.self.meta","typeLabel":"object"}},"required":["href"],"title":"Link","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.links.self","typeLabel":"Link · object"}},"required":["self"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.links","typeLabel":"object"},"attributes":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.name","typeLabel":"string"},"display_name":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.display_name","typeLabel":"string"},"slug":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.slug","typeLabel":"string"},"status":{"type":"string","enum":["deploying","running","hibernating","stopped"],"title":"EnvironmentStatus","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.status","typeLabel":"enum\u003cstring>"},"color":{"type":"string","enum":["blue","green","orange","purple","red","yellow","cyan","gray"],"title":"EnvironmentColor","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.color","typeLabel":"enum\u003cstring>"},"created_from_automation":{"type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.created_from_automation","typeLabel":"boolean"},"pull_request":{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.pull_request","typeLabel":"null"},"vanity_domain":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.vanity_domain","typeLabel":"string"},"framework":{"type":"string","enum":["laravel","symfony","jigsaw","html","php","express","hono","nuxt","next","tanstack","elysia","nestjs","astro","javascript","go","hugo","laravel-go","ruby","rails","jekyll","django","fastapi","flask","pelican","python","java","spring","rust","zola","axum","rocket","actix","warp","laravel-rust"],"title":"Framework","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.framework","typeLabel":"enum\u003cstring>"},"language":{"type":"string","enum":["html","php","javascript","python","go","ruby","java","rust"],"title":"Language","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.language","typeLabel":"enum\u003cstring>"},"php_major_version":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.php_major_version","typeLabel":"string"},"build_command":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.build_command.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.build_command.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.build_command","typeLabel":"string | null"},"node_version":{"type":"string","enum":["20","22","24","26"],"title":"NodeVersion","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.node_version","typeLabel":"enum\u003cstring>"},"deploy_command":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.deploy_command.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.deploy_command.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.deploy_command","typeLabel":"string | null"},"start_command":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.start_command.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.start_command.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.start_command","typeLabel":"string | null"},"uses_octane":{"type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.uses_octane","typeLabel":"boolean"},"uses_hibernation":{"type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.uses_hibernation","typeLabel":"boolean"},"hibernation_wake_up_interval":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.hibernation_wake_up_interval.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.hibernation_wake_up_interval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.hibernation_wake_up_interval","typeLabel":"integer | null"},"timeout":{"type":"integer","description":"The number of seconds the environment will wait for your application to respond before timing out. Changes take effect on the next deployment.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.timeout","typeLabel":"integer"},"shutdown_timeout":{"type":"integer","description":"The number of seconds to wait before stopping the previous deployment's compute instances, allowing it to finish processing requests and jobs after a new deployment becomes active. Changes take effect on the next deployment.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.shutdown_timeout","typeLabel":"integer"},"uses_push_to_deploy":{"type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.uses_push_to_deploy","typeLabel":"boolean"},"uses_deploy_hook":{"type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.uses_deploy_hook","typeLabel":"boolean"},"deploy_hook_url":{"oneOf":[{"type":"string","description":"The URL to send a `POST` request to in order to deploy the environment. `null` when the deploy hook is disabled or the token lacks the `environment_deploy_hook.edit` permission.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.deploy_hook_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to send a `POST` request to in order to deploy the environment. `null` when the deploy hook is disabled or the token lacks the `environment_deploy_hook.edit` permission.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.deploy_hook_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.deploy_hook_url","typeLabel":"string | null"},"uses_http_basic_auth":{"type":"boolean","description":"Whether visitors must sign in with HTTP basic authentication, using the username `admin`. The password is never returned.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.uses_http_basic_auth","typeLabel":"boolean"},"resend":{"oneOf":[{"type":"object","properties":{"from_address":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.resend.oneOf.0.from_address","typeLabel":"string"},"from_name":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.resend.oneOf.0.from_name","typeLabel":"string"},"key_name":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.resend.oneOf.0.key_name","typeLabel":"string"}},"required":["from_address","from_name","key_name"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.resend.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"from_address":{"type":"string"},"from_name":{"type":"string"},"key_name":{"type":"string"}},"required":["from_address","from_name","key_name"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.resend.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.resend","typeLabel":"object | null"},"internal_networking":{"type":"object","description":"The environment's internal networking settings.","properties":{"enabled":{"type":"boolean","description":"Whether other environments on the same cluster can reach this environment over the private network.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.internal_networking.enabled","typeLabel":"boolean"},"hostname":{"oneOf":[{"type":"string","description":"The private hostname other environments use to reach this environment. `null` when internal networking is disabled.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.internal_networking.hostname.oneOf.0","typeLabel":"string"},{"type":"null","description":"The private hostname other environments use to reach this environment. `null` when internal networking is disabled.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.internal_networking.hostname.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.internal_networking.hostname","typeLabel":"string | null"},"access_level":{"oneOf":[{"type":"string","title":"EnvironmentInternalNetworkingAccessLevel","description":"Which environments can send internal traffic to this environment. `null` when internal networking is disabled.","enum":["all","specific"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.internal_networking.access_level.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.internal_networking.access_level.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.internal_networking.access_level","typeLabel":"enum\u003cstring> | null"},"environment_ids":{"type":"array","description":"The IDs of the environments that can send internal traffic to this environment. Empty unless `access_level` is `specific`.","items":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.0.attributes.internal_networking.environment_ids.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.internal_networking.environment_ids","typeLabel":"string[]"}},"required":["enabled","hostname","access_level","environment_ids"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.internal_networking","typeLabel":"object"},"network_settings":{"type":"object","properties":{"cache":{"type":"object","properties":{"strategy":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.cache.strategy","typeLabel":"string"}},"required":["strategy"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.cache","typeLabel":"object"},"response_headers":{"type":"object","properties":{"frame":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.response_headers.frame","typeLabel":"string"},"content_type":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.response_headers.content_type","typeLabel":"string"},"hsts":{"type":"object","properties":{"max_age":{"type":"integer","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.response_headers.hsts.max_age","typeLabel":"integer"},"include_subdomains":{"type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.response_headers.hsts.include_subdomains","typeLabel":"boolean"},"preload":{"type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.response_headers.hsts.preload","typeLabel":"boolean"}},"required":["max_age","include_subdomains","preload"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.response_headers.hsts","typeLabel":"object"}},"required":["frame","content_type","hsts"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.response_headers","typeLabel":"object"},"firewall":{"type":"object","properties":{"bot_categories":{"type":"array","items":{"type":"string","enum":["academic_research","accessibility","advertising_and_marketing","aggregator","ai_assistant","ai_crawler","ai_search","feed_fetcher","monitoring_and_analytics","page_preview","search_engine_crawler","search_engine_optimization","security","social_media_marketing","webhooks","other"],"title":"BotControlCategory","uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.firewall.bot_categories.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.firewall.bot_categories","typeLabel":"enum\u003cstring>[]"},"rate_limit":{"type":"object","properties":{"429":{"type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.firewall.rate_limit.429","typeLabel":"boolean"},"level":{"type":"string","enum":["challenge","throttle","ban"],"title":"RateLimitLevel","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.firewall.rate_limit.level","typeLabel":"enum\u003cstring>"},"per_minute":{"type":"integer","enum":[100,300,500,750,1000],"title":"RateLimitPerMinute","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.firewall.rate_limit.per_minute","typeLabel":"enum\u003cinteger>"},"4xx":{"type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.firewall.rate_limit.4xx","typeLabel":"boolean"}},"required":["level","per_minute","4xx","429"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.firewall.rate_limit","typeLabel":"object"},"under_attack_mode_started_at":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.firewall.under_attack_mode_started_at","typeLabel":"string"},"block_path":{"type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.firewall.block_path","typeLabel":"boolean"}},"required":["bot_categories","rate_limit","under_attack_mode_started_at","block_path"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.firewall","typeLabel":"object"},"content_converter":{"type":"boolean","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings.content_converter","typeLabel":"boolean"}},"required":["cache","response_headers","firewall","content_converter"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.network_settings","typeLabel":"object"},"created_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.created_at","typeLabel":"string\u003cdate-time> | null"},"serving":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.0.attributes.serving","typeLabel":"string"},"post_deploy_command":{"oneOf":[{"type":"string","description":"The commands that run after the deployment goes live. Not returned for preview environments.","uniqueKey":"included.items.[INDEX].oneOf.0.attributes.post_deploy_command.oneOf.0","typeLabel":"string"},{"type":"null","description":"The commands that run after the deployment goes live. Not returned for preview environments.","uniqueKey":"included.items.[INDEX].oneOf.0.attributes.post_deploy_command.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.post_deploy_command","typeLabel":"string | null"},"":{"oneOf":[{"type":"object","required":["environment_variables"],"properties":{"environment_variables":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes..oneOf.0.environment_variables.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes..oneOf.0.environment_variables.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"included.items.[INDEX].oneOf.0.attributes..oneOf.0.environment_variables.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes..oneOf.0.environment_variables","typeLabel":"object[]"}},"uniqueKey":"included.items.[INDEX].oneOf.0.attributes..oneOf.0","typeLabel":"object"},{"type":"array","items":{"type":"string","uniqueKey":"included.items.[INDEX].oneOf.0.attributes..oneOf.1.items.[INDEX]","typeLabel":"string"},"maxItems":0,"minItems":0,"uniqueKey":"included.items.[INDEX].oneOf.0.attributes..oneOf.1","typeLabel":"string[]"}],"uniqueKey":"included.items.[INDEX].oneOf.0.attributes.","typeLabel":"object | string[]"}},"required":["name","display_name","slug","status","color","created_from_automation","pull_request","vanity_domain","framework","language","php_major_version","build_command","node_version","deploy_command","start_command","uses_octane","uses_hibernation","hibernation_wake_up_interval","timeout","shutdown_timeout","uses_push_to_deploy","uses_deploy_hook","deploy_hook_url","uses_http_basic_auth","resend","internal_networking",null,"network_settings","created_at"],"uniqueKey":"included.items.[INDEX].oneOf.0.attributes","typeLabel":"object"},"relationships":{"type":"object","properties":{"application":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","title":"ApplicationResourceIdentifier","required":["type","id"],"properties":{"type":{"type":"string","enum":["applications"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.application.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.application.data.oneOf.0.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.application.data.oneOf.0","typeLabel":"ApplicationResourceIdentifier · object"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.application.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.application.data","typeLabel":"ApplicationResourceIdentifier · object | null"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.application","typeLabel":"object"},"branch":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","title":"BranchResourceIdentifier","required":["type","id"],"properties":{"type":{"type":"string","enum":["branches"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.branch.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.branch.data.oneOf.0.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.branch.data.oneOf.0","typeLabel":"BranchResourceIdentifier · object"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.branch.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.branch.data","typeLabel":"BranchResourceIdentifier · object | null"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.branch","typeLabel":"object"},"deployments":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["deployments"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.deployments.data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.deployments.data.items.[INDEX].id","typeLabel":"string"}},"required":["type","id"],"title":"DeploymentResourceIdentifier","uniqueKey":"included.items.[INDEX].oneOf.0.relationships.deployments.data.items.[INDEX]","typeLabel":"DeploymentResourceIdentifier · object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.deployments.data","typeLabel":"DeploymentResourceIdentifier · object[]"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.deployments","typeLabel":"object"},"currentDeployment":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","title":"DeploymentResourceIdentifier","required":["type","id"],"properties":{"type":{"type":"string","enum":["deployments"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.currentDeployment.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.currentDeployment.data.oneOf.0.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.currentDeployment.data.oneOf.0","typeLabel":"DeploymentResourceIdentifier · object"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.currentDeployment.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.currentDeployment.data","typeLabel":"DeploymentResourceIdentifier · object | null"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.currentDeployment","typeLabel":"object"},"domains":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["domains"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.domains.data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.domains.data.items.[INDEX].id","typeLabel":"string"}},"required":["type","id"],"title":"DomainResourceIdentifier","uniqueKey":"included.items.[INDEX].oneOf.0.relationships.domains.data.items.[INDEX]","typeLabel":"DomainResourceIdentifier · object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.domains.data","typeLabel":"DomainResourceIdentifier · object[]"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.domains","typeLabel":"object"},"primaryDomain":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","title":"DomainResourceIdentifier","required":["type","id"],"properties":{"type":{"type":"string","enum":["domains"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.primaryDomain.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.primaryDomain.data.oneOf.0.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.primaryDomain.data.oneOf.0","typeLabel":"DomainResourceIdentifier · object"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.primaryDomain.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.primaryDomain.data","typeLabel":"DomainResourceIdentifier · object | null"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.primaryDomain","typeLabel":"object"},"instances":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["instances"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.instances.data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.instances.data.items.[INDEX].id","typeLabel":"string"}},"required":["type","id"],"title":"InstanceResourceIdentifier","uniqueKey":"included.items.[INDEX].oneOf.0.relationships.instances.data.items.[INDEX]","typeLabel":"InstanceResourceIdentifier · object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.instances.data","typeLabel":"InstanceResourceIdentifier · object[]"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.instances","typeLabel":"object"},"database":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","title":"DatabaseSchemaResourceIdentifier","required":["type","id"],"properties":{"type":{"type":"string","enum":["databaseSchemas"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.database.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.database.data.oneOf.0.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.database.data.oneOf.0","typeLabel":"DatabaseSchemaResourceIdentifier · object"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.database.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.database.data","typeLabel":"DatabaseSchemaResourceIdentifier · object | null"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.database","typeLabel":"object"},"cache":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","title":"CacheResourceIdentifier","required":["type","id"],"properties":{"type":{"type":"string","enum":["caches"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.cache.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.cache.data.oneOf.0.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.cache.data.oneOf.0","typeLabel":"CacheResourceIdentifier · object"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.cache.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.cache.data","typeLabel":"CacheResourceIdentifier · object | null"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.cache","typeLabel":"object"},"buckets":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["filesystems"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.buckets.data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.buckets.data.items.[INDEX].id","typeLabel":"string"}},"required":["type","id"],"title":"FilesystemResourceIdentifier","uniqueKey":"included.items.[INDEX].oneOf.0.relationships.buckets.data.items.[INDEX]","typeLabel":"FilesystemResourceIdentifier · object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.buckets.data","typeLabel":"FilesystemResourceIdentifier · object[]"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.buckets","typeLabel":"object"},"websocketApplication":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","title":"WebsocketApplicationResourceIdentifier","required":["type","id"],"properties":{"type":{"type":"string","enum":["websocketApplications"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.websocketApplication.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.websocketApplication.data.oneOf.0.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.websocketApplication.data.oneOf.0","typeLabel":"WebsocketApplicationResourceIdentifier · object"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.websocketApplication.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.websocketApplication.data","typeLabel":"WebsocketApplicationResourceIdentifier · object | null"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.websocketApplication","typeLabel":"object"},"secrets":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["secrets"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.secrets.data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.secrets.data.items.[INDEX].id","typeLabel":"string"}},"required":["type","id"],"title":"SecretResourceIdentifier","uniqueKey":"included.items.[INDEX].oneOf.0.relationships.secrets.data.items.[INDEX]","typeLabel":"SecretResourceIdentifier · object"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.secrets.data","typeLabel":"SecretResourceIdentifier · object[]"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.0.relationships.secrets","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.0.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.0","typeLabel":"EnvironmentResource · object"},{"type":"object","title":"BackgroundProcessResource","required":["id","type"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.id","typeLabel":"string"},"type":{"type":"string","enum":["background_processes"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"attributes":{"type":"object","properties":{"type":{"type":"string","enum":["worker","custom"],"title":"DaemonType","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.type","typeLabel":"enum\u003cstring>"},"processes":{"type":"integer","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.processes","typeLabel":"integer"},"command":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.command","typeLabel":"string"},"config":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.config.items.[INDEX]","typeLabel":"any"},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.config","typeLabel":"any[]"},"strategy_type":{"type":"string","enum":["none","growth_rate","queue_size"],"title":"DaemonStrategyType","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.strategy_type","typeLabel":"enum\u003cstring>"},"strategy_threshold":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.strategy_threshold.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.strategy_threshold.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.strategy_threshold","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.attributes.created_at","typeLabel":"string\u003cdate-time> | null"}},"required":["type","processes","command","config","strategy_type","strategy_threshold","created_at"],"uniqueKey":"included.items.[INDEX].oneOf.1.attributes","typeLabel":"object"},"relationships":{"type":"object","properties":{"instance":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","title":"InstanceResourceIdentifier","required":["type","id"],"properties":{"type":{"type":"string","enum":["instances"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.instance.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.instance.data.oneOf.0.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.instance.data.oneOf.0","typeLabel":"InstanceResourceIdentifier · object"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.instance.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.instance.data","typeLabel":"InstanceResourceIdentifier · object | null"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.1.relationships.instance","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.1.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.1","typeLabel":"BackgroundProcessResource · object"},{"type":"object","title":"ScheduledCommandResource","required":["id","type"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.id","typeLabel":"string"},"type":{"type":"string","enum":["scheduled_commands"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"attributes":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.name","typeLabel":"string | null"},"command":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.command","typeLabel":"string"},"schedule":{"type":"string","description":"The cron expression the command runs on, evaluated in UTC.","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.schedule","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.attributes.created_at","typeLabel":"string\u003cdate-time> | null"}},"required":["name","command","schedule","created_at"],"uniqueKey":"included.items.[INDEX].oneOf.2.attributes","typeLabel":"object"},"relationships":{"type":"object","properties":{"instance":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","title":"InstanceResourceIdentifier","required":["type","id"],"properties":{"type":{"type":"string","enum":["instances"],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.instance.data.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.instance.data.oneOf.0.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.instance.data.oneOf.0","typeLabel":"InstanceResourceIdentifier · object"},{"type":"null","isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.instance.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.instance.data","typeLabel":"InstanceResourceIdentifier · object | null"}},"required":["data"],"uniqueKey":"included.items.[INDEX].oneOf.2.relationships.instance","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.2.relationships","typeLabel":"object"}},"uniqueKey":"included.items.[INDEX].oneOf.2","typeLabel":"ScheduledCommandResource · object"}],"uniqueKey":"included.items.[INDEX]","typeLabel":"EnvironmentResource · object | BackgroundProcessResource · object | ScheduledCommandResource · object"},"uniqueKey":"included","typeLabel":"(EnvironmentResource · object | BackgroundProcessResource · object | ScheduledCommandResource · object)[]"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"\u003cstring>","type":"instances","attributes":{"name":"\u003cstring>","type":"app","size":"flex-512mb","scaling_type":"none","min_replicas":123,"max_replicas":123,"queue_status":"creating","queue_type":"standard","paused":true,"retire_at":"\u003cstring>","retired_at":"\u003cstring>","is_default":true,"visibility_timeout":123,"polling_interval":123,"shutdown_timeout":123,"uses_scheduler":true,"sleep_with_app":true,"hibernation_timeout":123,"uses_octane":true,"uses_inertia_ssr":true,"scaling_cpu_threshold_percentage":123,"scaling_memory_threshold_percentage":123,"created_at":"2023-11-07T05:31:56Z","probes":{"startup":{"path":"\u003cstring>","port":123,"delay":123,"interval":123,"timeout":123,"tries":123},"readiness":{"path":"\u003cstring>","port":123,"delay":123,"interval":123,"timeout":123,"tries":123},"liveness":{"path":"\u003cstring>","port":123,"delay":123,"interval":123,"timeout":123,"tries":123}}},"relationships":{"environment":{"data":{"type":"environments","id":"\u003cstring>"}},"backgroundProcesses":{"data":[{"type":"background_processes","id":"\u003cstring>"}]},"scheduledCommands":{"data":[{"type":"scheduled_commands","id":"\u003cstring>"}]}}},"included":[{"id":"\u003cstring>","type":"environments","links":{"self":{"href":"\u003cstring>","rel":"\u003cstring>","describedby":"\u003cstring>","title":"\u003cstring>","type":"\u003cstring>","hreflang":"\u003cstring>","meta":{}}},"attributes":{"name":"\u003cstring>","display_name":"\u003cstring>","slug":"\u003cstring>","status":"deploying","color":"blue","created_from_automation":true,"pull_request":null,"vanity_domain":"\u003cstring>","framework":"laravel","language":"html","php_major_version":"\u003cstring>","build_command":"\u003cstring>","node_version":"20","deploy_command":"\u003cstring>","start_command":"\u003cstring>","uses_octane":true,"uses_hibernation":true,"hibernation_wake_up_interval":123,"timeout":123,"shutdown_timeout":123,"uses_push_to_deploy":true,"uses_deploy_hook":true,"deploy_hook_url":"\u003cstring>","uses_http_basic_auth":true,"resend":{"from_address":"\u003cstring>","from_name":"\u003cstring>","key_name":"\u003cstring>"},"internal_networking":{"enabled":true,"hostname":"\u003cstring>","access_level":"all","environment_ids":["\u003cstring>"]},"network_settings":{"cache":{"strategy":"\u003cstring>"},"response_headers":{"frame":"\u003cstring>","content_type":"\u003cstring>","hsts":{"max_age":123,"include_subdomains":true,"preload":true}},"firewall":{"bot_categories":["academic_research"],"rate_limit":{"429":true,"level":"challenge","per_minute":100,"4xx":true},"under_attack_mode_started_at":"\u003cstring>","block_path":true},"content_converter":true},"created_at":"2023-11-07T05:31:56Z","serving":"\u003cstring>","post_deploy_command":"\u003cstring>","":{"environment_variables":[{"key":"\u003cstring>","value":"\u003cstring>"}]}},"relationships":{"application":{"data":{"type":"applications","id":"\u003cstring>"}},"branch":{"data":{"type":"branches","id":"\u003cstring>"}},"deployments":{"data":[{"type":"deployments","id":"\u003cstring>"}]},"currentDeployment":{"data":{"type":"deployments","id":"\u003cstring>"}},"domains":{"data":[{"type":"domains","id":"\u003cstring>"}]},"primaryDomain":{"data":{"type":"domains","id":"\u003cstring>"}},"instances":{"data":[{"type":"instances","id":"\u003cstring>"}]},"database":{"data":{"type":"databaseSchemas","id":"\u003cstring>"}},"cache":{"data":{"type":"caches","id":"\u003cstring>"}},"buckets":{"data":[{"type":"filesystems","id":"\u003cstring>"}]},"websocketApplication":{"data":{"type":"websocketApplications","id":"\u003cstring>"}},"secrets":{"data":[{"type":"secrets","id":"\u003cstring>"}]}}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"c49295ef-613a-46a7-bcc9-870bbaf70d55":{"description":"Authorization error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a2c84cff-96dc-4431-b708-1c5e9fa2e11f":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"03eb0523-1e4b-4064-8705-ebd8c95a27d5":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Errors overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","description":"A detailed description of each field that failed validation.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object"}},"required":["message","errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0af7a3bb-31a6-4f3e-8df2-26b0ea3c7a87":{"http":{"type":"http","description":"The Bearer Token generated on the Cloud UI.","scheme":"bearer","bearerFormat":"bearer","scopes":[],"schemeName":"http"}}},"servers":{"50ce4a97-515e-4c97-9895-7f81adc7e954":{"url":"https://cloud.laravel.com/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"The Bearer Token generated on the Cloud UI.","scheme":"bearer","bearerFormat":"bearer","scopes":[],"schemeName":"http"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The Bearer Token generated on the Cloud UI.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"http","name":"Authorization"}],"title":"http"}]},"originalFileLocation":"https://cloud.laravel.com/api-docs/api.json"},"subdomain":"cloud","siteName":"Laravel Cloud","title":"Update instance - Laravel Cloud","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T21:07:07.568Z","originalFileLocation":"api/instances/update-instance.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=\"Update an instance.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Laravel Cloud\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_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=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update instance - Laravel Cloud\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update an instance.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Laravel Cloud\">\u003cmeta data-mint-head property=\"og:url\" content=\"/cloud/docs/api/instances/update-instance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cloud.mintlify.site/docs/_mintlify/api/og/v2?division=Instances\u0026amp;title=Update+instance\u0026amp;description=Update+an+instance.\u0026amp;theme=546869994471480339332f3d\u0026amp;signature=c4b9cc7462fba889c53ea78534847720007d1f4574f80a1d91eed97d597ac283\">\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=\"Update instance - Laravel Cloud\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update an instance.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cloud.mintlify.site/docs/_mintlify/api/og/v2?division=Instances\u0026amp;title=Update+instance\u0026amp;description=Update+an+instance.\u0026amp;theme=546869994471480339332f3d\u0026amp;signature=c4b9cc7462fba889c53ea78534847720007d1f4574f80a1d91eed97d597ac283\">\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=\"/cloud/docs/mintlify-assets/_mintlify/favicons/cloud/CwnEEs8UQ8WD3Jou/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Laravel Cloud\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0057FF\">\u003clink data-mint-head rel=\"canonical\" href=\"/cloud/docs/api/instances/update-instance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/cloud/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/cloud/docs/api/instances/update-instance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://cloud.laravel.com/#organization\",\"name\":\"Laravel Cloud\",\"url\":\"https://cloud.laravel.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cloud/MkfTsQSKGENWqY-2/logo/laravel-logo-light.png?fit=max\u0026auto=format\u0026n=MkfTsQSKGENWqY-2\u0026q=85\u0026s=f508d8e9c4e3c842e83d055cc376daa1\"}},{\"@type\":\"WebSite\",\"@id\":\"/cloud/docs#website\",\"name\":\"Laravel Cloud\",\"url\":\"/cloud/docs\",\"publisher\":{\"@id\":\"https://cloud.laravel.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"/cloud/docs/api/instances/update-instance#webpage\",\"url\":\"/cloud/docs/api/instances/update-instance\",\"name\":\"Update instance\",\"description\":\"Update an instance.\",\"dateModified\":\"2026-11-20T21:07:07.568Z\",\"isPartOf\":{\"@id\":\"/cloud/docs#website\"},\"breadcrumb\":{\"@id\":\"/cloud/docs/api/instances/update-instance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"/cloud/docs/api/instances/update-instance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"/cloud/docs/api/applications/list-applications\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Instances\",\"item\":\"/cloud/docs/api/instances/list-instances\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update instance\",\"item\":\"/cloud/docs/api/instances/update-instance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"/cloud/docs/api/instances/update-instance#apireference\",\"headline\":\"Update instance\",\"name\":\"Update instance\",\"description\":\"Update an instance.\",\"url\":\"/cloud/docs/api/instances/update-instance\",\"mainEntityOfPage\":{\"@id\":\"/cloud/docs/api/instances/update-instance#webpage\"},\"dateModified\":\"2026-11-20T21:07:07.568Z\",\"publisher\":{\"@id\":\"https://cloud.laravel.com/#organization\"},\"isPartOf\":{\"@id\":\"/cloud/docs#website\"}}]}\u003c/script>","agentPointerHref":"/cloud/docs/api/instances/update-instance.md","siteName":"Laravel Cloud","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/intro"}]},{"tab":"Knowledge Base","pages":[{"title":"Knowledge Base","href":"/knowledge-base/intro"}]},{"tab":"API","icon":"square-terminal","groups":[{"group":"Overview","pages":[{"title":"Laravel Cloud API","sidebarTitle":"Introduction","href":"/api/introduction"},{"title":"API authentication for Laravel Cloud","sidebarTitle":"Authentication","href":"/api/authentication"}]},{"group":"CLI","pages":[{"title":"Laravel Cloud CLI","sidebarTitle":"Laravel Cloud CLI","href":"/api/cli"},{"title":"Stripe Projects","sidebarTitle":"Stripe Projects CLI","href":"/api/stripe-projects"}]},{"group":"Endpoints","boost":0.5,"pages":[{"group":"Applications","pages":[{"title":"List applications","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /applications","href":"/api/applications/list-applications"},{"title":"Create application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /applications","href":"/api/applications/create-application"},{"title":"Get application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /applications/{application}","href":"/api/applications/get-application"},{"title":"Delete application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /applications/{application}","href":"/api/applications/delete-application"},{"title":"Update application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /applications/{application}","href":"/api/applications/update-application"},{"title":"Upload application avatar","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /applications/{application}/avatar","href":"/api/applications/upload-application-avatar"},{"title":"Delete application avatar","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /applications/{application}/avatar","href":"/api/applications/delete-application-avatar"}]},{"group":"Background Processes","pages":[{"title":"List background processes","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /instances/{instance}/background-processes","href":"/api/background-processes/list-background-processes"},{"title":"Create background process","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/background-processes","href":"/api/background-processes/create-background-process"},{"title":"Get background process","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /background-processes/{backgroundProcess}","href":"/api/background-processes/get-background-process"},{"title":"Delete background process","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /background-processes/{backgroundProcess}","href":"/api/background-processes/delete-background-process"},{"title":"Update background process","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /background-processes/{backgroundProcess}","href":"/api/background-processes/update-background-process"}]},{"group":"Bucket Keys","pages":[{"title":"List object storage keys","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /buckets/{filesystem}/keys","href":"/api/bucket-keys/list-object-storage-keys"},{"title":"Create object storage key","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /buckets/{filesystem}/keys","href":"/api/bucket-keys/create-object-storage-key"},{"title":"Get object storage key","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /bucket-keys/{filesystemKey}","href":"/api/bucket-keys/get-object-storage-key"},{"title":"Delete object storage key","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /bucket-keys/{filesystemKey}","href":"/api/bucket-keys/delete-object-storage-key"},{"title":"Update object storage key","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /bucket-keys/{filesystemKey}","href":"/api/bucket-keys/update-object-storage-key"}]},{"group":"Caches","pages":[{"title":"List all available cache types with their configuration options","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /caches/types","href":"/api/caches/list-all-available-cache-types-with-their-configuration-options"},{"title":"List caches","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /caches","href":"/api/caches/list-caches"},{"title":"Create cache","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /caches","href":"/api/caches/create-cache"},{"title":"Get cache","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /caches/{cache}","href":"/api/caches/get-cache"},{"title":"Delete cache","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /caches/{cache}","href":"/api/caches/delete-cache"},{"title":"Update cache","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /caches/{cache}","href":"/api/caches/update-cache"},{"title":"Get cache metrics","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /caches/{cache}/metrics","href":"/api/caches/get-cache-metrics"}]},{"group":"Commands","pages":[{"title":"List commands","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/commands","href":"/api/commands/list-commands"},{"title":"Run command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/commands","href":"/api/commands/run-command"},{"title":"Get command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /commands/{command}","href":"/api/commands/get-command"}]},{"group":"Database Clusters","pages":[{"title":"List database types","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/types","href":"/api/database-clusters/list-database-types"},{"title":"List database presets","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/presets","href":"/api/database-clusters/list-database-presets"},{"title":"List database clusters","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters","href":"/api/database-clusters/list-database-clusters"},{"title":"Create database cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases/clusters","href":"/api/database-clusters/create-database-cluster"},{"title":"Get database cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}","href":"/api/database-clusters/get-database-cluster"},{"title":"Delete database cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /databases/clusters/{database}","href":"/api/database-clusters/delete-database-cluster"},{"title":"Update database cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /databases/clusters/{database}","href":"/api/database-clusters/update-database-cluster"},{"title":"Get database cluster metrics","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/metrics","href":"/api/database-clusters/get-database-cluster-metrics"}]},{"group":"Database Restores","pages":[{"title":"Create a database restore","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases/clusters/{database}/restore","href":"/api/database-restores/create-a-database-restore"}]},{"group":"Database Snapshots","pages":[{"title":"List database snapshots","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/snapshots","href":"/api/database-snapshots/list-database-snapshots"},{"title":"Create a database snapshot","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases/clusters/{database}/snapshots","href":"/api/database-snapshots/create-a-database-snapshot"},{"title":"Get a database snapshot","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /database-snapshots/{databaseSnapshot}","href":"/api/database-snapshots/get-a-database-snapshot"},{"title":"Delete a database snapshot","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /database-snapshots/{databaseSnapshot}","href":"/api/database-snapshots/delete-a-database-snapshot"}]},{"group":"Database Users","pages":[{"title":"List database users","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/users","href":"/api/database-users/list-database-users"},{"title":"Create a database user","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases/clusters/{database}/users","href":"/api/database-users/create-a-database-user"},{"title":"Get a database user","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/users/{databaseUser}","href":"/api/database-users/get-a-database-user"},{"title":"Delete a database user","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /databases/clusters/{database}/users/{databaseUser}","href":"/api/database-users/delete-a-database-user"},{"title":"Update a database user","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /databases/clusters/{database}/users/{databaseUser}","href":"/api/database-users/update-a-database-user"}]},{"group":"Databases","pages":[{"title":"List databases","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/databases","href":"/api/databases/list-databases"},{"title":"Create a database","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases/clusters/{database}/databases","href":"/api/databases/create-a-database"},{"title":"Get a database","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/clusters/{database}/databases/{schema}","href":"/api/databases/get-a-database"},{"title":"Delete a database","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /databases/clusters/{database}/databases/{schema}","href":"/api/databases/delete-a-database"}]},{"group":"Databases (Legacy)","pages":[{"title":"List databases","deprecated":true,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases","href":"/api/databases-legacy/list-databases"},{"title":"Create database","deprecated":true,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /databases","href":"/api/databases-legacy/create-database"},{"title":"Get database","deprecated":true,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /databases/{database}","href":"/api/databases-legacy/get-database"},{"title":"Delete database","deprecated":true,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /databases/{database}","href":"/api/databases-legacy/delete-database"},{"title":"Update database","deprecated":true,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /databases/{database}","href":"/api/databases-legacy/update-database"}]},{"group":"Dedicated Clusters","pages":[{"title":"List dedicated clusters","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /dedicated-clusters","href":"/api/dedicated-clusters/list-dedicated-clusters"}]},{"group":"Deployments","pages":[{"title":"List deployments","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/deployments","href":"/api/deployments/list-deployments"},{"title":"Initiate deployment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/deployments","href":"/api/deployments/initiate-deployment"},{"title":"List queued deployments","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/queued-deployments","href":"/api/deployments/list-queued-deployments"},{"title":"Get deployment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /deployments/{deployment}","href":"/api/deployments/get-deployment"},{"title":"Get deployment logs","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /deployments/{deployment}/logs","href":"/api/deployments/get-deployment-logs"},{"title":"Get queued deployment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /queued-deployments/{queuedDeployment}","href":"/api/deployments/get-queued-deployment"}]},{"group":"Domains","pages":[{"title":"List domains","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/domains","href":"/api/domains/list-domains"},{"title":"Create domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/domains","href":"/api/domains/create-domain"},{"title":"Get domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /domains/{domain}","href":"/api/domains/get-domain"},{"title":"Delete domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /domains/{domain}","href":"/api/domains/delete-domain"},{"title":"Update domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /domains/{domain}","href":"/api/domains/update-domain"},{"title":"Verify a domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /domains/{domain}/verify","href":"/api/domains/verify-a-domain"}]},{"group":"Edge Networks","pages":[{"title":"List edge networks","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /edge-networks","href":"/api/edge-networks/list-edge-networks"},{"title":"List rulesets","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /edge-networks/{edgeNetwork}/rulesets","href":"/api/edge-networks/list-rulesets"},{"title":"Get a ruleset","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /edge-networks/{edgeNetwork}/rulesets/{ruleset}","href":"/api/edge-networks/get-a-ruleset"},{"title":"List rules","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules","href":"/api/edge-networks/list-rules"},{"title":"Create a rule","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules","href":"/api/edge-networks/create-a-rule"},{"title":"Get a rule","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules/{rule}","href":"/api/edge-networks/get-a-rule"},{"title":"Delete a rule","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules/{rule}","href":"/api/edge-networks/delete-a-rule"},{"title":"Update a rule","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /edge-networks/{edgeNetwork}/rulesets/{ruleset}/rules/{rule}","href":"/api/edge-networks/update-a-rule"}]},{"group":"Email","pages":[{"title":"Attach Resend to environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/resend","href":"/api/email/attach-resend-to-environment"},{"title":"Detach Resend from environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /environments/{environment}/resend","href":"/api/email/detach-resend-from-environment"},{"title":"Update environment Resend sender","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /environments/{environment}/resend","href":"/api/email/update-environment-resend-sender"},{"title":"List reusable sending keys","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/resend/keys","href":"/api/email/list-reusable-sending-keys"},{"title":"List sending domains","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /resend/domains","href":"/api/email/list-sending-domains"}]},{"group":"Environments","pages":[{"title":"List environments","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /applications/{application}/environments","href":"/api/environments/list-environments"},{"title":"Create environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /applications/{application}/environments","href":"/api/environments/create-environment"},{"title":"List environment logs","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/logs","href":"/api/environments/list-environment-logs"},{"title":"Get environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}","href":"/api/environments/get-environment"},{"title":"Delete environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /environments/{environment}","href":"/api/environments/delete-environment"},{"title":"Update environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /environments/{environment}","href":"/api/environments/update-environment"},{"title":"Start environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/start","href":"/api/environments/start-environment"},{"title":"Stop environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/stop","href":"/api/environments/stop-environment"},{"title":"Purge edge cache","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/purge-edge-cache","href":"/api/environments/purge-edge-cache"},{"title":"Update vanity domain","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json put /environments/{environment}/vanity-domain","href":"/api/environments/update-vanity-domain"},{"title":"Add environment variables","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/variables","href":"/api/environments/add-environment-variables"},{"title":"Delete environment variables","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/variables/delete","href":"/api/environments/delete-environment-variables"},{"title":"Get environment metrics","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/metrics","href":"/api/environments/get-environment-metrics"},{"title":"Attach secrets to environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/secrets","href":"/api/environments/attach-secrets-to-environment"},{"title":"Detach secret from environment","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /environments/{environment}/secrets/{secret}","href":"/api/environments/detach-secret-from-environment"},{"title":"Enable environment internal networking","deprecated":null,"version":null,"tag":"Private Cloud","openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/internal-networking","href":"/api/environments/enable-environment-internal-networking"},{"title":"Disable environment internal networking","deprecated":null,"version":null,"tag":"Private Cloud","openapi":"https://cloud.laravel.com/api-docs/api.json delete /environments/{environment}/internal-networking","href":"/api/environments/disable-environment-internal-networking"},{"title":"Update environment internal networking","deprecated":null,"version":null,"tag":"Private Cloud","openapi":"https://cloud.laravel.com/api-docs/api.json patch /environments/{environment}/internal-networking","href":"/api/environments/update-environment-internal-networking"}]},{"group":"Instances","pages":[{"title":"List instances","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /environments/{environment}/instances","href":"/api/instances/list-instances"},{"title":"Create instance","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /environments/{environment}/instances","href":"/api/instances/create-instance"},{"title":"List instance sizes","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /instances/sizes","href":"/api/instances/list-instance-sizes"},{"title":"Get instance","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /instances/{instance}","href":"/api/instances/get-instance"},{"title":"Delete instance","description":"Delete an instance.","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /instances/{instance}","href":"/api/instances/delete-instance"},{"title":"Update instance","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /instances/{instance}","href":"/api/instances/update-instance"},{"title":"Pause a managed queue","description":"Stop dispatching jobs to the queue's workers; queued messages are retained until it is resumed.","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/pause","href":"/api/instances/pause-a-managed-queue"},{"title":"Resume a managed queue","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/resume","href":"/api/instances/resume-a-managed-queue"},{"title":"Purge a managed queue","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/purge","href":"/api/instances/purge-a-managed-queue"},{"title":"Set the default managed queue","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/default","href":"/api/instances/set-the-default-managed-queue"},{"title":"List managed queue failed jobs","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /instances/{instance}/failed-jobs","href":"/api/instances/list-managed-queue-failed-jobs"},{"title":"Delete managed queue failed jobs","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /instances/{instance}/failed-jobs","href":"/api/instances/delete-managed-queue-failed-jobs"},{"title":"Retry a managed queue failed job","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/failed-jobs/{jobId}/retry","href":"/api/instances/retry-a-managed-queue-failed-job"},{"title":"Delete a managed queue failed job","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /instances/{instance}/failed-jobs/{jobId}","href":"/api/instances/delete-a-managed-queue-failed-job"}]},{"group":"Meta","pages":[{"title":"Submit agent feedback","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /feedback","href":"/api/meta/submit-agent-feedback"},{"title":"Get organization","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /meta/organization","href":"/api/meta/get-organization"},{"title":"List regions","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /meta/regions","href":"/api/meta/list-regions"}]},{"group":"Object Storage Buckets","pages":[{"title":"List object storage buckets","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /buckets","href":"/api/object-storage-buckets/list-object-storage-buckets"},{"title":"Create object storage bucket","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /buckets","href":"/api/object-storage-buckets/create-object-storage-bucket"},{"title":"Get object storage bucket","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /buckets/{filesystem}","href":"/api/object-storage-buckets/get-object-storage-bucket"},{"title":"Delete object storage bucket","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /buckets/{filesystem}","href":"/api/object-storage-buckets/delete-object-storage-bucket"},{"title":"Update object storage bucket","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /buckets/{filesystem}","href":"/api/object-storage-buckets/update-object-storage-bucket"}]},{"group":"Scheduled Commands","pages":[{"title":"List scheduled commands","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /instances/{instance}/scheduled-commands","href":"/api/scheduled-commands/list-scheduled-commands"},{"title":"Create scheduled command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /instances/{instance}/scheduled-commands","href":"/api/scheduled-commands/create-scheduled-command"},{"title":"Get scheduled command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /scheduled-commands/{scheduledCommand}","href":"/api/scheduled-commands/get-scheduled-command"},{"title":"Delete scheduled command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /scheduled-commands/{scheduledCommand}","href":"/api/scheduled-commands/delete-scheduled-command"},{"title":"Update scheduled command","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /scheduled-commands/{scheduledCommand}","href":"/api/scheduled-commands/update-scheduled-command"}]},{"group":"Secrets","pages":[{"title":"Get secrets public key","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /secrets/public-key","href":"/api/secrets/get-secrets-public-key"},{"title":"List secrets","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /secrets","href":"/api/secrets/list-secrets"},{"title":"Create secret","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /secrets","href":"/api/secrets/create-secret"},{"title":"Delete secret","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /secrets/{secret}","href":"/api/secrets/delete-secret"},{"title":"Update secret","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /secrets/{secret}","href":"/api/secrets/update-secret"}]},{"group":"Usage","pages":[{"title":"Get usage","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /usage","href":"/api/usage/get-usage"}]},{"group":"WebSocket Applications","pages":[{"title":"List WebSocket applications","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-servers/{websocketServer}/applications","href":"/api/websocket-applications/list-websocket-applications"},{"title":"Create WebSocket application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /websocket-servers/{websocketServer}/applications","href":"/api/websocket-applications/create-websocket-application"},{"title":"Get WebSocket application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-applications/{websocketApplication}","href":"/api/websocket-applications/get-websocket-application"},{"title":"Delete WebSocket application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /websocket-applications/{websocketApplication}","href":"/api/websocket-applications/delete-websocket-application"},{"title":"Update WebSocket application","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /websocket-applications/{websocketApplication}","href":"/api/websocket-applications/update-websocket-application"},{"title":"Get WebSocket application metrics","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-applications/{websocketApplication}/metrics","href":"/api/websocket-applications/get-websocket-application-metrics"}]},{"group":"WebSocket Clusters","pages":[{"title":"List WebSocket cluster types","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-servers/types","href":"/api/websocket-clusters/list-websocket-cluster-types"},{"title":"List WebSocket clusters","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-servers","href":"/api/websocket-clusters/list-websocket-clusters"},{"title":"Create WebSocket cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json post /websocket-servers","href":"/api/websocket-clusters/create-websocket-cluster"},{"title":"Get WebSocket cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-servers/{websocketServer}","href":"/api/websocket-clusters/get-websocket-cluster"},{"title":"Delete WebSocket cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json delete /websocket-servers/{websocketServer}","href":"/api/websocket-clusters/delete-websocket-cluster"},{"title":"Update WebSocket cluster","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json patch /websocket-servers/{websocketServer}","href":"/api/websocket-clusters/update-websocket-cluster"},{"title":"Get WebSocket cluster metrics","deprecated":null,"version":null,"openapi":"https://cloud.laravel.com/api-docs/api.json get /websocket-servers/{websocketServer}/metrics","href":"/api/websocket-clusters/get-websocket-cluster-metrics"}]}]}]}]},"basePath":"","title":"Update instance - Laravel Cloud","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-Dk-T3rBp.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","CodeSnippet-CTZvgJfu.js","getApiPlaygroundDisplay-BK2o1XYu.js","Page--B9YZ09u.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js"]}