{"openapi":"3.1.0","info":{"description":"The Control Panel API answers JSON over HTTPS. Send a personal access token as a bearer token with every request.\nEach endpoint needs one token scope (`read`, `write`, `exec` or `destructive`), named on its page.\n","summary":"Manage sites, environments, clusters and your organisation over HTTPS.","title":"Corefinity Control Panel API","version":"1.0"},"servers":[{"description":"Production","url":"https://manage.corefinity.com/api"}],"security":[{"bearerAuth":[]}],"tags":[{"description":"A site's SSH and SFTP users and the keys they log in with.","name":"Access"},{"description":"The person a token belongs to.","name":"Account"},{"description":"How long you stay signed in to the Control Panel, the browsers that skip your two-factor code, and signing out everywhere.","name":"Account security"},{"description":"The agencies your company is a client of, an agency's client companies, and detaching a link.","name":"Agencies and clients"},{"description":"For agencies. The leads you refer to Corefinity, your page in the partner directory and the changes you ask for on it.","name":"Agency"},{"description":"The application lines a site can be created with, and the line and version each site runs.","name":"Application versions"},{"description":"Your company's billing account, usage, invoices, credits, payment methods, prices and quotes.","name":"Billing"},{"description":"A company's Cloudflare connection, and a site's zone, SSL/TLS mode and cache.","name":"Cloudflare"},{"description":"Copy one environment onto another, push it to live, and follow or cancel a copy that waits its turn.","name":"Copies"},{"description":"Your CoreClusters, their sites, usage, activity and capacity, and creating and deleting one.","name":"CoreCluster"},{"description":"Creating a site, and the one-time admin login of a fresh install.","name":"Create a site"},{"description":"A site's database, its users and access to it from outside the site.","name":"Database"},{"description":"The demo sites and clusters of your company, and keeping one so it carries on as a paid service.","name":"Demos"},{"description":"The build, database and after-deploy stages a site's deployments run, with their settings, versions and rehearsals.","name":"Deployment pipeline"},{"description":"A company's deployment pipeline for each platform, which its environments follow, with the company's variables and registry secrets.","name":"Deployment templates"},{"description":"Deploy code to a site, follow a deployment and read how deployments have gone.","name":"Deployments"},{"description":"The addresses a site answers on, DNS checks, attaching a domain and changing a site's address.","name":"Domains"},{"description":"Copies of a CoreStack Enterprise environment into one of your own protected CoreCluster sites.","name":"Enterprise copies"},{"description":"Deployments, pipelines and repositories of a CoreStack Enterprise environment.","name":"Enterprise deployments"},{"description":"The variables a CoreStack Enterprise environment's builds and deployments read.","name":"Environment variables"},{"description":"A site's environments, their settings and sizes.","name":"Environments"},{"description":"The pages a site shows for an error, and which errors show them.","name":"Error pages"},{"description":"Feature requests, bug reports, general feedback and platform requests for Corefinity's product team.","name":"Feedback"},{"description":"The addresses that may connect to your environments over SSH, or see their websites while protected.","name":"Firewall"},{"description":"The jobs waiting in a Laravel site's queues.","name":"Laravel queues"},{"description":"Search, export and measure the logs of a site or of every site on a CoreCluster.","name":"Logs"},{"description":"Magento websites and store views, and which store each served address shows.","name":"Magento stores"},{"description":"A site's maintenance switch.","name":"Maintenance mode"},{"description":"When queued changes are applied to a site, and the defaults a CoreCluster and a company give their sites.","name":"Maintenance windows"},{"description":"A company's Magento Marketplace keys, which Magento 2 installs use.","name":"Marketplace keys"},{"description":"A site's Node.js version, global packages and package caches.","name":"Node.js"},{"description":"The changes the Control Panel is making or has made, and how to follow them.","name":"Operations"},{"description":"Order links, priced as the order page prices them, and your company's orders.","name":"Orders"},{"description":"The companies a person can reach.","name":"Organisations"},{"description":"A site's sending domains, their DNS records and the email the site sends through them.","name":"Outbound email"},{"description":"A site's PHP version, extensions, PHP-FPM, Xdebug, MariaDB version and the runtime it runs on.","name":"PHP"},{"description":"PHP directives, a custom php.ini, what PHP runs with, and memory, upload size and execution time.","name":"PHP settings"},{"description":"Upgrade options, package, add-on and server type changes, automatic upgrades, and the package and region catalogues.","name":"Packages and capacity"},{"description":"Google PageSpeed Insights scores for a site's home page, on mobile and on desktop, with their history.","name":"PageSpeed"},{"description":"HTTP authentication, the logins a site asks visitors for.","name":"Password protection"},{"description":"Changes that wait for a site's maintenance window.","name":"Pending changes"},{"description":"Timed tests of your site's pages from a server location you choose, across the environments you name, with a report to share.","name":"Performance audits"},{"description":"The platform's own plugins on a WordPress site.","name":"Platform plugins"},{"description":"A site's platform tools, running one, and following the command it starts.","name":"Platform tools"},{"description":"A site's redirect rules.","name":"Redirects"},{"description":"The credentials a CoreStack Enterprise environment's builds use for private Composer registries.","name":"Registry secrets"},{"description":"The git provider accounts a company's environments deploy from.","name":"Repository connections"},{"description":"The SSH keys that can log in to your environments, and the host keys those environments present.","name":"SSH keys"},{"description":"The commands a site runs on a schedule.","name":"Scheduled tasks"},{"description":"Sites, their environments, activity, usage and what needs attention.","name":"Sites"},{"description":"Snapshots of a site and how often they are taken.","name":"Snapshots"},{"description":"Your support tickets with Corefinity: list and read them, open one, reply, close or reopen one, change its priority and choose who follows it.","name":"Support"},{"description":"The people in your company, their roles and permissions, and your company's notification settings.","name":"Team"},{"description":"The history of a site's browser terminal sessions, and their recordings.","name":"Terminal"},{"description":"The variables a site's deployments read, and the credentials its builds use for private registries.","name":"Variables and secrets"},{"description":"A Magento 2 site's Varnish full-page cache and its custom VCL.","name":"Varnish"},{"description":"A site's own Nginx rules and the rules Corefinity adds for it.","name":"Web server rules"},{"description":"What the Control Panel receives from your git provider when you push.","name":"Webhooks"},{"description":"The websites and environments of your companies.","name":"Websites and environments"},{"description":"The released change log entries and announcements you may read, and which of them you have read.","name":"What's new"}],"paths":{"/agency/page":{"get":{"description":"Your agency's page in Corefinity's partner directory and the change request that is waiting for approval,\neach `null` when there is none. Your role needs the `viewAgencyPage` permission.\n","operationId":"getAgencyPage","responses":{"200":{"content":{"application/json":{"examples":{"live":{"summary":"A live page with nothing waiting","value":{"data":{"change_request":null,"page":{"address":"14 Harbour Row, Bristol","content":"We build and run online shops.","email_address":"hello@northwind-digital.example.com","id":3207,"listing_description":"Magento and Shopware builds for UK retailers.","name":"Northwind Digital","phone_number":"01632 960 123","published":true,"services":["Magento","Hosting"],"slug":"northwind-digital","status":"live","subheading":"Magento specialists","website_url":"https://northwind-digital.example.com"}}}},"none":{"summary":"No page yet","value":{"data":{"change_request":null,"page":null}}}},"schema":{"$ref":"#/components/schemas/AgencyPageStateAnswer"}}},"description":"The page and its open change request."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Your role may not view the page","value":{"code":"forbidden","message":"You are not allowed to view your agency page.","reason":"forbidden","status":"error"}},"read_scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/LegacyRefusal"}]}}},"description":"The token lacks the `read` scope (`scope_required`), or your role may not view the agency page (`forbidden`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get your agency page","tags":["Agency"],"x-feature":"agency","x-file":"agency","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/agency/page-change-requests":{"get":{"description":"Every change request of your agency's page, newest first, waiting, approved or turned down. Your role needs\nthe `viewChangeRequest` permission. Paged by cursor: send `next_cursor` back as `cursor`; null means the last\npage.\n","operationId":"listAgencyPageChangeRequests","parameters":[{"$ref":"#/components/parameters/cursorLimit"},{"$ref":"#/components/parameters/AgencyCursor"}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"items":[{"address":"14 Harbour Row, Bristol","content":"We build and run online shops.","created_at":"2026-11-02T09:00:00Z","email_address":"hello@northwind-digital.example.com","id":3318,"listing_description":"Magento and Shopware builds for UK retailers.","name":"Northwind Digital","page_id":3207,"phone_number":"01632 960 123","services":["Magento","Hosting"],"slug":"northwind-digital","status":"approved","subheading":"Magento specialists","type":"create","updated_at":"2026-11-03T14:30:00Z","website_url":"https://northwind-digital.example.com"}],"next_cursor":null}},"schema":{"$ref":"#/components/schemas/AgencyPageChangeRequestPageAnswer"}}},"description":"One page of change requests."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/AgencyForbiddenChangeRequestsRead"},"422":{"$ref":"#/components/responses/AgencyInvalidPage"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your page change requests","tags":["Agency"],"x-feature":"agency","x-file":"agency","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/agency/page-change-requests/{changeRequest}":{"parameters":[{"description":"The id of one of your page's change requests. Digits only.","example":3318,"in":"path","name":"changeRequest","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"One change request of your agency's page. Another agency's request answers the same `404` as an id that does not exist.","operationId":"getAgencyPageChangeRequest","responses":{"200":{"content":{"application/json":{"example":{"data":{"address":"14 Harbour Row, Bristol","content":"We build and run online shops.","created_at":"2026-11-02T09:00:00Z","email_address":"hello@northwind-digital.example.com","id":3318,"listing_description":"Magento and Shopware builds for UK retailers.","name":"Northwind Digital","page_id":3207,"phone_number":"01632 960 123","services":["Magento","Hosting"],"slug":"northwind-digital","status":"approved","subheading":"Magento specialists","type":"create","updated_at":"2026-11-03T14:30:00Z","website_url":"https://northwind-digital.example.com"}},"schema":{"$ref":"#/components/schemas/AgencyPageChangeRequestAnswer"}}},"description":"The change request."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/AgencyForbiddenChangeRequestsRead"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a page change request","tags":["Agency"],"x-feature":"agency","x-file":"agency","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/agency/page/change-request":{"post":{"description":"Asks Corefinity to create your agency page (send every field but `slug`; your role needs\n`createAgencyPage`) or to change it (send only the fields to change; your role needs `editAgencyPage`). The\nlive page keeps its values until Corefinity approves the request, and a new request replaces one that is\nstill waiting. Images are added in the Control Panel.\n","operationId":"createAgencyPageChangeRequest","requestBody":{"content":{"application/json":{"examples":{"change":{"summary":"Change one field of a live page","value":{"subheading":"Magento and Shopware specialists"}},"first_page":{"summary":"Request your first page","value":{"address":"14 Harbour Row, Bristol","content":"We build and run online shops.","email_address":"hello@northwind-digital.example.com","listing_description":"Magento and Shopware builds for UK retailers.","name":"Northwind Digital","phone_number":"01632 960 123","services":["Magento","Hosting"],"subheading":"Magento specialists","website_url":"https://northwind-digital.example.com"}}},"schema":{"$ref":"#/components/schemas/AgencyPageChangeRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"change":{"summary":"A change waiting for approval","value":{"data":{"change_request":{"address":"14 Harbour Row, Bristol","content":"We build and run online shops.","created_at":"2026-11-09T10:15:00Z","email_address":"hello@northwind-digital.example.com","id":3319,"listing_description":"Magento and Shopware builds for UK retailers.","name":"Northwind Digital","page_id":3207,"phone_number":"01632 960 123","services":["Magento","Hosting"],"slug":"northwind-digital","status":"pending","subheading":"Magento and Shopware specialists","type":"edit","updated_at":"2026-11-09T10:15:00Z","website_url":"https://northwind-digital.example.com"},"page":{"address":"14 Harbour Row, Bristol","content":"We build and run online shops.","email_address":"hello@northwind-digital.example.com","id":3207,"listing_description":"Magento and Shopware builds for UK retailers.","name":"Northwind Digital","phone_number":"01632 960 123","published":true,"services":["Magento","Hosting"],"slug":"northwind-digital","status":"pending_change","subheading":"Magento specialists","website_url":"https://northwind-digital.example.com"}}}}},"schema":{"$ref":"#/components/schemas/AgencyPageStateAnswer"}}},"description":"The page as it is now, and the request that is waiting for approval. No request is raised when nothing differs from the page."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden_create":{"summary":"Your role may not request a page","value":{"code":"forbidden","message":"You are not allowed to request an agency page.","reason":"forbidden","status":"error"}},"forbidden_edit":{"summary":"Your role may not request changes","value":{"code":"forbidden","message":"You are not allowed to request changes to your agency page.","reason":"forbidden","status":"error"}},"write_scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/LegacyRefusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), or your role may not request an agency page or\nchanges to it (`forbidden`).\n"},"422":{"content":{"application/json":{"examples":{"nothing":{"summary":"No field of the page was sent","value":{"code":"invalid","errors":{"name":["Give at least one field of the page to change."]},"field":"name","message":"Give at least one field of the page to change.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`): no field at all, a first request without every required field or\nwith a `slug`, or a value the page form would refuse.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a page change request","tags":["Agency"],"x-effect":["changes-settings","sends"],"x-feature":"agency","x-file":"agency","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/agency/referrals":{"get":{"description":"The leads your agency has referred to Corefinity, newest first. Your role needs the `viewAgencyLeads`\npermission. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.\n","operationId":"listAgencyReferrals","parameters":[{"$ref":"#/components/parameters/cursorLimit"},{"$ref":"#/components/parameters/AgencyCursor"},{"description":"Part of a company name or website address. Up to 255 characters.","example":"harbour","in":"query","name":"search","required":false,"schema":{"maxLength":255,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"items":[{"company_name":"Harbour & Finch","contact_lead":true,"created_at":"2026-11-09T10:15:00Z","current_cost":120.5,"current_provider":"Another host","id":3120,"main_contact_email":"eleanor.finch@harbourandfinch.example.com","main_contact_mobile":"+447700900123","main_contact_mobile_country":"GB","main_contact_name":"Eleanor Finch","notes":"Moving this quarter.","preferred_contact_method":"phone","website_url":"https://harbourandfinch.example.com"}],"next_cursor":null}},"schema":{"$ref":"#/components/schemas/AgencyReferralPageAnswer"}}},"description":"One page of referrals."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/AgencyForbiddenReferralsRead"},"422":{"$ref":"#/components/responses/AgencyInvalidPage"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your partner referrals","tags":["Agency"],"x-feature":"agency","x-file":"agency","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"post":{"description":"Records a lead as your own agency's referral and emails Corefinity's sales team about it. Your role needs\nthe `createAgencyLeads` permission.\n","operationId":"createAgencyReferral","requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"Every field","value":{"company_name":"Harbour & Finch","contact_lead":true,"current_cost":120.5,"current_provider":"Another host","main_contact_email":"eleanor.finch@harbourandfinch.example.com","main_contact_mobile":"07700 900123","main_contact_mobile_country":"GB","main_contact_name":"Eleanor Finch","notes":"Moving this quarter.","preferred_contact_method":"phone","website_url":"https://harbourandfinch.example.com"}},"minimal":{"summary":"Only what is required","value":{"company_name":"Harbour & Finch","website_url":"harbourandfinch.example.com"}}},"schema":{"$ref":"#/components/schemas/AgencyReferralRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"company_name":"Harbour & Finch","contact_lead":true,"created_at":"2026-11-09T10:15:00Z","current_cost":120.5,"current_provider":"Another host","id":3120,"main_contact_email":"eleanor.finch@harbourandfinch.example.com","main_contact_mobile":"+447700900123","main_contact_mobile_country":"GB","main_contact_name":"Eleanor Finch","notes":"Moving this quarter.","preferred_contact_method":"phone","website_url":"https://harbourandfinch.example.com"}},"schema":{"$ref":"#/components/schemas/AgencyReferralAnswer"}}},"description":"The referral was recorded."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Your role may not create referrals","value":{"code":"forbidden","message":"You are not allowed to create partner referrals.","reason":"forbidden","status":"error"}},"write_scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/LegacyRefusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), or your role may not create partner referrals (`forbidden`)."},"422":{"content":{"application/json":{"examples":{"required":{"summary":"The required fields are missing","value":{"code":"invalid","errors":{"company_name":["The company name field is required."],"website_url":["The website url field is required."]},"field":"company_name","message":"The company name field is required. (and 1 more error)","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`). `field` names the first one and `errors` lists every one."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a partner referral","tags":["Agency"],"x-effect":["sends"],"x-feature":"agency","x-file":"agency","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/agency/referrals/{referral}":{"parameters":[{"description":"The id of one of your agency's referrals. Digits only.","example":3120,"in":"path","name":"referral","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"One of your agency's referrals. Another agency's referral answers the same `404` as an id that does not exist.","operationId":"getAgencyReferral","responses":{"200":{"content":{"application/json":{"example":{"data":{"company_name":"Harbour & Finch","contact_lead":true,"created_at":"2026-11-09T10:15:00Z","current_cost":120.5,"current_provider":"Another host","id":3120,"main_contact_email":"eleanor.finch@harbourandfinch.example.com","main_contact_mobile":"+447700900123","main_contact_mobile_country":"GB","main_contact_name":"Eleanor Finch","notes":"Moving this quarter.","preferred_contact_method":"phone","website_url":"https://harbourandfinch.example.com"}},"schema":{"$ref":"#/components/schemas/AgencyReferralAnswer"}}},"description":"The referral."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/AgencyForbiddenReferralsRead"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a partner referral","tags":["Agency"],"x-feature":"agency","x-file":"agency","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/app-versions":{"get":{"description":"Answers the lines each platform offers, with what a fresh install gets and the PHP and MariaDB versions each line runs.\nSend `placement` to learn which lines one of your CoreClusters or a region can run.","operationId":"listAppVersions","parameters":[{"description":"One platform only, such as `wordpress`, `magento2`, `laravel` or `shopware`.","example":"wordpress","in":"query","name":"platform","required":false,"schema":{"type":"string"}},{"description":"Where the site would run: `cluster:{id}` for one of your CoreClusters (the id, with no leading zero), or `region:{key}` for a region (2 to 8 lower-case letters, such as `region:uk`).","in":"query","name":"placement","required":false,"schema":{"pattern":"^(cluster:[1-9][0-9]{0,17}|region:[a-z]{2,8})$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"catalogue_version":"2026-11-08.1","platforms":[{"available":true,"default_version":"7.1","editions":[],"family":"wordpress","label":"WordPress","platform":"wordpress","reason":null,"versions":[{"acknowledge":[],"days_left":null,"default":true,"edition":null,"empty":{"available":true,"reason":null},"eol_since":null,"eol_stage":"none","fresh":{"available":true,"reason":null},"held_reason":null,"installs":"7.1.3","key":"7.1","label":"WordPress 7.1","mariadb":{"default":"11.8","pending":[],"versions":["11.4","11.8","12.3"]},"notes":[],"patches":{"count":0,"through":null},"php":{"default":"8.3","pending":[],"versions":["8.3","8.4","8.5"]},"search":null,"security_until":null,"services":null,"status":"active","tag":"latest"}],"warning":null}]},"schema":{"$ref":"#/components/schemas/AppVersionCatalogue"}}},"description":"The lines, by platform."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"Application versions are not on for your company (`feature_off`), or `placement` names a CoreCluster you cannot see."},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"platform":["That platform is not one we offer."]},"field":"platform","message":"That platform is not one we offer.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`platform` or `placement` names nothing (`invalid`); `field` names it."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/AppVersionCatalogueUnavailable"}},"summary":"List application versions","tags":["Application versions"],"x-feature":"app-versions","x-file":"app-versions","x-gates":["app_versions_api","app_versions"],"x-rate-limit":{"bucket":"corecluster-app-versions","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/companies":{"get":{"description":"Answers every company the token's user can reach: their own, and for an agency each client it manages.\nThe list is not paged, and a company's people are not part of it.\n","operationId":"listCompanies","responses":{"200":{"content":{"application/json":{"example":{"companies":[{"address":"1 Example Street, Anytown, AB1 2CD","country":"GB","id":"1180","name":"Northwind Digital","phone":"+44 20 7946 0118"},{"address":"14 Quay Street, Anytown, AB1 2CD","country":"GB","id":"1204","name":"Harbour & Finch","phone":"+44 20 7946 0142"}]},"schema":{"$ref":"#/components/schemas/CompanyList"}}},"description":"The companies."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your companies","tags":["Organisations"],"x-feature":"organisation","x-file":"companies","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/companies/{company}/app-versions/attention":{"parameters":[{"$ref":"#/components/parameters/company"}],"get":{"description":"Answers the sites of a company you belong to or manage sites for whose line is ending or has ended, ended first. An agency reads only the sites it manages.","operationId":"listCompanyAppVersionAttention","responses":{"200":{"content":{"application/json":{"example":{"sites":[{"company":{"id":1204,"name":"Harbour & Finch"},"days_left":null,"display_version":"11.9.0","domain":"bookings.harbourandfinch.example.com","edition":null,"eol_stage":"ended","line":null,"platform":"laravel","security_until":null,"site_id":1061,"status":"eol"}]},"schema":{"$ref":"#/components/schemas/AppVersionAttentionList"}}},"description":"The sites that need attention. Empty when none does."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/AppVersionCatalogueUnavailable"}},"summary":"List a company's sites on ending versions","tags":["Application versions"],"x-feature":"app-versions","x-file":"app-versions","x-gates":["app_versions_api","app_versions"],"x-rate-limit":{"bucket":"corecluster-app-versions-attention","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/companies/{company}/deployment-connections":{"parameters":[{"$ref":"#/components/parameters/company"}],"get":{"description":"Answers the git provider accounts of a company you may act for: your own, or a client your agency manages.\nOldest first, 50 a page. A company you cannot see answers `404`, as one that does not exist. Paged by cursor:\nsend `next_cursor` back as `cursor`; null means the last page.\n","operationId":"listCompanyDeploymentConnections","parameters":[{"$ref":"#/components/parameters/DeploymentConnectionCursor"}],"responses":{"200":{"content":{"application/json":{"examples":{"list":{"$ref":"#/components/examples/DeploymentConnectionListExample"}},"schema":{"$ref":"#/components/schemas/DeploymentConnectionList"}}},"description":"One page of connections."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/DeploymentConnectionCursorRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a company's repository connections","tags":["Repository connections"],"x-feature":"deployment-connections","x-file":"deployment-connections","x-gates":[],"x-rate-limit":{"bucket":"deployment-connections-read","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/companies/{company}/deployment-connections/{connection}":{"parameters":[{"$ref":"#/components/parameters/company"},{"$ref":"#/components/parameters/DeploymentConnectionId"}],"delete":{"description":"Removes a connection of a company you may act for. Only an owner can remove one (for a client, an owner of the\nagency that manages it), and only while no environment deploys through it. Removing cannot be undone, so send\nthe connection's id as `confirm_connection`.\n","operationId":"deleteCompanyDeploymentConnection","requestBody":{"$ref":"#/components/requestBodies/DeploymentConnectionRemoval"},"responses":{"200":{"$ref":"#/components/responses/DeploymentConnectionRemoved"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DeploymentConnectionRemovalForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/DeploymentConnectionInUse"},"422":{"$ref":"#/components/responses/DeploymentConnectionConfirmMismatch"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a company's repository connection","tags":["Repository connections"],"x-effect":["deletes"],"x-feature":"deployment-connections","x-file":"deployment-connections","x-gates":[],"x-rate-limit":{"bucket":"deployment-connections-write","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/companies/{company}/firewall":{"parameters":[{"$ref":"#/components/parameters/company"}],"get":{"description":"Answers the addresses and presets held at the company and the environments they open. An agency's company\naddresses reach its clients' environments too, so a client also reads its agency's here, with the `layer` `agency`.\n","operationId":"getCompanyFirewall","responses":{"200":{"content":{"application/json":{"examples":{"company":{"$ref":"#/components/examples/FirewallCompanyViewExample"}},"schema":{"$ref":"#/components/schemas/FirewallCompanyView"}}},"description":"The company's addresses."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a company's firewall","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/companies/{company}/firewall/activity":{"parameters":[{"$ref":"#/components/parameters/company"}],"get":{"description":"Answers the changes to the company's own addresses and presets, newest first. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.","operationId":"listCompanyFirewallActivity","parameters":[{"$ref":"#/components/parameters/firewallCursor"}],"responses":{"200":{"content":{"application/json":{"examples":{"activity":{"$ref":"#/components/examples/FirewallActivityPageExample"}},"schema":{"$ref":"#/components/schemas/FirewallActivityPage"}}},"description":"A page of activity."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"$ref":"#/components/responses/FirewallInvalidQuery"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a company's firewall activity","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/companies/{company}/magento-keys":{"parameters":[{"$ref":"#/components/parameters/company"}],"get":{"description":"Answers which Marketplace keys a company's Magento 2 installs use and what they can install.\nA key is never answered, only the last four characters of the public key.","operationId":"getCompanyMagentoKeys","responses":{"200":{"content":{"application/json":{"example":{"agency":"own","can_change":true,"commerce_sites":{"count":0,"sites":[]},"entitlements":{"checked_at":"2026-11-19T08:00:00Z","commerce":true,"error":null,"open_source":true},"fallback":"none","public_key_last4":"3f9a","source":"company","updated_at":"2026-11-19T08:00:00Z","updated_by":{"agency":null,"id":2012,"name":"Daniel Reyes"},"verified_at":"2026-11-19T08:00:00Z"},"schema":{"$ref":"#/components/schemas/MagentoKeys"}}},"description":"The keys in use."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrManagedClusters"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"Not found: the company is not one whose Marketplace keys you can manage, Magento 2 is not offered to your company, or the feature is off (`feature_off`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a company's Marketplace keys","tags":["Marketplace keys"],"x-feature":"magento","x-file":"app-versions","x-gates":["app_versions_api","platforms_magento2"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"put":{"description":"Saves the company's own Marketplace keys. The keys are checked with the Magento repository first, and nothing is saved when it refuses them.","operationId":"updateCompanyMagentoKeys","requestBody":{"content":{"application/json":{"examples":{"save":{"summary":"A pair of keys (made up)","value":{"private_key":"fedcba9876543210fedcba9876543210","public_key":"0123456789abcdef0123456789ab3f9a"}}},"schema":{"$ref":"#/components/schemas/MagentoKeysUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"agency":"own","can_change":true,"commerce_sites":{"count":0,"sites":[]},"entitlements":{"checked_at":"2026-11-19T08:00:00Z","commerce":true,"error":null,"open_source":true},"fallback":"none","public_key_last4":"3f9a","source":"company","updated_at":"2026-11-19T08:00:00Z","updated_by":{"agency":null,"id":2012,"name":"Daniel Reyes"},"verified_at":"2026-11-19T08:00:00Z"},"schema":{"$ref":"#/components/schemas/MagentoKeys"}}},"description":"The keys were saved."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"Not found: the company is not one whose Marketplace keys you can manage, Magento 2 is not offered to your company, or the feature is off (`feature_off`)."},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"public_key":["Paste the public key."]},"field":"public_key","message":"Paste the public key.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A key is missing or is not 32 characters of 0 to 9 and a to f, or the Magento repository refused the pair (`errors.keys`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/ProviderNoAnswer","description":"The Magento repository could not be reached, so the keys could not be checked. Nothing was saved; try again in a few minutes."}},"summary":"Update a company's Marketplace keys","tags":["Marketplace keys"],"x-effect":["changes-settings"],"x-feature":"magento","x-file":"app-versions","x-gates":["app_versions_api","platforms_magento2"],"x-rate-limit":{"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes the company's own Marketplace keys. While Adobe Commerce sites use them, send the company's name as `confirm_company`.","operationId":"deleteCompanyMagentoKeys","requestBody":{"content":{"application/json":{"examples":{"confirmed":{"summary":"Confirmed with the company name","value":{"confirm_company":"Harbour & Finch"}},"no_commerce_sites":{"summary":"No Adobe Commerce site uses the keys","value":{}}},"schema":{"$ref":"#/components/schemas/MagentoKeysDeleteRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"agency":"own","can_change":true,"commerce_sites":{"count":0,"sites":[]},"entitlements":{"checked_at":null,"commerce":false,"error":null,"open_source":false},"fallback":"none","public_key_last4":null,"source":"none","updated_at":null,"updated_by":null,"verified_at":null},"schema":{"$ref":"#/components/schemas/MagentoKeys"}}},"description":"The keys were removed. The answer shows what installs use now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"Not found: the company is not one whose Marketplace keys you can manage, Magento 2 is not offered to your company, or the feature is off (`feature_off`)."},"422":{"$ref":"#/components/responses/MagentoKeysRemovalNotConfirmed"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a company's Marketplace keys","tags":["Marketplace keys"],"x-effect":["deletes"],"x-feature":"magento","x-file":"app-versions","x-gates":["app_versions_api","platforms_magento2"],"x-rate-limit":{"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/companies/{company}/magento-keys/check":{"parameters":[{"$ref":"#/components/parameters/company"}],"post":{"description":"Asks the Magento repository again what the saved keys can install and answers the keys with the new result. Up to 6 checks an hour for each company.","operationId":"checkCompanyMagentoKeys","responses":{"200":{"content":{"application/json":{"example":{"agency":"own","can_change":true,"commerce_sites":{"count":0,"sites":[]},"entitlements":{"checked_at":"2026-11-19T08:00:00Z","commerce":true,"error":null,"open_source":true},"fallback":"none","public_key_last4":"3f9a","source":"company","updated_at":"2026-11-19T08:00:00Z","updated_by":{"agency":null,"id":2012,"name":"Daniel Reyes"},"verified_at":"2026-11-19T08:00:00Z"},"schema":{"$ref":"#/components/schemas/MagentoKeys"}}},"description":"The keys, checked again."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"Not found: the company has no keys of its own to check, it is not one whose keys you can manage, Magento 2 is not offered, or the feature is off (`feature_off`)."},"429":{"content":{"application/json":{"examples":{"per_hour":{"value":{"code":"rate_limited","message":"The keys were checked several times in the last hour. Try again later.","reason":"rate_limited","retry_after_seconds":1700}},"per_minute":{"value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests in a minute, or the keys were already checked 6 times in the last hour. Wait for `Retry-After` seconds."},"502":{"content":{"application/json":{"schema":{"properties":{"keys":{"$ref":"#/components/schemas/MagentoKeys"},"message":{"type":"string"}},"required":["message","keys"],"type":"object"}}},"description":"The Magento repository could not be reached. The saved answer stands and is sent in `keys`, with\n`entitlements.error` `unreachable`. The body carries a `message` and no `reason`.\n"}},"summary":"Check a company's Marketplace keys","tags":["Marketplace keys"],"x-effect":["changes-settings"],"x-feature":"magento","x-file":"app-versions","x-gates":["app_versions_api","platforms_magento2"],"x-rate-limit":{"also":[{"bucket":"reseller-magento-keys-check","limit":6,"minutes":60,"per":"company"}],"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/companies/{company}/ssh":{"parameters":[{"$ref":"#/components/parameters/company"}],"get":{"description":"Answers the keys held at the company, how far they reach and, for a client of an agency, the agency's keys that\nreach it. Your role needs the View Company SSH Keys permission.\n","operationId":"getCompanySsh","responses":{"200":{"content":{"application/json":{"examples":{"company":{"$ref":"#/components/examples/SshCompanyKeysExample"}},"schema":{"$ref":"#/components/schemas/SshCompanyKeys"}}},"description":"The company's keys."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SshCompanyReadForbidden"},"404":{"$ref":"#/components/responses/SshNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a company's SSH keys","tags":["SSH keys"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-rate-limit":{"bucket":"ssh-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/companies/{company}/ssh/legacy":{"parameters":[{"$ref":"#/components/parameters/company"}],"get":{"description":"Answers the Legacy keys on the company's environments, grouped by environment, 25 environments a page. A\nLegacy key was on the server before the Control Panel managed its keys, and stops working on `ends_on` unless\nit is kept. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.\n","operationId":"listCompanyLegacySshKeys","parameters":[{"description":"Answer the Legacy keys of this environment only, in one page (`cursor` is not used, though a malformed one is still refused, and `next_cursor` is null). Digits only. It may be any environment you can reach.","example":1311,"in":"query","name":"environment_id","required":false,"schema":{"minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/sshCursor"}],"responses":{"200":{"content":{"application/json":{"examples":{"legacy":{"$ref":"#/components/examples/SshLegacyKeysExample"}},"schema":{"$ref":"#/components/schemas/SshLegacyKeys"}}},"description":"A page of Legacy keys."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/SshNotFound"},"422":{"$ref":"#/components/responses/SshInvalidQuery"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a company's Legacy SSH keys","tags":["SSH keys"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-rate-limit":{"bucket":"ssh-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/company":{"get":{"description":"Answers your own company's name, phone number, address and country. Its people are not part of the answer;\nfor its notification settings use `GET /company/details`.\n","operationId":"getOwnCompany","responses":{"200":{"content":{"application/json":{"example":{"company":{"address":"14 Quay Street, Anytown, AB1 2CD","country":"GB","id":"1204","name":"Harbour & Finch","phone":"+44 20 7946 0142"}},"schema":{"$ref":"#/components/schemas/TeamCompanyEnvelope"}}},"description":"Your company."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"content":{"application/json":{"example":{"message":"Server Error"},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"Your account belongs to no company, so there is none to answer and the request fails. `GET /company/details`\nanswers `404` for the same account.\n"}},"summary":"Get your company","tags":["Team"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"put":{"description":"Changes your company's alert preferences and the Slack channel each kind of notification goes to. Anything you\nleave out stays as it is; send at least one setting. A channel must be one of your connected Slack workspace's\nchannels, with or without the leading `#`; `null` means no channel. The company's name, phone number and\naddress cannot be changed here.\n","operationId":"updateCompanySettings","requestBody":{"content":{"application/json":{"examples":{"preferences":{"summary":"Change the alert preferences","value":{"alerts_notifications":false,"deployment_started_notifications":true}},"slack_channels":{"summary":"Choose Slack channels","value":{"slack_channels":{"deployment_started":null,"deployments":"#deployments"}}}},"schema":{"$ref":"#/components/schemas/TeamCompanyUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"details":{"$ref":"#/components/examples/TeamCompanyDetailsExample"}},"schema":{"$ref":"#/components/schemas/TeamCompanyDetailsAnswer"}}},"description":"The company and its settings as they are now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound","description":"Your account belongs to no company."},"409":{"content":{"application/json":{"example":{"code":"not_connected","message":"Your company has not connected Slack, so a Slack channel cannot be chosen. Connect Slack on the My Company page first.","reason":"not_connected","status":"error"},"schema":{"$ref":"#/components/schemas/TeamRefusal"}}},"description":"A Slack channel was chosen, but your company has not connected Slack (`not_connected`)."},"422":{"content":{"application/json":{"examples":{"no_such_channel":{"summary":"The workspace has no such channel","value":{"code":"invalid","errors":{"slack_channels.alerts":["Your Slack workspace has no channel #releases that the Corefinity app can post to."]},"field":"slack_channels.alerts","message":"Your Slack workspace has no channel #releases that the Corefinity app can post to.","reason":"invalid"}},"nothing_sent":{"summary":"No setting was sent","value":{"code":"invalid","errors":{"settings":["Send at least one setting to change."]},"field":"settings","message":"Send at least one setting to change.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is wrong (`invalid`): no setting was sent (on `settings`), `slack_channels` names a key it does not\nhave, a channel is not one of your workspace's that the Corefinity app can post to (on\n`slack_channels.<key>`), or Slack could not list your channels.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update your company's notification settings","tags":["Team"],"x-effect":["changes-settings"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/company/agencies":{"get":{"description":"Every agency your own company is a client of, by name, with how many of your sites it manages and how many\nof your environments deploy through its deployment connections. `repository_gaps` lists your environments\nthat lost their repository when an agency was detached and still need a new deployment connection.\n","operationId":"listCompanyAgencies","responses":{"200":{"content":{"application/json":{"example":{"agencies":[{"deploys_through":1,"id":1180,"manages_sites":0,"name":"Northwind Digital","type":"agency"}],"can_detach":true,"company_id":1204,"repository_gaps":[]},"schema":{"$ref":"#/components/schemas/AgencyLinksAgencies"}}},"description":"Your company's agencies."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/AgencyLinksForbiddenRead"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your company's agencies","tags":["Agencies and clients"],"x-feature":"agency-links","x-file":"agency-links","x-gates":[],"x-rate-limit":{"bucket":"agency-links-read","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/company/agencies/{agency}":{"parameters":[{"$ref":"#/components/parameters/AgencyLinksAgency"}],"delete":{"description":"Ends the link at once: the agency's people lose access to your sites, tickets and billing, and what the\npreview lists goes with it. It cannot be undone; linking the agency again does not bring back removed keys,\nrepositories or subscriptions. Only your company's owners may detach, and `confirm_agency` must be the\nagency's id.\n","operationId":"detachCompanyAgency","requestBody":{"content":{"application/json":{"examples":{"detach":{"summary":"Detach agency 1180","value":{"confirm_agency":1180}}},"schema":{"properties":{"confirm_agency":{"description":"The id of the agency, the same number as in the path.","type":["integer","string"]}},"required":["confirm_agency"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"detached":{"agency_id":1180,"client_id":1204},"effects":{"firewall":{"stay_for_review":0,"stop_applying":0},"managed_sites":{"count":0,"names":[]},"repositories":{"count":1,"environments":[{"id":1311,"name":"Production"}],"other_environments":0},"side":"client","ssh_keys":{"count":0},"summary":["The agency's people lose access to your sites, tickets and billing at once.","1 environment deploys through the agency's deployment connections. It will need a new deployment connection before its next deployment.","Linking the agency again later does not bring back removed keys, repositories or subscriptions."],"ticket_subscriptions":{"count":0}}},"schema":{"$ref":"#/components/schemas/AgencyLinksDetached"}}},"description":"The link was removed. `effects` is what ended."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"archived":{"summary":"Your company is archived","value":{"code":"forbidden","message":"An archived company cannot change its agency links. Contact Corefinity support.","reason":"forbidden"}},"company_unavailable":{"summary":"Your company has been deleted","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"corefinity":{"summary":"A link only Corefinity support can change","value":{"code":"forbidden","message":"Contact Corefinity support to change this link.","reason":"forbidden"}},"not_an_owner":{"summary":"Only owners may detach","value":{"code":"forbidden","message":"Only the company's owners can detach an agency.","reason":"forbidden"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}},"write_scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and\nyou have not set it up (`two_factor_required`), you are not an owner of your company, your company is\narchived or the link is one only Corefinity support can change (`forbidden`), or your company has been\ndeleted (`company_unavailable`).\n"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"example":{"code":"confirm_mismatch","effects":{"firewall":{"stay_for_review":0,"stop_applying":0},"managed_sites":{"count":0,"names":[]},"repositories":{"count":1,"environments":[{"id":1311,"name":"Production"}],"other_environments":0},"side":"client","ssh_keys":{"count":0},"summary":["The agency's people lose access to your sites, tickets and billing at once.","1 environment deploys through the agency's deployment connections. It will need a new deployment connection before its next deployment.","Linking the agency again later does not bring back removed keys, repositories or subscriptions."],"ticket_subscriptions":{"count":0}},"errors":{"confirm_agency":["Detaching this agency ends its access at once and cannot be undone. To detach it, send confirm_agency set to its id, 1180. Nothing was changed."]},"field":"confirm_agency","message":"Detaching this agency ends its access at once and cannot be undone. To detach it, send confirm_agency set to its id, 1180. Nothing was changed.","reason":"confirm_mismatch"},"schema":{"$ref":"#/components/schemas/AgencyLinksConfirmRefusal"}}},"description":"`confirm_agency` is missing or is not the agency's id (`confirm_mismatch`). Nothing was changed; `effects`\nis what the detach would end.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Detach an agency from your company","tags":["Agencies and clients"],"x-effect":["deletes"],"x-feature":"agency-links","x-file":"agency-links","x-gates":[],"x-rate-limit":{"bucket":"agency-links-write","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/company/agencies/{agency}/detach-preview":{"parameters":[{"$ref":"#/components/parameters/AgencyLinksAgency"}],"get":{"description":"What detaching the agency from your company would end, with the names of your own sites and environments.\nNothing is changed. Any member of your company may read it.\n","operationId":"previewCompanyAgencyDetach","responses":{"200":{"content":{"application/json":{"example":{"agency_id":1180,"effects":{"firewall":{"stay_for_review":0,"stop_applying":0},"managed_sites":{"count":0,"names":[]},"repositories":{"count":1,"environments":[{"id":1311,"name":"Production"}],"other_environments":0},"side":"client","ssh_keys":{"count":0},"summary":["The agency's people lose access to your sites, tickets and billing at once.","1 environment deploys through the agency's deployment connections. It will need a new deployment connection before its next deployment.","Linking the agency again later does not bring back removed keys, repositories or subscriptions."],"ticket_subscriptions":{"count":0}}},"schema":{"$ref":"#/components/schemas/AgencyLinksAgencyPreview"}}},"description":"What the detach would end."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/AgencyLinksForbiddenPreview"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Preview detaching an agency","tags":["Agencies and clients"],"x-feature":"agency-links","x-file":"agency-links","x-gates":[],"x-rate-limit":{"bucket":"agency-links-read","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/company/app-versions/attention":{"get":{"description":"Answers the sites of your own company whose line is ending or has ended, ended first.","operationId":"listOwnCompanyAppVersionAttention","responses":{"200":{"content":{"application/json":{"example":{"sites":[{"company":{"id":1204,"name":"Harbour & Finch"},"days_left":null,"display_version":"11.9.0","domain":"bookings.harbourandfinch.example.com","edition":null,"eol_stage":"ended","line":null,"platform":"laravel","security_until":null,"site_id":1061,"status":"eol"}]},"schema":{"$ref":"#/components/schemas/AppVersionAttentionList"}}},"description":"The sites that need attention. Empty when none does."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/AppVersionCatalogueUnavailable"}},"summary":"List your sites on ending versions","tags":["Application versions"],"x-feature":"app-versions","x-file":"app-versions","x-gates":["app_versions_api","app_versions"],"x-rate-limit":{"bucket":"corecluster-app-versions-attention","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/company/clients":{"get":{"description":"The client companies linked beneath your own company, by name. A company that is not an agency has none.","operationId":"listCompanyClients","responses":{"200":{"content":{"application/json":{"example":{"can_detach":true,"clients":[{"id":1204,"name":"Harbour & Finch"}],"company_id":1180},"schema":{"$ref":"#/components/schemas/AgencyLinksClients"}}},"description":"Your agency's clients."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/AgencyLinksForbiddenRead"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your agency's clients","tags":["Agencies and clients"],"x-feature":"agency-links","x-file":"agency-links","x-gates":[],"x-rate-limit":{"bucket":"agency-links-read","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/company/clients/{client}":{"parameters":[{"$ref":"#/components/parameters/AgencyLinksClient"}],"delete":{"description":"Ends the link at once: your people lose access to the client's sites, tickets and billing, and what the\npreview counts goes with it. It cannot be undone. Only your agency's owners may detach, and `confirm_client`\nmust be the client's id.\n","operationId":"detachCompanyClient","requestBody":{"content":{"application/json":{"examples":{"detach":{"summary":"Detach client 1204","value":{"confirm_client":1204}}},"schema":{"properties":{"confirm_client":{"description":"The id of the client, the same number as in the path.","type":["integer","string"]}},"required":["confirm_client"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"detached":{"agency_id":1180,"client_id":1204},"effects":{"firewall":{"stay_for_review":0,"stop_applying":0},"managed_sites":{"count":0},"repositories":{"count":1},"side":"agency","ssh_keys":{"count":0},"summary":["Your people lose access to this client's sites, tickets and billing at once.","1 environment deploys through the agency's deployment connections. It will need a new deployment connection before its next deployment.","Linking the agency again later does not bring back removed keys, repositories or subscriptions."],"ticket_subscriptions":{"count":0}}},"schema":{"$ref":"#/components/schemas/AgencyLinksDetached"}}},"description":"The link was removed. `effects` is what ended."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"archived":{"summary":"Your agency is archived","value":{"code":"forbidden","message":"An archived company cannot change its agency links. Contact Corefinity support.","reason":"forbidden"}},"company_unavailable":{"summary":"Your company has been deleted","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"not_an_owner":{"summary":"Only owners may detach","value":{"code":"forbidden","message":"Only the agency's owners can detach a client.","reason":"forbidden"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}},"write_scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and\nyou have not set it up (`two_factor_required`), you are not an owner of your agency or your agency is\narchived (`forbidden`), or your company has been deleted (`company_unavailable`).\n"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"example":{"code":"confirm_mismatch","effects":{"firewall":{"stay_for_review":0,"stop_applying":0},"managed_sites":{"count":0},"repositories":{"count":1},"side":"agency","ssh_keys":{"count":0},"summary":["Your people lose access to this client's sites, tickets and billing at once.","1 environment deploys through the agency's deployment connections. It will need a new deployment connection before its next deployment.","Linking the agency again later does not bring back removed keys, repositories or subscriptions."],"ticket_subscriptions":{"count":0}},"errors":{"confirm_client":["Detaching this client ends its access at once and cannot be undone. To detach it, send confirm_client set to its id, 1204. Nothing was changed."]},"field":"confirm_client","message":"Detaching this client ends its access at once and cannot be undone. To detach it, send confirm_client set to its id, 1204. Nothing was changed.","reason":"confirm_mismatch"},"schema":{"$ref":"#/components/schemas/AgencyLinksConfirmRefusal"}}},"description":"`confirm_client` is missing or is not the client's id (`confirm_mismatch`). Nothing was changed; `effects`\nis what the detach would end.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Detach a client from your agency","tags":["Agencies and clients"],"x-effect":["deletes"],"x-feature":"agency-links","x-file":"agency-links","x-gates":[],"x-rate-limit":{"bucket":"agency-links-write","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/company/clients/{client}/detach-preview":{"parameters":[{"$ref":"#/components/parameters/AgencyLinksClient"}],"get":{"description":"What detaching the client from your agency would end, as counts: the names of a client's sites and\nenvironments are the client's. Nothing is changed. Any member of your agency may read it.\n","operationId":"previewCompanyClientDetach","responses":{"200":{"content":{"application/json":{"example":{"client_id":1204,"effects":{"firewall":{"stay_for_review":0,"stop_applying":0},"managed_sites":{"count":0},"repositories":{"count":1},"side":"agency","ssh_keys":{"count":0},"summary":["Your people lose access to this client's sites, tickets and billing at once.","1 environment deploys through the agency's deployment connections. It will need a new deployment connection before its next deployment.","Linking the agency again later does not bring back removed keys, repositories or subscriptions."],"ticket_subscriptions":{"count":0}}},"schema":{"$ref":"#/components/schemas/AgencyLinksClientPreview"}}},"description":"What the detach would end."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/AgencyLinksForbiddenPreview"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Preview detaching a client","tags":["Agencies and clients"],"x-feature":"agency-links","x-file":"agency-links","x-gates":[],"x-rate-limit":{"bucket":"agency-links-read","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/company/deployment-connections":{"get":{"description":"Answers the git provider accounts your own company deploys from, oldest first, 50 a page. Each connection says\nwhether it still works and which environments deploy through it. Paged by cursor: send `next_cursor` back as\n`cursor`; null means the last page.\n","operationId":"listOwnDeploymentConnections","parameters":[{"$ref":"#/components/parameters/DeploymentConnectionCursor"}],"responses":{"200":{"content":{"application/json":{"examples":{"list":{"$ref":"#/components/examples/DeploymentConnectionListExample"}},"schema":{"$ref":"#/components/schemas/DeploymentConnectionList"}}},"description":"One page of connections."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/DeploymentConnectionCursorRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your company's repository connections","tags":["Repository connections"],"x-feature":"deployment-connections","x-file":"deployment-connections","x-gates":[],"x-rate-limit":{"bucket":"deployment-connections-read","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/company/deployment-connections/{connection}":{"parameters":[{"$ref":"#/components/parameters/DeploymentConnectionId"}],"delete":{"description":"Removes a connection of your own company. Only an owner of the company can remove one, and only while no\nenvironment deploys through it. Removing cannot be undone, so send the connection's id as\n`confirm_connection`.\n","operationId":"deleteOwnDeploymentConnection","requestBody":{"$ref":"#/components/requestBodies/DeploymentConnectionRemoval"},"responses":{"200":{"$ref":"#/components/responses/DeploymentConnectionRemoved"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DeploymentConnectionRemovalForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/DeploymentConnectionInUse"},"422":{"$ref":"#/components/responses/DeploymentConnectionConfirmMismatch"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete your company's repository connection","tags":["Repository connections"],"x-effect":["deletes"],"x-feature":"deployment-connections","x-file":"deployment-connections","x-gates":[],"x-rate-limit":{"bucket":"deployment-connections-write","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/company/details":{"get":{"description":"Answers your own company with its Slack connection, its alert preferences and the Slack channel each kind of\nnotification goes to. `PUT /company` changes the settings and answers the same shape.\n","operationId":"getCompanyDetails","responses":{"200":{"content":{"application/json":{"examples":{"details":{"$ref":"#/components/examples/TeamCompanyDetailsExample"}},"schema":{"$ref":"#/components/schemas/TeamCompanyDetailsAnswer"}}},"description":"The company and its settings."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound","description":"Your account belongs to no company."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get your company's settings","tags":["Team"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/company/firewall":{"get":{"description":"The same answer as `GET /companies/{company}/firewall`, for the company of the person the token belongs to.\n","operationId":"getOwnCompanyFirewall","responses":{"200":{"content":{"application/json":{"examples":{"company":{"$ref":"#/components/examples/FirewallCompanyViewExample"}},"schema":{"$ref":"#/components/schemas/FirewallCompanyView"}}},"description":"Your company's addresses."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get your company's firewall","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/company/magento-keys":{"get":{"description":"Answers which Marketplace keys your own company's Magento 2 installs use and what they can install.\nA key is never answered, only the last four characters of the public key.","operationId":"getOwnCompanyMagentoKeys","responses":{"200":{"content":{"application/json":{"example":{"agency":"own","can_change":true,"commerce_sites":{"count":0,"sites":[]},"entitlements":{"checked_at":"2026-11-19T08:00:00Z","commerce":true,"error":null,"open_source":true},"fallback":"none","public_key_last4":"3f9a","source":"company","updated_at":"2026-11-19T08:00:00Z","updated_by":{"agency":null,"id":2012,"name":"Daniel Reyes"},"verified_at":"2026-11-19T08:00:00Z"},"schema":{"$ref":"#/components/schemas/MagentoKeys"}}},"description":"The keys in use."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrManagedClusters"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"Not found: the company is not one whose Marketplace keys you can manage, Magento 2 is not offered to your company, or the feature is off (`feature_off`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get your company's Marketplace keys","tags":["Marketplace keys"],"x-feature":"magento","x-file":"app-versions","x-gates":["app_versions_api","platforms_magento2"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"put":{"description":"Saves your company's own Marketplace keys. The keys are checked with the Magento repository first, and nothing is saved when it refuses them.","operationId":"updateOwnCompanyMagentoKeys","requestBody":{"content":{"application/json":{"examples":{"save":{"summary":"A pair of keys (made up)","value":{"private_key":"fedcba9876543210fedcba9876543210","public_key":"0123456789abcdef0123456789ab3f9a"}}},"schema":{"$ref":"#/components/schemas/MagentoKeysUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"agency":"own","can_change":true,"commerce_sites":{"count":0,"sites":[]},"entitlements":{"checked_at":"2026-11-19T08:00:00Z","commerce":true,"error":null,"open_source":true},"fallback":"none","public_key_last4":"3f9a","source":"company","updated_at":"2026-11-19T08:00:00Z","updated_by":{"agency":null,"id":2012,"name":"Daniel Reyes"},"verified_at":"2026-11-19T08:00:00Z"},"schema":{"$ref":"#/components/schemas/MagentoKeys"}}},"description":"The keys were saved."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"Not found: the company is not one whose Marketplace keys you can manage, Magento 2 is not offered to your company, or the feature is off (`feature_off`)."},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"public_key":["Paste the public key."]},"field":"public_key","message":"Paste the public key.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A key is missing or is not 32 characters of 0 to 9 and a to f, or the Magento repository refused the pair (`errors.keys`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/ProviderNoAnswer","description":"The Magento repository could not be reached, so the keys could not be checked. Nothing was saved; try again in a few minutes."}},"summary":"Update your company's Marketplace keys","tags":["Marketplace keys"],"x-effect":["changes-settings"],"x-feature":"magento","x-file":"app-versions","x-gates":["app_versions_api","platforms_magento2"],"x-rate-limit":{"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes the company's own Marketplace keys. While Adobe Commerce sites use them, send the company's name as `confirm_company`.","operationId":"deleteOwnCompanyMagentoKeys","requestBody":{"content":{"application/json":{"examples":{"confirmed":{"summary":"Confirmed with the company name","value":{"confirm_company":"Harbour & Finch"}},"no_commerce_sites":{"summary":"No Adobe Commerce site uses the keys","value":{}}},"schema":{"$ref":"#/components/schemas/MagentoKeysDeleteRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"agency":"own","can_change":true,"commerce_sites":{"count":0,"sites":[]},"entitlements":{"checked_at":null,"commerce":false,"error":null,"open_source":false},"fallback":"none","public_key_last4":null,"source":"none","updated_at":null,"updated_by":null,"verified_at":null},"schema":{"$ref":"#/components/schemas/MagentoKeys"}}},"description":"The keys were removed. The answer shows what installs use now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"Not found: the company is not one whose Marketplace keys you can manage, Magento 2 is not offered to your company, or the feature is off (`feature_off`)."},"422":{"$ref":"#/components/responses/MagentoKeysRemovalNotConfirmed"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete your company's Marketplace keys","tags":["Marketplace keys"],"x-effect":["deletes"],"x-feature":"magento","x-file":"app-versions","x-gates":["app_versions_api","platforms_magento2"],"x-rate-limit":{"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/company/magento-keys/check":{"post":{"description":"Asks the Magento repository again what the saved keys can install and answers the keys with the new result. Up to 6 checks an hour for each company.","operationId":"checkOwnCompanyMagentoKeys","responses":{"200":{"content":{"application/json":{"example":{"agency":"own","can_change":true,"commerce_sites":{"count":0,"sites":[]},"entitlements":{"checked_at":"2026-11-19T08:00:00Z","commerce":true,"error":null,"open_source":true},"fallback":"none","public_key_last4":"3f9a","source":"company","updated_at":"2026-11-19T08:00:00Z","updated_by":{"agency":null,"id":2012,"name":"Daniel Reyes"},"verified_at":"2026-11-19T08:00:00Z"},"schema":{"$ref":"#/components/schemas/MagentoKeys"}}},"description":"The keys, checked again."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"Not found: the company has no keys of its own to check, it is not one whose keys you can manage, Magento 2 is not offered, or the feature is off (`feature_off`)."},"429":{"content":{"application/json":{"examples":{"per_hour":{"value":{"code":"rate_limited","message":"The keys were checked several times in the last hour. Try again later.","reason":"rate_limited","retry_after_seconds":1700}},"per_minute":{"value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests in a minute, or the keys were already checked 6 times in the last hour. Wait for `Retry-After` seconds."},"502":{"content":{"application/json":{"schema":{"properties":{"keys":{"$ref":"#/components/schemas/MagentoKeys"},"message":{"type":"string"}},"required":["message","keys"],"type":"object"}}},"description":"The Magento repository could not be reached. The saved answer stands and is sent in `keys`, with\n`entitlements.error` `unreachable`. The body carries a `message` and no `reason`.\n"}},"summary":"Check your company's Marketplace keys","tags":["Marketplace keys"],"x-effect":["changes-settings"],"x-feature":"magento","x-file":"app-versions","x-gates":["app_versions_api","platforms_magento2"],"x-rate-limit":{"also":[{"bucket":"reseller-magento-keys-check","limit":6,"minutes":60,"per":"company"}],"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/company/maintenance-window":{"get":{"description":"Answers your company's default window and how many sites and CoreClusters it reaches. The company is the one your token belongs to.","operationId":"getCompanyMaintenanceWindow","responses":{"200":{"content":{"application/json":{"example":{"company":{"id":1204,"name":"Harbour & Finch"},"editable":true,"effective":{"end_hour":4,"label":"00:00–04:00 UK time","length_hours":4,"source":"platform","source_label":"Corefinity default","staff_locked":false,"start_hour":0,"timezone":"Europe/London"},"inherited":{"level":"platform","name":"Corefinity default","start_hour":0},"own":null,"reach":{"clusters":1,"sites":1}},"schema":{"$ref":"#/components/schemas/CompanyMaintenanceWindow"}}},"description":"The window."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get your company's maintenance window","tags":["Maintenance windows"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"put":{"description":"Sets the default window for every site and CoreCluster of your company that has none of its own. Changes already queued for them move to the new window.","operationId":"updateCompanyMaintenanceWindow","requestBody":{"content":{"application/json":{"examples":{"three_in_the_morning":{"summary":"Open the window at 03:00","value":{"start_hour":3}}},"schema":{"$ref":"#/components/schemas/MaintenanceWindowUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"company":{"id":1204,"name":"Harbour & Finch"},"editable":true,"effective":{"end_hour":7,"label":"03:00–07:00 UK time","length_hours":4,"source":"company","source_label":"Company default","staff_locked":false,"start_hour":3,"timezone":"Europe/London"},"inherited":{"level":"platform","name":"Corefinity default","start_hour":0},"own":{"start_hour":3},"reach":{"clusters":1,"sites":1},"restamped":0},"schema":{"$ref":"#/components/schemas/CompanyMaintenanceWindow"}}},"description":"The window was saved. `restamped` counts the queued changes that moved."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor","description":"The token lacks the `write` scope (`scope_required`), or your company requires two-factor authentication and you have not set it up."},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"start_hour":{"summary":"Not an hour from 0 to 23","value":{"code":"window_start_invalid","message":"Choose a start hour from 00 to 23.","reason":"window_start_invalid"}},"unknown_field":{"summary":"A field other than start_hour","value":{"code":"window_start_invalid","message":"Only start_hour can be set; a window always lasts 4 hours, UK time.","reason":"window_start_invalid"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The start hour is missing or wrong."},"429":{"$ref":"#/components/responses/MaintenanceWindowWriteBudget"}},"summary":"Update your company's maintenance window","tags":["Maintenance windows"],"x-effect":["changes-settings"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"also":[{"bucket":"maintenance-window-writes","limit":10,"minutes":60,"per":"company"},{"bucket":"maintenance-window-writes","limit":30,"minutes":60,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"delete":{"description":"Deletes your company's own default, so the Corefinity default applies again. Changes already queued move with it.","operationId":"deleteCompanyMaintenanceWindow","responses":{"200":{"content":{"application/json":{"example":{"company":{"id":1204,"name":"Harbour & Finch"},"editable":true,"effective":{"end_hour":4,"label":"00:00–04:00 UK time","length_hours":4,"source":"platform","source_label":"Corefinity default","staff_locked":false,"start_hour":0,"timezone":"Europe/London"},"inherited":{"level":"platform","name":"Corefinity default","start_hour":0},"own":null,"reach":{"clusters":1,"sites":1},"restamped":0},"schema":{"$ref":"#/components/schemas/CompanyMaintenanceWindow"}}},"description":"The window your company uses now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor","description":"The token lacks the `write` scope (`scope_required`), or your company requires two-factor authentication and you have not set it up."},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/MaintenanceWindowWriteBudget"}},"summary":"Delete your company's maintenance window","tags":["Maintenance windows"],"x-effect":["deletes"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"also":[{"bucket":"maintenance-window-writes","limit":10,"minutes":60,"per":"company"},{"bucket":"maintenance-window-writes","limit":30,"minutes":60,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/company/maintenance-window/preview":{"get":{"description":"Answers what setting `start_hour`, or clearing the default, would do across your company's sites. Nothing is saved.","operationId":"previewCompanyMaintenanceWindow","parameters":[{"description":"The start hour to try, from 0 to 23. Send this or `clear`.","example":3,"in":"query","name":"start_hour","required":false,"schema":{"maximum":23,"minimum":0,"type":"integer"}},{"description":"Send `1` to preview removing the window set at this level, instead of `start_hour`.","in":"query","name":"clear","required":false,"schema":{"enum":["1"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"batches":[],"effective_after":{"end_hour":7,"label":"03:00–07:00 UK time","source":"company","source_label":"Company default","start_hour":3},"hold_until":"2026-11-03T09:30:00Z","moved":0,"next_after":{"ends_at":"2026-11-04T07:00:00Z","label":"Tonight 03:00–07:00 UK time","starts_at":"2026-11-04T03:00:00Z"},"notice_period":{"until":null},"snapshot_overlap":null,"unchanged":false},"schema":{"$ref":"#/components/schemas/MaintenanceWindowPreview"}}},"description":"The preview."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"start_hour":{"summary":"Not an hour from 0 to 23","value":{"code":"window_start_invalid","message":"Choose a start hour from 00 to 23.","reason":"window_start_invalid"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`start_hour` is missing or wrong."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Preview your company's window change","tags":["Maintenance windows"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/company/ssh":{"get":{"description":"The same answer as `GET /companies/{company}/ssh`, for the company of the person the token belongs to.\n","operationId":"getOwnCompanySsh","responses":{"200":{"content":{"application/json":{"examples":{"company":{"$ref":"#/components/examples/SshCompanyKeysExample"}},"schema":{"$ref":"#/components/schemas/SshCompanyKeys"}}},"description":"Your company's keys."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SshCompanyReadForbidden"},"404":{"$ref":"#/components/responses/SshNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get your company's SSH keys","tags":["SSH keys"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-rate-limit":{"bucket":"ssh-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/coreclusters/{cluster}/maintenance-window":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"Answers the default window of the CoreCluster, where it comes from, and the sites that have a window of their own.","operationId":"getClusterMaintenanceWindow","responses":{"200":{"content":{"application/json":{"example":{"cluster":{"id":1017,"name":"Northwind UK 1"},"editable":true,"effective":{"end_hour":4,"label":"00:00–04:00 UK time","length_hours":4,"source":"platform","source_label":"Corefinity default","staff_locked":false,"start_hour":0,"timezone":"Europe/London"},"inherited":{"level":"platform","name":"Corefinity default","start_hour":0},"overrides":{"count":0,"sites":[]},"own":null},"schema":{"$ref":"#/components/schemas/ClusterMaintenanceWindow"}}},"description":"The window."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The cluster does not exist or is not a CoreCluster of your company (both answer the same body; shared hosting has no window of its own at this level), or maintenance windows are not on for the API (`feature_off`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a CoreCluster's maintenance window","tags":["Maintenance windows"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"put":{"description":"Sets the default window of the CoreCluster, used by every site in it that has none of its own. Changes already queued for those sites move to the new window.","operationId":"updateClusterMaintenanceWindow","requestBody":{"content":{"application/json":{"examples":{"three_in_the_morning":{"summary":"Open the window at 03:00","value":{"start_hour":3}}},"schema":{"$ref":"#/components/schemas/MaintenanceWindowUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"cluster":{"id":1017,"name":"Northwind UK 1"},"editable":true,"effective":{"end_hour":7,"label":"03:00–07:00 UK time","length_hours":4,"source":"cluster","source_label":"CoreCluster default","staff_locked":false,"start_hour":3,"timezone":"Europe/London"},"inherited":{"level":"platform","name":"Corefinity default","start_hour":0},"overrides":{"count":0,"sites":[]},"own":{"start_hour":3},"restamped":0},"schema":{"$ref":"#/components/schemas/ClusterMaintenanceWindow"}}},"description":"The window was saved. `restamped` counts the queued changes that moved."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"You can see it but not change it","value":{"code":"forbidden","message":"You cannot change this CoreCluster.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you have not set it up, or you can see this but may not change it (`forbidden`; today everyone who can see it may change its window, so this is not answered yet)."},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The cluster does not exist or is not a CoreCluster of your company (both answer the same body; shared hosting has no window of its own at this level), or maintenance windows are not on for the API (`feature_off`)."},"409":{"content":{"application/json":{"examples":{"window_locked":{"summary":"Corefinity has set the window","value":{"code":"window_locked","message":"This CoreCluster's window is set by Corefinity.","reason":"window_locked"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has set the window, so it cannot be changed here."},"422":{"content":{"application/json":{"examples":{"start_hour":{"summary":"Not an hour from 0 to 23","value":{"code":"window_start_invalid","message":"Choose a start hour from 00 to 23.","reason":"window_start_invalid"}},"unknown_field":{"summary":"A field other than start_hour","value":{"code":"window_start_invalid","message":"Only start_hour can be set; a window always lasts 4 hours, UK time.","reason":"window_start_invalid"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The start hour is missing or wrong (`window_start_invalid`)."},"429":{"$ref":"#/components/responses/MaintenanceWindowWriteBudget"}},"summary":"Update a CoreCluster's maintenance window","tags":["Maintenance windows"],"x-effect":["changes-settings"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"also":[{"bucket":"maintenance-window-writes","limit":10,"minutes":60,"per":"cluster"},{"bucket":"maintenance-window-writes","limit":30,"minutes":60,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"delete":{"description":"Deletes the CoreCluster's own default, so its sites that have no window of their own use your company's default again, else Corefinity's. Changes already queued move with it.","operationId":"deleteClusterMaintenanceWindow","responses":{"200":{"content":{"application/json":{"example":{"cluster":{"id":1017,"name":"Northwind UK 1"},"editable":true,"effective":{"end_hour":4,"label":"00:00–04:00 UK time","length_hours":4,"source":"platform","source_label":"Corefinity default","staff_locked":false,"start_hour":0,"timezone":"Europe/London"},"inherited":{"level":"platform","name":"Corefinity default","start_hour":0},"overrides":{"count":0,"sites":[]},"own":null,"restamped":0},"schema":{"$ref":"#/components/schemas/ClusterMaintenanceWindow"}}},"description":"The window the CoreCluster uses now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"You can see it but not change it","value":{"code":"forbidden","message":"You cannot change this CoreCluster.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you have not set it up, or you can see this but may not change it (`forbidden`; today everyone who can see it may change its window, so this is not answered yet)."},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The cluster does not exist or is not a CoreCluster of your company (both answer the same body; shared hosting has no window of its own at this level), or maintenance windows are not on for the API (`feature_off`)."},"409":{"content":{"application/json":{"examples":{"window_locked":{"summary":"Corefinity has set the window","value":{"code":"window_locked","message":"This CoreCluster's window is set by Corefinity.","reason":"window_locked"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has set the window, so it cannot be changed here."},"429":{"$ref":"#/components/responses/MaintenanceWindowWriteBudget"}},"summary":"Delete a CoreCluster's maintenance window","tags":["Maintenance windows"],"x-effect":["deletes"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"also":[{"bucket":"maintenance-window-writes","limit":10,"minutes":60,"per":"cluster"},{"bucket":"maintenance-window-writes","limit":30,"minutes":60,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/coreclusters/{cluster}/maintenance-window/preview":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"Answers what setting `start_hour`, or clearing the default, would do across the sites of the CoreCluster. Nothing is saved.","operationId":"previewClusterMaintenanceWindow","parameters":[{"description":"The start hour to try, from 0 to 23. Send this or `clear`.","example":3,"in":"query","name":"start_hour","required":false,"schema":{"maximum":23,"minimum":0,"type":"integer"}},{"description":"Send `1` to preview removing the window set at this level, instead of `start_hour`.","in":"query","name":"clear","required":false,"schema":{"enum":["1"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"batches":[],"effective_after":{"end_hour":7,"label":"03:00–07:00 UK time","source":"cluster","source_label":"CoreCluster default","start_hour":3},"hold_until":"2026-11-03T09:30:00Z","moved":0,"next_after":{"ends_at":"2026-11-04T07:00:00Z","label":"Tonight 03:00–07:00 UK time","starts_at":"2026-11-04T03:00:00Z"},"notice_period":{"until":null},"snapshot_overlap":null,"unchanged":false},"schema":{"$ref":"#/components/schemas/MaintenanceWindowPreview"}}},"description":"The preview."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The cluster does not exist or is not a CoreCluster of your company (both answer the same body; shared hosting has no window of its own at this level), or maintenance windows are not on for the API (`feature_off`)."},"409":{"content":{"application/json":{"examples":{"window_locked":{"summary":"Corefinity has set the window","value":{"code":"window_locked","message":"This CoreCluster's window is set by Corefinity.","reason":"window_locked"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has set the window, so it cannot be changed here."},"422":{"content":{"application/json":{"examples":{"start_hour":{"summary":"Not an hour from 0 to 23","value":{"code":"window_start_invalid","message":"Choose a start hour from 00 to 23.","reason":"window_start_invalid"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`start_hour` is missing or wrong (`window_start_invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Preview a CoreCluster's window change","tags":["Maintenance windows"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/corestack/attention":{"get":{"description":"The items that need attention across your sites, and the items somebody has acknowledged, with their totals.","operationId":"listAttention","parameters":[{"description":"Only the items about this site or environment. A site that is not yours answers `404`.","in":"query","name":"site_id","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Send `1` to list up to 200 acknowledged items instead of 50.","example":true,"in":"query","name":"acknowledged","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"attention":[{"acknowledgeable":true,"acknowledged":null,"action":null,"cluster":{"id":1017,"name":"Northwind UK 1"},"detail":"No container is ready.","environment":null,"href":"/managed-clusters/sites/1051","id":"site_down:1051","kind":"site_down","scope":"site","severity":"critical","since":"2026-11-14T08:58:00Z","site":{"domain":"journal.harbourandfinch.example.com","id":1051},"subject":null,"title":"Site is down"}],"attention_acknowledged":[],"attention_acknowledged_total":0,"attention_total":1,"generated_at":"2026-11-14T09:00:00Z"},"schema":{"$ref":"#/components/schemas/AttentionList"}}},"description":"The attention list."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List what needs attention","tags":["Sites"],"x-feature":"sites","x-file":"sites","x-gates":["attention_ack"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/attention/{attention}/ack":{"parameters":[{"description":"The `id` of an item of the attention list, URL-encoded: a kind, a colon, a number and sometimes a further\npart, such as `site_down:1051` (sent as `site_down%3A1051`).\n","example":"site_down:1051","in":"path","name":"attention","required":true,"schema":{"pattern":"^[a-z_]+:[0-9]+(?::[^/]+)?$","type":"string"}}],"post":{"description":"Marks an item as acknowledged for your company. It stays listed, stops counting as needing attention until it\nchanges, and shows who acknowledged it. Acknowledging the same item again answers the same acknowledgement.\n","operationId":"acknowledgeAttention","responses":{"200":{"content":{"application/json":{"example":{"acknowledged":{"at":"2026-11-14T09:01:00Z","by":{"id":2041,"name":"Eleanor Finch"},"since_at":"2026-11-14T08:58:00Z"},"overview_patch":{"attention":[],"attention_acknowledged":[{"acknowledgeable":true,"acknowledged":{"at":"2026-11-14T09:01:00Z","by":{"id":2041,"name":"Eleanor Finch"},"since_at":"2026-11-14T08:58:00Z"},"action":null,"cluster":{"id":1017,"name":"Northwind UK 1"},"detail":"No container is ready.","environment":null,"href":"/managed-clusters/sites/1051","id":"site_down:1051","kind":"site_down","scope":"site","severity":"critical","since":"2026-11-14T08:58:00Z","site":{"domain":"journal.harbourandfinch.example.com","id":1051},"subject":null,"title":"Site is down"}],"attention_acknowledged_total":1,"attention_total":0,"generated_at":"2026-11-14T09:01:00Z","sites_attention":{}}},"schema":{"$ref":"#/components/schemas/AttentionAcknowledged"}}},"description":"The acknowledgement, and the parts of the overview it changed."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"content":{"application/json":{"examples":{"feature_off":{"summary":"Attention acknowledgement is not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_open":{"summary":"The item is not open to you","value":{"code":"not_open","message":"That item is no longer open. The list has been refreshed.","reason":"not_open"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The item is not open to you (`not_open`), attention acknowledgement is not on for your company\n(`feature_off`), or the id is not an item id.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Acknowledge an attention item","tags":["Sites"],"x-effect":["changes-settings"],"x-feature":"sites","x-file":"sites","x-gates":["attention_ack"],"x-rate-limit":{"bucket":"reseller-attention","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"delete":{"description":"Withdraws the acknowledgement of an item, so it counts as needing attention again.","operationId":"unacknowledgeAttention","responses":{"200":{"content":{"application/json":{"example":{"overview_patch":{"attention":[{"acknowledgeable":true,"acknowledged":null,"action":null,"cluster":{"id":1017,"name":"Northwind UK 1"},"detail":"No container is ready.","environment":null,"href":"/managed-clusters/sites/1051","id":"site_down:1051","kind":"site_down","scope":"site","severity":"critical","since":"2026-11-14T08:58:00Z","site":{"domain":"journal.harbourandfinch.example.com","id":1051},"subject":null,"title":"Site is down"}],"attention_acknowledged":[],"attention_acknowledged_total":0,"attention_total":1,"generated_at":"2026-11-14T09:02:00Z","sites_attention":{"1051":1}}},"schema":{"$ref":"#/components/schemas/AttentionUnacknowledged"}}},"description":"The parts of the overview the withdrawal changed."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"content":{"application/json":{"examples":{"feature_off":{"summary":"Attention acknowledgement is not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_acknowledged":{"summary":"Nothing to withdraw","value":{"code":"not_acknowledged","message":"That item is not acknowledged.","reason":"not_acknowledged"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The item has no acknowledgement to withdraw (`not_acknowledged`), attention acknowledgement is not on for\nyour company (`feature_off`), or the id is not an item id.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Withdraw an acknowledgement","tags":["Sites"],"x-effect":["changes-settings"],"x-feature":"sites","x-file":"sites","x-gates":["attention_ack"],"x-rate-limit":{"bucket":"reseller-attention","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/account":{"get":{"description":"Answers your company's billing account: its details and VAT basis, its balance, its card or Direct Debit\nmandate, its contract lines, the next invoice and what you may do; `with=details` adds the billing contacts\nand the countries the billing address may be in. Editing the details, paying an invoice and adding or removing\na card or mandate are done in the Control Panel.\n","operationId":"getBillingAccount","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"},{"description":"`details` adds `billing_contacts` and `countries`, which are `null` without it.","example":"details","in":"query","name":"with","schema":{"enum":["details"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"account":{"$ref":"#/components/examples/BillingAccountExample"}},"schema":{"$ref":"#/components/schemas/BillingAccount"}}},"description":"The billing account."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/BillingAccountConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the billing account","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/account/vat-number":{"put":{"description":"Saves or clears (`vat_number: null`) the billing account's VAT number, which changes the VAT on invoices\nissued from now on, and answers the account's VAT basis as it now stands. Send the account's `version` as you\nlast read it: when the details were changed since, the save is refused `409 stale` and nothing is written. A\nEuropean Union number is saved as `pending` and checked afterwards.\n","operationId":"updateBillingVatNumber","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"}],"requestBody":{"content":{"application/json":{"examples":{"set":{"summary":"Save a United Kingdom VAT number","value":{"vat_number":"GB123456789","version":1184934486}}},"schema":{"$ref":"#/components/schemas/BillingVatNumberRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"saved":{"summary":"A United Kingdom VAT number saved","value":{"vat":{"buyer":null,"check":null,"country":"GB","kind":"standard","label":"UK VAT 20 %","rate_percent":20,"validation":{"state":"valid","validated_at":null}}}}},"schema":{"properties":{"vat":{"$ref":"#/components/schemas/BillingVat"}},"required":["vat"],"type":"object"}}},"description":"The account's VAT basis after the save."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"billing_forbidden":{"summary":"You may not change your company's billing details","value":{"code":"billing_forbidden","message":"Billing is available to your company's owner and billing contacts.","reason":"billing_forbidden"}},"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and\nyou have not set it up (`two_factor_required`), or you may not change your company's billing details\n(`billing_forbidden`).\n"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"example":{"code":"stale","message":"Someone else changed these details. Reload and try again","reason":"stale"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The billing details were changed since you read `version` (`stale`). Read the account again and send its new `version`."},"422":{"content":{"application/json":{"examples":{"account_conflict":{"$ref":"#/components/examples/BillingAccountConflictExample"},"characters":{"summary":"A character a VAT number cannot have","value":{"code":"invalid","errors":{"vat_number":["Enter a VAT number using letters, numbers and + or *, and no other characters"]},"field":"vat_number","message":"Enter a VAT number using letters, numbers and + or *, and no other characters","reason":"invalid"}},"country":{"summary":"The account has no billing country yet","value":{"code":"invalid","errors":{"country":["Choose the billing country first"]},"field":"country","message":"Choose the billing country first","reason":"invalid"}},"shape":{"summary":"Not the United Kingdom's shape, on a United Kingdom account","value":{"code":"invalid","errors":{"vat_number":["Enter a VAT number like GB123456789"]},"field":"vat_number","message":"Enter a VAT number like GB123456789","reason":"invalid"}},"too_long":{"summary":"A number longer than 20 characters as it would be saved","value":{"code":"invalid","errors":{"vat_number":["Use 20 characters or fewer for the VAT number"]},"field":"vat_number","message":"Use 20 characters or fewer for the VAT number","reason":"invalid"}},"version":{"summary":"The version is missing","value":{"code":"invalid","errors":{"version":["The version field is required."]},"field":"version","message":"The version field is required.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`); `field` names it. `version` is needed. A `vat_number` is refused\nfor characters a VAT number cannot have, for being longer than 20 characters once it is tidied and given\nits country prefix, and, for a United Kingdom account, for a number that is not the United Kingdom's\nshape. An account with no billing country takes no VAT number (`field` is `country`): choose the country\nin the Control Panel first. `account` and `account_id` naming different billing accounts is refused on\n`account_id`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update the VAT number","tags":["Billing"],"x-effect":["changes-settings"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-write","limit":30,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/billing/balance":{"get":{"description":"Answers the account's balance on its own: what has accrued this month, what is outstanding on open invoices,\nthe credits available, each contract line's running figure, when the next invoice is issued and the latest\nactivity. The same block as `balance` in `GET /corestack/billing/account`.\n","operationId":"getBillingBalance","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"}],"responses":{"200":{"content":{"application/json":{"examples":{"balance":{"$ref":"#/components/examples/BillingBalanceExample"}},"schema":{"$ref":"#/components/schemas/BillingBalance"}}},"description":"The balance."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/BillingAccountConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the balance","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/catalogue":{"get":{"description":"Answers the packages on sale with their monthly prices, the add-ons with the price of one unit, the staging\nenvironment sizes, the price modifiers (the Performance server type, the region) and the VAT that applies to\nthe account. Prices exclude VAT and are in the billing account's currency unless `currency` names another;\neveryone who is signed in may read them. Someone who may not read the billing account, and a request whose\n`account` is not one of your company's, is not refused: the prices are in pounds sterling unless `currency`\nsays otherwise, and the three fields of `vat` are `null`.\n","operationId":"getBillingCatalogue","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"},{"description":"Only one line: `cs` for CoreStack packages, `cc` for CoreCluster packages.","example":"cc","in":"query","name":"product_line","schema":{"enum":["cs","cc"],"type":"string"}},{"description":"The region to price in, `uk` when left out.","in":"query","name":"region","schema":{"enum":["uk","us","nl","aus"],"type":"string"}},{"description":"The currency to price in. Left out, the billing account's.","in":"query","name":"currency","schema":{"enum":["GBP","USD","EUR"],"type":"string"}},{"description":"A platform key, such as `wordpress`. The packages that cannot run it are moved to `hidden`. A key that is not a platform on offer is refused `422 invalid` on `platform`.","in":"query","name":"platform","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"clusters":{"$ref":"#/components/examples/BillingCatalogueExample"}},"schema":{"$ref":"#/components/schemas/BillingCatalogue"}}},"description":"The catalogue."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/FeatureOff","description":"Billing is not on for your company (`feature_off`). An `account` you may not read is not a 404 here; the catalogue is answered without it."},"422":{"content":{"application/json":{"examples":{"account_conflict":{"$ref":"#/components/examples/BillingAccountConflictExample"},"currency_unpublished":{"summary":"A currency there are no prices in","value":{"code":"currency_unpublished","message":"Prices in JPY are not available right now","reason":"currency_unpublished"}},"product_line":{"summary":"A product line that does not exist","value":{"code":"invalid","errors":{"product_line":["The selected product line is invalid."]},"field":"product_line","message":"The selected product line is invalid.","reason":"invalid"}},"zone_unknown":{"summary":"A region that is not priced","value":{"code":"zone_unknown","message":"Unknown region","reason":"zone_unknown"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`zone_unknown`: the region is not one that is priced. `currency_unpublished`: there are no prices in the\ncurrency at the moment. `invalid`: a parameter is wrong (`field` names it), or `account` and `account_id`\nname different billing accounts.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the price catalogue","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/contracts":{"get":{"description":"Answers every line the account is billed for now: each package, add-on and staging environment, with its\ncontract, what it is for, its monthly and hourly price and since when it runs. A contract opened for a new\nsite or CoreCluster bills nothing until that site or CoreCluster is ready, which `contract.billing_starts`\nsays. The list is not paged.\n","operationId":"listBillingContracts","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"}],"responses":{"200":{"content":{"application/json":{"examples":{"lines":{"$ref":"#/components/examples/BillingContractLinesExample"}},"schema":{"items":{"$ref":"#/components/schemas/BillingContractLine"},"type":"array"}}},"description":"The contract lines."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/BillingAccountConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List the contract lines","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/credits":{"get":{"description":"Answers the account's credits, newest first: what each was for, what is left of it, when it expires and the\ninvoices it was applied to. The list is not paged.\n","operationId":"listBillingCredits","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"}],"responses":{"200":{"content":{"application/json":{"examples":{"credits":{"$ref":"#/components/examples/BillingCreditsExample"}},"schema":{"items":{"$ref":"#/components/schemas/BillingCredit"},"type":"array"}}},"description":"The credits."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/BillingAccountConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List the credits","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/invoices":{"get":{"description":"Answers the account's invoices, newest first, with `total` counting every invoice the filters choose; an\ninvoice's `lines` are filled only with `with=lines`. Paged by cursor: send `next_cursor` back as `cursor`;\nnull means the last page.\n","operationId":"listInvoices","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"},{"description":"Only invoices with one of these statuses, as a comma list: `open`, `collecting`, `paid`, `unpaid`, `void`, `refunded`, `written_off`.","in":"query","name":"status","schema":{"pattern":"^[a-z_]+(,[a-z_]+)*$","type":"string"}},{"description":"`lines` fills each invoice's `lines`.","example":"lines","in":"query","name":"with","schema":{"enum":["lines"],"type":"string"}},{"$ref":"#/components/parameters/cursorLimit"},{"description":"The `next_cursor` of the previous answer. Anything that is not a whole number is refused `422` on `cursor`.","in":"query","name":"cursor","schema":{"pattern":"^\\d+$","type":"string"}},{"description":"`1` for only the invoices still to be paid whose due day has passed.","in":"query","name":"overdue","schema":{"enum":["0","1","true","false"],"type":"string"}},{"description":"Only invoices issued on or after this day, as `YYYY-MM-DD`.","in":"query","name":"issued_from","schema":{"format":"date","type":"string"}},{"description":"Only invoices issued on or before this day, as `YYYY-MM-DD`.","in":"query","name":"issued_to","schema":{"format":"date","type":"string"}},{"description":"Only invoices whose number contains this text.","in":"query","name":"search","schema":{"maxLength":100,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"invoices":{"$ref":"#/components/examples/BillingInvoicePageExample"}},"schema":{"$ref":"#/components/schemas/BillingInvoicePage"}}},"description":"A page of invoices."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"account_conflict":{"$ref":"#/components/examples/BillingAccountConflictExample"},"cursor":{"summary":"A cursor the list did not give","value":{"code":"invalid","errors":{"cursor":["The cursor format is invalid."]},"field":"cursor","message":"The cursor format is invalid.","reason":"invalid"}},"issued_day":{"summary":"A day that is not one","value":{"code":"invalid","errors":{"issued_from":["Give the day as YYYY-MM-DD, for example 2027-01-31."]},"field":"issued_from","message":"Give the day as YYYY-MM-DD, for example 2027-01-31.","reason":"invalid"}},"issued_range":{"summary":"A range that ends before it starts","value":{"code":"invalid","errors":{"issued_to":["The end of the range is before its start"]},"field":"issued_to","message":"The end of the range is before its start","reason":"invalid"}},"status":{"summary":"A status that does not exist","value":{"code":"invalid","errors":{"status":["Unknown invoice status"]},"field":"status","message":"Unknown invoice status","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A filter is wrong (`invalid`; `field` names it), or `account` and `account_id` name different billing accounts."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List invoices","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/invoices/{invoice}":{"parameters":[{"$ref":"#/components/parameters/billingInvoice"}],"get":{"description":"Answers one invoice with its lines, the credits applied to it, its payments and its credit notes.\n","operationId":"getInvoice","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"}],"responses":{"200":{"content":{"application/json":{"examples":{"paid":{"$ref":"#/components/examples/BillingInvoiceExample"}},"schema":{"$ref":"#/components/schemas/BillingInvoice"}}},"description":"The invoice."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/BillingAccountConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an invoice","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/invoices/{invoice}/credit-notes/{number}/pdf":{"parameters":[{"$ref":"#/components/parameters/billingInvoice"},{"description":"The credit note's `number`, from the invoice's `credit_notes`. Letters, digits and hyphens.","in":"path","name":"number","required":true,"schema":{"pattern":"^[A-Za-z0-9-]+$","type":"string"}}],"get":{"description":"Answers the PDF of one of the invoice's credit notes, which exists once the note's `pdf_href` on the invoice\nis not `null`. Each download is recorded in the company's activity.\n","operationId":"downloadCreditNotePdf","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"The credit note, as a PDF file named for its number.","headers":{"Cache-Control":{"description":"Always `no-store, private`.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"content":{"application/json":{"examples":{"credit_note_not_ready":{"summary":"The credit note's PDF is not ready yet","value":{"code":"credit_note_not_ready","message":"This credit note is not ready yet. Try again shortly","reason":"credit_note_not_ready"}},"feature_off":{"summary":"Billing is not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_found":{"summary":"No such invoice or credit note","value":{"message":"Not found."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"Billing is not on for your company (`feature_off`); the invoice does not exist, is not your company's or\nhas no credit note with that number; or the credit note's PDF is not ready yet (`credit_note_not_ready`).\n"},"422":{"$ref":"#/components/responses/BillingAccountConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"content":{"application/json":{"example":{"code":"provider_unavailable","message":"This credit note could not be fetched just now. Try again in a moment","reason":"provider_unavailable"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The credit note's PDF could not be fetched at the moment (`provider_unavailable`). Try again shortly."}},"summary":"Download a credit note PDF","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/billing/invoices/{invoice}/pdf":{"parameters":[{"$ref":"#/components/parameters/billingInvoice"}],"post":{"description":"Step one of downloading an invoice's PDF: answers a link that works for ten minutes, and only for the person\nit was given to. With a token, step two is `GET` on `download_url` (`GET /corestack/billing/pdf/{token}`);\n`url` is the same link for a browser that is signed in to the Control Panel.\n","operationId":"createInvoicePdfLink","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"}],"responses":{"200":{"content":{"application/json":{"examples":{"link":{"summary":"A link that works for ten minutes","value":{"download_url":"/api/corestack/billing/pdf/Xk3ExampleTokenExampleTokenExampleTokenExample12","expires_at":"2027-01-18T10:25:00Z","url":"/nova-vendor/corecluster/billing/pdf/Xk3ExampleTokenExampleTokenExampleTokenExample12"}}},"schema":{"$ref":"#/components/schemas/BillingInvoicePdfLink"}}},"description":"The link.","headers":{"Cache-Control":{"description":"Always `no-store`.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"example":{"code":"pdf_pending","message":"The PDF of this invoice is not ready yet. Try again in a few minutes","reason":"pdf_pending"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The invoice's PDF has not been made yet (`pdf_pending`). Try again in a few minutes."},"422":{"$ref":"#/components/responses/BillingAccountConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a link to an invoice PDF","tags":["Billing"],"x-effect":["none"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/billing/ledger":{"get":{"description":"Answers the account's ledger, newest first, 50 entries a page: each hour's accrual, each invoice, payment,\nrefund, credit applied and adjustment, with amounts to six decimal places. Paged by cursor: send `next_cursor`\nback as `cursor`; null means the last page.\n","operationId":"listBillingLedger","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"},{"description":"Only entries of this type.","example":"invoice","in":"query","name":"type","schema":{"enum":["accrual","credit_applied","invoice","payment","refund","adjustment","write_off"],"type":"string"}},{"description":"Only entries at or after this moment (UTC), as a date or a date and time.","in":"query","name":"from","schema":{"type":"string"}},{"description":"Only entries before this moment (UTC). It must be after `from`.","in":"query","name":"to","schema":{"type":"string"}},{"description":"The `next_cursor` of the previous answer. Anything that is not a whole number is refused `422` on `cursor`.","in":"query","name":"cursor","schema":{"pattern":"^\\d+$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"invoices":{"$ref":"#/components/examples/BillingLedgerExample"}},"schema":{"$ref":"#/components/schemas/BillingLedgerPage"}}},"description":"A page of the ledger."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"account_conflict":{"$ref":"#/components/examples/BillingAccountConflictExample"},"cursor":{"summary":"A cursor the list did not give","value":{"code":"invalid","errors":{"cursor":["The cursor format is invalid."]},"field":"cursor","message":"The cursor format is invalid.","reason":"invalid"}},"type":{"summary":"A type that does not exist","value":{"code":"invalid","errors":{"type":["The selected type is invalid."]},"field":"type","message":"The selected type is invalid.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A filter is wrong (`invalid`; `field` names it), or `account` and `account_id` name different billing accounts."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List the ledger","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/payment-methods":{"get":{"description":"Answers the cards on the account, its Direct Debit mandate when it has one, which of them is charged first and\nwhat you may do; a card is its brand, its last four digits and its expiry, never its number. Adding, removing\nand reordering cards, and setting up Direct Debit, are done in the Control Panel.\n","operationId":"listPaymentMethods","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"}],"responses":{"200":{"content":{"application/json":{"examples":{"methods":{"$ref":"#/components/examples/BillingPaymentMethodsExample"}},"schema":{"$ref":"#/components/schemas/BillingPaymentMethods"}}},"description":"The payment methods."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/BillingAccountConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List the payment methods","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/pdf/{token}":{"parameters":[{"description":"The token at the end of `download_url`, as `POST /corestack/billing/invoices/{invoice}/pdf` answered it.","in":"path","name":"token","required":true,"schema":{"pattern":"^[A-Za-z0-9_-]{1,64}$","type":"string"}}],"get":{"description":"Step two of downloading an invoice's PDF: answers the file the link names, for the person the link was given\nto, while it lasts. Your right to read the account's billing is checked again, and each download is recorded\nin the company's activity.\n","operationId":"downloadInvoicePdf","responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"The invoice, as a PDF file named for the invoice number.","headers":{"Cache-Control":{"description":"Always `no-store`.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"content":{"application/json":{"examples":{"feature_off":{"summary":"Billing is not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_found":{"summary":"Not an invoice you can read","value":{"message":"Not found."}},"pdf_missing":{"summary":"The file could not be found","value":{"code":"pdf_missing","message":"The PDF of this invoice could not be found. Open a ticket and we will send it.","reason":"pdf_missing"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"Billing is not on for your company (`feature_off`), the invoice is no longer one you can read, or the\nfile could not be found (`pdf_missing`): open a ticket and Corefinity sends it.\n"},"409":{"content":{"application/json":{"example":{"code":"pdf_pending","message":"The PDF of this invoice is not ready yet.","reason":"pdf_pending"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The invoice has no PDF any more (`pdf_pending`). Ask for a new link later."},"410":{"content":{"application/json":{"example":{"code":"link_expired","message":"This link has expired. Open the invoice and download again.","reason":"link_expired"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The link has expired, or it was given to somebody else (`link_expired`). Ask for a new one."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Download an invoice PDF","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/billing/quote":{"post":{"description":"Prices up to ten changes against the billing account and answers what each costs a month, the monthly total\nbefore and after, the amount for the rest of this month and its VAT; nothing is changed and nothing is\ncharged. Send the quote's `id` as `quote_id` with the change itself (a package, add-on or server type change)\nuntil `expires_at`, 15 minutes later, to make it at the price you were shown. A quote is for the company's\nowner and its billing contacts.\n","operationId":"previewBillingQuote","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"}],"requestBody":{"content":{"application/json":{"examples":{"new_cluster":{"summary":"A new CoreCluster on CC8","value":{"changes":[{"family":"general","package":"CC8","region":"uk","type":"new_cluster"}]}},"package":{"summary":"A larger package for a CoreCluster","value":{"changes":[{"package":"CC12","subject":{"id":1017,"type":"cluster"},"type":"package"}]}}},"schema":{"$ref":"#/components/schemas/BillingQuoteRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"package":{"$ref":"#/components/examples/BillingQuoteExample"}},"schema":{"$ref":"#/components/schemas/BillingQuote"}}},"description":"The quote."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"billing_settling":{"summary":"A staging environment that has just been moved","value":{"code":"billing_settling","message":"This environment has just been moved and its billing is still being updated. Try again in a few minutes.","reason":"billing_settling"}},"contract_missing":{"summary":"Nothing to price the change against","value":{"code":"contract_missing","message":"Not billed in the Control Panel: there is no billing contract to price this against. Make the change without a quote.","reason":"contract_missing"}},"downgrade":{"summary":"A smaller package","value":{"code":"downgrade","message":"Choose a larger package; downgrades are arranged with support","reason":"downgrade"}},"same_family":{"summary":"Already on that server type","value":{"code":"same_family","message":"This is already the server type","reason":"same_family"}},"same_package":{"summary":"Already on that package","value":{"code":"same_package","message":"This is already the package","reason":"same_package"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change cannot be priced as asked. `same_package`: the subject is on that package already.\n`downgrade`: the package is smaller than the one it is on. `same_family`: it is on that server type\nalready. `contract_missing`: the subject has no billing contract in the Control Panel, so there is\nnothing to price it against; the change can be made without a quote. A `uat_size` change for an\nenvironment that has just been moved is refused `billing_settling` while its billing is brought up to\ndate, and `billing_moved_away` for the environment the move left behind.\n"},"422":{"content":{"application/json":{"examples":{"disk_too_large":{"summary":"More extra disk than 102400 GB","value":{"code":"invalid","errors":{"changes.0.disk_gb":["The changes.0.disk_gb may not be greater than 102400."]},"field":"changes.0.disk_gb","message":"The changes.0.disk_gb may not be greater than 102400.","reason":"invalid"}},"missing_subject":{"summary":"A package change without its subject","value":{"code":"invalid","errors":{"changes.0.subject":["A package change needs subject."]},"field":"changes.0.subject","message":"A package change needs subject.","reason":"invalid"}},"no_changes":{"summary":"No changes","value":{"code":"invalid","errors":{"changes":["The changes field is required."]},"field":"changes","message":"The changes field is required.","reason":"invalid"}},"package_unknown":{"summary":"A package that is not sold","value":{"code":"package_unknown","message":"CC999 is not a package we sell.","reason":"package_unknown"}},"zone_unknown":{"summary":"A region that is not priced","value":{"code":"zone_unknown","message":"Choose a region of uk, us, nl or aus.","reason":"zone_unknown"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`invalid`: a field is missing or wrong, or a change lacks a field its `type` needs; `field` names it, a\nchange's field by its row (`changes.0.subject`). The catalogue's own refusals name what is not sold:\n`package_unknown`, `package_inactive`, `package_platform` (the package cannot run the site's platform),\n`zone_unknown`, `currency_unpublished`, `family_unavailable` (the server type is not offered there),\n`uat_unknown` (not a staging environment size) and `duplicate_change` (two changes of one type for one\nsubject).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Preview the price of changes","tags":["Billing"],"x-effect":["none"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-quote","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/standing":{"get":{"description":"Answers where the billing account stands on unpaid invoices: what is overdue, each invoice being followed up\nwith its dates, the services that are suspended and what brings them back. A company with no billing account\nyet answers `good` with empty lists.\n","operationId":"getBillingStanding","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"}],"responses":{"200":{"content":{"application/json":{"examples":{"final_notice":{"$ref":"#/components/examples/BillingStandingFinalNoticeExample"},"good":{"summary":"Nothing is overdue","value":{"cases":[],"paused_until":null,"restore":{"how":"none"},"state":"good","suspended_services":[]}}},"schema":{"$ref":"#/components/schemas/BillingStanding"}}},"description":"The account's standing."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/BillingAccountConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the account's standing","tags":["Billing"],"x-feature":"billing","x-file":"billing-standing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/billing/usage":{"get":{"description":"Answers what the account accrued in one calendar month (UTC): the month's total, each day's total (a day on\nwhich nothing accrued is left out) and each contract line with its hours and its own days. `credits_applied`\nlists the credits applied to invoices whose period starts in the month, as negative amounts.\n","operationId":"getBillingUsage","parameters":[{"$ref":"#/components/parameters/billingAccount"},{"$ref":"#/components/parameters/billingAccountId"},{"description":"The month, as `YYYY-MM`. Left out, the current month (UTC).","example":"2027-01","in":"query","name":"month","schema":{"pattern":"^\\d{4}-\\d{2}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"usage":{"$ref":"#/components/examples/BillingUsageExample"}},"schema":{"$ref":"#/components/schemas/BillingUsage"}}},"description":"The month's usage."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/BillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"account_conflict":{"$ref":"#/components/examples/BillingAccountConflictExample"},"month":{"summary":"A month that is not one","value":{"code":"invalid","errors":{"month":["Give the month as YYYY-MM, for example 2027-01."]},"field":"month","message":"Give the month as YYYY-MM, for example 2027-01.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`month` is not a month (`invalid`), or `account` and `account_id` name different billing accounts."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a month of usage","tags":["Billing"],"x-feature":"billing","x-file":"billing","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/capacity/check":{"post":{"description":"Checks whether a new CoreStack site with this package would fit in a region, without creating or reserving\nanything. `ok` is false when the create would be refused, and `blocking` says why.\n","operationId":"checkClusterSiteCapacity","requestBody":{"content":{"application/json":{"examples":{"package_only":{"summary":"A site on its own","value":{"package":"cs4","region":"uk"}},"with_staging":{"summary":"A site with one staging environment","value":{"environments":[{"uat_size":"xsmall"}],"package":"cs4","region":"uk"}}},"schema":{"$ref":"#/components/schemas/CapacityCheckRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"fits":{"summary":"The site fits","value":{"added":{"cpu_millicores":4500,"disk_bytes":236223201280,"environments":1,"memory_bytes":19327352832,"sites":1},"blocking":[],"cluster":{"id":1009,"name":"CoreStack"},"current":null,"evaluated_at":"2026-11-04T11:32:06Z","node_pending":null,"ok":true,"package":{"key":"cs4","name":"CS4"},"projected":null,"rows":[{"node_pending":null,"role":"production","tier":"shared","uat_size":null},{"node_pending":null,"role":"staging","tier":"shared","uat_size":"xsmall"}],"storage_pending":false,"warnings":[]}},"region_not_set_up":{"summary":"The region is not offered yet","value":{"added":{"cpu_millicores":4500,"disk_bytes":236223201280,"environments":1,"memory_bytes":19327352832,"sites":1},"blocking":[{"message":"United Kingdom is not set up for CoreStack yet. Choose another region","reason":"no_platform_cluster"}],"cluster":null,"current":null,"evaluated_at":"2026-11-04T11:32:06Z","node_pending":null,"ok":false,"package":{"key":"cs4","name":"CS4"},"projected":null,"rows":[],"storage_pending":false,"warnings":[]}}},"schema":{"$ref":"#/components/schemas/CapacityCheck"}}},"description":"The result of the check."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"You cannot create sites for your company","value":{"code":"forbidden","message":"You cannot create sites for this company.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor\nauthentication and you have not set it up, or you cannot create sites for your company (`forbidden`).\n"},"404":{"$ref":"#/components/responses/FeatureOff"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"package":["Choose a package"]},"field":"package","message":"Choose a package","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing, wrong or not part of this request."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Check whether a new site fits","tags":["Sites"],"x-effect":["none"],"x-feature":"sites","x-file":"sites","x-gates":["corestack_create"],"x-rate-limit":{"bucket":"corecluster-capacity","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters":{"get":{"description":"Answers every CoreCluster of your company, by name, each with its package, capacity, usage and site counts,\nand whether another one can be created now. The list is not paged.\n","operationId":"listClusters","responses":{"200":{"content":{"application/json":{"examples":{"list":{"$ref":"#/components/examples/ClusterListExample"}},"schema":{"$ref":"#/components/schemas/ClusterList"}}},"description":"The CoreClusters."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your CoreClusters","tags":["CoreCluster"],"x-feature":"clusters","x-file":"clusters","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"Creates a CoreCluster in a region on a package, with up to ten first sites, charged at the package's price\nfrom the moment it is created. Follow it with `GET /corestack/clusters/{cluster}/progress` until it has\nfinished. Only a create that is accepted counts towards the rate limit, which your whole company shares.\n","operationId":"createCluster","requestBody":{"content":{"application/json":{"examples":{"empty":{"summary":"A CoreCluster with no sites yet","value":{"compute_family":"general","name":"Northwind UK 2","package":"xsmall","region":"uk"}},"with_first_site":{"summary":"A CoreCluster with a first site","value":{"name":"Northwind UK 3","package":"xsmall","region":"uk","sites":[{"content":"empty","domain":"journal.harbourandfinch.example.com","php_version":"8.3","platform":"wordpress","tier":"S"}]}},"with_fresh_install":{"summary":"A CoreCluster with a fresh WordPress install","value":{"name":"Northwind UK 4","package":"xsmall","region":"uk","sites":[{"content":"fresh","domain":"bookings.harbourandfinch.example.com","fresh":{"admin_email":"eleanor.finch@example.com","admin_username":"eleanor","locale":"en_GB","site_title":"Harbour & Finch bookings"},"platform":"wordpress","tier":"S"}]}}},"schema":{"$ref":"#/components/schemas/ClusterCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"created":{"$ref":"#/components/examples/ClusterCreatedExample"}},"schema":{"$ref":"#/components/schemas/ClusterCreated"}}},"description":"The CoreCluster is being created. `sites` lists each first site with its own operation."},"202":{"content":{"application/json":{"examples":{"accepted":{"$ref":"#/components/examples/ClusterAcceptedExample"}},"schema":{"$ref":"#/components/schemas/ClusterCreated"}}},"description":"The create was accepted and its first step is still being confirmed. The body is the same as for `201`,\nwith the operation's `status` `pending`.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/FeatureOff"},"409":{"content":{"application/json":{"examples":{"changed":{"summary":"The package or region changed while the request was checked","value":{"code":"cluster_busy","message":"The package or the region changed while the request was checked. Check it and try again.","reason":"cluster_busy"}},"cluster_busy":{"summary":"Another CoreCluster is being created","value":{"code":"cluster_busy","message":"Another cluster is being created for your company. Try again in a moment.","reason":"cluster_busy"}},"compute_blocked":{"summary":"The region cannot take the CoreCluster now","value":{"code":"compute_blocked","dimension":null,"message":"We can't set this up in United Kingdom right now. Please contact support and we'll sort it out.","reason":"compute_blocked","tier":"production"}},"duplicate":{"summary":"A first site's domain was taken while the request was checked","value":{"code":"duplicate","message":"A site with this domain already exists in this cluster","reason":"duplicate"}},"region_unavailable":{"summary":"The region has no room","value":{"code":"region_unavailable","message":"No capacity in this region at the moment. Choose another region or contact support.","reason":"region_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was created. `reason` says why: `region_unavailable` (the region is not open or has no room for\nthe package; it may carry a `cause`), `compute_blocked` (the region cannot take the CoreCluster now; the\nanswer adds `tier` and `dimension`), `cluster_busy` (another CoreCluster is being created for your\ncompany, or the package or region changed while the request was checked) or `duplicate` (a first site's\ndomain was taken while the request was checked).\n"},"422":{"content":{"application/json":{"examples":{"first_site_size":{"summary":"A first site with no size","value":{"code":"invalid","errors":{"sites.0.tier":["Choose a size"]},"field":"sites.0.tier","message":"Choose a size","reason":"invalid"}},"first_site_unknown_field":{"summary":"A first site's field that is not part of the request","value":{"code":"invalid","errors":{"sites.0.http_auth":["The http_auth field is not part of this request."]},"field":"sites.0.http_auth","message":"The http_auth field is not part of this request.","reason":"invalid"}},"fresh_admin_email":{"summary":"A fresh install's administrator address of more than 190 characters","value":{"code":"invalid","errors":{"sites.0.fresh.admin_email":["Enter a valid admin email address"]},"field":"sites.0.fresh.admin_email","message":"Enter a valid admin email address","reason":"invalid"}},"fresh_admin_username":{"summary":"A fresh install's administrator name that is not allowed","value":{"code":"invalid","errors":{"sites.0.fresh.admin_username":["Admin username: 3–32 characters, a letter first, then letters, digits or `_`"]},"field":"sites.0.fresh.admin_username","message":"Admin username: 3–32 characters, a letter first, then letters, digits or `_`","reason":"invalid"}},"fresh_site_title":{"summary":"A fresh install's title of more than 100 characters","value":{"code":"invalid","errors":{"sites.0.fresh.site_title":["The title is too long"]},"field":"sites.0.fresh.site_title","message":"The title is too long","reason":"invalid"}},"name_taken":{"summary":"The name is already in use","value":{"code":"invalid","errors":{"name":["You already have a cluster called that"]},"field":"name","message":"You already have a cluster called that","reason":"invalid"}},"node_acknowledge":{"summary":"An acknowledgement that is not one `eol`","value":{"code":"invalid","errors":{"sites.0.node_acknowledge":["invalid"]},"field":"sites.0.node_acknowledge","message":"Acknowledge with [\"eol\"], or leave it out.","reason":"invalid"}},"node_major":{"summary":"A Node.js version that is not a number from 1 to 99","value":{"code":"invalid","errors":{"sites.0.node_major":["invalid"]},"field":"sites.0.node_major","message":"Choose a Node.js version from the list.","reason":"invalid"}},"runtime_not_adopted":{"summary":"A new site cannot choose a Node.js version here yet","value":{"code":"runtime_not_adopted","errors":{"sites.0.node_major":["runtime_not_adopted"]},"message":"A Node.js version cannot be chosen for a new site here yet. Leave it out to use the default.","reason":"runtime_not_adopted"}},"too_many_first_sites":{"summary":"More than ten first sites","value":{"code":"invalid","errors":{"sites":["Add up to 10 sites while creating the cluster. Add the rest once it is ready."]},"field":"sites","message":"Add up to 10 sites while creating the cluster. Add the rest once it is ready.","reason":"invalid"}},"unknown_field":{"summary":"A field that is not part of the request","value":{"code":"invalid","errors":{"compute_optimised":["The compute_optimised field is not part of this request."]},"field":"compute_optimised","message":"The compute_optimised field is not part of this request.","reason":"invalid"}},"varnish_platform":{"summary":"Varnish asked for a site that is not Magento 2","value":{"code":"invalid","errors":{"sites.0.varnish":["varnish_not_offered"]},"field":"sites.0.varnish","message":"Varnish is offered for Magento 2 sites only.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`). `field` names it; a first site's field is named by its row, such\nas `sites.0.tier`. A field that is not listed in the request schema is refused the same way. A name whose\naddress an earlier CoreCluster had, a deleted one included, is not available. A first site's Node.js\nchoice has reasons of its own, with the row's field in `errors` and no `field`: `runtime_not_adopted` (a\nnew site cannot choose a version here yet), `node_major_unavailable`, `node_platform_minimum` and\n`node_major_existing_only` (the version is not offered to a new site of this platform), `ack_required`\n(the version is past its end of life; `required` lists what `node_acknowledge` must carry) and\n`feature_off` (choosing a version is switched off).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"example":{"message":"The platform could not be checked just now. Try again in a minute."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The platform could not be checked or written to, so nothing was created. Try again in a minute."},"503":{"content":{"application/json":{"example":{"code":"temporarily_unavailable","message":"This region is not ready","reason":"temporarily_unavailable"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The region cannot take a new CoreCluster at the moment (`temporarily_unavailable`). Nothing was created. Try again later."}},"summary":"Create a CoreCluster","tags":["CoreCluster"],"x-effect":["billable"],"x-feature":"cluster-create","x-file":"clusters","x-gates":["managed_clusters_create"],"x-long-running":"getClusterProgress","x-rate-limit":{"bucket":"reseller-cluster-create","limit":10,"minutes":60},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/clusters/capacity/check":{"post":{"description":"Answers whether the sites and environments you list would fit a package in a region, before the CoreCluster\nexists. Nothing is created or reserved. A proposal that would not fit still answers `200`, with the reasons\nin `blocking`.\n","operationId":"checkPackageCapacity","requestBody":{"content":{"application/json":{"examples":{"one_site":{"summary":"One small WordPress site on the smallest package","value":{"package":"xsmall","region":"uk","sites":[{"platform":"wordpress","tier":"S"}]}}},"schema":{"$ref":"#/components/schemas/ClusterPackageCapacityRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"fits":{"$ref":"#/components/examples/ClusterPackageCapacityExample"}},"schema":{"$ref":"#/components/schemas/ClusterCapacityCheck"}}},"description":"The capacity of the package now and with the proposal. `cluster` is null."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"content":{"application/json":{"examples":{"region":{"summary":"No region","value":{"code":"invalid","errors":{"region":["Choose a region"]},"field":"region","message":"Choose a region","reason":"invalid"}},"remove":{"summary":"Something to take away before the CoreCluster exists","value":{"code":"invalid","errors":{"remove":["There is no cluster to remove anything from yet"]},"field":"remove","message":"There is no cluster to remove anything from yet","reason":"invalid"}},"too_many":{"summary":"More than 50 rows","value":{"code":"invalid","errors":{"sites":["At most 50 sites and environments can be checked at once"]},"field":"sites","message":"At most 50 sites and environments can be checked at once","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The proposal is not one (`invalid`): a field that is not part of the request, a row that is not a known\nplatform and size, more than 50 rows in all, a `remove` list that is not empty, or a package or region\nthat does not exist.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Check what fits a new CoreCluster","tags":["CoreCluster"],"x-effect":["none"],"x-feature":"clusters","x-file":"clusters","x-gates":[],"x-rate-limit":{"bucket":"reseller-capacity","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"One CoreCluster with every site on it. Each site carries its environments; a site removed from the\nCoreCluster is not listed.\n","operationId":"getCluster","responses":{"200":{"content":{"application/json":{"examples":{"cluster":{"$ref":"#/components/examples/ClusterAnswerExample"}},"schema":{"$ref":"#/components/schemas/ClusterAnswer"}}},"description":"The CoreCluster and its sites."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a CoreCluster","tags":["CoreCluster"],"x-feature":"clusters","x-file":"clusters","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"delete":{"description":"Deletes the CoreCluster for good, with its capacity and SSH address; read\n`GET /corestack/clusters/{cluster}/deletion` first. Without `allow_non_empty` only an empty CoreCluster is\ndeleted; with it, every site, environment and deleted site in its grace period goes too, with no final\nsnapshot, and so do their snapshots, except the ones the preview counts in `kept_snapshots`, which stay until\ntheir retention ends. The CoreCluster reads `state` `deleting` until it is gone, then answers `404`.\n","operationId":"deleteCluster","requestBody":{"content":{"application/json":{"examples":{"empty":{"summary":"Delete an empty CoreCluster","value":{"confirm_name":"Northwind spare"}},"everything":{"summary":"Delete a CoreCluster and everything on it","value":{"allow_non_empty":true,"confirm_name":"Northwind UK 1"}}},"schema":{"$ref":"#/components/schemas/ClusterDeleteRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"started":{"$ref":"#/components/examples/ClusterDeleteAcceptedExample"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"The deletion has started."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"cluster_deleting":{"summary":"The CoreCluster is already being deleted","value":{"code":"cluster_deleting","message":"This cluster is being deleted","reason":"cluster_deleting"}},"cluster_not_empty":{"summary":"The CoreCluster still has a site","value":{"code":"cluster_not_empty","details":{"preflight":"corecluster_delete_preflight","totals":{"deleted_sites":0,"domains":1,"environments":0,"mail_domains":0,"sites":1,"snapshot_bytes":1288490188,"snapshots":2}},"message":"The cluster is not empty: it still has sites, environments, deleted sites in their grace period or snapshots. Read what deleting it removes, then send the request again with allow_non_empty set to true to delete everything on it.","reason":"cluster_not_empty"}},"legacy_cluster":{"summary":"Corefinity manages the CoreCluster","value":{"code":"legacy_cluster","message":"This cluster is managed by Corefinity and cannot be deleted here. Contact support.","reason":"legacy_cluster"}},"moving_package":{"summary":"The CoreCluster is moving to a new package","value":{"code":"cluster_busy","message":"The cluster is moving to its new package. Wait, or ask staff to remove it.","reason":"cluster_busy"}},"setting_up":{"summary":"The CoreCluster is still being set up","value":{"code":"cluster_busy","message":"The cluster is still being set up. Wait, or ask staff to remove it.","reason":"cluster_busy"}},"staff_removal":{"summary":"A site only Corefinity can remove","value":{"code":"staff_removal","message":"1 site on this cluster can only be removed by our staff. Contact support to delete the cluster","reason":"staff_removal"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ClusterNotEmptyRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"Nothing was started. `reason` says why: `cluster_not_empty` (something is still on the CoreCluster and\n`allow_non_empty` was not true; `details.totals` counts it), `cluster_deleting` (it is already being\ndeleted), `cluster_busy` (it is still being set up, is moving to a new package, or another change to it\nis running), `legacy_cluster` (Corefinity manages it, so it cannot be deleted here) or `staff_removal` (a\nsite on it can only be removed by Corefinity).\n"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"The name does not match","value":{"code":"confirm_mismatch","errors":{"confirm_name":["Type the cluster's name to confirm"]},"field":"confirm_name","message":"Type the cluster's name to confirm","reason":"confirm_mismatch"}},"invalid":{"summary":"allow_non_empty is not true or false","value":{"code":"invalid","errors":{"allow_non_empty":["Send allow_non_empty as true or false."]},"field":"allow_non_empty","message":"Send allow_non_empty as true or false.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"}]}}},"description":"`confirm_name` is missing or is not the CoreCluster's name exactly (`confirm_mismatch`), or a field is\nwrong or not part of the request (`invalid`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"example":{"message":"The change could not be saved. Contact support."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The platform could not be read or written to, so the deletion did not start and the CoreCluster is as it was."},"503":{"$ref":"#/components/responses/SwitchedOff"}},"summary":"Delete a CoreCluster","tags":["CoreCluster"],"x-effect":["deletes"],"x-feature":"clusters","x-file":"clusters","x-gates":["managed_clusters_create","delete"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-cluster-changes","limit":5,"minutes":1},"x-scope":"destructive","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/clusters/{cluster}/activity":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"What happened on the CoreCluster and its sites, newest first. Paged by `before`: send the answer's\n`next_before` and `next_before_id` back as `before` and `before_id`, together; null means the last page.\n","operationId":"listClusterActivity","parameters":[{"$ref":"#/components/parameters/cursorLimit"},{"description":"Only the activity of one site or environment of the CoreCluster, by its site row id. A row that is not on the CoreCluster answers `404`.","in":"query","name":"site_id","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"The `next_before` of the previous answer, a time in epoch milliseconds. Send it with `before_id`.","in":"query","name":"before","required":false,"schema":{"pattern":"^\\d{1,16}$","type":"string"}},{"description":"The `next_before_id` of the previous answer, such as `operation:5120`. Send it with `before`.","in":"query","name":"before_id","required":false,"schema":{"pattern":"^(operation|command|deployment|restore|snapshot|terminal|pagespeed|audit|copy):[1-9]\\d{0,18}$","type":"string"}},{"description":"Only these kinds of activity, for example `kinds[]=operation&kinds[]=deployment`.","in":"query","name":"kinds[]","required":false,"schema":{"items":{"enum":["operation","command","deployment","restore","snapshot","terminal","pagespeed","audit","copy"],"type":"string"},"type":"array"}},{"description":"Send `1` for only what is still running; `0`, or leaving it out, lists everything. The words `true` and `false` are refused `422`.","example":1,"in":"query","name":"unfinished","required":false,"schema":{"enum":[0,1],"type":"integer"}},{"description":"`mcp` for only what an AI assistant did, `panel` for everything else.","in":"query","name":"origin","required":false,"schema":{"enum":["mcp","panel"],"type":"string"}},{"description":"Only what one actor did. `u` followed by a user id, `schedule` or `corefinity`.","in":"query","name":"actor","required":false,"schema":{"pattern":"^(schedule|corefinity|u\\d{1,18})$","type":"string"}},{"description":"Only items with this result.","in":"query","name":"result","required":false,"schema":{"enum":["succeeded","failed","running"],"type":"string"}},{"description":"Only items at or after this date or time, such as `2026-11-01` or `2026-11-01T09:00:00Z`.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Only items before this date or time; an item at exactly this time is left out.","in":"query","name":"to","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"page":{"$ref":"#/components/examples/ClusterActivityExample"}},"schema":{"$ref":"#/components/schemas/ActivityPage"}}},"description":"One page of activity."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"examples":{"cursor":{"summary":"before without before_id","value":{"code":"invalid","errors":{"before_id":["Send before and before_id together."]},"field":"before_id","message":"Send before and before_id together.","reason":"invalid"}},"unfinished":{"summary":"unfinished sent as a word","value":{"code":"invalid","errors":{"unfinished":["The unfinished field must be true or false."]},"field":"unfinished","message":"The unfinished field must be true or false.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A filter value is not allowed, or only one of `before` and `before_id` was sent (`field` names the one that is missing)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a CoreCluster's activity","tags":["CoreCluster"],"x-feature":"clusters","x-file":"clusters","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/addons":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"put":{"description":"Sets the CoreCluster's four add-on allowances (extra cores, memory, disk and log storage) to the totals sent,\nso `0` removes an add-on. The change applies at once and is billed from the next hour; the ceilings and steps\nare in the CoreCluster's upgrade options (`addons.max`, `addons.unit`). A CoreCluster with no billing\ncontract takes the change all the same, unpriced: `quote` is null.\n","operationId":"updateClusterAddons","requestBody":{"content":{"application/json":{"examples":{"cores_and_memory":{"summary":"Two extra cores and 8 GB of memory","value":{"cores":2,"disk_gb":0,"log_storage_gb":0,"memory_gb":8}}},"schema":{"$ref":"#/components/schemas/UpgradeClusterAddonsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"applied":{"$ref":"#/components/examples/UpgradeClusterAddonsExample"}},"schema":{"$ref":"#/components/schemas/UpgradeClusterAddonsChange"}}},"description":"The add-ons were applied. `operation` is the change, already completed."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/UpgradeClusterWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"stale":{"summary":"The price has moved since the quote","value":{"code":"stale","message":"Prices changed. Review the quote again.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was changed. `stale`: the price has moved since the quote. `no_payment_method`: the billing\naccount has no card or mandate. `cluster_busy`: another change to the CoreCluster is running, or its\nsites are being moved. `cluster_not_ready`, `cluster_deleting`, `cluster_migrating`: the CoreCluster is\nbeing created or deleted, or is still moving to its last package. `capacity_blocked`: a smaller\nallowance would leave less than the CoreCluster's sites use (`dimension` names what). `compute_blocked`:\nthere is no room for the extra cores or memory at the moment. `cluster_legacy`: capacity is added to\nthis CoreCluster with support. `demo_keep_required`: the CoreCluster is a demo that has not been kept\n(the answer adds `keep_url` and `change`).\n"},"422":{"content":{"application/json":{"examples":{"addon_bounds":{"$ref":"#/components/examples/UpgradeAddonBoundsExample"},"missing":{"$ref":"#/components/examples/UpgradeAddonsMissingExample"}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`invalid`: a field is missing or wrong (`field` names it). `addon_bounds`: an allowance is above its\nceiling or off its step (an allowance the CoreCluster holds already is never refused for its size).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a CoreCluster's add-ons","tags":["Packages and capacity"],"x-effect":["billable"],"x-feature":"upgrades","x-file":"upgrades","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-upgrades","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/clusters/{cluster}/capacity/check":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"post":{"description":"Answers whether new sites and environments, the removal of others, or another package would fit the\nCoreCluster, without creating or reserving anything. A proposal that would not fit still answers `200`, with\nthe reasons in `blocking`; an empty body answers the CoreCluster as it is now.\n","operationId":"checkClusterCapacity","requestBody":{"content":{"application/json":{"examples":{"add_a_site":{"summary":"One more small WordPress site","value":{"sites":[{"platform":"wordpress","tier":"S"}]}},"add_an_environment":{"summary":"One more environment and a larger site","value":{"environments":[{"platform":"wordpress","tier":"S"}],"sites":[{"platform":"magento2","tier":"M"}]}}},"schema":{"$ref":"#/components/schemas/ClusterCapacityRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"examples":{"fits":{"$ref":"#/components/examples/ClusterCapacityExample"}},"schema":{"$ref":"#/components/schemas/ClusterCapacityCheck"}}},"description":"The capacity of the CoreCluster now and with the proposal."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"examples":{"remove":{"summary":"A row that is not on the CoreCluster","value":{"code":"invalid","errors":{"remove.0":["That site or environment is not on this cluster"]},"field":"remove.0","message":"That site or environment is not on this cluster","reason":"invalid"}},"rows":{"summary":"sites is not a list","value":{"code":"invalid","errors":{"sites":["The sites field must be a list of {platform, tier}"]},"field":"sites","message":"The sites field must be a list of {platform, tier}","reason":"invalid"}},"too_many":{"summary":"More than 50 rows","value":{"code":"invalid","errors":{"sites":["At most 50 sites and environments can be checked at once"]},"field":"sites","message":"At most 50 sites and environments can be checked at once","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The proposal is not one (`invalid`): a field that is not part of the request, a row that is not a known\nplatform and size, more than 50 rows in all, a `remove` id that is not on the CoreCluster, or a package\nthat does not exist.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Check what fits a CoreCluster","tags":["CoreCluster"],"x-effect":["none"],"x-feature":"clusters","x-file":"clusters","x-gates":[],"x-rate-limit":{"bucket":"reseller-capacity","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/compute-family":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"post":{"description":"Moves every site of a CoreCluster between the two server types, `general` (Standard) and `optimised`\n(Performance); the CoreCluster is billed at the new price once the last site has moved. It is all or nothing:\nwhen any site cannot move yet, nothing is queued and the refusal's `refused` lists each such site. A\nCoreCluster with no billing contract takes the change all the same, unpriced: `quote` is null.\n","operationId":"switchClusterComputeFamily","requestBody":{"content":{"application/json":{"examples":{"performance":{"summary":"Move to Performance servers","value":{"confirm_name":"Northwind UK 1","family":"optimised"}}},"schema":{"$ref":"#/components/schemas/UpgradeClusterFamilyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"settled":{"summary":"No site had to move","value":{"already":[],"cluster":{},"items":[],"operation":null,"pending":null,"queued":false,"quote":null,"settled":true},"x-unverified":true}},"schema":{"$ref":"#/components/schemas/UpgradeClusterFamilyChange"}}},"description":"The moves are queued or started: one entry of `items` for each site, with its own operation once it has\nstarted. `settled` is `true` when no site had to move.\n","x-unverified":true},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/UpgradeClusterWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"same_family":{"$ref":"#/components/examples/UpgradeSameFamilyExample"}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was changed. `same_family`: the CoreCluster is on that server type. `stale`: the price has moved\nsince the quote. `no_payment_method`: the billing account has no card or mandate.\n`family_change_pending`: an earlier change of server type has not finished. `compute_capacity_blocked`:\nthe servers of that type have no room at the moment. `demo_keep_required`: the CoreCluster is a demo\nthat has not been kept (the answer adds `keep_url` and `change`). When a site cannot move yet, the\nanswer is that site's own refusal, its domain before the sentence, with `refused` listing every such\nsite.\n"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"$ref":"#/components/examples/UpgradeConfirmNameMismatchExample"},"family":{"$ref":"#/components/examples/UpgradeFamilyUnknownExample"}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`confirm_mismatch`: `confirm_name` is not the CoreCluster's name. `invalid`: a field is missing or wrong\n(`field` names it). `family_unavailable`: the server type is not offered in the region.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/UpgradeRegionNotReady"}},"summary":"Switch a CoreCluster's server type","tags":["Packages and capacity"],"x-effect":["billable"],"x-feature":"upgrades","x-file":"upgrades","x-gates":["compute_optimised","billing","restart_batches"],"x-rate-limit":{"bucket":"corecluster-upgrades","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/clusters/{cluster}/deletion":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"What deleting the CoreCluster would take with it: totals, then each site with its environments and snapshots.\n`empty` is true when no site, environment, deleted site or snapshot is left. Nothing is deleted.\n","operationId":"previewClusterDeletion","responses":{"200":{"content":{"application/json":{"examples":{"one_site":{"$ref":"#/components/examples/ClusterDeletionExample"}},"schema":{"$ref":"#/components/schemas/ClusterDeletion"}}},"description":"What the deletion would take."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/SwitchedOff"}},"summary":"Preview a CoreCluster's deletion","tags":["CoreCluster"],"x-feature":"clusters","x-file":"clusters","x-gates":["managed_clusters_create","delete"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/clusters/{cluster}/logs/context":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"Answers one line with the lines before and after it in the same stream, each list oldest first. Name the\nline as `<stream_id>,<time>`, both taken from a line a search answered.\n","operationId":"getClusterLogContext","parameters":[{"$ref":"#/components/parameters/clusterLogsLine"},{"$ref":"#/components/parameters/logsBefore"},{"$ref":"#/components/parameters/logsAfter"},{"$ref":"#/components/parameters/logsSites"},{"$ref":"#/components/parameters/logsEnvironment"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/ClusterLogsContextExample"}},"schema":{"$ref":"#/components/schemas/ClusterLogsContext"}}},"description":"The line and its neighbours."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/LogsLineNotFound"},"409":{"$ref":"#/components/responses/ClusterLogsScopeConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"Get lines around a CoreCluster's log line","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab","cluster_logs"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/logs/exports":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"post":{"description":"Starts a file of the matching lines of every site of the CoreCluster that you can see, up to 50,000 lines or\n64 MiB, and answers the export with its `capability`, which is shown only once. Read the export with\n`GET /corestack/logs/exports/{download}` until `state` is `ready`, then collect the file once, within 24\nhours.\n","operationId":"startClusterLogsExport","requestBody":{"content":{"application/json":{"examples":{"csv":{"summary":"The last day's web access lines as CSV","value":{"format":"csv","range":"24h","source":"web-access"}},"json":{"summary":"Server errors as JSON lines","value":{"format":"json","query":"status:>=500","range":"1h","source":"web-access"}}},"schema":{"$ref":"#/components/schemas/ClusterLogsExportRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsExportStartedExample"}},"schema":{"$ref":"#/components/schemas/LogsExportStarted"}}},"description":"The export, which is being prepared, and its one-time capability."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ClusterLogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"Start an export of a CoreCluster's logs","tags":["Logs"],"x-effect":["none"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab","cluster_logs"],"x-long-running":"getLogsExport","x-rate-limit":{"bucket":"corecluster-logs-download","limit":5,"minutes":10},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/clusters/{cluster}/logs/facets":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"Answers the ten most frequent values of each field the matching lines carry. Takes the same source, query,\nfilters and time as a search.\n","operationId":"getClusterLogFacets","parameters":[{"$ref":"#/components/parameters/logsSites"},{"$ref":"#/components/parameters/logsEnvironment"},{"$ref":"#/components/parameters/logsSourceExample"},{"$ref":"#/components/parameters/logsQuery"},{"$ref":"#/components/parameters/logsFiltersEncoded"},{"$ref":"#/components/parameters/logsRange"},{"$ref":"#/components/parameters/logsFrom"},{"$ref":"#/components/parameters/logsTo"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsFacetsExample"}},"schema":{"$ref":"#/components/schemas/LogsFacetsResult"}}},"description":"The facets."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ClusterLogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"Get the facets of a CoreCluster's logs","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab","cluster_logs"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/logs/fields":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"Answers the fields the lines of a source carry in the time range (the last 24 hours when left out), each with\nits type and its five most frequent values. The answer is kept for a minute.\n","operationId":"listClusterLogFields","parameters":[{"$ref":"#/components/parameters/logsSites"},{"$ref":"#/components/parameters/logsEnvironment"},{"$ref":"#/components/parameters/logsSourceExample"},{"$ref":"#/components/parameters/logsRange"},{"$ref":"#/components/parameters/logsFrom"},{"$ref":"#/components/parameters/logsTo"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsFieldsExample"}},"schema":{"$ref":"#/components/schemas/LogsFields"}}},"description":"The fields."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ClusterLogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"List a CoreCluster's log fields","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab","cluster_logs"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/logs/fields/{field}/values":{"parameters":[{"$ref":"#/components/parameters/cluster"},{"$ref":"#/components/parameters/logsField"}],"get":{"description":"Answers up to 50 values of one field with how many lines carry each, most frequent first. The time range\ndefaults to the last 24 hours.\n","operationId":"listClusterLogFieldValues","parameters":[{"$ref":"#/components/parameters/logsSites"},{"$ref":"#/components/parameters/logsEnvironment"},{"$ref":"#/components/parameters/logsSourceExample"},{"$ref":"#/components/parameters/logsPrefix"},{"$ref":"#/components/parameters/logsRange"},{"$ref":"#/components/parameters/logsFrom"},{"$ref":"#/components/parameters/logsTo"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsFieldValuesExample"}},"schema":{"$ref":"#/components/schemas/LogsFieldValues"}}},"description":"The values and their counts."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ClusterLogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"List a CoreCluster's log field values","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab","cluster_logs"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/logs/histogram":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"Answers how many matching lines each slice of the time range holds, split by level, for the same source,\nquery, filters and time as a search. A query that cannot be counted over time answers no buckets and a\nwarning.\n","operationId":"getClusterLogHistogram","parameters":[{"$ref":"#/components/parameters/logsSites"},{"$ref":"#/components/parameters/logsEnvironment"},{"$ref":"#/components/parameters/logsSourceExample"},{"$ref":"#/components/parameters/logsQuery"},{"$ref":"#/components/parameters/logsFiltersEncoded"},{"$ref":"#/components/parameters/logsBuckets"},{"$ref":"#/components/parameters/logsRange"},{"$ref":"#/components/parameters/logsFrom"},{"$ref":"#/components/parameters/logsTo"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsHistogramExample"}},"schema":{"$ref":"#/components/schemas/LogsHistogram"}}},"description":"The buckets."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ClusterLogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"Get a histogram of a CoreCluster's logs","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab","cluster_logs"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/logs/query":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"post":{"description":"Answers the matching lines of every site of the CoreCluster that you can see, newest first, each with its\n`site`; a query with a pipe answers `site` null and says so in `warnings`, and an aggregating pipe, such as\n`| stats count()`, answers `kind` `table`. Paged by cursor: send `next_cursor` back as `cursor`; null means\nthe last page.\n","operationId":"queryClusterLogs","requestBody":{"content":{"application/json":{"examples":{"all_environments":{"summary":"Every environment of every site","value":{"environment":"all","range":"1h"}},"errors":{"summary":"Server errors in the last hour","value":{"limit":200,"query":"status:>=500","range":"1h","source":"web-access"}},"filters":{"summary":"Filters instead of a query","value":{"filters":{"method":["GET"],"path":{"mode":"prefix","value":"/checkout"},"status":["5xx"]},"limit":50,"range":"24h","source":"web-access"}},"window":{"summary":"An exact window, with facets","value":{"facets":["status","level"],"from":"2026-11-03T09:00:00Z","source":"all","to":"2026-11-03T10:00:00Z"}}},"schema":{"$ref":"#/components/schemas/ClusterLogsQueryRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/ClusterLogsQueryExample"}},"schema":{"$ref":"#/components/schemas/ClusterLogsQueryResult"}}},"description":"A page of lines, or a table."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ClusterLogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"Search a CoreCluster's logs","tags":["Logs"],"x-effect":["none"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab","cluster_logs"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/logs/saved-queries":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"Answers your saved queries for this CoreCluster, then the ones you keep for everywhere, then any that\nCorefinity support shared on this CoreCluster.\n","operationId":"listClusterLogSavedQueries","responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/ClusterLogsSavedQueryListExample"}},"schema":{"$ref":"#/components/schemas/LogsSavedQueryList"}}},"description":"The saved queries."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List saved log queries for a CoreCluster","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab","cluster_logs"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"Saves a query, filters or neither with a source and a time range: for this CoreCluster when `cluster_id` is\nsent, for everywhere otherwise. You can keep 50 saved queries.\n","operationId":"createClusterLogSavedQuery","requestBody":{"content":{"application/json":{"examples":{"filters":{"summary":"Filters, kept for everywhere","value":{"filters":{"level":["warning","error"]},"name":"PHP warnings","range":"7d","source":"php"}},"pinned":{"summary":"A query for this CoreCluster","value":{"cluster_id":1017,"name":"Checkout errors","query":"status:>=500","range":"24h","source":"web-access"}}},"schema":{"$ref":"#/components/schemas/ClusterLogsSavedQueryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/ClusterLogsSavedQueryExample"}},"schema":{"$ref":"#/components/schemas/LogsSavedQuery"}}},"description":"The saved query."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a saved CoreCluster log query","tags":["Logs"],"x-effect":["changes-settings"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab","cluster_logs"],"x-rate-limit":{"bucket":"corecluster-logs-saved","limit":30,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/logs/streams":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"Answers the log sources, the limits of a read, the logs quota, the time ranges on offer, and each site of\nthe CoreCluster with whether its logs are in the read.\n","operationId":"listClusterLogStreams","parameters":[{"$ref":"#/components/parameters/logsSites"},{"$ref":"#/components/parameters/logsEnvironment"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/ClusterLogsStreamsExample"}},"schema":{"$ref":"#/components/schemas/ClusterLogsStreams"}}},"description":"The sources, limits, quota and ranges."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ClusterLogsScopeConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"List a CoreCluster's log sources","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab","cluster_logs"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/logs/usage":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"Answers the logs quota of the CoreCluster, what is stored, how long lines are kept, 30 days of daily figures\nand the share of each site you can see. This endpoint is available whenever logs are, also while the other\nCoreCluster logs endpoints are not.\n","operationId":"getClusterLogUsage","responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/ClusterLogsUsageExample"}},"schema":{"$ref":"#/components/schemas/LogsUsage"}}},"description":"The usage."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/LogsNotCollectedConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a CoreCluster's logs usage","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/package":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"post":{"description":"Moves a CoreCluster to a larger package, billed at the new price once the change has finished; a smaller\npackage is arranged with support. `quote` is the price the change was made at, or null for a CoreCluster with\nno billing contract.\n","operationId":"updateClusterPackage","requestBody":{"content":{"application/json":{"examples":{"larger":{"summary":"Move to CC12","value":{"confirm_name":"Northwind UK 1","package":"cc12"}}},"schema":{"$ref":"#/components/schemas/UpgradeClusterPackageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"started":{"$ref":"#/components/examples/UpgradeClusterPackageExample"}},"schema":{"$ref":"#/components/schemas/UpgradeClusterPackageChange"}}},"description":"The change has started."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/UpgradeClusterWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"same_package":{"summary":"Already on that package","value":{"code":"same_package","message":"This is already the package","reason":"same_package"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was changed. `same_package`: the CoreCluster is on that package. `downgrade`: the package is\nsmaller. `stale`: the price has moved since the quote. `cluster_busy`: another change to the CoreCluster\nor to one of its sites is running. `cluster_not_ready`, `cluster_deleting`, `cluster_migrating`: the\nCoreCluster is being created or deleted, or is still moving to its last package. `compute_blocked`:\nthere is no room for the larger package at the moment. `support_only`, `legacy_cluster`,\n`cluster_on_compute`, `pool_generation_exhausted`: this CoreCluster's package is changed with support.\n`demo_keep_required`: the CoreCluster is a demo that has not been kept (the answer adds `keep_url` and\n`change`). A region with no room for the package refuses with its own reason and sentence.\n"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"$ref":"#/components/examples/UpgradeConfirmNameMismatchExample"},"corestack_package":{"summary":"A CoreStack package, for a CoreCluster with no billing contract","value":{"code":"invalid","errors":{"package":["That package is for Managed Websites, not a Managed Cluster. Choose a cluster package."]},"field":"package","message":"That package is for Managed Websites, not a Managed Cluster. Choose a cluster package.","reason":"invalid"},"x-unverified":true},"package_unknown":{"summary":"A CoreStack package","value":{"code":"package_unknown","errors":{"package":["CS8 is not a package for this cluster"]},"message":"CS8 is not a package for this cluster","reason":"package_unknown"}},"unknown_field":{"summary":"A field the change does not take","value":{"code":"invalid","errors":{"apply":["unknown_key"]},"field":"apply","message":"The apply field is not part of this request.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`confirm_mismatch`: `confirm_name` is not the CoreCluster's name. `invalid`: a field is missing or wrong\n(`field` names it): on `package`, a package that does not exist or one the region or the CoreCluster's\nsites cannot take; a field that is not one of the three is refused too, naming it. `package_unknown`: the\npackage is not a CoreCluster package, such as `cs8` (a CoreCluster with no billing contract is told so\nas `invalid` on `package`). `pool_above_ceiling`: the CoreCluster runs more servers than the package\nallows.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/UpstreamFailed","description":"The platform could not be written to, so nothing was changed. Try again in a minute."}},"summary":"Update a CoreCluster's package","tags":["Packages and capacity"],"x-effect":["billable"],"x-feature":"upgrades","x-file":"upgrades","x-gates":["packages","managed_clusters_create"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-cluster-changes","limit":5,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/clusters/{cluster}/progress":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"How far the CoreCluster's create has got, stage by stage, with its first sites. Read it again until the\noperation's `status` is `completed` or `failed`. It keeps answering after the create has finished.\n","operationId":"getClusterProgress","responses":{"200":{"content":{"application/json":{"examples":{"creating":{"$ref":"#/components/examples/ClusterProgressExample"}},"schema":{"$ref":"#/components/schemas/ClusterProgress"}}},"description":"The progress of the create."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The id does not exist or is something you cannot see, the CoreCluster was not created through a create the Control Panel recorded, or creating CoreClusters is not on for your company (`feature_off`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a CoreCluster's create progress","tags":["CoreCluster"],"x-feature":"cluster-create","x-file":"clusters","x-gates":["managed_clusters_create"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/provisioning-options":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"What a new site in this CoreCluster can be: each platform with its versions and sizes, whether each size is\navailable and fits, and the CoreCluster's remaining capacity.\n","operationId":"getClusterProvisioningOptions","responses":{"200":{"content":{"application/json":{"example":{"can_create":{"available":true,"reason":null},"capacity":{"basis":"estimate","cpu":{"capacity_millicores":8000,"level":"ok","percent":0,"used_p95_millicores":0},"evaluated_at":"2026-11-14T09:00:00Z","level":"ok","memory":{"capacity_bytes":34359738368,"level":"ok","percent":0,"used_p95_bytes":0},"package":null,"sites":{"count":0,"environments":0},"storage":{"capacity_bytes":0,"level":"ok","percent":0,"provisioned_bytes":0}},"cluster":{"id":1017,"name":"Northwind UK 1"},"limits":{"domain_max":253},"magento_keys":{"source":"none","updated_at":null},"next_port":20033,"platforms":[{"available":true,"content":{"empty":{"available":true,"reason":null},"fresh":{"available":true,"reason":null}},"default_tier":"S","fresh_install_inputs":[{"default":"eleanor.finch@harbourandfinch.example.com","label":"Admin email","name":"admin_email","required":false},{"default":"en_GB","label":"Language","name":"locale","options":["en_GB","en_US"],"required":false}],"key":"wordpress","label":"WordPress","mariadb_versions":[{"default":true,"label":"MariaDB 11.8","version":"11.8"}],"php_versions":[{"default":true,"eol_date":"2027-12-31","label":"PHP 8.3","status":"supported","version":"8.3"}],"reason":null,"tiers":[{"available":true,"disk_bytes":10737418240,"estimate":{"cpu_millicores":150,"disk_bytes":10737418240,"memory_bytes":805306368},"fits":true,"fits_reason":null,"key":"S","label":"Small","limits":{"cpu_millicores":2000,"memory_bytes":4294967296},"plain":"0.1 vCPU guaranteed, up to 2 vCPU · 512 MB guaranteed, up to 4 GB · 10 GB disk","reason":null,"requests":{"cpu_millicores":100,"memory_bytes":536870912}}]}],"preview_suffix":".example.net"},"schema":{"$ref":"#/components/schemas/ProvisioningOptions"}}},"description":"The options."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get what a new site can be","tags":["Sites"],"x-feature":"sites","x-file":"sites","x-gates":["provisioning"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/sites":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"post":{"description":"Creates a site in one of your CoreClusters, sized by `tier`, with no further environments; add those afterwards.\nThe answer is `201` when the create has started, or `202` while it waits for room; follow `operation.id` until it completes.","operationId":"createClusterSite","requestBody":{"content":{"application/json":{"examples":{"empty_wordpress":{"summary":"An empty WordPress site","value":{"content":"empty","domain":"journal.harbourandfinch.example.com","php_version":"8.3","platform":"wordpress","tier":"S"}},"fresh_wordpress":{"summary":"A fresh WordPress install","value":{"content":"fresh","domain":"harbourandfinch.example.net","php_version":"8.3","platform":"wordpress","tier":"S"}}},"schema":{"$ref":"#/components/schemas/SiteCreateClusterRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"empty":{"summary":"An empty site","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-19T09:00:02+00:00","completed_at":null,"created_at":"2026-11-19T09:00:00+00:00","environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5122,"notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"journal.harbourandfinch.example.com","id":1051},"status":"committed","status_label":"Waiting for the platform","steps":[{"key":"reserved","label":"Port and address reserved","state":"done"},{"key":"committed","label":"Saved to the platform","state":"done"},{"key":"picked_up","label":"Picked up by the platform","state":"current"},{"key":"starting","label":"Site started","state":"todo"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New site journal.harbourandfinch.example.com","to_version":null,"type":"provision","type_label":"New site"},"site":{"access_summary":{"apply_state":"applied","company_keys":0,"keys":0,"users":1},"actions":{"attach_domain":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"restore_deleted":{"available":false,"reason":"This site is not deleted"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"journal.harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":false,"primary":"journal.harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"applying","hosting":{"cluster_kind":"customer","label":"CoreCluster Northwind UK 1"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1051,"kind":"corestack","lifecycle":"provisioning","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.8"},"mode":"staging","mode_label":"No domain","operation":null,"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"site_id":"rs-northwind-journal-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20031 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20031,"sftp_command":"sftp -P 20031 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20031 web@ssh-northwind.example.net","user":"web","users":1},"tier":"S","uat_size":null,"usage":{"cpu_millicores":180,"disk_used_bytes":2147483648,"memory_bytes":912261120,"observed_at":"2026-11-24T09:10:00Z","source":"live"}}}},"fresh":{"summary":"A fresh install, with the endpoint that reveals its admin login","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-19T09:00:02+00:00","completed_at":null,"created_at":"2026-11-19T09:00:00+00:00","environment":{"env_id":"rs-northwind-harbourandfinch-example-net","hostname":"harbourandfinch-example-net.northwind.cfstack.example.net","id":1055,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5123,"notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"harbourandfinch.example.net","id":1055},"status":"committed","status_label":"Waiting for the platform","steps":[{"key":"reserved","label":"Port and address reserved","state":"done"},{"key":"committed","label":"Saved to the platform","state":"done"},{"key":"picked_up","label":"Picked up by the platform","state":"current"},{"key":"starting","label":"Site started","state":"todo"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New site harbourandfinch.example.net","to_version":null,"type":"provision","type_label":"New site"},"reveal_url":"https://manage.corefinity.com/api/corestack/sites/1055/provisioning/reveal","site":{"access_summary":{"apply_state":"applied","company_keys":0,"keys":0,"users":1},"actions":{"attach_domain":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"restore_deleted":{"available":false,"reason":"This site is not deleted"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"harbourandfinch.example.net","domains_summary":{"aliases":0,"dns":"unknown","noindex":false,"primary":"journal.harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-harbourandfinch-example-net","hostname":"harbourandfinch-example-net.northwind.cfstack.example.net","id":1055,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-harbourandfinch-example-net","hostname":"harbourandfinch-example-net.northwind.cfstack.example.net","id":1055,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"applying","hosting":{"cluster_kind":"customer","label":"CoreCluster Northwind UK 1"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1055,"kind":"corestack","lifecycle":"provisioning","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.8"},"mode":"staging","mode_label":"No domain","operation":null,"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://harbourandfinch-example-net.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://harbourandfinch-example-net.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"harbourandfinch.example.net","id":1055},"site_id":"rs-northwind-harbourandfinch-example-net","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20031 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20031,"sftp_command":"sftp -P 20031 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20031 web@ssh-northwind.example.net","user":"web","users":1},"tier":"S","uat_size":null,"usage":{"cpu_millicores":180,"disk_used_bytes":2147483648,"memory_bytes":912261120,"observed_at":"2026-11-24T09:10:00Z","source":"live"}}}}},"schema":{"$ref":"#/components/schemas/SiteCreatedInCluster"}}},"description":"The create has started."},"202":{"content":{"application/json":{"example":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-19T09:00:02+00:00","completed_at":null,"created_at":"2026-11-19T09:00:00+00:00","environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5122,"notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"journal.harbourandfinch.example.com","id":1051},"status":"pending","status_label":"Saving change","steps":[{"key":"reserved","label":"Port and address reserved","state":"done"},{"key":"committed","label":"Saved to the platform","state":"done"},{"key":"picked_up","label":"Picked up by the platform","state":"current"},{"key":"starting","label":"Site started","state":"todo"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New site journal.harbourandfinch.example.com","to_version":null,"type":"provision","type_label":"New site"},"site":{"access_summary":{"apply_state":"applied","company_keys":0,"keys":0,"users":1},"actions":{"attach_domain":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"restore_deleted":{"available":false,"reason":"This site is not deleted"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"journal.harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":false,"primary":"journal.harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"applying","hosting":{"cluster_kind":"customer","label":"CoreCluster Northwind UK 1"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1051,"kind":"corestack","lifecycle":"provisioning","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.8"},"mode":"staging","mode_label":"No domain","operation":null,"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"site_id":"rs-northwind-journal-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20031 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20031,"sftp_command":"sftp -P 20031 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20031 web@ssh-northwind.example.net","user":"web","users":1},"tier":"S","uat_size":null,"usage":{"cpu_millicores":180,"disk_used_bytes":2147483648,"memory_bytes":912261120,"observed_at":"2026-11-24T09:10:00Z","source":"live"}}},"schema":{"$ref":"#/components/schemas/SiteCreatedInCluster"}}},"description":"The create is accepted and has not started yet."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"You may not create sites for this company","value":{"code":"forbidden","message":"You cannot create sites for this company.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), two-factor authentication is required and not set up\n(`two_factor_required`), your account has no company that can use Managed Clusters\n(`company_not_enabled`), you may not create sites for this company (`forbidden`), or you may not use its\nbilling (`billing_forbidden`).\n"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"cleaning_up":{"summary":"A site of this domain is still being removed","value":{"code":"cleaning_up","message":"This site is being cleaned up. Try again in a minute.","reason":"cleaning_up"}},"duplicate":{"summary":"The domain is already a site of the CoreCluster","value":{"code":"duplicate","message":"A site with this domain already exists in this cluster","reason":"duplicate"}},"hosted_elsewhere":{"summary":"The domain is already a site somewhere else on the platform","value":{"code":"duplicate","message":"This domain is already hosted on the platform","reason":"duplicate"}},"placement":{"summary":"The CoreCluster cannot take a site of this platform yet","value":{"code":"placement","message":"Sites of that platform cannot be created on this cluster yet. Contact support.","reason":"placement"}},"platform_cluster":{"summary":"The id is a Corefinity platform","value":{"code":"platform_cluster","message":"Sites on a platform cluster are created with a CoreStack package (Create site, CoreStack), not on the cluster itself. Nothing was created.","reason":"platform_cluster"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The create conflicts with the state of the CoreCluster or the site, and nothing was created. `reason` says\nhow: `duplicate` (the domain is already a site in the CoreCluster, or is hosted somewhere else on the\nplatform), `cleaning_up` (a site of this domain is still being removed; try again in a minute), `placement`\n(the CoreCluster cannot take a site of this platform yet) or `platform_cluster` (the id is a Corefinity\nplatform, where sites are created with a package). Other reasons mean the CoreCluster cannot take the\nsite at the moment, and `message` says what to do: `capacity_blocked`, `compute_blocked`,\n`storage_blocked`, `cluster_not_ready`, `package_restricted`, `not_v3`, `not_configured` and `stale`.\n"},"422":{"content":{"application/json":{"examples":{"admin_username":{"summary":"A fresh install's admin username that is `admin`, or not in the form","value":{"code":"invalid","errors":{"fresh.admin_username":["Admin username: 3–32 characters, a letter first, then letters, digits or `_`"]},"field":"fresh.admin_username","message":"Admin username: 3–32 characters, a letter first, then letters, digits or `_`","reason":"invalid"}},"content":{"summary":"`content` is missing","value":{"code":"invalid","errors":{"content":["Choose a fresh install or an empty site"]},"field":"content","message":"Choose a fresh install or an empty site","reason":"invalid"}},"node_major":{"summary":"`node_major` sent as text, or not a major from 1 to 99. `errors` carries a word for this field, and `message` the sentence","value":{"code":"invalid","errors":{"node_major":["invalid"]},"field":"node_major","message":"Choose a Node.js version from the list.","reason":"invalid"}},"not_part_of_request":{"summary":"A field the API does not take","value":{"code":"invalid","errors":{"trial":["This request contains a field that is not part of it."]},"field":"trial","message":"This request contains a field that is not part of it.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`), or a rule of the create refuses it with a reason of its own, naming the\nfield. `billing_account_id` and `trial` are never part of an API create.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/SiteCreatePlatformUnreadable"},"503":{"$ref":"#/components/responses/SiteCreateVersionsUnavailable"}},"summary":"Create a site in a CoreCluster","tags":["Create a site"],"x-effect":["billable"],"x-feature":"site-create","x-file":"app-versions","x-gates":["app_versions_api","provisioning"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-provision","limit":100,"minutes":60},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"To be shown the generated HTTP authentication password in `credentials`, when the request asks for `http_auth`. Without it the create still succeeds and the password is null"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/clusters/{cluster}/snapshot-settings":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"Answers the default frequency the CoreCluster's sites follow, its snapshot quota and retention, and how much\nof the quota is used.\n","operationId":"getClusterSnapshotSettings","responses":{"200":{"content":{"application/json":{"examples":{"settings":{"$ref":"#/components/examples/SnapshotClusterSettingsExample"}},"schema":{"$ref":"#/components/schemas/SnapshotClusterSettings"}}},"description":"The CoreCluster's snapshot settings."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a CoreCluster's snapshot settings","tags":["Snapshots"],"x-feature":"snapshots","x-file":"snapshots","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Sets the frequency the CoreCluster's sites follow unless they have their own. The quota and the retention are\nset by Corefinity and cannot be changed here.\n","operationId":"updateClusterSnapshotSettings","requestBody":{"content":{"application/json":{"examples":{"daily":{"summary":"Daily","value":{"frequency":"daily"}}},"schema":{"$ref":"#/components/schemas/SnapshotClusterSettingsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"settings":{"$ref":"#/components/examples/SnapshotClusterSettingsExample"}},"schema":{"$ref":"#/components/schemas/SnapshotClusterSettings"}}},"description":"The CoreCluster's snapshot settings as they are now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"A field only Corefinity can set","value":{"code":"forbidden","message":"Only Corefinity staff can change the snapshot quota and retention.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the scope (`scope_required`), two-factor authentication is required and not set up\n(`two_factor_required`), or the body\ncarries `quota_gb` or `retention_days`, which only Corefinity can set (`forbidden`).\n"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"conflict":{"summary":"The package sets the snapshot settings","value":{"code":"conflict","message":"This cluster's snapshot settings are set by its Medium package. Scheduled snapshots are switched on or off per environment (Snapshots tab).","reason":"conflict"}},"platform_cluster":{"summary":"The cluster has no settings of its own","value":{"code":"platform_cluster","message":"Standalone sites are managed through Managed Websites. This cluster has no settings of its own","reason":"platform_cluster"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The CoreCluster's package sets its snapshot settings (`conflict`), or the cluster has no settings of its\nown because its sites are standalone (`platform_cluster`).\n"},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not a frequency","value":{"code":"invalid","errors":{"frequency":["The selected frequency is invalid."]},"field":"frequency","message":"The selected frequency is invalid.","reason":"invalid"}},"nothing_to_change":{"summary":"Nothing to change","value":{"code":"invalid_arguments","errors":{"frequency":["Send a frequency, quota_gb or retention_days to change."]},"field":"frequency","message":"Send a frequency, quota_gb or retention_days to change.","reason":"invalid_arguments"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/FieldRefusal"}]}}},"description":"The `frequency` is not one of the allowed values (`invalid`), or the body has nothing to change\n(`invalid_arguments`, which means the same as `invalid`; `field` is `frequency`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a CoreCluster's snapshot settings","tags":["Snapshots"],"x-effect":["changes-settings"],"x-feature":"snapshots","x-file":"snapshots","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/upgrade-options":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"Answers what a CoreCluster can change to and what each choice costs a month: the CoreCluster packages, its\nadd-ons with their unit prices and ceilings, the server types, and whether you may pay for a change\n(`rights.can_pay`). `uat` and `pending` are null for a CoreCluster, and one with no billing contract is\noffered the same changes without prices (`not_billed`).\n","operationId":"getClusterUpgradeOptions","responses":{"200":{"content":{"application/json":{"examples":{"cluster":{"$ref":"#/components/examples/UpgradeOptionsClusterExample"}},"schema":{"$ref":"#/components/schemas/UpgradeOptions"}}},"description":"The upgrade options."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a CoreCluster's upgrade options","tags":["Packages and capacity"],"x-feature":"upgrades","x-file":"upgrades","x-gates":["packages","billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/clusters/{cluster}/usage":{"parameters":[{"$ref":"#/components/parameters/cluster"}],"get":{"description":"The CPU, memory and disk the CoreCluster's sites used over a time range, in even steps, with how many sites\nreported in each step and the CoreCluster's allowance.\n","operationId":"getClusterUsage","parameters":[{"description":"The time range to read.","example":"7d","in":"query","name":"range","required":false,"schema":{"default":"24h","enum":["6h","24h","7d","30d"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"week":{"$ref":"#/components/examples/ClusterUsageExample"}},"schema":{"$ref":"#/components/schemas/ClusterUsage"}}},"description":"The usage series."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"range":["Choose a range of 6h, 24h, 7d or 30d."]},"field":"range","message":"Choose a range of 6h, 24h, 7d or 30d.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The range is not one of `6h`, `24h`, `7d` or `30d`."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a CoreCluster's usage","tags":["CoreCluster"],"x-feature":"clusters","x-file":"clusters","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/commands/{command}":{"parameters":[{"description":"The id of a command, from a run. Digits only.","example":5120,"in":"path","name":"command","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers a command's status and result. Read it until `status` is `succeeded`, `failed`, `timed_out` or `lost`; a secret is never part of it.","operationId":"getCommand","responses":{"200":{"content":{"application/json":{"example":{"blocked_until_verified":false,"duration_ms":840,"error":null,"exit_code":0,"finished_at":"2026-11-19T09:30:01Z","id":5120,"input":null,"kind":"flush_cache","label":"Flush cache","operation_id":null,"output_excerpt":"Success: The cache was flushed.\n","queued_at":"2026-11-19T09:30:00Z","requested_by":{"id":2012,"name":"Daniel Reyes"},"result":{"flushed":true},"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"started_at":"2026-11-19T09:30:00Z","status":"succeeded","status_label":"Done"},"schema":{"$ref":"#/components/schemas/Command"}}},"description":"The command."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrManagedClusters"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a command","tags":["Platform tools"],"x-feature":"functions","x-file":"app-versions","x-gates":["app_versions_api"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/corestack/companies/{company}/auto-upgrades":{"parameters":[{"$ref":"#/components/parameters/company"}],"get":{"description":"Answers whether the company lets its CoreClusters grow automatically when a new site or environment would\nnot fit, the monthly limit on what that may add to the bill, and this month's upgrades, newest first (20 at\nmost). A company you may not manage answers the same 404 as one that does not exist.\n","operationId":"getAutoUpgrades","responses":{"200":{"content":{"application/json":{"examples":{"on":{"$ref":"#/components/examples/AutoUpgradesOnExample"}},"schema":{"$ref":"#/components/schemas/AutoUpgrades"}}},"description":"The setting."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the automatic upgrades setting","tags":["Packages and capacity"],"x-feature":"upgrades","x-file":"auto-upgrades","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-auto-upgrades-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Turns automatic upgrades on or off, or changes the monthly limit, and answers the setting as it now stands.\nTurning them on or raising the limit is consent to be charged: only the company's own owners and billing\ncontacts may do it, signed in as themselves, with `confirm_spend: true`. Turning them off or lowering the\nlimit needs no confirmation.\n","operationId":"updateAutoUpgrades","requestBody":{"content":{"application/json":{"examples":{"lower_limit":{"summary":"Lower the monthly limit","value":{"enabled":true,"monthly_limit":100}},"turn_off":{"summary":"Turn automatic upgrades off","value":{"enabled":false}},"turn_on":{"summary":"Turn automatic upgrades on with a limit of 250.00 a month","value":{"confirm_spend":true,"enabled":true,"monthly_limit":"250.00"}}},"schema":{"$ref":"#/components/schemas/AutoUpgradesRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"on":{"$ref":"#/components/examples/AutoUpgradesOnExample"}},"schema":{"$ref":"#/components/schemas/AutoUpgrades"}}},"description":"The setting after the change."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"billing_forbidden":{"summary":"Turning them off or lowering the limit without being an owner or billing contact","value":{"code":"billing_forbidden","message":"Billing is available to your company's owner and billing contacts.","reason":"billing_forbidden"}},"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"owners_only":{"summary":"Turning them on or raising the limit without being an owner or billing contact","value":{"code":"billing_forbidden","message":"Only the company's owners and billing contacts can turn on automatic upgrades or raise the limit.","reason":"billing_forbidden"}},"scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and\nyou have not set it up (`two_factor_required`), or you may not make this change (`billing_forbidden`):\nturning automatic upgrades on or raising the limit is for the company's owners and billing contacts, and\nturning them off or lowering the limit is for them too.\n"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"An automatic upgrade is being made","value":{"code":"busy","message":"Another automatic upgrade is being made. Try again in a moment.","reason":"busy"}},"no_billing_account":{"summary":"The company has no billing account","value":{"code":"auto_upgrades_unavailable","message":"Automatic upgrades need a billing account. Add your billing details first.","reason":"auto_upgrades_unavailable"}},"not_available_yet":{"summary":"Automatic upgrades are not available yet","value":{"code":"auto_upgrades_unavailable","message":"Automatic upgrades are not available yet.","reason":"auto_upgrades_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was changed. `auto_upgrades_unavailable`: automatic upgrades cannot be turned on now, and the\nmessage says why (the setting's `unavailable_reason` carries the same sentence). `busy`: an automatic\nupgrade is being made for the company at this moment; try again shortly.\n"},"422":{"content":{"application/json":{"examples":{"confirm_spend":{"summary":"Turning them on without confirm_spend","value":{"code":"invalid","errors":{"confirm_spend":["Confirm that you agree to automatic upgrades: each one is added to the monthly bill and stays there until it is changed back, and the limit caps what new upgrades can add in one calendar month."]},"field":"confirm_spend","message":"Confirm that you agree to automatic upgrades: each one is added to the monthly bill and stays there until it is changed back, and the limit caps what new upgrades can add in one calendar month.","reason":"invalid"}},"enabled":{"summary":"enabled is missing","value":{"code":"invalid","errors":{"enabled":["Say whether automatic upgrades are on: true or false."]},"field":"enabled","message":"Say whether automatic upgrades are on: true or false.","reason":"invalid"}},"monthly_limit":{"summary":"A limit below 1, above the maximum or with more than two decimal places","value":{"code":"invalid","errors":{"monthly_limit":["Set a monthly limit from £1.00 to £100,000.00, in whole pence at most."]},"field":"monthly_limit","message":"Set a monthly limit from £1.00 to £100,000.00, in whole pence at most.","reason":"invalid"}},"unknown_field":{"summary":"A field the setting does not have","value":{"code":"invalid","errors":{"currency":["unknown_key"]},"field":"currency","message":"currency is not a setting of automatic upgrades.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`); `field` names it. `enabled` must be `true` or `false`. A\n`monthly_limit` must be from 1 up to the setting's `max_monthly_limit`, with two decimal places at most.\nTurning them on or raising the limit needs `confirm_spend: true`. A field the setting does not have is\nrefused too; for it, `errors` carries the word `unknown_key` and `message` the sentence.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update the automatic upgrades setting","tags":["Packages and capacity"],"x-effect":["changes-settings","billable"],"x-feature":"upgrades","x-file":"auto-upgrades","x-gates":["billing"],"x-rate-limit":{"bucket":"corecluster-auto-upgrades","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-secrets":{"parameters":[{"$ref":"#/components/parameters/company"}],"get":{"description":"Answers the credentials for private npm and Composer registries that the company's environments use in their\nbuilds, unless an environment has a credential of its own for the same registry. A token or a username is\nnever part of any answer.\n","operationId":"listCompanyDeploySecrets","responses":{"200":{"content":{"application/json":{"examples":{"secrets":{"$ref":"#/components/examples/CompanyDeploySecretListExample"}},"schema":{"$ref":"#/components/schemas/CompanyDeploySecretList"}}},"description":"The company's registry secrets."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/DeployTemplateArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a company's registry secrets","tags":["Deployment templates"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"Saves the credential for one private registry and answers the whole list. A registry must resolve to public\naddresses, and a company holds one credential for each registry and scope.\n","operationId":"createCompanyDeploySecret","requestBody":{"content":{"application/json":{"examples":{"composer":{"summary":"A Composer registry","value":{"auth_type":"http-basic","kind":"composer","label":"Private packages","registry":"packages.example.com","token":"your-registry-token","username":"your-username"}},"npm":{"summary":"An npm registry for one scope, shared and checked after the save","value":{"kind":"npm","label":"Private npm","registry":"https://npm.example.com","scope":"@example","shared_with_managed":true,"token":"your-npm-token","verify":true}}},"schema":{"$ref":"#/components/schemas/CompanyDeploySecretCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"verified":{"$ref":"#/components/examples/CompanyDeploySecretVerifiedExample"}},"schema":{"$ref":"#/components/schemas/CompanyDeploySecretList"}}},"description":"The company's registry secrets, with the new one."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DeployTemplateWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/CompanyDeploySecretExists"},"422":{"$ref":"#/components/responses/CompanyDeploySecretRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a company registry secret","tags":["Deployment templates"],"x-effect":["changes-settings"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-secrets/{secret}":{"parameters":[{"$ref":"#/components/parameters/company"},{"$ref":"#/components/parameters/CompanyDeploySecretId"}],"put":{"description":"Changes the fields you send, keeps the rest and answers the whole list. `verify` true on its own checks the\nsaved credential with its registry without changing it.\n","operationId":"updateCompanyDeploySecret","requestBody":{"content":{"application/json":{"examples":{"label":{"summary":"Rename a credential","value":{"label":"Example packages"}},"verify":{"summary":"Check the saved credential with its registry","value":{"verify":true}}},"schema":{"$ref":"#/components/schemas/CompanyDeploySecretUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"renamed":{"$ref":"#/components/examples/CompanyDeploySecretListExample"},"verified":{"$ref":"#/components/examples/CompanyDeploySecretVerifiedExample"}},"schema":{"$ref":"#/components/schemas/CompanyDeploySecretList"}}},"description":"The company's registry secrets after the change, with `verification` when the registry was asked."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DeployTemplateWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/CompanyDeploySecretExists"},"422":{"$ref":"#/components/responses/CompanyDeploySecretRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a company registry secret","tags":["Deployment templates"],"x-effect":["changes-settings"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes the credential and answers the list that is left. Builds no longer sign in to that registry with it.","operationId":"deleteCompanyDeploySecret","responses":{"200":{"content":{"application/json":{"examples":{"none":{"summary":"No credential is left","value":{"can_share":true,"data":[]}}},"schema":{"$ref":"#/components/schemas/CompanyDeploySecretList"}}},"description":"The company's registry secrets after the removal."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DeployTemplateWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/DeployTemplateArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a company's registry secret","tags":["Deployment templates"],"x-effect":["deletes"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-templates":{"parameters":[{"$ref":"#/components/parameters/company"}],"get":{"description":"Answers one row for each platform the company can have a template for: whether the company has saved one or\nfollows the default, its revision, and how many environments it reaches.\n","operationId":"listDeployTemplates","responses":{"200":{"content":{"application/json":{"examples":{"templates":{"summary":"One saved template and one default","value":{"data":[{"locked":null,"platform":"magento2","reach":{"environments":1,"follows_every_stage":1,"overrides_some":0,"production":1},"revision":2,"saved_at":"2026-11-09T10:42:07Z","saved_by":"Maya Okafor","state":"customised","template_id":12},{"locked":null,"platform":"laravel","reach":{"environments":0,"follows_every_stage":0,"overrides_some":0,"production":0},"revision":0,"saved_at":null,"saved_by":null,"state":"default","template_id":null}]}}},"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeployTemplateSummary"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"The company's templates, one for each platform."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/DeployTemplateArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a company's deployment templates","tags":["Deployment templates"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-templates/{platform}":{"parameters":[{"$ref":"#/components/parameters/company"},{"$ref":"#/components/parameters/DeployTemplatePlatform"}],"get":{"description":"Answers the template for one platform: what the company has set for each stage of the production and UAT\nconfigurations, what each stage inherits and what is in effect, the build presets on offer, and whether you\nmay edit it.\n","operationId":"getDeployTemplate","parameters":[{"description":"A kept revision to read instead of the current one.","in":"query","name":"version","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"`current`, `previous` or a revision number. Adds `compare` to the answer, with the before and after of each changed stage.","example":"previous","in":"query","name":"compare_to","required":false,"schema":{"anyOf":[{"enum":["current","previous"],"type":"string"},{"minimum":1,"type":"integer"}]}},{"description":"One upstream to answer, as `upstreams[].upstream` names it (`none`, or `agency:` and the agency's id).","in":"query","name":"upstream","required":false,"schema":{"pattern":"^(none|agency:[1-9][0-9]{0,18})$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"template":{"$ref":"#/components/examples/DeployTemplateExample"}},"schema":{"$ref":"#/components/schemas/DeployTemplate"}}},"description":"The template."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The company does not exist or is not one you manage, the platform has no template, or `version` or `compare_to` names a revision the template does not keep (`previous` when there is none before it): all answer `Not found.` with no reason. Or deployment templates are not on for your company (`feature_off`)."},"422":{"$ref":"#/components/responses/DeployTemplateArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a company's deployment template","tags":["Deployment templates"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-templates/{platform}/restore":{"parameters":[{"$ref":"#/components/parameters/company"},{"$ref":"#/components/parameters/DeployTemplatePlatform"}],"post":{"description":"Puts the template back to a kept revision (`version_id`), or every stage back to Corefinity's default\n(`version` `corefinity`), as a new revision, and writes the change through to the environments that follow it.\nSend exactly one of `version_id` and `version`. It is confirmed exactly as a stage save is.\n","operationId":"restoreDeployTemplate","requestBody":{"content":{"application/json":{"examples":{"confirmed":{"summary":"Restore revision 1, which reaches one production environment","value":{"confirm_count":1,"confirm_production":true,"confirm_targets":[1042],"revision":2,"version_id":1}},"dry_run":{"summary":"See which environments a restore would reach","value":{"dry_run":true,"revision":2,"version_id":1}}},"schema":{"$ref":"#/components/schemas/DeployTemplateRestoreRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"restored":{"$ref":"#/components/examples/DeployTemplateSavedExample"}},"schema":{"$ref":"#/components/schemas/DeployTemplateSaved"}}},"description":"The template, with the reach of the restore and, when it was made, what was written."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DeployTemplateWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/DeployTemplateConflict"},"422":{"$ref":"#/components/responses/DeployTemplateSaveRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Restore a version of a deployment template","tags":["Deployment templates"],"x-effect":["overwrites"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-templates/{platform}/usage":{"parameters":[{"$ref":"#/components/parameters/company"},{"$ref":"#/components/parameters/DeployTemplatePlatform"}],"get":{"description":"Answers the environments of this platform the template reaches, 50 a page, each with what every stage does\n(follows the template or holds its own content), and a summary of the counts. Paged by cursor: send\n`next_cursor` back as `cursor`; null means the last page.\n","operationId":"listDeployTemplateUsage","parameters":[{"$ref":"#/components/parameters/DeployTemplateCursor"},{"description":"Only production environments, or only the others.","in":"query","name":"role","required":false,"schema":{"enum":["production","uat"],"type":"string"}},{"in":"query","name":"stage","required":false,"schema":{"enum":["build","database","post_deploy","settings"],"type":"string"}},{"description":"Only the environments in this state.","in":"query","name":"state","required":false,"schema":{"enum":["follows_every_stage","overrides_some","overrides_every_stage","replaced_below","changed_since_deploy","kept","relink_pending"],"type":"string"}},{"description":"A domain or environment name to search for.","in":"query","name":"q","required":false,"schema":{"maxLength":100,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"usage":{"summary":"One environment that follows every stage","value":{"data":[{"binding_id":2210,"changed_since_deploy":[],"environment":{"name":"Production","slug":"production"},"last_deployment":null,"role":"production","site":{"domain":"harbourandfinch.example.com","id":1042,"kind":"corecluster","owner":null},"site_id":1042,"stages":{"build":{"level":"corefinity","revision":2,"state":"follows"},"database":{"level":"corefinity","revision":2,"state":"follows"},"post_deploy":{"level":"owner","revision":2,"state":"follows"},"settings":{"level":"corefinity","revision":2,"state":"follows"}},"states":["follows_every_stage"]}],"next_cursor":null,"summary":{"changed_since_deploy":0,"environments":1,"follows_every_stage":1,"kept":0,"overrides_every_stage":0,"overrides_some":0,"production":1,"relink_pending":0,"replaced_below":0}}}},"schema":{"$ref":"#/components/schemas/DeployTemplateUsagePage"}}},"description":"A page of environments, with the summary."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/DeployTemplateArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List the environments a template reaches","tags":["Deployment templates"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-templates/{platform}/usage/reset":{"parameters":[{"$ref":"#/components/parameters/company"},{"$ref":"#/components/parameters/DeployTemplatePlatform"}],"post":{"description":"Makes the named stages of each target environment follow the template again, replacing what the environment\nholds for them. Send `dry_run` true first to see what would change; a reset that includes production\nenvironments is then confirmed with `confirm_production` true and `confirm_count`, the dry run's\n`production_count`.\n","operationId":"resetDeployTemplateEnvironments","requestBody":{"content":{"application/json":{"examples":{"confirmed":{"summary":"Reset every stage of one production environment","value":{"confirm_count":1,"confirm_production":true,"targets":[{"site_id":1042,"stages":["all"]}]}},"dry_run":{"summary":"See what a reset would change","value":{"dry_run":true,"targets":[{"site_id":1042,"stages":["post_deploy"]}]}}},"schema":{"$ref":"#/components/schemas/DeployTemplateResetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"dry_run":{"summary":"A dry run","value":{"dry_run":true,"production_count":1,"refused":[],"targets":[{"production":true,"site_id":1042,"stages":["post_deploy"]}],"written":null}},"reset":{"summary":"One environment reset","value":{"dry_run":false,"production_count":1,"refused":[],"targets":[{"production":true,"site_id":1042,"stages":["build","database","post_deploy","settings"]}],"written":{"environments":1,"kept":0,"revisions":1,"tunnel_access_started":[]}}}},"schema":{"$ref":"#/components/schemas/DeployTemplateResetAnswer"}}},"description":"The targets and, when the reset was made, what was written."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DeployTemplateWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The company does not exist or is not one you manage, the platform has no template, or a target is not a site you can see: all answer `Not found.` with no reason. Or deployment templates are not on for your company (`feature_off`)."},"409":{"content":{"application/json":{"examples":{"reach_changed":{"summary":"The count confirmed is not the number of production environments","value":{"code":"reach_changed","message":"The production environments of this reset have changed. Review the selection again.","production_count":1,"reason":"reach_changed"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The production environments of the reset are not the number you confirmed (`reach_changed`, with\n`production_count`), or an environment could no longer be reset while it was being made (`reach_changed`,\nwith `refused`). Run the dry run again.\n"},"422":{"content":{"application/json":{"examples":{"confirm":{"summary":"Production environments, not confirmed","value":{"code":"confirm","errors":{"confirm_count":["Type the number of production environments to confirm the reset."]},"message":"Type the number of production environments to confirm the reset.","production_count":1,"reason":"confirm"}},"no_targets":{"summary":"No targets","value":{"code":"invalid","errors":{"targets":["The targets argument is required."]},"field":"targets","message":"Some arguments are not valid.","reason":"invalid"}},"refused_on":{"summary":"A target whose pipeline Corefinity has locked","value":{"code":"template_refused_on","errors":{"targets":["Some environments cannot be reset. Deselect them, then reset the rest."]},"message":"Some environments cannot be reset. Deselect them, then reset the rest.","reason":"template_refused_on","targets":[{"production":true,"reason":"pipeline_locked","site_id":1042}]}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"A field is wrong (`invalid`, with the `field`), the reset includes production environments and is not\nconfirmed (`confirm`, with `production_count`), or some targets cannot be reset (`template_refused_on`,\nwith `targets` giving each one's `reason`: `not_reached`, `pipeline_classic`, `pipeline_review_pending` or\n`pipeline_locked`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Reset environments to their template","tags":["Deployment templates"],"x-effect":["overwrites"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"A target environment gains a command it does not run now (never for a dry run)"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-templates/{platform}/versions":{"parameters":[{"$ref":"#/components/parameters/company"},{"$ref":"#/components/parameters/DeployTemplatePlatform"}],"get":{"description":"Answers the template's kept revisions, newest first, 50 a page: who saved each, which stages it changed and\nhow many environments it was written to. Paged by cursor: send `next_cursor` back as `cursor`; null means the\nlast page.\n","operationId":"listDeployTemplateVersions","parameters":[{"$ref":"#/components/parameters/DeployTemplateCursor"},{"description":"With `stage`, only the versions that changed that stage of this configuration.","in":"query","name":"config","required":false,"schema":{"enum":["production","uat"],"type":"string"}},{"description":"With `config`.","in":"query","name":"stage","required":false,"schema":{"enum":["build","database","post_deploy","settings"],"type":"string"}},{"description":"`corefinity` answers the versions of Corefinity's default instead. Not with `config` and `stage`.","in":"query","name":"level","required":false,"schema":{"enum":["corefinity"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"versions":{"summary":"Two versions","value":{"next_cursor":null,"template_id":12,"versions":[{"at":"2026-11-09T10:42:07Z","by":"Maya Okafor","changed":[{"config":"production","stage":"post_deploy"}],"reach":{"kept":0,"production":1,"uat":0,"written":1},"restored_from":null,"revision":2,"sets":[{"config":"production","stage":"post_deploy"}],"source":"person","version_ref":{"revision":2,"template_id":12}},{"at":"2026-11-02T09:15:30Z","by":"Maya Okafor","changed":[{"config":"production","stage":"post_deploy"}],"reach":{"kept":0,"production":1,"uat":0,"written":1},"restored_from":null,"revision":1,"sets":[{"config":"production","stage":"post_deploy"}],"source":"person","version_ref":{"revision":1,"template_id":12}}]}}},"schema":{"$ref":"#/components/schemas/DeployTemplateVersionPage"}}},"description":"A page of versions."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"filters":{"summary":"A configuration without its stage","value":{"code":"invalid","errors":{"level":["Filter by level, or by one configuration and stage."]},"field":"level","message":"Filter by level, or by one configuration and stage.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A parameter is wrong (`invalid`, with the `field`), or `config` came without `stage`, or `level` came with them (`invalid` on `level`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a deployment template's versions","tags":["Deployment templates"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-templates/{platform}/{config}/stages/{stage}":{"parameters":[{"$ref":"#/components/parameters/company"},{"$ref":"#/components/parameters/DeployTemplatePlatform"},{"description":"The configuration the stage belongs to.","example":"production","in":"path","name":"config","required":true,"schema":{"enum":["production","uat"],"type":"string"}},{"description":"The stage to save. `all` is only for copying one configuration onto the other with `copy_from_config`.","example":"post_deploy","in":"path","name":"stage","required":true,"schema":{"enum":["build","database","post_deploy","settings","all"],"type":"string"}}],"put":{"description":"Sets one stage of the template, or hands it back to what it inherits, and writes the change through to every\nenvironment that follows that stage. Send `dry_run` true first: the answer's `reach` lists the environments\nthe change would be written to and writes nothing. A change that reaches production environments is then saved\nwith `confirm_production`, `confirm_count` and `confirm_targets`, and is refused `reach_changed` if the reach\nchanged since.\n","operationId":"replaceDeployTemplateStage","requestBody":{"content":{"application/json":{"examples":{"confirmed":{"summary":"Save a change that reaches one production environment","value":{"confirm_count":1,"confirm_production":true,"confirm_targets":[1042],"mode":"replace","revision":2,"value":{"lines":["php bin/magento cache:flush","php bin/magento cron:install"]}}},"dry_run":{"summary":"See which environments a change would reach","value":{"dry_run":true,"mode":"replace","revision":2,"value":{"lines":["php bin/magento cache:flush","php bin/magento cron:install"]}}}},"schema":{"$ref":"#/components/schemas/DeployTemplateStageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"saved":{"$ref":"#/components/examples/DeployTemplateSavedExample"}},"schema":{"$ref":"#/components/schemas/DeployTemplateSaved"}}},"description":"The template, with the reach of the change and, when it was saved, what was written."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DeployTemplateWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/DeployTemplateConflict"},"422":{"$ref":"#/components/responses/DeployTemplateSaveRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Replace a stage of a deployment template","tags":["Deployment templates"],"x-effect":["changes-settings","overwrites"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"The save brings a command the saved stage does not hold (never for a dry run)"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-variables":{"parameters":[{"$ref":"#/components/parameters/company"}],"get":{"description":"Answers the company's deployment variables, each with its value masked. They reach every environment of the\ncompany whose pipeline has the three stages, unless the environment has a variable of its own with the same\nname.\n","operationId":"listCompanyDeployVariables","responses":{"200":{"content":{"application/json":{"examples":{"variables":{"$ref":"#/components/examples/CompanyDeployVariableListExample"}},"schema":{"$ref":"#/components/schemas/CompanyDeployVariableList"}}},"description":"The company's variables, in name order."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/DeployTemplateArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a company's deployment variables","tags":["Deployment templates"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-variables/{name}":{"parameters":[{"$ref":"#/components/parameters/company"},{"$ref":"#/components/parameters/CompanyDeployVariableName"}],"put":{"description":"Creates the variable when the company does not have it and changes it otherwise, then answers the whole list\nwith each value masked. A new variable needs a `value`; an agency can also share a variable with the sites it\nmanages for its clients (`shared_with_managed`).\n","operationId":"updateCompanyDeployVariable","requestBody":{"content":{"application/json":{"examples":{"create":{"summary":"Create a variable","value":{"value":"example-value-not-a-real-secret"}},"share":{"summary":"Share a variable with the sites you manage","value":{"shared_with_managed":true}}},"schema":{"$ref":"#/components/schemas/CompanyDeployVariableSetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"variables":{"$ref":"#/components/examples/CompanyDeployVariableListExample"}},"schema":{"$ref":"#/components/schemas/CompanyDeployVariableList"}}},"description":"The company's variables after the change."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DeployTemplateWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"name_format":{"$ref":"#/components/examples/CompanyDeployVariableNameFormatExample"},"no_value":{"summary":"A new variable without a value, or a value with a line break","value":{"code":"variable_invalid","errors":{"value":["Use at most 2,048 characters, with no line breaks, control or invisible formatting characters."]},"message":"Use at most 2,048 characters, with no line breaks, control or invisible formatting characters.","reason":"variable_invalid"}},"prefix":{"summary":"A name that starts with CF_","value":{"code":"variable_invalid","errors":{"name":["Use letters, digits and underscores, starting with a letter or underscore, without the CF_ prefix (CoreStack adds it)."]},"message":"Use letters, digits and underscores, starting with a letter or underscore, without the CF_ prefix (CoreStack adds it).","reason":"variable_invalid"}},"reserved":{"summary":"A name CoreStack sets itself","value":{"code":"variable_reserved","errors":{"name":["CF_RELEASE is set by CoreStack. Choose another name."]},"message":"CF_RELEASE is set by CoreStack. Choose another name.","reason":"variable_reserved"}},"too_long":{"summary":"A value longer than 2,048 characters","value":{"code":"invalid","errors":{"value":["The value argument must be at most 2048 characters."]},"field":"value","message":"Some arguments are not valid.","reason":"invalid"}},"too_many":{"summary":"The company holds as many variables as it can","value":{"code":"too_many_variables","errors":{"name":["This company already has the most deployment variables it can hold."]},"message":"This company already has the most deployment variables it can hold.","reason":"too_many_variables"}},"tool_credential":{"summary":"A name a build tool reads its credentials from","value":{"code":"variable_tool_credential","errors":{"name":["Builds see this variable as CF_NPM_TOKEN, so npm never reads it. Add the credentials under Deployments > Private registries instead."]},"message":"Builds see this variable as CF_NPM_TOKEN, so npm never reads it. Add the credentials under Deployments > Private registries instead.","reason":"variable_tool_credential"}},"wrong_type":{"summary":"A value that is not a string","value":{"code":"invalid","errors":{"value":["The value argument must be string."]},"field":"value","message":"Some arguments are not valid.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"The request was refused and nothing was stored. `errors` names the field.\n\n- `invalid`: a field of the wrong type or one this endpoint does not take, a `value` longer than 2,048\n  characters, or a name that is not letters, digits and underscores or is longer than 64 characters (on\n  `name`).\n- `variable_invalid`: a new variable without a value, a body with neither `value` nor\n  `shared_with_managed`, a name that starts with `CF_`, in either case, or a value with a line break,\n  control or invisible formatting character.\n- `variable_reserved`: a name CoreStack sets itself.\n- `variable_tool_credential`: a new variable with a name a build tool reads its own credentials from,\n  such as `NPM_TOKEN`.\n- `too_many_variables`: the company holds as many variables as it can.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a company deployment variable","tags":["Deployment templates"],"x-effect":["changes-settings"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes the variable from the company and answers the list that is left. Environments no longer receive it at their next deployment.","operationId":"deleteCompanyDeployVariable","responses":{"200":{"content":{"application/json":{"examples":{"variables":{"$ref":"#/components/examples/CompanyDeployVariableListExample"}},"schema":{"$ref":"#/components/schemas/CompanyDeployVariableList"}}},"description":"The company's variables after the removal."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DeployTemplateWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/DeployTemplateArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a company deployment variable","tags":["Deployment templates"],"x-effect":["deletes"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/companies/{company}/deploy-variables/{name}/reveal":{"parameters":[{"$ref":"#/components/parameters/company"},{"$ref":"#/components/parameters/CompanyDeployVariableName"}],"post":{"description":"Answers the variable's stored value, the only endpoint that does. It needs a token with the `exec` scope and a\nperson who may change the company's templates.\n","operationId":"revealCompanyDeployVariable","responses":{"200":{"content":{"application/json":{"examples":{"revealed":{"summary":"A revealed value","value":{"name":"SLACK_URL","value":"example-value-not-a-real-secret"}}},"schema":{"properties":{"name":{"type":"string"},"value":{"description":"The stored value.","type":"string"}},"required":["name","value"],"type":"object"}}},"description":"The variable's name and its value.","headers":{"Cache-Control":{"description":"Always `no-store, private`. Do not keep the answer.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DeployTemplateWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"unreadable":{"summary":"The value can no longer be read","value":{"code":"not_available","message":"This value cannot be read. Save it again.","reason":"not_available"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The stored value can no longer be read (`not_available`). Save the variable again."},"422":{"$ref":"#/components/responses/DeployTemplateArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Reveal a company deployment variable's value","tags":["Deployment templates"],"x-effect":["reveals-secret"],"x-feature":"deployment-templates","x-file":"deployment-templates","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"reseller-credentials","limit":10,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/company/cloudflare":{"get":{"description":"Answers your company's Cloudflare connection: its status, the token's id and last four characters, and the\nzones it sees. The token itself is never shown.\n","operationId":"getCompanyCloudflare","responses":{"200":{"content":{"application/json":{"examples":{"connected":{"$ref":"#/components/examples/CloudflareConnected"}},"schema":{"$ref":"#/components/schemas/CloudflareConnection"}}},"description":"The connection. `status` is `not_connected` when there is none."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the Cloudflare connection","tags":["Cloudflare"],"x-feature":"cloudflare","x-file":"domains","x-gates":["cloudflare"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"Checks a Cloudflare API token with Cloudflare and stores it encrypted for your company. Connecting again\nreplaces the token and keeps every site's zone.\n","operationId":"connectCompanyCloudflare","requestBody":{"content":{"application/json":{"examples":{"token":{"summary":"A made-up token of the right length","value":{"token":"example-cloudflare-api-token-0000000000000000"}}},"schema":{"$ref":"#/components/schemas/CloudflareConnectRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"connected":{"$ref":"#/components/examples/CloudflareConnected"}},"schema":{"$ref":"#/components/schemas/CloudflareConnection"}}},"description":"The connection as it is now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"token":["This token is not valid. Check it was copied in full"]},"field":"token","message":"This token is not valid. Check it was copied in full","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The token is missing, is not the right length, or Cloudflare does not accept it."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/CloudflareUnreachable"}},"summary":"Connect Cloudflare","tags":["Cloudflare"],"x-effect":["changes-settings"],"x-feature":"cloudflare","x-file":"domains","x-gates":["cloudflare"],"x-rate-limit":{"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes your company's Cloudflare connection and its stored token. The token still exists at Cloudflare until\nyou delete it there.\n","operationId":"disconnectCompanyCloudflare","responses":{"200":{"content":{"application/json":{"examples":{"disconnected":{"$ref":"#/components/examples/CloudflareDisconnected"}},"schema":{"properties":{"connection":{"$ref":"#/components/schemas/CloudflareConnection"}},"required":["connection"],"type":"object"}}},"description":"The connection, now `not_connected`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Disconnect Cloudflare","tags":["Cloudflare"],"x-effect":["deletes"],"x-feature":"cloudflare","x-file":"domains","x-gates":["cloudflare"],"x-rate-limit":{"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/company/cloudflare/refresh":{"post":{"description":"Checks the stored token with Cloudflare again and reads the zones it sees. The answer is the connection in\nwhatever state that leaves it.\n","operationId":"refreshCompanyCloudflareZones","responses":{"200":{"content":{"application/json":{"examples":{"connected":{"$ref":"#/components/examples/CloudflareConnected"}},"schema":{"$ref":"#/components/schemas/CloudflareConnection"}}},"description":"The connection as it is now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"example":{"code":"not_connected","message":"Connect Cloudflare for this company first","reason":"not_connected"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Your company has no Cloudflare connection."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/CloudflareUnreachable"}},"summary":"Read the Cloudflare zones again","tags":["Cloudflare"],"x-effect":["none"],"x-feature":"cloudflare","x-file":"domains","x-gates":["cloudflare"],"x-rate-limit":{"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/copy-queue/{queued}":{"parameters":[{"description":"The id of the waiting copy, `queued.id` in the answer that queued it. Digits only.","in":"path","name":"queued","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers where a queued copy stands: still waiting and for what, started (with the operation to follow), or\nended without starting. A copy whose target you may not change answers `404`, as an id that does not exist.\n","operationId":"getQueuedCopy","responses":{"200":{"content":{"application/json":{"examples":{"started":{"summary":"Started, with the operation to follow","value":{"queued":{"ahead":null,"deadline_at":"2026-11-03T13:00:00Z","ended_at":"2026-11-03T07:04:10Z","id":6120,"message":null,"operation_id":5120,"queued_at":"2026-11-03T07:00:00Z","reason":null,"source":{"id":1042,"name":"Production"},"state":"started","target":{"id":1043,"name":"Staging"}}}},"waiting":{"summary":"Waiting for a change on the target to finish","value":{"queued":{"ahead":0,"deadline_at":"2026-11-03T13:00:00Z","ended_at":null,"id":6120,"message":"Waiting for the change in progress on Staging to finish. It starts on its own.","operation_id":null,"queued_at":"2026-11-03T07:00:00Z","reason":"target_busy","source":{"id":1042,"name":"Production"},"state":"waiting","target":{"id":1043,"name":"Staging"}}}}},"schema":{"$ref":"#/components/schemas/CopyQueueResult"}}},"description":"The queued copy."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a copy that waits its turn","tags":["Copies"],"x-feature":"copies","x-file":"copy-queue","x-gates":["clone"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"delete":{"description":"Cancels a queued copy while its `state` is `waiting`, so nothing is copied. A copy that is being started\n(`starting`), has started, or ended without starting answers `409` here; one that has started runs to its end.\n","operationId":"cancelQueuedCopy","responses":{"200":{"content":{"application/json":{"example":{"queued":{"ahead":null,"deadline_at":"2026-11-03T13:00:00Z","ended_at":"2026-11-03T07:02:31Z","id":6120,"message":"Cancelled before it started.","operation_id":null,"queued_at":"2026-11-03T07:00:00Z","reason":"cancelled","source":{"id":1042,"name":"Production"},"state":"cancelled","target":{"id":1043,"name":"Staging"}}},"schema":{"$ref":"#/components/schemas/CopyQueueResult"}}},"description":"The copy was cancelled before it started."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"not_waiting":{"summary":"The copy was already cancelled","value":{"code":"not_waiting","message":"This copy is no longer waiting, so it cannot be cancelled.","queued":{"ahead":null,"deadline_at":"2026-11-03T13:00:00Z","ended_at":"2026-11-03T07:02:31Z","id":6120,"message":"Cancelled before it started.","operation_id":null,"queued_at":"2026-11-03T07:00:00Z","reason":"cancelled","source":{"id":1042,"name":"Production"},"state":"cancelled","target":{"id":1043,"name":"Staging"}},"reason":"not_waiting"}}},"schema":{"allOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/CopyQueueResult"}]}}},"description":"The copy is no longer waiting (`not_waiting`): it is being started, has started, or ended without\nstarting. `queued` carries the entry as it stands now.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Cancel a copy that waits its turn","tags":["Copies"],"x-effect":["changes-settings"],"x-feature":"copies","x-file":"copy-queue","x-gates":["clone"],"x-rate-limit":{"bucket":"reseller-clone-queue","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/create-options":{"get":{"description":"Answers what a new site of your company can be: where a CoreStack site can be placed, the packages and staging\nsizes on offer, and whether you can add a CoreCluster. Answered with `Cache-Control: no-store`.\n","operationId":"getSiteCreateOptions","responses":{"200":{"content":{"application/json":{"example":{"corecluster":{"available":{"available":true,"reason":null},"href":"https://manage.corefinity.com/managed-clusters/new"},"corestack":{"available":{"available":true,"reason":null},"new_cluster_href":"https://manage.corefinity.com/managed-clusters/new","packages":["cs4"],"placements":[{"available":{"available":false,"reason":"United Kingdom is not set up for CoreStack yet. Choose another region"},"family":[],"kind":"platform","label":"United Kingdom","region":"uk","state":"coming_soon"},{"available":{"available":true,"reason":null},"capacity":{"basis":"estimate","cpu":{"capacity_millicores":8000,"level":"ok","percent":3,"used_p95_millicores":300},"evaluated_at":"2026-11-10T00:59:45Z","level":"ok","memory":{"capacity_bytes":34359738368,"level":"ok","percent":4,"used_p95_bytes":1610612736},"package":null,"sites":{"count":1,"environments":1},"storage":{"capacity_bytes":0,"level":"ok","percent":0,"provisioned_bytes":21474836480}},"cluster":{"id":1017,"name":"Northwind UK 1"},"family":[{"available":true,"first_node_shape":null,"key":"general","label":"Standard","note":null,"provisioned":true,"reason":null}],"grows":false,"kind":"cluster","region":""}],"uat_sizes":["xsmall","small","medium","large"]},"enterprise":{"available":{"available":false,"reason":"Ask us about CoreStack Enterprise"},"href":null},"owner":{"host_slug":"example","id":1204,"name":"Harbour & Finch"}},"schema":{"$ref":"#/components/schemas/WebsiteCreateOptions"}}},"description":"The options."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/FeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the create options","tags":["Sites"],"x-feature":"sites","x-file":"environments","x-gates":["managed_websites_v2"],"x-rate-limit":{"bucket":"corecluster-websites","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/demos":{"get":{"description":"The demos of your company, and of the companies your agency manages, newest first; one that failed while it\nwas being set up is not listed. You need two-factor authentication set up, whatever your company requires.\nPaged by cursor: send `next_cursor` back as `cursor`; null means the last page.\n","operationId":"listDemos","parameters":[{"description":"Items a page: 1 to 50, default 20.","in":"query","name":"limit","required":false,"schema":{"default":20,"maximum":50,"minimum":1,"type":"integer"}},{"description":"The `next_cursor` of the previous answer. Digits only; anything else is refused `422` on `cursor`.","in":"query","name":"cursor","required":false,"schema":{"pattern":"^[1-9][0-9]{0,18}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"days_left":27,"ends_at":"2026-12-06T09:00:00Z","grace_ends_at":null,"id":3310,"keep":{"allowed":true,"refusal":null,"url":"https://manage.corefinity.com/billing/keep?demo=3310&plan=keep"},"kept_at":null,"package":"CS4","price_after":{"amount":"300.00","currency":"GBP"},"product_line":"CS","region":"uk","starts_at":"2026-11-06T09:00:00Z","state":"active","target":{"id":1051,"name":"journal.harbourandfinch.example.com","type":"site"},"upgrade":{"next":null}}],"next_cursor":null},"schema":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Demo"},"type":"array"}},"required":["data"],"type":"object"}]}}},"description":"One page of demos."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"limit":["The limit may not be greater than 50."]},"field":"limit","message":"The limit may not be greater than 50.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A `limit` outside 1 to 50, or a `cursor` the list did not give you (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your demos","tags":["Demos"],"x-feature":"demos","x-file":"demos","x-gates":[],"x-rate-limit":{"bucket":"corecluster-demos-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/demos/{demo}":{"parameters":[{"$ref":"#/components/parameters/DemoId"}],"get":{"description":"One demo, with the packages you could keep it on (`upgrade_options`, priced) and, once it is kept,\nwhere each change the Keep asked for stands (`progress`). A demo of a company you cannot see answers the\nsame `404` as an id that does not exist.\n","operationId":"getDemo","responses":{"200":{"content":{"application/json":{"example":{"days_left":27,"ends_at":"2026-12-06T09:00:00Z","grace_ends_at":null,"id":3310,"keep":{"allowed":true,"refusal":null,"url":"https://manage.corefinity.com/billing/keep?demo=3310&plan=keep"},"kept_at":null,"package":"CS4","price_after":{"amount":"300.00","currency":"GBP"},"product_line":"CS","progress":{"changes":[],"next":null,"state":"none"},"region":"uk","starts_at":"2026-11-06T09:00:00Z","state":"active","target":{"id":1051,"name":"journal.harbourandfinch.example.com","type":"site"},"upgrade":{"next":null},"upgrade_options":[{"monthly":{"amount":"300.00","currency":"GBP"},"package":"CS4"},{"monthly":{"amount":"450.00","currency":"GBP"},"package":"CS6"},{"monthly":{"amount":"600.00","currency":"GBP"},"package":"CS8"}]},"schema":{"$ref":"#/components/schemas/DemoDetail"}}},"description":"The demo."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a demo","tags":["Demos"],"x-feature":"demos","x-file":"demos","x-gates":[],"x-rate-limit":{"bucket":"corecluster-demos-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/demos/{demo}/keep":{"parameters":[{"$ref":"#/components/parameters/DemoId"}],"post":{"description":"Keeps the demo, so it carries on as a paid service billed from the next full hour; only an owner or a billing\nrole of the company may. `confirm_keep` is the site's domain, or the word `cluster` for a CoreCluster; a\nbigger package, add-on units or another server type are applied after the Keep, one at a time, and `progress`\nfollows them. The API never takes billing or card details: when one is missing, the Keep is refused with a\n`keep_url` that opens the Keep page in the Control Panel.\n","operationId":"keepDemo","requestBody":{"content":{"application/json":{"examples":{"keep":{"summary":"Keep it as it is","value":{"accept_privacy":true,"confirm_keep":"journal.harbourandfinch.example.com"}},"keep_on_a_bigger_package":{"summary":"Keep it on a bigger package","value":{"accept_privacy":true,"confirm_keep":"journal.harbourandfinch.example.com","package":"CS8"}}},"schema":{"$ref":"#/components/schemas/DemoKeepRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"demo":{"days_left":null,"ends_at":"2026-12-06T09:00:00Z","grace_ends_at":null,"id":3310,"keep":{"allowed":false,"refusal":null,"url":"https://manage.corefinity.com/billing/keep?demo=3310&plan=keep"},"kept_at":"2026-11-09T10:15:00Z","package":"CS4","price_after":{"amount":"300.00","currency":"GBP"},"product_line":"CS","region":"uk","starts_at":"2026-11-06T09:00:00Z","state":"kept","target":{"id":1051,"name":"journal.harbourandfinch.example.com","type":"site"},"upgrade":{"next":null}},"kept":{"already":false,"billed_from":"2026-11-09T11:00:00Z","kept_at":"2026-11-09T10:15:00Z","restored":false,"staging":"none"},"progress":{"changes":[],"next":null,"state":"none"},"upgrade":{"message":null,"next":null,"operation_id":null,"state":"none"}},"schema":{"$ref":"#/components/schemas/DemoKeepAnswer"}}},"description":"The demo is kept, and nothing more has started. `upgrade.state` is `none`, `queued` or `refused`. A second Keep of a kept demo answers the same, with `kept.already` true."},"202":{"content":{"application/json":{"example":{"demo":{"days_left":null,"ends_at":"2026-12-06T09:00:00Z","grace_ends_at":null,"id":3310,"keep":{"allowed":false,"refusal":null,"url":"https://manage.corefinity.com/billing/keep?demo=3310&plan=keep"},"kept_at":"2026-11-09T10:15:00Z","package":"CS4","price_after":{"amount":"300.00","currency":"GBP"},"product_line":"CS","region":"uk","starts_at":"2026-11-06T09:00:00Z","state":"kept","target":{"id":1051,"name":"journal.harbourandfinch.example.com","type":"site"},"upgrade":{"next":null}},"kept":{"already":false,"billed_from":"2026-11-09T11:00:00Z","kept_at":"2026-11-09T10:15:00Z","restored":false,"staging":"none"},"progress":{"changes":[{"ended_at":null,"kind":"package","operation_id":5120,"plan":"cs8","started_at":"2026-11-09T10:15:00Z","state":"applying"}],"next":null,"state":"applying"},"upgrade":{"message":null,"next":null,"operation_id":5120,"reason":null,"state":"started"}},"schema":{"$ref":"#/components/schemas/DemoKeepAnswer"}}},"description":"The demo is kept and its first change has started (`upgrade.state` is `started`). Follow `upgrade.operation_id`, or read the demo's `progress`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden_role":{"summary":"Not an owner or a billing role","value":{"code":"forbidden_role","message":"Ask Eleanor Finch to keep this site: keeping it needs the owner or a billing role.","reason":"forbidden_role"}},"two_factor":{"summary":"Two-factor authentication is not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}},"write_scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), you have not set up two-factor authentication\n(`two_factor_required`), or you are neither an owner nor a billing role of the company (`forbidden_role`).\n"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"already_kept":{"summary":"Kept already","value":{"code":"already_kept","message":"This site is already kept. Change it from its own page.","reason":"already_kept"}},"billing_country_unconfirmed":{"summary":"The billing country the demo set for you is not confirmed","value":{"code":"billing_details_required","keep_url":"https://manage.corefinity.com/billing/keep?demo=3310&plan=keep&step=billing_details","message":"Confirm your billing country (United Kingdom) to keep your site.","reason":"billing_details_required"}},"billing_details_required":{"summary":"Billing details are missing","value":{"code":"billing_details_required","keep_url":"https://manage.corefinity.com/billing/keep?demo=3310&plan=keep","message":"Add your billing details to keep your site.","reason":"billing_details_required"}},"busy":{"summary":"The demo is being updated","value":{"code":"busy","message":"This demo is being updated. Try again in a moment.","reason":"busy"}},"demo_building":{"summary":"Still being set up","value":{"code":"demo_building","message":"Your demo is still being set up. Keep it once it is ready.","reason":"demo_building"}},"demo_closed":{"summary":"The demo has ended","value":{"code":"demo_closed","message":"This demo has ended and can no longer be kept. Start an order to carry on.","reason":"demo_closed"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"payment_method_required":{"summary":"No payment method","value":{"code":"payment_method_required","keep_url":"https://manage.corefinity.com/billing/keep?demo=3310&plan=keep","message":"Add a payment method to keep your site.","reason":"payment_method_required"}}},"schema":{"$ref":"#/components/schemas/DemoKeepRefusal"}}},"description":"The demo cannot be kept now: it is still being set up (`demo_building`), it has ended (`demo_closed`), it\nis kept already and the request asks for a change (`already_kept`), it is being updated (`busy`), or its\nsite is managed by another control panel (`managed_elsewhere`). Or a step you finish in the browser is\nmissing, with its `keep_url`: billing details or a billing country to confirm\n(`billing_details_required`), or a payment method (`payment_method_required`).\n"},"422":{"content":{"application/json":{"examples":{"addon_bounds":{"summary":"A disk total that is not a multiple of 10, or above the most","value":{"code":"addon_bounds","message":"GB of disk must be a whole number from 0 to 102400, in steps of 10.","reason":"addon_bounds"}},"addon_bounds_cores":{"summary":"More extra cores than can be bought","value":{"code":"addon_bounds","message":"Cores must be a whole number from 0 to 16.","reason":"addon_bounds"}},"addon_bounds_log_storage":{"summary":"More extra log storage than can be bought","value":{"code":"addon_bounds","message":"GB of log storage must be a whole number from 0 to 1000.","reason":"addon_bounds"}},"addon_bounds_memory":{"summary":"More extra memory than can be bought","value":{"code":"addon_bounds","message":"GB of RAM must be a whole number from 0 to 64.","reason":"addon_bounds"}},"confirm_billing_country":{"summary":"Another billing country was typed","value":{"code":"confirm_mismatch","errors":{"confirm_billing_country":["Your billing country is United Kingdom (GB). Confirm GB, or change it in Billing › Details first."]},"field":"confirm_billing_country","message":"Your billing country is United Kingdom (GB). Confirm GB, or change it in Billing › Details first.","reason":"confirm_mismatch"}},"confirm_mismatch":{"summary":"The confirmation does not match","value":{"code":"confirm_mismatch","errors":{"confirm_keep":["Type the site's domain to keep it."]},"field":"confirm_keep","message":"Type the site's domain to keep it.","reason":"confirm_mismatch"}},"confirm_mismatch_cluster":{"summary":"The confirmation of a CoreCluster demo does not match","value":{"code":"confirm_mismatch","errors":{"confirm_keep":["Type the word cluster to keep it."]},"field":"confirm_keep","message":"Type the word cluster to keep it.","reason":"confirm_mismatch"}},"invalid":{"summary":"The confirmation is missing","value":{"code":"invalid","errors":{"confirm_keep":["The confirm keep field is required."]},"field":"confirm_keep","message":"The confirm keep field is required.","reason":"invalid"}},"package_not_offered":{"summary":"A package the demo cannot be kept on","value":{"code":"package_not_offered","field":"package","message":"That package is not offered for this demo. Choose one of the bigger packages listed.","reason":"package_not_offered"}},"package_platform":{"summary":"A package that does not run the site's platform","value":{"code":"package_platform","field":"package","message":"That package does not run this site's platform. Choose a bigger one.","reason":"package_platform"}},"privacy_required":{"summary":"The privacy notice is not accepted","value":{"code":"privacy_required","field":"accept_privacy","message":"Accept the privacy notice to keep it.","reason":"privacy_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`), `confirm_keep` or `confirm_billing_country` does not match\n(`confirm_mismatch`, with `field`), the privacy notice is not accepted (`privacy_required`), the package is\nnot one this demo can be kept on (`package_not_offered`, `package_platform`), or add-on units are outside\nwhat can be bought (`addon_bounds`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Keep a demo","tags":["Demos"],"x-effect":["billable"],"x-feature":"demos","x-file":"demos","x-gates":["billing"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-demos-keep","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/environments/{environment}/deploy-secrets":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers the Composer registry credentials saved for a CoreStack Enterprise environment, in registry order. A\ntoken or a username is never part of any answer: `last4` shows the last four characters of a token of 12\ncharacters or more.\n","operationId":"listEnvironmentRegistrySecrets","responses":{"200":{"content":{"application/json":{"examples":{"secrets":{"summary":"One saved credential","value":{"data":[{"auth_type":"bearer","id":318,"kind":"composer","label":"Private packages","last4":"oken","last_used_at":null,"registry":"repo.example.com","scope":"","verified_at":null}]}}},"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EnvironmentRegistrySecret"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"The environment's registry secrets."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnvironmentRegistrySecretNotEnterprise"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List an environment's registry secrets","tags":["Registry secrets"],"x-feature":"registry-secrets","x-file":"environment-deploy-secrets","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"post":{"description":"Saves the credential for one Composer registry. The registry is named by its host, with a port when it needs\none; it must resolve to public addresses. An environment holds one credential for each registry. A saved\ncredential is used by the environment's builds once registry credentials are switched on for it.\n","operationId":"createEnvironmentRegistrySecret","requestBody":{"content":{"application/json":{"examples":{"basic":{"summary":"A registry that signs in with a username and a token","value":{"auth_type":"http-basic","label":"Private packages","registry":"packages.example.com","secret":"your-registry-token","username":"northwind-digital"}},"bearer":{"summary":"A registry that signs in with a bearer token","value":{"auth_type":"bearer","label":"Private packages","registry":"packages.example.com","secret":"your-registry-token"}}},"schema":{"$ref":"#/components/schemas/EnvironmentRegistrySecretCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"created":{"summary":"A new credential, not verified yet","value":{"data":{"auth_type":"http-basic","id":319,"kind":"composer","label":"Private packages","last4":"oken","last_used_at":null,"registry":"packages.example.com","scope":"","verified_at":null}}}},"schema":{"$ref":"#/components/schemas/EnvironmentRegistrySecretAnswer"}}},"description":"The saved credential."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentRegistrySecretForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/EnvironmentRegistrySecretExists"},"422":{"$ref":"#/components/responses/EnvironmentRegistrySecretRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a registry secret","tags":["Registry secrets"],"x-effect":["changes-settings"],"x-feature":"registry-secrets","x-file":"environment-deploy-secrets","x-gates":[],"x-rate-limit":{"bucket":"environment-deploy-secrets-write","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/environments/{environment}/deploy-secrets/{secret}":{"parameters":[{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/EnvironmentRegistrySecretId"}],"put":{"description":"Changes the fields you send and keeps the rest. A new token replaces the saved one. Anything that changes what\nthe registry is asked with (the registry, the sign-in type, the username or the token) clears `verified_at`; a\nnew label keeps it.\n","operationId":"updateEnvironmentRegistrySecret","requestBody":{"content":{"application/json":{"examples":{"label":{"summary":"Rename a credential","value":{"label":"Harbour & Finch packages"}},"token":{"summary":"Replace the token","value":{"secret":"your-new-registry-token"}}},"schema":{"$ref":"#/components/schemas/EnvironmentRegistrySecretUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"renamed":{"summary":"A renamed credential","value":{"data":{"auth_type":"bearer","id":318,"kind":"composer","label":"Harbour & Finch packages","last4":"oken","last_used_at":null,"registry":"repo.example.com","scope":"","verified_at":null}}}},"schema":{"$ref":"#/components/schemas/EnvironmentRegistrySecretAnswer"}}},"description":"The credential after the change."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentRegistrySecretForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/EnvironmentRegistrySecretExists"},"422":{"$ref":"#/components/responses/EnvironmentRegistrySecretRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a registry secret","tags":["Registry secrets"],"x-effect":["changes-settings"],"x-feature":"registry-secrets","x-file":"environment-deploy-secrets","x-gates":[],"x-rate-limit":{"bucket":"environment-deploy-secrets-write","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes the credential. The environment's next build no longer signs in to that registry.","operationId":"deleteEnvironmentRegistrySecret","responses":{"204":{"description":"The credential was removed. No body."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentRegistrySecretForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnvironmentRegistrySecretNotEnterprise"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a registry secret","tags":["Registry secrets"],"x-effect":["deletes"],"x-feature":"registry-secrets","x-file":"environment-deploy-secrets","x-gates":[],"x-rate-limit":{"bucket":"environment-deploy-secrets-write","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/environments/{environment}/deploy-secrets/{secret}/verify":{"parameters":[{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/EnvironmentRegistrySecretId"}],"post":{"description":"Asks the registry once, with the saved credential, whether it accepts it. `verified` says so, `message` says\nwhat the registry answered, and an accepted credential gets its `verified_at`. A credential the registry\nrefuses, or a registry that cannot be reached, is still a `200` with `verified` false.\n","operationId":"checkEnvironmentRegistrySecret","responses":{"200":{"content":{"application/json":{"examples":{"accepted":{"summary":"The registry accepted the credential","value":{"data":{"auth_type":"bearer","id":318,"kind":"composer","label":"Private packages","last4":"oken","last_used_at":null,"registry":"repo.example.com","scope":"","verified_at":"2026-11-09T10:42:07Z"},"message":"The registry accepted these credentials.","verified":true}},"refused":{"summary":"The registry refused the credential","value":{"data":{"auth_type":"bearer","id":318,"kind":"composer","label":"Private packages","last4":"oken","last_used_at":null,"registry":"repo.example.com","scope":"","verified_at":null},"message":"The registry refused these credentials.","verified":false}}},"schema":{"$ref":"#/components/schemas/EnvironmentRegistrySecretVerified"}}},"description":"What the registry answered, and the credential as it is now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentRegistrySecretForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnvironmentRegistrySecretNotEnterprise"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Check a registry secret with its registry","tags":["Registry secrets"],"x-effect":["changes-settings"],"x-feature":"registry-secrets","x-file":"environment-deploy-secrets","x-gates":[],"x-rate-limit":{"bucket":"environment-deploy-secrets-write","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/feedback":{"post":{"description":"Sends Corefinity's product team a feature request, a bug report, general feedback or a request for a platform,\nas the Feedback button of the Control Panel does, and answers the submission's reference. Nobody replies to\nfeedback: open a support ticket when you need an answer. Send only the fields of your `type`, with a\n`Content-Length`, in at most 8 MiB.\n","operationId":"sendFeedback","requestBody":{"content":{"application/json":{"examples":{"bug_report":{"summary":"A bug report about one site","value":{"description":"I pressed Deploy and nothing happened.","expected":"A deployment starts.","severity":"major","site_id":1042,"steps":"Open the site\nPress Deploy","title":"Deploy button does nothing","type":"bug_report"}},"feature_request":{"summary":"A feature request","value":{"description":"Let me download every redirect of a site as one file.","importance":"important","title":"Export redirects as a spreadsheet","type":"feature_request","why":"We review redirects with a client every quarter."}},"general_feedback":{"summary":"General feedback, whose first line is its summary","value":{"description":"The new site list is much quicker.\nThank you.","type":"general_feedback"}},"php_extension_request":{"summary":"A request for a PHP extension, with a text file attached","value":{"attachments":[{"data":"Q2xhc3MgIkltYWdpY2siIG5vdCBmb3VuZAo=","mime_type":"text/plain","name":"error.txt"}],"description":"Our image pipeline needs imagick.","request":{"kind":"php_extension","name":"imagick"},"title":"The imagick extension","type":"platform_request"}},"platform_request":{"summary":"A request for a platform","value":{"description":"We would like to host two Sylius shops.","platform":"sylius","platform_version":"2.0","sites_count":2,"timeline":"within_3_months","title":"Sylius hosting","type":"platform_request"}}},"schema":{"$ref":"#/components/schemas/FeedbackSubmission"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"id":1234,"reference":"FB-1234","status":"received"},"schema":{"$ref":"#/components/schemas/FeedbackReceived"}}},"description":"The feedback was received."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The site, environment or cluster named does not exist or is not one you can see (both answer the same body), or feedback is not on for your company (`feature_off`)."},"411":{"content":{"application/json":{"example":{"code":"length_required","message":"Send the feedback with a Content-Length.","reason":"length_required"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The request has no `Content-Length` (`length_required`). Nothing was read."},"413":{"content":{"application/json":{"examples":{"attachments_together":{"summary":"Attachments over 5 MiB together","value":{"code":"payload_too_large","message":"The attachments are over 5 MiB together.","reason":"payload_too_large"}},"image_attachment":{"summary":"An image over 2 MiB","value":{"code":"payload_too_large","message":"An image attachment is over 2 MiB.","reason":"payload_too_large"}},"request":{"summary":"The request is over 8 MiB","value":{"code":"payload_too_large","message":"That's too large to send. Attach smaller files.","reason":"payload_too_large"}},"text_attachment":{"summary":"A text attachment over 256 KiB","value":{"code":"payload_too_large","message":"A text attachment is over 0.25 MiB.","reason":"payload_too_large"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The request is over 8 MiB, or an attachment, or all of them together, is over its size\n(`payload_too_large`). Nothing was saved or counted.\n"},"422":{"content":{"application/json":{"examples":{"missing":{"summary":"A bug report with no summary and no severity","value":{"code":"invalid","errors":{"severity":["Choose how bad it is."],"title":["Add a summary."]},"field":"title","message":"Check the highlighted fields.","reason":"invalid"}},"missing_platform":{"summary":"A platform request that names neither a platform nor a request","value":{"code":"invalid","errors":{"platform":["Choose a platform."]},"field":"platform","message":"Check the highlighted fields.","reason":"invalid"}},"other_type_field":{"summary":"A field of another type","value":{"code":"invalid","errors":{"why":["The why field is not part of this request."]},"field":"why","message":"Check the highlighted fields.","reason":"invalid"}},"severity_on_general_feedback":{"summary":"A severity on general feedback","value":{"code":"invalid","errors":{"severity":["The severity field is not part of this request."]},"field":"severity","message":"Check the highlighted fields.","reason":"invalid"}},"two_contexts":{"summary":"A site and a cluster together","value":{"code":"invalid","errors":{"site_id":["Name at most one of site_id, environment_id and cluster_id."]},"field":"site_id","message":"Check the highlighted fields.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing, not valid, or not one of your `type` (`invalid`). `errors` names each refused field\nwith its sentence and `field` the first of them.\n"},"429":{"content":{"application/json":{"examples":{"requests":{"summary":"Too many requests in a minute","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}},"submissions":{"summary":"Ten submissions in the last hour","value":{"code":"rate_limited","limit":"user_hour","message":"Thanks — you've sent a lot of feedback in the last hour.","reason":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests in a minute, or you or your company have sent the most feedback allowed for now. Both\nare `rate_limited` and both send `Retry-After`; the second names the limit reached in `limit`\n(`user_hour`, `user_day` or `company_day`).\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"503":{"content":{"application/json":{"example":{"code":"busy","message":"The Control Panel is busy. Send your feedback again in a moment.","reason":"busy"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The feedback could not be saved at the moment (`busy`). Nothing was saved or counted; send it again after `Retry-After` seconds.","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}}},"summary":"Send feedback to Corefinity","tags":["Feedback"],"x-effect":["sends"],"x-feature":"feedback","x-file":"feedback","x-gates":["feedback"],"x-rate-limit":{"also":[{"bucket":"feedback-submissions","limit":10,"minutes":60,"per":"person"},{"bucket":"feedback-submissions","limit":30,"minutes":1440,"per":"person"},{"bucket":"feedback-submissions","limit":100,"minutes":1440,"per":"company"}],"bucket":"corecluster-feedback-burst","limit":30,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/logs/exports/{download}":{"parameters":[{"$ref":"#/components/parameters/logsDownload"}],"get":{"description":"Answers one of your exports, of a site or of a CoreCluster; only the person who started an export can read it.\nRead it until `state` is `ready`, `failed` or `expired`.\n","operationId":"getLogsExport","responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsExportReadyExample"}},"schema":{"$ref":"#/components/schemas/LogsExport"}}},"description":"The export."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a logs export","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/logs/exports/{download}/collect":{"parameters":[{"$ref":"#/components/parameters/logsDownload"}],"post":{"description":"Answers the file of a ready export, once: CSV or one JSON object a line, not a JSON document. Send the\n`capability` the start answered; once the file has been collected, or after 24 hours, the answer is `410`.\n","operationId":"collectLogsExport","requestBody":{"content":{"application/json":{"examples":{"collect":{"summary":"Collect the file","value":{"capability":"Example-export-capability-0000000000000000000001"}}},"schema":{"$ref":"#/components/schemas/LogsExportCollectRequest"}}},"required":true},"responses":{"200":{"content":{"application/x-ndjson":{"schema":{"type":"string"}},"text/csv":{"example":"time,source,msg\n2026-11-03T09:55:00Z,web-access,GET /products/5 200\n","schema":{"type":"string"}}},"description":"The file. It can be collected once.","headers":{"Cache-Control":{"description":"Always `no-store`.","schema":{"type":"string"}},"Content-Disposition":{"description":"`attachment`, with the file name.","schema":{"type":"string"}},"X-Logs-Lines":{"description":"The number of lines in the file.","schema":{"type":"integer"}},"X-Logs-Truncated":{"description":"`1` when the file was cut at the line or size limit. Not sent otherwise.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"download_preparing":{"value":{"code":"download_preparing","message":"The download is still being prepared.","reason":"download_preparing"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The export is still being prepared (`download_preparing`). Nothing is used up; try again when its `state` is `ready`."},"410":{"content":{"application/json":{"examples":{"expired":{"value":{"code":"expired","message":"This download has expired. Prepare it again.","reason":"expired"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The export has been collected already, has expired or failed (`expired`). Start a new one."},"422":{"content":{"application/json":{"examples":{"capability":{"value":{"code":"invalid","errors":{"capability":["This download link is not valid."]},"field":"capability","message":"This download link is not valid.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The `capability` is missing or is not this export's. Nothing is used up."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Collect a logs export","tags":["Logs"],"x-effect":["deletes"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"corecluster-logs-download","limit":5,"minutes":10},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/logs/saved-queries/{query}":{"parameters":[{"$ref":"#/components/parameters/logsSavedQuery"}],"delete":{"description":"Deletes one of your saved queries, of a site or of a CoreCluster, and answers the ones you still have.\n","operationId":"deleteLogSavedQuery","responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsSavedQueryRemainingExample"}},"schema":{"$ref":"#/components/schemas/LogsSavedQueryList"}}},"description":"Your remaining saved queries."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a saved log query","tags":["Logs"],"x-effect":["deletes"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"corecluster-logs-saved","limit":30,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/nginx-rules/policy":{"get":{"description":"Answers what Nginx rules may contain: the directives each hook takes, the ones that are refused and why, and the limits. Send `site` for the policy of one site, or `platform` for a platform in general. The answer carries an `ETag`; send it back in `If-None-Match` and an unchanged policy answers `304` with no body.\n","operationId":"getNginxPolicy","parameters":[{"description":"The id of a site row: the policy for its platform and the hooks it can use. A site you cannot see answers `404`.","in":"query","name":"site","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"A platform, when `site` is not sent.","example":"wordpress","in":"query","name":"platform","required":false,"schema":{"enum":["laravel","magento2","php","shopware","shopware5","wordpress"],"type":"string"}},{"description":"The `ETag` of an earlier answer.","in":"header","name":"If-None-Match","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"directives":[{"args":["2","3"],"checks":["add_header"],"contexts":["headers","location","location_if","php"],"doc":null,"hooks":["server","headers","php"],"name":"add_header","prefix":false}],"header_governed":{"fixed":["X-Content-Type-Options","Referrer-Policy","X-Frame-Options","Strict-Transport-Security"],"framing":["Content-Type","Content-Length","Server"],"governed":["Cache-Control","CDN-Cache-Control","Cloudflare-CDN-Cache-Control","Surrogate-Control","X-Robots-Tag"]},"hooks":["server","headers","php","http"],"limits":{"buffers_total_max":4194304,"hook_file_bytes":65536,"keepalive":32,"lines_warn":1500,"location_nesting":3,"map_entries":1000,"max_lines":2000,"max_locations":200,"max_regex":512,"size_caps":{"client_body_buffer_size":1048576,"proxy_buffer_size":262144,"proxy_busy_buffers_size":1048576},"verify_paths":5,"zone_total_bytes":10485760},"platform_headers":[{"name":"X-Content-Type-Options","value":"nosniff"}],"platforms":["wordpress"],"policy_version":6,"rate_limit_presets":[],"refused":[{"context":null,"hook":null,"message":"This module is not loaded by the platform's nginx.","name":"*_by_lua*","reason":"module_not_loaded"}],"reserved_prefixes":["cf_"],"static_extensions":["css","js","png","jpg","svg","woff2","pdf"]},"schema":{"$ref":"#/components/schemas/NginxPolicy"}}},"description":"The policy. The lists are shortened here.","headers":{"Cache-Control":{"description":"`private, max-age=3600`.","schema":{"type":"string"}},"ETag":{"description":"Identifies this answer. Send it back in `If-None-Match`.","schema":{"type":"string"}}}},"304":{"description":"The policy has not changed since the `ETag` sent in `If-None-Match`. No body."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not a platform","value":{"code":"invalid","errors":{"platform":["Choose one of the platforms: laravel, magento2, php, shopware, shopware5, wordpress."]},"field":"platform","message":"Choose one of the platforms: laravel, magento2, php, shopware, shopware5, wordpress.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`site` is not an id, or `platform` is not one of the platforms (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the Nginx rules policy","tags":["Web server rules"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"bucket":"corecluster-nginx-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/node/catalogue":{"get":{"description":"Answers the Node.js versions with their status and dates, the default for new sites, the curated packages and\nthe limits. With `site`, each version says whether that site may move to it; with `platform`, whether a new\nsite of that platform may use it.\n","operationId":"getNodeCatalogue","parameters":[{"description":"The id of a site row, to answer what that site may move to. Digits only.","in":"query","name":"site","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"A platform, such as `wordpress`, to answer what a new site of that platform may use. Any other value is refused `422`. Ignored when `site` is sent.","example":"wordpress","in":"query","name":"platform","required":false,"schema":{"anyOf":[{"enum":["wordpress"],"type":"string"},{"enum":["laravel"],"type":"string"},{"enum":["magento2"],"type":"string"},{"enum":["shopware5"],"type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"examples":{"catalogue":{"summary":"The versions for a new WordPress site, shortened","value":{"curated":[{"description":"Tailwind CSS on the command line, for building a theme's CSS.","name":"@tailwindcss/cli"},{"description":"Compiles Sass and SCSS to CSS.","name":"sass"},{"description":"Runs a project's gulp tasks.","name":"gulp-cli"}],"default_for_new":24,"limits":{"max_packages":20},"majors":[{"arrives_with":null,"available_on_this_row":true,"codename":null,"default_for_new":false,"end_of_life_on":"2029-04-30","label":"Node.js 26","major":26,"needs_ack":[],"reason":null,"recommended":true,"selectable":true,"status":"active_lts"},{"arrives_with":null,"available_on_this_row":true,"codename":"Krypton","default_for_new":true,"end_of_life_on":"2028-04-30","label":"Node.js 24","major":24,"needs_ack":[],"reason":null,"recommended":true,"selectable":true,"status":"maintenance_lts"},{"arrives_with":null,"available_on_this_row":true,"codename":"Hydrogen","default_for_new":false,"end_of_life_on":"2025-04-30","label":"Node.js 18","major":18,"needs_ack":["eol"],"reason":null,"recommended":false,"selectable":true,"status":"end_of_life"}]}}},"schema":{"$ref":"#/components/schemas/RuntimeNodeCatalogue"}}},"description":"The Node.js versions, the default, the curated packages and the limits."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/FeatureOffRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The `site` does not exist or is not yours to see, or Node.js is not on for your company (`feature_off`)."},"422":{"$ref":"#/components/responses/RuntimeNodeArgumentsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the Node.js versions on offer","tags":["Node.js"],"x-feature":"node-runtime","x-file":"runtime","x-gates":["node_runtime"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/node/packages/lookup":{"get":{"description":"Answers whether a package exists on the public npm registry, the version a selector resolves to, its licence,\nwhether it has an install script and whether it is deprecated. `exists` is null when the registry could not be\nasked.\n","operationId":"getNodePackage","parameters":[{"description":"The package's name on the npm registry, with its `@scope/` when it has one. Lower case, at most 214 characters; not a URL, a git address, a file or a tarball.","example":"sharp","in":"query","name":"name","required":true,"schema":{"maxLength":214,"pattern":"^(?:@[a-z0-9~-][a-z0-9._~-]*/[a-z0-9~-][a-z0-9._~-]*|[a-z0-9~][a-z0-9._~-]*)$","type":"string"}},{"description":"A version, a range written without spaces or a tag, such as `0.34`, `^1.90` or `latest`, at most 64 characters. Left out, the newest version is looked up.","example":"0.34","in":"query","name":"selector","required":false,"schema":{"maxLength":64,"pattern":"^(?:[0-9A-Za-z.^~<>=|*x+-]{1,64}|[a-z][a-z0-9._-]{0,63})$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"found":{"summary":"A package with an install script","value":{"deprecated":null,"description":"High performance image processing","exists":true,"has_install_script":true,"latest":"0.34.4","licence":"Apache-2.0","resolved_version":"0.34.4"}}},"schema":{"$ref":"#/components/schemas/RuntimeNodePackageLookup"}}},"description":"What the registry says about the package."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/FeatureOff"},"422":{"$ref":"#/components/responses/RuntimeNodePackageInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a package from npm","tags":["Node.js"],"x-feature":"node-runtime","x-file":"runtime","x-gates":["node_runtime"],"x-rate-limit":{"bucket":"corecluster-node-lookup","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/operations/{operation}":{"parameters":[{"$ref":"#/components/parameters/operation"}],"get":{"description":"Answers one operation: its status, steps and, when it failed, why. Read it every few seconds until `status` is\n`completed` or `failed`. A CoreCluster's own operations are read here too.\n","operationId":"getOperation","responses":{"200":{"content":{"application/json":{"examples":{"failed":{"$ref":"#/components/examples/OperationFailedExample"}},"schema":{"$ref":"#/components/schemas/OperationRead"}}},"description":"The operation."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an operation","tags":["Operations"],"x-feature":"operations","x-file":"operations","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/operations/{operation}/retry":{"parameters":[{"$ref":"#/components/parameters/operation"}],"post":{"description":"Retries a site's failed operation from where it stopped and answers the new attempt to follow.\nSite and environment creations, operations already retried and a CoreCluster's own operations cannot be retried here.\n","operationId":"retryOperation","requestBody":{"content":{"application/json":{"examples":{"acknowledge_the_live_env_file":{"summary":"Retry after checking the live .env file","value":{"acknowledge_env":true}},"retry":{"summary":"Retry from where the operation stopped","value":{}}},"schema":{"$ref":"#/components/schemas/OperationRetryRequest"}}},"required":false},"responses":{"201":{"content":{"application/json":{"examples":{"retried":{"$ref":"#/components/examples/OperationRetriedExample"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"The new attempt."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"busy":{"value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"cluster_paused":{"value":{"code":"cluster_paused","message":"Changes on this site are paused for planned maintenance; please try again later.","reason":"cluster_paused"}},"deleted":{"value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"managed_elsewhere":{"value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"provisioning":{"value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}},"restore_running":{"value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site's state refuses the retry. `reason` says why, among them `deleted`, `provisioning`, `busy` (another\nchange is running), `restore_running`, `managed_elsewhere` and `cluster_paused` (Corefinity has paused\nchanges for planned maintenance: the message says until when, if that is known).\n"},"422":{"content":{"application/json":{"examples":{"acknowledge_env":{"summary":"The live .env file changed under the operation","value":{"code":"invalid","errors":{"acknowledge_env":["acknowledge_env_required"]},"field":"acknowledge_env","message":"Check the .env file, then confirm it is the one to continue from","reason":"invalid"}},"created_by_staff":{"summary":"A failed site or environment creation, which Corefinity retries","value":{"code":"not_retryable","message":"Creating this site is retried by our staff. Ask us to retry it, or delete the site and create it again.","reason":"not_retryable"}},"not_retryable":{"summary":"This operation cannot be retried here","value":{"code":"not_retryable","message":"This change cannot be retried","reason":"not_retryable"}},"stale":{"summary":"A later change has overtaken the operation","value":{"code":"stale","message":"A newer domain attach has already completed for this environment. Change its domain in the Domains tab instead.","reason":"stale"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The operation cannot be retried here (`not_retryable`: it did not fail, was already retried, or is a site\nor environment creation), a later change has overtaken it (`stale`), or its failure needs `acknowledge_env`\nfirst (`invalid` on `acknowledge_env`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Retry a failed operation","tags":["Operations"],"x-effect":["changes-settings","overwrites","runs-code"],"x-feature":"operations","x-file":"operations","x-gates":[],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-sets","limit":5,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"destructive","when":"The failed operation is a site delete, an environment delete or a copy onto production"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/operations/{operation}/reveal":{"parameters":[{"$ref":"#/components/parameters/operation"}],"post":{"description":"Answers the one-time login a copy or a new environment created, once, to whoever asks first. Every answer is sent\nwith `Cache-Control: no-store`, and the reveal is recorded with who made it and when.\n","operationId":"revealOperationResult","responses":{"200":{"content":{"application/json":{"example":{"credentials":{"admin":{"password":"Example-admin-2026","url":"https://staging.harbourandfinch.example.com/wp-admin/","username":"admin"},"note":"Shown once. Store it in your password manager.","revealed_at":"2026-11-03T09:20:00+00:00"},"remaining":0,"revealed_at":"2026-11-03T09:20:00+00:00"},"schema":{"$ref":"#/components/schemas/OperationReveal"}}},"description":"The login."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The request did not ask for JSON. Send `Accept: application/json`. Nothing was shown."},"409":{"content":{"application/json":{"examples":{"already_revealed":{"value":{"code":"already_revealed","details":{"reset_target":{"url":"https://staging.harbourandfinch.example.com/wp-admin/","username":"admin"},"reset_tool":"corestack_admin_login_reset","revealed":{"at":"2026-11-03T09:20:00+00:00","by_name":"Eleanor Finch","label":null,"via":"panel"}},"message":"These credentials were already shown. Reset them from the site page","reason":"already_revealed"}},"busy":{"value":{"code":"busy","message":"Another change to this site is in progress","reason":"busy"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The login was already shown (`already_revealed`), or another reveal of it is running (`busy`).\n`already_revealed` adds `details`: who saw the login and when, and the account a password reset would change.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Reveal an operation's one-time login","tags":["Operations"],"x-effect":["reveals-secret"],"x-feature":"operations","x-file":"operations","x-gates":[],"x-rate-limit":{"bucket":"corecluster-reveal","limit":5,"minutes":10},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/order-links/preview":{"post":{"description":"Checks a configuration for the order page, prices it as the order page does (monthly, excluding VAT) and\nanswers the link that opens the order page with every choice made. Nothing is created, saved or charged, and\nthe answer is the same for everyone who is signed in.\n","operationId":"previewOrderLink","requestBody":{"content":{"application/json":{"examples":{"cluster":{"summary":"A CoreCluster on Performance servers with upgrades","value":{"addons":{"cores":2,"disk_gb":50,"memory_gb":8},"compute_family":"optimised","currency":"GBP","package":"CC8","region":"uk"}},"cluster_annual":{"summary":"A CoreCluster billed annually, no upgrades","value":{"billing":"annual","currency":"GBP","package":"CC8","region":"uk"}},"site":{"summary":"A CoreStack site for WordPress","value":{"currency":"GBP","package":"CS4","platform":"wordpress","region":"uk"}}},"schema":{"$ref":"#/components/schemas/OrderLinkPreviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"cluster":{"$ref":"#/components/examples/OrderLinkPreviewExample"}},"schema":{"$ref":"#/components/schemas/OrderLinkPreview"}}},"description":"The configuration as it was checked, its price, and the link that opens the order page with it."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/FeatureOff"},"422":{"content":{"application/json":{"examples":{"addons":{"summary":"Upgrades that are not an object of whole numbers","value":{"code":"invalid","errors":{"addons":["Send the upgrades as an object of whole numbers"]},"field":"addons","message":"Send the upgrades as an object of whole numbers","reason":"invalid"}},"billing":{"summary":"A billing period that does not exist","value":{"code":"invalid","errors":{"billing":["Choose monthly or annual"]},"field":"billing","message":"Choose monthly or annual","reason":"invalid"}},"compute_family":{"summary":"A server type that does not exist","value":{"code":"invalid","errors":{"compute_family":["Choose Standard or Performance"]},"field":"compute_family","message":"Choose Standard or Performance","reason":"invalid"}},"cores":{"summary":"More extra cores than the package takes","value":{"code":"invalid","errors":{"cores":["Add up to 8 extra cores"]},"field":"cores","message":"Add up to 8 extra cores","reason":"invalid"}},"currency":{"summary":"A currency the order page does not offer","value":{"code":"invalid","errors":{"currency":["Choose GBP, USD or EUR"]},"field":"currency","message":"Choose GBP, USD or EUR","reason":"invalid"}},"disk_gb":{"summary":"Extra disk that is not a step of 10 GB","value":{"code":"invalid","errors":{"disk_gb":["Add up to 102,400 GB, in steps of 10"]},"field":"disk_gb","message":"Add up to 102,400 GB, in steps of 10","reason":"invalid"}},"package_missing":{"summary":"No package, or a line the order page does not sell","value":{"code":"invalid","errors":{"package":["Choose a package"]},"field":"package","message":"Choose a package","reason":"invalid"}},"package_too_small":{"summary":"A package smaller than the platform starts at","value":{"code":"invalid","errors":{"package":["Magento 2 starts at CS4"]},"field":"package","message":"Magento 2 starts at CS4","reason":"invalid"}},"package_unknown":{"summary":"A package that is not sold","value":{"code":"invalid","errors":{"package":["CC999 is not a package we sell."]},"field":"package","message":"CC999 is not a package we sell.","reason":"invalid"}},"platform_missing":{"summary":"A CoreStack package with no platform","value":{"code":"invalid","errors":{"platform":["Choose a platform"]},"field":"platform","message":"Choose a platform","reason":"invalid"}},"platform_not_offered":{"summary":"A platform the order page does not offer","value":{"code":"invalid","errors":{"platform":["That platform is not offered"]},"field":"platform","message":"That platform is not offered","reason":"invalid"}},"region":{"summary":"A region the order page does not offer","value":{"code":"invalid","errors":{"region":["Choose a region"]},"field":"region","message":"Choose a region","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The order page would not take a value (`invalid`). `errors` lists every refused field in the order\npage's own words and `field` names the first: `package`, `region`, `currency`, `compute_family`,\n`platform`, `billing`, `addons`, or an upgrade by its own name (`cores`, `memory_gb`, `disk_gb`). The\nceilings in an upgrade's sentence are the package's own.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Preview an order link","tags":["Orders"],"x-effect":["none"],"x-feature":"order","x-file":"order-links","x-gates":["order"],"x-rate-limit":{"bucket":"corecluster-order-link","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/orders":{"get":{"description":"Answers your company's orders for new sites and CoreClusters, newest first, 25 a page, with how many there are\nin each state; the company's owner and its billing contacts see every order with who placed it. `kind`,\n`user_id` and `search` narrow the rows and the counts alike, and `total` counts every order whatever the\nfilters. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.\n","operationId":"listOrders","parameters":[{"description":"Only orders in this state. `open` is in progress or being built; `ended` is cancelled or expired.","in":"query","name":"state","schema":{"default":"all","enum":["all","open","completed","failed","ended"],"type":"string"}},{"description":"Only orders for a site, or only orders for a CoreCluster.","in":"query","name":"kind","schema":{"enum":["site","cluster"],"type":"string"}},{"description":"Only orders placed by this person, an `id` from `placers`.","in":"query","name":"user_id","schema":{"minimum":1,"type":"integer"}},{"description":"An order number, a domain or a CoreCluster's name.","in":"query","name":"search","schema":{"maxLength":100,"type":"string"}},{"description":"The `next_cursor` of the previous answer. Anything that is not a whole number is refused `422` on `cursor`.","in":"query","name":"cursor","schema":{"pattern":"^\\d{1,18}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"orders":{"$ref":"#/components/examples/CompanyOrderPageExample"}},"schema":{"$ref":"#/components/schemas/CompanyOrderPage"}}},"description":"A page of orders."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"orders_forbidden":{"summary":"You may not see your company's orders","value":{"code":"orders_forbidden","message":"Only the company's owner or someone with a billing role can see its orders.","reason":"orders_forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `read` scope (`scope_required`), your company requires two-factor authentication and\nyou have not set it up (`two_factor_required`), or you may not see your company's orders\n(`orders_forbidden`).\n"},"404":{"$ref":"#/components/responses/FeatureOff"},"422":{"content":{"application/json":{"examples":{"cursor":{"summary":"A cursor the list did not give","value":{"code":"invalid","errors":{"cursor":["The cursor format is invalid."]},"field":"cursor","message":"The cursor format is invalid.","reason":"invalid"}},"state":{"summary":"A state that does not exist","value":{"code":"invalid","errors":{"state":["The selected state is invalid."]},"field":"state","message":"The selected state is invalid.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A filter is wrong (`invalid`); `field` names it."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your orders","tags":["Orders"],"x-feature":"order","x-file":"billing","x-gates":["order"],"x-rate-limit":{"bucket":"corecluster-orders","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/overview":{"get":{"description":"The Managed Clusters overview: your CoreClusters with their usage, and whatever else the overview shows\nfor your company.\n","operationId":"getOverview","responses":{"200":{"content":{"application/json":{"example":{"activity":[],"attention":[{"acknowledgeable":true,"acknowledged":null,"action":null,"cluster":{"id":1017,"name":"Northwind UK 1"},"detail":"No container is ready.","environment":null,"href":"/managed-clusters/sites/1051","id":"site_down:1051","kind":"site_down","scope":"site","severity":"critical","since":"2026-11-14T08:58:00Z","site":{"domain":"journal.harbourandfinch.example.com","id":1051},"subject":null,"title":"Site is down"}],"attention_acknowledged":[],"attention_acknowledged_total":0,"attention_total":1,"clusters":[{"id":1017,"kind":"customer","label":"Northwind UK 1","name":"Northwind UK 1","region":{"key":"uk","label":"United Kingdom","place":"London (europe-west2)"},"sites":{"applying":0,"degraded":0,"down":1,"environments":1,"healthy":1,"live":1,"preview":1,"total":2,"unknown":0},"slug":"northwind-uk-1","state":"ready","state_label":"Ready"}],"generated_at":"2026-11-14T09:00:00Z","pagespeed":null,"sites":[]},"schema":{"$ref":"#/components/schemas/Overview"}}},"description":"The overview."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the overview","tags":["Sites"],"x-feature":"sites","x-file":"sites","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/packages":{"get":{"description":"Answers the packages on offer, in order of size, with what each holds and the platforms it can run; prices are\nin `GET /corestack/billing/catalogue` and in a quote. `product_line=cc` (the default) lists the CoreCluster\npackages; `product_line=cs` lists the CoreStack site packages.\n","operationId":"listPackages","parameters":[{"description":"`cc` for CoreCluster packages (the default), `cs` for CoreStack site packages.","example":"cc","in":"query","name":"product_line","schema":{"default":"cc","enum":["cc","cs"],"type":"string"}},{"description":"Only the packages offered in this region.","in":"query","name":"region","schema":{"enum":["uk","us","nl","aus"],"type":"string"}},{"description":"Only the packages that can run this platform, such as `wordpress`. A platform you are not offered is refused, naming the ones you are.","in":"query","name":"platform","schema":{"type":"string"}},{"description":"A server type. It is accepted and changes nothing, because every package is offered on both.","in":"query","name":"family","schema":{"enum":["general","optimised"],"type":"string"}},{"description":"One of your CoreClusters, for the CoreCluster packages. It marks the package the CoreCluster is on (`current`) and what a change to each other one would be (`change`).","in":"query","name":"cluster_id","schema":{"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"clusters":{"$ref":"#/components/examples/UpgradePackageListExample"}},"schema":{"$ref":"#/components/schemas/UpgradePackageList"}}},"description":"The packages."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `read` scope (`scope_required`), or your company requires two-factor authentication\nand you have not set it up (`two_factor_required`).\n"},"404":{"content":{"application/json":{"examples":{"corestack_off":{"summary":"CoreStack packages are not available yet","value":{"code":"feature_off","field":"product_line","message":"CoreStack packages are not available yet.","reason":"feature_off"}},"feature_off":{"summary":"Packages are not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_found":{"summary":"Not a CoreCluster you can see","value":{"message":"Not found."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"Packages are not on for your company (`feature_off`), the CoreStack packages are not available yet\n(`feature_off`, naming `product_line`), or `cluster_id` is not a CoreCluster you can see.\n"},"422":{"content":{"application/json":{"examples":{"family":{"summary":"A server type that does not exist","value":{"code":"invalid","errors":{"family":["Choose general or optimised"]},"field":"family","message":"Choose general or optimised","reason":"invalid"}},"platform":{"summary":"A platform that does not exist","value":{"code":"invalid","errors":{"platform":["That platform is not one we offer."]},"field":"platform","message":"That platform is not one we offer.","reason":"invalid"}},"product_line":{"summary":"A product line that does not exist","value":{"code":"invalid","errors":{"product_line":["Choose a product line of cs or cc"]},"field":"product_line","message":"Choose a product line of cs or cc","reason":"invalid"}},"region":{"summary":"A region that does not exist","value":{"code":"invalid","errors":{"region":["Choose a region of uk, us, nl or aus"]},"field":"region","message":"Choose a region of uk, us, nl or aus","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A parameter is wrong (`invalid`); `field` names it."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List packages","tags":["Packages and capacity"],"x-feature":"upgrades","x-file":"upgrades","x-gates":["packages"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/pending-changes/attention":{"get":{"description":"Answers tonight's changes and recent failed windows across every site you can see. Its links are paths in the Control Panel.\n","operationId":"listPendingChangesAttention","responses":{"200":{"content":{"application/json":{"example":{"attention":[{"acknowledgeable":false,"acknowledged":null,"action":{"href":"/managed-clusters/sites/1042#pending","label":"What applies tonight"},"cluster":null,"detail":"Scheduled maintenance tonight. Your PHP settings change is scheduled for tonight.","environment":null,"href":"/managed-clusters/sites/1042#pending","id":"maintenance_scheduled:4120","kind":"maintenance_scheduled","scope":"batch","severity":"info","since":"2026-11-04T11:00:00Z","site":null,"subject":null,"title":"Scheduled maintenance tonight"}],"attention_acknowledged":[],"attention_acknowledged_total":0,"attention_total":1,"generated_at":"2026-11-04T11:00:00Z"},"schema":{"$ref":"#/components/schemas/PendingChangesAttention"}}},"description":"The list."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/FeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List pending changes needing attention","tags":["Pending changes"],"x-feature":"pending-changes","x-file":"operations","x-gates":["restart_batches"],"x-rate-limit":{"bucket":"corecluster-attention","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/php/catalogue/{version}":{"parameters":[{"description":"A PHP version as major and minor, such as `8.4`.","example":"8.4","in":"path","name":"version","required":true,"schema":{"pattern":"^[0-9]+\\.[0-9]+$","type":"string"}}],"get":{"description":"Answers the extensions of a PHP version with what needs them, the tools that come with it and its php.ini\ndirectives. With `platform`, the presets and examples are those for that platform. It is not about one site:\nwhat a site has on is in its PHP configuration.\n","operationId":"getPhpCatalogue","parameters":[{"description":"A platform, such as `wordpress`, to get its presets and examples. Any other value is refused `422`.","example":"wordpress","in":"query","name":"platform","required":false,"schema":{"anyOf":[{"enum":["wordpress"],"type":"string"},{"enum":["laravel"],"type":"string"},{"enum":["magento2"],"type":"string"},{"enum":["shopware5"],"type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"examples":{"catalogue":{"summary":"PHP 8.4 for WordPress, shortened","value":{"builtin":["core","ctype","curl","date","dom","fileinfo"],"directives":{"max_input_vars":{"access":"perdir","default":"500000","extension":"core"},"memory_limit":{"access":"all","default":"1024M","extension":"core"},"realpath_cache_size":{"access":"system","default":"4096K","extension":"core"}},"eol_date":"2028-12-31","examples":[{"description":"Room for large product imports and menus with many items.","key":"woocommerce_large_imports","text":"max_input_vars = 20000\n","title":"WooCommerce large imports"},{"description":"Show every error on the page while you test. Not on production.","key":"debug_staging","text":"display_errors = On\nerror_reporting = E_ALL\nlog_errors = On\n","title":"Debug a staging environment"}],"extensions":[{"always_on":false,"available":true,"baseline_for":[],"conflicts":["blackfire","pcov"],"description":"Step debugging and error tracing while developing. Not on production.","group":"debugging","kind":"zend_extension","label":"Xdebug","name":"xdebug","non_production_only":true,"recommended_for":[],"required_by":[],"requires":[],"unavailable_reason":null,"version":"3.5.3"},{"always_on":false,"available":true,"baseline_for":["wordpress","laravel","magento2","shopware"],"conflicts":[],"description":"Image processing through ImageMagick: resizing, format conversion and PDF thumbnails.","group":"images","kind":"extension","label":"Imagick","name":"imagick","non_production_only":false,"recommended_for":[],"required_by":[],"requires":[],"unavailable_reason":null,"version":"3.8.1"},{"always_on":false,"available":true,"baseline_for":["wordpress","laravel","magento2","shopware"],"conflicts":[],"description":"A client for Redis and Valkey, for caches, sessions and queues.","group":"caching","kind":"extension","label":"Redis","name":"redis","non_production_only":false,"recommended_for":[],"required_by":["shopware"],"requires":["igbinary","msgpack"],"unavailable_reason":null,"version":"6.3.0"}],"php_version":"8.4.9","presets":[{"available":true,"directives":{"max_execution_time":"300","max_input_time":"300","max_input_vars":"20000"},"git_mode_note":null,"git_mode_only":[],"key":"woocommerce_large_catalogue","label":"WooCommerce large catalogue","reason":null,"xdebug":false},{"available":true,"directives":{"display_errors":"On","error_reporting":"E_ALL","zend.assertions":"1"},"git_mode_note":null,"git_mode_only":[],"key":"debug","label":"Debug (non-production)","reason":null,"xdebug":true}],"status":"supported","tools":[{"label":"7-Zip","name":"7z","path":"/usr/bin/7z","purpose":"Packs and unpacks 7z and other archives.","version":"25.01"}],"unavailable":[],"version":"8.4"}}},"schema":{"$ref":"#/components/schemas/RuntimePhpCatalogue"}}},"description":"The catalogue of that PHP version."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/FeatureOffRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"There is no catalogue for that PHP version, or PHP configuration is not on for your company (`feature_off`)."},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a PHP version's catalogue","tags":["PHP"],"x-feature":"php-runtime","x-file":"runtime","x-gates":["php_runtime"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/regions":{"get":{"description":"Answers every region a CoreCluster can be created in, with whether it is open now and, when it is not, why.\n`package` names a CoreCluster package's key, to judge each region's room for that package.\n","operationId":"listRegions","parameters":[{"description":"A CoreCluster package's key, such as `cc8`. A package that does not exist answers 404.","in":"query","name":"package","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"regions":{"$ref":"#/components/examples/UpgradeRegionListExample"}},"schema":{"$ref":"#/components/schemas/UpgradeRegionList"}}},"description":"The regions."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List regions","tags":["Packages and capacity"],"x-feature":"upgrades","x-file":"upgrades","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites":{"get":{"description":"Every site you can open, one entry per site with its environments, in id order.\nPaged by cursor: send `next_cursor` back as `cursor`; null means the last page.\n","operationId":"listSites","parameters":[{"description":"Only the sites of this CoreCluster. A CoreCluster that is not yours answers `404`.","in":"query","name":"cluster_id","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Only sites of this platform. Only the platforms available to your company are accepted.","example":"wordpress","in":"query","name":"platform","required":false,"schema":{"enum":["wordpress","laravel","magento2","shopware5"],"type":"string"}},{"description":"`corecluster` for sites in one of your CoreClusters, `corestack` for standalone CoreStack sites.","in":"query","name":"kind","required":false,"schema":{"enum":["corecluster","corestack"],"type":"string"}},{"description":"Part of a domain or of an environment name.","in":"query","name":"search","required":false,"schema":{"maxLength":120,"type":"string"}},{"description":"`security` for sites on an application version that receives security fixes only, `eol` for sites on an\nended version. Accepted only while application versions are on for your company; otherwise it is refused\n`422` on `app_status`.\n","in":"query","name":"app_status","required":false,"schema":{"enum":["security","eol"],"type":"string"}},{"description":"Items a page: 1 to 100, default 50.","example":20,"in":"query","name":"limit","required":false,"schema":{"default":50,"maximum":100,"minimum":1,"type":"integer"}},{"description":"The `next_cursor` of the previous answer. One with other characters, or longer than 64, is refused `422` on\n`cursor`; any other value that is not a cursor reads the first page.\n","in":"query","name":"cursor","required":false,"schema":{"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"one_site":{"summary":"One site with a staging environment","value":{"next_cursor":null,"sites":[{"cluster":{"id":1017,"name":"Northwind UK 1"},"compute_family":"general","covers_site":true,"domain":"harbourandfinch.example.com","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environment_count":1,"environments":[{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"staging-harbourandfinch-example-com.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"}],"health":"healthy","hosting":{"cluster_kind":"customer","label":"CoreCluster Northwind UK 1"},"id":1042,"kind":"corecluster","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"mariadb":{"version":"11.8"},"mode":"production","mode_label":"Domain attached","operation":null,"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://harbourandfinch-example-com.northwind.cfstack.example.net","primary_url":"https://harbourandfinch.example.com","removed":false,"restore":null,"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":"rs-northwind-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"tier":"S","uat_size":null,"usage":{"cpu_millicores":180,"disk_used_bytes":2147483648,"memory_bytes":912261120,"observed_at":"2026-11-14T09:10:00Z","source":"live"}}]}}},"schema":{"$ref":"#/components/schemas/SiteList"}}},"description":"One page of sites."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFound","description":"The CoreCluster named by `cluster_id` does not exist or is not yours to see."},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"limit":["The limit may not be greater than 100."]},"field":"limit","message":"The limit may not be greater than 100.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A filter value is not allowed."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your sites","tags":["Sites"],"x-feature":"sites","x-file":"sites","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"Creates a site with its environments, on a Corefinity platform in a region (with a `package`) or in one of your CoreClusters (sized by `tier`). This opens a contract for the site.\nThe answer is `201` when the create has started, or `202` while it waits for room; follow `operation.id` until it completes.","operationId":"createSite","requestBody":{"content":{"application/json":{"examples":{"fresh_wordpress_on_corestack":{"summary":"A fresh WordPress install on a Corefinity platform, behind HTTP authentication","value":{"environments":[],"package":"cs4","placement":{"kind":"platform","region":"uk"},"site":{"content":"fresh","domain":"harbourandfinch.example.net","http_auth":true,"php_version":"8.3","platform":"wordpress"}}},"wordpress_on_corestack":{"summary":"An empty WordPress site on a Corefinity platform, with the staging environment its package includes","value":{"environments":[{"included":true,"name":"Staging","uat_size":"xsmall"}],"package":"cs4","placement":{"kind":"platform","region":"uk"},"site":{"content":"empty","domain":"journal.harbourandfinch.example.com","php_version":"8.3","platform":"wordpress"}}}},"schema":{"$ref":"#/components/schemas/SiteCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"cluster":{"id":1009,"kind":"platform","label":"CoreStack","name":"CoreStack","state":"ready","state_label":"Ready"},"company_enabled":false,"credentials":[{"password":"Example-staging-2026","revealed_at":"2026-11-19T09:00:00Z","rule_id":3151,"user_id":3171,"username":"example"}],"environments":[{"environment":{"access_summary":{"apply_state":"applied","company_keys":0,"keys":0,"users":1},"actions":{"attach_domain":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"restore_deleted":{"available":false,"reason":"This site is not deleted"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"journal.harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":false,"primary":"journal.harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1052,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1052,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"applying","hosting":{"cluster_kind":"platform","label":"CoreStack"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1052,"kind":"corestack","lifecycle":"provisioning","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.8"},"mode":"staging","mode_label":"No domain","operation":null,"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"site_id":"rs-northwind-journal-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20031 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20031,"sftp_command":"sftp -P 20031 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20031 web@ssh-northwind.example.net","user":"web","users":1},"tier":"xsmall","uat_size":null,"usage":{"cpu_millicores":180,"disk_used_bytes":2147483648,"memory_bytes":912261120,"observed_at":"2026-11-24T09:10:00Z","source":"live"}},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1009,"name":"CoreStack"},"committed_at":"2026-11-19T09:00:02+00:00","completed_at":null,"created_at":"2026-11-19T09:00:00+00:00","environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1052,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"journal.harbourandfinch.example.com","id":1052},"status":"pending","status_label":"Saving change","steps":[{"key":"reserved","label":"Port and address reserved","state":"done"},{"key":"committed","label":"Saved to the platform","state":"done"},{"key":"picked_up","label":"Picked up by the platform","state":"current"},{"key":"starting","label":"Site started","state":"todo"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New environment Staging","to_version":null,"type":"env_create","type_label":"New environment"}}],"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1009,"name":"CoreStack"},"committed_at":"2026-11-19T09:00:02+00:00","completed_at":null,"created_at":"2026-11-19T09:00:00+00:00","environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"journal.harbourandfinch.example.com","id":1051},"status":"committed","status_label":"Waiting for the platform","steps":[{"key":"reserved","label":"Port and address reserved","state":"done"},{"key":"committed","label":"Saved to the platform","state":"done"},{"key":"picked_up","label":"Picked up by the platform","state":"current"},{"key":"starting","label":"Site started","state":"todo"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New site journal.harbourandfinch.example.com","to_version":null,"type":"provision","type_label":"New site"},"payment":null,"progress_href":"/managed-websites/sites/1051/progress","quote":null,"site":{"access_summary":{"apply_state":"applied","company_keys":0,"keys":0,"users":1},"actions":{"attach_domain":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"restore_deleted":{"available":false,"reason":"This site is not deleted"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"journal.harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":false,"primary":"journal.harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"applying","hosting":{"cluster_kind":"platform","label":"CoreStack"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1051,"kind":"corestack","lifecycle":"provisioning","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.8"},"mode":"staging","mode_label":"No domain","operation":null,"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"site_id":"rs-northwind-journal-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20031 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20031,"sftp_command":"sftp -P 20031 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20031 web@ssh-northwind.example.net","user":"web","users":1},"tier":"cs4","uat_size":null,"usage":{"cpu_millicores":180,"disk_used_bytes":2147483648,"memory_bytes":912261120,"observed_at":"2026-11-24T09:10:00Z","source":"live"}},"state":"creating"},"schema":{"$ref":"#/components/schemas/SiteCreated"}}},"description":"The create has started.","headers":{"Cache-Control":{"description":"Always `no-store, private`: the answer can carry a password.","schema":{"type":"string"}}}},"202":{"content":{"application/json":{"example":{"cluster":{"id":1009,"kind":"platform","label":"CoreStack","name":"CoreStack","state":"ready","state_label":"Ready"},"company_enabled":false,"credentials":[{"password":"Example-staging-2026","revealed_at":"2026-11-19T09:00:00Z","rule_id":3151,"user_id":3171,"username":"example"}],"environments":[{"environment":{"access_summary":{"apply_state":"applied","company_keys":0,"keys":0,"users":1},"actions":{"attach_domain":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"restore_deleted":{"available":false,"reason":"This site is not deleted"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"journal.harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":false,"primary":"journal.harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1052,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1052,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"applying","hosting":{"cluster_kind":"platform","label":"CoreStack"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1052,"kind":"corestack","lifecycle":"provisioning","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.8"},"mode":"staging","mode_label":"No domain","operation":null,"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"site_id":"rs-northwind-journal-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20031 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20031,"sftp_command":"sftp -P 20031 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20031 web@ssh-northwind.example.net","user":"web","users":1},"tier":"xsmall","uat_size":null,"usage":{"cpu_millicores":180,"disk_used_bytes":2147483648,"memory_bytes":912261120,"observed_at":"2026-11-24T09:10:00Z","source":"live"}},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1009,"name":"CoreStack"},"committed_at":"2026-11-19T09:00:02+00:00","completed_at":null,"created_at":"2026-11-19T09:00:00+00:00","environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1052,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"journal.harbourandfinch.example.com","id":1052},"status":"pending","status_label":"Saving change","steps":[{"key":"reserved","label":"Port and address reserved","state":"done"},{"key":"committed","label":"Saved to the platform","state":"done"},{"key":"picked_up","label":"Picked up by the platform","state":"current"},{"key":"starting","label":"Site started","state":"todo"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New environment Staging","to_version":null,"type":"env_create","type_label":"New environment"}}],"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1009,"name":"CoreStack"},"committed_at":"2026-11-19T09:00:02+00:00","completed_at":null,"created_at":"2026-11-19T09:00:00+00:00","environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"journal.harbourandfinch.example.com","id":1051},"status":"pending","status_label":"Saving change","steps":[{"key":"reserved","label":"Port and address reserved","state":"done"},{"key":"committed","label":"Saved to the platform","state":"done"},{"key":"picked_up","label":"Picked up by the platform","state":"current"},{"key":"starting","label":"Site started","state":"todo"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New site journal.harbourandfinch.example.com","to_version":null,"type":"provision","type_label":"New site"},"payment":null,"progress_href":"/managed-websites/sites/1051/progress","quote":null,"site":{"access_summary":{"apply_state":"applied","company_keys":0,"keys":0,"users":1},"actions":{"attach_domain":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"restore_deleted":{"available":false,"reason":"This site is not deleted"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"journal.harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":false,"primary":"journal.harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"applying","hosting":{"cluster_kind":"platform","label":"CoreStack"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1051,"kind":"corestack","lifecycle":"provisioning","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.8"},"mode":"staging","mode_label":"No domain","operation":null,"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"site_id":"rs-northwind-journal-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20031 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20031,"sftp_command":"sftp -P 20031 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20031 web@ssh-northwind.example.net","user":"web","users":1},"tier":"cs4","uat_size":null,"usage":{"cpu_millicores":180,"disk_used_bytes":2147483648,"memory_bytes":912261120,"observed_at":"2026-11-24T09:10:00Z","source":"live"}},"state":"capacity_being_added"},"schema":{"$ref":"#/components/schemas/SiteCreated"}}},"description":"The create is accepted and has not started yet. `state` is `capacity_being_added` while it waits for room to be added; otherwise it is `creating` and the operation is still `pending`.","headers":{"Cache-Control":{"description":"Always `no-store, private`: the answer can carry a password.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"billing_forbidden":{"summary":"The site needs the company's billing, which you may not use","value":{"code":"billing_forbidden","message":"Billing is available to your company's owner and billing contacts.","reason":"billing_forbidden"}},"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"You may not create sites for this company","value":{"code":"forbidden","message":"You cannot create sites for this company.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), two-factor authentication is required and not set up\n(`two_factor_required`), you may not create sites for this company (`forbidden`), or you may not use its\nbilling (`billing_forbidden`).\n"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"Site creation is not on for your company (`feature_off`), or `placement.cluster_id` is not a CoreCluster you can create in."},"409":{"content":{"application/json":{"examples":{"cleaning_up":{"summary":"A site of this domain is still being removed","value":{"code":"cleaning_up","message":"This site is being cleaned up. Try again in a minute.","reason":"cleaning_up"}},"duplicate":{"summary":"The domain is already a site in the same place","value":{"code":"duplicate","message":"A site with this domain already exists in this cluster","reason":"duplicate"}},"hosted_elsewhere":{"summary":"The domain is already a site somewhere else on the platform","value":{"code":"duplicate","message":"This domain is already hosted on the platform","reason":"duplicate"}},"no_payment_method":{"value":{"code":"no_payment_method","message":"Add a card or a Direct Debit mandate first","reason":"no_payment_method"}},"no_platform_cluster":{"value":{"code":"no_platform_cluster","message":"UK is not set up for CoreStack yet. Choose another region","reason":"no_platform_cluster"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The create conflicts with the current state, and nothing was created. `reason` says how: `duplicate` (the\ndomain is already a site here, or is hosted somewhere else on the platform), `cleaning_up` (a site of this\ndomain is still being removed; try again in a minute), `no_payment_method` or `no_platform_cluster`.\nOther reasons mean the region or the CoreCluster cannot take the site at the moment, and `message` says\nwhat to do: `platform_not_ready`, `compute_blocked`, `region_unavailable`, `package_restricted`,\n`storage_blocked`, `storage_tier_missing`, `tier_not_ready`, `cluster_not_ready`, `not_v3`,\n`not_configured` and `stale`.\n"},"422":{"content":{"application/json":{"examples":{"not_part_of_request":{"summary":"A field the API does not take","value":{"code":"invalid","errors":{"trial":["This request contains a field that is not part of it."]},"field":"trial","message":"This request contains a field that is not part of it.","reason":"invalid"}},"tier_on_a_platform":{"summary":"A size sent where the package sets it","value":{"code":"invalid","errors":{"site.tier":["The package sets the size"]},"field":"site.tier","message":"The package sets the size","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`), or a rule of the create refuses it with a reason of its own, naming the field. `billing_account_id` and `trial` are never part of an API create."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/SiteCreatePlatformUnreadable"},"503":{"$ref":"#/components/responses/SiteCreateVersionsUnavailable"}},"summary":"Create a site","tags":["Create a site"],"x-effect":["billable"],"x-feature":"site-create","x-file":"app-versions","x-gates":["app_versions_api","corestack_create"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-site-create","limit":100,"minutes":60},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"To be shown the generated HTTP authentication passwords in `credentials`. Without it the create still succeeds and each password is null"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"One site or environment, with its platform, versions, size, usage, health, addresses and what you can do with it.","operationId":"getSite","responses":{"200":{"content":{"application/json":{"examples":{"site":{"$ref":"#/components/examples/SiteDetailExample"}},"schema":{"$ref":"#/components/schemas/SiteAnswer"}}},"description":"The site."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site","tags":["Sites"],"x-feature":"sites","x-file":"sites","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"delete":{"description":"Deletes the row `{site}` names, once the request carries the typed confirmation that row takes: the body's\nfields say which. It answers the operation to follow.\n","operationId":"deleteSite","requestBody":{"content":{"application/json":{"examples":{"environment":{"summary":"Delete one environment","value":{"confirm_name":"Staging"}},"site":{"summary":"Delete a site","value":{"confirm_domain":"harbourandfinch.example.com"}}},"schema":{"$ref":"#/components/schemas/SiteDeleteRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"queued":{"summary":"Waiting for external database access to be turned off","value":{"held_delete_id":3120,"message":"Turning off external access, then deleting.","reason":"external_db_delete_queued","turn_off_operation_id":5119}},"started":{"summary":"The delete has started","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-14T10:00:00Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"label":"Site stopped","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"rolling_out","status_label":"Stopping the site","step":"stopped","steps":[{"key":"snapshot","label":"Final snapshot taken","state":"done"},{"key":"stopped","label":"Site stopped","state":"current"},{"key":"hidden","label":"Hidden","state":"todo"}],"summary":"Delete harbourandfinch.example.com","to_version":null,"type":"delete","type_label":"Delete site"},"site":{"deleted":{"at":"2026-11-14T10:00:00Z","by":{"id":2041,"name":"Eleanor Finch"},"final_snapshot_id":3301,"purge_at":"2026-11-21T10:00:00Z"},"domain":"harbourandfinch.example.com","health":"applying","id":1042,"kind":"corecluster","lifecycle":"deleted","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"mariadb":{"version":"11.8"},"mode":"production","mode_label":"Domain attached","operation":null,"php":{"version":"8.3"},"primary_url":"https://harbourandfinch.example.com","removed":false,"tier":"S","usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}}}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/SiteDeleteAccepted"},{"$ref":"#/components/schemas/SiteDeleteQueued"}]}}},"description":"The delete has started: the row and the operation to follow. When external database access has to be turned\noff first, the answer is instead a message with the reason `external_db_delete_queued` and no operation; the\ndelete then starts by itself.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound","description":"The row does not exist or is not yours to delete, or deleting this kind of row is not on for your company."},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change to the site is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"clone_in_progress":{"summary":"A copy from the environment is still running","value":{"code":"clone_in_progress","message":"A copy from this environment is in progress. Wait for it to finish.","reason":"clone_in_progress"}},"cluster_deleting":{"summary":"The CoreCluster is being deleted","value":{"code":"cluster_deleting","message":"This cluster is being deleted","reason":"cluster_deleting"}},"cluster_paused":{"summary":"Changes are paused for planned maintenance","value":{"code":"cluster_paused","message":"Changes on this site are paused for planned maintenance; please try again later.","reason":"cluster_paused"}},"deleted":{"summary":"The site is already deleted","value":{"code":"deleted","message":"This site is already deleted","reason":"deleted"}},"environment_deleted":{"summary":"The environment is already being deleted","value":{"code":"deleted","message":"This environment is already being deleted","reason":"deleted"}},"has_environments":{"summary":"The site still has environments","value":{"code":"has_environments","message":"This site still has 1 environment. Delete it first, then delete the site.","reason":"has_environments"}},"is_production":{"summary":"An environment's confirmation sent for the production row","value":{"code":"is_production","message":"The production environment is the site. Delete the site instead.","reason":"is_production"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The delete cannot start now. `reason` says why. `cluster_paused` means Corefinity has paused changes for\nplanned maintenance: the message says until when, if that is known.\n"},"422":{"content":{"application/json":{"examples":{"environment":{"summary":"The environment's name does not match","value":{"code":"confirm_mismatch","errors":{"confirm_name":["Type the environment's name exactly to confirm"]},"field":"confirm_name","message":"Type the environment's name exactly to confirm","reason":"confirm_mismatch"}},"site":{"summary":"The domain does not match","value":{"code":"confirm_mismatch","errors":{"confirm_domain":["Type the site's domain exactly to confirm the deletion"]},"field":"confirm_domain","message":"Type the site's domain exactly to confirm the deletion","reason":"confirm_mismatch"}}},"schema":{"$ref":"#/components/schemas/ConfirmMismatchRefusal"}}},"description":"The confirmation is missing or does not match. Both answer `confirm_mismatch`, and `field` names the\nconfirmation to send.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"example":{"message":"The site could not be read for its final snapshot. Try again in a minute."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The site could not be read to take its final snapshot. Nothing has been deleted and no operation has\nstarted: send the request again in a minute.\n"},"503":{"$ref":"#/components/responses/SwitchedOff"}},"summary":"Delete a site","tags":["Sites"],"x-effect":["deletes"],"x-feature":"sites","x-file":"sites","x-gates":["delete","provisioning"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-go-live","limit":5,"minutes":1},"x-scope":"destructive","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/access":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers how to connect to the site or environment, its users with their keys, the company keys that reach it,\nand ready `ssh`, `sftp`, `rsync` and database tunnel commands for the built-in `web` user. While SSH keys are\non for your company it also answers the usernames and host keys, and `web` lists every key that can log in as\nit.\n","operationId":"getSiteAccess","responses":{"200":{"content":{"application/json":{"examples":{"access":{"$ref":"#/components/examples/SiteAccessExample"}},"schema":{"$ref":"#/components/schemas/SiteAccess"}}},"description":"The site's access."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's SSH and SFTP access","tags":["Access"],"x-feature":"access","x-file":"access","x-gates":["access"],"x-rate-limit":{"bucket":"reseller-access-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/access/keys/{key}":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/siteAccessKey"}],"delete":{"description":"Removes a key of one of the site's users. `confirm_fingerprint` is optional; when you send it, it must be the\nkey's fingerprint. On the built-in `web` user, only a key the list marks `can_delete` is removed here,\nanswered as `DELETE /ssh/keys/{key}` answers and counted against the limit on key changes (30 a minute for\nyou, 120 for your company); company, website and personal keys are removed where they were added.\n","operationId":"deleteSiteAccessKey","requestBody":{"content":{"application/json":{"examples":{"confirmed":{"summary":"Remove a named user's key, naming its fingerprint","value":{"confirm_fingerprint":"SHA256:KhDfvkk2rdhCA9zaR3SurL80w/B/MbslK5FOxIaEpY0"}},"web_user":{"summary":"Remove a key of the built-in user","value":{}}},"schema":{"$ref":"#/components/schemas/SiteAccessKeyDeleteRequest"}}},"required":false},"responses":{"202":{"content":{"application/json":{"examples":{"named_user":{"$ref":"#/components/examples/SiteAccessKeyRemovedExample"},"web_user":{"summary":"A key of the built-in user","value":{"change_id":48217,"remaining_sources":[]}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/SiteAccessKeyChanged"},{"$ref":"#/components/schemas/SshKeyRemoved"}]}}},"description":"The removal was started. For a named user's key the answer is the key, with the status `removing`, and its\n`operation`. For a key of the built-in `web` user, while SSH keys are on, it is a `change_id`.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteAccessWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteAccessConflict"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"The typed fingerprint is not the key's","value":{"code":"confirm_mismatch","errors":{"confirm_fingerprint":["Type the key's fingerprint exactly to remove it."]},"field":"confirm_fingerprint","message":"Type the key's fingerprint exactly to remove it.","reason":"confirm_mismatch"}},"not_json":{"summary":"A body that is not valid JSON","value":{"code":"invalid_arguments","errors":{"body":["The request body is not valid JSON."]},"field":"body","message":"The request body is not valid JSON.","reason":"invalid_arguments"}},"person_login":{"summary":"A key of a person's own SSH username","value":{"code":"ssh_person_managed_elsewhere","field":null,"message":"That username belongs to a person and is managed in their profile.","reason":"ssh_person_managed_elsewhere"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/FieldRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`confirm_fingerprint` is not the key's fingerprint (`confirm_mismatch`), the request body is not valid JSON\n(`invalid_arguments` on `body`), or the key belongs to a person's own SSH username\n(`ssh_person_managed_elsewhere`).\n"},"429":{"$ref":"#/components/responses/SiteAccessKeyTooManyRequests"},"502":{"$ref":"#/components/responses/UpstreamFailed"},"503":{"$ref":"#/components/responses/SiteAccessNotReady"}},"summary":"Delete a user's key","tags":["Access"],"x-effect":["deletes"],"x-feature":"access","x-file":"access","x-gates":["access"],"x-long-running":"getSiteAccessOperation","x-rate-limit":{"also":[{"bucket":"ssh-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"ssh-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"reseller-access-changes","limit":30,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/access/operations/{operation}":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/siteAccessOperation"}],"get":{"description":"Answers a change to the site's users or keys. Read it again until `status` is `completed` or `failed`. Only\noperations of this site, of the types `users_change` and `keys_change`, are answered here.\n","operationId":"getSiteAccessOperation","responses":{"200":{"content":{"application/json":{"examples":{"completed":{"$ref":"#/components/examples/SiteAccessOperationExample"}},"schema":{"properties":{"operation":{"$ref":"#/components/schemas/Operation"}},"required":["operation"],"type":"object"}}},"description":"The operation."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an access operation","tags":["Access"],"x-feature":"access","x-file":"access","x-gates":["access"],"x-rate-limit":{"bucket":"reseller-access-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/access/users":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Adds a named user to the site or environment: `ssh` for SSH and SFTP over the whole site, or `sftp` for SFTP\nonly, limited to one folder. A generated password is in this answer and nowhere else, so asking for one also\nneeds the `exec` scope.\n","operationId":"createSiteAccessUser","requestBody":{"content":{"application/json":{"examples":{"sftp_generated_password":{"summary":"An SFTP user limited to the uploads folder, with a generated password","value":{"label":"Photographer","password":"generate","root_path":"htdocs/wp-content/uploads","type":"sftp","username":"photographer"}},"ssh_keys_only":{"summary":"An SSH user that signs in with keys only","value":{"label":"Web agency","type":"ssh","username":"agency"}}},"schema":{"$ref":"#/components/schemas/SiteAccessUserCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"created":{"$ref":"#/components/examples/SiteAccessUserCreatedExample"}},"schema":{"$ref":"#/components/schemas/SiteAccessUserCreated"}}},"description":"The user was added and the change is being applied. Follow `operation.id` with\n`GET /corestack/sites/{site}/access/operations/{operation}`. `password` holds a generated password, once;\nthe answer is sent with `Cache-Control: no-store`.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteAccessWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteAccessConflict"},"422":{"$ref":"#/components/responses/SiteAccessUserInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/UpstreamFailed"},"503":{"$ref":"#/components/responses/SiteAccessNotReady"}},"summary":"Create an SSH or SFTP user","tags":["Access"],"x-effect":["changes-settings","reveals-secret"],"x-feature":"access","x-file":"access","x-gates":["access"],"x-long-running":"getSiteAccessOperation","x-rate-limit":{"bucket":"reseller-access-changes","limit":30,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"The body asks for a generated password (`password` is `generate`)"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/access/users/{user}":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/siteAccessUser"}],"patch":{"description":"Changes a named user's `type`, `root_path`, `label` or password; send only what changes. A change of the label\nalone answers at once, with no operation, and the built-in `web` user cannot be changed.\n","operationId":"updateSiteAccessUser","requestBody":{"content":{"application/json":{"examples":{"label":{"summary":"Change the label","value":{"label":"Print supplier (Leeds)"}},"limit_to_sftp":{"summary":"Limit the user to SFTP in one folder","value":{"root_path":"htdocs/wp-content/uploads","type":"sftp"}},"new_password":{"summary":"Give the user a generated password","value":{"password":"generate"}}},"schema":{"$ref":"#/components/schemas/SiteAccessUserUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"label":{"$ref":"#/components/examples/SiteAccessUserLabelledExample"},"password":{"$ref":"#/components/examples/SiteAccessUserUpdatedExample"}},"schema":{"$ref":"#/components/schemas/SiteAccessUserUpdated"}}},"description":"The user as it is now. `operation` is sent when a change is being applied, and `password` when one was\ngenerated. The answer is sent with `Cache-Control: no-store`.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteAccessWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteAccessConflict"},"422":{"$ref":"#/components/responses/SiteAccessUserInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/UpstreamFailed"},"503":{"$ref":"#/components/responses/SiteAccessNotReady"}},"summary":"Update an SSH or SFTP user","tags":["Access"],"x-effect":["changes-settings","reveals-secret"],"x-feature":"access","x-file":"access","x-gates":["access"],"x-long-running":"getSiteAccessOperation","x-rate-limit":{"bucket":"reseller-access-changes","limit":30,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"The body asks for a generated password (`password` is `generate`)"}],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes a named user and its keys. `confirm_username` is optional; when you send it, it must be the user's\nusername. The built-in `web` user cannot be removed.\n","operationId":"deleteSiteAccessUser","requestBody":{"content":{"application/json":{"examples":{"confirmed":{"summary":"Remove the user, naming it","value":{"confirm_username":"supplier"}}},"schema":{"$ref":"#/components/schemas/SiteAccessUserDeleteRequest"}}},"required":false},"responses":{"202":{"content":{"application/json":{"examples":{"removing":{"$ref":"#/components/examples/SiteAccessUserRemovedExample"}},"schema":{"$ref":"#/components/schemas/SiteAccessUserRemoved"}}},"description":"The removal was started. `user.status` is `removing` until the operation completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteAccessWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteAccessConflict"},"422":{"content":{"application/json":{"examples":{"built_in":{"summary":"The built-in user","value":{"code":"invalid","message":"This user cannot be changed","reason":"invalid"}},"confirm_mismatch":{"summary":"The typed username is not the user's","value":{"code":"confirm_mismatch","errors":{"confirm_username":["Type the user's username exactly to delete it."]},"field":"confirm_username","message":"Type the user's username exactly to delete it.","reason":"confirm_mismatch"}},"not_json":{"summary":"A body that is not valid JSON","value":{"code":"invalid_arguments","errors":{"body":["The request body is not valid JSON."]},"field":"body","message":"The request body is not valid JSON.","reason":"invalid_arguments"}},"person_login":{"summary":"A person's own SSH username","value":{"code":"ssh_person_managed_elsewhere","field":null,"message":"That username belongs to a person and is managed in their profile.","reason":"ssh_person_managed_elsewhere"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/FieldRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The built-in user cannot be removed (`invalid`), the username is a person's own SSH username\n(`ssh_person_managed_elsewhere`), `confirm_username` is not the user's username (`confirm_mismatch`), or\nthe request body is not valid JSON (`invalid_arguments` on `body`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/UpstreamFailed"},"503":{"$ref":"#/components/responses/SiteAccessNotReady"}},"summary":"Delete an SSH or SFTP user","tags":["Access"],"x-effect":["deletes"],"x-feature":"access","x-file":"access","x-gates":["access"],"x-long-running":"getSiteAccessOperation","x-rate-limit":{"bucket":"reseller-access-changes","limit":30,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/access/users/{user}/keys":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/siteAccessUser"}],"post":{"description":"Adds a public key to one of the site's users. A key added to the built-in `web` user, while SSH keys are on\nfor your company, is a key for the whole environment: it is answered as `POST /ssh/keys` answers, followed\nwith `GET /ssh/changes/{change}`, and counts against the limit on key changes (30 a minute for you, 120 for\nyour company).\n","operationId":"createSiteAccessUserKey","requestBody":{"content":{"application/json":{"examples":{"named_user":{"summary":"A key for a named user","value":{"key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAAAExampleKeyOnlyDoNotUseThisIsNotARealKey6 supplier@desktop","name":"Supplier desktop"}},"web_user":{"summary":"A key for the built-in user","value":{"key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAAAExampleKeyOnlyDoNotUseThisIsNotARealKey2","name":"Build server"}}},"schema":{"$ref":"#/components/schemas/SiteAccessKeyCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"named_user":{"$ref":"#/components/examples/SiteAccessKeyAddedExample"},"web_user":{"$ref":"#/components/examples/SiteAccessWebKeyAddedExample"}},"schema":{"anyOf":[{"$ref":"#/components/schemas/SiteAccessKeyChanged"},{"$ref":"#/components/schemas/SshKeySaved"}]}}},"description":"The key was added. For a named user the answer is the key and its `operation`. For the built-in `web`\nuser, while SSH keys are on, it is the environment key with a `change_id`.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteAccessWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteAccessConflict"},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"No key was sent","value":{"code":"invalid","errors":{"key":["The key field is required."]},"field":"key","message":"The key field is required.","reason":"invalid"}},"not_a_key":{"summary":"Not a public key","value":{"code":"invalid","message":"Paste the public key in OpenSSH format (one line starting with ssh-ed25519, ecdsa-sha2-nistp256/384/521 or ssh-rsa)","reason":"invalid"}},"too_long":{"summary":"A key of more than 16,384 bytes","value":{"code":"invalid","message":"That is too long to be a public key","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"A field is missing or wrong (`invalid`, with the `field`), the key cannot be used or the user already has\n50 keys (`invalid`, with a message that says why, such as a private key, a weak key or one already added\nto this user), or the user is a person's own SSH username (`ssh_person_managed_elsewhere`). For the\nbuilt-in `web` user, while SSH keys are on, the refusals are those of `POST /ssh/keys`.\n"},"429":{"$ref":"#/components/responses/SiteAccessKeyTooManyRequests"},"502":{"$ref":"#/components/responses/UpstreamFailed"},"503":{"$ref":"#/components/responses/SiteAccessNotReady"}},"summary":"Create a key for a user","tags":["Access"],"x-effect":["changes-settings"],"x-feature":"access","x-file":"access","x-gates":["access"],"x-long-running":"getSiteAccessOperation","x-rate-limit":{"also":[{"bucket":"ssh-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"ssh-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"reseller-access-changes","limit":30,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/activity":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"The activity feed of one site or environment, newest first. Paged by `before`: send the answer's `next_before`\nand `next_before_id` back as `before` and `before_id`, together; null means the last page.\n","operationId":"listSiteActivity","parameters":[{"$ref":"#/components/parameters/cursorLimit"},{"description":"The `next_before` of the previous answer, a time in epoch milliseconds. Send it with `before_id`.","in":"query","name":"before","required":false,"schema":{"pattern":"^\\d{1,16}$","type":"string"}},{"description":"The `next_before_id` of the previous answer, such as `operation:5120`. Send it with `before`.","in":"query","name":"before_id","required":false,"schema":{"type":"string"}},{"description":"Only these kinds of activity, for example `kinds[]=operation&kinds[]=deployment`.","in":"query","name":"kinds[]","required":false,"schema":{"items":{"enum":["operation","command","deployment","restore","snapshot","terminal","pagespeed","audit","copy"],"type":"string"},"type":"array"}},{"description":"Send `1` for only what is still running; `0`, or leaving it out, lists everything. The words `true` and `false` are refused `422`.","example":1,"in":"query","name":"unfinished","required":false,"schema":{"enum":[0,1],"type":"integer"}},{"description":"`mcp` for only what an AI assistant did, `panel` for everything else.","in":"query","name":"origin","required":false,"schema":{"enum":["mcp","panel"],"type":"string"}},{"description":"Only what one actor did. `u` followed by a user id, `schedule` or `corefinity`.","in":"query","name":"actor","required":false,"schema":{"pattern":"^(schedule|corefinity|u\\d{1,18})$","type":"string"}},{"description":"Only items with this result.","in":"query","name":"result","required":false,"schema":{"enum":["succeeded","failed","running"],"type":"string"}},{"description":"Only items at or after this date or time.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Only items before this date or time. The bound is exclusive: an item at exactly this moment is left out\n(`from` includes its own moment).\n","in":"query","name":"to","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"actor":{"id":2041,"name":"Eleanor Finch"},"at":"2026-11-14T09:12:03Z","cluster":{"id":1017,"name":"Northwind UK 1"},"environment":null,"href":"/managed-clusters/sites/1042#activity","id":"operation:5120","kind":"operation","origin":"panel","ref":{"id":5120,"type":"operation"},"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"completed","status_label":"Done","summary":"Scheduled tasks","title":"Scheduled tasks","unfinished":false}],"next_before":null,"next_before_id":null},"schema":{"$ref":"#/components/schemas/ActivityPage"}}},"description":"One page of activity."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"before_id":["Send before and before_id together."]},"field":"before_id","message":"Send before and before_id together.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A filter value is not allowed, or only one of `before` and `before_id` was sent (`field` names the one that is missing)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's activity","tags":["Sites"],"x-feature":"resources","x-file":"sites","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/addons":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"Sets the site's four add-on allowances (extra cores, memory, disk and log storage) to the totals sent, so `0`\nremoves an add-on; the site is billed for them from the hour the change starts. The ceilings and steps are in\nthe site's upgrade options (`addons.max`, `addons.unit`), and a change of log storage alone applies at once.\n","operationId":"updateSiteAddons","requestBody":{"content":{"application/json":{"examples":{"cores":{"summary":"Two extra cores","value":{"cores":2,"disk_gb":0,"log_storage_gb":0,"memory_gb":0}}},"schema":{"$ref":"#/components/schemas/UpgradeSiteAddonsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"started":{"$ref":"#/components/examples/UpgradeSiteAddonsExample"}},"schema":{"$ref":"#/components/schemas/UpgradeSiteChange"}}},"description":"The change has started, or is queued, in which case `queued` is `true`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/UpgradeWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"same_addons":{"summary":"The site holds these add-ons already","value":{"code":"same_addons","message":"These are already the site's add-ons","reason":"same_addons"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was changed. `same_addons`: the site holds these add-ons already. `stale`: the price has moved\nsince the quote. `cluster_site`: the site is inside a CoreCluster, which holds the add-ons.\n`no_payment_method`: the billing account has no card or mandate. `not_resizable`, `disk_not_growable`:\nthe site's allowances or disk cannot be changed here: contact support. `compute_blocked`: there is no\nroom for that capacity at the moment. `busy`, `snapshot_running`, `provisioning`, `deleted`: another\nchange or a snapshot is running, or the site is being created or deleted. `change_pending`: another\nchange of yours already waits for the night: apply it now or cancel it. `demo_keep_required`: the site\nis a demo that has not been kept (the answer adds `keep_url` and `change`). `managed_elsewhere`: the\nsite is managed by another control panel.\n"},"422":{"content":{"application/json":{"examples":{"addon_bounds":{"$ref":"#/components/examples/UpgradeAddonBoundsExample"},"missing":{"$ref":"#/components/examples/UpgradeAddonsMissingExample"},"tonight_off":{"summary":"Tonight, while changes cannot wait for the night","value":{"code":"feature_off","errors":{"apply":["Queuing changes for the maintenance window is switched off at the moment"]},"message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`invalid`: a field is missing or wrong (`field` names it); on `disk_gb` that is also a disk allowance\nsmaller than the data the site holds, and on `cores` the id of an environment, which has no add-ons of\nits own. `addon_bounds`: an allowance is above its ceiling or off its step (an allowance the site holds\nalready is never refused for its size). `feature_off`: `apply: tonight` while changes cannot wait for\nthe night.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"not_saved":{"summary":"The platform did not save the change","value":{"message":"The change could not be saved. Contact support."}},"settings_unreadable":{"summary":"The site's settings could not be read","value":{"code":"upstream_unavailable","message":"The site's settings could not be read; try again shortly.","reason":"upstream_unavailable"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The platform did not answer, or did not save the change. Send the request again in a minute. When the\nsite's settings could not be read the answer is `upstream_unavailable`; when the change could not be\nsaved it is a sentence only, with no `reason`.\n"}},"summary":"Update a site's add-ons","tags":["Packages and capacity"],"x-effect":["billable"],"x-feature":"upgrades","x-file":"upgrades","x-gates":["billing"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-upgrades","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/admin-login/reset":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Sets a new password for an administrator of a WordPress, Magento 2 or Shopware site and answers it once. Leave\n`username` out to reset the administrator the site's current database was created with. The reset runs as one of\nthe site's platform tools, so its limits and refusals are a tool run's.\n","operationId":"resetSiteAdminLogin","requestBody":{"content":{"application/json":{"examples":{"current":{"summary":"Reset the administrator the site was created with","value":{"confirm":true}},"named":{"summary":"Reset a named administrator","value":{"confirm":true,"username":"shop-admin"}}},"schema":{"$ref":"#/components/schemas/EnvironmentAdminLoginResetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"command":{"blocked_until_verified":false,"duration_ms":840,"error":null,"exit_code":0,"finished_at":"2026-11-10T00:59:43Z","id":5122,"input":null,"kind":"wp_admin_reset","label":"Reset admin password","operation_id":null,"output_excerpt":null,"queued_at":"2026-11-10T00:59:43Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-10T00:59:42Z","status":"succeeded","status_label":"Done"},"secret":{"password":"Example-new-password-1","revealed_at":"2026-11-10T00:59:43+00:00","url":"https://harbourandfinch.example.com/wp-admin/","username":"shop-admin"}},"schema":{"$ref":"#/components/schemas/EnvironmentAdminLoginReset"}}},"description":"The password was reset. `secret` holds it, once."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"A change is being applied to the site","value":{"code":"busy","message":"A change is being applied to this site. Wait for it to finish.","reason":"busy"}},"command_running":{"summary":"Another command is still running on the site","value":{"code":"command_running","message":"Another action is still running on this site. Wait for it to finish.","reason":"command_running"}},"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"exec_unresolved":{"summary":"An earlier command was never confirmed stopped","value":{"code":"exec_unresolved","message":"A previous command on this site has not been confirmed stopped. Contact support.","reason":"exec_unresolved"}},"managed_elsewhere":{"summary":"Another control panel manages the site","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_available":{"summary":"A platform with no administrator","value":{"code":"not_available","message":"Laravel sites have no CMS administrator to reset.","reason":"not_available"}},"not_running":{"summary":"The site is not running normally","value":{"code":"not_running","message":"The site is not running normally. Try again once it has recovered.","reason":"not_running"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The reset cannot run. `reason` says why: `not_available` (the platform has no administrator to reset, such as\nLaravel), `managed_elsewhere`, `deleted`, `provisioning`, `not_running`, `busy` (a change is being applied\nto the site), `command_running` (another command is still running on it) or `exec_unresolved` (an earlier\ncommand was never confirmed stopped; contact support).\n"},"422":{"content":{"application/json":{"examples":{"confirm":{"summary":"No confirmation","value":{"code":"invalid","errors":{"confirm":["Confirm the action"]},"field":"confirm","message":"Confirm the action","reason":"invalid"}},"name_it":{"summary":"No administrator named or known","value":{"code":"invalid","errors":{"username":["Name the administrator to reset"]},"field":"username","message":"Name the administrator to reset.","reason":"invalid"}},"username_format":{"summary":"A username the platform does not take","value":{"code":"invalid","errors":{"username":["The username format is invalid."]},"field":"username","message":"The username format is invalid.","reason":"invalid"}},"username_long":{"summary":"A Shopware username over 32 characters","value":{"code":"invalid","errors":{"username":["The username may not be greater than 32 characters.","The username format is invalid."]},"field":"username","message":"The username may not be greater than 32 characters. (and 1 more error)","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`username` is left out and the site has no known administrator, `username` is not one the platform takes, or `confirm` is not true."},"429":{"content":{"application/json":{"example":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many runs: more than 20 a minute, counted together with your other platform tool runs. Wait for `Retry-After` seconds. A reset has no hourly limit of its own."},"503":{"$ref":"#/components/responses/CommandsSwitchedOff"}},"summary":"Reset an administrator's password","tags":["Platform tools"],"x-effect":["runs-code","reveals-secret"],"x-feature":"functions","x-file":"environments","x-gates":["functions"],"x-rate-limit":{"bucket":"reseller-functions","limit":20,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/app-version":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the line and version a site runs, when its line ends, and the line to move to when it is ending.","operationId":"getSiteAppVersion","responses":{"200":{"content":{"application/json":{"example":{"built_for_only":false,"content":"fresh","created_for":"7.0.7","days_left":null,"detected":null,"differs":false,"display_version":"7.0.7","edition":null,"edition_label":null,"eol_since":null,"eol_stage":"none","installed_version":"7.0.7","line":"7.0","line_label":"WordPress 7.0","next":[],"next_line":null,"platform":"wordpress","recognition":"line","security_until":null,"status":"security"},"schema":{"$ref":"#/components/schemas/AppVersionOfSite"}}},"description":"The site's version."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/AppVersionCatalogueUnavailable"}},"summary":"Get a site's application version","tags":["Application versions"],"x-feature":"app-versions","x-file":"app-versions","x-gates":["app_versions_api","app_versions"],"x-rate-limit":{"bucket":"corecluster-app-versions-site","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/corestack/sites/{site}/attach-domain":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Takes the site or environment live on the hostnames you send. `confirm_domain` is the site's domain on\nproduction, or the domain you are attaching on any other environment, typed exactly. With `point_dns` the DNS\nrecords are written in your connected Cloudflare account before the attach starts, and each record written\ncounts against your company's 60 Cloudflare changes an hour.\n","operationId":"attachSiteDomain","requestBody":{"content":{"application/json":{"examples":{"www_canonical":{"summary":"Attach a domain served on its www form","value":{"canonical":"www.harbourandfinch.example.org","confirm_domain":"harbourandfinch.example.org","hosts":["harbourandfinch.example.org","www.harbourandfinch.example.org"],"www":"www"}}},"schema":{"$ref":"#/components/schemas/AttachDomainRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"started":{"$ref":"#/components/examples/AttachDomainStarted"}},"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"The attach started. Follow it by `id`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"already_attached":{"summary":"The environment already has a domain","value":{"code":"already_attached","message":"This environment already has a domain. Change it in the Domains tab.","reason":"already_attached"}},"not_connected":{"summary":"point_dns for a hostname the connection cannot write","value":{"code":"not_connected","message":"Connect the domain's Cloudflare zone first, or update DNS yourself","reason":"not_connected"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`already_attached`, `busy`, `deleted`, `not_ready`, `not_running`, `not_available` (the platform cannot\nattach a domain yet), `platform_plugins_off`, `platform_plugins_applying`, `store_hosts`,\n`cli_move_build_raise` or `managed_elsewhere`. With `point_dns`, also `not_connected` (a hostname is not\none your Cloudflare connection can write, or the connection is not working), `no_zone` (no hostname is in\na connected zone, or Cloudflare is off for the site) and `busy` (another Cloudflare change for the\ncompany is running).\n"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"The domain was not typed exactly","value":{"code":"confirm_mismatch","errors":{"confirm_domain":["Type the site's domain exactly to confirm"]},"field":"confirm_domain","message":"Type the site's domain exactly to confirm","reason":"confirm_mismatch"}},"confirm_replacements":{"summary":"point_dns would replace existing records","value":{"code":"confirm_replacements","errors":{"confirm_replacements":["Existing DNS records would be replaced. Confirm to continue."]},"message":"Existing DNS records would be replaced. Confirm to continue.","reason":"confirm_replacements"}},"dns_not_ready":{"summary":"DNS does not point at the platform yet","value":{"code":"invalid","errors":{"hosts":["DNS does not point at the platform yet"]},"field":"hosts","message":"DNS does not point at the platform yet","reason":"invalid"}},"too_many":{"summary":"point_dns would change more than 20 records","value":{"code":"too_many","errors":{"hosts":["Too many DNS changes in one go. Point the hosts in two steps."]},"message":"Too many DNS changes in one go. Point the hosts in two steps.","reason":"too_many"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"`confirm_mismatch` (the domain was not typed exactly) or `invalid`: a field is missing or wrong, DNS does\nnot point at the platform yet (`errors.hosts`), or a hostname behind Cloudflare needs\n`proxied_records_checked` (`errors.proxied_records_checked`). With `point_dns`, also\n`confirm_replacements` (existing DNS records would be replaced: send `confirm_replacements`; the check's\n`dns_plan` shows which) and `too_many` (more than 20 record changes in one go). Those two name the field\nin `errors` and carry no `field`.\n"},"429":{"content":{"application/json":{"examples":{"hour_spent":{"summary":"The company's hour of Cloudflare changes is spent","value":{"code":"rate_limited","message":"Too many Cloudflare changes this hour. Try again later.","reason":"rate_limited"}},"rate_limited":{"summary":"The endpoint's request limit is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests (`rate_limited`): the endpoint's request limit, answered with `Retry-After` and\n`retry_after_seconds`, or, with `point_dns`, your company's 60 Cloudflare changes this hour, which the\nControl Panel and AI assistants spend too. That second refusal names no wait here: neither the header\nnor `retry_after_seconds` is sent. The hour is counted from each change, so try again later.\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"500":{"$ref":"#/components/responses/DomainCommandsSwitchedOffError"},"502":{"$ref":"#/components/responses/DomainUpstreamFailed","description":"A check or a write outside the Control Panel could not run, or, with `point_dns`, some DNS records could\nnot be written at Cloudflare. Nothing is undone: send the request again.\n"}},"summary":"Attach a domain to a site","tags":["Domains"],"x-effect":["changes-settings","overwrites","runs-code"],"x-feature":"domains","x-file":"domains","x-gates":["provisioning"],"x-long-running":"getOperation","x-rate-limit":{"also":[{"bucket":"reseller-cloudflare-writes","limit":60,"minutes":60,"per":"company"}],"bucket":"reseller-go-live","limit":5,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/attach-domain/check":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Answers whether every hostname is ready to attach and what is missing. `blockers` lists what would refuse the\nattach whatever DNS says. Nothing changes.\n","operationId":"checkSiteAttachDomain","requestBody":{"content":{"application/json":{"examples":{"www_canonical":{"summary":"A domain served on its www form","value":{"canonical":"www.harbourandfinch.example.org","hosts":["harbourandfinch.example.org","www.harbourandfinch.example.org"],"www":"www"}}},"schema":{"$ref":"#/components/schemas/AttachDomainCheckRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"proxied":{"summary":"A hostname behind Cloudflare that cannot be checked","value":{"advice":null,"blockers":[],"canonical":"harbourandfinch.example.org","dns_plan":{"actions":[],"can_apply":false,"requires_confirmation":false,"zone":null},"hosts":[{"cloudflare_zone":null,"dns_answers":[{"type":"A","value":"198.51.100.21"}],"dns_checked_at":"2026-11-02T15:25:00Z","dns_detail":"proxied_unconfirmed","dns_state":"unknown","dns_state_since":null,"expected_ip":"203.0.113.10","host":"harbourandfinch.example.org","noindex":false,"ok":false,"problems":["Proxied by Cloudflare: the address behind it can't be checked from here. Make sure the Cloudflare record points at 203.0.113.10."],"redirects_to":null,"role":"primary","tls":{"checked_at":null,"issuer":null,"not_after":null,"reason":null,"state":"none"}}],"ok":false,"platform_url":"https://example-org-examplecompany.harbourandfinch.example.net","primary_url":"https://harbourandfinch.example.org","proxied_unconfirmed":[{"challenge_path":{"code":"reachable","note":"The certificate check gets through Cloudflare.","ok":true,"status":404},"confirmable":true,"host":"harbourandfinch.example.org","verification":{"found":true,"name":"_cfcp-verify.example.org","state":"found","value":"cfcp-verify=3f1c0a9e5b7d2c4e8a6f1b0d9c7e5a3b"}}],"ran_at":"2026-11-02T15:25:00Z","role":"production","www":"bare"}}},"schema":{"$ref":"#/components/schemas/AttachDomainCheck"}}},"description":"The check."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Check a domain before attaching it","tags":["Domains"],"x-effect":["none"],"x-feature":"domains","x-file":"domains","x-gates":["provisioning"],"x-rate-limit":{"bucket":"reseller-dns-check","limit":20,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/clone":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Copies `{site}` onto another environment of its website, or onto production (push to live), replacing what\nis there; quote the `preview_token` of `previewSiteClone`. A copy that starts answers 201 with its\noperation; one that has to wait for something still running answers 202 and starts by itself\n(`getQueuedCopy`). A copy onto production keeps a safety copy first and needs `confirm_name` set to the\nwebsite's domain.\n","operationId":"cloneSite","requestBody":{"content":{"application/json":{"examples":{"onto_an_environment":{"summary":"Copy files and database onto Staging, keeping a safety copy","value":{"confirm_name":"Staging","preview_token":"cp_Xq7mR2vK9sLp4TzW8nBd","safety_first":true,"scope":"files_db","target":{"environment_id":1043,"type":"environment"}}},"push_to_live":{"summary":"Push a staging environment to live","value":{"confirm_name":"harbourandfinch.example.com","preview_token":"cp_Hd3nV8cY1wQe6UjM5aRf","scope":"files_db","target":{"type":"production"}}},"waits_its_turn":{"summary":"A database copy sent while a change is in progress on Staging","value":{"confirm_name":"Staging","preview_token":"cp_Lk9pT4xG2bNs7ZoC1eJy","scope":"db","target":{"environment_id":1043,"type":"environment"}}},"with_settings":{"summary":"Copy files and database onto Staging with the PHP settings and Nginx rules","value":{"confirm_name":"Staging","copy_nginx_rules":true,"copy_php_runtime":true,"preview_token":"cp_Pw5sD7kF3hJq9XvB2mNc","scope":"files_db","target":{"environment_id":1043,"type":"environment"}}}},"schema":{"$ref":"#/components/schemas/CloneRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T07:00:00Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":"Snapshots taken","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1043},"status":"executing","status_label":"Taking the source snapshot","step":"snapshot","steps":[{"key":"snapshot","label":"Snapshots taken","state":"current"},{"key":"bound","label":"Prepared on the cluster","state":"todo"},{"key":"holding","label":"Disk slot held","state":"todo"},{"key":"stopped","label":"Target stopped","state":"todo"},{"key":"copied","label":"Data copied","state":"todo"},{"key":"started","label":"Target started","state":"todo"},{"key":"fixups","label":"Target adjusted","state":"todo"},{"key":"cleanup","label":"Tidied up","state":"todo"}],"subject":null,"summary":"Staging ← Production (files and database)","to_version":null,"type":"clone","type_label":"Clone"},"target":{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"}},"schema":{"$ref":"#/components/schemas/CloneStarted"}}},"description":"The copy started. Follow `operation.id` with `getOperation` until it completes."},"202":{"content":{"application/json":{"example":{"message":"Waiting for the change in progress on Staging to finish. It starts on its own.","queued":{"ahead":0,"deadline_at":"2026-11-03T13:00:00Z","ended_at":null,"id":6120,"message":"Waiting for the change in progress on Staging to finish. It starts on its own.","operation_id":null,"queued_at":"2026-11-03T07:00:00Z","reason":"target_busy","source":{"id":1042,"name":"Production"},"state":"waiting","target":{"id":1043,"name":"Staging"}},"reason":"queued","target":{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"}},"schema":{"$ref":"#/components/schemas/CloneQueued"}}},"description":"The copy waits its turn (`reason` is `queued`) and starts by itself when what it waits for has finished.\nRead it with `getQueuedCopy` and `queued.id`; cancel it with `cancelQueuedCopy`.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden","description":"The token lacks a scope the copy needs (`scope_required`, with the `scope` to use: `write`, `destructive` for a copy onto production, `exec` for Node.js packages that run install scripts), or your company requires two-factor authentication and you have not set it up."},"404":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The feature is not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_found":{"summary":"Not found, or not yours to change","value":{"message":"Not found."}},"snapshot":{"summary":"The snapshot is not a ready snapshot of the source","value":{"message":"That snapshot cannot be used"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/FeatureOffRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The source or the target does not exist or is not yours to change, the feature is not on for your company\n(`feature_off`), or `snapshot_id` is not a ready snapshot of the source.\n"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"A change is in progress on the source","value":{"code":"busy","message":"The source environment has a change in progress. Wait for it to finish.","reason":"busy"}},"clone_in_progress":{"summary":"Another copy is running on the website","value":{"code":"clone_in_progress","message":"Another copy is running on this site. Wait for it to finish.","reason":"clone_in_progress"}},"copy_queued":{"summary":"A copy onto this target already waits its turn","value":{"code":"copy_queued","message":"A copy onto Staging is already waiting its turn. Cancel it first to queue another.","reason":"copy_queued"}},"different_cluster":{"summary":"The target is in another cluster","value":{"code":"different_cluster","message":"Clone works within one managed cluster. The target is in another.","reason":"different_cluster"}},"maintenance":{"summary":"Production is in maintenance mode","value":{"code":"maintenance","message":"Production is in maintenance mode. Switch it off before pushing to live.","reason":"maintenance"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"ssh_unreachable":{"summary":"The source cannot be reached at the moment","value":{"code":"ssh_unreachable","message":"The environment you are copying from cannot be reached right now. Try again in a few minutes.","reason":"ssh_unreachable"}},"target_busy":{"summary":"A change is in progress on the target","value":{"code":"target_busy","message":"The target environment has a change in progress. Wait for it to finish.","reason":"target_busy"}},"too_small":{"summary":"The target's disk is too small for the data","value":{"code":"too_small","message":"The target's disk is too small for the data being copied (needs 96.0 GB, has 53.7 GB). Resize the target to Medium (100 GB) or larger first.","reason":"too_small"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The copy cannot be made now, and it is not something a copy waits for. `reason` says why: `copy_queued`\n(a copy onto this target already waits), `different_cluster`, `maintenance` (production is in maintenance\nmode), `too_small` (the target's disk is too small for the data), `scratch_over_quota` (the copy needs\nmore working space than the target's size allows), `capacity_blocked` (with `dimension`),\n`storage_managed` (the storage of one of the two environments cannot take this copy, or is still being\nset up), `ssh_unreachable` and `measure_failed` (the source could not be reached or measured: try again\nin a few minutes), `shopware5_copy_unavailable`, `managed_elsewhere`, or, when copies do not wait their\nturn on your installation, `target_busy`, `busy` (a change in progress on the source) and\n`clone_in_progress`. Read `message` for any other reason.\n"},"422":{"content":{"application/json":{"examples":{"anonymise":{"summary":"An anonymised copy of a site that is not Shopware","value":{"code":"invalid","errors":{"anonymise":["An anonymised copy is offered on Shopware only"]},"field":"anonymise","message":"An anonymised copy is offered on Shopware only","reason":"invalid"}},"confirm_mismatch":{"summary":"The typed name does not match","value":{"code":"confirm_mismatch","errors":{"confirm_name":["Type the environment's name exactly to confirm"]},"field":"confirm_name","message":"Type the environment's name exactly to confirm","reason":"confirm_mismatch"}},"copy_tick":{"summary":"A `copy_…` field that is not true or false","value":{"code":"invalid","errors":{"copy_php_runtime":["Choose whether to copy this: true or false"]},"field":"copy_php_runtime","message":"Choose whether to copy this: true or false","reason":"invalid"}},"legacy_search":{"summary":"A push to live from an environment on the temporary older search engine","value":{"code":"legacy_search","errors":{"target":["This site's search runs on a temporary older engine. Switch the store to the OpenSearch module first."]},"message":"This site's search runs on a temporary older engine. Switch the store to the OpenSearch module first.","reason":"legacy_search"}},"no_target":{"summary":"No target, or an unknown target type","value":{"code":"invalid","errors":{"target":["Choose where to clone to"]},"field":"target","message":"Choose where to clone to","reason":"invalid"}},"preview_token":{"summary":"The preview token is missing, too old or for another copy","value":{"code":"invalid","errors":{"preview_token":["Run the preview again. It is older than 15 minutes."]},"field":"preview_token","message":"Run the preview again. It is older than 15 minutes.","reason":"invalid"}},"snapshot_transfer":{"summary":"A saved snapshot onto an environment on other servers","value":{"code":"snapshot_transfer","errors":{"snapshot_id":["A saved snapshot can be copied only to an environment on the same servers for now, and these two environments are on different servers. Copy the live environment instead, or restore the snapshot to an environment on the same servers."]},"field":"snapshot_id","message":"A saved snapshot can be copied only to an environment on the same servers for now, and these two environments are on different servers. Copy the live environment instead, or restore the snapshot to an environment on the same servers.","reason":"snapshot_transfer"}},"unknown_key":{"summary":"A key the body does not take","value":{"code":"invalid","errors":{"colour":["unknown_key"]},"field":"colour","message":"The colour field is not part of this request.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The request cannot be taken as written. `invalid` names the field in `field` and `errors`: no or an\nunknown target or scope, a key the body does not take, a `preview_token` that is missing, older than 15\nminutes or was made for another target, scope or snapshot, the same environment as source and target, or\na production environment named as an `environment` target. `confirm_mismatch`: `confirm_name` is missing\nwhere it is required, or does not match. `snapshot_transfer`: a saved snapshot cannot be copied to an\nenvironment on other servers. `ack_required` and `node_major_existing_only`: the Node.js version being\ncopied needs `node_acknowledge`, or cannot be copied to this target. `legacy_search`: a Magento 2\nenvironment whose search runs on a temporary older engine cannot be pushed to live. A `copy_…` field\nthat is not true or false is `invalid` too.\n"},"429":{"content":{"application/json":{"examples":{"copy_limit":{"summary":"Three copies or restores are already running","value":{"code":"copy_limit","message":"Your company already has 3 copies or restores running. Try again when one has finished.","reason":"copy_limit"}},"rate_limited":{"summary":"Too many copies in a minute","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many copies in a minute (`rate_limited`: wait for `Retry-After` seconds; only a copy that is taken\ncounts), or your company already has three copies or restores running (`copy_limit`).\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"502":{"content":{"application/json":{"example":{"message":"Live status is unavailable. Try again in a minute."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The environments could not be read, so nothing was started. Try again in a minute."},"503":{"content":{"application/json":{"example":{"code":"temporarily_unavailable","message":"We can't make this copy right now. Nothing was changed. Try again in a few minutes; contact support if it keeps happening.","reason":"temporarily_unavailable"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The copy cannot be made at the moment (`temporarily_unavailable`). Nothing was changed."}},"summary":"Copy an environment onto another","tags":["Copies"],"x-effect":["overwrites"],"x-feature":"copies","x-file":"copies","x-gates":["clone"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-clone","limit":5,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"destructive","when":"The copy goes onto production (`target.type` is `production`)"},{"needs":"exec","when":"`copy_node_runtime` is true and the source's Node.js packages run install scripts the target does not run now"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/clone/preview":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Checks a copy of `{site}` onto another environment: what would move, what blocks it now (`blockers`), what\nit would wait for (`waits`), and the `preview_token` that `cloneSite` must quote within 15 minutes. Ask with\nthe same target, scope and snapshot you will send; you need to be able to change both environments.\n","operationId":"previewSiteClone","parameters":[{"description":"`environment` (with `target_id`) or `production`, which copies onto the website's production.","example":"environment","in":"query","name":"target_type","schema":{"enum":["environment","production"],"type":"string"}},{"description":"For `environment`, the site row id of the environment to copy onto.","example":1043,"in":"query","name":"target_id","schema":{"minimum":1,"type":"integer"}},{"description":"What to copy. Files and database when left out.","example":"files_db","in":"query","name":"scope","schema":{"$ref":"#/components/schemas/CloneScope"}},{"description":"Copy from this snapshot of the source instead of the live environment.","in":"query","name":"snapshot_id","schema":{"minimum":1,"type":"integer"}},{"description":"Ask about an anonymised copy (Shopware only). `true` or `false`; `1` and `0` are taken too, and anything\nelse is refused `invalid`.\n","in":"query","name":"anonymise","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"blockers":[],"can_proceed":true,"crypt_match":null,"estimated_seconds":null,"estimated_switch_seconds":30,"expected_switch":{"compute":{"from":null,"to":null},"crosses_tier":false,"note":null,"storage":{"from":null,"to":null}},"expires_at":"2026-11-03T07:15:00Z","fixups":["URLs rewritten to harbourandfinch-example-com-staging.northwind.cfstack.example.net","Crons switched off","Outbound mail captured by Mailpit","Search engines blocked (noindex)","WordPress admin password reset (shown once)"],"preview_token":"cp_Xq7mR2vK9sLp4TzW8nBd","queues":false,"safety_snapshot":true,"scope":"files_db","sizes":{"basis":null,"copied_bytes":null,"db_bytes":null,"files_bytes":null,"measured_at":null,"scratch_bytes":null,"used_bytes":null},"source":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","platform":"wordpress","role":"production","role_label":"Production","slug":"production","tier":"S"},"steps":[{"key":"snapshot","label":"Snapshots taken"},{"key":"bound","label":"Prepared on the cluster"},{"key":"holding","label":"Disk slot held"},{"key":"stopped","label":"Target stopped"},{"key":"copied","label":"Data copied"},{"key":"started","label":"Target started"},{"key":"fixups","label":"Target adjusted"},{"key":"cleanup","label":"Tidied up"}],"target":{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging","tier":"S"},"target_disk":{"free_bytes":null,"size_bytes":10737418240,"used_bytes":null},"target_growth":null,"waits":[]},"schema":{"$ref":"#/components/schemas/ClonePreview"}}},"description":"The preview. `can_proceed` says whether a copy sent now would be taken."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"anonymise":{"summary":"An `anonymise` that is not true or false","value":{"code":"invalid","errors":{"anonymise":["Anonymise is true or false"]},"field":"anonymise","message":"Anonymise is true or false","reason":"invalid"}},"scope":{"summary":"An unknown scope","value":{"code":"invalid","errors":{"scope":["Choose what to copy"]},"field":"scope","message":"Choose what to copy","reason":"invalid"}},"target_type":{"summary":"An unknown target type","value":{"code":"invalid","errors":{"target_type":["Choose where to clone to"]},"field":"target_type","message":"Choose where to clone to","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The target type, the scope or another parameter is not a value the preview takes (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Preview a copy onto an environment","tags":["Copies"],"x-feature":"copies","x-file":"copies","x-gates":["clone"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/cloudflare-zone":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"`auto` lets the Control Panel find the zone for the site's domain, `manual` chooses one of the connection's\nzones by `zone_id`, and `off` stops using Cloudflare for the site.\n","operationId":"updateSiteCloudflareZone","requestBody":{"content":{"application/json":{"examples":{"auto":{"summary":"Find the zone from the site's domain","value":{"mode":"auto"}},"manual":{"summary":"Choose a zone of the connection","value":{"mode":"manual","zone_id":"023e105f4ecef8ad9ca31a8372d0c353"}},"off":{"summary":"Stop using Cloudflare for the site","value":{"mode":"off"}}},"schema":{"$ref":"#/components/schemas/CloudflareZoneRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"off":{"summary":"Cloudflare is off for the site","value":{"mode":"off","zone":null}}},"schema":{"properties":{"mode":{"enum":["auto","manual","off"],"type":"string"},"zone":{"oneOf":[{"$ref":"#/components/schemas/CloudflareZone"},{"type":"null"}]}},"required":["zone","mode"],"type":"object"}}},"description":"The zone the site now uses, or null, and the mode."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`not_connected` (a `manual` zone without a connection), `deleted`, `provisioning` or `managed_elsewhere`."},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"zone_id":["Unknown zone"]},"field":"zone_id","message":"Unknown zone","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong. A zone that is not one of your connection's is an unknown zone."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a site's Cloudflare zone","tags":["Cloudflare"],"x-effect":["changes-settings"],"x-feature":"cloudflare","x-file":"domains","x-gates":["cloudflare"],"x-rate-limit":{"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/cloudflare-zone/ssl":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"Sets the SSL/TLS mode of the site's Cloudflare zone to Full or Full (strict). The mode applies to every\nhostname in that zone.\n","operationId":"updateSiteCloudflareSslMode","requestBody":{"content":{"application/json":{"examples":{"strict":{"summary":"Full (strict)","value":{"value":"strict"}}},"schema":{"$ref":"#/components/schemas/CloudflareSslRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"strict":{"$ref":"#/components/examples/CloudflareZoneSslSet"}},"schema":{"properties":{"zone":{"$ref":"#/components/schemas/CloudflareZone"}},"required":["zone"],"type":"object"}}},"description":"The zone with its new mode."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another zone change is being made","value":{"code":"busy","message":"Another change to a Cloudflare zone is being made just now. Try again in a minute.","reason":"busy"}},"no_zone":{"summary":"The site has no zone","value":{"code":"no_zone","message":"This site's domain is not in a connected Cloudflare zone","reason":"no_zone"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`no_zone` (the site has no zone to set), `not_connected`, `busy` (another zone change is being made),\n`deleted`, `provisioning` or `managed_elsewhere`.\n"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"value":["Choose Full or Full (strict)"]},"field":"value","message":"Choose Full or Full (strict)","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The value is not `full` or `strict`, or the token may not change zone settings."},"429":{"$ref":"#/components/responses/CloudflareTooManyRequests"},"502":{"content":{"application/json":{"example":{"message":"Cloudflare did not answer. Try again in a minute."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"Cloudflare did not answer or refused the change. The mode is unchanged as far as the Control Panel knows. Try again in a minute."}},"summary":"Update the zone's SSL mode","tags":["Cloudflare"],"x-effect":["changes-settings"],"x-feature":"cloudflare","x-file":"domains","x-gates":["cloudflare"],"x-rate-limit":{"also":[{"bucket":"reseller-cloudflare-writes","limit":60,"minutes":60,"per":"company"}],"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/cloudflare/purge":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Purges the whole zone, or up to 30 addresses on the site's own domains. The purge is sent to Cloudflare before\nthe answer: the command in the answer says whether it `succeeded` or `failed`, and stays readable at\n`GET /corestack/commands/{command}`. When Varnish is on for the site its cache is purged first, unless\n`varnish_first` is false.\n","operationId":"purgeSiteCloudflareCache","requestBody":{"content":{"application/json":{"examples":{"everything":{"summary":"Purge the whole zone","value":{"everything":true}},"urls":{"summary":"Purge two addresses","value":{"urls":["https://harbourandfinch.example.com/","https://harbourandfinch.example.com/sale/"]}}},"schema":{"$ref":"#/components/schemas/CloudflarePurgeRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"failed":{"summary":"Cloudflare did not answer","value":{"command":{"blocked_until_verified":false,"duration_ms":547,"error":"Cloudflare did not answer. Try again in a minute.","exit_code":null,"finished_at":"2026-11-06T08:07:03Z","id":2036,"input":{"everything":true},"kind":"cloudflare_purge","label":"Purge Cloudflare cache","operation_id":null,"output_excerpt":null,"queued_at":"2026-11-06T08:07:02Z","requested_by":{"id":5021,"name":"Eleanor Finch"},"result":null,"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-06T08:07:02Z","status":"failed","status_label":"Failed"}}},"purged":{"summary":"A purge of the whole zone","value":{"command":{"blocked_until_verified":false,"duration_ms":515,"error":null,"exit_code":null,"finished_at":"2026-11-06T08:05:41Z","id":2035,"input":{"everything":true},"kind":"cloudflare_purge","label":"Purge Cloudflare cache","operation_id":null,"output_excerpt":"Purged everything cached for harbourandfinch.example.com (1 request).","queued_at":"2026-11-06T08:05:40Z","requested_by":{"id":5021,"name":"Eleanor Finch"},"result":{"purged":"everything"},"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-06T08:05:40Z","status":"succeeded","status_label":"Done"}}}},"schema":{"properties":{"command":{"$ref":"#/components/schemas/CloudflarePurgeCommand"}},"required":["command"],"type":"object"}}},"description":"The purge was sent. `command.status` is `succeeded`, with what was purged in `result`, or `failed`, with\nCloudflare's refusal in `error`.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"no_zone":{"summary":"The site has no zone","value":{"code":"no_zone","message":"This site's domain is not in a connected Cloudflare zone","reason":"no_zone"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`not_connected`, `no_zone`, `deleted`, `provisioning`, `managed_elsewhere`, or the site cannot take the\npurge now: `busy` (another change is running), `command_running` (another command is running),\n`restore_running`, `deployment_running`, `removed` or `exec_unresolved`.\n"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"urls":["Purge everything, or give 1–30 URLs on this site's addresses"]},"field":"urls","message":"Purge everything, or give 1–30 URLs on this site's addresses","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"Send either `everything` or `urls`, never both; every address must be on one of the site's domains. Also\nanswered when the token may not purge the cache.\n"},"429":{"content":{"application/json":{"examples":{"purges_spent":{"summary":"The site's ten purges this hour are used","value":{"code":"rate_limited","message":"Too many purges for this site. Try again in a few minutes.","reason":"rate_limited","retry_after_seconds":3600}},"rate_limited":{"summary":"The endpoint's request limit is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests (`rate_limited`): the endpoint's request limit, or the site's ten purges this hour, which\nthe Control Panel and AI assistants spend too. Wait for `Retry-After`, which `retry_after_seconds` repeats.\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"503":{"$ref":"#/components/responses/CommandsSwitchedOff"}},"summary":"Purge a site's Cloudflare cache","tags":["Cloudflare"],"x-effect":["deletes"],"x-feature":"cloudflare","x-file":"domains","x-gates":["cloudflare","exec"],"x-rate-limit":{"also":[{"bucket":"reseller-cloudflare-purge","limit":10,"minutes":60,"per":"environment"}],"bucket":"reseller-cloudflare-purge","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/cloudflare/ssl-rules":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the SSL rules set for the site's domains, the domains a rule can name, and, with `check`, whether the stored Cloudflare token may set one.","operationId":"listSiteCloudflareSslRules","parameters":[{"description":"Send `1` to ask Cloudflare whether the token may change Configuration Rules in each zone. Nothing is written.","example":true,"in":"query","name":"check","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"checked":{"summary":"With `check`","value":{"access":[{"access":"ok","zone":"harbourandfinch.example.com"}],"domains":[{"host":"harbourandfinch.example.com","zone":"harbourandfinch.example.com"},{"host":"www.harbourandfinch.example.com","zone":"harbourandfinch.example.com"}],"rules":[{"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"id":318,"removed_at":null,"set_at":"2026-11-03T09:16:40+00:00","site_id":1042,"ssl":"full","state":"active","state_reason":null,"zone":{"id":"zone-example-1","name":"harbourandfinch.example.com"}}],"zone":{"id":"zone-example-1","name":"harbourandfinch.example.com"}}},"rules":{"summary":"One active rule","value":{"domains":[{"host":"harbourandfinch.example.com","zone":"harbourandfinch.example.com"},{"host":"www.harbourandfinch.example.com","zone":"harbourandfinch.example.com"}],"rules":[{"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"id":318,"removed_at":null,"set_at":"2026-11-03T09:16:40+00:00","site_id":1042,"ssl":"full","state":"active","state_reason":null,"zone":{"id":"zone-example-1","name":"harbourandfinch.example.com"}}],"zone":{"id":"zone-example-1","name":"harbourandfinch.example.com"}}}},"schema":{"$ref":"#/components/schemas/CloudflareSslRuleList"}}},"description":"The rules, the domains and the zone."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's Cloudflare SSL rules","tags":["Cloudflare"],"x-feature":"cloudflare","x-file":"cloudflare-ssl-rules","x-gates":["cloudflare"],"x-rate-limit":{"bucket":"reseller-cloudflare-rules","limit":20,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"Sets Full or Full (strict) for the named domains of the site, in their Cloudflare zone, and leaves the zone's own SSL mode as it is. The same rule asked for twice is one rule.","operationId":"updateSiteCloudflareSslRule","requestBody":{"content":{"application/json":{"examples":{"full_for_both":{"summary":"Full for the domain and its www","value":{"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"ssl":"full"}}},"schema":{"$ref":"#/components/schemas/CloudflareSslRuleSet"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"rule":{"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"id":318,"removed_at":null,"set_at":"2026-11-03T09:16:40+00:00","site_id":1042,"ssl":"full","state":"active","state_reason":null,"zone":{"id":"zone-example-1","name":"harbourandfinch.example.com"}}},"schema":{"$ref":"#/components/schemas/CloudflareSslRuleResult"}}},"description":"The rule, as Cloudflare now has it."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"The rule is being changed","value":{"code":"busy","message":"This SSL rule is being changed. Try again in a moment.","reason":"busy"}},"cloudflare_off":{"summary":"Cloudflare is off for the site","value":{"code":"no_zone","message":"Cloudflare is switched off for this site","reason":"no_zone"}},"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_connected":{"summary":"Your company has not connected Cloudflare","value":{"code":"not_connected","message":"Connect Cloudflare for this company first","reason":"not_connected"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}},"rule_edited":{"summary":"The rule was changed in Cloudflare while it was being set","value":{"code":"rule_edited","message":"This SSL rule was changed in Cloudflare after the Control Panel set it, so it was left as it is. Change or remove it in Cloudflare.","reason":"rule_edited","rule":{"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"id":318,"removed_at":null,"set_at":"2026-11-03T09:16:40+00:00","site_id":1042,"ssl":"full","state":"kept","state_reason":"rule_edited","zone":{"id":"zone-example-1","name":"harbourandfinch.example.com"}}}},"token_unreadable":{"summary":"The stored token cannot be read","value":{"code":"not_connected","message":"The stored token could not be read. Connect Cloudflare again.","reason":"not_connected"}},"zone_gone":{"summary":"The token no longer sees the zone","value":{"code":"no_zone","message":"The Cloudflare token no longer sees the zone harbourandfinch.example.com, so the rule could not be checked","reason":"no_zone"}}},"schema":{"$ref":"#/components/schemas/CloudflareSslRuleRefusal"}}},"description":"Cloudflare is not connected (`not_connected`), the site or the token has no zone to use (`no_zone`), the same rule is being changed (`busy`), the rule was changed in Cloudflare while it was being set and so was left (`rule_edited`, with the `rule`), the site is deleted or still being created (`deleted`, `provisioning`), or another control panel manages it (`managed_elsewhere`)."},"422":{"content":{"application/json":{"examples":{"access_unknown":{"summary":"Cloudflare did not say whether the token may change Configuration Rules","value":{"code":"rules_not_allowed","message":"Cloudflare did not say whether the token may change Configuration Rules on harbourandfinch.example.com, so nothing was written. Check the token's permissions, then try again.","reason":"rules_not_allowed"}},"bad_ssl":{"summary":"A mode other than full or strict","value":{"code":"invalid","errors":{"ssl":["Choose Full or Full (strict)"]},"field":"ssl","message":"Choose Full or Full (strict)","reason":"invalid"}},"not_on_site":{"summary":"A domain that is not this site's","value":{"code":"invalid","errors":{"hosts":["shop.harbourandfinch.example.org is not a domain of this site"]},"field":"hosts","message":"shop.harbourandfinch.example.org is not a domain of this site","reason":"invalid"}},"rules_not_allowed":{"summary":"The token may not change Configuration Rules","value":{"code":"rules_not_allowed","message":"The Cloudflare token may not change Configuration Rules on harbourandfinch.example.com. Allow Zone > Config Rules > Edit on the token, then try again.","reason":"rules_not_allowed"}},"token_refused":{"summary":"Cloudflare refused the stored token","value":{"code":"not_connected","message":"Cloudflare refused the token. Replace it under Company settings → Cloudflare.","reason":"not_connected"}},"too_long":{"summary":"Domain names too long, together, for one rule","value":{"code":"invalid","errors":{"hosts":["These domain names are too long for one rule. Set them in two rules."]},"field":"hosts","message":"These domain names are too long for one rule. Set them in two rules.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong, or Cloudflare refused the rule as written (`invalid`); the Cloudflare token may not change Configuration Rules, or Cloudflare did not say whether it may (`rules_not_allowed`); or Cloudflare refused the stored token (`not_connected`). Nothing was written."},"429":{"$ref":"#/components/responses/CloudflareTooManyRequests"},"502":{"$ref":"#/components/responses/CloudflareSslRuleUnavailable"}},"summary":"Update an SSL rule for domains","tags":["Cloudflare"],"x-effect":["changes-settings"],"x-feature":"cloudflare","x-file":"cloudflare-ssl-rules","x-gates":["cloudflare"],"x-rate-limit":{"also":[{"bucket":"reseller-cloudflare-writes","limit":60,"minutes":60,"per":"company"}],"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/cloudflare/ssl-rules/{rule}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of one of the site's SSL rules. Digits only.","example":318,"in":"path","name":"rule","required":true,"schema":{"minimum":1,"type":"integer"}}],"delete":{"description":"Takes the rule out of the Cloudflare zone, so its domains use the zone's own SSL mode again. A rule that was changed in Cloudflare afterwards is left there. A deleted site's rules can still be removed.","operationId":"deleteSiteCloudflareSslRule","responses":{"200":{"content":{"application/json":{"example":{"rule":{"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"id":318,"removed_at":"2026-11-03T10:02:11+00:00","set_at":"2026-11-03T09:16:40+00:00","site_id":1042,"ssl":"full","state":"removed","state_reason":null,"zone":{"id":"zone-example-1","name":"harbourandfinch.example.com"}}},"schema":{"$ref":"#/components/schemas/CloudflareSslRuleResult"}}},"description":"The rule, now `removed`. A rule that was already removed answers the same."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The site or the rule does not exist, the rule is another site's, or the feature is not on for your company (`feature_off`)."},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"The rule is being changed","value":{"code":"busy","message":"This SSL rule is being changed. Try again in a moment.","reason":"busy"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_connected":{"summary":"Your company has not connected Cloudflare","value":{"code":"not_connected","message":"Connect Cloudflare for this company first","reason":"not_connected"}},"not_owner":{"summary":"A switch that is still running set the rule","value":{"code":"not_owner","message":"This SSL rule belongs to a switch that is still running, which removes it itself","reason":"not_owner"}},"rule_edited":{"summary":"The rule was changed in Cloudflare","value":{"code":"rule_edited","message":"This SSL rule was changed in Cloudflare after the Control Panel set it, so it was left as it is. Change or remove it in Cloudflare.","reason":"rule_edited","rule":{"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"id":318,"removed_at":null,"set_at":"2026-11-03T09:16:40+00:00","site_id":1042,"ssl":"full","state":"kept","state_reason":"rule_edited","zone":{"id":"zone-example-1","name":"harbourandfinch.example.com"}}}},"zone_gone":{"summary":"The token no longer sees the zone","value":{"code":"no_zone","message":"The Cloudflare token no longer sees the zone harbourandfinch.example.com, so the rule could not be checked","reason":"no_zone"}}},"schema":{"$ref":"#/components/schemas/CloudflareSslRuleRefusal"}}},"description":"A switch that is still running set the rule (`not_owner`), the rule was changed in Cloudflare and so was left (`rule_edited`, with the `rule`), the rule is being changed by another request (`busy`), Cloudflare is not connected (`not_connected`), the token no longer sees the zone (`no_zone`), or another control panel manages the site (`managed_elsewhere`)."},"422":{"content":{"application/json":{"examples":{"rules_not_allowed":{"summary":"The token may not change Configuration Rules","value":{"code":"rules_not_allowed","message":"The Cloudflare token may not change Configuration Rules on harbourandfinch.example.com. Allow Zone > Config Rules > Edit on the token, then try again.","reason":"rules_not_allowed"}},"token_refused":{"summary":"Cloudflare refused the stored token","value":{"code":"not_connected","message":"Cloudflare refused the token. Replace it under Company settings → Cloudflare.","reason":"not_connected"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The Cloudflare token may not change Configuration Rules (`rules_not_allowed`), or Cloudflare refused the stored token (`not_connected`). The rule is as it was."},"429":{"$ref":"#/components/responses/CloudflareTooManyRequests"},"502":{"$ref":"#/components/responses/CloudflareSslRuleUnavailable"}},"summary":"Delete an SSL rule","tags":["Cloudflare"],"x-effect":["deletes"],"x-feature":"cloudflare","x-file":"cloudflare-ssl-rules","x-gates":["cloudflare"],"x-rate-limit":{"also":[{"bucket":"reseller-cloudflare-writes","limit":60,"minutes":60,"per":"company"}],"bucket":"reseller-cloudflare","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/compute-family":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Moves a site between the two server types, `general` (Standard) and `optimised` (Performance), billed at the\nnew price from the hour the move starts. The types on offer, and what each adds a month, are in the site's\nupgrade options (`family`).\n","operationId":"switchSiteComputeFamily","requestBody":{"content":{"application/json":{"examples":{"performance":{"summary":"Move to Performance servers","value":{"confirm_domain":"harbourandfinch.example.com","family":"optimised"}},"tonight":{"summary":"Move to Performance servers tonight","value":{"apply":"tonight","confirm_domain":"harbourandfinch.example.com","family":"optimised"}}},"schema":{"$ref":"#/components/schemas/UpgradeSiteFamilyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"queued":{"$ref":"#/components/examples/UpgradeSiteFamilyQueuedExample"}},"schema":{"$ref":"#/components/schemas/UpgradeSiteChange"}}},"description":"The move is queued or has started. Queued (`queued: true`): `item` is the move that waits and `operation`\nis null; a move asked for now answers this way too when it could not start at once. Started: `operation`\nis the move, of type `site_migrate`, and `item` is null. `quote` prices the server type alone (the\npackage and add-ons at the new type's price), and the site keeps its `compute_family` until the move\nhas finished.\n","x-unverified":true},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/UpgradeWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"same_family":{"$ref":"#/components/examples/UpgradeSameFamilyExample"}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was changed. `same_family`: the site is on that server type. `stale`: the price has moved since\nthe quote. `cluster_site`: the site is inside a CoreCluster, which changes its server type as a whole.\n`no_payment_method`: the billing account has no card or mandate. `move_pending`: the site has a move or\nother changes waiting already. `compute_capacity_blocked`: the servers of that type have no room at the\nmoment. `not_resizable`, `not_ready`, `provisioning`, `deleted`: the site cannot be moved, or is being\ncreated or deleted. `demo_keep_required`: the site is a demo that has not been kept (the answer adds\n`keep_url` and `change`). `managed_elsewhere`: the site is managed by another control panel. Other\nreasons a move can be refused for carry their own sentence.\n"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"$ref":"#/components/examples/UpgradeConfirmDomainMismatchExample"},"family":{"$ref":"#/components/examples/UpgradeFamilyUnknownExample"}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`confirm_mismatch`: `confirm_domain` is not the site's domain. `invalid`: a field is missing or wrong\n(`field` names it). `family_unavailable`: the server type is not offered where the site runs.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/UpgradeRegionNotReady"}},"summary":"Switch a site's server type","tags":["Packages and capacity"],"x-effect":["billable"],"x-feature":"upgrades","x-file":"upgrades","x-gates":["compute_optimised","billing","restart_batches"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-upgrades","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/credentials/database":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Answers the login the site's application uses for its database: the host and port as the site itself reaches\nthem, the database name, the username and the password. It needs the `exec` scope, the answer is never cached,\nand every reveal is recorded with the person who asked. Nothing is changed: the request has no body.\n","operationId":"revealSiteDatabaseLogin","responses":{"200":{"content":{"application/json":{"example":{"host":"127.0.0.1","name":"wordpress","password":"example-password-not-a-secret","port":3306,"revealed_at":"2026-11-03T09:16:40Z","username":"application"},"schema":{"$ref":"#/components/schemas/CredentialsDatabaseLogin"}}},"description":"The login. Keep it out of logs and tickets.","headers":{"Cache-Control":{"description":"Always `no-store, private`.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound","description":"The id does not exist, the site has been removed, or it is a site whose login you may not reveal. All answer the same body."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"not_found_on_cluster":{"summary":"The login is not on the cluster","value":{"code":"upstream_unavailable","message":"The credentials could not be found on the cluster.","reason":"upstream_unavailable"}},"unreachable":{"summary":"The cluster could not be reached","value":{"code":"upstream_unavailable","message":"The cluster could not be reached. Try again in a minute.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The login could not be read from the site's cluster (`upstream_unavailable`). Nothing was revealed."}},"summary":"Reveal a site's own database login","tags":["Database"],"x-effect":["reveals-secret"],"x-feature":"database","x-file":"credentials","x-gates":[],"x-rate-limit":{"bucket":"reseller-credentials","limit":10,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/credentials/preview":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Answers the HTTP login of the environment's platform address, read when you ask and recorded in the site's\nactivity. It needs a person who may reveal the site's credentials; anyone else gets the `404` of a site that does\nnot exist.\n","operationId":"revealSitePreviewLogin","responses":{"200":{"content":{"application/json":{"example":{"password":"Example-preview-password-1","revealed_at":"2026-11-10T00:59:43Z","url":"https://harbourandfinch-example-com.northwind.cfstack.example.net","username":"preview"},"schema":{"$ref":"#/components/schemas/EnvironmentPreviewCredentials"}}},"description":"The login."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"upstream_unavailable":{"summary":"The site could not be reached","value":{"code":"upstream_unavailable","message":"The cluster could not be reached. Try again in a minute.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The login could not be read at the moment (`upstream_unavailable`). Try again in a minute."}},"summary":"Reveal the preview login","tags":["Password protection"],"x-effect":["reveals-secret"],"x-feature":"http-auth","x-file":"environments","x-gates":[],"x-rate-limit":{"bucket":"reseller-credentials","limit":10,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/crons":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the whole set: its `version`, the switch for the site, the built-in task, each task with its id, next\nrun and last run, and whether the last change has been applied.\n","operationId":"getSiteCrons","responses":{"200":{"content":{"application/json":{"examples":{"set":{"$ref":"#/components/examples/CronSetExample"}},"schema":{"$ref":"#/components/schemas/CronSet"}}},"description":"The set of scheduled tasks."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/CronSiteNotReady"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's scheduled tasks","tags":["Scheduled tasks"],"x-feature":"crons","x-file":"crons","x-gates":["crons"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Replaces the whole set at the `version` you read. A task you leave out is removed; a task without an `id` is\nadded. A change to what runs answers `201` with an operation to follow; a save that changes nothing, or only\nlabels, answers `200` with `operation` null.\n","operationId":"replaceSiteCrons","requestBody":{"content":{"application/json":{"examples":{"add_a_task":{"summary":"Add a task to a site that has none","value":{"enabled":true,"entries":[{"command":"curl -s -o /dev/null https://www.harbourandfinch.example.com/","enabled":true,"label":"Warm the cache","no_overlap":true,"schedule":"*/15 * * * *","timeout":900}],"version":0}},"switch_off":{"summary":"Switch scheduled tasks off for the site","value":{"builtin_enabled":true,"enabled":false,"entries":[],"version":0}}},"schema":{"$ref":"#/components/schemas/CronSetUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"unchanged":{"$ref":"#/components/examples/CronSaveUnchangedExample"}},"schema":{"$ref":"#/components/schemas/CronSaveResult"}}},"description":"Saved, and nothing that runs changed. `operation` is null."},"201":{"content":{"application/json":{"examples":{"saved":{"$ref":"#/components/examples/CronSaveExample"}},"schema":{"$ref":"#/components/schemas/CronSaveResult"}}},"description":"Saved. `operation` is the `crons_change` operation that applies the set to the site."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"confirm_mismatch":{"summary":"A task was left out without its label","value":{"code":"confirm_mismatch","field":"confirm_labels","labels":["Old clean-up"],"message":"Removing a scheduled task needs its label, exactly: send confirm_labels with “Old clean-up”. Nothing was changed.","reason":"confirm_mismatch"}},"conflict":{"summary":"Another change to the platform landed first","value":{"code":"conflict","message":"Another change landed first. Reload and try again.","reason":"conflict"}},"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_changeable":{"summary":"The site's files cannot be written from the Control Panel","value":{"message":"This site cannot be changed from the control panel. Contact support."}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}},"removed":{"summary":"The site has been removed","value":{"code":"removed","message":"This site has been removed","reason":"removed"}},"restore_running":{"summary":"A restore of the site is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"stale":{"summary":"The set changed since you read it","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/CronRemovalRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The save was refused and nothing changed. `reason` says why: `stale` (the set changed since you read it,\nor a task `id` is not one of the set's; read it again), `busy`, `restore_running`, `command_running` or\n`deployment_running` (another change, a restore, a command or a deployment is running; wait for it),\n`conflict` (another change to the platform landed first: send the request again), `confirm_mismatch`\n(tasks were left out without their labels in `confirm_labels`; `labels` lists every label to send),\n`deleted`, `provisioning` or `removed` (the site is deleted, still being created or removed),\n`cluster_not_ready`, `cluster_deleting` or `cluster_migrating` (the site's CoreCluster is being created,\ndeleted or moved to another package), or `managed_elsewhere`. A site whose files the Control Panel cannot\nwrite answers a sentence only, with no `reason`.\n"},"422":{"content":{"application/json":{"examples":{"entry":{"summary":"A command that is not allowed","value":{"code":"invalid","errors":{"entries.1.command":["Entry 2: Command contains `sudo`, which is not allowed in a cron"]},"field":"entries.1.command","message":"Entry 2: Command contains `sudo`, which is not allowed in a cron","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong. A refused task is named by its place in `entries`, such as\n`entries.1.command`, and its message starts with the task's number.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"no_answer":{"summary":"The platform answered with an error","value":{"message":"The platform returned an error (HTTP 503). Try again shortly."}},"not_saved":{"summary":"The platform did not save the change","value":{"message":"The change could not be saved. Contact support."}}},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The platform did not answer, or did not save the change. Nothing was changed: send the request again in\na minute. The answer is a sentence only, with no `reason`.\n"}},"summary":"Replace a site's scheduled tasks","tags":["Scheduled tasks"],"x-effect":["changes-settings","deletes","overwrites","runs-code"],"x-feature":"crons","x-file":"crons","x-gates":["crons"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-sets","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/crons/validate":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Checks a `schedule`, a `command` or both, and answers when the schedule would next run, any warnings and\nanything refused. Nothing is saved.\n","operationId":"checkSiteCron","requestBody":{"content":{"application/json":{"examples":{"schedule_and_command":{"summary":"A schedule and a command","value":{"command":"php bin/console app:export","schedule":"30 2 * * *"}},"schedule_only":{"summary":"A schedule on its own","value":{"schedule":"*/15 * * * *"}}},"schema":{"$ref":"#/components/schemas/CronValidateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"refused":{"summary":"A schedule and a command that are refused","value":{"errors":{"command":"Command contains `sudo`, which is not allowed in a cron","minute":"Minute must be 0–59"},"human":null,"next_runs":[],"normalised":null,"valid":false,"warnings":[]}},"valid":{"summary":"Both are accepted","value":{"errors":{},"human":"Every 15 minutes","next_runs":["2026-11-06T10:30:00+01:00","2026-11-06T10:45:00+01:00","2026-11-06T11:00:00+01:00"],"normalised":"*/15 * * * *","valid":true,"warnings":[]}}},"schema":{"$ref":"#/components/schemas/CronValidateResult"}}},"description":"The result of the check. A schedule or command that is refused answers `200` with `valid` false."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/CronSiteNotReady"},"422":{"content":{"application/json":{"examples":{"nothing_to_check":{"summary":"Neither a schedule nor a command was sent","value":{"code":"invalid","errors":{"schedule":["Send a schedule or a command to check"]},"field":"schedule","message":"Send a schedule or a command to check","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is wrong, or the body has neither a `schedule` nor a `command`."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Check a schedule or a command","tags":["Scheduled tasks"],"x-effect":["none"],"x-feature":"crons","x-file":"crons","x-gates":["crons"],"x-rate-limit":{"bucket":"reseller-validate","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/database":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers how to connect to the database of a site or one of its environments, its database users with their\nlimits, and external access with its allowed addresses and price. It never answers a password: the site's own\nlogin and a generated password each have their own reveal.\n","operationId":"getSiteDatabase","responses":{"200":{"content":{"application/json":{"example":{"can":{"edit_sources":true,"enable_external":true,"manage_users":true,"reveal_application":true},"connection":{"database":"application","engine":"MariaDB","host":"127.0.0.1","port":3306,"ssh_tunnel":"ssh -N -L 3306:127.0.0.1:3306 -p 30122 web@ssh-northwind.example.net","version":"11.4"},"counts":{"external":0,"external_cap":5,"users":1,"users_cap":10},"external":{"address":"203.0.113.40","available":true,"database":"application","enabled_at":"2026-11-02T15:41:09+00:00","enabled_by":"Daniel Reyes","host":"harbourandfinch-example-com-db.northwind.cfstack.example.net","moved_at":null,"operation":null,"port":3306,"price":{"amount":"15.00","billed_on":"corestack","currency":"GBP","label":"Dedicated IP address","period":"month"},"sanitised":false,"sources":[{"added_at":"2026-11-02T15:41:09+00:00","added_by":"Daniel Reyes","cidr":"192.0.2.15/32","label":"Reporting","pending":false},{"added_at":"2026-11-02T15:41:09+00:00","added_by":"Daniel Reyes","cidr":"198.51.100.64/29","label":"Order system","pending":false}],"sources_cap":10,"status":"on","tls":"optional","window_date":null},"users":[{"actions":["reveal"],"connects_from":"site","database":"application","kind":"protected","scope":"application","username":"application"},{"actions":["edit","rotate","delete"],"added_at":"2026-11-03T09:16:41+00:00","added_by":"Daniel Reyes","connects_from":"internal","database":"application","id":4112,"kind":"internal","max_statement_time":null,"max_user_connections":null,"password_origin":"generated","pending":null,"require_tls":false,"reveal_pending":true,"scope":"read_only","username":"reporting_ro"}],"viewer_ip":"198.51.100.24"},"schema":{"$ref":"#/components/schemas/DatabaseTab"}}},"description":"The database details."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's database details","tags":["Database"],"x-feature":"database","x-file":"database","x-gates":["database_tab"],"x-rate-limit":{"bucket":"reseller-database-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/database/operations/{operation}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of an operation one of these endpoints answered.","example":5120,"in":"path","name":"operation","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers an operation that a database user change or an external access change started on this site. Read it\nuntil `status` is `completed` or `failed`. An operation of any other kind, or of another site, answers 404.\n","operationId":"getSiteDatabaseOperation","responses":{"200":{"content":{"application/json":{"example":{"operation":{"applied_at":"2026-11-03T09:16:41Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":"2026-11-03T09:16:41Z","created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":null,"notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"completed","status_label":"Done","step":null,"steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Applied in the database","state":"done"}],"subject":null,"summary":"User reporting_ro added (internal, read-only)","to_version":null,"type":"db_user_change","type_label":"Database users"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"The operation as it stands."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a database operation","tags":["Database"],"x-feature":"database","x-file":"database","x-gates":["database_tab"],"x-rate-limit":{"bucket":"reseller-database-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/database/users":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Adds a database user to the environment: an `internal` user connects from inside the site only, an `external`\nuser through external access only. A generated password is never in the answer: once the operation completes,\nreveal it once with the reveal endpoint. Try-it is off because the request creates a login.\n","operationId":"createSiteDatabaseUser","requestBody":{"content":{"application/json":{"examples":{"external_read_write":{"summary":"A read-write user for an outside system, with your own password and limits","value":{"confirm_read_write":"read-write","kind":"external","max_statement_time":30,"max_user_connections":5,"password":{"mode":"set","value":"example-password-not-a-secret"},"require_tls":true,"scope":"read_write","username":"erp_sync"}},"internal_read_only":{"summary":"A read-only user for a reporting tool, with a generated password","value":{"kind":"internal","password":{"mode":"generate"},"scope":"read_only","username":"reports_ro"}}},"schema":{"$ref":"#/components/schemas/DatabaseUserCreate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"operation":{"applied_at":"2026-11-03T09:16:40Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":"Saved","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Saving the change","step":"saved","steps":[{"key":"saved","label":"Saved","state":"current"},{"key":"applied","label":"Applied in the database","state":"todo"}],"subject":null,"summary":"User reports_ro added (internal, read-only)","to_version":null,"type":"db_user_change","type_label":"Database users"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"The user is being added. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/DatabaseChangeConflict"},"422":{"content":{"application/json":{"examples":{"connections_limit_too_high":{"summary":"More connections than a user can be given","value":{"code":"invalid","errors":{"max_user_connections":["Use a whole number from 1 to 1000, or leave it empty for no limit."]},"field":"max_user_connections","message":"Use a whole number from 1 to 1000, or leave it empty for no limit.","reason":"invalid"}},"external_off":{"summary":"An external user while external access is off","value":{"code":"external_off","message":"Turn on external access first: external users connect through it.","reason":"external_off"}},"limits_on_internal":{"summary":"A limit on an internal user","value":{"code":"invalid","errors":{"max_user_connections":["Limits and TLS apply to external users only."]},"field":"max_user_connections","message":"Limits and TLS apply to external users only.","reason":"invalid"}},"name_reserved":{"summary":"The name is kept for the platform","value":{"code":"invalid","errors":{"username":["That name is reserved. Choose another."]},"field":"username","message":"That name is reserved. Choose another.","reason":"invalid"}},"name_taken":{"summary":"The name is already used on this environment","value":{"code":"invalid","errors":{"username":["reporting_ro already exists on this environment (internal)."]},"field":"username","message":"reporting_ro already exists on this environment (internal).","reason":"invalid"}},"password_refused":{"summary":"A password of your own that is too short","value":{"code":"invalid","errors":{"password.value":["Use 12 to 64 printable characters, without spaces, quotes or backslashes."]},"field":"password.value","message":"Use 12 to 64 printable characters, without spaces, quotes or backslashes.","reason":"invalid"}},"read_write_confirmation_wrong":{"summary":"A confirmation that was typed and is not read-write","value":{"code":"invalid","detail_reason":"confirm_mismatch","errors":{"confirm_read_write":["A read-write user can change and delete data. Type read-write to confirm."]},"field":"confirm_read_write","message":"A read-write user can change and delete data. Type read-write to confirm.","reason":"invalid"}},"read_write_not_confirmed":{"summary":"A read-write user without its confirmation","value":{"code":"invalid","errors":{"confirm_read_write":["A read-write user can change and delete data. Type read-write to confirm."]},"field":"confirm_read_write","message":"A read-write user can change and delete data. Type read-write to confirm.","reason":"invalid"}},"statement_time_too_long":{"summary":"A longest statement of more than a day","value":{"code":"invalid","errors":{"max_statement_time":["Use a whole number from 1 to 86400, or leave it empty for no limit."]},"field":"max_statement_time","message":"Use a whole number from 1 to 86400, or leave it empty for no limit.","reason":"invalid"}},"user_cap":{"summary":"The environment has the most users it can hold","value":{"code":"user_cap","message":"You have 10 database users. That is the most one environment can hold (5 of them external). Delete one you no longer need, or ask Corefinity support.","reason":"user_cap"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`): the name, the password, a limit, or a\n`read_write` user without `confirm_read_write`. A `confirm_read_write` that is typed and is not `read-write`\nis `invalid` too, with `detail_reason: confirm_mismatch` beside it. Or the user cannot be added: `user_cap` (the\nenvironment already has 10 users, or 5 external ones) or `external_off` (an external user needs external\naccess on first).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/DatabaseUsersSwitchedOff"}},"summary":"Create a database user","tags":["Database"],"x-effect":["changes-settings"],"x-feature":"database","x-file":"database","x-gates":["database_tab"],"x-long-running":"getSiteDatabaseOperation","x-rate-limit":{"bucket":"reseller-database","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/database/users/{username}":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/DatabaseUsername"}],"patch":{"description":"Changes a user's access and, for an external user, its limits and whether it must connect with TLS: send only\nwhat changes. Sessions that are open keep their old settings until they reconnect. Try-it is off because\nmaking a user read-write needs a typed confirmation.\n","operationId":"updateSiteDatabaseUser","requestBody":{"content":{"application/json":{"examples":{"make_read_write":{"summary":"Give a read-only user read-write access","value":{"confirm_read_write":"read-write","scope":"read_write"}}},"schema":{"$ref":"#/components/schemas/DatabaseUserUpdate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"operation":{"applied_at":"2026-11-03T09:16:40Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":"Saved","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Saving the change","step":"saved","steps":[{"key":"saved","label":"Saved","state":"current"},{"key":"applied","label":"Applied in the database","state":"todo"}],"subject":null,"summary":"User reporting_ro is now read-write","to_version":null,"type":"db_user_change","type_label":"Database users"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"The change is being applied. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/DatabaseUserNotFound"},"409":{"$ref":"#/components/responses/DatabaseChangeConflict"},"422":{"content":{"application/json":{"examples":{"read_write_confirmation_wrong":{"summary":"A confirmation that was typed and is not read-write","value":{"code":"invalid","detail_reason":"confirm_mismatch","errors":{"confirm_read_write":["A read-write user can change and delete data. Type read-write to confirm."]},"field":"confirm_read_write","message":"A read-write user can change and delete data. Type read-write to confirm.","reason":"invalid"}},"read_write_not_confirmed":{"summary":"Read-write access without its confirmation","value":{"code":"invalid","errors":{"confirm_read_write":["A read-write user can change and delete data. Type read-write to confirm."]},"field":"confirm_read_write","message":"A read-write user can change and delete data. Type read-write to confirm.","reason":"invalid"}},"unchanged":{"summary":"The user already has these settings","value":{"code":"unchanged","message":"Nothing to change.","reason":"unchanged"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is wrong (`invalid`, with `field` and `errors`), such as a limit on an internal user or read-write\naccess without `confirm_read_write`; a `confirm_read_write` that is typed and is not `read-write`\n(`invalid` too, with `detail_reason: confirm_mismatch` beside it); or the user already has these settings\n(`unchanged`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/DatabaseUsersSwitchedOff"}},"summary":"Update a database user","tags":["Database"],"x-effect":["changes-settings"],"x-feature":"database","x-file":"database","x-gates":["database_tab"],"x-long-running":"getSiteDatabaseOperation","x-rate-limit":{"bucket":"reseller-database","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes the login and closes its open sessions. It cannot be undone: add the user again for a new login.\n","operationId":"deleteSiteDatabaseUser","responses":{"202":{"content":{"application/json":{"example":{"operation":{"applied_at":"2026-11-03T09:16:40Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":"Saved","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Saving the change","step":"saved","steps":[{"key":"saved","label":"Saved","state":"current"},{"key":"applied","label":"Applied in the database","state":"todo"}],"subject":null,"summary":"User reporting_ro deleted","to_version":null,"type":"db_user_change","type_label":"Database users"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"The user is being removed. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/DatabaseUserNotFound"},"409":{"$ref":"#/components/responses/DatabaseChangeConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/DatabaseUsersSwitchedOff"}},"summary":"Delete a database user","tags":["Database"],"x-effect":["deletes"],"x-feature":"database","x-file":"database","x-gates":["database_tab"],"x-long-running":"getSiteDatabaseOperation","x-rate-limit":{"bucket":"reseller-database","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/database/users/{username}/password":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/DatabaseUsername"}],"post":{"description":"Gives the user a new password: a generated one, revealed once with the reveal endpoint, or one of your own.\nThe old password stops working as soon as the operation completes; sessions that are open keep working until\nthey reconnect. Try-it is off because whatever uses the old password stops connecting.\n","operationId":"rotateSiteDatabaseUserPassword","requestBody":{"content":{"application/json":{"examples":{"generate":{"summary":"A generated password","value":{"password":{"mode":"generate"}}},"set_your_own":{"summary":"A password of your own","value":{"password":{"mode":"set","value":"example-password-not-a-secret"}}}},"schema":{"$ref":"#/components/schemas/DatabasePasswordRotate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"operation":{"applied_at":"2026-11-03T09:16:40Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":"Saved","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Saving the change","step":"saved","steps":[{"key":"saved","label":"Saved","state":"current"},{"key":"applied","label":"Applied in the database","state":"todo"}],"subject":null,"summary":"Password of reporting_ro rotated","to_version":null,"type":"db_user_change","type_label":"Database users"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"The password is being changed. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/DatabaseUserNotFound"},"409":{"$ref":"#/components/responses/DatabaseChangeConflict"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"password.value":["Use 12 to 64 printable characters, without spaces, quotes or backslashes."]},"field":"password.value","message":"Use 12 to 64 printable characters, without spaces, quotes or backslashes.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The password is missing or refused (`invalid`, with `field` and `errors`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/DatabaseUsersSwitchedOff"}},"summary":"Rotate a database user's password","tags":["Database"],"x-effect":["changes-settings"],"x-feature":"database","x-file":"database","x-gates":["database_tab"],"x-long-running":"getSiteDatabaseOperation","x-rate-limit":{"bucket":"reseller-database","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/database/users/{username}/reveal":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/DatabaseUsername"}],"post":{"description":"Answers the password generated when the user was added or its password last rotated: once, within 24 hours,\nto the person who made that change, after its operation has completed. It needs the `exec` scope, the answer\nis never cached and the reveal is recorded.\n","operationId":"revealSiteDatabaseUserPassword","responses":{"200":{"content":{"application/json":{"example":{"password":"example-password-not-a-secret","username":"reporting_ro"},"schema":{"$ref":"#/components/schemas/DatabaseRevealedPassword"}}},"description":"The password, this once. Keep it out of logs and tickets.","headers":{"Cache-Control":{"description":"Always `no-store, private`.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/DatabaseUserNotFound"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"410":{"content":{"application/json":{"example":{"code":"reveal_gone","message":"This password can no longer be shown. Rotate it to get a new one.","reason":"reveal_gone"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The password cannot be shown (`reveal_gone`): it was shown already, you set it yourself, it is more than\n24 hours old, somebody else made the change, or a later rotation replaced it. Rotate the password to get\na new one.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Reveal a generated password once","tags":["Database"],"x-effect":["reveals-secret"],"x-feature":"database","x-file":"database","x-gates":["database_tab"],"x-rate-limit":{"bucket":"reseller-database-reveal","limit":10,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers how the site deploys, its repository and branch, the repository connections you may use on it and its\nlast 10 deployments, newest first. Read it again to follow a deployment you started.\n","operationId":"getSiteDeployments","responses":{"200":{"content":{"application/json":{"examples":{"git":{"$ref":"#/components/examples/SiteDeploymentSettingsGitExample"},"manual":{"$ref":"#/components/examples/SiteDeploymentSettingsManualExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentSettings"}}},"description":"The deployment settings and the last 10 deployments."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's deployment settings","tags":["Deployments"],"x-feature":"deployments","x-file":"deployments","x-gates":["deployments"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"Deploys the connected branch, or the branch or commit named in `ref`, and answers the new deployment with\n`status` `queued`. Follow it with `GET /corestack/sites/{site}/deployments`. Your role needs the Create\nDeployments permission.\n","operationId":"createSiteDeployment","requestBody":{"content":{"application/json":{"examples":{"connected_branch":{"summary":"Deploy the connected branch","value":{}},"ref":{"summary":"Deploy a named branch","value":{"ref":"main"}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentCreateRequest"}}},"required":false},"responses":{"201":{"content":{"application/json":{"examples":{"queued":{"$ref":"#/components/examples/SiteDeploymentQueuedExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentAnswer"}}},"description":"The new deployment, queued."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentForbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"value":{"message":"Not found."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/FeatureOffRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site does not exist or is one you cannot deploy, `binding_id` is not a pipeline of this site, or\ndeployments are not on for your company (`feature_off`).\n"},"409":{"content":{"application/json":{"examples":{"busy":{"$ref":"#/components/examples/SiteDeploymentBusyRefusalExample"},"deployment_running":{"$ref":"#/components/examples/SiteDeploymentRunningRefusalExample"},"mode":{"$ref":"#/components/examples/SiteDeploymentModeRefusalExample"},"needs_reauth":{"summary":"The repository's connection no longer exists","value":{"code":"needs_reauth","message":"The repository's connection no longer exists. Connect the repository again.","reason":"needs_reauth"}},"pipeline_untranslated":{"summary":"A pipeline moved from CoreStack Enterprise is not translated yet","value":{"code":"pipeline_untranslated","message":"This pipeline came from CoreStack Enterprise and has not been translated yet. Open the deployment settings to review it.","reason":"pipeline_untranslated"}},"stale":{"summary":"A deployment that was waiting can no longer be started","value":{"code":"stale","message":"This waiting deployment can no longer be started. Refresh and check its pipeline.","reason":"stale"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site cannot deploy now. `reason` says why: `mode` (the site deploys by upload, or its files are not in\nthe releases layout yet), `deployment_running`, `busy` (another change to the site is in progress),\n`restore_running`, `command_running`, `needs_reauth` (the repository's connection is gone or needs\nre-authorising), `site_content_off` (deploying site content is paused by Corefinity),\n`pipeline_untranslated`, `pipeline_review_pending` or `pipeline_switched_off` (the pipeline cannot run\nyet), `tunnels_switched_off` or `runtime_not_adopted` (the build cannot reach the site's services),\n`exec_unresolved` or `install_running` (contact support), `managed_elsewhere`, `deleted` or `removed`;\n`stale` means a deployment that was waiting could no longer be started: read the deployments again.\n"},"422":{"content":{"application/json":{"examples":{"feature_off":{"summary":"Choosing a pipeline is not on","value":{"code":"feature_off","field":"binding_id","message":"Choosing a pipeline binding is not available yet. Deploy without binding_id to use the repository's.","reason":"feature_off"}},"invalid":{"summary":"The ref is not a branch or a commit","value":{"code":"invalid","errors":{"ref":["Enter a branch name or a commit SHA"]},"field":"ref","message":"Enter a branch name or a commit SHA","reason":"invalid"}},"no_repository":{"summary":"No repository is connected","value":{"code":"no_repository","message":"Connect a repository first","reason":"no_repository"}},"unreachable":{"summary":"A self-hosted GitLab whose address cannot be reached","value":{"message":"GitLab (self-hosted) at this connection's address cannot be reached: That address is not a public web address the Control Panel can reach."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"`ref` is not a branch name or a commit SHA, or a field is wrong (`invalid`); `binding_id` was sent while\nchoosing a pipeline is not on for your company (`feature_off`, naming the field); no repository is\nconnected (`no_repository`); or the git provider's address cannot be reached (a message only).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/ProviderNoAnswer"},"503":{"content":{"application/json":{"examples":{"not_started":{"summary":"The waiting deployment could not be started","value":{"message":"The deployment could not be started. Try again in a moment."}}},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"A deployment that was waiting could not be started. Try again in a moment.","x-unverified":true}},"summary":"Create a site deployment","tags":["Deployments"],"x-effect":["runs-code","overwrites"],"x-feature":"deployments","x-file":"deployments","x-gates":["deployments"],"x-rate-limit":{"bucket":"reseller-deploy","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"deploy","when":"Always"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/branches":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Asks the git provider for the branches of one repository the connection can see, the default branch first,\nthen by name, at most 200. You must be someone who may deploy the site.\n","operationId":"listSiteDeploymentBranches","parameters":[{"$ref":"#/components/parameters/SiteDeploymentConnection"},{"description":"The repository as `owner/name`, or `group/subgroup/name` on GitLab.","example":"northwind-digital/harbourandfinch","in":"query","name":"repo","required":true,"schema":{"maxLength":200,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"branches":{"value":{"branches":[{"default":true,"name":"main","sha":"9730595c6ec7aa59b77674ada74e30d961b1817c"},{"default":false,"name":"develop","sha":"4b1f0c9d2e7a8b6c5d4e3f2a1b0c9d8e7f6a5b4c"}]}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentBranchList"}}},"description":"The branches."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/SiteDeploymentConnectionNotFound"},"409":{"$ref":"#/components/responses/SiteDeploymentConnectionNeedsReauth"},"422":{"content":{"application/json":{"examples":{"invalid":{"$ref":"#/components/examples/SiteDeploymentRepoShapeRefusalExample"},"unreachable":{"summary":"A self-hosted GitLab whose address cannot be reached","value":{"message":"GitLab (self-hosted) at this connection's address cannot be reached: That address is not a public web address the Control Panel can reach."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"`connection` or `repo` is missing, `repo` is not `owner/name`, or the repository was not found with this\nconnection (`invalid`). A git provider whose address cannot be reached answers a message only.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/ProviderNoAnswer"}},"summary":"List a repository's branches","tags":["Deployments"],"x-feature":"deployments","x-file":"deployments","x-gates":["deployments"],"x-rate-limit":{"bucket":"reseller-deploy-browse","limit":30,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/build-caches/clear":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Removes what the build servers keep between this site's builds, such as downloaded packages. The next build\nstarts from nothing and takes longer; later builds are quick again.\n","operationId":"clearSiteDeploymentBuildCaches","responses":{"200":{"content":{"application/json":{"examples":{"cleared":{"summary":"One build server cleared","value":{"cleared":[{"bytes":4096,"server":"Build server 1"}]}}},"schema":{"properties":{"cleared":{"items":{"properties":{"bytes":{"description":"How much was removed, in bytes. Null when the build server could not be reached.","minimum":0,"type":["integer","null"]},"server":{"type":"string"}},"required":["server","bytes"],"type":"object"},"type":"array"}},"required":["cleared"],"type":"object"}}},"description":"What was cleared, by build server."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Clear a site's build caches","tags":["Deployment pipeline"],"x-effect":["deletes"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/carried-over":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"For an environment that was moved from CoreStack Enterprise, answers the build, database and after-deploy\ncommands that came with it, translated into the three stages line by line, with the ones that need a person to\nlook at them. `bindings` is empty when nothing was carried over.\n","operationId":"getSiteDeploymentCarriedOver","responses":{"200":{"content":{"application/json":{"examples":{"needs_review":{"summary":"One line needs a look","value":{"attention_id":"deploy_pipeline_carried:1042","auto_deploy":false,"bindings":[{"also_set":["Maintenance page: off"],"binding_id":2210,"label":"Default pipeline","lines":[{"change":"kept","needs_review":false,"result":[{"stage":"build","text":"composer install --no-dev"}],"source":{"index":0,"stage":"build"},"text":"composer install --no-dev"},{"change":"rewritten","needs_review":true,"reason":"Copies from the old server need a look","result":[{"stage":"build","text":"scp web@old.harbourandfinch.example.org:/var/www/media.tgz ."}],"source":{"index":1,"stage":"build"},"text":"scp web@old.harbourandfinch.example.org:/var/www/media.tgz ."}],"rehearsal":null,"repository":{"branch":"main","provider":"gitlab","repo":"northwind-digital/harbourandfinch"},"revision":null,"state":"needs_review"}],"files_mode":false,"moved_at":null}},"nothing":{"summary":"Nothing was carried over","value":{"attention_id":null,"auto_deploy":false,"bindings":[],"files_mode":false,"moved_at":null}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentCarriedOver"}}},"description":"What was carried over."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's carried-over pipeline","tags":["Deployment pipeline"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/carried-over/accept":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Decides the carried-over lines of one pipeline and turns it into a three-stage pipeline. Each line that needs\na look is accepted, removed or edited; `lines` `[]` accepts the translation as it is, once no line needs a\nlook. Your role needs the Edit Environment Deployment Pipeline permission.\n","operationId":"acceptSiteDeploymentCarriedOver","requestBody":{"content":{"application/json":{"examples":{"remove":{"summary":"Remove the one line that needs a look","value":{"binding_id":2210,"lines":[{"action":"remove","index":1,"stage":"build"}]}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentCarriedOverAcceptRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"accepted":{"summary":"An accepted pipeline","value":{"attention_id":"deploy_pipeline_carried:1042","auto_deploy":false,"bindings":[{"also_set":["Maintenance page: off"],"binding_id":2210,"label":"Default pipeline","lines":[{"change":"kept","needs_review":false,"result":[{"stage":"build","text":"composer install --no-dev"}],"source":{"index":0,"stage":"build"},"text":"composer install --no-dev"},{"change":"removed","needs_review":false,"reason":"Copies from the old server need a look","result":[],"source":{"index":1,"stage":"build"},"text":"scp web@old.harbourandfinch.example.org:/var/www/media.tgz ."}],"rehearsal":null,"repository":{"branch":"main","provider":"gitlab","repo":"northwind-digital/harbourandfinch"},"revision":"e64e702d17d85dd8","state":"accepted"}],"files_mode":false,"moved_at":null}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentCarriedOver"}}},"description":"What was carried over, with the pipeline now accepted."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentPipelineWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"nothing":{"summary":"Nothing was carried over","value":{"code":"not_available","message":"Nothing was carried over for this pipeline.","reason":"not_available"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was carried over for this pipeline (`not_available`), the translation changed since it was read\n(`stale`), a credential in it cannot be moved into a deployment variable (`variable_invalid`: contact\nsupport), Corefinity has locked the pipeline (`pipeline_locked`), or the site is managed by another control\npanel (`managed_elsewhere`).\n"},"422":{"content":{"application/json":{"examples":{"edit":{"summary":"An edit whose text is on two lines","value":{"code":"invalid","errors":{"lines.0":["An edit needs its new text, on one line."]},"field":"lines.0","message":"An edit needs its new text, on one line.","reason":"invalid"}},"line_credentials":{"summary":"An edit that holds a credential","value":{"code":"line_credentials","errors":{"lines.1":["This line holds a credential. Move this value into a variable, then save again."]},"message":"This line holds a credential. Move this value into a variable, then save again.","reason":"line_credentials"}},"lines":{"summary":"Lines that are not a list","value":{"code":"invalid","errors":{"lines":["Choose what to do with at least one line."]},"field":"lines","message":"Choose what to do with at least one line.","reason":"invalid"}},"magerun":{"summary":"A line that still runs n98-magerun, accepted as it is","value":{"code":"invalid","errors":{"lines.0":["This line still runs n98-magerun, which CoreStack does not have, so the deployment would fail on it. Edit it to run its Magento commands as php bin/magento instead, or remove it."]},"field":"lines.0","message":"This line still runs n98-magerun, which CoreStack does not have, so the deployment would fail on it. Edit it to run its Magento commands as php bin/magento instead, or remove it.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`lines` is not a list of decisions, or a decision is not one the line can take (`invalid`, with the `field`,\nsuch as `lines.0`): a line that still runs n98-magerun cannot be accepted as it is, and a line that picks\nthe Node.js version cannot be edited. Or the lines an edit leaves are refused as a save of them would be,\nthe field named in `errors` only: `line_credentials` (an edit holds a credential), `line_too_long` or\n`too_many_lines`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Accept a carried-over pipeline","tags":["Deployment pipeline"],"x-effect":["changes-settings","overwrites"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"An edit brings new text"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/mode":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"Switches the site between deploying from git (`git`) and by upload (`manual`). Switching to git answers `201`\nwith the `operation` that moves the site's files into the releases layout; switching to manual answers `200`\nwith the `command` that moves them back, or null when the site already deploys by upload. Your role needs the\nManage Deployment Source permission.\n","operationId":"updateSiteDeploymentMode","requestBody":{"content":{"application/json":{"examples":{"git":{"summary":"Deploy from git","value":{"mode":"git"}},"manual":{"summary":"Deploy by upload","value":{"mode":"manual"}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentModeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"already_manual":{"$ref":"#/components/examples/SiteDeploymentModeManualExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentModeManualAnswer"}}},"description":"The settings, and the command that switches the site to manual deployments, if one was started."},"201":{"content":{"application/json":{"examples":{"converting":{"$ref":"#/components/examples/SiteDeploymentModeGitExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentModeGitAnswer"}}},"description":"The settings, and the operation that moves the site's files into the releases layout."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentForbidden","description":"As every site deployment change, with one more case: switching back to `git` while automatic deployment was\nleft on makes each push deploy on its own again, so it also needs the Create Deployments permission.\n"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"bedrock_layout":{"summary":"A WordPress site built with Bedrock","value":{"code":"bedrock_layout","message":"This WordPress site is built with Bedrock, so it cannot switch to manual deployments yet. Keep deploying it with Git.","reason":"bedrock_layout"}},"busy":{"$ref":"#/components/examples/SiteDeploymentBusyRefusalExample"},"layout_unknown":{"summary":"The site's layout could not be confirmed","value":{"code":"layout_unknown","message":"The Control Panel could not confirm whether this WordPress site is built with Bedrock, so it stays on Git deployments. Try again in a minute.","reason":"layout_unknown"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The mode cannot change now. `reason` says why: `busy` (another change to the site is in progress),\n`deployment_running`, `bedrock_layout` (a WordPress site built with Bedrock cannot switch to `manual`\nyet), `layout_unknown` (how the WordPress site is built could not be confirmed: try again in a minute),\n`managed_elsewhere`, `deleted` or `removed`. Another `reason` means the conversion could not start, and\nthe message says why.\n"},"422":{"content":{"application/json":{"examples":{"already_git":{"summary":"The site already deploys from git","value":{"code":"invalid","errors":{"mode":["This site already uses git deployments"]},"field":"mode","message":"This site already uses git deployments","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`mode` is missing or is not `git` or `manual`, or the site already deploys from git (send `reconvert`\ntrue only while its conversion is pending).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"content":{"application/json":{"examples":{"commands_off":{"summary":"Site commands are switched off","value":{"message":"Site commands are switched off at the moment"}}},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"Switching to `manual` moves the site's files with a site command, and Corefinity has switched site commands\noff for the moment. A message only, with no `reason`.\n"}},"summary":"Update how a site deploys","tags":["Deployments"],"x-effect":["changes-settings","runs-code","overwrites"],"x-feature":"deployments","x-file":"deployments","x-gates":["deployments"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-deploy","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/options":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"Changes the deployment options you send and keeps the rest: the extra paths kept between releases, the paths a\nbuild may read, the check before the switch, the warm-up and the cache purges. A list is sent whole and\nreplaces the saved one. Your role needs the Edit Environment Deployment Pipeline permission.\n","operationId":"updateSiteDeploymentOptions","requestBody":{"content":{"application/json":{"examples":{"options":{"summary":"Keep two more paths between releases","value":{"cloudflare_purge":false,"extra_shared_paths":["public/uploads","var/exports"]}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentOptionsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"options":{"summary":"The options","value":{"build_reads":[],"cloudflare_purge":false,"extra_shared_paths":[{"kind":"dir","path":"public/uploads"},{"kind":"dir","path":"var/exports"}],"migrate":false,"platform_shared":[{"kind":"dir","path":"storage"},{"kind":"file","path":".env"}],"pre_switch_check":false,"snapshot_before_upgrade":false,"warm_up":false}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentOptions"}}},"description":"The deployment options after the change."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentPipelineWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"422":{"content":{"application/json":{"examples":{"build_reads":{"summary":"More than 50 paths a build may read","value":{"code":"invalid","errors":{"build_reads":["Enter at most 50 paths."]},"field":"build_reads","message":"Enter at most 50 paths.","reason":"invalid"}},"check_paths":{"summary":"A sixth path to check before the switch","value":{"code":"invalid","errors":{"pre_switch_check":["Enter up to five paths, each starting with a slash."]},"field":"pre_switch_check","message":"Enter up to five paths, each starting with a slash.","reason":"invalid"}},"switch":{"summary":"A switch that is neither on nor off","value":{"code":"invalid","errors":{"warm_up":["Turn this on or off."]},"field":"warm_up","message":"Turn this on or off.","reason":"invalid"}},"warm_up_paths":{"summary":"An eleventh path to warm up","value":{"code":"invalid","errors":{"warm_up":["Enter up to ten paths, each starting with a slash."]},"field":"warm_up","message":"Enter up to ten paths, each starting with a slash.","reason":"invalid"}},"wrong_platform":{"summary":"A snapshot before an upgrade, on a site that is not Magento 2","value":{"code":"wrong_platform","errors":{"snapshot_before_upgrade":["A snapshot before an upgrade is available for Magento 2 sites only."]},"message":"A snapshot before an upgrade is available for Magento 2 sites only.","reason":"wrong_platform"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"An option is not a value it takes (`invalid`, with the `field`): a switch that is neither true nor false,\na path that is not one, a list longer than it may be (50 extra paths, 50 paths a build may read, five\npaths to check, ten to warm up), or an extra path that overlaps another. Or the option is one only a\nMagento 2 site has (`wrong_platform`): `snapshot_before_upgrade` and `varnish_purge`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a site's deployment options","tags":["Deployment pipeline"],"x-effect":["changes-settings","overwrites"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/pipeline":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the environment's pipeline: the build, database and after-deploy stages with each line and what the\nplatform makes of it, the settings, the build presets on offer, the deployment options and the template each\nstage follows. `revision` is what a save sends back, so a pipeline somebody else changed in the meantime is\nnot overwritten. A pipeline that does not have the three stages yet answers `stages` and `settings` null, with\nthe commands it runs in `classic` and why it cannot be edited in `can`.\n","operationId":"getSiteDeploymentPipeline","parameters":[{"description":"One of the environment's pipelines, as `bindings[].id` names them. The default pipeline when left out.","in":"query","name":"binding_id","required":false,"schema":{"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"pipeline":{"$ref":"#/components/examples/SiteDeploymentPipelineExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentPipeline"}}},"description":"The pipeline."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's deployment pipeline","tags":["Deployment pipeline"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/pipeline/check":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Says what the platform makes of each line of a stage: whether it only touches files or needs the environment's\nservices, and whether a build with these lines would open a tunnel to them. It stores nothing and runs\nnothing.\n","operationId":"checkSiteDeploymentPipelineLines","requestBody":{"content":{"application/json":{"examples":{"build":{"summary":"Two build lines","value":{"lines":["composer install --no-dev","php artisan migrate --force"],"stage":"build"}}},"schema":{"properties":{"binding_id":{"description":"One of the environment's pipelines. The default pipeline when left out.","minimum":1,"type":"integer"},"lines":{"items":{"type":"string"},"maxItems":200,"type":"array"},"stage":{"enum":["build","database","post_deploy"],"type":"string"}},"required":["stage","lines"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"checked":{"summary":"One line that touches files and one that needs the database","value":{"lines":[{"badges":[],"rule":"composer.install","suggestion":null,"verdict":"files","warnings":[]},{"badges":[{"id":"uses_services","label":"Uses this environment's services","severity":"info"}],"rule":"laravel.migrate","suggestion":null,"verdict":"services","warnings":[]}],"stage":"build","tunnels":{"declared_by":[2],"open":true,"services":[{"key":"database","label":"MariaDB"},{"key":"redis","label":"Valkey"}]}}}},"schema":{"properties":{"lines":{"items":{"additionalProperties":true,"properties":{"badges":{"items":{"$ref":"#/components/schemas/SiteDeploymentPipelineBadge"},"type":"array"},"rule":{"description":"The rule that recognised the line.","type":["string","null"]},"suggestion":{"type":["string","object","null"]},"verdict":{"description":"Such as `files` for a line that only touches files, or `services` for one that needs the environment's services.","type":"string"},"warnings":{"items":{},"type":"array"}},"required":["verdict","badges","warnings"],"type":"object"},"type":"array"},"stage":{"type":"string"},"tunnels":{"additionalProperties":true,"description":"Whether a build with these lines opens a tunnel to the environment's services, and to which.","type":"object"}},"required":["stage","lines","tunnels"],"type":"object"}}},"description":"What the platform makes of each line, in the order sent."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"stage":{"summary":"No such stage","value":{"code":"invalid","errors":{"lines":["Send the stage and its lines."]},"field":"lines","message":"Send the stage and its lines.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The stage is not one of the three, or `lines` is missing (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Check a stage's lines before saving","tags":["Deployment pipeline"],"x-effect":["none"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/pipeline/{binding}/copy":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentPipelineBinding"}],"post":{"description":"Copies the chosen parts of the pipeline of another environment of the same site onto this one: its stages,\nsettings, variables, registry secrets and deployment options. Send `dry_run` true to see what would change and\nwrite nothing; copying onto a production environment needs `confirm_production` true. Your role needs the Edit\nEnvironment Deployment Pipeline permission.\n","operationId":"copySiteDeploymentPipeline","requestBody":{"content":{"application/json":{"examples":{"copy":{"summary":"Copy production's stages and settings","value":{"from_site_id":1042,"parts":["stages","settings"],"revision":"3b4b4f4d2bd57cc6"}},"dry_run":{"summary":"See what copying production's stages and settings would change","value":{"dry_run":true,"from_site_id":1042,"parts":["stages","settings"],"revision":"3b4b4f4d2bd57cc6"}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentPipelineCopyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"copied":{"summary":"The after-deploy stage replaced, the settings already the same","value":{"dry_run":false,"from_site_id":1042,"parts":[{"added":[],"overwritten":["post_deploy"],"part":"stages","removed":[],"unchanged":["build","database"]},{"added":[],"overwritten":[],"part":"settings","removed":[],"unchanged":["maintenance_policy","tunnels","pause_crons","run_migrations","timeouts","keep_node_modules"]}]}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentPipelineCopyAnswer"}}},"description":"What was, or would be, copied, part by part."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentPipelineWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteDeploymentPipelineConflict"},"422":{"$ref":"#/components/responses/SiteDeploymentPipelineRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Copy a pipeline from another environment","tags":["Deployment pipeline"],"x-effect":["overwrites"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"The copied stages bring a command this pipeline does not run now (never for a dry run)"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/pipeline/{binding}/restore":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentPipelineBinding"}],"post":{"description":"Puts the pipeline's stages and settings back to a kept version, as a new version, and answers the whole\npipeline. Only a version the list marks `restorable` can be restored, and your role needs the Edit Environment\nDeployment Pipeline permission.\n","operationId":"restoreSiteDeploymentPipeline","requestBody":{"content":{"application/json":{"examples":{"restore":{"summary":"Restore version 5001","value":{"revision":"46949b2b48a5494e","version_id":5001}}},"schema":{"properties":{"revision":{"description":"The pipeline revision you read.","type":"string"},"version_id":{"description":"The version to restore.","minimum":1,"type":"integer"}},"required":["version_id","revision"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"pipeline":{"$ref":"#/components/examples/SiteDeploymentPipelineExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentPipeline"}}},"description":"The pipeline after the restore."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentPipelineWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteDeploymentPipelineConflict"},"422":{"$ref":"#/components/responses/SiteDeploymentPipelineRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Restore a version of a pipeline","tags":["Deployment pipeline"],"x-effect":["overwrites"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/pipeline/{binding}/settings":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentPipelineBinding"}],"put":{"description":"Changes the settings you send, keeps the rest and answers the whole pipeline. `timeouts` is one setting: its\nmap is sent whole. Send the `revision` you read: a pipeline that changed since is refused `stale`. Your role\nneeds the Edit Environment Deployment Pipeline permission.\n","operationId":"updateSiteDeploymentPipelineSettings","requestBody":{"content":{"application/json":{"examples":{"settings":{"summary":"Never open tunnels, and run migrations","value":{"revision":"413c6ef3a8a3ffe9","run_migrations":true,"tunnels":"off"}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentPipelineSettingsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"pipeline":{"$ref":"#/components/examples/SiteDeploymentPipelineExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentPipeline"}}},"description":"The pipeline after the save."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentPipelineWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteDeploymentPipelineConflict"},"422":{"$ref":"#/components/responses/SiteDeploymentPipelineRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a pipeline's settings","tags":["Deployment pipeline"],"x-effect":["changes-settings"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/pipeline/{binding}/stages/{stage}":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentPipelineBinding"},{"example":"post_deploy","in":"path","name":"stage","required":true,"schema":{"enum":["build","database","post_deploy"],"type":"string"}}],"put":{"description":"Replaces one stage and answers the whole pipeline; the next deployment runs the saved stage. Send the\n`revision` you read: a pipeline that changed since is refused `stale`. Your role needs the Edit Environment\nDeployment Pipeline permission.\n","operationId":"replaceSiteDeploymentPipelineStage","requestBody":{"content":{"application/json":{"examples":{"lines":{"summary":"Set the after-deploy lines","value":{"lines":["php artisan queue:restart","php artisan config:cache"],"revision":"413c6ef3a8a3ffe9"}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentPipelineStageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"pipeline":{"$ref":"#/components/examples/SiteDeploymentPipelineExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentPipeline"}}},"description":"The pipeline after the save."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentPipelineWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteDeploymentPipelineConflict"},"422":{"$ref":"#/components/responses/SiteDeploymentPipelineRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Replace a stage of a pipeline","tags":["Deployment pipeline"],"x-effect":["changes-settings","overwrites"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"The save brings a command the pipeline does not run now"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/pipeline/{binding}/template-reset":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentPipelineBinding"}],"post":{"description":"Makes the named stages follow the company's deployment template again, replacing what the pipeline holds for\nthem, and answers the whole pipeline. A production environment needs `confirm_production` true, and your role\nneeds the Edit Environment Deployment Pipeline permission.\n","operationId":"resetSiteDeploymentPipelineToTemplate","requestBody":{"content":{"application/json":{"examples":{"reset":{"summary":"Make the after-deploy stage of production follow its template","value":{"confirm_production":true,"revision":"40db515d599e2f77","stages":["post_deploy"]}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentPipelineTemplateResetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"pipeline":{"$ref":"#/components/examples/SiteDeploymentPipelineExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentPipeline"}}},"description":"The pipeline after the reset."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentPipelineWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteDeploymentPipelineConflict"},"422":{"$ref":"#/components/responses/SiteDeploymentPipelineRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Reset a pipeline's stages to its template","tags":["Deployment pipeline"],"x-effect":["overwrites"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline","deploy_templates"],"x-rate-limit":{"bucket":"corecluster-deploy-templates","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"The pipeline gains a command it does not run now"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/pipeline/{binding}/versions":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentPipelineBinding"}],"get":{"description":"Answers the pipeline's kept versions, newest first: who saved each, which stages it changed and whether it\ncan be restored. Every kept version is on one page.\n","operationId":"listSiteDeploymentPipelineVersions","parameters":[{"description":"Only the versions that changed this stage or the settings.","in":"query","name":"stage","required":false,"schema":{"enum":["build","database","post_deploy"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"versions":{"summary":"Two versions","value":{"data":[{"at":"2026-11-09T10:42:07Z","by":"Maya Okafor","changed":["settings"],"number":2,"restorable":false,"restorable_reason":"This is the current version.","source":"editor","version_id":5002},{"at":"2026-11-02T09:15:30Z","by":"Maya Okafor","changed":["post_deploy"],"number":1,"restorable":true,"restorable_reason":null,"source":"editor","version_id":5001}],"next_cursor":null}}},"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SiteDeploymentPipelineVersionSummary"},"type":"array"},"next_cursor":{"description":"Always null.","type":"null"}},"required":["data","next_cursor"],"type":"object"}}},"description":"The versions."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"stage":{"summary":"A stage that is not one","value":{"code":"invalid","errors":{"stage":["Choose build, database or post_deploy."]},"field":"stage","message":"Choose build, database or post_deploy.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`stage` is not one of the three stages (`invalid` on `stage`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a pipeline's versions","tags":["Deployment pipeline"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/pipeline/{binding}/versions/{version}":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentPipelineBinding"},{"description":"The `version_id` of one of the pipeline's versions. Digits only.","example":5001,"in":"path","name":"version","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers the stages and settings as that version held them, with `diff`: for each stage that differs from the\ncurrent pipeline, or from the version named in `compare_to`, its lines before and after, and under `settings`\neach setting that differs. `diff` is null when nothing differs. A version kept of a pipeline that did not have\nthe three stages yet answers `stages` and `settings` null.\n","operationId":"getSiteDeploymentPipelineVersion","parameters":[{"description":"Another `version_id` to compare with, or `current` for the current pipeline, which is the default.","in":"query","name":"compare_to","required":false,"schema":{"anyOf":[{"const":"current","type":"string"},{"minimum":1,"type":"integer"}]}}],"responses":{"200":{"content":{"application/json":{"examples":{"identical":{"summary":"The current version, compared with the current pipeline","value":{"at":"2026-11-09T10:42:07Z","by":"Maya Okafor","changed":["settings"],"compare_to":"current","diff":null,"number":2,"restorable":false,"restorable_reason":"This is the current version.","settings":{"keep_node_modules":false,"maintenance_policy":"off","pause_crons":"auto","run_migrations":null,"timeouts":{"build":3600,"build_line":3600,"database_line":600,"post_line":600},"tunnels":"off"},"source":"editor","stages":{"build":{"effective":[],"hooks":[],"lines":[],"mode":"preset","preset":{"frontend":[],"options":[],"platform":"none"}},"database":{"lines":[],"platform_step_at":0},"post_deploy":{"lines":[{"badges":[],"comments":[],"origin":"custom","text":"php artisan queue:restart","verdict":"services"},{"badges":[{"id":"replaced_by_platform","label":"Replaced by a CoreStack step","severity":"info"}],"comments":[],"origin":"custom","text":"php artisan config:cache","verdict":"platform_duplicate"}]}},"version_id":5002}},"version":{"summary":"A version, compared with the current pipeline","value":{"at":"2026-11-02T09:15:30Z","by":"Maya Okafor","changed":["post_deploy"],"compare_to":"current","diff":{"post_deploy":{"after":["php artisan queue:restart","php artisan config:cache"],"before":["php artisan queue:restart"]},"settings":{"tunnels":{"after":"off","before":"auto"}}},"number":1,"restorable":true,"restorable_reason":null,"settings":{"keep_node_modules":false,"maintenance_policy":"off","pause_crons":"auto","run_migrations":null,"timeouts":{"build":3600,"build_line":3600,"database_line":600,"post_line":600},"tunnels":"auto"},"source":"editor","stages":{"build":{"effective":[],"hooks":[],"lines":[],"mode":"preset","preset":{"frontend":[],"options":[],"platform":"none"}},"database":{"lines":[],"platform_step_at":0},"post_deploy":{"lines":[{"badges":[],"comments":[],"origin":"custom","text":"php artisan queue:restart","verdict":"services"}]}},"version_id":5001}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentPipelineVersion"}}},"description":"The version."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"compare_to":{"summary":"Not a version's id","value":{"code":"invalid","errors":{"compare_to":["Compare with current or with a version's id."]},"field":"compare_to","message":"Compare with current or with a version's id.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`compare_to` is neither `current` nor a version's id (`invalid` on `compare_to`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get one version of a pipeline","tags":["Deployment pipeline"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/rehearsals":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Runs a pipeline's stages on a staging environment without changing what the environment serves, to show\nwhether a deployment would succeed. Only one rehearsal of an environment runs at a time, and a production\nenvironment is never rehearsed on. Your role needs the Edit Environment Deployment Pipeline permission, and\nthe token the `deploy` ability as well as the `exec` scope: a rehearsal builds and runs a deployment.\n","operationId":"startSiteDeploymentRehearsal","requestBody":{"content":{"application/json":{"examples":{"own":{"summary":"Rehearse the staging environment's own pipeline","value":{"binding_id":2211}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentRehearsalRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"started":{"summary":"A rehearsal that is running","value":{"rehearsal":{"binding_id":2211,"finished_at":null,"id":77,"per_stage":{"build":"skipped","database":"skipped","platform_step":"pending","shared_files":"pending","upload":"pending"},"skipped":[],"started_at":"2026-11-09T10:42:07Z","state":"running"}}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentRehearsalAnswer"}}},"description":"The rehearsal started."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"permission":{"summary":"The role lacks Edit Environment Deployment Pipeline","value":{"code":"forbidden","message":"You need the Edit Environment Deployment Pipeline permission to do this. An owner of your company can grant it in Roles.","permission":"editEnvironmentDeploymentPipeline","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the exec scope this needs. Use a token with the exec scope.","reason":"scope_required","scope":"exec"}},"token_cannot_deploy":{"summary":"The token lacks the deploy ability","value":{"code":"scope_required","message":"This access token cannot deploy.","reason":"scope_required","scope":"deploy"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `exec` scope or the `deploy` ability (`scope_required`; `scope` names which), your\ncompany requires two-factor authentication and you have not set it up, or your role lacks the Edit\nEnvironment Deployment Pipeline permission (`forbidden`, with `permission`).\n"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"deployment_running":{"summary":"A rehearsal or a deployment is running","value":{"code":"deployment_running","message":"A deployment is running. Wait for it to finish, or stop it from its page.","reason":"deployment_running"}},"production":{"summary":"A production environment","value":{"code":"rehearsal_production","message":"Rehearse on a staging environment of this site first.","reason":"rehearsal_production"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The rehearsal cannot start as things are. `reason` says why: `rehearsal_production` (a production\nenvironment), `deployment_running` or `busy` (a deployment or another rehearsal is running), `restore_running`,\n`command_running`, `install_running` or `exec_unresolved` (other work is running on it, or an earlier\ncommand's outcome is still being checked), `pipeline_classic`,\n`pipeline_untranslated`, `pipeline_review_pending` or `pipeline_switched_off` (the pipeline cannot run as\nthree stages yet), `not_available` (the environment has no pipeline to rehearse on),\n`tunnels_switched_off`, `host_key_unconfirmed`, `needs_reauth` (reconnect the git account), `stale` or\n`pipeline_locked` (a proposal that cannot be saved), `removed` or `managed_elsewhere`.\n"},"422":{"content":{"application/json":{"examples":{"binding":{"summary":"No pipeline named","value":{"code":"invalid","errors":{"binding_id":["Choose the pipeline to rehearse."]},"field":"binding_id","message":"Choose the pipeline to rehearse.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is wrong (`invalid`, with the `field`), the site has no repository connected (`no_repository`), or\na proposed stage or setting is refused as a save of it would be, its field under `proposal.`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/ProviderNoAnswer"},"503":{"content":{"application/json":{"examples":{"switched_off":{"summary":"Commands are switched off","value":{"code":"switched_off","message":"Site commands are switched off at the moment","reason":"switched_off","switch":"exec"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has switched commands on sites off for the moment (`switched_off`). Try again later."}},"summary":"Start a pipeline rehearsal","tags":["Deployment pipeline"],"x-effect":["runs-code"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline","exec"],"x-long-running":"getSiteDeploymentRehearsal","x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"exec","x-scope-extra":[{"needs":"deploy","when":"Always"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/rehearsals/{rehearsal}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of a rehearsal of this environment. Digits only.","example":77,"in":"path","name":"rehearsal","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers a rehearsal and how far it has got. Read it until `state` is no longer `running`.\n","operationId":"getSiteDeploymentRehearsal","responses":{"200":{"content":{"application/json":{"examples":{"running":{"summary":"A rehearsal that is running","value":{"rehearsal":{"binding_id":2211,"finished_at":null,"id":77,"per_stage":{"build":"skipped","database":"skipped","platform_step":"pending","shared_files":"pending","upload":"pending"},"skipped":[],"started_at":"2026-11-09T10:42:07Z","state":"running"}}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentRehearsalAnswer"}}},"description":"The rehearsal."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a rehearsal","tags":["Deployment pipeline"],"x-feature":"deployment-pipeline","x-file":"deployment-pipeline","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/repositories":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Asks the git provider for the repositories the connection's account can see, most recently updated first, at\nmost 50. `q` searches part of their names. You must be someone who may deploy the site.\n","operationId":"listSiteDeploymentRepositories","parameters":[{"$ref":"#/components/parameters/SiteDeploymentConnection"},{"description":"Part of a repository's name.","example":"shop","in":"query","name":"q","required":false,"schema":{"maxLength":100,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"repositories":{"value":{"repositories":[{"admin":true,"default_branch":"main","name":"harbourandfinch","repo":"northwind-digital/harbourandfinch","url":"https://gitlab.example.com/northwind-digital/harbourandfinch"},{"admin":false,"default_branch":"main","name":"harbourandfinch-theme","repo":"northwind-digital/harbourandfinch-theme","url":"https://gitlab.example.com/northwind-digital/harbourandfinch-theme"}]}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentRepositoryList"}}},"description":"The repositories."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/SiteDeploymentConnectionNotFound"},"409":{"$ref":"#/components/responses/SiteDeploymentConnectionNeedsReauth"},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"No connection named","value":{"code":"invalid","errors":{"connection":["The connection field is required."]},"field":"connection","message":"The connection field is required.","reason":"invalid"}},"unreachable":{"summary":"A self-hosted GitLab whose address cannot be reached","value":{"message":"GitLab (self-hosted) at this connection's address cannot be reached: That address is not a public web address the Control Panel can reach."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"`connection` is missing or `q` is too long (`invalid`), or the git provider's address cannot be reached (a\nmessage only).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/ProviderNoAnswer"}},"summary":"List the repositories a connection can see","tags":["Deployments"],"x-feature":"deployments","x-file":"deployments","x-gates":["deployments"],"x-rate-limit":{"bucket":"reseller-deploy-browse","limit":30,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/repository":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"Sets the repository and branch the site deploys, through one of the connections the settings list, and\nwhether a push to the branch deploys. The site must deploy from git. Your role needs the Manage Deployment\nRepositories permission, Manage Deployment Source to change `auto_deploy`, and Create Deployments to turn it\non or to change the repository while it is on.\n","operationId":"updateSiteDeploymentRepository","requestBody":{"content":{"application/json":{"examples":{"site_content":{"summary":"A repository of themes on a WordPress site","value":{"auto_deploy":false,"branch":"main","connection_id":4217,"contents":"site_content","repo":"northwind-digital/harbourandfinch","target_path":"wp-content/themes"}},"whole_site":{"summary":"A repository that holds the whole site","value":{"auto_deploy":true,"branch":"main","connection_id":4217,"repo":"northwind-digital/harbourandfinch","root_directory":null}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentRepositoryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"connected":{"$ref":"#/components/examples/SiteDeploymentRepositorySavedExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentSettingsAnswer"}}},"description":"The settings as they are now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentForbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"value":{"message":"Not found."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/FeatureOffRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site does not exist or is one you cannot deploy, `connection_id` is not a connection you may use on\nthis site, or deployments are not on for your company (`feature_off`).\n"},"409":{"content":{"application/json":{"examples":{"mode":{"$ref":"#/components/examples/SiteDeploymentModeRefusalExample"},"needs_reauth":{"summary":"The connection needs re-authorising","value":{"code":"needs_reauth","message":"The GitLab connection needs re-authorising","reason":"needs_reauth"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The repository cannot be set now. `reason` says why: `mode` (switch the site to git deployments first),\n`needs_reauth` (the connection needs re-authorising), `managed_elsewhere` or `removed`.\n"},"422":{"content":{"application/json":{"examples":{"invalid":{"$ref":"#/components/examples/SiteDeploymentRepoShapeRefusalExample"},"wrong_platform":{"summary":"Site content on a site that is not WordPress","value":{"code":"wrong_platform","errors":{"contents":["Site content repositories are available for WordPress sites only."]},"field":"contents","message":"Site content repositories are available for WordPress sites only.","reason":"wrong_platform"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Message"},{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`): for example `repo` is not `owner/name` or is longer than 200\ncharacters, `root_directory` is not a folder inside the repository or is longer than 121 characters, the\nrepository or branch was not found with this connection, the connected account cannot manage webhooks on\nthe repository, or `target_path` is not a folder inside the site. `contents` `site_content` on a site that is not WordPress\nis `wrong_platform`, and while repositories of site content are paused by Corefinity it is `feature_off`;\nboth name the field. A git provider whose address cannot be reached answers a message only.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/ProviderNoAnswer"}},"summary":"Update a site's repository","tags":["Deployments"],"x-effect":["changes-settings"],"x-feature":"deployments","x-file":"deployments","x-gates":["deployments"],"x-rate-limit":{"bucket":"reseller-deploy","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/secrets":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the credentials the environment's builds use for private npm and Composer registries. A token or a\nusername is never part of any answer: `last4` shows the last four characters of a token of 12 characters or\nmore.\n","operationId":"listSiteDeploymentSecrets","responses":{"200":{"content":{"application/json":{"examples":{"secrets":{"$ref":"#/components/examples/SiteDeploymentSecretListExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentSecretList"}}},"description":"The environment's registry secrets."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/SiteDeploymentArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's registry secrets","tags":["Variables and secrets"],"x-feature":"deployment-variables","x-file":"deployment-variables","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"Saves the credential for one private registry and answers the whole list. A registry must resolve to public\naddresses, and an environment holds one credential for each registry and scope.\n","operationId":"createSiteDeploymentSecret","requestBody":{"content":{"application/json":{"examples":{"composer":{"summary":"A Composer registry","value":{"auth_type":"http-basic","kind":"composer","label":"Private packages","registry":"packages.example.com","token":"your-registry-token","username":"northwind-digital"}},"npm":{"summary":"An npm registry for one scope, checked after the save","value":{"kind":"npm","label":"Private npm","registry":"https://npm.example.com","scope":"@northwind-digital","token":"your-npm-token","verify":true}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentSecretCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"verified":{"$ref":"#/components/examples/SiteDeploymentSecretVerifiedExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentSecretList"}}},"description":"The environment's registry secrets, with the new one."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteDeploymentSecretConflict"},"422":{"$ref":"#/components/responses/SiteDeploymentSecretRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a site registry secret","tags":["Variables and secrets"],"x-effect":["changes-settings"],"x-feature":"deployment-variables","x-file":"deployment-variables","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/secrets/{secret}":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentSecretId"}],"put":{"description":"Changes the fields you send, keeps the rest and answers the whole list. Anything that changes what the\nregistry is asked with clears `verified_at`, and `verify` true on its own checks the saved credential without\nchanging it.\n","operationId":"updateSiteDeploymentSecret","requestBody":{"content":{"application/json":{"examples":{"label":{"summary":"Rename a credential","value":{"label":"Harbour & Finch packages"}},"verify":{"summary":"Check the saved credential with its registry","value":{"verify":true}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentSecretUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"renamed":{"$ref":"#/components/examples/SiteDeploymentSecretListExample"},"verified":{"$ref":"#/components/examples/SiteDeploymentSecretVerifiedExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentSecretList"}}},"description":"The environment's registry secrets after the change, with `verification` when the registry was asked."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/SiteDeploymentSecretConflict"},"422":{"$ref":"#/components/responses/SiteDeploymentSecretRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a site registry secret","tags":["Variables and secrets"],"x-effect":["changes-settings"],"x-feature":"deployment-variables","x-file":"deployment-variables","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes the credential and answers the list that is left. The environment's next build no longer signs in to that registry.","operationId":"deleteSiteDeploymentSecret","responses":{"200":{"content":{"application/json":{"examples":{"none":{"summary":"No credential is left","value":{"data":[]}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentSecretList"}}},"description":"The environment's registry secrets after the removal."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"422":{"$ref":"#/components/responses/SiteDeploymentArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a site's registry secret","tags":["Variables and secrets"],"x-effect":["deletes"],"x-feature":"deployment-variables","x-file":"deployment-variables","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/shared-files":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Checks that the settings file the site's platform needs is in the shared folder a deployment links it from,\nand says where to create a missing one. The check only advises: deploying works as before whatever it\nanswers. It reads the site's files, so the site must be running.\n","operationId":"checkSiteDeploymentSharedFiles","parameters":[{"description":"What the check is for. `rehearsal` also accepts a file in an `htdocs` folder that is not in the releases\nlayout yet.\n","example":"deployment","in":"query","name":"for","required":false,"schema":{"default":"deployment","enum":["deployment","rehearsal"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"missing":{"summary":"A file is missing","value":{"files":[{"message":"/var/www/harbourandfinch.example.com/shared/.env is not on this environment yet. Create it over SFTP or SSH before you deploy: without it the deployment stops at linking shared files, and the site keeps serving its current release. If your repository includes .env, the deployment keeps that copy instead.","path":".env","shared_path":"/var/www/harbourandfinch.example.com/shared/.env","status":"missing"}],"for":"deployment","message":"1 file this environment needs is missing from its shared folder. You can still start, but the deployment will stop before it goes live.","state":"missing"}},"not_applicable":{"summary":"The site deploys by upload","value":{"files":[],"for":"deployment","message":"This environment deploys by upload, so there are no shared files to check.","state":"not_applicable"}},"ok":{"summary":"Every file is in place","value":{"files":[{"message":"/var/www/harbourandfinch.example.com/shared/.env is in place.","path":".env","shared_path":"/var/www/harbourandfinch.example.com/shared/.env","status":"present"}],"for":"rehearsal","message":"Every file this environment needs in its shared folder is in place.","state":"ok"}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentSharedFiles"}}},"description":"The state of each file the site needs."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"not_running":{"value":{"code":"not_running","message":"The site is not running","reason":"not_running"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not running (`not_running`)."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`for` is not `deployment` or `rehearsal`."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"content":{"application/json":{"examples":{"switched_off":{"value":{"code":"switched_off","message":"Site commands are switched off at the moment","reason":"switched_off","switch":"exec"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/SwitchedOffRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"Corefinity has switched site commands off for the moment (`switched_off`, with `switch` `exec`), or the\nsite's files could not be read (`temporarily_unavailable`). Try again in a moment.\n"}},"summary":"Check a site's shared files","tags":["Deployments"],"x-feature":"deployments","x-file":"deployments","x-gates":["deployments","exec"],"x-rate-limit":{"bucket":"reseller-deploy-shared-files","limit":10,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/variables":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the environment's deployment variables by name, each with its value masked and the deployment stages\nthat read it, and the company variables that reach the environment in `inherited`. A build sees each variable\nwith the `CF_` prefix, so `API_TOKEN` is read as `$CF_API_TOKEN`.\n","operationId":"listSiteDeploymentVariables","responses":{"200":{"content":{"application/json":{"examples":{"variables":{"$ref":"#/components/examples/SiteDeploymentVariableListExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentVariableList"}}},"description":"The environment's variables, in name order."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/SiteDeploymentArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's deployment variables","tags":["Variables and secrets"],"x-feature":"deployment-variables","x-file":"deployment-variables","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/variables/{name}":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentVariableName"}],"put":{"description":"Creates the variable when the environment does not have it and changes it otherwise, then answers the whole\nlist with each value masked. A new variable needs a `value`, and making a stored value `shown` in deployment\nlogs needs the value sent with it.\n","operationId":"updateSiteDeploymentVariable","requestBody":{"content":{"application/json":{"examples":{"change":{"summary":"Change a variable's value","value":{"value":"example-value-not-a-real-secret"}},"create":{"summary":"Create a variable","value":{"value":"example-value-not-a-real-secret"}},"shown":{"summary":"Set a value that may appear in deployment logs","value":{"log_visibility":"shown","value":"https://api.example.com"}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentVariableSetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"variables":{"$ref":"#/components/examples/SiteDeploymentVariableListExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentVariableList"}}},"description":"The environment's variables after the change."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"422":{"content":{"application/json":{"examples":{"name_format":{"$ref":"#/components/examples/SiteDeploymentVariableNameFormatExample"},"no_value":{"summary":"A body with neither a value nor a log visibility","value":{"code":"invalid","errors":{"value":["Use at most 2,048 characters, with no line breaks, control or invisible formatting characters."]},"field":"value","message":"Use at most 2,048 characters, with no line breaks, control or invisible formatting characters.","reason":"invalid"}},"prefix":{"summary":"A name that starts with CF_","value":{"code":"variable_invalid","errors":{"name":["Use letters, digits and underscores, starting with a letter or underscore, without the CF_ prefix (CoreStack adds it)."]},"message":"Use letters, digits and underscores, starting with a letter or underscore, without the CF_ prefix (CoreStack adds it).","reason":"variable_invalid"}},"reserved":{"summary":"A name CoreStack sets itself","value":{"code":"variable_reserved","errors":{"name":["CF_DOMAIN is set by CoreStack. Choose another name."]},"message":"CF_DOMAIN is set by CoreStack. Choose another name.","reason":"variable_reserved"}},"shown_needs_value":{"summary":"Showing a stored value without sending it","value":{"code":"invalid","errors":{"log_visibility":["Send the value with log_visibility shown. A stored value is read only through its reveal."]},"field":"log_visibility","message":"Send the value with log_visibility shown. A stored value is read only through its reveal.","reason":"invalid"}},"too_long":{"summary":"A value longer than 2,048 characters","value":{"code":"invalid","errors":{"value":["The value argument must be at most 2048 characters."]},"field":"value","message":"Some arguments are not valid.","reason":"invalid"}},"too_many":{"summary":"The environment is full","value":{"code":"too_many_variables","errors":{"name":["This environment already has the most variables it can hold."]},"message":"This environment already has the most variables it can hold.","reason":"too_many_variables"}},"tool_credential":{"summary":"A name a build tool reads its credentials from","value":{"code":"variable_tool_credential","errors":{"name":["Builds see this variable as CF_NPM_TOKEN, so npm never reads it. Add the credentials under Deployments > Private registries instead."]},"message":"Builds see this variable as CF_NPM_TOKEN, so npm never reads it. Add the credentials under Deployments > Private registries instead.","reason":"variable_tool_credential"}},"value":{"summary":"A value with a line break, or a new variable sent without a value","value":{"code":"variable_invalid","errors":{"value":["Use at most 2,048 characters, with no line breaks, control or invisible formatting characters."]},"message":"Use at most 2,048 characters, with no line breaks, control or invisible formatting characters.","reason":"variable_invalid"}},"wrong_type":{"summary":"A value that is not a string","value":{"code":"invalid","errors":{"value":["The value argument must be string."]},"field":"value","message":"Some arguments are not valid.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"The request was refused and nothing was stored. `errors` names the field.\n\n- `invalid`: a field of the wrong type or one this endpoint does not take, a `value` longer than 2,048\n  characters, a `log_visibility` that is neither `hidden` nor `shown`, a name that is not letters, digits\n  and underscores or is longer than 64 characters (on `name`), a body with neither `value` nor\n  `log_visibility` (on `value`), or `log_visibility` `shown` for a stored value without the value.\n- `variable_invalid`: a name that starts with `CF_`, in either case, a new variable sent without a\n  `value`, or a value with a line break, control or invisible formatting character.\n- `variable_reserved`: a new variable with a name CoreStack sets itself.\n- `variable_tool_credential`: a new variable with a name a build tool reads its own credentials from,\n  such as `NPM_TOKEN`.\n- `too_many_variables`: the environment holds as many variables as it can.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a site's deployment variable","tags":["Variables and secrets"],"x-effect":["changes-settings"],"x-feature":"deployment-variables","x-file":"deployment-variables","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes the variable from the environment and answers the list that is left. The next deployment no longer has it.","operationId":"deleteSiteDeploymentVariable","responses":{"200":{"content":{"application/json":{"examples":{"variables":{"summary":"The variable that is left","value":{"data":[{"log_visibility":"shown","masked":"••••••••.com","name":"API_URL","overrides":null,"replaces_platform":false,"tool_credential":null,"updated_at":"2026-11-09T10:42:07Z","updated_by":null,"used_in":[]}],"inherited":[]}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentVariableList"}}},"description":"The environment's variables after the removal."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"422":{"$ref":"#/components/responses/SiteDeploymentArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a deployment variable","tags":["Variables and secrets"],"x-effect":["deletes"],"x-feature":"deployment-variables","x-file":"deployment-variables","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"corecluster-deploy-pipeline","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/variables/{name}/reveal":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentVariableName"}],"post":{"description":"Answers the variable's stored value, the only endpoint that does. It needs a token with the `exec` scope and a\nperson who may change the site, and the reveal is recorded in the site's activity by the variable's name.\n","operationId":"revealSiteDeploymentVariable","responses":{"200":{"content":{"application/json":{"examples":{"revealed":{"summary":"A revealed value","value":{"name":"API_TOKEN","value":"example-value-not-a-real-secret"}}},"schema":{"properties":{"name":{"type":"string"},"value":{"description":"The stored value.","type":"string"}},"required":["name","value"],"type":"object"}}},"description":"The variable's name and its value.","headers":{"Cache-Control":{"description":"Always `no-store, private`. Do not keep the answer.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor","description":"The token lacks the `exec` scope (`scope_required`), or your company requires two-factor authentication and you have not set it up."},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"unreadable":{"summary":"The value can no longer be read","value":{"code":"not_available","message":"This value cannot be read. Save it again.","reason":"not_available"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The stored value can no longer be read (`not_available`): save the variable again. Or the site is managed\nby another control panel (`managed_elsewhere`).\n"},"422":{"$ref":"#/components/responses/SiteDeploymentArgumentRefused"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Reveal a deployment variable's value","tags":["Variables and secrets"],"x-effect":["reveals-secret"],"x-feature":"deployment-variables","x-file":"deployment-variables","x-gates":["deployments","deploy_pipeline"],"x-rate-limit":{"bucket":"reseller-credentials","limit":10,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/{deployment}/retry":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentId"}],"post":{"description":"Runs a deployment the settings mark `can_retry` again with the files it already built, and answers the same\ndeployment with `status` `queued`. That is a failed deployment, and one other case: a deployment that was\nstopped (`cancelled`) in its after-deploy commands once its release was live, whose retry runs those\ncommands again. Any other cancelled deployment is refused `not_failed`. A deployment that is not the site's\nnewest would put an older release live, so it needs `confirm_older` true. Your role needs the Retry\nDeployments permission.\n","operationId":"retrySiteDeployment","requestBody":{"content":{"application/json":{"examples":{"newest":{"summary":"Retry the site's newest deployment","value":{}},"older":{"summary":"Retry a deployment that is not the newest","value":{"confirm_older":true}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentRetryRequest"}}},"required":false},"responses":{"201":{"content":{"application/json":{"examples":{"queued":{"$ref":"#/components/examples/SiteDeploymentQueuedExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentAnswer"}}},"description":"The deployment, queued again."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"artifact_pruned":{"$ref":"#/components/examples/SiteDeploymentArtifactPrunedRefusalExample"},"deployment_running":{"$ref":"#/components/examples/SiteDeploymentRunningRefusalExample"},"not_failed":{"summary":"The deployment did not fail","value":{"code":"not_failed","message":"Only a failed deployment can be retried","reason":"not_failed"}},"pipeline_changed_since_build":{"summary":"The pipeline changed after the build","value":{"code":"pipeline_changed_since_build","message":"The pipeline changed after this build. Retry deploys the same built files; use Deploy again to run the new build.","reason":"pipeline_changed_since_build"}},"rollback_not_retryable":{"summary":"The deployment is a rollback","value":{"code":"rollback_not_retryable","message":"Start a new rollback instead","reason":"rollback_not_retryable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The deployment cannot be retried. `reason` says why: `not_failed` (it neither failed nor was stopped in\nits after-deploy commands with its release live), `rollback_not_retryable` (roll back again instead), `artifact_pruned` (its release archive was removed after 30 days),\n`pipeline_changed_since_build` (its build lines or build variables changed after its build: deploy the\ncommit again), `release_not_live` (a newer release is live: deploy again), `mode` (the site no longer\ndeploys from git), `deployment_running`, `busy`, `restore_running`, `command_running`,\n`managed_elsewhere`, `deleted` or `removed`. Another `reason` means the site cannot take the retry now,\nand the message says why.\n"},"422":{"content":{"application/json":{"examples":{"confirm":{"summary":"An older deployment, not confirmed","value":{"code":"confirm","errors":{"confirm_older":["This will put an older release live: commit 6b34ba4 from 2 Nov at 14:05. The newest deployment is 49ea0cf from 9 Nov at 09:16."]},"message":"This will put an older release live: commit 6b34ba4 from 2 Nov at 14:05. The newest deployment is 49ea0cf from 9 Nov at 09:16. To retry it anyway, repeat the request with confirm_older set to true.","reason":"confirm"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The deployment is not the site's newest and `confirm_older` is not true (`confirm`), or `confirm_older`\nis not a boolean (`invalid`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Retry a site's failed deployment","tags":["Deployments"],"x-effect":["runs-code","overwrites"],"x-feature":"deployments","x-file":"deployments","x-gates":["deployments"],"x-rate-limit":{"bucket":"reseller-deploy","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"deploy","when":"Always"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/{deployment}/rollback":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentId"}],"post":{"description":"Puts an earlier successful deployment's release live again, as a new deployment with `trigger` `rollback`.\nThe settings mark the deployments you can roll back to with `can_rollback`. Your role needs the Rollback\nDeployments permission.\n","operationId":"rollBackSiteDeployment","requestBody":{"content":{"application/json":{"examples":{"deployment":{"summary":"Roll back to the deployment in the path","value":{}},"release":{"summary":"Roll back to a release by its id","value":{"release_id":"2245ae09-7793-49fa-850b-225c62855fce"}}},"schema":{"$ref":"#/components/schemas/SiteDeploymentRollbackRequest"}}},"required":false},"responses":{"201":{"content":{"application/json":{"examples":{"rollback":{"$ref":"#/components/examples/SiteDeploymentRollbackExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentAnswer"}}},"description":"The new rollback deployment, queued."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"artifact_pruned":{"$ref":"#/components/examples/SiteDeploymentArtifactPrunedRefusalExample"},"deployment_running":{"$ref":"#/components/examples/SiteDeploymentRunningRefusalExample"}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site cannot roll back now. `reason` says why: `artifact_pruned` (the release archive was removed\nafter 30 days), `mode`, `deployment_running`, `busy`, `restore_running`, `command_running`,\n`exec_unresolved` or `install_running` (contact support), `managed_elsewhere`, `deleted` or `removed`.\n"},"422":{"content":{"application/json":{"examples":{"no_earlier":{"summary":"Nothing to roll back to","value":{"code":"invalid","errors":{"release_id":["There is no earlier release to roll back to"]},"field":"release_id","message":"There is no earlier release to roll back to","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`release_id` is longer than 64 characters, or there is no earlier successful release to roll back to\n(both `invalid` on `release_id`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Roll a site back to a deployment","tags":["Deployments"],"x-effect":["runs-code","overwrites"],"x-feature":"deployments","x-file":"deployments","x-gates":["deployments"],"x-rate-limit":{"bucket":"reseller-deploy","limit":5,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"deploy","when":"Always"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/deployments/{deployment}/stop":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/SiteDeploymentId"}],"post":{"description":"Stops a deployment the settings mark `can_stop`. That is a running deployment, which is answered with\n`status` `cancelled`: the site keeps, or goes back to, the release that was live. It is also a failed\ndeployment whose `crons_paused.state` is `database_failed`: its database stage failed after maintenance mode\nwent on and scheduled tasks and queues were paused, and no other deployment of the site is in progress.\nStopping that one builds nothing: it puts the earlier release back, switches maintenance mode off and resumes\nthe scheduled tasks and queues, and the deployment is answered still `failed`. Your role needs the Stop\nDeployments permission. The request has no body.\n","operationId":"cancelSiteDeployment","responses":{"200":{"content":{"application/json":{"examples":{"stopped":{"$ref":"#/components/examples/SiteDeploymentStoppedExample"}},"schema":{"$ref":"#/components/schemas/SiteDeploymentAnswer"}}},"description":"The deployment: `cancelled` when it was running, still `failed` when it was a failed deployment whose\npaused scheduled tasks and queues the stop resumes.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SiteDeploymentForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"not_running":{"value":{"code":"not_running","message":"This deployment is not running","reason":"not_running"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The deployment is neither running nor a failed one the settings mark `can_stop` (`not_running`), or the\nsite is managed by another control panel (`managed_elsewhere`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Cancel a site's deployment","tags":["Deployments"],"x-effect":["changes-settings"],"x-feature":"deployments","x-file":"deployments","x-gates":["deployments"],"x-rate-limit":{"bucket":"reseller-deploy","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"deploy","when":"Always"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/domains":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the main domain, the extra domains, each hostname's DNS and certificate state, and the `version` to\nsend with a save.\n","operationId":"getSiteDomains","responses":{"200":{"content":{"application/json":{"examples":{"live":{"summary":"A live site with one extra domain","value":{"advice":null,"apply":{"applied_at":"2026-11-02T14:37:55Z","error":null,"operation":null,"state":"applied","state_label":"Applied"},"canonical_url":"https://harbourandfinch.example.com","cloudflare":{"connected":false,"zone":null},"hosts":[{"cloudflare_zone":null,"dns_answers":[{"type":"A","value":"203.0.113.10"}],"dns_checked_at":"2026-11-06T09:00:12Z","dns_detail":null,"dns_state":"points_here","dns_state_since":"2026-11-01T10:14:03Z","expected_ip":"203.0.113.10","host":"harbourandfinch.example.com","noindex":false,"redirects_to":null,"role":"primary","tls":{"checked_at":"2026-11-06T09:14:41Z","issuer":"Let's Encrypt","not_after":"2026-12-08T05:41:17Z","reason":null,"state":"ready"}},{"cloudflare_zone":null,"dns_answers":[{"type":"A","value":"203.0.113.10"}],"dns_checked_at":"2026-11-06T09:00:12Z","dns_detail":null,"dns_state":"points_here","dns_state_since":"2026-11-01T10:14:03Z","expected_ip":"203.0.113.10","host":"www.harbourandfinch.example.com","noindex":false,"redirects_to":"harbourandfinch.example.com","role":"alias","tls":{"checked_at":"2026-11-06T09:14:41Z","issuer":"Let's Encrypt","not_after":"2026-12-08T05:41:17Z","reason":null,"state":"ready"}}],"ingress_ip":"203.0.113.10","limits":{"hosts_max":10},"locked_reason":null,"mode":"production","noindex":false,"noindex_source":"flags","primary":"harbourandfinch.example.com","url_change":{"can_change":{"available":true,"reason":null},"in_flight":null},"version":4,"www":"bare"}}},"schema":{"$ref":"#/components/schemas/DomainsSet"}}},"description":"The site's domains."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/DomainLifecycleConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's domains","tags":["Domains"],"x-feature":"domains","x-file":"domains","x-gates":["domains"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Replaces the list of extra domains and sets whether search engines are asked not to index the site. Send the\n`version` you last read; a save that changes something answers the operation to follow.\n","operationId":"replaceSiteDomains","requestBody":{"content":{"application/json":{"examples":{"add_alias":{"summary":"Keep www and add a shop domain","value":{"aliases":["www.harbourandfinch.example.com","shop.harbourandfinch.example.com"],"noindex":false,"version":4}},"magento_default_store":{"summary":"Show Magento's default store on an extra domain","value":{"aliases":["www.harbourandfinch.example.com",{"host":"shop.harbourandfinch.example.com","serve":"storefront","store":null}],"noindex":false,"version":4}},"magento_point_base_urls":{"summary":"Move a Magento store's base URLs to its domain","value":{"aliases":["www.harbourandfinch.example.com",{"base_url":true,"host":"shop.harbourandfinch.example.com","serve":"storefront","store":{"code":"guns","type":"website"}}],"noindex":false,"point_base_urls":["shop.harbourandfinch.example.com"],"version":4}}},"schema":{"$ref":"#/components/schemas/DomainsUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"unchanged":{"$ref":"#/components/examples/DomainsUnchanged"}},"schema":{"$ref":"#/components/schemas/DomainsUpdateResult"}}},"description":"Nothing differs from what is saved, so nothing started. `operation` is null."},"201":{"content":{"application/json":{"examples":{"saved":{"$ref":"#/components/examples/DomainsSaved"}},"schema":{"$ref":"#/components/schemas/DomainsUpdateResult"}}},"description":"The change started. Follow `operation.id`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"maintenance":{"summary":"The maintenance page is on","value":{"code":"maintenance","message":"Switch the maintenance page off before changing the site's hosts","reason":"maintenance"}},"managed_elsewhere":{"summary":"Managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"preview_only":{"summary":"No domain attached yet","value":{"code":"preview_only","message":"Take the site live first","reason":"preview_only"}},"stale":{"summary":"The domains changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The save cannot start: `stale` (the domains changed since your read), `busy` or `restore_running` (another\nchange is running), `deleted`, `removed`, `provisioning`, `preview_only` (no domain attached yet),\n`maintenance` (the maintenance page is on), `store_hosts` or `managed_elsewhere`.\n"},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"An extra domain that is listed twice","value":{"code":"invalid","errors":{"aliases.1":["Each host may appear once"]},"field":"aliases.1","message":"Each host may appear once","reason":"invalid"}},"store_required":{"summary":"A Magento storefront alias without a store","value":{"code":"store_required","errors":{"aliases.0.store":["Choose the Magento website or store view this address shows."]},"field":"aliases.0.store","message":"Choose the Magento website or store view this address shows.","reason":"store_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), an extra domain is used by another\nsite (`host_taken`), or the site's domains are locked (`domains_locked`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Replace a site's extra domains","tags":["Domains"],"x-effect":["changes-settings","deletes","overwrites"],"x-feature":"domains","x-file":"domains","x-gates":["domains"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-sets","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/domains/check":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Checks the public DNS of up to 10 hostnames and answers whether each points at the platform, with the records\nto create. Nothing changes. The person needs the right to change the site.\n","operationId":"checkSiteDomainsDns","requestBody":{"content":{"application/json":{"examples":{"two_hosts":{"summary":"The main domain and its www form","value":{"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"]}}},"schema":{"$ref":"#/components/schemas/DomainsCheckRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"one_elsewhere":{"summary":"One hostname still points at another server","value":{"advice":null,"dns_plan":{"actions":[{"action":"keep","existing":null,"host":"harbourandfinch.example.com","reason":null,"record":{"content":"203.0.113.10","name":"harbourandfinch.example.com","proxied":true,"type":"A"}},{"action":"manual","existing":null,"host":"shop.harbourandfinch.example.com","reason":"Not in a connected Cloudflare zone. Add an A record to 203.0.113.10","record":null}],"can_apply":false,"requires_confirmation":false,"zone":null},"hosts":[{"cloudflare_zone":null,"dns_answers":[{"type":"A","value":"203.0.113.10"}],"dns_checked_at":"2026-11-06T09:16:05Z","dns_detail":null,"dns_state":"points_here","dns_state_since":"2026-11-01T10:14:03Z","expected_ip":"203.0.113.10","host":"harbourandfinch.example.com","noindex":false,"ok":true,"problems":[],"redirects_to":null,"role":"primary","tls":{"checked_at":"2026-11-06T09:14:41Z","issuer":"Let's Encrypt","not_after":"2026-12-08T05:41:17Z","reason":null,"state":"ready"}},{"cloudflare_zone":null,"dns_answers":[{"type":"A","value":"198.51.100.9"}],"dns_checked_at":"2026-11-06T09:16:05Z","dns_detail":"direct","dns_state":"elsewhere","dns_state_since":null,"expected_ip":"203.0.113.10","host":"shop.harbourandfinch.example.com","noindex":false,"ok":false,"problems":["Points at 198.51.100.9. Update the A record to 203.0.113.10"],"redirects_to":null,"role":"alias","tls":{"checked_at":null,"issuer":null,"not_after":null,"reason":null,"state":"none"}}],"ok":false,"ran_at":"2026-11-06T09:16:05Z"}}},"schema":{"$ref":"#/components/schemas/DomainsCheckResult"}}},"description":"The state of each hostname."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/DomainLifecycleConflict"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/DomainUpstreamFailed"}},"summary":"Check where hostnames point","tags":["Domains"],"x-effect":["none"],"x-feature":"domains","x-file":"domains","x-gates":["domains"],"x-rate-limit":{"bucket":"reseller-dns-check","limit":20,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/domains/point-dns":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Writes the DNS records for up to 10 of the site's existing domains in your connected Cloudflare account.\nRecords that already exist are replaced only with `confirm_replacements`.\n","operationId":"pointSiteDomainsDns","requestBody":{"content":{"application/json":{"examples":{"one_host":{"summary":"Point one domain, replacing nothing","value":{"confirm_replacements":false,"hosts":["harbourandfinch.example.com"]}}},"schema":{"$ref":"#/components/schemas/DnsPointRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"created":{"$ref":"#/components/examples/DnsPointed"}},"schema":{"$ref":"#/components/schemas/DnsPointResult"}}},"description":"The records written and the state of each hostname afterwards."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"not_connected":{"summary":"No Cloudflare connection","value":{"code":"not_connected","message":"Connect Cloudflare for this company first","reason":"not_connected"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`not_connected` (no Cloudflare connection), `no_zone` (the domain is in no connected zone, or Cloudflare is\noff for the site), `busy` (another Cloudflare change for the company is running), `deleted`,\n`provisioning` or `managed_elsewhere`.\n"},"422":{"content":{"application/json":{"examples":{"confirm_replacements":{"summary":"Existing records would be replaced","value":{"code":"confirm_replacements","dns_plan":{"actions":[{"action":"replace","existing":[{"content":"198.51.100.9","proxied":false,"type":"A"}],"host":"harbourandfinch.example.com","reason":null,"record":{"content":"203.0.113.10","name":"harbourandfinch.example.com","proxied":true,"type":"A"}}],"can_apply":true,"requires_confirmation":true,"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"harbourandfinch.example.com"}},"errors":{"confirm_replacements":["Existing DNS records would be replaced. Confirm to continue."]},"message":"Existing DNS records would be replaced. Confirm to continue.","reason":"confirm_replacements"}},"invalid":{"summary":"A hostname that is not the site's","value":{"code":"invalid","errors":{"hosts":["other.harbourandfinch.example.net is not one of this site's addresses"]},"field":"hosts","message":"other.harbourandfinch.example.net is not one of this site's addresses","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/DnsWriteRefusal"}]}}},"description":"A hostname is not one of the site's domains (`invalid`), the site has no domain attached yet\n(`preview_only`), existing records would be replaced without `confirm_replacements`\n(`confirm_replacements`, with the `dns_plan` that would be written), or the plan is too large (`too_many`).\n"},"429":{"$ref":"#/components/responses/CloudflareTooManyRequests"},"502":{"content":{"application/json":{"schema":{"additionalProperties":true,"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"}}},"description":"Part of the plan could not be written at Cloudflare. The body says which records failed."}},"summary":"Point hostnames at the platform","tags":["Domains"],"x-effect":["overwrites"],"x-feature":"domains","x-file":"domains","x-gates":["domains"],"x-rate-limit":{"also":[{"bucket":"reseller-cloudflare-writes","limit":60,"minutes":60,"per":"company"}],"bucket":"reseller-dns-check","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/email":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the site's sending domains with the DNS records each needs and whether they have been found, the\nsender, and what you may do next. The default sending domain is also answered at the top level.\n`store_mapping` is what was last read on the site: `read_stores=true` asks for a fresh read.\n","operationId":"getSiteEmail","parameters":[{"description":"True to have the stores of a live Magento 2 site read again. The fresh read is queued: this answer still\nholds `store_mapping` as it was last read, and a later one holds the new reading. Without it the stores\nare read again by themselves from time to time. It changes nothing on any other site.\n","example":true,"in":"query","name":"read_stores","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"add":{"allowed":true,"count":1,"default_prefix":"mg","max":5,"reason":null},"cloudflare":{"can_write_records":true,"connected":true,"written_at":null,"zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"default_domain":"mg.harbourandfinch.example.com","domains":[{"active":true,"added_at":"2026-11-03T09:16:42Z","added_by":"Daniel Reyes","can_make_default":false,"can_remove":true,"can_rotate":true,"can_test":false,"cloudflare":{"can_write_records":true,"connected":true,"written_at":null,"zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"error":null,"from_domain":"harbourandfinch.example.com","id":3101,"is_default":true,"last_checked_at":"2026-11-03T09:16:40Z","last_test":null,"make_default_reason":null,"operation_id":5120,"records":[{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":null,"purpose":"spf","required":true,"state":"missing","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":null,"found":null,"name":"pic._domainkey.mg.harbourandfinch.example.com","priority":null,"purpose":"dkim","required":true,"state":"missing","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"email.mg.harbourandfinch.example.com","priority":null,"purpose":"tracking","required":true,"state":"missing","type":"CNAME","value":"eu.mail.example.net"}],"remove_reason":null,"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"pending_dns","state_label":"Waiting for DNS","test_reason":"Test emails can be sent once the sending domain is verified","verified_at":null}],"error":null,"last_checked_at":"2026-11-03T09:16:40Z","mailpit":null,"operation":null,"records":[{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":null,"purpose":"spf","required":true,"state":"missing","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":null,"found":null,"name":"pic._domainkey.mg.harbourandfinch.example.com","priority":null,"purpose":"dkim","required":true,"state":"missing","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"email.mg.harbourandfinch.example.com","priority":null,"purpose":"tracking","required":true,"state":"missing","type":"CNAME","value":"eu.mail.example.net"}],"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"pending_dns","state_label":"Waiting for DNS","store_mapping":null,"test":{"last_sent_at":null,"last_to":null,"remaining_today":20},"verified_at":null},"schema":{"$ref":"#/components/schemas/EmailSettings"}}},"description":"The email settings."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrManagedClusters"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/EmailLifecycleConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's email settings","tags":["Outbound email"],"x-feature":"email","x-file":"email","x-gates":["email"],"x-rate-limit":{"bucket":"corestack-email-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"post":{"description":"Creates the site's first sending domain, by default `mg.` followed by the site's domain, and makes the site\nsend through it. The domain then waits for its DNS records: add them at your DNS provider, or with the DNS\nendpoint when the domain is in a connected Cloudflare account, and verify. Try-it is off because the request\ncreates a sending domain.\n","operationId":"createSiteEmail","requestBody":{"content":{"application/json":{"examples":{"default_domain":{"summary":"Send as noreply@harbourandfinch.example.com through the default sending domain","value":{"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"}}}},"schema":{"$ref":"#/components/schemas/EmailSetUp"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"email":{"add":{"allowed":false,"count":1,"default_prefix":"mg","max":5,"reason":"Set up the first sending domain before adding another."},"cloudflare":{"can_write_records":true,"connected":true,"written_at":null,"zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"default_domain":"mg.harbourandfinch.example.com","domains":[{"active":false,"added_at":"2026-11-03T09:16:40Z","added_by":"Daniel Reyes","can_make_default":false,"can_remove":false,"can_rotate":false,"can_test":false,"cloudflare":{"can_write_records":true,"connected":true,"written_at":null,"zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"error":null,"from_domain":"harbourandfinch.example.com","id":3101,"is_default":true,"last_checked_at":null,"last_test":null,"make_default_reason":null,"operation_id":5120,"records":[],"remove_reason":null,"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"creating","state_label":"Creating","test_reason":"Test emails can be sent once the sending domain is verified","verified_at":null}],"error":null,"last_checked_at":null,"mailpit":null,"operation":{"id":5120,"scope":"site","status":"executing","status_label":"Creating the sending domain","summary":"Sending domain mg.harbourandfinch.example.com","to_version":null,"type":"mail_setup","type_label":"Email sending"},"records":[],"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"creating","state_label":"Creating","store_mapping":null,"test":{"last_sent_at":null,"last_to":null,"remaining_today":20},"verified_at":null},"operation":{"applied_at":"2026-11-03T09:16:40Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":"Sending domain created","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Creating the sending domain","step":"domain","steps":[{"key":"domain","label":"Sending domain created","state":"current"},{"key":"secret","label":"Credentials stored","state":"todo"},{"key":"restart_pending","label":"Settings sent","state":"todo"},{"key":"restarted","label":"Settings applied","state":"todo"},{"key":"dns","label":"DNS records added","state":"todo"},{"key":"verified","label":"Verified","state":"todo"}],"subject":null,"summary":"Sending domain mg.harbourandfinch.example.com","to_version":null,"type":"mail_setup","type_label":"Email sending"}},"schema":{"$ref":"#/components/schemas/EmailChangeStarted"}}},"description":"The sending domain is being set up. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"duplicate":{"summary":"The site already has a sending domain","value":{"code":"duplicate","message":"This site already has a sending domain. Remove it first.","reason":"duplicate"}},"staff_managed":{"summary":"The site's email is managed by Corefinity","value":{"code":"staff_managed","message":"This site's email is managed by staff. Contact support to change it.","reason":"staff_managed"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The domain cannot be set up now. `reason` says why: `duplicate` (the site already has a sending domain, or the domain is in use), `exists` (the email provider already has this domain: contact support), `staff_managed`, `unavailable` (this environment does not send email itself), `busy`, `restore_running`, `removed`, `deleted`, `provisioning` or `managed_elsewhere`.\n"},"422":{"content":{"application/json":{"examples":{"sender_outside":{"summary":"A sender address of another domain","value":{"code":"invalid","errors":{"sender.address":["The sender must use this site's domain"]},"field":"sender.address","message":"The sender must use this site's domain","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/EmailProviderFailed"}},"summary":"Create a site's first sending domain","tags":["Outbound email"],"x-effect":["changes-settings"],"x-feature":"email","x-file":"email","x-gates":["email"],"x-long-running":"getSiteEmailOperation","x-rate-limit":{"bucket":"reseller-email","limit":12,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes the site's default sending domain, or the one `domain` names, and its SMTP login. The default can be\nremoved once no other sending domain is left; the site's email then goes out through Corefinity's shared\nsender. The answer is an operation to follow.\n","operationId":"deleteSiteEmail","requestBody":{"content":{"application/json":{"examples":{"default_domain":{"summary":"Remove the site's only sending domain","value":{}}},"schema":{"$ref":"#/components/schemas/EmailDomainChoice"}}},"required":false},"responses":{"202":{"content":{"application/json":{"example":{"operation":{"applied_at":"2026-11-03T09:16:40Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5124,"install":null,"label":"Fallback sender published","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Publishing the fallback sender","step":"fallback","steps":[{"key":"fallback","label":"Fallback sender published","state":"current"},{"key":"restart_pending","label":"Settings sent","state":"todo"},{"key":"restarted","label":"Settings applied","state":"todo"},{"key":"verified","label":"Fallback sender verified","state":"todo"},{"key":"revoked","label":"Credentials revoked","state":"todo"}],"subject":null,"summary":"Remove sending domain mg.harbourandfinch.example.com","to_version":null,"type":"mail_remove","type_label":"Remove email sending"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"The sending domain is being removed. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/EmailDomainNotFound"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"no_domain":{"summary":"The site has no sending domain","value":{"code":"state","message":"This site has no sending domain","reason":"state"}},"state":{"summary":"The default while another domain is left","value":{"code":"state","message":"The default can be removed once no other domain is left. Make another one the default first.","reason":"state"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The domain cannot be removed now. `reason` says why: `state` (the default while another sending domain is\nleft, or the site has no sending domain), `unavailable` (this environment does not send email itself, or\nCorefinity's shared sender is not set up for the site: contact support), `busy` (another change is\nrunning), `restore_running`, `removed`, `deleted`, `provisioning` or `managed_elsewhere`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a site's sending domain","tags":["Outbound email"],"x-effect":["deletes"],"x-feature":"email","x-file":"email","x-gates":["email"],"x-long-running":"getSiteEmailOperation","x-rate-limit":{"bucket":"reseller-email","limit":12,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/email/commands/{command}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of a command a test send answered.","example":6187,"in":"path","name":"command","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers a test send of this site. Read it until `status` is neither `queued` nor `running`: `result.sent`\nthen says whether the email was handed over, and `result.message` what to do next.\n","operationId":"getSiteEmailCommand","responses":{"200":{"content":{"application/json":{"example":{"blocked_until_verified":false,"duration_ms":0,"error":null,"exit_code":0,"finished_at":"2026-11-03T09:16:40Z","id":6187,"input":{"domain":"mg.harbourandfinch.example.com","to":"tom.harbour@harbourandfinch.example.com"},"kind":"email_test","label":"Send a test email","operation_id":null,"output_excerpt":"sent\n","queued_at":"2026-11-03T09:16:40Z","requested_by":{"id":2012,"name":"Daniel Reyes"},"result":{"message":"Sent. Check the inbox (and spam) of tom.harbour@harbourandfinch.example.com.","sent":true},"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-03T09:16:40Z","status":"succeeded","status_label":"Done"},"schema":{"$ref":"#/components/schemas/EmailCommand"}}},"description":"The test send as it stands."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrManagedClusters"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a test email's progress","tags":["Outbound email"],"x-feature":"email","x-file":"email","x-gates":["email"],"x-rate-limit":{"bucket":"corestack-email-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/corestack/sites/{site}/email/dns":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Writes the sending domain's DNS records into the Cloudflare zone of a connected Cloudflare account, while the\ndomain waits for DNS; `mx: true` also writes the optional MX records. A record that could not be written\nleaves its guidance in `email.error`. Try-it is off because the request changes live DNS.\n","operationId":"createSiteEmailDnsRecords","requestBody":{"content":{"application/json":{"examples":{"sending_records":{"summary":"Add the records sending needs","value":{}},"with_mx":{"summary":"Add the MX records too","value":{"mx":true}}},"schema":{"$ref":"#/components/schemas/EmailDnsRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"email":{"add":{"allowed":true,"count":1,"default_prefix":"mg","max":5,"reason":null},"cloudflare":{"can_write_records":true,"connected":true,"written_at":"2026-11-03T09:16:40Z","zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"default_domain":"mg.harbourandfinch.example.com","domains":[{"active":true,"added_at":"2026-11-03T09:16:40Z","added_by":"Daniel Reyes","can_make_default":false,"can_remove":true,"can_rotate":true,"can_test":false,"cloudflare":{"can_write_records":true,"connected":true,"written_at":"2026-11-03T09:16:40Z","zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"error":null,"from_domain":"harbourandfinch.example.com","id":3101,"is_default":true,"last_checked_at":"2026-11-03T09:16:40Z","last_test":null,"make_default_reason":null,"operation_id":5120,"records":[{"cloudflare":{"record_id":"example-record-id","written_at":"2026-11-03T09:16:40Z"},"found":null,"name":"mg.harbourandfinch.example.com","priority":null,"purpose":"spf","required":true,"state":"missing","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":{"record_id":"example-record-id","written_at":"2026-11-03T09:16:40Z"},"found":null,"name":"pic._domainkey.mg.harbourandfinch.example.com","priority":null,"purpose":"dkim","required":true,"state":"missing","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":{"record_id":"example-record-id","written_at":"2026-11-03T09:16:40Z"},"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":{"record_id":"example-record-id","written_at":"2026-11-03T09:16:40Z"},"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":{"record_id":"example-record-id","written_at":"2026-11-03T09:16:40Z"},"found":null,"name":"email.mg.harbourandfinch.example.com","priority":null,"purpose":"tracking","required":true,"state":"missing","type":"CNAME","value":"eu.mail.example.net"}],"remove_reason":null,"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"pending_dns","state_label":"Waiting for DNS","test_reason":"Test emails can be sent once the sending domain is verified","verified_at":null}],"error":null,"last_checked_at":"2026-11-03T09:16:40Z","mailpit":null,"operation":null,"records":[{"cloudflare":{"record_id":"example-record-id","written_at":"2026-11-03T09:16:40Z"},"found":null,"name":"mg.harbourandfinch.example.com","priority":null,"purpose":"spf","required":true,"state":"missing","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":{"record_id":"example-record-id","written_at":"2026-11-03T09:16:40Z"},"found":null,"name":"pic._domainkey.mg.harbourandfinch.example.com","priority":null,"purpose":"dkim","required":true,"state":"missing","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":{"record_id":"example-record-id","written_at":"2026-11-03T09:16:40Z"},"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":{"record_id":"example-record-id","written_at":"2026-11-03T09:16:40Z"},"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":{"record_id":"example-record-id","written_at":"2026-11-03T09:16:40Z"},"found":null,"name":"email.mg.harbourandfinch.example.com","priority":null,"purpose":"tracking","required":true,"state":"missing","type":"CNAME","value":"eu.mail.example.net"}],"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"pending_dns","state_label":"Waiting for DNS","store_mapping":null,"test":{"last_sent_at":null,"last_to":null,"remaining_today":20},"verified_at":null},"written":5},"schema":{"$ref":"#/components/schemas/EmailDnsWritten"}}},"description":"The records were written, as far as they could be."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/EmailDomainNotFound"},"409":{"content":{"application/json":{"examples":{"cloudflare_off":{"summary":"Cloudflare is switched off for the site","value":{"code":"no_zone","message":"Cloudflare is switched off for this site","reason":"no_zone"}},"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"no_zone":{"summary":"The domain is in none of the connected account's zones","value":{"code":"no_zone","message":"Connect Cloudflare for this site's zone first, or add the records by hand","reason":"no_zone"}},"not_connected":{"summary":"No connected Cloudflare account","value":{"code":"not_connected","message":"Connect Cloudflare first, or add the records by hand","reason":"not_connected"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The records cannot be written. `reason` says why: `not_connected` (your company has no connected Cloudflare\naccount), `no_zone` (the domain is in none of the connected account's zones, or Cloudflare is switched off\nfor the site), `deleted`, `provisioning` or `managed_elsewhere`.\n"},"422":{"content":{"application/json":{"examples":{"state":{"summary":"The domain is not waiting for DNS","value":{"code":"state","message":"The records can be added while the domain waits for DNS","reason":"state"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`mx` is not true or false (`invalid`), or the domain is not waiting for DNS (`state`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a sending domain's DNS records","tags":["Outbound email"],"x-effect":["changes-settings"],"x-feature":"email","x-file":"email","x-gates":["email"],"x-rate-limit":{"bucket":"reseller-email","limit":12,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/email/domains":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Adds a sending domain for mail from another of the site's domains, on a Magento 2 site that already has its\nfirst one: `prefix` (by default `mg`) in front of `from_domain`. A site can have up to 5 sending domains.\nTry-it is off because the request creates a sending domain.\n","operationId":"createSiteEmailDomain","requestBody":{"content":{"application/json":{"examples":{"second_domain":{"summary":"Send mail from harbourandfinch.example.net through mg.harbourandfinch.example.net","value":{"from_domain":"harbourandfinch.example.net"}}},"schema":{"$ref":"#/components/schemas/EmailDomainAdd"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"email":{"add":{"allowed":true,"count":2,"default_prefix":"mg","max":5,"reason":null},"cloudflare":{"can_write_records":true,"connected":true,"written_at":null,"zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"default_domain":"mg.harbourandfinch.example.com","domains":[{"active":true,"added_at":"2026-11-03T09:16:40Z","added_by":"Daniel Reyes","can_make_default":false,"can_remove":false,"can_rotate":false,"can_test":false,"cloudflare":{"can_write_records":true,"connected":true,"written_at":null,"zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"error":null,"from_domain":"harbourandfinch.example.com","id":3101,"is_default":true,"last_checked_at":"2026-11-03T09:16:40Z","last_test":null,"make_default_reason":null,"operation_id":5120,"records":[{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":null,"purpose":"spf","required":true,"state":"missing","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":null,"found":null,"name":"pic._domainkey.mg.harbourandfinch.example.com","priority":null,"purpose":"dkim","required":true,"state":"missing","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"email.mg.harbourandfinch.example.com","priority":null,"purpose":"tracking","required":true,"state":"missing","type":"CNAME","value":"eu.mail.example.net"}],"remove_reason":"The default can be removed once no other domain is left. Make another one the default first.","sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"pending_dns","state_label":"Waiting for DNS","test_reason":"Test emails can be sent once the sending domain is verified","verified_at":null},{"active":false,"added_at":"2026-11-03T09:16:40Z","added_by":"Daniel Reyes","can_make_default":false,"can_remove":false,"can_rotate":false,"can_test":false,"cloudflare":{"can_write_records":false,"connected":true,"written_at":null,"zone":null},"error":null,"from_domain":"harbourandfinch.example.net","id":3102,"is_default":false,"last_checked_at":null,"last_test":null,"make_default_reason":"Only a verified sending domain the site already sends through can be the default.","operation_id":5123,"records":[],"remove_reason":null,"sender":{"address":"noreply@harbourandfinch.example.net","name":null},"sending_domain":"mg.harbourandfinch.example.net","state":"creating","state_label":"Creating","test_reason":"Test emails can be sent once the sending domain is verified","verified_at":null}],"error":null,"last_checked_at":"2026-11-03T09:16:40Z","mailpit":null,"operation":{"id":5123,"scope":"site","status":"executing","status_label":"Creating the sending domain","summary":"Sending domain mg.harbourandfinch.example.net","to_version":null,"type":"mail_setup","type_label":"Email sending"},"records":[{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":null,"purpose":"spf","required":true,"state":"missing","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":null,"found":null,"name":"pic._domainkey.mg.harbourandfinch.example.com","priority":null,"purpose":"dkim","required":true,"state":"missing","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"email.mg.harbourandfinch.example.com","priority":null,"purpose":"tracking","required":true,"state":"missing","type":"CNAME","value":"eu.mail.example.net"}],"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"pending_dns","state_label":"Waiting for DNS","store_mapping":null,"test":{"last_sent_at":null,"last_to":null,"remaining_today":20},"verified_at":null},"operation":{"applied_at":"2026-11-03T09:16:40Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5123,"install":null,"label":"Sending domain created","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Creating the sending domain","step":"domain","steps":[{"key":"domain","label":"Sending domain created","state":"current"},{"key":"secret","label":"Credentials stored","state":"todo"},{"key":"dns","label":"DNS records added","state":"todo"},{"key":"verified","label":"Verified","state":"todo"}],"subject":null,"summary":"Sending domain mg.harbourandfinch.example.net","to_version":null,"type":"mail_setup","type_label":"Email sending"}},"schema":{"$ref":"#/components/schemas/EmailChangeStarted"}}},"description":"The sending domain is being added. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"duplicate":{"summary":"The site already has this sending domain","value":{"code":"duplicate","message":"This site already has the sending domain mg.harbourandfinch.example.net.","reason":"duplicate"}},"from_taken":{"summary":"Mail from that domain already has a sending domain","value":{"code":"duplicate","message":"This site already has a sending domain for mail from @harbourandfinch.example.com.","reason":"duplicate"}},"limit":{"summary":"The site has its 5 sending domains","value":{"code":"limit","message":"A site can have up to 5 sending domains. Remove one first.","reason":"limit"}},"no_default":{"summary":"The first sending domain is not set up and in use yet","value":{"code":"state","message":"Set up the first sending domain before adding another.","reason":"state"}},"unavailable":{"summary":"The site is not a Magento 2 site","value":{"code":"unavailable","message":"Several sending domains are available on Magento 2 sites.","reason":"unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The domain cannot be added now. `reason` says why: `unavailable` (several sending domains are for Magento 2\nsites, or this environment does not send email itself), `state` (the site's first sending domain is not\nset up and in use yet), `limit` (the site has its 5 sending domains), `duplicate` (the site already has a\nsending domain for mail from `from_domain`, or the sending domain is already one of this site's or\nanother's), `exists` (the email provider already has this domain: contact support), `staff_managed`,\n`busy`, `restore_running`, `removed`, `deleted`, `provisioning` or `managed_elsewhere`.\n"},"422":{"content":{"application/json":{"examples":{"from_outside":{"summary":"A domain that is not one of the site's","value":{"code":"invalid","errors":{"from_domain":["The domain must be one of this site's domains, or under one of them"]},"field":"from_domain","message":"The domain must be one of this site's domains, or under one of them","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/EmailProviderFailed"}},"summary":"Create another sending domain","tags":["Outbound email"],"x-effect":["changes-settings"],"x-feature":"email","x-file":"email","x-gates":["email"],"x-long-running":"getSiteEmailOperation","x-rate-limit":{"bucket":"reseller-email","limit":12,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/email/domains/{domain}":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/EmailDomain"}],"delete":{"description":"Removes the sending domain the path names, and its SMTP login: mail from its domain then goes out through the\ndefault sending domain. The default itself can be removed once no other sending domain is left.\n","operationId":"deleteSiteEmailDomain","responses":{"202":{"content":{"application/json":{"example":{"operation":{"applied_at":"2026-11-03T09:16:40Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5125,"install":null,"label":"Mail moved to the default","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Running","step":"transport","steps":[{"key":"transport","label":"Mail moved to the default","state":"current"},{"key":"verified","label":"Change verified","state":"todo"},{"key":"revoked","label":"Credentials revoked","state":"todo"}],"subject":null,"summary":"Remove sending domain mg.harbourandfinch.example.net","to_version":null,"type":"mail_remove","type_label":"Remove email sending"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"The sending domain is being removed. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/EmailDomainNotFound"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"state":{"summary":"The default while another domain is left","value":{"code":"state","message":"The default can be removed once no other domain is left. Make another one the default first.","reason":"state"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The domain cannot be removed now. `reason` says why: `state` (the default while another sending domain is\nleft), `unavailable` (this environment does not send email itself, or\nCorefinity's shared sender is not set up for the site: contact support), `busy` (another change is\nrunning), `restore_running`, `removed`, `deleted`, `provisioning` or `managed_elsewhere`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete one sending domain","tags":["Outbound email"],"x-effect":["deletes"],"x-feature":"email","x-file":"email","x-gates":["email"],"x-long-running":"getSiteEmailOperation","x-rate-limit":{"bucket":"reseller-email","limit":12,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/email/domains/{domain}/default":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/EmailDomain"}],"post":{"description":"Makes a verified sending domain that the site already sends through the default: mail whose sender matches no\nother sending domain then goes out through it. Answers the settings as they then read.\n","operationId":"updateSiteEmailDefaultDomain","responses":{"200":{"content":{"application/json":{"example":{"add":{"allowed":true,"count":2,"default_prefix":"mg","max":5,"reason":null},"cloudflare":{"can_write_records":false,"connected":true,"written_at":null,"zone":null},"default_domain":"mg.harbourandfinch.example.com","domains":[{"active":true,"added_at":"2026-11-03T09:16:40Z","added_by":"Daniel Reyes","can_make_default":false,"can_remove":false,"can_rotate":true,"can_test":true,"cloudflare":{"can_write_records":false,"connected":true,"written_at":null,"zone":null},"error":null,"from_domain":"harbourandfinch.example.net","id":3101,"is_default":true,"last_checked_at":"2026-11-03T09:16:40Z","last_test":null,"make_default_reason":null,"operation_id":5120,"records":[{"cloudflare":null,"found":"v=spf1 include:mail.example.net ~all","name":"mg.harbourandfinch.example.net","priority":null,"purpose":"spf","required":true,"state":"valid","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":null,"found":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY","name":"pic._domainkey.mg.harbourandfinch.example.net","priority":null,"purpose":"dkim","required":true,"state":"valid","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":null,"found":"mxa.eu.mail.example.net","name":"mg.harbourandfinch.example.net","priority":10,"purpose":"mx","required":false,"state":"valid","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":null,"found":"mxb.eu.mail.example.net","name":"mg.harbourandfinch.example.net","priority":10,"purpose":"mx","required":false,"state":"valid","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":null,"found":"eu.mail.example.net","name":"email.mg.harbourandfinch.example.net","priority":null,"purpose":"tracking","required":true,"state":"valid","type":"CNAME","value":"eu.mail.example.net"}],"remove_reason":"The default can be removed once no other domain is left. Make another one the default first.","sender":{"address":"noreply@harbourandfinch.example.net","name":null},"sending_domain":"mg.harbourandfinch.example.net","state":"verified","state_label":"Verified","test_reason":null,"verified_at":"2026-11-03T09:16:40Z"},{"active":true,"added_at":"2026-11-03T09:16:40Z","added_by":"Daniel Reyes","can_make_default":true,"can_remove":true,"can_rotate":true,"can_test":true,"cloudflare":{"can_write_records":true,"connected":true,"written_at":null,"zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"error":null,"from_domain":"harbourandfinch.example.com","id":3102,"is_default":false,"last_checked_at":"2026-11-03T09:16:40Z","last_test":null,"make_default_reason":null,"operation_id":5121,"records":[{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":null,"purpose":"spf","required":true,"state":"missing","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":null,"found":null,"name":"pic._domainkey.mg.harbourandfinch.example.com","priority":null,"purpose":"dkim","required":true,"state":"missing","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"email.mg.harbourandfinch.example.com","priority":null,"purpose":"tracking","required":true,"state":"missing","type":"CNAME","value":"eu.mail.example.net"}],"remove_reason":null,"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"verified","state_label":"Verified","test_reason":null,"verified_at":"2026-11-03T09:16:40Z"}],"error":null,"last_checked_at":"2026-11-03T09:16:40Z","mailpit":null,"operation":null,"records":[{"cloudflare":null,"found":"v=spf1 include:mail.example.net ~all","name":"mg.harbourandfinch.example.net","priority":null,"purpose":"spf","required":true,"state":"valid","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":null,"found":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY","name":"pic._domainkey.mg.harbourandfinch.example.net","priority":null,"purpose":"dkim","required":true,"state":"valid","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":null,"found":"mxa.eu.mail.example.net","name":"mg.harbourandfinch.example.net","priority":10,"purpose":"mx","required":false,"state":"valid","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":null,"found":"mxb.eu.mail.example.net","name":"mg.harbourandfinch.example.net","priority":10,"purpose":"mx","required":false,"state":"valid","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":null,"found":"eu.mail.example.net","name":"email.mg.harbourandfinch.example.net","priority":null,"purpose":"tracking","required":true,"state":"valid","type":"CNAME","value":"eu.mail.example.net"}],"sender":{"address":"noreply@harbourandfinch.example.net","name":null},"sending_domain":"mg.harbourandfinch.example.net","state":"verified","state_label":"Verified","store_mapping":null,"test":{"last_sent_at":null,"last_to":null,"remaining_today":20},"verified_at":"2026-11-03T09:16:40Z"},"schema":{"$ref":"#/components/schemas/EmailSettings"}}},"description":"The email settings, with the new default first."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/EmailDomainNotFound"},"409":{"content":{"application/json":{"examples":{"already_default":{"summary":"It is the default already","value":{"code":"state","message":"This is already the default sending domain.","reason":"state"}},"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"busy_email_change":{"summary":"Another email change is running","value":{"code":"busy","message":"Another email change is running on this site. Try again in a minute.","reason":"busy"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_ready":{"summary":"It is not verified and in use yet","value":{"code":"state","message":"Only a verified sending domain the site already sends through can be the default.","reason":"state"}},"upstream_unavailable":{"summary":"The site's mail settings could not be written","value":{"code":"upstream_unavailable","message":"The cluster for this site is not configured","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The domain cannot be made the default. `reason` says why: `state` (it is the default already, it is not\nverified and in use yet, or an earlier change to the site's mail login did not finish), `busy` (another\nchange is running), `upstream_unavailable` (the site's mail settings could not be written: nothing was\nchanged, try again), `unavailable` (this environment does not send email itself), `restore_running`,\n`removed`, `deleted`, `provisioning` or `managed_elsewhere`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update the default sending domain","tags":["Outbound email"],"x-effect":["changes-settings"],"x-feature":"email","x-file":"email","x-gates":["email"],"x-rate-limit":{"bucket":"reseller-email","limit":12,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/email/operations/{operation}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of an operation one of these endpoints answered.","example":5120,"in":"path","name":"operation","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers an operation that a set-up, a rotation or a removal started on this site. Read it until `status` is\n`completed` or `failed`. An operation of any other kind, or of another site, answers 404.\n","operationId":"getSiteEmailOperation","responses":{"200":{"content":{"application/json":{"example":{"operation":{"applied_at":"2026-11-03T09:16:40Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":"2026-11-03T09:16:40Z","created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":null,"notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"completed","status_label":"Verified","step":null,"steps":[{"key":"domain","label":"Sending domain created","state":"done"},{"key":"secret","label":"Credentials stored","state":"done"},{"key":"restart_pending","label":"Settings sent","state":"done"},{"key":"restarted","label":"Settings applied","state":"done"},{"key":"dns","label":"DNS records added","state":"skipped"},{"key":"verified","label":"Verified","state":"skipped"}],"subject":null,"summary":"Sending domain mg.harbourandfinch.example.com","to_version":null,"type":"mail_setup","type_label":"Email sending"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"The operation as it stands."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrManagedClusters"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an email operation","tags":["Outbound email"],"x-feature":"email","x-file":"email","x-gates":["email"],"x-rate-limit":{"bucket":"corestack-email-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/corestack/sites/{site}/email/rotate":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Gives the sending domain a new SMTP login, moves the site onto it and revokes the old one. The login is\nnever answered: the site reads it itself. Beside the limit on changes, a person may start three rotations an\nhour.\n","operationId":"rotateSiteEmailSmtpLogin","requestBody":{"content":{"application/json":{"examples":{"default_domain":{"summary":"Rotate the default sending domain's login","value":{}}},"schema":{"$ref":"#/components/schemas/EmailDomainChoice"}}},"required":false},"responses":{"201":{"content":{"application/json":{"example":{"email":{"add":{"allowed":true,"count":1,"default_prefix":"mg","max":5,"reason":null},"cloudflare":{"can_write_records":true,"connected":true,"written_at":null,"zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"default_domain":"mg.harbourandfinch.example.com","domains":[{"active":true,"added_at":"2026-11-03T09:16:40Z","added_by":"Daniel Reyes","can_make_default":false,"can_remove":false,"can_rotate":false,"can_test":true,"cloudflare":{"can_write_records":true,"connected":true,"written_at":null,"zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"error":null,"from_domain":"harbourandfinch.example.com","id":3101,"is_default":true,"last_checked_at":"2026-11-03T09:16:40Z","last_test":null,"make_default_reason":null,"operation_id":5120,"records":[{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":null,"purpose":"spf","required":true,"state":"missing","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":null,"found":null,"name":"pic._domainkey.mg.harbourandfinch.example.com","priority":null,"purpose":"dkim","required":true,"state":"missing","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"email.mg.harbourandfinch.example.com","priority":null,"purpose":"tracking","required":true,"state":"missing","type":"CNAME","value":"eu.mail.example.net"}],"remove_reason":null,"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"verified","state_label":"Verified","test_reason":null,"verified_at":"2026-11-03T09:16:40Z"}],"error":null,"last_checked_at":"2026-11-03T09:16:40Z","mailpit":null,"operation":{"id":5122,"scope":"site","status":"executing","status_label":"Creating the new credential","summary":"New SMTP credential for mg.harbourandfinch.example.com","to_version":null,"type":"mail_rotate","type_label":"Email credentials"},"records":[{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":null,"purpose":"spf","required":true,"state":"missing","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":null,"found":null,"name":"pic._domainkey.mg.harbourandfinch.example.com","priority":null,"purpose":"dkim","required":true,"state":"missing","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"email.mg.harbourandfinch.example.com","priority":null,"purpose":"tracking","required":true,"state":"missing","type":"CNAME","value":"eu.mail.example.net"}],"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"verified","state_label":"Verified","store_mapping":null,"test":{"last_sent_at":null,"last_to":null,"remaining_today":20},"verified_at":"2026-11-03T09:16:40Z"},"operation":{"applied_at":"2026-11-03T09:16:40Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5122,"install":null,"label":"New credential created","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Creating the new credential","step":"credential","steps":[{"key":"credential","label":"New credential created","state":"current"},{"key":"secret","label":"Credentials stored","state":"todo"},{"key":"restart_pending","label":"Settings sent","state":"todo"},{"key":"restarted","label":"Settings applied","state":"todo"},{"key":"verified","label":"New login verified","state":"todo"},{"key":"revoked","label":"Old credentials revoked","state":"todo"}],"subject":null,"summary":"New SMTP credential for mg.harbourandfinch.example.com","to_version":null,"type":"mail_rotate","type_label":"Email credentials"}},"schema":{"$ref":"#/components/schemas/EmailChangeStarted"}}},"description":"The login is being rotated. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/EmailDomainNotFound"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The login cannot be rotated now. `reason` says why: `state` (the sending domain is not set up yet),\n`unavailable` (this environment does not send email itself), `busy` (another change is running),\n`restore_running`, `removed`, `deleted`, `provisioning` or `managed_elsewhere`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Rotate a sending domain's SMTP login","tags":["Outbound email"],"x-effect":["changes-settings"],"x-feature":"email","x-file":"email","x-gates":["email"],"x-long-running":"getSiteEmailOperation","x-rate-limit":{"also":[{"bucket":"reseller-email-rotate","limit":3,"minutes":60,"per":"person"}],"bucket":"reseller-email","limit":12,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/email/test":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Sends one test email from the site through a verified sending domain, the default unless `domain` names\nanother. The answer is a command: when its `status` is `queued` or `running`, follow it with the command\nendpoint. Beside the limit on changes, a site may send 20 test emails a day (the day in UTC), counted with\nthe tests sent from the Control Panel and by AI assistants: `test.remaining_today` of the email settings says\nhow many are left, and a test past the last answers 429 `limit`, which no wait within the day lifts. One test\nis sent at a time on a site.\n","operationId":"sendSiteEmailTest","requestBody":{"content":{"application/json":{"examples":{"test":{"summary":"Send a test to one address","value":{"to":"tom.harbour@harbourandfinch.example.com"}}},"schema":{"$ref":"#/components/schemas/EmailTestRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"command":{"blocked_until_verified":false,"duration_ms":0,"error":null,"exit_code":0,"finished_at":"2026-11-03T09:16:40Z","id":6187,"input":{"domain":"mg.harbourandfinch.example.com","to":"tom.harbour@harbourandfinch.example.com"},"kind":"email_test","label":"Send a test email","operation_id":null,"output_excerpt":"sent\n","queued_at":"2026-11-03T09:16:40Z","requested_by":{"id":2012,"name":"Daniel Reyes"},"result":{"message":"Sent. Check the inbox (and spam) of tom.harbour@harbourandfinch.example.com.","sent":true},"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-03T09:16:40Z","status":"succeeded","status_label":"Done"}},"schema":{"$ref":"#/components/schemas/EmailCommandAnswer"}}},"description":"The test was started. `command.result` holds its outcome once it has finished."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/EmailDomainNotFound"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"command_running":{"summary":"Another test email is being sent","value":{"code":"command_running","message":"A test email is already being sent for this site. Try again in a moment.","reason":"command_running"}},"state":{"summary":"The sending domain is not verified","value":{"code":"state","message":"Test emails can be sent once the sending domain is verified","reason":"state"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The test cannot be sent now. `reason` says why: `state` (the sending domain is not verified, or the site\ndoes not send through it yet), `command_running` (another test, or another action, is still running on\nthe site), `busy` (a change is running), `restore_running`, `deployment_running`, `not_running` (the site\nis not running), `exec_unresolved` (an earlier command has not been confirmed stopped: contact support),\n`removed`, `deleted`, `provisioning` or `managed_elsewhere`.\n"},"422":{"content":{"application/json":{"examples":{"no_recipient":{"summary":"No address to send to","value":{"code":"invalid","errors":{"to":["Enter the address to send the test email to"]},"field":"to","message":"Enter the address to send the test email to","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`to` is missing or not an email address (`invalid`, with `field` and `errors`).\n"},"429":{"content":{"application/json":{"examples":{"limit":{"summary":"The site's 20 test emails for today are sent","value":{"code":"limit","message":"Twenty test emails a day per site. Try again tomorrow.","reason":"limit"}},"rate_limited":{"summary":"The limit on changes is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests. `rate_limited`: the limit on changes is spent; wait for the number of seconds in\n`Retry-After`, which `retry_after_seconds` repeats. `limit`: the site has sent its 20 test emails for\ntoday; this answer carries no `Retry-After`, no `X-RateLimit-Reset` and no `retry_after_seconds`, and the\ncount starts again at midnight UTC.\n","headers":{"Retry-After":{"description":"Sent with `rate_limited` only.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"The limit on changes in a minute (12). Sent with `rate_limited` and with `limit`.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"How many changes are left in the current minute. Sent with `rate_limited` and with `limit`; it does\nnot count the day's test emails.\n","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Sent with `rate_limited` only.","schema":{"type":"integer"}}}},"503":{"content":{"application/json":{"examples":{"cluster_unreachable":{"summary":"The site's cluster could not be reached","value":{"message":"The cluster could not be reached"}},"switched_off":{"summary":"Commands on sites are switched off","value":{"code":"switched_off","message":"Site commands are switched off at the moment","reason":"switched_off"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"Corefinity has switched commands on sites off for the moment (`switched_off`), or the site's cluster could\nnot be reached, which is answered with a message only. Try again later.\n"}},"summary":"Send a test email","tags":["Outbound email"],"x-effect":["sends"],"x-feature":"email","x-file":"email","x-gates":["email","exec"],"x-rate-limit":{"also":[{"bucket":"email-tests","limit":20,"minutes":1440,"per":"environment"}],"bucket":"reseller-email","limit":12,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/email/verify":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Asks the email provider to look for the sending domain's DNS records now, and answers the settings as they\nthen read. A domain whose required records are found becomes `verified`. Without `domain` the default sending\ndomain is checked.\n","operationId":"checkSiteEmailDomain","requestBody":{"content":{"application/json":{"examples":{"default_domain":{"summary":"Re-check the default sending domain","value":{}},"named_domain":{"summary":"Re-check one sending domain","value":{"domain":"mg.harbourandfinch.example.com"}}},"schema":{"$ref":"#/components/schemas/EmailDomainChoice"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"add":{"allowed":true,"count":1,"default_prefix":"mg","max":5,"reason":null},"cloudflare":{"can_write_records":true,"connected":true,"written_at":null,"zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"default_domain":"mg.harbourandfinch.example.com","domains":[{"active":true,"added_at":"2026-11-03T09:16:40Z","added_by":"Daniel Reyes","can_make_default":false,"can_remove":true,"can_rotate":true,"can_test":false,"cloudflare":{"can_write_records":true,"connected":true,"written_at":null,"zone":{"id":"example-zone-id","name":"harbourandfinch.example.com"}},"error":null,"from_domain":"harbourandfinch.example.com","id":3101,"is_default":true,"last_checked_at":"2026-11-03T09:16:40Z","last_test":null,"make_default_reason":null,"operation_id":5120,"records":[{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":null,"purpose":"spf","required":true,"state":"missing","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":null,"found":null,"name":"pic._domainkey.mg.harbourandfinch.example.com","priority":null,"purpose":"dkim","required":true,"state":"missing","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"email.mg.harbourandfinch.example.com","priority":null,"purpose":"tracking","required":true,"state":"missing","type":"CNAME","value":"eu.mail.example.net"}],"remove_reason":null,"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"pending_dns","state_label":"Waiting for DNS","test_reason":"Test emails can be sent once the sending domain is verified","verified_at":null}],"error":null,"last_checked_at":"2026-11-03T09:16:40Z","mailpit":null,"operation":null,"records":[{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":null,"purpose":"spf","required":true,"state":"missing","type":"TXT","value":"v=spf1 include:mail.example.net ~all"},{"cloudflare":null,"found":null,"name":"pic._domainkey.mg.harbourandfinch.example.com","priority":null,"purpose":"dkim","required":true,"state":"missing","type":"TXT","value":"k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxa.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"mg.harbourandfinch.example.com","priority":10,"purpose":"mx","required":false,"state":"missing","type":"MX","value":"mxb.eu.mail.example.net"},{"cloudflare":null,"found":null,"name":"email.mg.harbourandfinch.example.com","priority":null,"purpose":"tracking","required":true,"state":"missing","type":"CNAME","value":"eu.mail.example.net"}],"sender":{"address":"noreply@harbourandfinch.example.com","name":"Harbour & Finch"},"sending_domain":"mg.harbourandfinch.example.com","state":"pending_dns","state_label":"Waiting for DNS","store_mapping":null,"test":{"last_sent_at":null,"last_to":null,"remaining_today":20},"verified_at":null},"schema":{"$ref":"#/components/schemas/EmailSettings"}}},"description":"The email settings after the check."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/EmailDomainNotFound"},"409":{"content":{"application/json":{"examples":{"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is deleted and waiting to be purged (`deleted`), still being created (`provisioning`), or managed\nby another control panel (`managed_elsewhere`).\n"},"422":{"content":{"application/json":{"examples":{"not_at_provider":{"summary":"The email provider does not have the domain yet","value":{"code":"state","message":"Mailgun does not have this sending domain yet. Retry the set-up.","reason":"state"}},"state":{"summary":"No sending domain to check","value":{"code":"state","message":"There is no sending domain to re-check yet","reason":"state"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"There is nothing to check (`state`): the site has no sending domain yet, its sending domain is still being\ncreated or removed, or the email provider does not have it yet.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/EmailProviderFailed"}},"summary":"Check a sending domain's DNS records","tags":["Outbound email"],"x-effect":["changes-settings"],"x-feature":"email","x-file":"email","x-gates":["email"],"x-rate-limit":{"bucket":"reseller-email","limit":12,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/environment":{"parameters":[{"$ref":"#/components/parameters/site"}],"patch":{"description":"Changes the environment whose row `{site}` names. Send only what changes. The request body's variants say\nwhat each kind of change takes and who may make it.\n","operationId":"updateSiteEnvironment","requestBody":{"content":{"application/json":{"examples":{"resize":{"summary":"Resize a staging environment now","value":{"apply":"now","uat_size":"medium"}},"settings":{"summary":"Rename the environment and switch scheduled snapshots off","value":{"name":"QA","scheduled_snapshots":false}}},"schema":{"$ref":"#/components/schemas/EnvironmentUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"settings":{"summary":"The environment, renamed","value":{"operation":null,"site":{"access_summary":{"apply_state":"never","company_keys":0,"keys":0,"users":0},"actions":{"apply_pending_now":{"available":false,"reason":"Scheduled maintenance is switched off at the moment"},"attach_domain":{"available":true,"reason":null},"change_url":{"available":false,"reason":"Domains are switched off at the moment"},"clone":{"available":true,"reason":null},"create_environment":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"go_live":{"available":true,"reason":null},"maintenance":{"available":true,"reason":null},"push_to_live":{"available":true,"reason":null},"restore_deleted":{"available":false,"reason":"Environments are removed at once. Recreate it from the final snapshot."},"terminal":{"available":false,"reason":"The terminal is available once the site is running"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":true,"primary":null,"tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1043,"name":"QA","role":"staging","role_label":"Staging","slug":"staging"},"environments":[{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1043,"name":"QA","role":"staging","role_label":"Staging","slug":"staging"}],"final_snapshot_note":"Snapshots are off for this cluster, so no final copy is taken: it cannot be brought back afterwards.","health":"unknown","hosting":{"cluster_kind":"customer","label":"CoreCluster Northwind UK 1"},"http_auth_summary":{"apply_state":"applied","enabled":true,"rules":0,"users":0},"id":1043,"kind":"corecluster","lifecycle":"active","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.4"},"mode":"staging","mode_label":"No domain","operation":null,"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://harbourandfinch-example-com-staging.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":true,"url":"https://harbourandfinch-example-com-staging.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":true,"scheduled_snapshots":false},"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":"rs-northwind-harbourandfinch-example-com--staging","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20032 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20032,"sftp_command":"sftp -P 20032 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20032 web@ssh-northwind.example.net","user":"web","users":0},"tier":"S","uat_size":null,"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}}}}},"schema":{"$ref":"#/components/schemas/EnvironmentSettingsSaved"}}},"description":"The settings were saved at once. `operation` is null."},"201":{"content":{"application/json":{"examples":{"resize":{"description":"A resize answers the row, the operation it started (null when it waits for the maintenance window), the accepted quote and the row's pending changes. A queued resize also answers the `window` it waits for.","summary":"A resize started now","value":{"item":null,"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-10T09:00:00+00:00","completed_at":null,"created_at":"2026-11-10T09:00:00+00:00","environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com--staging","hostname":"journal-harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1052,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"journal.harbourandfinch.example.com","id":1052},"status":"committed","status_label":"In progress","steps":[{"key":"checked","label":"Checked","state":"done"},{"key":"committed","label":"Committed","state":"done"},{"key":"applied","label":"Applied","state":"current"}],"subject":null,"summary":"Resize environment","to_version":null,"type":"uat_resize","type_label":"Resize environment"},"pending":{"batch":null,"can_apply_now":{"available":false,"reason":"nothing_pending"},"environment":{"id":1052,"name":"Staging","role":"staging","slug":"staging"},"items":[],"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"tier":null,"window":{"date":"2026-11-10","ends_at":"2026-11-11T07:00:00Z","label":"Tonight 21:00–07:00 (Europe/London)","starts_at":"2026-11-10T21:00:00Z"}},"queued":false,"quote":{"applies":"now","currency":"GBP","effective_from":"2026-11-10T09:00:00Z","expires_at":"2026-11-10T09:15:00Z","id":"4a3f0c1e-2b7d-4c55-9e1f-0f6b3c2d1a90","lines":[{"after":{"amount":"75.00","currency":"GBP"},"before":{"amount":"0.00","currency":"GBP"},"delta":{"amount":"75.00","currency":"GBP"},"key":"uat","label":"Staging environment: small → medium"}],"monthly_after":{"amount":"75.00","currency":"GBP"},"monthly_before":{"amount":"0.00","currency":"GBP"},"monthly_delta":{"amount":"75.00","currency":"GBP"},"prorata":{"amount":{"amount":"51.56","currency":"GBP"},"from":"2026-11-10T09:00:00Z","hours":495,"to":"2026-12-01T00:00:00Z"},"tax":{"amount":{"amount":"15.00","currency":"GBP"},"kind":"standard","note":"UK VAT 20 %","rate_percent":20},"trial":null},"site":{"access_summary":{"apply_state":"never","company_keys":0,"keys":0,"users":0},"actions":{"apply_pending_now":{"available":false,"reason":"Nothing is waiting for tonight."},"attach_domain":{"available":true,"reason":null},"change_url":{"available":false,"reason":"Domains are switched off at the moment"},"clone":{"available":true,"reason":null},"create_environment":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"go_live":{"available":true,"reason":null},"maintenance":{"available":true,"reason":null},"push_to_live":{"available":true,"reason":null},"restore_deleted":{"available":false,"reason":"Environments are removed at once. Recreate it from the final snapshot."},"terminal":{"available":false,"reason":"The terminal is available once the site is running"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"journal.harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":true,"primary":null,"tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com--staging","hostname":"journal-harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1052,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"},"environments":[{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},{"env_id":"rs-northwind-journal-harbourandfinch-example-com--staging","hostname":"journal-harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1052,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"}],"final_snapshot_note":"Snapshots are off for this cluster, so no final copy is taken: it cannot be brought back afterwards.","health":"applying","hosting":{"cluster_kind":"customer","label":"CoreCluster Northwind UK 1"},"http_auth_summary":{"apply_state":"applied","enabled":true,"rules":0,"users":0},"id":1052,"kind":"corestack","lifecycle":"active","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.4"},"mode":"staging","mode_label":"No domain","operation":{"id":5121,"scope":"site","status":"committed","status_label":"Waiting for the platform","summary":"Resize environment","to_version":null,"type":"uat_resize","type_label":"Resize environment"},"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://journal-harbourandfinch-example-com-staging.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":true,"url":"https://journal-harbourandfinch-example-com-staging.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":true,"scheduled_snapshots":false},"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"site_id":"rs-northwind-journal-harbourandfinch-example-com--staging","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20002 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20002,"sftp_command":"sftp -P 20002 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20002 web@ssh-northwind.example.net","user":"web","users":0},"tier":"small","uat_size":null,"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}}}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/EnvironmentResized"},{"$ref":"#/components/schemas/EnvironmentSettingsSaved"}]}}},"description":"A change was started or queued. `operation` is the operation that applies it, to follow until it completes,\nor null when the change waits for the maintenance window.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"agency":{"description":"Billing stays with the company that pays for the site, never with the agency that manages it.","summary":"A resize by a person of the managing agency","value":{"code":"forbidden","message":"Billing for this site is Harbour & Finch's.","reason":"forbidden"}},"billing_forbidden":{"description":"A resize changes what you pay, so it needs a person who may manage billing for the site.","summary":"A resize by a person who may not manage billing","value":{"code":"billing_forbidden","message":"Billing is available to your company's owner and billing contacts.","reason":"billing_forbidden"}},"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"permission":{"description":"Changing `auto_deploy` needs the Manage Deployment Source permission, and switching it on Create Deployments as well.","summary":"Your role may not change auto-deploy","value":{"code":"forbidden","message":"You need the Manage Deployment Source permission to do this. An owner of your company can grant it in Roles.","permission":"manageDeploymentSource","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope (`scope_required`), two-factor authentication is required and not set up, or\nyou may not make this change: `forbidden`, with the `permission` you\nlack where a permission decides it, or a reason of its own that the message explains.\n"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The id does not exist or is something you cannot change, or the feature is not on for your company (`feature_off`): environments, or the feature a field of the request belongs to."},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"contract_missing":{"summary":"The site has no billing set up","value":{"code":"contract_missing","message":"Ask support to set up billing for this site","reason":"contract_missing"}},"included_size":{"summary":"A size below the one the package includes","value":{"code":"included_size","message":"The included staging environment cannot be smaller than small","reason":"included_size"}},"managed_elsewhere":{"summary":"Another control panel manages the site","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"no_payment_method":{"summary":"The billing account has no card or mandate","value":{"code":"no_payment_method","message":"Add a card or a Direct Debit mandate first","reason":"no_payment_method"}},"stale":{"description":"Ask for a new quote and send its `quote_id`.","summary":"The price has moved since the quote","value":{"code":"stale","message":"Prices changed. Review the quote again.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change cannot be made now. `reason` says why: `managed_elsewhere`, `deleted`, `provisioning`, `busy`\n(another change is running) or a reason of the change's own, which the message explains.\n"},"422":{"content":{"application/json":{"examples":{"name_empty":{"summary":"A new name that is empty, or holds a control character","value":{"code":"invalid","errors":{"name":["Give the environment a name"]},"field":"name","message":"Give the environment a name","reason":"invalid"}},"name_long":{"summary":"A new name of more than 40 characters","value":{"code":"invalid","errors":{"name":["Use at most 40 characters."]},"field":"name","message":"Use at most 40 characters.","reason":"invalid"}},"name_markup":{"summary":"A new name with < or >","value":{"code":"invalid","errors":{"name":["An environment name cannot contain < or >"]},"field":"name","message":"An environment name cannot contain < or >","reason":"invalid"}},"name_taken":{"summary":"Another environment has the name","value":{"code":"invalid","errors":{"name":["Another environment of this site is already called staging"]},"field":"name","message":"Another environment of this site is already called staging","reason":"invalid"}},"not_a_setting":{"summary":"A field that is not a setting","value":{"code":"invalid","errors":{"apply":["The apply field is not part of this request."]},"field":"apply","message":"The apply field is not part of this request.","reason":"invalid"}},"not_boolean":{"summary":"A setting that is not true or false","value":{"code":"invalid","errors":{"scheduled_snapshots":["Choose on or off"]},"field":"scheduled_snapshots","message":"Choose on or off","reason":"invalid"}},"nothing":{"summary":"Nothing to change","value":{"code":"invalid","errors":{"name":["Change at least one setting"]},"field":"name","message":"Change at least one setting","reason":"invalid"}},"rename_alone":{"summary":"A new name beside the HTTP authentication switch","value":{"code":"invalid","errors":{"http_auth_enabled":["Rename the environment on its own, then switch HTTP authentication"]},"field":"http_auth_enabled","message":"Rename the environment on its own, then switch HTTP authentication","reason":"invalid"}},"resize_alone":{"summary":"A resize beside another setting","value":{"code":"invalid","errors":{"name":["A resize is sent on its own."]},"field":"name","message":"A resize is sent on its own.","reason":"invalid"}},"snapshots_off":{"summary":"Scheduled snapshots switched on where snapshots are not on","value":{"code":"invalid","errors":{"scheduled_snapshots":["Snapshots are not turned on for this cluster. Contact support to have them turned on."]},"field":"scheduled_snapshots","message":"Snapshots are not turned on for this cluster. Contact support to have them turned on.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"A field is missing or wrong (`invalid`): `field` names the first one and `errors` lists every one. A field\nof a feature that is switched off is refused here with `feature_off` on that field. Nothing in the request\nis applied.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update an environment","tags":["Environments"],"x-effect":["changes-settings","billable"],"x-feature":"environments","x-file":"environments","x-gates":["environments"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-env-changes","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/environments":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Lists the site's production row and every environment, what a new environment can be copied from, and whether\nyou can add one. `{site}` is any row of the site.\n","operationId":"listSiteEnvironments","responses":{"200":{"content":{"application/json":{"example":{"branches":{"available":false,"reason":"Environments from a git branch are switched off at the moment"},"can_create":{"available":true,"reason":null},"clone":{"available":true,"reason":null},"environments":[{"auto_deploy":false,"branch":null,"create_failed":false,"created_at":"2026-11-10T00:59:38Z","created_by":null,"deploy_mode":"manual","env_id":"rs-northwind-harbourandfinch-example-com","health":"unknown","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","http_auth":{"enabled":false,"users":0},"id":1042,"lifecycle":"active","mode":"staging","mode_label":"No domain","name":"Production","operation":null,"platform_url":"https://harbourandfinch-example-com.northwind.cfstack.example.net","primary_url":null,"restore":null,"role":"production","role_label":"Production","scheduled_snapshots":true,"slug":"production","source":null,"tier":"S","usage_p95":{"basis":"estimate","cpu_millicores":null,"memory_bytes":null}},{"auto_deploy":false,"branch":null,"create_failed":false,"created_at":"2026-11-10T00:59:38Z","created_by":null,"deploy_mode":"manual","env_id":"rs-northwind-harbourandfinch-example-com--staging","final_snapshot_note":"Snapshots are off for this cluster, so no final copy is taken: it cannot be brought back afterwards.","health":"unknown","hostname":"harbourandfinch-example-com-staging.northwind.cfstack.example.net","http_auth":{"enabled":true,"users":0},"id":1043,"lifecycle":"active","mode":"staging","mode_label":"No domain","name":"Staging","operation":null,"platform_url":"https://harbourandfinch-example-com-staging.northwind.cfstack.example.net","primary_url":null,"restore":null,"role":"staging","role_label":"Staging","scheduled_snapshots":false,"slug":"staging","source":null,"tier":"S","usage_p95":{"basis":"estimate","cpu_millicores":null,"memory_bytes":null}}],"limits":{"name_max":40,"slug_max":16},"production":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"queued_copies":[],"site":{"cluster":{"id":1017,"name":"Northwind UK 1"},"domain":"harbourandfinch.example.com","id":1042,"lifecycle":"active","platform":{"key":"wordpress","label":"WordPress"}},"sizing":{"by":"tier","default":null,"included":null,"pricing":null,"sizes":null},"sources":[{"can_clone":{"available":true,"reason":null},"environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"}},{"can_clone":{"available":true,"reason":null},"environment":{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"}}]},"schema":{"$ref":"#/components/schemas/EnvironmentGroup"}}},"description":"The site's environments."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's environments","tags":["Environments"],"x-feature":"environments","x-file":"environments","x-gates":["environments"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"Adds a staging environment to the site, protected by HTTP authentication from the start, with the data\n`source` chooses. Follow `operation.id` until it completes; `credentials` is the generated HTTP authentication login, answered once with\n`Cache-Control: no-store`.\n","operationId":"createSiteEnvironment","requestBody":{"content":{"application/json":{"examples":{"clone":{"summary":"A copy of the Staging environment, files and database","value":{"name":"Review","slug":"review","source":{"environment_id":1043,"scope":"files_db","type":"clone"}}},"empty":{"summary":"An empty environment","value":{"name":"QA","source":{"type":"empty"}}}},"schema":{"$ref":"#/components/schemas/EnvironmentCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"created":{"summary":"A token with the exec scope","value":{"credentials":{"password":"Example-generated-password-1","revealed_at":"2026-11-10T00:59:39Z","rule_id":3120,"user_id":3121,"username":"example"},"environment":{"access_summary":{"apply_state":"applied","company_keys":0,"keys":0,"users":1},"actions":{"apply_pending_now":{"available":false,"reason":"Scheduled maintenance is switched off at the moment"},"attach_domain":{"available":false,"reason":"The site is still being created"},"change_url":{"available":false,"reason":"Domains are switched off at the moment"},"clone":{"available":false,"reason":"This environment is still being created"},"create_environment":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"go_live":{"available":false,"reason":"The site is still being created"},"maintenance":{"available":false,"reason":"This site is still being created"},"push_to_live":{"available":false,"reason":"This environment is still being created"},"restore_deleted":{"available":false,"reason":"Environments are removed at once. Recreate it from the final snapshot."},"terminal":{"available":false,"reason":"The terminal is available once the site is running"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":false,"primary":null,"tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-harbourandfinch-example-com--qa","hostname":"harbourandfinch-example-com-qa.northwind.cfstack.example.net","id":1044,"name":"QA","role":"staging","role_label":"Staging","slug":"qa"},"environments":[{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"},{"env_id":"rs-northwind-harbourandfinch-example-com--qa","hostname":"harbourandfinch-example-com-qa.northwind.cfstack.example.net","id":1044,"name":"QA","role":"staging","role_label":"Staging","slug":"qa"}],"final_snapshot_note":"Snapshots are off for this cluster, so no final copy is taken: it cannot be brought back afterwards.","health":"applying","hosting":{"cluster_kind":"customer","label":"CoreCluster Northwind UK 1"},"http_auth_summary":{"apply_state":"applied","enabled":true,"rules":1,"users":1},"id":1044,"kind":"corestack","lifecycle":"provisioning","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.4"},"mode":"staging","mode_label":"No domain","operation":{"id":5120,"scope":"site","status":"committed","status_label":"Waiting for the platform","summary":"New environment","to_version":null,"type":"env_create","type_label":"New environment"},"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://harbourandfinch-example-com-qa.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":true,"url":"https://harbourandfinch-example-com-qa.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":true,"scheduled_snapshots":false},"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":"rs-northwind-harbourandfinch-example-com--qa","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20033 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20033,"sftp_command":"sftp -P 20033 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20033 web@ssh-northwind.example.net","user":"web","users":1},"tier":"S","uat_size":null,"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-10T00:59:39Z","completed_at":null,"created_at":"2026-11-10T00:59:39Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com--qa","hostname":"harbourandfinch-example-com-qa.northwind.cfstack.example.net","id":1044,"name":"QA","role":"staging","role_label":"Staging","slug":"qa"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1044},"status":"committed","status_label":"Waiting for the platform","step":"picked_up","steps":[{"key":"reserved","label":"Port and address reserved","state":"done"},{"key":"namespace","label":"Place on the platform created","state":"done"},{"key":"dns","label":"Address published","state":"done"},{"key":"committed","label":"Saved to the platform","state":"done"},{"key":"picked_up","label":"Picked up by the platform","state":"current"},{"key":"starting","label":"Environment started","state":"todo"},{"key":"seeded","label":"Site prepared","state":"todo"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New environment","to_version":null,"type":"env_create","type_label":"New environment"}}},"password_withheld":{"summary":"A token without the exec scope","value":{"credentials":{"password":null,"password_withheld":{"message":"The generated HTTP authentication password is shown only to an access token with the exec scope. It stays revealable on the environment's Access tab.","scope":"exec"},"revealed_at":"2026-11-10T00:59:39Z","rule_id":3120,"user_id":3121,"username":"example"},"environment":{"access_summary":{"apply_state":"applied","company_keys":0,"keys":0,"users":1},"actions":{"apply_pending_now":{"available":false,"reason":"Scheduled maintenance is switched off at the moment"},"attach_domain":{"available":false,"reason":"The site is still being created"},"change_url":{"available":false,"reason":"Domains are switched off at the moment"},"clone":{"available":false,"reason":"This environment is still being created"},"create_environment":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"go_live":{"available":false,"reason":"The site is still being created"},"maintenance":{"available":false,"reason":"This site is still being created"},"push_to_live":{"available":false,"reason":"This environment is still being created"},"restore_deleted":{"available":false,"reason":"Environments are removed at once. Recreate it from the final snapshot."},"terminal":{"available":false,"reason":"The terminal is available once the site is running"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":false,"primary":null,"tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-harbourandfinch-example-com--qa","hostname":"harbourandfinch-example-com-qa.northwind.cfstack.example.net","id":1044,"name":"QA","role":"staging","role_label":"Staging","slug":"qa"},"environments":[{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"},{"env_id":"rs-northwind-harbourandfinch-example-com--qa","hostname":"harbourandfinch-example-com-qa.northwind.cfstack.example.net","id":1044,"name":"QA","role":"staging","role_label":"Staging","slug":"qa"}],"final_snapshot_note":"Snapshots are off for this cluster, so no final copy is taken: it cannot be brought back afterwards.","health":"applying","hosting":{"cluster_kind":"customer","label":"CoreCluster Northwind UK 1"},"http_auth_summary":{"apply_state":"applied","enabled":true,"rules":1,"users":1},"id":1044,"kind":"corestack","lifecycle":"provisioning","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.4"},"mode":"staging","mode_label":"No domain","operation":{"id":5120,"scope":"site","status":"committed","status_label":"Waiting for the platform","summary":"New environment","to_version":null,"type":"env_create","type_label":"New environment"},"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://harbourandfinch-example-com-qa.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":true,"url":"https://harbourandfinch-example-com-qa.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":true,"scheduled_snapshots":false},"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":"rs-northwind-harbourandfinch-example-com--qa","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20033 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20033,"sftp_command":"sftp -P 20033 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20033 web@ssh-northwind.example.net","user":"web","users":1},"tier":"S","uat_size":null,"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-10T00:59:39Z","completed_at":null,"created_at":"2026-11-10T00:59:39Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com--qa","hostname":"harbourandfinch-example-com-qa.northwind.cfstack.example.net","id":1044,"name":"QA","role":"staging","role_label":"Staging","slug":"qa"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1044},"status":"committed","status_label":"Waiting for the platform","step":"picked_up","steps":[{"key":"reserved","label":"Port and address reserved","state":"done"},{"key":"namespace","label":"Place on the platform created","state":"done"},{"key":"dns","label":"Address published","state":"done"},{"key":"committed","label":"Saved to the platform","state":"done"},{"key":"picked_up","label":"Picked up by the platform","state":"current"},{"key":"starting","label":"Environment started","state":"todo"},{"key":"seeded","label":"Site prepared","state":"todo"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New environment","to_version":null,"type":"env_create","type_label":"New environment"}}}},"schema":{"$ref":"#/components/schemas/EnvironmentCreated"}}},"description":"The environment is being created. Follow `operation.id`."},"202":{"content":{"application/json":{"examples":{"waiting":{"summary":"Waiting for another change","value":{"credentials":{"password":"Example-generated-password-1","revealed_at":"2026-11-10T00:59:52Z","rule_id":3120,"user_id":3121,"username":"example"},"environment":{"access_summary":{"apply_state":"applied","company_keys":0,"keys":0,"users":1},"actions":{"apply_pending_now":{"available":false,"reason":"Scheduled maintenance is switched off at the moment"},"attach_domain":{"available":false,"reason":"The site is still being created"},"change_url":{"available":false,"reason":"Domains are switched off at the moment"},"clone":{"available":false,"reason":"This environment is still being created"},"create_environment":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"go_live":{"available":false,"reason":"The site is still being created"},"maintenance":{"available":false,"reason":"This site is still being created"},"push_to_live":{"available":false,"reason":"This environment is still being created"},"restore_deleted":{"available":false,"reason":"Environments are removed at once. Recreate it from the final snapshot."},"terminal":{"available":false,"reason":"The terminal is available once the site is running"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":false,"primary":null,"tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-harbourandfinch-example-com--qa","hostname":"harbourandfinch-example-com-qa.northwind.cfstack.example.net","id":1044,"name":"QA","role":"staging","role_label":"Staging","slug":"qa"},"environments":[{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"harbourandfinch-example-com-staging.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"},{"env_id":"rs-northwind-harbourandfinch-example-com--qa","hostname":"harbourandfinch-example-com-qa.northwind.cfstack.example.net","id":1044,"name":"QA","role":"staging","role_label":"Staging","slug":"qa"}],"final_snapshot_note":"Snapshots are off for this cluster, so no final copy is taken: it cannot be brought back afterwards.","health":"applying","hosting":{"cluster_kind":"customer","label":"CoreCluster Northwind UK 1"},"http_auth_summary":{"apply_state":"applied","enabled":true,"rules":1,"users":1},"id":1044,"kind":"corestack","lifecycle":"provisioning","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.4"},"mode":"staging","mode_label":"No domain","operation":{"id":5120,"scope":"site","status":"pending","status_label":"Saving change","summary":"New environment","to_version":null,"type":"env_create","type_label":"New environment"},"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://harbourandfinch-example-com-qa.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":true,"url":"https://harbourandfinch-example-com-qa.northwind.cfstack.example.net"},"primary_url":null,"production_hosts":[],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":true,"scheduled_snapshots":false},"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":"rs-northwind-harbourandfinch-example-com--qa","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":null,"host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":null,"sftp_command":null,"tunnel_command":null,"user":"web","users":1},"tier":"S","uat_size":null,"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-10T00:59:52Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com--qa","hostname":"harbourandfinch-example-com-qa.northwind.cfstack.example.net","id":1044,"name":"QA","role":"staging","role_label":"Staging","slug":"qa"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":"Port and address reserved","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1044},"status":"pending","status_label":"Waiting for another change to finish. This carries on by itself.","step":"reserved","steps":[{"key":"reserved","label":"Port and address reserved","state":"current"},{"key":"namespace","label":"Place on the platform created","state":"todo"},{"key":"dns","label":"Address published","state":"todo"},{"key":"committed","label":"Saved to the platform","state":"todo"},{"key":"picked_up","label":"Picked up by the platform","state":"todo"},{"key":"starting","label":"Environment started","state":"todo"},{"key":"seeded","label":"Site prepared","state":"todo"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New environment","to_version":null,"type":"env_create","type_label":"New environment"}}}},"schema":{"$ref":"#/components/schemas/EnvironmentCreated"}}},"description":"The environment was accepted and waits: another change holds the cluster, or the platform's answer is still\nbeing confirmed. `operation.status` is `pending`. Follow `operation.id`.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The id does not exist or is something you cannot change, or the feature is not on for your company (`feature_off`). A `source` that names something you cannot use answers the same plain `404`."},"409":{"content":{"application/json":{"examples":{"cleaning_up":{"summary":"An environment with that name is still being removed","value":{"code":"cleaning_up","message":"This environment is being removed. Try again in a few minutes.","reason":"cleaning_up"}},"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted. Restore it first.","reason":"deleted"}},"duplicate":{"summary":"An environment with that name was added meanwhile","value":{"code":"duplicate","message":"An environment with that name already exists","reason":"duplicate"}},"managed_elsewhere":{"summary":"Another control panel manages the site","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"The site is still being created. Try again once it is ready.","reason":"provisioning"}},"site_unadopted":{"summary":"The site is not ready to be changed from the Control Panel","value":{"code":"site_unadopted","message":"This site is not ready to be changed from the Control Panel yet. Contact support.","reason":"site_unadopted"}},"source_busy":{"summary":"The environment to copy from is busy","value":{"code":"source_busy","message":"The environment to copy from is busy. Wait for it to finish.","reason":"source_busy"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The environment cannot be added now. `reason` says why: `managed_elsewhere` (checked first), `deleted`,\n`provisioning`, `site_unadopted` (the site is not ready to be changed from the Control Panel; contact support),\n`duplicate` (an environment with that name was added meanwhile), `cleaning_up` (an environment with that name is\nstill being removed), `source_busy` (the environment to copy from is not ready), `busy` (another change holds the\nname or the address) or another reason the message explains, such as a CoreCluster with no room left.\n"},"422":{"content":{"application/json":{"examples":{"name_missing":{"summary":"No name","value":{"code":"invalid","errors":{"name":["Give the environment a name"]},"field":"name","message":"Give the environment a name","reason":"invalid"}},"slug_taken":{"summary":"The name is already in use","value":{"code":"invalid","errors":{"slug":["An environment with that name already exists"]},"field":"slug","message":"An environment with that name already exists","reason":"invalid"}},"snapshot_transfer":{"summary":"A saved snapshot of an environment on other servers","value":{"code":"snapshot_transfer","errors":{"source.snapshot_id":["A saved snapshot can be copied only to an environment on the same servers for now, and these two environments are on different servers. Copy the live environment instead, or restore the snapshot to an environment on the same servers."]},"message":"A saved snapshot can be copied only to an environment on the same servers for now, and these two environments are on different servers. Copy the live environment instead, or restore the snapshot to an environment on the same servers.","reason":"snapshot_transfer"}},"source_anonymise_platform":{"summary":"An anonymised copy of a site that is not Shopware","value":{"code":"invalid","errors":{"source.anonymise":["An anonymised copy is offered on Shopware only"]},"field":"source.anonymise","message":"An anonymised copy is offered on Shopware only","reason":"invalid"}},"source_branch_missing":{"summary":"A branch source that names no branch","value":{"code":"invalid","errors":{"source.branch":["Choose a branch"]},"field":"source.branch","message":"Choose a branch","reason":"invalid"}},"source_branch_platform":{"summary":"A branch source on a site that is not WordPress","value":{"code":"invalid","errors":{"source.type":["Environments from a git branch are available for WordPress sites only at the moment. Start the environment empty or copy one."]},"field":"source.type","message":"Environments from a git branch are available for WordPress sites only at the moment. Start the environment empty or copy one.","reason":"invalid"}},"source_branch_with_field":{"summary":"A branch source with a copy's field","value":{"code":"invalid","errors":{"source.scope":["The source.scope field is not part of this request."]},"field":"source.scope","message":"The source.scope field is not part of this request.","reason":"invalid"}},"source_clone_with_field":{"summary":"A copy with a branch source's field","value":{"code":"invalid","errors":{"source.branch":["The source.branch field is not part of this request."]},"field":"source.branch","message":"The source.branch field is not part of this request.","reason":"invalid"}},"source_empty_with_field":{"summary":"An empty source with a copy's field","value":{"code":"invalid","errors":{"source.environment_id":["The source.environment_id field is not part of this request."]},"field":"source.environment_id","message":"The source.environment_id field is not part of this request.","reason":"invalid"}},"source_missing":{"summary":"No source","value":{"code":"invalid","errors":{"source.type":["Choose where the environment's data comes from"]},"field":"source.type","message":"Choose where the environment's data comes from","reason":"invalid"}},"unknown_field":{"summary":"A field that is not part of the request","value":{"code":"invalid","errors":{"role":["This request contains a field that is not part of it."]},"field":"role","message":"This request contains a field that is not part of it.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the request is refused for a reason of\nits own that names the field in `errors`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests","description":"Too many environments were added: wait for `Retry-After` seconds. Only a create that is accepted counts against the limit; one refused with a `4xx` does not."},"502":{"$ref":"#/components/responses/UpstreamFailed","description":"The platform did not save the new environment. Its operation has failed and nothing is left to follow; try again in a minute."},"503":{"content":{"application/json":{"examples":{"tier_cluster_missing":{"summary":"No servers for the environment in this region yet","value":{"code":"tier_cluster_missing","message":"The platform has no compute cluster for this here yet. Contact support.","reason":"tier_cluster_missing"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The platform cannot place the environment at the moment. `reason` says why: `tier_cluster_missing` (no servers for it in this region yet; contact support) or `temporarily_unavailable` (try again in a few minutes). Nothing was added."}},"summary":"Create a staging environment","tags":["Environments"],"x-effect":["billable"],"x-feature":"environments","x-file":"environments","x-gates":["environments"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-env-create","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"To be shown the generated HTTP authentication password in `credentials`. Without it the create still succeeds and the password is null"},{"needs":"deploy","when":"The environment is built from a git branch, which deploys that branch"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/environments/starts-with":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers what a new staging environment of the site inherits before you add it, and that HTTP authentication\nprotects it from the start. A part that is not available for the site is answered as null.\n`{site}` is any row of the site; a site that cannot take a new environment now is refused as adding one is.\n","operationId":"getEnvironmentStartsWith","responses":{"200":{"content":{"application/json":{"examples":{"everything":{"summary":"A site with the firewall and SSH keys","value":{"firewall":{"closed_to_others":false,"inherited":2,"items":[{"cidr":"203.0.113.10/32","layer":"website","owner":{"id":1302,"name":"harbourandfinch.example.com","type":"website"},"scope":"both"},{"cidr":"198.51.100.24/32","layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"scope":"both"}],"presets":[{"layer":"company","name":"GitHub Actions","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"ranges":1,"slug":"github-actions"}],"stage":"dark"},"http_auth":{"enabled":true},"ssh":{"items":[{"layer":"company","name":"Deploy key","owner":{"id":1204,"name":"Harbour & Finch","type":"company"}}],"keys":1}}},"neither":{"summary":"A site with neither the firewall nor SSH keys","value":{"firewall":null,"http_auth":{"enabled":true},"ssh":null}}},"schema":{"$ref":"#/components/schemas/EnvironmentStartsWith"}}},"description":"What the new environment starts with."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted. Restore it first.","reason":"deleted"}},"managed_elsewhere":{"summary":"Another control panel manages the site","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"The site is still being created. Try again once it is ready.","reason":"provisioning"}},"site_unadopted":{"summary":"The site is not ready to be changed from the Control Panel","value":{"code":"site_unadopted","message":"This site is not ready to be changed from the Control Panel yet. Contact support.","reason":"site_unadopted"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site cannot take a new environment now, so there is nothing to show. `reason` says why:\n`managed_elsewhere` (checked first), `deleted`, `provisioning` or `site_unadopted` (the site is not ready to\nbe changed from the Control Panel; contact support).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get what a new environment starts with","tags":["Environments"],"x-feature":"environments","x-file":"environment-starts-with","x-gates":["environments"],"x-rate-limit":{"bucket":"reseller-env-starts-with","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/error-pages":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers which errors show a page of yours or of the platform and which show the application's own answer, the pages, the `version` every change sends back, and the latest change.","operationId":"getSiteErrorPages","responses":{"200":{"content":{"application/json":{"example":{"applied_revision_id":312,"available":true,"can_change":true,"config":{"codes":{"404":"app","500":"page","502":"page","503":"page","504":"page"},"pages":{"404":{"message":null,"source":null},"500":{"message":null,"source":null},"502":{"message":null,"source":null},"503":{"message":null,"source":"<!DOCTYPE html><html><head><meta name=\"viewport\" content=\"width=device-width\"><title>Back soon</title></head><body><h1>Back soon</h1><p>{{message}}</p></body></html>"},"504":{"message":null,"source":null},"maintenance":{"message":null,"source":null}},"support_email":null},"limits":{"page_bytes":65536,"row_bytes":262144},"locked":null,"operation":{"can_retry":false,"completed_at":"2026-11-06T09:17:03Z","created_at":"2026-11-06T09:16:40Z","error":null,"id":5119,"outcome":"applied","status":"completed","steps":[{"at":"2026-11-06T09:16:40Z","detail":"No problems","key":"check","label":"Check","state":"done"},{"at":"2026-11-06T09:16:41Z","detail":null,"key":"commit","label":"Commit","state":"done"},{"at":"2026-11-06T09:16:58Z","detail":null,"key":"apply","label":"Apply","state":"done"},{"at":"2026-11-06T09:17:03Z","detail":"Checked on your site","key":"verify","label":"Verify","state":"done"}]},"pages":[{"bytes":0,"changed":null,"id":"maintenance","state":"platform","warnings":0},{"bytes":0,"changed":null,"id":"404","state":"app","warnings":0},{"bytes":0,"changed":null,"id":"500","state":"platform","warnings":0},{"bytes":0,"changed":null,"id":"502","state":"platform","warnings":0},{"bytes":169,"changed":{"at":"2026-11-02T15:41:09Z","by":"Eleanor Finch","revision":2},"id":"503","state":"custom","warnings":0},{"bytes":0,"changed":null,"id":"504","state":"platform","warnings":0}],"revision":{"author":"Eleanor Finch","created_at":"2026-11-02T15:41:09Z","id":312,"note":"Our own 503 page","number":2,"origin":"save"},"site_id":1042,"site_name":"harbourandfinch.example.com","tags":[{"description":"The status code of this page, for example 503.","scope":"compile","tag":"{{status_code}}"},{"description":"The message you set for this page.","scope":"compile","tag":"{{message}}"}],"unavailable_reason":null,"version":2},"schema":{"$ref":"#/components/schemas/ErrorPages"}}},"description":"The site's error pages. `tags` is shortened here."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 120 reads of error pages a minute you have across the API, the Control Panel and AI assistants. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"Get a site's error pages","tags":["Error pages"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-read","limit":120,"minutes":1,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Saves the whole configuration at the `version` you read: the setting of every code, every page and the support email. Scripts and anything else a page may not contain are removed, and `warnings` lists what was; the change is then checked on the site: follow the operation in the answer.","operationId":"replaceSiteErrorPages","requestBody":{"content":{"application/json":{"examples":{"app_shows_503":{"summary":"Let the application answer a 503 itself, and set the maintenance page's message","value":{"config":{"codes":{"404":"app","500":"page","502":"page","503":"app","504":"page"},"pages":{"404":{"message":null,"source":null},"500":{"message":null,"source":null},"502":{"message":null,"source":null},"503":{"message":null,"source":null},"504":{"message":null,"source":null},"maintenance":{"message":"Back at 10:00 UTC","source":null}},"support_email":"help@harbourandfinch.example.com"},"note":"Our app shows its own holding page","version":2}},"own_page":{"summary":"Change the message of your own 503 page","value":{"config":{"codes":{"404":"app","500":"page","502":"page","503":"page","504":"page"},"pages":{"404":{"message":null,"source":null},"500":{"message":null,"source":null},"502":{"message":null,"source":null},"503":{"message":"We are updating the shop.","source":"<!DOCTYPE html><html><head><meta name=\"viewport\" content=\"width=device-width\"><title>Back soon</title></head><body><h1>Back soon</h1><p>{{message}}</p></body></html>"},"504":{"message":null,"source":null},"maintenance":{"message":null,"source":null}},"support_email":null},"version":2}}},"schema":{"$ref":"#/components/schemas/ErrorPagesUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"operation":null,"revision":null},"schema":{"$ref":"#/components/schemas/ErrorPagesSaveResult"}}},"description":"The configuration is the one the site already has. Nothing was started."},"201":{"content":{"application/json":{"example":{"operation":{"can_retry":false,"completed_at":null,"created_at":"2026-11-06T09:16:40Z","error":null,"id":5123,"outcome":null,"status":"committed","steps":[{"at":"2026-11-06T09:16:40Z","detail":"No problems","key":"check","label":"Check","state":"done"},{"at":null,"detail":null,"key":"commit","label":"Commit","state":"current"},{"at":null,"detail":null,"key":"apply","label":"Apply","state":"todo"},{"at":null,"detail":null,"key":"verify","label":"Verify","state":"todo"}]},"revision":{"id":313,"number":3,"status":"applying"},"warnings":[]},"schema":{"$ref":"#/components/schemas/ErrorPagesSaveResult"}}},"description":"The change was saved. Follow `operation`; `revision` is the new revision."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"operation_in_progress":{"summary":"Another change is running","value":{"code":"operation_in_progress","message":"A change to this environment is in progress. Try again when it has finished.","reason":"operation_in_progress"}},"restore_running":{"summary":"A restore of the site is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"stale":{"summary":"The pages changed since your read","value":{"code":"stale","message":"Someone else changed these error pages. Read them again to see their change.","reason":"stale"}},"switch_reconcile_failed":{"summary":"The maintenance switch could not be checked","value":{"code":"switch_reconcile_failed","message":"The maintenance switch could not be checked on your site, so nothing was changed. Try again shortly.","reason":"switch_reconcile_failed"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change was refused because of the site's state. `reason` says why: `stale` (somebody saved since your read: read the pages again and send the new `version`), `operation_in_progress` (another change to the site has not finished), `restore_running` (a restore of the site is running), `switch_reconcile_failed` (the change leaves a 503 to the application while maintenance mode is on, and the site could not be reached to keep the maintenance page in place: nothing was changed) or `managed_elsewhere`."},"413":{"content":{"application/json":{"examples":{"too_large":{"summary":"One page is too large","value":{"bytes":70112,"code":"too_large","max_bytes":65536,"message":"This page is larger than 64 KB.","page":"503","reason":"too_large"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"A page is over 64 KiB, or the pages are over 256 KiB together (`too_large`). `page` names the page, or is null for the total; `bytes` and `max_bytes` say by how much."},"422":{"content":{"application/json":{"examples":{"error_pages_locked":{"summary":"Corefinity has locked the site's error pages","value":{"code":"error_pages_locked","message":"Corefinity has locked this environment's error pages. Contact support to change them.","reason":"error_pages_locked"}},"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"config":["418 is not a configurable code (404, 500, 502, 503, 504)."]},"field":"config","message":"418 is not a configurable code (404, 500, 502, 503, 504).","reason":"invalid"}},"invalid_page":{"summary":"A page cannot be saved as it is","value":{"code":"invalid_page","diagnostics":[{"code":"unknown_tag","column":5,"line":1,"message":"{{nope}} is not a tag. To show braces, write &#123;&#123;.","page":"500","severity":"error"}],"message":"These pages cannot be saved: fix the errors shown.","reason":"invalid_page"}},"runtime_lacks_capability":{"summary":"The site cannot use error pages yet","value":{"code":"runtime_lacks_capability","message":"Available after this site's platform update","reason":"runtime_lacks_capability"}},"unknown_field":{"summary":"A field the request does not take","value":{"code":"invalid","errors":{"nope":["nope is not one of version, config, note."]},"field":"nope","message":"nope is not one of version, config, note.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `invalid_page` (a page has a problem that stops the save; `diagnostics` lists each one), `overlap_nginx_rules` (the site's Nginx rules already set an error page for a code; `codes` lists them), `error_pages_locked` (Corefinity has locked the site's error pages) or `runtime_lacks_capability` (error pages arrive with the site's next platform update)."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 20 saves a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"Replace a site's error pages","tags":["Error pages"],"x-effect":["changes-settings","overwrites"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-long-running":"getSiteErrorPagesOperation","x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/error-pages/copy":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Copies this environment's settings and pages onto another environment of the same company, as a new revision there, for example to promote staging's pages to production. `version` is the other environment's. Copying onto a production environment needs `confirm_production: true`.","operationId":"copySiteErrorPages","requestBody":{"content":{"application/json":{"examples":{"copy_onto_production":{"summary":"Promote staging onto production","value":{"confirm_production":true,"note":"Promote the staging pages","to_site_id":1042,"version":2}},"copy_to_staging":{"summary":"Copy production onto the staging environment","value":{"to_site_id":1043,"version":0}}},"schema":{"$ref":"#/components/schemas/ErrorPagesCopy"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"operation":null,"revision":null},"schema":{"$ref":"#/components/schemas/ErrorPagesSaveResult"}}},"description":"The site already has that configuration. Nothing was started."},"201":{"content":{"application/json":{"example":{"operation":{"can_retry":false,"completed_at":null,"created_at":"2026-11-06T09:16:40Z","error":null,"id":5123,"outcome":null,"status":"committed","steps":[{"at":"2026-11-06T09:16:40Z","detail":"No problems","key":"check","label":"Check","state":"done"},{"at":null,"detail":null,"key":"commit","label":"Commit","state":"current"},{"at":null,"detail":null,"key":"apply","label":"Apply","state":"todo"},{"at":null,"detail":null,"key":"verify","label":"Verify","state":"todo"}]},"revision":{"id":313,"number":3,"status":"applying"},"warnings":[]},"schema":{"$ref":"#/components/schemas/ErrorPagesSaveResult"}}},"description":"The change was saved as a new revision. Follow `operation`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"operation_in_progress":{"summary":"Another change is running","value":{"code":"operation_in_progress","message":"A change to this environment is in progress. Try again when it has finished.","reason":"operation_in_progress"}},"restore_running":{"summary":"A restore of the site is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"stale":{"summary":"The pages changed since your read","value":{"code":"stale","message":"Someone else changed these error pages. Read them again to see their change.","reason":"stale"}},"switch_reconcile_failed":{"summary":"The maintenance switch could not be checked","value":{"code":"switch_reconcile_failed","message":"The maintenance switch could not be checked on your site, so nothing was changed. Try again shortly.","reason":"switch_reconcile_failed"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change was refused because of the site's state. `reason` says why: `stale` (somebody saved since your read: read the pages again and send the new `version`), `operation_in_progress` (another change to the site has not finished), `restore_running` (a restore of the site is running), `switch_reconcile_failed` (the change leaves a 503 to the application while maintenance mode is on, and the site could not be reached to keep the maintenance page in place: nothing was changed) or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"confirm":{"summary":"Copying onto production needs the confirmation","value":{"code":"confirm","errors":{"confirm_production":["Set confirm_production to true to change production's error pages."]},"field":"confirm_production","message":"Set confirm_production to true to change production's error pages.","reason":"confirm"}},"error_pages_locked":{"summary":"Corefinity has locked the site's error pages","value":{"code":"error_pages_locked","message":"Corefinity has locked this environment's error pages. Contact support to change them.","reason":"error_pages_locked"}},"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"to_site_id":["Choose another environment to copy to."]},"field":"to_site_id","message":"Choose another environment to copy to.","reason":"invalid"}},"invalid_page":{"summary":"A page cannot be saved as it is","value":{"code":"invalid_page","diagnostics":[{"code":"unknown_tag","column":5,"line":1,"message":"{{nope}} is not a tag. To show braces, write &#123;&#123;.","page":"500","severity":"error"}],"message":"These pages cannot be saved: fix the errors shown.","reason":"invalid_page"}},"runtime_lacks_capability":{"summary":"The site cannot use error pages yet","value":{"code":"runtime_lacks_capability","message":"Available after this site's platform update","reason":"runtime_lacks_capability"}},"tenant_mismatch":{"summary":"The other environment belongs to another company","value":{"code":"tenant_mismatch","message":"Error pages can be copied only between environments of the same company.","reason":"tenant_mismatch"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `invalid_page` (a page has a problem that stops the save; `diagnostics` lists each one), `overlap_nginx_rules` (the site's Nginx rules already set an error page for a code; `codes` lists them), `error_pages_locked` (Corefinity has locked the site's error pages) or `runtime_lacks_capability` (error pages arrive with the site's next platform update). A copy onto production without `confirm_production: true` answers `confirm`, and one between companies `tenant_mismatch`."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 20 saves a minute the target environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"Copy error pages to another environment","tags":["Error pages"],"x-effect":["changes-settings","overwrites"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-long-running":"getSiteErrorPagesOperation","x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/error-pages/operations/{operation}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of an error pages change of this site, from a change's `operation.id`.","in":"path","name":"operation","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers a change to the site's error pages. Read it again until `outcome` is set: `applied`, `applied_unverified` (live, but the site could not confirm it), `rejected` (the site kept its previous pages) or `unknown`.","operationId":"getSiteErrorPagesOperation","responses":{"200":{"content":{"application/json":{"example":{"operation":{"can_retry":false,"completed_at":"2026-11-06T09:17:03Z","created_at":"2026-11-06T09:16:40Z","error":null,"id":5123,"outcome":"applied","status":"completed","steps":[{"at":"2026-11-06T09:16:40Z","detail":"No problems","key":"check","label":"Check","state":"done"},{"at":"2026-11-06T09:16:41Z","detail":null,"key":"commit","label":"Commit","state":"done"},{"at":"2026-11-06T09:16:58Z","detail":null,"key":"apply","label":"Apply","state":"done"},{"at":"2026-11-06T09:17:03Z","detail":"Checked on your site","key":"verify","label":"Verify","state":"done"}]}},"schema":{"properties":{"operation":{"$ref":"#/components/schemas/ErrorPagesOperation"}},"required":["operation"],"type":"object"}}},"description":"The change."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 120 reads of error pages a minute you have across the API, the Control Panel and AI assistants. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"Get an error pages operation","tags":["Error pages"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-read","limit":120,"minutes":1,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/error-pages/preview":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Answers the page as visitors would get it, with the tags filled in from sample values and everything a page may not contain removed. Nothing is saved.","operationId":"previewSiteErrorPage","requestBody":{"content":{"application/json":{"examples":{"preview":{"summary":"Preview your own 503 page with a message","value":{"message":"Back at 10:00 UTC","page":"503","source":"<!DOCTYPE html><html><head><meta name=\"viewport\" content=\"width=device-width\"><title>Back soon</title></head><body><h1>Back soon</h1><p>{{message}}</p></body></html>"}}},"schema":{"$ref":"#/components/schemas/ErrorPageCheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"bytes":249,"diagnostics":[],"html":"<!DOCTYPE html><html><head>\n<meta name=\"robots\" content=\"noindex\"><meta name=\"viewport\" content=\"width=device-width\"><title>Back soon</title></head><body><h1>Back soon</h1><p>Back at 10:00 UTC</p></body></html>","samples":{"host":"www.harbourandfinch.example.com","message":"Back at 10:00 UTC","request_id":"4f2c9a1e7b3d4c5a8e6f0b1a2c3d4e5f","retry_after":"300","site_name":"harbourandfinch.example.com","status_code":"503","status_text":"Down for maintenance","support_email":"","time_utc":"2026-11-24T09:30:00+00:00"}},"schema":{"$ref":"#/components/schemas/ErrorPagePreview"}}},"description":"The page and what the check found."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"413":{"content":{"application/json":{"examples":{"too_large":{"summary":"The page is too large","value":{"bytes":70112,"code":"too_large","max_bytes":65536,"message":"This page is larger than 64 KB.","page":"503","reason":"too_large"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`source` is over 64 KiB (`too_large`). `page` names the page; `bytes` and `max_bytes` say by how much."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not one of the pages","value":{"code":"invalid","errors":{"page":["page is one of maintenance, 404, 500, 502, 503, 504."]},"field":"page","message":"page is one of maintenance, 404, 500, 502, 503, 504.","reason":"invalid"}},"message_too_long":{"summary":"A message over 300 characters","value":{"code":"invalid","errors":{"message":["The 503 message is at most 300 characters."]},"field":"message","message":"The 503 message is at most 300 characters.","reason":"invalid"}},"sample_key":{"summary":"A tag that `sample` cannot set","value":{"code":"invalid","errors":{"sample.status_code":["sample takes host, request_id, time_utc and support_email."]},"field":"sample.status_code","message":"sample takes host, request_id, time_utc and support_email.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`): a `page` that is not one, a field that is not text, a `sample` key other than the four it takes (`field` is `sample.<key>`), a `message` over 300 characters or with a line break in it, or a `sample.support_email` that is not an address."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 120 checks and previews a minute you have across the API, the Control Panel and AI assistants. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"Preview an error page","tags":["Error pages"],"x-effect":["none"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-preview","limit":120,"minutes":1,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/error-pages/reset":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Goes back to the platform's pages and settings, as a new revision. The history is kept.","operationId":"resetSiteErrorPages","requestBody":{"content":{"application/json":{"examples":{"reset":{"summary":"Back to the platform defaults","value":{"version":2}}},"schema":{"$ref":"#/components/schemas/ErrorPagesReset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"operation":null,"revision":null},"schema":{"$ref":"#/components/schemas/ErrorPagesSaveResult"}}},"description":"The site already has that configuration. Nothing was started."},"201":{"content":{"application/json":{"example":{"operation":{"can_retry":false,"completed_at":null,"created_at":"2026-11-06T09:16:40Z","error":null,"id":5123,"outcome":null,"status":"committed","steps":[{"at":"2026-11-06T09:16:40Z","detail":"No problems","key":"check","label":"Check","state":"done"},{"at":null,"detail":null,"key":"commit","label":"Commit","state":"current"},{"at":null,"detail":null,"key":"apply","label":"Apply","state":"todo"},{"at":null,"detail":null,"key":"verify","label":"Verify","state":"todo"}]},"revision":{"id":313,"number":3,"status":"applying"},"warnings":[]},"schema":{"$ref":"#/components/schemas/ErrorPagesSaveResult"}}},"description":"The change was saved as a new revision. Follow `operation`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"operation_in_progress":{"summary":"Another change is running","value":{"code":"operation_in_progress","message":"A change to this environment is in progress. Try again when it has finished.","reason":"operation_in_progress"}},"restore_running":{"summary":"A restore of the site is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"stale":{"summary":"The pages changed since your read","value":{"code":"stale","message":"Someone else changed these error pages. Read them again to see their change.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change was refused because of the site's state. `reason` says why: `stale` (somebody saved since your read: read the pages again and send the new `version`), `operation_in_progress` (another change to the site has not finished), `restore_running` (a restore of the site is running) or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"error_pages_locked":{"summary":"Corefinity has locked the site's error pages","value":{"code":"error_pages_locked","message":"Corefinity has locked this environment's error pages. Contact support to change them.","reason":"error_pages_locked"}},"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"version":["version is a whole number."]},"field":"version","message":"version is a whole number.","reason":"invalid"}},"invalid_page":{"summary":"A page cannot be saved as it is","value":{"code":"invalid_page","diagnostics":[{"code":"unknown_tag","column":5,"line":1,"message":"{{nope}} is not a tag. To show braces, write &#123;&#123;.","page":"500","severity":"error"}],"message":"These pages cannot be saved: fix the errors shown.","reason":"invalid_page"}},"runtime_lacks_capability":{"summary":"The site cannot use error pages yet","value":{"code":"runtime_lacks_capability","message":"Available after this site's platform update","reason":"runtime_lacks_capability"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `invalid_page` (a page has a problem that stops the save; `diagnostics` lists each one), `overlap_nginx_rules` (the site's Nginx rules already set an error page for a code; `codes` lists them), `error_pages_locked` (Corefinity has locked the site's error pages) or `runtime_lacks_capability` (error pages arrive with the site's next platform update)."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 20 saves a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"Reset error pages to the defaults","tags":["Error pages"],"x-effect":["changes-settings","overwrites"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-long-running":"getSiteErrorPagesOperation","x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/error-pages/retry":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Applies the saved revision again after the site refused it or the outcome was unknown (`can_retry` on the change). No new revision is made.","operationId":"retrySiteErrorPages","requestBody":{"content":{"application/json":{"examples":{"retry":{"summary":"Apply the saved pages again","value":{"version":2}}},"schema":{"$ref":"#/components/schemas/ErrorPagesRetry"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"operation":{"can_retry":false,"completed_at":null,"created_at":"2026-11-06T09:16:40Z","error":null,"id":5123,"outcome":null,"status":"committed","steps":[{"at":"2026-11-06T09:16:40Z","detail":"No problems","key":"check","label":"Check","state":"done"},{"at":null,"detail":null,"key":"commit","label":"Commit","state":"current"},{"at":null,"detail":null,"key":"apply","label":"Apply","state":"todo"},{"at":null,"detail":null,"key":"verify","label":"Verify","state":"todo"}]},"revision":{"id":312,"number":2,"status":"applying"},"warnings":[]},"schema":{"$ref":"#/components/schemas/ErrorPagesSaveResult"}}},"description":"The change started again. Follow `operation`; `revision` is the saved revision."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"operation_in_progress":{"summary":"Another change is running","value":{"code":"operation_in_progress","message":"A change to this environment is in progress. Try again when it has finished.","reason":"operation_in_progress"}},"restore_running":{"summary":"A restore of the site is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"stale":{"summary":"The pages changed since your read","value":{"code":"stale","message":"Someone else changed these error pages. Read them again to see their change.","reason":"stale"}},"switch_reconcile_failed":{"summary":"The maintenance switch could not be checked","value":{"code":"switch_reconcile_failed","message":"The maintenance switch could not be checked on your site, so nothing was changed. Try again shortly.","reason":"switch_reconcile_failed"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change was refused because of the site's state. `reason` says why: `stale` (somebody saved since your read: read the pages again and send the new `version`), `operation_in_progress` (another change to the site has not finished), `restore_running` (a restore of the site is running), `switch_reconcile_failed` (the change leaves a 503 to the application while maintenance mode is on, and the site could not be reached to keep the maintenance page in place: nothing was changed) or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"error_pages_locked":{"summary":"Corefinity has locked the site's error pages","value":{"code":"error_pages_locked","message":"Corefinity has locked this environment's error pages. Contact support to change them.","reason":"error_pages_locked"}},"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"version":["There is no failed change to retry."]},"field":"version","message":"There is no failed change to retry.","reason":"invalid"}},"invalid_page":{"summary":"A page cannot be saved as it is","value":{"code":"invalid_page","diagnostics":[{"code":"unknown_tag","column":5,"line":1,"message":"{{nope}} is not a tag. To show braces, write &#123;&#123;.","page":"500","severity":"error"}],"message":"These pages cannot be saved: fix the errors shown.","reason":"invalid_page"}},"runtime_lacks_capability":{"summary":"The site cannot use error pages yet","value":{"code":"runtime_lacks_capability","message":"Available after this site's platform update","reason":"runtime_lacks_capability"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `invalid_page` (a page has a problem that stops the save; `diagnostics` lists each one), `overlap_nginx_rules` (the site's Nginx rules already set an error page for a code; `codes` lists them), `error_pages_locked` (Corefinity has locked the site's error pages) or `runtime_lacks_capability` (error pages arrive with the site's next platform update). With no failed change to apply again, the answer is `invalid` on `version`."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 20 saves a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"Retry applying the error pages","tags":["Error pages"],"x-effect":["changes-settings"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-long-running":"getSiteErrorPagesOperation","x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/error-pages/revert":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Saves an earlier revision's configuration again, as a new revision, and applies it like any save.","operationId":"restoreSiteErrorPageRevision","requestBody":{"content":{"application/json":{"examples":{"revert":{"summary":"Put revision 311 back","value":{"note":"Back to the first pages","revision_id":311,"version":2}}},"schema":{"$ref":"#/components/schemas/ErrorPagesRevert"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"operation":null,"revision":null},"schema":{"$ref":"#/components/schemas/ErrorPagesSaveResult"}}},"description":"The site already has that configuration. Nothing was started."},"201":{"content":{"application/json":{"example":{"operation":{"can_retry":false,"completed_at":null,"created_at":"2026-11-06T09:16:40Z","error":null,"id":5123,"outcome":null,"status":"committed","steps":[{"at":"2026-11-06T09:16:40Z","detail":"No problems","key":"check","label":"Check","state":"done"},{"at":null,"detail":null,"key":"commit","label":"Commit","state":"current"},{"at":null,"detail":null,"key":"apply","label":"Apply","state":"todo"},{"at":null,"detail":null,"key":"verify","label":"Verify","state":"todo"}]},"revision":{"id":313,"number":3,"status":"applying"},"warnings":[]},"schema":{"$ref":"#/components/schemas/ErrorPagesSaveResult"}}},"description":"The change was saved as a new revision. Follow `operation`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"operation_in_progress":{"summary":"Another change is running","value":{"code":"operation_in_progress","message":"A change to this environment is in progress. Try again when it has finished.","reason":"operation_in_progress"}},"restore_running":{"summary":"A restore of the site is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"stale":{"summary":"The pages changed since your read","value":{"code":"stale","message":"Someone else changed these error pages. Read them again to see their change.","reason":"stale"}},"switch_reconcile_failed":{"summary":"The maintenance switch could not be checked","value":{"code":"switch_reconcile_failed","message":"The maintenance switch could not be checked on your site, so nothing was changed. Try again shortly.","reason":"switch_reconcile_failed"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change was refused because of the site's state. `reason` says why: `stale` (somebody saved since your read: read the pages again and send the new `version`), `operation_in_progress` (another change to the site has not finished), `restore_running` (a restore of the site is running), `switch_reconcile_failed` (the change leaves a 503 to the application while maintenance mode is on, and the site could not be reached to keep the maintenance page in place: nothing was changed) or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"error_pages_locked":{"summary":"Corefinity has locked the site's error pages","value":{"code":"error_pages_locked","message":"Corefinity has locked this environment's error pages. Contact support to change them.","reason":"error_pages_locked"}},"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"revision_id":["revision_id is a whole number from 1."]},"field":"revision_id","message":"revision_id is a whole number from 1.","reason":"invalid"}},"invalid_page":{"summary":"A page cannot be saved as it is","value":{"code":"invalid_page","diagnostics":[{"code":"unknown_tag","column":5,"line":1,"message":"{{nope}} is not a tag. To show braces, write &#123;&#123;.","page":"500","severity":"error"}],"message":"These pages cannot be saved: fix the errors shown.","reason":"invalid_page"}},"runtime_lacks_capability":{"summary":"The site cannot use error pages yet","value":{"code":"runtime_lacks_capability","message":"Available after this site's platform update","reason":"runtime_lacks_capability"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `invalid_page` (a page has a problem that stops the save; `diagnostics` lists each one), `overlap_nginx_rules` (the site's Nginx rules already set an error page for a code; `codes` lists them), `error_pages_locked` (Corefinity has locked the site's error pages) or `runtime_lacks_capability` (error pages arrive with the site's next platform update)."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 20 saves a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"Restore an error page revision","tags":["Error pages"],"x-effect":["changes-settings","overwrites"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-long-running":"getSiteErrorPagesOperation","x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/error-pages/revisions":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Lists the saved revisions of the site's error pages, newest first, with who changed what. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.","operationId":"listSiteErrorPageRevisions","parameters":[{"description":"Items a page: 1 to 100, default 20.","in":"query","name":"limit","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"content":{"application/json":{"example":{"next_cursor":null,"revisions":[{"author":"Eleanor Finch","created_at":"2026-11-02T15:41:09Z","id":312,"live":true,"note":"Our own 503 page","number":2,"origin":"save","source_revision_id":null,"status":"applied","summary":"503 → platform page; 503 page edited"},{"author":"Eleanor Finch","created_at":"2026-11-01T10:02:11Z","id":311,"live":false,"note":"First pages","number":1,"origin":"save","source_revision_id":null,"status":"applied","summary":"503 → your app's page"}]},"schema":{"$ref":"#/components/schemas/ErrorPageRevisionPage"}}},"description":"A page of revisions."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"cursor":{"summary":"Not a cursor","value":{"code":"invalid","errors":{"cursor":["cursor is the next_cursor of the page before."]},"field":"cursor","message":"cursor is the next_cursor of the page before.","reason":"invalid"}},"invalid":{"summary":"Not a page size","value":{"code":"invalid","errors":{"limit":["limit is a whole number from 1."]},"field":"limit","message":"limit is a whole number from 1.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`limit` is not a whole number from 1, or `cursor` is not the `next_cursor` of a page (`invalid`). A `limit` over 100 is read as 100."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 120 reads of error pages a minute you have across the API, the Control Panel and AI assistants. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"List a site's error page revisions","tags":["Error pages"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-read","limit":120,"minutes":1,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/error-pages/revisions/{revision}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of a revision of this site, from the list's `id`.","in":"path","name":"revision","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers one revision with its whole configuration and, for each page, its HTML before and after the revision and a unified diff.","operationId":"getSiteErrorPageRevision","responses":{"200":{"content":{"application/json":{"example":{"config":{"codes":{"404":"app","500":"page","502":"page","503":"page","504":"page"},"pages":{"404":{"message":null,"source":null},"500":{"message":null,"source":null},"502":{"message":null,"source":null},"503":{"message":null,"source":"<!DOCTYPE html><html><head><meta name=\"viewport\" content=\"width=device-width\"><title>Back soon</title></head><body><h1>Back soon</h1><p>{{message}}</p></body></html>"},"504":{"message":null,"source":null},"maintenance":{"message":null,"source":null}},"support_email":null},"pages":{"404":{"after":null,"before":null,"changed":false,"diff":null},"500":{"after":null,"before":null,"changed":false,"diff":null},"502":{"after":null,"before":null,"changed":false,"diff":null},"503":{"after":"<!DOCTYPE html><html><head><meta name=\"viewport\" content=\"width=device-width\"><title>Back soon</title></head><body><h1>Back soon</h1><p>{{message}}</p></body></html>","before":null,"changed":true,"diff":"--- revision 1\n+++ revision 2\n@@ -0,0 +1,1 @@\n+<!DOCTYPE html><html><head><meta name=\"viewport\" content=\"width=device-width\"><title>Back soon</title></head><body><h1>Back soon</h1><p>{{message}}</p></body></html>\n"},"504":{"after":null,"before":null,"changed":false,"diff":null},"maintenance":{"after":null,"before":null,"changed":false,"diff":null}},"revision":{"author":"Eleanor Finch","created_at":"2026-11-02T15:41:09Z","id":312,"live":true,"note":"Our own 503 page","number":2,"origin":"save","source_revision_id":null,"status":"applied","summary":"503 → platform page; 503 page edited"}},"schema":{"$ref":"#/components/schemas/ErrorPageRevisionDetail"}}},"description":"The revision and what it changed."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 120 reads of error pages a minute you have across the API, the Control Panel and AI assistants. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"Get one error page revision","tags":["Error pages"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-read","limit":120,"minutes":1,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/error-pages/test":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Runs a check against the site that changes none of its pages. `live` asks one of the site's own addresses for a path, as a visitor would, and answers the status, the main headers and who drew the answer; `render` answers which version of each page the site serves now (while maintenance is on, only the maintenance page). The first `render` on a site that has never been checked prepares the site instead, which takes a person who may change the site (anyone else is answered 404): the answer then has `preparing: true`, no pages and the `operation_id` of the preparation. Follow that id with the general operation endpoint (`GET /corestack/operations/{operation}`) until its `status` is `completed`, then send the request again. The error pages operation endpoint answers changes to the pages only, so it answers 404 for a preparation.","operationId":"testSiteErrorPages","requestBody":{"content":{"application/json":{"examples":{"live":{"summary":"Ask the site for its home page","value":{"kind":"live","path":"/"}},"render":{"summary":"Show which pages the site serves","value":{"kind":"render"}}},"schema":{"$ref":"#/components/schemas/ErrorPagesTest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"live":{"summary":"What the site answers now","value":{"body_head":"<!doctype html><html lang=\"en\"><head><title>Harbour & Finch</title>","bytes":5120,"checked_at":"2026-11-06T09:16:40Z","error":null,"headers":{"cache-control":null,"cf-cache-status":null,"content-type":"text/html; charset=UTF-8","retry-after":null,"server":"nginx"},"kind":"live","message":null,"refused":null,"status":200,"truncated":true,"url":"https://harbourandfinch.example.com/","who":"app"}},"refused":{"summary":"The site's address does not point at the site","value":{"body_head":null,"bytes":null,"checked_at":"2026-11-06T09:16:40Z","error":null,"headers":{"cache-control":null,"cf-cache-status":null,"content-type":null,"retry-after":null,"server":null},"kind":"live","message":"This address does not point at your site","refused":"not_your_site","status":null,"truncated":false,"url":"https://harbourandfinch.example.com/","who":null}},"render":{"summary":"Which pages the site serves","value":{"checked_at":"2026-11-06T09:16:40Z","kind":"render","maintenance_on":false,"operation_id":null,"pages":[{"error":null,"generation":"a41c09e2","html":"<!DOCTYPE html><html lang=\"en\"><head><title>Down for maintenance</title></head><body><h1>Down for maintenance</h1></body></html>","id":"maintenance","ok":true,"revision":0,"state":"ok"},{"error":"The site answered 200 for this page.","generation":null,"html":null,"id":"503","ok":false,"revision":null,"state":"error"}],"preparing":false}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ErrorPagesLiveTest"},{"$ref":"#/components/schemas/ErrorPagesRenderTest"}]}}},"description":"The check's result. `pages` is shortened here."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"operation_in_progress":{"summary":"The site cannot be prepared while another change runs","value":{"code":"operation_in_progress","message":"A change to this environment is in progress. Try again when it has finished.","reason":"operation_in_progress"}},"restore_running":{"summary":"A restore of the site is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The check cannot run now. `reason` says why: `managed_elsewhere`, or, for a `render` that has to prepare the site first, `operation_in_progress` (another change to the site has not finished) or `restore_running` (a restore of the site is running)."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not one of the two checks","value":{"code":"invalid","errors":{"kind":["kind is live or render."]},"field":"kind","message":"kind is live or render.","reason":"invalid"}},"path":{"summary":"A path with a fragment","value":{"code":"invalid","errors":{"path":["The path has no # fragment."]},"field":"path","message":"The path has no # fragment.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`): a `kind` that is neither check, or a `path` the check does not send."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the six tests a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"Test the error pages on the site","tags":["Error pages"],"x-effect":["none"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-test","limit":6,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/error-pages/validate":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Checks one page's HTML: what would be removed on a save, what would stop it, and warnings, each with its line and column. Leave `source` out to check the platform's page with your `message`. Nothing is saved.","operationId":"checkSiteErrorPage","requestBody":{"content":{"application/json":{"examples":{"check":{"summary":"Check your own 503 page","value":{"page":"503","source":"<!DOCTYPE html><html><head><meta name=\"viewport\" content=\"width=device-width\"><title>Back soon</title></head><body><h1>Back soon</h1><p>{{message}}</p></body></html>"}},"problem":{"summary":"A page with a script in it","value":{"page":"500","source":"<h1>{{status_code}}</h1><script>track()</script>"}}},"schema":{"$ref":"#/components/schemas/ErrorPageCheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"clean":{"summary":"Nothing to report","value":{"bytes":294,"diagnostics":[],"samples":{"host":"www.harbourandfinch.example.com","message":"This site is being updated. Please try again in a few minutes.","request_id":"4f2c9a1e7b3d4c5a8e6f0b1a2c3d4e5f","retry_after":"300","site_name":"harbourandfinch.example.com","status_code":"503","status_text":"Down for maintenance","support_email":"","time_utc":"2026-11-24T09:30:00+00:00"}}},"problems":{"summary":"Warnings","value":{"bytes":90,"diagnostics":[{"code":"no_doctype","column":1,"line":1,"message":"The page has no <!DOCTYPE html>: browsers render it in quirks mode.","page":"500","severity":"warning"},{"code":"no_title","column":1,"line":1,"message":"The page has no <title>.","page":"500","severity":"warning"}],"samples":{"host":"www.harbourandfinch.example.com","message":"Please try again in a moment.","request_id":"4f2c9a1e7b3d4c5a8e6f0b1a2c3d4e5f","retry_after":"","site_name":"harbourandfinch.example.com","status_code":"500","status_text":"Something went wrong","support_email":"","time_utc":"2026-11-24T09:30:00+00:00"}}}},"schema":{"$ref":"#/components/schemas/ErrorPageCheckResult"}}},"description":"What the check found. An empty `diagnostics` means the page can be saved as it is."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"413":{"content":{"application/json":{"examples":{"too_large":{"summary":"The page is too large","value":{"bytes":70112,"code":"too_large","max_bytes":65536,"message":"This page is larger than 64 KB.","page":"503","reason":"too_large"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`source` is over 64 KiB (`too_large`). `page` names the page; `bytes` and `max_bytes` say by how much."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not one of the pages","value":{"code":"invalid","errors":{"page":["page is one of maintenance, 404, 500, 502, 503, 504."]},"field":"page","message":"page is one of maintenance, 404, 500, 502, 503, 504.","reason":"invalid"}},"message_too_long":{"summary":"A message over 300 characters","value":{"code":"invalid","errors":{"message":["The 503 message is at most 300 characters."]},"field":"message","message":"The 503 message is at most 300 characters.","reason":"invalid"}},"sample_key":{"summary":"A tag that `sample` cannot set","value":{"code":"invalid","errors":{"sample.status_code":["sample takes host, request_id, time_utc and support_email."]},"field":"sample.status_code","message":"sample takes host, request_id, time_utc and support_email.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`): a `page` that is not one, a field that is not text, a `sample` key other than the four it takes (`field` is `sample.<key>`), a `message` over 300 characters or with a line break in it, or a `sample.support_email` that is not an address."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 120 checks and previews a minute you have across the API, the Control Panel and AI assistants. Wait for `Retry-After`, which `retry_after_seconds` repeats."}},"summary":"Check an error page without saving","tags":["Error pages"],"x-effect":["none"],"x-feature":"error-pages","x-file":"error-pages","x-gates":["error_pages"],"x-rate-limit":{"also":[{"bucket":"corecluster-error-pages-preview","limit":120,"minutes":1,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/external-db/disable":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Removes the environment's external users at once, stops the charge, and releases the fixed address: turning\naccess on again later gives a new address under the same host name. It needs a person who can change the\nsite's billing, and `confirm_environment`, the environment's name as the Control Panel shows it.\n","operationId":"disableSiteExternalDatabase","requestBody":{"content":{"application/json":{"examples":{"confirm":{"summary":"Turn access off for the Production environment","value":{"confirm_environment":"Production"}}},"schema":{"$ref":"#/components/schemas/DatabaseExternalDisable"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"operation":{"applied_at":"2026-11-03T09:16:40Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"External users deleted","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Deleting the external users","step":"users_dropped","steps":[{"key":"users_dropped","label":"External users deleted","state":"current"},{"key":"billing_ended","label":"Charge stopped","state":"todo"},{"key":"drained","label":"Outside access closed","state":"todo"},{"key":"service_gone","label":"Endpoint removed","state":"todo"},{"key":"dns_deleted","label":"Host name removed","state":"todo"},{"key":"address_released","label":"Fixed address released","state":"todo"},{"key":"off","label":"Off","state":"todo"}],"subject":null,"summary":"External database access turned off","to_version":null,"type":"external_db_change","type_label":"External database access"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"Access is being turned off. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DatabaseBillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"A change to external access is running","value":{"code":"busy","message":"A change to external access is already in progress on this environment.","reason":"busy"}},"external_db_already_off":{"summary":"Access is already off","value":{"code":"external_db_already_off","message":"External access is already off for this environment.","reason":"external_db_already_off"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Access cannot be turned off now. `reason` says why: `external_db_already_off`, `external_db_failed` (the\nlast change did not finish: contact support), `busy`, `deleted`, `provisioning`, `removed` or\n`managed_elsewhere`.\n"},"422":{"content":{"application/json":{"examples":{"confirmation_missing":{"summary":"The confirmation was not sent","value":{"code":"invalid","errors":{"confirm_environment":["Type Production to confirm."]},"field":"confirm_environment","message":"Type Production to confirm.","reason":"invalid"}},"confirmation_wrong":{"summary":"Another name was typed","value":{"code":"confirm_mismatch","errors":{"confirm_environment":["Type Production to confirm."]},"field":"confirm_environment","message":"Type Production to confirm.","reason":"confirm_mismatch"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"}]}}},"description":"`confirm_environment` is typed and is not the environment's name (`confirm_mismatch`), or is missing or\nempty (`invalid`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Turn external database access off","tags":["Database"],"x-effect":["deletes","changes-settings"],"x-feature":"database","x-file":"database","x-gates":["database_tab","external_db"],"x-long-running":"getSiteDatabaseOperation","x-rate-limit":{"bucket":"reseller-database","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/external-db/enable":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Gives the environment a fixed public address and a host name that only the addresses you list can reach, as a\npaid add-on charged monthly from when access is on. It needs a person who can change the site's billing, and\n`confirm_cost: true` once the charge in `external.price` of the database details is agreed. The first turn-on\nis applied in the environment's nightly maintenance window and answers `operation: null`; later ones start at\nonce.\n","operationId":"enableSiteExternalDatabase","requestBody":{"content":{"application/json":{"examples":{"first_time":{"summary":"Turn access on for one address block","value":{"confirm_cost":true,"sources":[{"cidr":"198.51.100.64/29","label":"Order system"}]}}},"schema":{"$ref":"#/components/schemas/DatabaseExternalEnable"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"queued_for_the_window":{"summary":"The first turn-on, queued for the maintenance window","value":{"external":{"address":null,"available":true,"database":"application","enabled_at":null,"enabled_by":null,"host":null,"moved_at":null,"operation":null,"port":3306,"price":{"amount":"15.00","billed_on":"corestack","currency":"GBP","label":"Dedicated IP address","period":"month"},"sanitised":false,"sources":[{"added_at":null,"added_by":null,"cidr":"198.51.100.64/29","label":"Order system","pending":true}],"sources_cap":10,"status":"tonight","tls":"optional","window_date":"2026-11-04"},"operation":null}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/DatabaseExternalQueued"},{"$ref":"#/components/schemas/OperationStarted"}]}}},"description":"Access is being turned on (`operation` to follow), or, the first time, is queued for the maintenance\nwindow (`operation: null`, with `external` as it now reads).\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/DatabaseBillingForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"A change to external access is running","value":{"code":"busy","message":"A change to external access is already in progress on this environment.","reason":"busy"}},"change_pending":{"summary":"Another change is already queued for the maintenance window","value":{"code":"change_pending","message":"A change is already queued for tonight. Apply it now or cancel it first","reason":"change_pending"}},"demo_keep_required":{"summary":"The site is a demo that has not been kept","value":{"change":{"label":"A dedicated database address","monthly":null},"code":"demo_keep_required","keep_url":"https://manage.corefinity.com/billing/keep?demo=3310&plan=dbip","message":"Keep your site to add to it.","reason":"demo_keep_required"}},"external_db_already_on":{"summary":"Access is already on","value":{"code":"external_db_already_on","message":"External access is already on for this environment.","reason":"external_db_already_on"}},"external_db_failed":{"summary":"The last change did not finish","value":{"code":"external_db_failed","message":"External access could not be turned on. Contact support so we can finish or undo it.","reason":"external_db_failed"}},"restart_batches_off":{"summary":"Queuing for the maintenance window is not available","value":{"code":"restart_batches_off","message":"Changes cannot be scheduled for tonight yet. Apply the change now instead.","reason":"restart_batches_off"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Access cannot be turned on now. `reason` says why: `external_db_already_on`, `external_db_failed` (the\nlast change did not finish: contact support), `busy` (a change to external access or to the site is\nrunning), `external_db_price_changed`, `deleted`, `provisioning`, `removed` or `managed_elsewhere`.\nA first turn-on, which waits for the maintenance window, is also refused while another change is\nalready queued for that window (`change_pending`) or while queuing for the window is not available\n(`restart_batches_off`). On a site that is a demo, `demo_keep_required` answers with `keep_url` and the\n`change`: keep the site first.\n"},"422":{"content":{"application/json":{"examples":{"charge_not_confirmed":{"summary":"The charge was not confirmed","value":{"code":"invalid","errors":{"confirm_cost":["Confirm the monthly charge to turn external access on."]},"field":"confirm_cost","message":"Confirm the monthly charge to turn external access on.","reason":"invalid"}},"external_db_not_available":{"summary":"Access is not available on this environment yet","value":{"code":"external_db_not_available","message":"External access isn't available on this environment yet. Ask Corefinity support.","reason":"external_db_not_available"}},"no_address":{"summary":"No address was sent","value":{"code":"invalid","errors":{"sources":["Access stays on only while at least one address can use it. Add the new address first, or turn external access off."]},"field":"sources","message":"Access stays on only while at least one address can use it. Add the new address first, or turn external access off.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`): `confirm_cost` is not `true`, or an\naddress is refused. Or access is not available on this environment yet (`external_db_not_available`), or\nthe add-on has no published price in your contract's currency (`currency_unpublished`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"example":{"code":"upstream_unavailable","message":"The environment's settings could not be read. Try again in a moment.","reason":"upstream_unavailable"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The environment's settings could not be read (`upstream_unavailable`). Nothing was changed; try again."}},"summary":"Turn external database access on","tags":["Database"],"x-effect":["billable","changes-settings"],"x-feature":"database","x-file":"database","x-gates":["database_tab","external_db"],"x-long-running":"getSiteDatabaseOperation","x-rate-limit":{"bucket":"reseller-database","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/external-db/sources":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"Replaces the list of addresses that may reach the database from outside: send every address to keep, at least\none and at most 10, while access is on. New labels alone are saved at once and answer `200` with\n`operation: null`; a changed list answers `202` and applies in about a minute. The documentation ranges the\nexamples here use are refused: send your own systems' public addresses.\n","operationId":"replaceSiteExternalDatabaseSources","requestBody":{"content":{"application/json":{"examples":{"add_an_address":{"summary":"Keep both addresses and add a third","value":{"sources":[{"cidr":"198.51.100.64/29","label":"Order system"},{"cidr":"192.0.2.15/32","label":"Reporting"},{"cidr":"203.0.113.20/32","label":"Warehouse"}]}},"rename":{"summary":"Keep both addresses and give one a new label","value":{"sources":[{"cidr":"198.51.100.64/29","label":"Order system (London)"},{"cidr":"192.0.2.15/32","label":"Reporting"}]}}},"schema":{"$ref":"#/components/schemas/DatabaseExternalSources"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"operation":null,"sources":[{"added_at":"2026-11-02T15:41:09+00:00","added_by":"Daniel Reyes","cidr":"192.0.2.15/32","label":"Reporting","pending":false},{"added_at":"2026-11-02T15:41:09+00:00","added_by":"Daniel Reyes","cidr":"198.51.100.64/29","label":"Order system (London)","pending":false}]},"schema":{"$ref":"#/components/schemas/DatabaseSourcesSaved"}}},"description":"Only labels changed. They are saved, nothing was started and `operation` is null."},"202":{"content":{"application/json":{"example":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-03T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5122,"install":null,"label":"Saved","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Saving the change","step":"saved","steps":[{"key":"saved","label":"Saved","state":"current"},{"key":"applied","label":"Picked up by the platform","state":"todo"},{"key":"live","label":"Allowed addresses live","state":"todo"}],"subject":null,"summary":"Allowed addresses changed (3 on the list)","to_version":null,"type":"external_db_change","type_label":"External database access"}},"schema":{"$ref":"#/components/schemas/OperationStarted"}}},"description":"The list changed and is being applied. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"A change to external access is running","value":{"code":"busy","message":"A change to external access is already in progress on this environment.","reason":"busy"}},"external_db_not_on":{"summary":"Access is not on","value":{"code":"external_db_not_on","message":"Turn external access on first.","reason":"external_db_not_on"}},"external_db_unchanged":{"summary":"The list is already exactly this","value":{"code":"external_db_unchanged","message":"The allowed addresses are already exactly these.","reason":"external_db_unchanged"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The list cannot be changed now. `reason` says why: `external_db_not_on` (turn access on first),\n`external_db_unchanged` (the list is already exactly this), `busy`, `deleted`, `provisioning`, `removed`\nor `managed_elsewhere`.\n"},"422":{"content":{"application/json":{"examples":{"documentation_range":{"summary":"Addresses from the ranges kept for documentation, as these examples use","value":{"code":"invalid","errors":{"sources.0.cidr":["198.51.100.64/29 is a documentation range. Use a public IPv4 address, or a block from /32 to /28."],"sources.1.cidr":["203.0.113.20/32 is a documentation address. Use a public IPv4 address, or a block from /32 to /28."]},"field":"sources.0.cidr","message":"198.51.100.64/29 is a documentation range. Use a public IPv4 address, or a block from /32 to /28. (and 1 more error)","reason":"invalid"}},"last_address":{"summary":"An empty list while access is on","value":{"code":"invalid","errors":{"sources":["Access stays on only while at least one address can use it. Add the new address first, or turn external access off."]},"field":"sources","message":"Access stays on only while at least one address can use it. Add the new address first, or turn external access off.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The list or one of its addresses is refused (`invalid`). `errors` names each one by its position, such as\n`sources.0.cidr`, and `field` the first.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Replace the allowed addresses","tags":["Database"],"x-effect":["changes-settings","overwrites"],"x-feature":"database","x-file":"database","x-gates":["database_tab","external_db"],"x-long-running":"getSiteDatabaseOperation","x-rate-limit":{"bucket":"reseller-database","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/functions":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the tools the site's platform offers, such as clearing a cache, with whether each can run now and the inputs it takes.","operationId":"listSiteFunctions","responses":{"200":{"content":{"application/json":{"example":{"functions":[{"availability":{"available":true,"reason":null},"confirm":false,"description":"Clears the WordPress object cache. Pages rebuild their cache on the next visit.","effect":"none","group":"cache","group_label":"Cache","inputs":[],"key":"flush_cache","label":"Flush cache","last":{"blocked_until_verified":false,"finished_at":"2026-11-19T09:30:01Z","id":5120,"kind":"flush_cache","label":"Flush cache","requested_by":{"id":2012,"name":"Daniel Reyes"},"status":"succeeded","status_label":"Done"},"limits":{"per_hour":null},"sync":false},{"availability":{"available":true,"reason":null},"confirm":false,"description":"Clears PHP's compiled-code cache with a graceful PHP reload. Requests in progress finish first.","effect":"none","group":"cache","group_label":"Cache","inputs":[],"key":"reset_opcache","label":"Reset OPcache","last":null,"limits":{"per_hour":null},"sync":false}],"groups":[{"key":"cache","label":"Cache"}],"maintenance":{"by":null,"bypass_corefinity":1,"bypass_ips":[],"command":null,"enabled":false,"page":"default","retry_after_seconds":300,"since":null},"platform":"wordpress","running":null},"schema":{"$ref":"#/components/schemas/SiteFunctionList"}}},"description":"The tools."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrManagedClusters"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"deleted":{"value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"provisioning":{"value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is deleted and waiting to be purged (`deleted`), or still being created (`provisioning`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's platform tools","tags":["Platform tools"],"x-feature":"functions","x-file":"app-versions","x-gates":["app_versions_api","functions"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/corestack/sites/{site}/functions/{function}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The `key` of a tool from the site's list. Lower-case letters, digits and `_`.","example":"flush_cache","in":"path","name":"function","required":true,"schema":{"pattern":"^[a-z0-9_]+$","type":"string"}}],"post":{"description":"Runs one of the site's tools with its inputs in the body, and `\"confirm\": true` where the tool asks for it.\nA run that has finished answers `200`; one that is queued or running answers `202`, to follow with the command endpoint.","operationId":"startSiteFunction","requestBody":{"content":{"application/json":{"examples":{"flush_cache":{"summary":"A tool with no inputs","value":{}}},"schema":{"additionalProperties":true,"description":"The tool's inputs, as the list names them.","properties":{"confirm":{"description":"True, for a tool that asks for confirmation.","type":"boolean"}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"command":{"blocked_until_verified":false,"duration_ms":840,"error":null,"exit_code":0,"finished_at":"2026-11-19T09:30:01Z","id":5120,"input":null,"kind":"flush_cache","label":"Flush cache","operation_id":null,"output_excerpt":"Success: The cache was flushed.\n","queued_at":"2026-11-19T09:30:00Z","requested_by":{"id":2012,"name":"Daniel Reyes"},"result":{"flushed":true},"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"started_at":"2026-11-19T09:30:00Z","status":"succeeded","status_label":"Done"}},"schema":{"$ref":"#/components/schemas/SiteFunctionRun"}}},"description":"The run has finished. A tool that creates a password answers it once in `secret`, with `Cache-Control: no-store`."},"202":{"content":{"application/json":{"example":{"command":{"blocked_until_verified":false,"duration_ms":null,"error":null,"exit_code":null,"finished_at":null,"id":5120,"input":null,"kind":"flush_cache","label":"Flush cache","operation_id":null,"output_excerpt":null,"queued_at":"2026-11-19T09:30:00Z","requested_by":{"id":2012,"name":"Daniel Reyes"},"result":null,"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"started_at":null,"status":"queued","status_label":"Queued"}},"schema":{"$ref":"#/components/schemas/SiteFunctionRun"}}},"description":"The run is queued or running. Follow `command.id`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change to the site is in progress","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"command_running":{"summary":"Another tool or command is still running","value":{"code":"command_running","message":"Another action is still running on this site. Wait for it to finish.","reason":"command_running"}},"deleted":{"value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"deployment_running":{"value":{"code":"deployment_running","message":"A deployment is running. Wait for it to finish.","reason":"deployment_running"}},"exec_unresolved":{"summary":"An earlier command was never confirmed stopped; waiting does not clear it","value":{"code":"exec_unresolved","message":"A previous command on this site has not been confirmed stopped. Contact support.","reason":"exec_unresolved"}},"install_running":{"value":{"code":"install_running","message":"An installer is still running on this site. Contact support.","reason":"install_running"}},"not_running":{"value":{"code":"not_running","message":"The site is not running normally. Try again once it has recovered.","reason":"not_running"}},"provisioning":{"value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}},"removed":{"value":{"code":"removed","message":"This site has been removed","reason":"removed"}},"restore_running":{"value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site cannot run this now, and nothing was run. `reason` says why.\nThe site's state: `deleted`, `provisioning`, `removed`, `wrong_platform` (the tool is not one of this\nsite's platform), `not_running`, `managed_elsewhere`, or `site_unadopted` (the site cannot be changed\nfrom the Control Panel yet; contact support).\nSomething else is running, so wait for it and try again: `busy` (another change), `command_running`\n(another tool or command), `deployment_running`, `restore_running`, or, for a tool that stops the\nsite's processes, `snapshot_running`.\nA command whose end was never confirmed: `exec_unresolved` and `install_running`. Waiting does not clear\nthese; contact support.\n"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"confirm":["Confirm the action"]},"field":"confirm","message":"Confirm the action","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The tool does not exist, an input is missing or wrong, or the tool asks for `\"confirm\": true`."},"429":{"content":{"application/json":{"example":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many runs: more than 20 a minute, or the hourly limit of this tool on this site. Wait for `Retry-After` seconds."},"503":{"$ref":"#/components/responses/CommandsSwitchedOff"}},"summary":"Start a platform tool","tags":["Platform tools"],"x-effect":["runs-code"],"x-feature":"functions","x-file":"app-versions","x-gates":["app_versions_api","functions"],"x-long-running":"getCommand","x-rate-limit":{"bucket":"reseller-functions","limit":20,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/http-auth":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the rules that ask visitors for a login, their users and the `version` every save sends back.\nA password is never part of this answer.\n","operationId":"getSiteHttpAuth","responses":{"200":{"content":{"application/json":{"example":{"apply":{"applied_at":"2026-11-06T15:01:10Z","detail":{"credentials":"verified"},"error":null,"operation":null,"state":"applied","state_label":"Applied"},"bypass_corefinity":1,"bypass_ips":[],"default_for_role":true,"enabled":true,"limits":{"prefix_max":200,"rules_max":20,"users_per_rule_max":10},"note":"Passwords are stored encrypted and shown only when you reveal them; every reveal is recorded.","rules":[{"enabled":true,"id":51,"path_prefix":null,"sort":0,"users":[{"created_at":"2026-11-04T10:00:00Z","id":71,"password_set":true,"revealed_at":"2026-11-05T11:00:00Z","username":"client"}]},{"enabled":true,"id":52,"path_prefix":"/wp-admin/","sort":1,"users":[{"created_at":"2026-11-04T10:00:00Z","id":72,"password_set":true,"revealed_at":null,"username":"editor"}]}],"version":4},"schema":{"$ref":"#/components/schemas/HttpAuthSet"}}},"description":"The HTTP authentication set."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's HTTP authentication","tags":["Password protection"],"x-feature":"http-auth","x-file":"redirects","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Replaces the whole set of rules and users, so start from the last read and keep the `id` of every rule and\nuser you want to keep. The passwords this save set or generated are answered once, in `credentials`.\n","operationId":"replaceSiteHttpAuth","requestBody":{"content":{"application/json":{"examples":{"protect_a_path":{"summary":"Protect one path with a password you typed","value":{"enabled":false,"rules":[{"enabled":true,"path_prefix":"/wp-admin/","users":[{"password":"Example-editor-2026","username":"editor"}]}],"version":0}},"protect_everything_with_a_generated_password":{"summary":"Protect the whole environment with a generated password (also needs the exec scope)","value":{"enabled":true,"rules":[{"enabled":true,"path_prefix":null,"users":[{"generate":true,"username":"client"}]}],"version":0}}},"schema":{"$ref":"#/components/schemas/HttpAuthUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"credentials":[],"http_auth":{"apply":{"applied_at":null,"error":null,"operation":null,"state":"applied","state_label":"Applied"},"bypass_corefinity":1,"bypass_ips":[],"default_for_role":false,"enabled":false,"limits":{"prefix_max":200,"rules_max":20,"users_per_rule_max":10},"note":"Passwords are stored encrypted and shown only when you reveal them; every reveal is recorded.","rules":[],"version":0},"operation":null},"schema":{"$ref":"#/components/schemas/HttpAuthSaveResult"}}},"description":"The set sent is the set the site already has. Nothing was started."},"201":{"content":{"application/json":{"example":{"credentials":[{"password":"Example-editor-2026","revealed_at":"2026-11-06T15:00:00Z","rule_id":52,"user_id":74,"username":"editor"}],"http_auth":{"apply":{"applied_at":null,"detail":{"credentials":"pending"},"error":null,"operation":{"id":431,"scope":"site","status":"executing","status_label":"Applying","summary":"HTTP authentication: 1 rule, 1 user","to_version":null,"type":"http_auth_change","type_label":"HTTP authentication"},"state":"applying","state_label":"Applying"},"bypass_corefinity":1,"bypass_ips":[],"default_for_role":false,"enabled":false,"limits":{"prefix_max":200,"rules_max":20,"users_per_rule_max":10},"note":"Passwords are stored encrypted and shown only when you reveal them; every reveal is recorded.","rules":[{"enabled":true,"id":52,"path_prefix":"/wp-admin/","sort":0,"users":[{"created_at":"2026-11-06T15:00:00Z","id":74,"password_set":true,"revealed_at":null,"username":"editor"}]}],"version":1},"operation":{"completed_at":null,"created_at":"2026-11-06T15:00:00Z","error":null,"id":431,"scope":"site","status":"executing","status_label":"Applying","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"credentials","label":"Password live","state":"current"}],"type":"http_auth_change","type_label":"HTTP authentication"}},"schema":{"$ref":"#/components/schemas/HttpAuthSaveResult"}}},"description":"The set was saved and is being applied. Follow `operation.id` until it completes. `credentials` lists the\npasswords this save set or generated; the answer is sent with `Cache-Control: no-store, private`.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The site does not exist or is not yours to change, a rule or user `id` in the body is not one of this site's, or HTTP authentication saves are not on for your company (`feature_off`)."},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"cluster_paused":{"summary":"Changes are paused for planned maintenance","value":{"code":"cluster_paused","message":"Changes on this site are paused for planned maintenance; please try again later.","reason":"cluster_paused"}},"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"legacy_adopt_pending":{"summary":"HTTP authentication is being prepared for this site","value":{"code":"legacy_adopt_pending","message":"HTTP authentication is not available on this site yet. It is being prepared.","reason":"legacy_adopt_pending"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"stale":{"summary":"The set changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The save was refused because of the site's state. `reason` says why: `stale`, `busy`, `cluster_paused`\n(Corefinity has paused changes for planned maintenance: the message says until when, if that is known),\n`deleted`, `provisioning`, `removed`, `legacy_adopt_pending`, `legacy_domain_attached` or\n`managed_elsewhere`.\n"},"422":{"content":{"application/json":{"examples":{"no_user":{"summary":"The whole-environment rule has no user","value":{"code":"invalid","errors":{"enabled":["Add at least one user for the whole-environment rule"]},"field":"enabled","message":"Add at least one user for the whole-environment rule","reason":"invalid"}},"password":{"summary":"A password that is too short, too long or has no letter or no digit","value":{"code":"invalid","errors":{"rules.0.users.0.password":["Use at least 12 characters including a letter and a digit"]},"field":"rules.0.users.0.password","message":"Use at least 12 characters including a letter and a digit","reason":"invalid"}},"username":{"summary":"A username that does not start and end with a letter or digit","value":{"code":"invalid","errors":{"rules.0.users.0.username":["3–32 characters: letters, digits, dots, dashes and underscores"]},"field":"rules.0.users.0.username","message":"3–32 characters: letters, digits, dots, dashes and underscores","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing, wrong or not one the save takes. Rules and users are named by position, such as `rules.0.users.1.username`."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"no_answer":{"summary":"The platform did not answer","value":{"message":"The platform returned an error (HTTP 503). Try again shortly."}},"not_changeable":{"summary":"The site's files cannot be written from the Control Panel","value":{"message":"The site's directory is not one the panel may change."}},"not_saved":{"summary":"The platform did not save the change","value":{"message":"The change could not be saved. Contact support."}}},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The platform gave no answer while the save read the site's files, the platform did not save the change, or the Control Panel may not write this site's files. Nothing was changed. When the platform is at fault, try again shortly. The answer is a sentence only, with no `reason`."}},"summary":"Replace a site's HTTP authentication","tags":["Password protection"],"x-effect":["changes-settings","overwrites","reveals-secret"],"x-feature":"http-auth","x-file":"redirects","x-gates":["http_auth"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-http-auth","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"A user in the body asks for a generated password (`generate` is true)"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/http-auth/users/{user}/reveal":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of an HTTP authentication user of this site, from the read. Digits only.","example":71,"in":"path","name":"user","required":true,"schema":{"minimum":1,"type":"integer"}}],"post":{"description":"Answers one user's current password to the token's own person. Every reveal is recorded with who revealed it\nand when, and the answer is never cached.\n","operationId":"revealSiteHttpAuthPassword","responses":{"200":{"content":{"application/json":{"example":{"password":"Example-client-2026","revealed_at":"2026-11-06T15:05:00Z","rule_id":51,"user_id":71,"username":"client"},"schema":{"$ref":"#/components/schemas/HttpAuthCredential"}}},"description":"The user's password, sent with `Cache-Control: no-store, private`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"legacy_hash":{"summary":"The password cannot be shown","value":{"code":"legacy_hash","message":"Carried from the previous environment as a legacy password hash: it signs in as before, but its password cannot be shown. Set a new password for it.","reason":"legacy_hash"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The user was carried over as a password hash, so there is no password to show (`legacy_hash`; set a new password for it), or another control panel manages the site (`managed_elsewhere`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"example":{"message":"This password cannot be shown. Contact support."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The stored password could not be read. Contact support."}},"summary":"Reveal an HTTP authentication password","tags":["Password protection"],"x-effect":["reveals-secret"],"x-feature":"http-auth","x-file":"redirects","x-gates":[],"x-rate-limit":{"bucket":"reseller-http-auth-reveal","limit":10,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/laravel/queues":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the jobs waiting in each queue of a Laravel site, and which queues a worker listens on. The figures\nare read on the site without running the application's code, and an answer is kept for up to a minute:\n`checked_at` says when it was read. Try-it is off because the read runs a command on the site.\n","operationId":"getSiteLaravelQueues","responses":{"200":{"content":{"application/json":{"example":{"checked_at":"2026-11-03T09:14:03Z","config_source":"cache","connection":"database","driver":"database","failed":0,"listening":{"queues":["default"],"source":"default"},"queues":[{"delayed":0,"listened":false,"name":"webhooks","name_supported":true,"oldest_ready_at":"2026-11-03T09:00:00Z","ready":40,"reserved":0,"unworked":true,"waiting_seconds":843},{"delayed":0,"listened":true,"name":"default","name_supported":true,"oldest_ready_at":"2026-11-03T09:13:20Z","ready":1,"reserved":0,"unworked":false,"waiting_seconds":43}],"reason":null,"state":"ok","truncated":false,"unreadable_names":0,"unworked":["webhooks"]},"schema":{"$ref":"#/components/schemas/LaravelQueues"}}},"description":"The site's queues, largest first."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The feature is not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_found":{"summary":"No such site, or not one you can see","value":{"message":"Not found."}},"wrong_platform":{"summary":"The site is not a Laravel site","value":{"code":"wrong_platform","message":"This is not a Laravel site.","reason":"wrong_platform"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The id does not exist or is a site you cannot see, the feature is not on for your company (`feature_off`),\nor the site is not a Laravel site (`wrong_platform`).\n"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another command is running","value":{"code":"busy","message":"Another command is running on this site. Try again in a moment.","reason":"busy"}},"busy_change":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"command_running":{"summary":"Another action is running on the site","value":{"code":"command_running","message":"Another action is still running on this site. Wait for it to finish.","reason":"command_running"}},"deployment_running":{"summary":"A deployment is running","value":{"code":"deployment_running","message":"A deployment is running. Wait for it to finish.","reason":"deployment_running"}},"exec_unresolved":{"summary":"An earlier command has not been confirmed stopped","value":{"code":"exec_unresolved","message":"A previous command on this site has not been confirmed stopped. Contact support.","reason":"exec_unresolved"}},"install_running":{"summary":"An installer is still running on the site","value":{"code":"install_running","message":"An installer is still running on this site. Contact support.","reason":"install_running"}},"not_running":{"summary":"The site is not running","value":{"code":"not_running","message":"The site is not running","reason":"not_running"}},"removed":{"summary":"The site has been removed","value":{"code":"removed","message":"This site has been removed","reason":"removed"}},"restore_running":{"summary":"A restore of the site is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"site_unadopted":{"summary":"The site cannot be changed from the Control Panel yet","value":{"code":"site_unadopted","message":"This site is not ready to be changed from the Control Panel yet. Contact support.","reason":"site_unadopted"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The read runs a command on the site, and the site cannot take one now. `reason` says why: `not_running`;\n`busy` (another command or change is running on it); `command_running`, `restore_running`,\n`deployment_running` or `install_running` (other work is running on the site); `exec_unresolved` (an\nearlier command has not been confirmed stopped: contact support); `removed`; or `site_unadopted`. An\nanswer kept from the last minute is given without asking the site, so none of these is answered then.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"example":{"code":"helper_failed","helper":"database","message":"The site's database did not answer, so its queues could not be read. Try again in a moment.","reason":"helper_failed"},"schema":{"$ref":"#/components/schemas/LaravelQueuesFailedRefusal"}}},"description":"The queues could not be read (`helper_failed`). `helper` says what failed: `database` or `redis` (the\nsite's queue store did not answer), `exec` (the read did not run) or `output` (its answer could not be\nused).\n"},"503":{"$ref":"#/components/responses/SiteCommandUnavailable"}},"summary":"Get a Laravel site's queues","tags":["Laravel queues"],"x-feature":"laravel","x-file":"laravel-queues","x-gates":["platforms_laravel"],"x-rate-limit":{"bucket":"corecluster-laravel","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/live":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Reads the site's status from its cluster, then answers the site as `getSite` does. The cluster is read at most\nonce every 15 seconds for each site, whoever asks; inside that time the answer is the status already stored.\n","operationId":"refreshSiteLiveStatus","responses":{"200":{"content":{"application/json":{"examples":{"site":{"$ref":"#/components/examples/SiteDetailExample"}},"schema":{"$ref":"#/components/schemas/SiteAnswer"}}},"description":"The site, with the status now read."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"example":{"message":"Live status is temporarily unavailable."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The site's live status could not be read. The last known status stays."}},"summary":"Refresh a site's live status","tags":["Sites"],"x-effect":["none"],"x-feature":"sites","x-file":"sites","x-gates":[],"x-rate-limit":{"bucket":"reseller-live","limit":20,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/logs/context":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers one line with the lines before and after it in the same stream, each list oldest first. Name the\nline as `<stream_id>,<time>`, both taken from a line a search answered.\n","operationId":"getSiteLogContext","parameters":[{"$ref":"#/components/parameters/logsLine"},{"$ref":"#/components/parameters/logsBefore"},{"$ref":"#/components/parameters/logsAfter"},{"$ref":"#/components/parameters/logsEnvironmentId"},{"$ref":"#/components/parameters/logsScope"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/SiteLogsContextExample"}},"schema":{"$ref":"#/components/schemas/LogsContext"}}},"description":"The line and its neighbours."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/LogsLineNotFound"},"409":{"$ref":"#/components/responses/LogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"Get lines around a site's log line","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/logs/exports":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Starts a file of the site's matching lines, up to 50,000 lines or 64 MiB, and answers the export with its\n`capability`, which is shown only once. Read the export with `GET /corestack/logs/exports/{download}` until\n`state` is `ready`, then collect the file once, within 24 hours.\n","operationId":"startSiteLogsExport","requestBody":{"content":{"application/json":{"examples":{"csv":{"summary":"The last day's web access lines as CSV","value":{"format":"csv","range":"24h","source":"web-access"}},"json":{"summary":"Server errors as JSON lines","value":{"format":"json","query":"status:>=500","range":"1h","source":"web-access"}}},"schema":{"$ref":"#/components/schemas/LogsExportRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsExportStartedExample"}},"schema":{"$ref":"#/components/schemas/LogsExportStarted"}}},"description":"The export, which is being prepared, and its one-time capability."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/LogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"Start an export of a site's logs","tags":["Logs"],"x-effect":["none"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-long-running":"getLogsExport","x-rate-limit":{"bucket":"corecluster-logs-download","limit":5,"minutes":10},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/logs/facets":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the ten most frequent values of each field the matching lines carry. Takes the same source, query,\nfilters and time as a search.\n","operationId":"getSiteLogFacets","parameters":[{"$ref":"#/components/parameters/logsEnvironmentId"},{"$ref":"#/components/parameters/logsScope"},{"$ref":"#/components/parameters/logsSourceExample"},{"$ref":"#/components/parameters/logsQuery"},{"$ref":"#/components/parameters/logsFiltersEncoded"},{"$ref":"#/components/parameters/logsRange"},{"$ref":"#/components/parameters/logsFrom"},{"$ref":"#/components/parameters/logsTo"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsFacetsExample"}},"schema":{"$ref":"#/components/schemas/LogsFacetsResult"}}},"description":"The facets."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/LogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"Get the facets of a site's logs","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/logs/fields":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the fields the lines of a source carry in the time range (the last 24 hours when left out), each with\nits type and its five most frequent values. The answer is kept for a minute.\n","operationId":"listSiteLogFields","parameters":[{"$ref":"#/components/parameters/logsEnvironmentId"},{"$ref":"#/components/parameters/logsScope"},{"$ref":"#/components/parameters/logsSourceExample"},{"$ref":"#/components/parameters/logsRange"},{"$ref":"#/components/parameters/logsFrom"},{"$ref":"#/components/parameters/logsTo"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsFieldsExample"}},"schema":{"$ref":"#/components/schemas/LogsFields"}}},"description":"The fields."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/LogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"List a site's log fields","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/logs/fields/{field}/values":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/logsField"}],"get":{"description":"Answers up to 50 values of one field with how many lines carry each, most frequent first. The time range\ndefaults to the last 24 hours.\n","operationId":"listSiteLogFieldValues","parameters":[{"$ref":"#/components/parameters/logsEnvironmentId"},{"$ref":"#/components/parameters/logsScope"},{"$ref":"#/components/parameters/logsSourceExample"},{"$ref":"#/components/parameters/logsPrefix"},{"$ref":"#/components/parameters/logsRange"},{"$ref":"#/components/parameters/logsFrom"},{"$ref":"#/components/parameters/logsTo"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsFieldValuesExample"}},"schema":{"$ref":"#/components/schemas/LogsFieldValues"}}},"description":"The values and their counts."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/LogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"List a site's log field values","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/logs/histogram":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers how many matching lines each slice of the time range holds, split by level, for the same source,\nquery, filters and time as a search. A query that cannot be counted over time answers no buckets and a\nwarning.\n","operationId":"getSiteLogHistogram","parameters":[{"$ref":"#/components/parameters/logsEnvironmentId"},{"$ref":"#/components/parameters/logsScope"},{"$ref":"#/components/parameters/logsSourceExample"},{"$ref":"#/components/parameters/logsQuery"},{"$ref":"#/components/parameters/logsFiltersEncoded"},{"$ref":"#/components/parameters/logsBuckets"},{"$ref":"#/components/parameters/logsRange"},{"$ref":"#/components/parameters/logsFrom"},{"$ref":"#/components/parameters/logsTo"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/LogsHistogramExample"}},"schema":{"$ref":"#/components/schemas/LogsHistogram"}}},"description":"The buckets."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/LogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"Get a histogram of a site's logs","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/logs/query":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Answers the lines of the site that match, newest first; a query that ends in an aggregating pipe, such as\n`| stats count()`, answers `kind` `table` with `table` instead of `lines`. Paged by cursor: send `next_cursor`\nback as `cursor`; null means the last page.\n","operationId":"querySiteLogs","requestBody":{"content":{"application/json":{"examples":{"errors":{"summary":"Server errors in the last hour","value":{"limit":200,"query":"status:>=500","range":"1h","source":"web-access"}},"filters":{"summary":"Filters instead of a query","value":{"filters":{"method":["GET"],"path":{"mode":"prefix","value":"/checkout"},"status":["5xx"]},"limit":50,"range":"24h","source":"web-access"}},"whole_site":{"summary":"Every environment of the website","value":{"range":"1h","scope":"site"}},"window":{"summary":"An exact window, with facets","value":{"facets":["status","level"],"from":"2026-11-03T09:00:00Z","source":"all","to":"2026-11-03T10:00:00Z"}}},"schema":{"$ref":"#/components/schemas/LogsQueryRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/SiteLogsQueryExample"}},"schema":{"$ref":"#/components/schemas/LogsQueryResult"}}},"description":"A page of lines, or a table."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/LogsReadConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"Search a site's logs","tags":["Logs"],"x-effect":["none"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"corecluster-logs-query","limit":150,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/logs/saved-queries":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers your saved queries for this site, then the ones you keep for every site, then any that Corefinity\nsupport shared on this site.\n","operationId":"listSiteLogSavedQueries","responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/SiteLogsSavedQueryListExample"}},"schema":{"$ref":"#/components/schemas/LogsSavedQueryList"}}},"description":"The saved queries."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List saved log queries for a site","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"Saves a query, filters or neither with a source and a time range: for this site when `site_id` is sent, for\nevery site otherwise. You can keep 50 saved queries.\n","operationId":"createSiteLogSavedQuery","requestBody":{"content":{"application/json":{"examples":{"filters":{"summary":"Filters, kept for every site","value":{"filters":{"level":["warning","error"]},"name":"PHP warnings","range":"7d","source":"php"}},"pinned":{"summary":"A query for this site","value":{"name":"Checkout errors","query":"status:>=500","range":"24h","site_id":1042,"source":"web-access"}}},"schema":{"$ref":"#/components/schemas/LogsSavedQueryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/SiteLogsSavedQueryExample"}},"schema":{"$ref":"#/components/schemas/LogsSavedQuery"}}},"description":"The saved query."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a site's saved log query","tags":["Logs"],"x-effect":["changes-settings"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"corecluster-logs-saved","limit":30,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/logs/streams":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the log sources of the environment, whether each one is collected, the limits of a read, the logs\nquota and the time ranges on offer.\n","operationId":"listSiteLogStreams","parameters":[{"$ref":"#/components/parameters/logsEnvironmentId"},{"$ref":"#/components/parameters/logsScope"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/SiteLogsStreamsExample"}},"schema":{"$ref":"#/components/schemas/LogsStreams"}}},"description":"The sources, limits, quota and ranges."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/LogsNotCollectedConflict"},"422":{"$ref":"#/components/responses/LogsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"List a site's log sources","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/logs/usage":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the logs quota of the website, what is stored, how long lines are kept, 30 days of daily figures and\nthe share of each environment you can see.\n","operationId":"getSiteLogUsage","responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/SiteLogsUsageExample"}},"schema":{"$ref":"#/components/schemas/LogsUsage"}}},"description":"The usage."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/LogsNotCollectedConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/LogsStoreUnavailable"}},"summary":"Get a site's logs usage","tags":["Logs"],"x-feature":"logs","x-file":"logs","x-gates":["logs_tab"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/magento/store-mapping":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"Changes which store an existing served address shows, without adding or removing domains. Omitted choices stay as they are; null removes an explicit choice, and point_base_urls explicitly moves the selected stores' base URLs even from another host.","operationId":"updateSiteMagentoStoreMapping","requestBody":{"content":{"application/json":{"examples":{"keep_current_choices":{"summary":"Keep the current mapping","value":{"domains_version":0,"nginx_version":0}},"map_a_store":{"summary":"Show a website on a serving alias","value":{"domains_version":0,"hosts":{"guns.example.com":{"code":"guns","type":"website"}},"nginx_version":0}},"move_base_urls":{"summary":"Explicitly move a store's base URLs","value":{"domains_version":0,"hosts":{"guns.example.com":{"code":"guns","type":"website"}},"nginx_version":0,"point_base_urls":["guns.example.com"]}},"use_magento_default":{"summary":"Return to Magento's default store","value":{"default":null,"domains_version":0,"nginx_version":0}},"use_the_default_on_an_alias":{"summary":"Remove the alias's explicit store choice","value":{"domains_version":0,"hosts":{"guns.example.com":null},"nginx_version":0}}},"schema":{"$ref":"#/components/schemas/MagentoStoreMappingUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"operation":null,"stores":{"default_hosts":["shop.example.com"],"default_store":null,"domains_version":0,"nginx_version":0,"read_at":"2026-11-11T12:00:00Z","store_hosts":[],"warnings":[],"websites":[]}},"schema":{"properties":{"operation":{"type":"null"},"stores":{"$ref":"#/components/schemas/MagentoStores"}},"required":["stores","operation"],"type":"object"}}},"description":"Nothing differed. No operation was started; the stores are returned again."},"201":{"content":{"application/json":{"example":{"operation":{"completed_at":null,"created_at":"2026-11-11T12:00:00Z","error":null,"id":901,"scope":"site","status":"pending","status_label":"Saving change","steps":[{"key":"checked","label":"Stores checked","state":"done"},{"key":"store_mapping","label":"Store mapping saved","state":"current"},{"key":"store_base_urls","label":"Store addresses updated","state":"todo"}],"type":"magento_stores_change","type_label":"Magento stores change"}},"schema":{"properties":{"operation":{"$ref":"#/components/schemas/Operation"}},"required":["operation"],"type":"object"}}},"description":"Follow the magento_stores_change operation until the store mapping and store addresses finish."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/MagentoStoresNotFound"},"409":{"$ref":"#/components/responses/MagentoStoresConflict"},"422":{"$ref":"#/components/responses/MagentoStoreMappingInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/MagentoStoresUnreadable"},"503":{"$ref":"#/components/responses/CommandsSwitchedOff"}},"summary":"Update a site's Magento store mapping","tags":["Magento stores"],"x-effect":["changes-settings"],"x-feature":"magento-stores","x-file":"magento-stores","x-gates":["magento_store_domains","nginx_rules","exec"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-sets","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/magento/stores":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Reads Magento's websites, store views, base URLs and mapped addresses. The result may be reused for 60 seconds; a save checks Magento again.","operationId":"listSiteMagentoStores","responses":{"200":{"content":{"application/json":{"examples":{"stores":{"$ref":"#/components/examples/MagentoStoresRead"}},"schema":{"$ref":"#/components/schemas/MagentoStores"}}},"description":"The stores, their addresses, both versions and any warnings."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/MagentoStoresNotFound"},"409":{"$ref":"#/components/responses/MagentoStoresConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/MagentoStoresUnreadable"},"503":{"$ref":"#/components/responses/CommandsSwitchedOff"}},"summary":"List a site's Magento stores","tags":["Magento stores"],"x-feature":"magento-stores","x-file":"magento-stores","x-gates":["magento_store_domains","exec"],"x-rate-limit":{"bucket":"corecluster-magento","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/maintenance":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Switches the site's maintenance mode on or off and checks the site afterwards. While it is on, visitors get the maintenance page; Corefinity support still sees the site (`bypass_corefinity` counts its addresses, which are not listed). The answer is the state the site was checked in and the command that switched it.\n","operationId":"updateSiteMaintenanceMode","requestBody":{"content":{"application/json":{"examples":{"on":{"summary":"Switch maintenance mode on","value":{"enabled":true}}},"schema":{"$ref":"#/components/schemas/MaintenanceModeSwitch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"already_on":{"summary":"The site was already in maintenance mode, so nothing was switched or checked","value":{"command":{"blocked_until_verified":false,"duration_ms":212,"error":null,"exit_code":0,"finished_at":"2026-11-06T09:21:07Z","id":905,"input":{"enabled":true},"kind":"maintenance","label":"Maintenance mode","operation_id":null,"output_excerpt":null,"queued_at":"2026-11-06T09:21:07Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"result":{"enabled":true,"host_checked":null,"http_code":null},"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-06T09:21:07Z","status":"succeeded","status_label":"Done"},"maintenance":{"by":{"id":2041,"name":"Eleanor Finch"},"bypass_corefinity":1,"bypass_ips":[],"command":{"blocked_until_verified":false,"finished_at":"2026-11-06T09:21:07Z","id":905,"kind":"maintenance","label":"Maintenance mode","status":"succeeded","status_label":"Done"},"enabled":true,"page":"default","retry_after_seconds":300,"since":"2026-11-06T09:16:41Z"}}},"switched":{"summary":"Maintenance mode was switched on and the site checked","value":{"command":{"blocked_until_verified":false,"duration_ms":516,"error":null,"exit_code":0,"finished_at":"2026-11-06T09:16:41Z","id":904,"input":{"enabled":true},"kind":"maintenance","label":"Maintenance mode","operation_id":null,"output_excerpt":"HTTP/1.1 503 Service Temporarily Unavailable\nServer: nginx\nContent-Type: text/html\nCache-Control: no-store\nRetry-After: 300\n","queued_at":"2026-11-06T09:16:40Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"result":{"enabled":true,"host_checked":"harbourandfinch.example.com","http_code":503},"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-06T09:16:40Z","status":"succeeded","status_label":"Done"},"maintenance":{"by":{"id":2041,"name":"Eleanor Finch"},"bypass_corefinity":1,"bypass_ips":[],"command":{"blocked_until_verified":false,"finished_at":"2026-11-06T09:16:41Z","id":904,"kind":"maintenance","label":"Maintenance mode","status":"succeeded","status_label":"Done"},"enabled":true,"page":"default","retry_after_seconds":300,"since":"2026-11-06T09:16:41Z"}}}},"schema":{"$ref":"#/components/schemas/MaintenanceModeResult"}}},"description":"The switch ran. `command.status` is `succeeded`, or `failed` with the reason in `command.error`. When the site was already in the state you asked for, nothing is switched or checked, and `command.result` has `host_checked` and `http_code` null."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"The switch is being checked","value":{"code":"busy","message":"Maintenance mode is being checked. Try again in a moment.","reason":"busy"}},"change_running":{"summary":"Another change to the site is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"command_running":{"summary":"A command is running on the site","value":{"code":"command_running","message":"Another action is still running on this site. Wait for it to finish.","reason":"command_running"}},"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"exec_unresolved":{"summary":"An earlier command has not been confirmed stopped","value":{"code":"exec_unresolved","message":"A previous command on this site has not been confirmed stopped. Contact support.","reason":"exec_unresolved"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_running":{"summary":"The site is not running","value":{"code":"not_running","message":"The site is not running normally. Try again once it has recovered.","reason":"not_running"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The switch cannot run now. `reason` says why: `not_running` (the site is not running normally), `busy` or `command_running` (another change or command is running), `exec_unresolved` (an earlier command on the site has not been confirmed stopped), `deleted`, `provisioning` or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not true or false","value":{"code":"invalid","errors":{"enabled":["The enabled field must be true or false."]},"field":"enabled","message":"The enabled field must be true or false.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`enabled` is missing or not true or false (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/CommandsSwitchedOff"}},"summary":"Update maintenance mode","tags":["Maintenance mode"],"x-effect":["changes-settings"],"x-feature":"maintenance-mode","x-file":"error-pages","x-gates":["maintenance"],"x-rate-limit":{"bucket":"reseller-maintenance","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/maintenance-window":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the window in force for the site, where it comes from, its next occurrence and whether you can change it. An environment answers its website's window.","operationId":"getSiteMaintenanceWindow","responses":{"200":{"content":{"application/json":{"example":{"editable":true,"effective":{"end_hour":4,"label":"00:00–04:00 UK time","length_hours":4,"source":"platform","source_label":"Corefinity default","staff_locked":false,"start_hour":0,"timezone":"Europe/London"},"inherited":{"level":"platform","name":"Corefinity default","start_hour":0},"next":{"ends_at":"2026-11-04T04:00:00Z","hours":4,"label":"00:00–04:00 UK time","last_start_at":"2026-11-04T03:30:00Z","local_date":"2026-11-04","starts_at":"2026-11-04T00:00:00Z"},"notice_period":{"until":null},"own":null,"pending":{"count":0,"notice":false},"site":{"domain":"harbourandfinch.example.com","id":1042},"snapshot_overlap":null},"schema":{"$ref":"#/components/schemas/SiteMaintenanceWindow"}}},"description":"The window."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's maintenance window","tags":["Maintenance windows"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"put":{"description":"Gives the website a window of its own, starting at `start_hour` and lasting four hours, UK time. Changes already queued move to the new window.","operationId":"updateSiteMaintenanceWindow","requestBody":{"content":{"application/json":{"examples":{"three_in_the_morning":{"summary":"Open the window at 03:00","value":{"start_hour":3}}},"schema":{"$ref":"#/components/schemas/MaintenanceWindowUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"editable":true,"effective":{"end_hour":7,"label":"03:00–07:00 UK time","length_hours":4,"source":"site","source_label":"This website","staff_locked":false,"start_hour":3,"timezone":"Europe/London"},"inherited":{"level":"platform","name":"Corefinity default","start_hour":0},"next":{"ends_at":"2026-11-04T07:00:00Z","hours":4,"label":"03:00–07:00 UK time","last_start_at":"2026-11-04T06:30:00Z","local_date":"2026-11-04","starts_at":"2026-11-04T03:00:00Z"},"notice_period":{"until":null},"own":{"start_hour":3},"pending":{"count":0,"notice":false},"restamped":0,"site":{"domain":"harbourandfinch.example.com","id":1042},"snapshot_overlap":null},"schema":{"$ref":"#/components/schemas/SiteMaintenanceWindow"}}},"description":"The window was saved. `restamped` counts the queued changes that moved."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"You can see it but not change it","value":{"code":"forbidden","message":"You cannot change this website.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you have not set it up, or you can see this but may not change it (`forbidden`; today everyone who can see it may change its window, so this is not answered yet)."},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"batch_applying":{"summary":"Maintenance is running on the site","value":{"code":"batch_applying","message":"Maintenance is running on this site now. Try again when it finishes.","reason":"batch_applying"}},"window_locked":{"summary":"Corefinity has set the window","value":{"code":"window_locked","message":"This website's window is set by Corefinity.","reason":"window_locked"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has set the window (`window_locked`), or maintenance is running on the site now (`batch_applying`)."},"422":{"content":{"application/json":{"examples":{"environment":{"summary":"An environment, which uses its website's window","value":{"code":"window_scope_unavailable","message":"Environments use their website's window.","reason":"window_scope_unavailable"}},"start_hour":{"summary":"Not an hour from 0 to 23","value":{"code":"window_start_invalid","message":"Choose a start hour from 00 to 23.","reason":"window_start_invalid"}},"unknown_field":{"summary":"A field other than start_hour","value":{"code":"window_start_invalid","message":"Only start_hour can be set; a window always lasts 4 hours, UK time.","reason":"window_start_invalid"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The start hour is missing or wrong (`window_start_invalid`), or the site is an environment (`window_scope_unavailable`)."},"429":{"$ref":"#/components/responses/MaintenanceWindowWriteBudget"}},"summary":"Update a site's maintenance window","tags":["Maintenance windows"],"x-effect":["changes-settings"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"also":[{"bucket":"maintenance-window-writes","limit":10,"minutes":60,"per":"environment"},{"bucket":"maintenance-window-writes","limit":30,"minutes":60,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"delete":{"description":"Deletes the website's own window, so it uses the window it inherits again (its CoreCluster's default, else your company's, else Corefinity's). Changes already queued move with it.","operationId":"deleteSiteMaintenanceWindow","responses":{"200":{"content":{"application/json":{"example":{"editable":true,"effective":{"end_hour":4,"label":"00:00–04:00 UK time","length_hours":4,"source":"platform","source_label":"Corefinity default","staff_locked":false,"start_hour":0,"timezone":"Europe/London"},"inherited":{"level":"platform","name":"Corefinity default","start_hour":0},"next":{"ends_at":"2026-11-04T04:00:00Z","hours":4,"label":"00:00–04:00 UK time","last_start_at":"2026-11-04T03:30:00Z","local_date":"2026-11-04","starts_at":"2026-11-04T00:00:00Z"},"notice_period":{"until":null},"own":null,"pending":{"count":0,"notice":false},"restamped":0,"site":{"domain":"harbourandfinch.example.com","id":1042},"snapshot_overlap":null},"schema":{"$ref":"#/components/schemas/SiteMaintenanceWindow"}}},"description":"The window the site uses now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"You can see it but not change it","value":{"code":"forbidden","message":"You cannot change this website.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you have not set it up, or you can see this but may not change it (`forbidden`; today everyone who can see it may change its window, so this is not answered yet)."},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"batch_applying":{"summary":"Maintenance is running on the site","value":{"code":"batch_applying","message":"Maintenance is running on this site now. Try again when it finishes.","reason":"batch_applying"}},"window_locked":{"summary":"Corefinity has set the window","value":{"code":"window_locked","message":"This website's window is set by Corefinity.","reason":"window_locked"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has set the window (`window_locked`), or maintenance is running on the site now (`batch_applying`)."},"422":{"content":{"application/json":{"examples":{"environment":{"summary":"An environment, which uses its website's window","value":{"code":"window_scope_unavailable","message":"Environments use their website's window.","reason":"window_scope_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is an environment, which uses its website's window."},"429":{"$ref":"#/components/responses/MaintenanceWindowWriteBudget"}},"summary":"Delete a site's maintenance window","tags":["Maintenance windows"],"x-effect":["deletes"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"also":[{"bucket":"maintenance-window-writes","limit":10,"minutes":60,"per":"environment"},{"bucket":"maintenance-window-writes","limit":30,"minutes":60,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/maintenance-window/history":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the changes to the site's window, and to the CoreCluster and company defaults that reach it, newest first, twenty a page. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.","operationId":"listSiteMaintenanceWindowHistory","parameters":[{"description":"The `next_cursor` of the previous answer.","in":"query","name":"cursor","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"events":[{"action":"set","actor":{"name":"Eleanor Finch"},"after":{"start_hour":2},"at":"2026-11-03T09:00:00Z","before":null,"channel":"api","level":"website"}],"next_cursor":null},"schema":{"$ref":"#/components/schemas/MaintenanceWindowHistory"}}},"description":"A page of changes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's window changes","tags":["Maintenance windows"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/corestack/sites/{site}/maintenance-window/preview":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers what setting `start_hour`, or clearing the window, would do: the window afterwards and the queued changes that would move. Nothing is saved.","operationId":"previewSiteMaintenanceWindow","parameters":[{"description":"The start hour to try, from 0 to 23. Send this or `clear`.","example":3,"in":"query","name":"start_hour","required":false,"schema":{"maximum":23,"minimum":0,"type":"integer"}},{"description":"Send `1` to preview removing the window set at this level, instead of `start_hour`.","in":"query","name":"clear","required":false,"schema":{"enum":["1"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"batches":[],"effective_after":{"end_hour":7,"label":"03:00–07:00 UK time","source":"site","source_label":"This website","start_hour":3},"hold_until":"2026-11-03T09:30:00Z","moved":0,"next_after":{"ends_at":"2026-11-04T07:00:00Z","label":"Tonight 03:00–07:00 UK time","starts_at":"2026-11-04T03:00:00Z"},"notice_period":{"until":null},"snapshot_overlap":null,"unchanged":false},"schema":{"$ref":"#/components/schemas/MaintenanceWindowPreview"}}},"description":"The preview."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"window_locked":{"summary":"Corefinity has set the window","value":{"code":"window_locked","message":"This website's window is set by Corefinity.","reason":"window_locked"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has set the window, so it cannot be changed here."},"422":{"content":{"application/json":{"examples":{"environment":{"summary":"An environment, which uses its website's window","value":{"code":"window_scope_unavailable","message":"Environments use their website's window.","reason":"window_scope_unavailable"}},"start_hour":{"summary":"Not an hour from 0 to 23","value":{"code":"window_start_invalid","message":"Choose a start hour from 00 to 23.","reason":"window_start_invalid"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`start_hour` is missing or wrong (`window_start_invalid`), or the site is an environment (`window_scope_unavailable`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Preview a site's window change","tags":["Maintenance windows"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/corestack/sites/{site}/mariadb-version":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"Moves the site's database to the next MariaDB version. MariaDB moves forward only, one version at a time.\nAnswers the operation that makes the change.\n","operationId":"updateMariadbVersion","requestBody":{"content":{"application/json":{"examples":{"next":{"summary":"Move from MariaDB 11.4 to 11.8","value":{"to":"11.8"}}},"schema":{"$ref":"#/components/schemas/RuntimeMariadbVersionChangeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"started":{"summary":"The change started","value":{"committed_at":"2026-11-09T21:35:25+00:00","completed_at":null,"created_at":"2026-11-09T21:35:25+00:00","error":null,"from_version":"11.4","id":5121,"requested_by":{"id":2012,"name":"Daniel Reyes"},"status":"committed","status_label":"Waiting for the platform","steps":[{"key":"saved","state":"done"},{"key":"applied","state":"current"},{"key":"restarted","state":"todo"},{"key":"healthy","state":"todo"}],"to_version":"11.8","type":"mariadb_version","type_label":"MariaDB version"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/VersionChangeOperation"},{"$ref":"#/components/schemas/QueuedChange"}]}}},"description":"The change started (the operation), or was queued for the site's window (`queued`)."},"202":{"content":{"application/json":{"example":{"committed_at":null,"completed_at":null,"created_at":"2026-11-09T21:35:25+00:00","error":null,"from_version":"11.4","id":5121,"requested_by":{"id":2012,"name":"Daniel Reyes"},"status":"pending","status_label":"Saving change","steps":[{"key":"saved","state":"current"},{"key":"applied","state":"todo"},{"key":"restarted","state":"todo"},{"key":"healthy","state":"todo"}],"to_version":"11.8","type":"mariadb_version","type_label":"MariaDB version"},"schema":{"$ref":"#/components/schemas/VersionChangeOperation"}}},"description":"The change was sent and its outcome is still being established: the operation is `pending`. Follow it by its `id`;\nit settles as saved or as failed within a few minutes. Do not send the change again meanwhile.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/RuntimeVersionConflict"},"422":{"$ref":"#/components/responses/RuntimeMariadbVersionInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/RuntimeNotSaved"}},"summary":"Update a site's MariaDB version","tags":["PHP"],"x-effect":["changes-settings"],"x-feature":"php-runtime","x-file":"runtime","x-gates":[],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-operations","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the four hooks with their text, the `version` every change sends back, whether the rules are live, the verify paths, the limits and, when there is one, a change made outside the Control Panel (`drift`).\n","operationId":"getSiteNginxRules","parameters":[{"description":"Send `rendered` to add `path_apps.rendered`, the Nginx text written for the path apps.","in":"query","name":"include","required":false,"schema":{"enum":["rendered"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"adopted":false,"adoption":{"adopt_now_refusal":null,"adopted":false,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":null},"corefinity_rules":null,"drift":null,"hooks":{"headers":{"available":false,"available_after":{"date":null,"state":"not_scheduled"},"content":null},"http":{"available":false,"available_after":{"date":null,"state":"not_scheduled"},"content":null},"php":{"available":false,"available_after":{"date":null,"state":"not_scheduled"},"content":null},"server":{"available":true,"content":"location = /older {\n    return 410;\n}\n"}},"limits":{"max_bytes":65536,"max_lines":2000,"max_locations":200,"used":{"headers":null,"http":null,"php":null,"server":{"bytes":161,"lines":3,"locations":1}},"warn_lines":1500},"locked":null,"platform":"wordpress","policy_version":6,"revision":{"author":{"client":null,"kind":"user","name":"Eleanor Finch"},"created_at":"2026-11-02T15:41:09Z","errors_since":null,"hooks_changed":["server"],"id":317,"note":null,"number":2,"origin":"editor","status":"applied","status_reason":null},"site_id":1042,"status":{"applied_revision_id":317,"error":null,"operation_id":null,"pending_reason":null,"revert":null,"revision_id":317,"state":"live"},"verify_paths":[{"expect":"2xx","path":"/checkout"}],"version":2},"schema":{"$ref":"#/components/schemas/NginxRules"}}},"description":"The site's Nginx rules."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's Nginx rules","tags":["Web server rules"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"bucket":"corecluster-nginx-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Saves the hooks sent in `content` at the `version` you read: a hook left out stays as it is, and `\"\"` or `null` clears it. The change is checked, tested, applied and verified against the site's health check and verify paths, and one that fails is put back automatically: follow the operation in the answer. `verify_paths` may be sent without `content`.","operationId":"replaceSiteNginxRules","requestBody":{"content":{"application/json":{"examples":{"path_apps":{"summary":"Save a new path app, which is given the id a1, and leave the hooks as they are","value":{"note":"WordPress admin under /wp/","path_apps":[{"label":"Blog admin","php":{"dir_index":["wp-admin/"],"entries":["wp-admin/*.php","wp-login.php"],"router":["wp-json/"]},"prefix":"/wp/","preset":"wordpress-admin","root":"htdocs","type":"php-app"}],"version":0}},"save_a_hook":{"summary":"Save the server hook with a note","value":{"content":{"server":"location = /private-report.pdf {\n    return 404;\n}\n"},"note":"Hide the old report","version":2}},"verify_paths_only":{"summary":"Save only the verify paths","value":{"verify_paths":[{"expect":"2xx","path":"/checkout"}],"version":2}}},"schema":{"$ref":"#/components/schemas/NginxRulesUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"unchanged":{"summary":"The site already has this content","value":{"operation":null,"revision":null}},"verify_paths":{"summary":"Only the verify paths were saved","value":{"verify_paths":[{"expect":"2xx","path":"/checkout"}],"version":3}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/NginxSaveResult"},{"$ref":"#/components/schemas/NginxVerifyPathsResult"}]}}},"description":"Nothing was started: the content is what the site already has (`operation` and `revision` are null), or only the verify paths were saved (`version` and `verify_paths`)."},"201":{"content":{"application/json":{"examples":{"queued":{"summary":"The change waits for the site's window","value":{"item_id":77,"operation":null,"queued":true,"revision":null,"window_date":"2026-11-07"}},"started":{"summary":"The change started","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:40Z","completed_at":null,"created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"Saved","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Saving change","step":"saved","steps":[{"key":"tested","label":"Tested","state":"done"},{"key":"saved","label":"Saved","state":"current"},{"key":"sent","label":"Sent to the site","state":"todo"},{"key":"reloaded","label":"Nginx reloaded","state":"todo"},{"key":"checked","label":"Checked","state":"todo"},{"key":"verified","label":"Verified","state":"todo"}],"subject":null,"summary":"Nginx rules","to_version":null,"type":"nginx_rules_change","type_label":"Nginx rules"},"revision":{"id":318,"number":3,"status":"saving"}}}},"schema":{"$ref":"#/components/schemas/NginxSaveResult"}}},"description":"The change was saved. Follow `operation`; `revision` is the new revision. A change that waits for a window answers `queued: true` with nothing started."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"conflict":{"summary":"Another change to the platform landed first","value":{"code":"conflict","message":"Another change landed first. Reload and try again.","reason":"conflict"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"restore_running":{"summary":"A restore is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"stale":{"summary":"The rules changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The request was refused because of the site's state. `reason` says why: `stale` (the rules changed since your read: read them again and send the new `version`), `busy` or `change_pending` (another change is running or waiting), `restore_running`, `command_running` or `deployment_running` (a restore, a command or a deployment is running on the site), `conflict` (another change to the platform landed first: send the request again), `cluster_paused`, `cluster_not_ready` or `cluster_deleting` (the site's cluster cannot take changes at the moment), or `managed_elsewhere`."},"413":{"content":{"application/json":{"examples":{"too_large":{"summary":"The server hook is over 64 KB","value":{"code":"too_large","hook":"server","max_bytes":65536,"message":"The server hook is larger than 64 KB.","reason":"too_large"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"A hook is over its size limit (`too_large`). `hook` names it and `max_bytes` is the limit."},"422":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The change cannot wait for a window at the moment","value":{"code":"feature_off","message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}},"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"content.nope":["content.nope is not a hook: server, headers, php or http."]},"field":"content.nope","message":"content.nope is not a hook: server, headers, php or http.","reason":"invalid"}},"nginx_invalid":{"summary":"The rules break the policy","value":{"code":"nginx_invalid","diagnostics":[{"code":"root_outside_webroot","column":5,"hook":"server","line":4,"message":"Rules can serve files from the web root only.","severity":"error","source":"policy"}],"message":"These nginx rules cannot be saved: fix the errors shown.","reason":"nginx_invalid"}},"nginx_rules_locked":{"summary":"Corefinity has locked the site's Nginx rules","value":{"code":"nginx_rules_locked","diagnostics":[],"message":"Corefinity has locked this environment's nginx rules. Contact support to change them.","reason":"nginx_rules_locked"}},"nothing_sent":{"summary":"Nothing to save was sent","value":{"code":"invalid","errors":{"content":["Send the content of at least one hook."]},"field":"content","message":"Send the content of at least one hook.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `nginx_invalid` (the rules break the policy; `diagnostics` lists each problem), `nginx_test_failed` (the rules failed the test on the site's own Nginx; `diagnostics`), `hook_unavailable` (the site cannot use that hook yet), `nginx_rules_locked` (Corefinity manages the site's Nginx rules), or `feature_off` when `apply` asks for a window and changes cannot wait for one at the moment."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 20 saves a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."},"500":{"$ref":"#/components/responses/NginxPlatformUnreadable"},"502":{"$ref":"#/components/responses/NginxChangeNotSaved"},"503":{"$ref":"#/components/responses/NginxConfigurationUnreadable"}},"summary":"Replace a site's Nginx rules","tags":["Web server rules"],"x-effect":["changes-settings","overwrites"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-long-running":"getSiteNginxOperation","x-rate-limit":{"also":[{"bucket":"corecluster-nginx-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/backup-guard":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers whether Corefinity blocks requests for database dumps left in the web root (a request for a `.sql`\nor `.sql.gz` file answers 404), whether the site carries the rule yet, and the file types it covers.\n","operationId":"getSiteBackupGuard","responses":{"200":{"content":{"application/json":{"example":{"backup_guard":{"applied":true,"attention_extensions":["zip","tar.gz","tgz"],"available":true,"enabled":true,"extensions":["sql","sql.gz"],"lines":["set $cf_backup_guard_body \"\";","if ($uri ~* \"\\.(?:sql|sql\\.gz)$\") { return 404 $cf_backup_guard_body; }"],"pending":false,"platform_enforced":false,"switched_off_at":null,"uncertain":false}},"schema":{"properties":{"backup_guard":{"$ref":"#/components/schemas/NginxBackupGuard"}},"required":["backup_guard"],"type":"object"}}},"description":"The rule's state."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's backup-file rule","tags":["Web server rules"],"x-feature":"nginx-rules","x-file":"nginx-backup-guard","x-gates":["nginx_rules"],"x-rate-limit":{"bucket":"corecluster-nginx-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Switches the rule on or off. The change applies at once, so it cannot be scheduled: follow the operation\nin the answer. Sending the state the site already has answers `200` with `operation: null`.\n","operationId":"updateSiteBackupGuard","requestBody":{"content":{"application/json":{"examples":{"switch_off":{"summary":"Stop blocking backup files","value":{"enabled":false}},"switch_on":{"summary":"Block backup files again","value":{"enabled":true}}},"schema":{"$ref":"#/components/schemas/NginxBackupGuardUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"backup_guard":{"applied":true,"attention_extensions":["zip","tar.gz","tgz"],"available":true,"enabled":true,"extensions":["sql","sql.gz"],"lines":["set $cf_backup_guard_body \"\";","if ($uri ~* \"\\.(?:sql|sql\\.gz)$\") { return 404 $cf_backup_guard_body; }"],"pending":false,"platform_enforced":false,"switched_off_at":null,"uncertain":false},"operation":null},"schema":{"$ref":"#/components/schemas/NginxBackupGuardSaveResult"}}},"description":"The site already has that state. Nothing was started and `operation` is null."},"201":{"content":{"application/json":{"example":{"backup_guard":{"applied":true,"attention_extensions":["zip","tar.gz","tgz"],"available":true,"enabled":false,"extensions":["sql","sql.gz"],"lines":["set $cf_backup_guard_body \"\";","if ($uri ~* \"\\.(?:sql|sql\\.gz)$\") { return 404 $cf_backup_guard_body; }"],"pending":true,"platform_enforced":false,"switched_off_at":"2026-11-06T09:16:40Z","uncertain":false},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:40Z","completed_at":null,"created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":true,"id":5120,"install":null,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"current"},{"key":"live","label":"Live","state":"todo"}],"subject":null,"summary":"Backup file blocking","to_version":null,"type":"nginx_backup_guard_change","type_label":"Backup file blocking"}},"schema":{"$ref":"#/components/schemas/NginxBackupGuardSaveResult"}}},"description":"The change was saved and started. Follow `operation`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"conflict":{"summary":"Another change to the platform landed first","value":{"code":"conflict","message":"Another change landed first. Reload and try again.","reason":"conflict"}},"files_missing":{"summary":"The site's Nginx files are not ready yet","value":{"code":"files_missing","message":"This environment's Nginx files are not ready yet. Try again in a few minutes.","reason":"files_missing"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_changeable":{"summary":"The site's files cannot be written from the Control Panel","value":{"message":"This site cannot be changed from the control panel. Contact support."}},"restore_running":{"summary":"A restore is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"wrong_platform":{"summary":"The platform always blocks these files","value":{"code":"wrong_platform","message":"This site's platform always blocks these files, so this cannot be switched off.","reason":"wrong_platform"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The switch was refused because of the site's state. `reason` says why: `wrong_platform` (the site's\nplatform always blocks these files, so the rule cannot be switched off), `files_missing` (the site's\nNginx files are not ready yet), `busy` (another change is running), `restore_running`, `command_running`,\n`deployment_running`, `stale` (the rule was changed by someone else at the same moment: read it again),\n`conflict` (another change to the platform landed first: send the request again), `cluster_paused`,\n`cluster_not_ready`, `cluster_deleting` or `managed_elsewhere`. A site whose files the Control Panel\ncannot write answers a sentence only, with no `reason`.\n"},"422":{"content":{"application/json":{"examples":{"apply_not_supported":{"summary":"The change cannot be scheduled","value":{"code":"apply_not_supported","field":"apply","message":"This change applies at once, so it cannot be scheduled.","reason":"apply_not_supported"}},"invalid":{"summary":"Not true or false","value":{"code":"invalid","errors":{"enabled":["Say whether to block backup files: true or false."]},"field":"enabled","message":"Say whether to block backup files: true or false.","reason":"invalid"}},"nginx_rules_locked":{"summary":"Corefinity has locked the site's Nginx rules","value":{"code":"nginx_rules_locked","diagnostics":[],"message":"Corefinity has locked this environment's nginx rules. Contact support to change them.","reason":"nginx_rules_locked"}},"not_available":{"summary":"The rule is not offered yet","value":{"code":"not_available","message":"Blocking backup files is not available yet.","reason":"not_available"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`enabled` is missing or not true or false, or the body names another field (`invalid`, with `field`);\n`apply` is anything but `now` (`apply_not_supported`); the rule is not offered for the site yet\n(`not_available`); or Corefinity has locked the site's Nginx rules (`nginx_rules_locked`).\n"},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 20 saves a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."},"502":{"content":{"application/json":{"examples":{"no_answer":{"summary":"The platform did not answer","value":{"message":"The platform returned an error (HTTP 503). Try again shortly."}},"not_saved":{"summary":"The platform did not save the change","value":{"message":"The change could not be saved. Contact support."}}},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The platform did not answer, or did not save the change. Nothing was switched: send the request again\nin a minute. The answer is a sentence only, with no `reason`.\n"}},"summary":"Update a site's backup-file rule","tags":["Web server rules"],"x-effect":["changes-settings"],"x-feature":"nginx-rules","x-file":"nginx-backup-guard","x-gates":["nginx_rules"],"x-long-running":"getOperation","x-rate-limit":{"also":[{"bucket":"corecluster-nginx-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/copy":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Copies the live rules of another environment of the same website onto this one, for example staging onto production, with the web root rewritten for this environment. `dry_run: true` previews the result and saves nothing. Otherwise the copy is saved like any change; copying onto a production environment needs `confirm_production: true`. Unless `hooks` says otherwise, every part is copied.\n","operationId":"copySiteNginxRules","requestBody":{"content":{"application/json":{"examples":{"copy_onto_production":{"summary":"Copy staging onto production","value":{"confirm_production":true,"from_site_id":1043,"hooks":["server","headers","php","http"],"note":"Promote staging","version":2}},"preview":{"summary":"Preview a copy from the staging environment","value":{"dry_run":true,"from_site_id":1043}}},"schema":{"$ref":"#/components/schemas/NginxRulesCopy"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"preview":{"summary":"A preview","value":{"content":{"headers":null,"http":null,"php":null,"server":"location = /staging-only {\n    return 410;\n}\n"},"diagnostics":[],"diff":{"headers":null,"http":null,"php":null,"server":"--- this environment\n+++ copied\n@@ -1,3 +1,3 @@\n-location = /older {\n+location = /staging-only {\n     return 410;\n }\n"},"rewrites":[],"source_revision":{"id":57,"number":1,"site_id":1043},"state":"dry_run"}},"unchanged":{"summary":"Nothing to copy","value":{"operation":null,"revision":null}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/NginxCopyPreview"},{"$ref":"#/components/schemas/NginxSaveResult"}]}}},"description":"A preview (`state: dry_run`), or a copy of content this environment already has (`operation` and `revision` null)."},"201":{"content":{"application/json":{"examples":{"queued":{"summary":"The copy waits for the site's window","value":{"item_id":77,"operation":null,"queued":true,"revision":null,"window_date":"2026-11-07"}},"started":{"summary":"The copy started","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:40Z","completed_at":null,"created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"Saved","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Saving change","step":"saved","steps":[{"key":"tested","label":"Tested","state":"done"},{"key":"saved","label":"Saved","state":"current"},{"key":"sent","label":"Sent to the site","state":"todo"},{"key":"reloaded","label":"Nginx reloaded","state":"todo"},{"key":"checked","label":"Checked","state":"todo"},{"key":"verified","label":"Verified","state":"todo"}],"subject":null,"summary":"Nginx rules","to_version":null,"type":"nginx_rules_change","type_label":"Nginx rules"},"revision":{"id":318,"number":3,"status":"saving"}}}},"schema":{"$ref":"#/components/schemas/NginxSaveResult"}}},"description":"The copy was saved as a new revision. Follow `operation`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"conflict":{"summary":"Another change to the platform landed first","value":{"code":"conflict","message":"Another change landed first. Reload and try again.","reason":"conflict"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"restore_running":{"summary":"A restore is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"stale":{"summary":"The rules changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The request was refused because of the site's state. `reason` says why: `stale` (the rules changed since your read: read them again and send the new `version`), `busy` or `change_pending` (another change is running or waiting), `restore_running`, `command_running` or `deployment_running` (a restore, a command or a deployment is running on the site), `conflict` (another change to the platform landed first: send the request again), `cluster_paused`, `cluster_not_ready` or `cluster_deleting` (the site's cluster cannot take changes at the moment), or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"confirm":{"summary":"Copying onto production needs the confirmation","value":{"code":"confirm","errors":{"confirm_production":["Confirm that this changes production's nginx rules to copy onto production."]},"field":"confirm_production","message":"Confirm that this changes production's nginx rules to copy onto production.","reason":"confirm"}},"feature_off":{"summary":"The change cannot wait for a window at the moment","value":{"code":"feature_off","message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}},"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"from_site_id":["from_site_id is a whole number from 1."]},"field":"from_site_id","message":"from_site_id is a whole number from 1.","reason":"invalid"}},"nginx_invalid":{"summary":"The rules break the policy","value":{"code":"nginx_invalid","diagnostics":[{"code":"root_outside_webroot","column":5,"hook":"server","line":4,"message":"Rules can serve files from the web root only.","severity":"error","source":"policy"}],"message":"These nginx rules cannot be saved: fix the errors shown.","reason":"nginx_invalid"}},"nginx_rules_locked":{"summary":"Corefinity has locked the site's Nginx rules","value":{"code":"nginx_rules_locked","diagnostics":[],"message":"Corefinity has locked this environment's nginx rules. Contact support to change them.","reason":"nginx_rules_locked"}},"no_hooks":{"summary":"An empty list of parts","value":{"code":"invalid","errors":{"hooks":["Choose at least one hook to copy"]},"field":"hooks","message":"Choose at least one hook to copy","reason":"invalid"}},"no_version":{"summary":"A copy that is not a preview, sent without the version","value":{"code":"invalid","errors":{"version":["version is a whole number."]},"field":"version","message":"version is a whole number.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `nginx_invalid` (the rules break the policy; `diagnostics` lists each problem), `nginx_test_failed` (the rules failed the test on the site's own Nginx; `diagnostics`), `hook_unavailable` (the site cannot use that hook yet), `nginx_rules_locked` (Corefinity manages the site's Nginx rules), or `feature_off` when `apply` asks for a window and changes cannot wait for one at the moment. A copy onto production without `confirm_production: true` answers `confirm`."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 20 saves a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."},"500":{"$ref":"#/components/responses/NginxPlatformUnreadable"},"502":{"$ref":"#/components/responses/NginxChangeNotSaved"},"503":{"$ref":"#/components/responses/NginxConfigurationUnreadable"}},"summary":"Copy Nginx rules between environments","tags":["Web server rules"],"x-effect":["changes-settings","overwrites"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-long-running":"getSiteNginxOperation","x-rate-limit":{"also":[{"bucket":"corecluster-nginx-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/corefinity-rules/move":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Moves the rules Corefinity set up for the site (`corefinity_rules` in the read) into your own `server` hook, where you can edit them. Only blocks that answer every address exactly as before can move. The move always applies at once and takes about a minute.\n","operationId":"moveSiteCorefinityNginxRules","requestBody":{"content":{"application/json":{"examples":{"move_every_block":{"summary":"Move every block that can move","value":{"version":0}}},"schema":{"$ref":"#/components/schemas/NginxCorefinityRulesMove"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:40Z","completed_at":null,"created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5122,"install":null,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"tested","label":"Tested","state":"done"},{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"current"},{"key":"restarted","label":"Change applied","state":"todo"},{"key":"healthy","label":"Healthy","state":"todo"},{"key":"checked","label":"Checked","state":"todo"},{"key":"verified","label":"Verified","state":"todo"}],"subject":null,"summary":"Move Corefinity rules","to_version":null,"type":"nginx_rules_move","type_label":"Move Corefinity rules"},"revision":{"id":319,"number":1,"status":"saving"}},"schema":{"$ref":"#/components/schemas/NginxSaveResult"}}},"description":"The move started. Follow `operation`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"conflict":{"summary":"Another change to the platform landed first","value":{"code":"conflict","message":"Another change landed first. Reload and try again.","reason":"conflict"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_running":{"summary":"The site is not running","value":{"code":"not_running","message":"This environment is not running. Start it, then move the rules.","reason":"not_running"}},"restore_running":{"summary":"A restore is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"stale":{"summary":"The rules changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The request was refused because of the site's state. `reason` says why: `stale` (the rules changed since your read: read them again and send the new `version`), `busy` or `change_pending` (another change is running or waiting), `not_running` (the site is not running), `restore_running`, `command_running` or `deployment_running` (a restore, a command or a deployment is running on the site), `conflict` (another change to the platform landed first: send the request again), `cluster_paused`, `cluster_not_ready` or `cluster_deleting` (the site's cluster cannot take changes at the moment), or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The change cannot wait for a window at the moment","value":{"code":"feature_off","message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}},"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"version":["version is a whole number."]},"field":"version","message":"version is a whole number.","reason":"invalid"}},"nginx_invalid":{"summary":"The rules break the policy","value":{"code":"nginx_invalid","diagnostics":[{"code":"root_outside_webroot","column":5,"hook":"server","line":4,"message":"Rules can serve files from the web root only.","severity":"error","source":"policy"}],"message":"These nginx rules cannot be saved: fix the errors shown.","reason":"nginx_invalid"}},"nginx_rules_locked":{"summary":"Corefinity has locked the site's Nginx rules","value":{"code":"nginx_rules_locked","diagnostics":[],"message":"Corefinity has locked this environment's nginx rules. Contact support to change them.","reason":"nginx_rules_locked"}},"not_admitted":{"summary":"A move cannot wait for a window","value":{"code":"not_admitted","message":"This change cannot be scheduled for tonight","reason":"not_admitted"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `nginx_invalid` (the rules break the policy; `diagnostics` lists each problem), `nginx_test_failed` (the rules failed the test on the site's own Nginx; `diagnostics`), `hook_unavailable` (the site cannot use that hook yet), `nginx_rules_locked` (Corefinity manages the site's Nginx rules), or `feature_off` when `apply` asks for a window and changes cannot wait for one at the moment. A move also answers `not_admitted` when `apply` asks for a window."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 20 saves a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."},"500":{"$ref":"#/components/responses/NginxPlatformUnreadable"},"502":{"$ref":"#/components/responses/NginxChangeNotSaved"}},"summary":"Move Corefinity's rules into yours","tags":["Web server rules"],"x-effect":["changes-settings"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-long-running":"getSiteNginxOperation","x-rate-limit":{"also":[{"bucket":"corecluster-nginx-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/drift":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Answers a change to the site's Nginx rules that was made outside the Control Panel (`drift` in the read). `committed` takes the changed rules as your saved rules, as a new revision that is then checked like any change. `panel` keeps your saved rules: nothing is written, and your next save writes them again.\n","operationId":"resolveSiteNginxDrift","requestBody":{"content":{"application/json":{"examples":{"keep_the_control_panels":{"summary":"Keep your saved rules","value":{"action":"panel","version":3}},"use_the_committed_version":{"summary":"Take the changed rules as your saved rules","value":{"action":"committed","version":3}}},"schema":{"$ref":"#/components/schemas/NginxDriftAnswer"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"operation":null,"revision":null},"schema":{"$ref":"#/components/schemas/NginxSaveResult"}}},"description":"`panel`: your saved rules stay as they are."},"201":{"content":{"application/json":{"example":{"operation":null,"revision":{"id":320,"number":2,"status":"pending_verify"}},"schema":{"$ref":"#/components/schemas/NginxSaveResult"}}},"description":"`committed`: the changed rules are a new revision, `pending_verify` until they have been checked."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"inventory_behind":{"summary":"The rules changed again after your read","value":{"code":"inventory_behind","message":"The nginx files changed again in the repository after they were last read. Read them again to see the latest change, then choose again.","reason":"inventory_behind"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"stale":{"summary":"The rules changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The request was refused because of the site's state. `reason` says why: `stale` (the rules changed since your read: read them again and send the new `version`), `busy` or `change_pending` (another change is running or waiting), `inventory_behind` (the rules changed again after your read), or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not one of the two answers","value":{"code":"invalid","errors":{"action":["action is committed or panel."]},"field":"action","message":"action is committed or panel.","reason":"invalid"}},"nginx_rules_locked":{"summary":"Corefinity has locked the site's Nginx rules","value":{"code":"nginx_rules_locked","diagnostics":[],"message":"Corefinity has locked this environment's nginx rules. Contact support to change them.","reason":"nginx_rules_locked"}},"no_drift":{"summary":"Nothing to answer","value":{"code":"no_drift","message":"This environment's nginx rules are the ones the Control Panel last committed: there is no change made outside it to answer.","reason":"no_drift"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`), there is no change made outside the Control Panel to answer (`no_drift`), the changed rules break the policy (`nginx_invalid`, with `diagnostics`) or lack a file (`files_missing`), or Corefinity has locked the site's Nginx rules (`nginx_rules_locked`)."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 20 saves a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."},"503":{"content":{"application/json":{"examples":{"upstream_unavailable":{"summary":"Try again in a few minutes","value":{"code":"upstream_unavailable","message":"This environment's configuration repository can't be read right now. Try again in a few minutes.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site's configuration cannot be read at the moment (`upstream_unavailable`). Try again in a few minutes."}},"summary":"Answer a change made outside","tags":["Web server rules"],"x-effect":["changes-settings","overwrites"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"also":[{"bucket":"corecluster-nginx-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/explain":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Works out which rule answers a path on the site, step by step: the locations that were considered, the one that won and what it answers. Send `content` to explain unsaved hooks instead of the saved ones. Nothing is saved and no request is made to the site.\n","operationId":"testSiteNginxRules","requestBody":{"content":{"application/json":{"examples":{"saved_rules":{"summary":"Explain a path against the saved rules","value":{"host":"harbourandfinch.example.com","path":"/older"}},"unsaved_rules":{"summary":"Explain a path against an unsaved server hook","value":{"content":{"server":"location = /private-report.pdf {\n    return 404;\n}\n"},"path":"/private-report.pdf"}}},"schema":{"$ref":"#/components/schemas/NginxExplainRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"block":{"file":"nginx-site.conf","line":1,"server_name":"harbourandfinch.example.com"},"locations":[{"file":"custom-server.inc","hook":"server","line":3,"match":"exact","nested":false,"pattern":"/private-report.pdf","source":"custom"}],"notes":[],"outcome":{"detail":"404 — return 404 in your Server rules, line 2","kind":"returned"},"server_steps":[],"try_files_branches":[],"winner":0},"schema":{"$ref":"#/components/schemas/NginxExplanation"}}},"description":"The explanation."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"413":{"content":{"application/json":{"examples":{"too_large":{"summary":"The server hook is over its limit","value":{"code":"too_large","diagnostics":[],"hook":"server","max_bytes":65536,"message":"A hook file may hold 65536 bytes.","reason":"too_large"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"A hook sent in `content` is over its size limit (`too_large`). `hook` names it and `max_bytes` is the limit."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"No path","value":{"code":"invalid","errors":{"path":["Enter a path such as /wp-content/uploads/report.pdf."]},"field":"path","message":"Enter a path such as /wp-content/uploads/report.pdf.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`: a path that is not one, a host the site does not serve), or the server hook does not parse (`nginx_invalid`, with `diagnostics`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Explain which rule answers an address","tags":["Web server rules"],"x-effect":["none"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"bucket":"corecluster-nginx-explain","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/htaccess":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Converts an Apache `.htaccess` file into Nginx rules per hook, the redirect lines for the site's redirects, and the lines that could not be converted; nothing is saved. Lines the fixed conversion cannot handle are sent, with their values removed, to an AI model for suggestions: read the conversion again until `ai.status` is no longer `running`. It can be read for one hour, by the person who started it.","operationId":"createSiteHtaccessConversion","requestBody":{"content":{"application/json":{"examples":{"convert":{"summary":"Convert a short file","value":{"content":"RewriteEngine On\nRedirect 301 /old-page /new-page\nOptions -Indexes\nHeader set X-Frame-Options SAMEORIGIN\n"}}},"schema":{"$ref":"#/components/schemas/NginxHtaccessConvert"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"conversion":{"ai":{"error":null,"hooks":null,"lines":0,"notes":[],"status":"not_needed","unconverted":[]},"converted":[],"created_at":"2026-11-06T09:16:40+00:00","expires_at":"2026-11-06T10:16:40+00:00","handled":[{"line":1,"lines":[1],"reason":"Not needed in nginx.","text":"RewriteEngine On"},{"line":3,"lines":[3],"reason":"Already the platform default.","text":"Options -Indexes"}],"hooks":{"headers":"","server":""},"id":"6cc45fe1-46c3-4ce3-b9ca-20ab24c3bbc4","platform":"wordpress","pointers":[],"redirects":{"content":"Redirect 301 /old-page /new-page\n","count":1,"format":"apache","lines":[2]},"unconverted":[{"line":4,"lines":[4],"reason":"Set by Corefinity. Use CSP frame-ancestors to allow framing; browsers prefer it to X-Frame-Options.","text":"Header set X-Frame-Options SAMEORIGIN"}]}},"schema":{"properties":{"conversion":{"$ref":"#/components/schemas/NginxHtaccessConversion"}},"required":["conversion"],"type":"object"}}},"description":"The conversion."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"413":{"content":{"application/json":{"examples":{"too_large":{"summary":"The file is over 256 KB","value":{"code":"too_large","max_bytes":262144,"message":"An .htaccess file may be 256 KB at most. Convert it in parts.","reason":"too_large"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The file is over the size limit (`too_large`). `max_bytes` is the limit."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Nothing to convert","value":{"code":"invalid","errors":{"content":["Paste or upload an .htaccess first."]},"field":"content","message":"Paste or upload an .htaccess first.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`content` is missing or empty (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create an .htaccess conversion","tags":["Web server rules"],"x-effect":["none"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"bucket":"corecluster-nginx-convert","limit":20,"minutes":60},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/htaccess/{conversion}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of a conversion you started on this site, from its `conversion.id`.","in":"path","name":"conversion","required":true,"schema":{"format":"uuid","type":"string"}}],"get":{"description":"Answers a conversion you started on this site, with the AI's suggestions once they are ready.\n","operationId":"getSiteHtaccessConversion","responses":{"200":{"content":{"application/json":{"example":{"conversion":{"ai":{"error":null,"hooks":null,"lines":0,"notes":[],"status":"not_needed","unconverted":[]},"converted":[],"created_at":"2026-11-06T09:16:40+00:00","expires_at":"2026-11-06T10:16:40+00:00","handled":[{"line":1,"lines":[1],"reason":"Not needed in nginx.","text":"RewriteEngine On"},{"line":3,"lines":[3],"reason":"Already the platform default.","text":"Options -Indexes"}],"hooks":{"headers":"","server":""},"id":"6cc45fe1-46c3-4ce3-b9ca-20ab24c3bbc4","platform":"wordpress","pointers":[],"redirects":{"content":"Redirect 301 /old-page /new-page\n","count":1,"format":"apache","lines":[2]},"unconverted":[{"line":4,"lines":[4],"reason":"Set by Corefinity. Use CSP frame-ancestors to allow framing; browsers prefer it to X-Frame-Options.","text":"Header set X-Frame-Options SAMEORIGIN"}]}},"schema":{"properties":{"conversion":{"$ref":"#/components/schemas/NginxHtaccessConversion"}},"required":["conversion"],"type":"object"}}},"description":"The conversion."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The feature is not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"hidden":{"summary":"Not found, or not yours to see","value":{"message":"Not found."}},"not_found":{"summary":"The conversion has expired or is not yours","value":{"code":"not_found","message":"This conversion has expired or does not exist. Convert the file again.","reason":"not_found"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site does not exist or is not yours to see, the feature is not on for your company (`feature_off`), or the conversion has expired, does not exist or was started by somebody else (`not_found`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an .htaccess conversion","tags":["Web server rules"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"bucket":"corecluster-nginx-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/operations/{operation}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of an operation of this site, from a change's `operation.id`.","in":"path","name":"operation","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers an operation of this site. Read it again until `status` is `completed` or `failed`.\n","operationId":"getSiteNginxOperation","responses":{"200":{"content":{"application/json":{"example":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:40Z","completed_at":"2026-11-06T09:17:22Z","created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":null,"notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"completed","status_label":"Done","step":null,"steps":[{"key":"tested","label":"Tested","state":"done"},{"key":"saved","label":"Saved","state":"done"},{"key":"sent","label":"Sent to the site","state":"done"},{"key":"reloaded","label":"Nginx reloaded","state":"done"},{"key":"checked","label":"Checked","state":"done"},{"key":"verified","label":"Verified","state":"done"}],"subject":null,"summary":"Nginx rules","to_version":null,"type":"nginx_rules_change","type_label":"Nginx rules"},"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"The operation."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an Nginx rules operation","tags":["Web server rules"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"bucket":"corecluster-nginx-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/revisions":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Lists the revisions of the site's Nginx rules, newest first. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.","operationId":"listSiteNginxRevisions","parameters":[{"description":"Items a page: 1 to 100, default 20.","in":"query","name":"limit","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"author":{"client":null,"kind":"user","name":"Eleanor Finch"},"created_at":"2026-11-02T15:41:09Z","errors_since":null,"hooks_changed":["server"],"id":317,"note":null,"number":2,"origin":"editor","status":"applied","status_reason":null},{"author":{"client":null,"kind":"user","name":"Eleanor Finch"},"created_at":"2026-11-01T10:02:11Z","errors_since":null,"hooks_changed":["server"],"id":316,"note":"First rules","number":1,"origin":"editor","status":"superseded","status_reason":null}],"next_cursor":null},"schema":{"$ref":"#/components/schemas/NginxRevisionPage"}}},"description":"A page of revisions."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not a cursor","value":{"code":"invalid","errors":{"cursor":["cursor is the next_cursor of the page before."]},"field":"cursor","message":"cursor is the next_cursor of the page before.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`cursor` is not one the list gave you (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's Nginx revisions","tags":["Web server rules"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"bucket":"corecluster-nginx-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/revisions/{revision}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of a revision of this site, from the list's `id`.","in":"path","name":"revision","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers one revision with the text of its hooks and a unified diff of each hook against the current revision, or against another one.\n","operationId":"getSiteNginxRevision","parameters":[{"description":"The id of the revision to compare with, or `current` (the default).","in":"query","name":"against","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"against":{"current":true,"id":317},"diff":{"headers":null,"http":null,"php":null,"server":"--- revision 2\n+++ revision 1\n@@ -1,3 +1,3 @@\n-location = /older {\n-    return 410;\n+location = /old {\n+    return 404;\n }\n"},"revision":{"author":{"client":null,"kind":"user","name":"Eleanor Finch"},"content":{"headers":null,"http":null,"php":null,"server":"location = /old {\n    return 404;\n}\n"},"created_at":"2026-11-01T10:02:11Z","errors_since":null,"hooks_changed":["server"],"id":316,"note":"First rules","number":1,"origin":"editor","status":"applied","status_reason":null}},"schema":{"$ref":"#/components/schemas/NginxRevisionDetail"}}},"description":"The revision and its differences."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not a revision of this site","value":{"code":"invalid","errors":{"against":["against is current or a revision of this environment."]},"field":"against","message":"against is current or a revision of this environment.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`against` is not `current` or a revision of this site (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get one Nginx revision","tags":["Web server rules"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"bucket":"corecluster-nginx-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/revisions/{revision}/errors":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of a revision of this site, from the list's `id`.","in":"path","name":"revision","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers up to 50 web server error lines logged while the revision was live, to see whether a change of rules broke something. `available` is false, with a `reason`, when the revision never went live or the site's logs cannot be read.\n","operationId":"getSiteNginxRevisionErrors","responses":{"200":{"content":{"application/json":{"examples":{"lines":{"summary":"Errors logged while the revision was live","value":{"available":true,"count":1,"from":"2026-11-02T15:41:09Z","lines":[{"at":"2026-11-03T08:12:45Z","level":"error","message":"open() \"/var/www/harbourandfinch.example.com/htdocs/private-report.pdf\" failed (2: No such file or directory)"}],"to":null}},"never_live":{"summary":"The revision never went live","value":{"available":false,"reason":"never_live"}}},"schema":{"$ref":"#/components/schemas/NginxRevisionErrors"}}},"description":"The error lines, or why there are none to read."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the errors since a revision","tags":["Web server rules"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules","logs_tab"],"x-rate-limit":{"bucket":"corecluster-nginx-logs","limit":30,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/revisions/{revision}/revert":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of a revision of this site, from the list's `id`.","in":"path","name":"revision","required":true,"schema":{"minimum":1,"type":"integer"}}],"post":{"description":"Restores a revision as a new revision: a hook the old revision did not have is cleared. The restore is checked, tested and applied like any save, and answers the same.\n","operationId":"restoreSiteNginxRevision","requestBody":{"content":{"application/json":{"examples":{"restore":{"summary":"Restore the revision with a note","value":{"note":"Back to the rules of 28 September","version":2}}},"schema":{"$ref":"#/components/schemas/NginxRevisionRevert"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"operation":null,"revision":null},"schema":{"$ref":"#/components/schemas/NginxSaveResult"}}},"description":"The revision holds what the site already has. Nothing was started."},"201":{"content":{"application/json":{"examples":{"queued":{"summary":"The restore waits for the site's window","value":{"item_id":77,"operation":null,"queued":true,"revision":null,"window_date":"2026-11-07"}},"started":{"summary":"The restore started","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:40Z","completed_at":null,"created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"Saved","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Saving change","step":"saved","steps":[{"key":"tested","label":"Tested","state":"done"},{"key":"saved","label":"Saved","state":"current"},{"key":"sent","label":"Sent to the site","state":"todo"},{"key":"reloaded","label":"Nginx reloaded","state":"todo"},{"key":"checked","label":"Checked","state":"todo"},{"key":"verified","label":"Verified","state":"todo"}],"subject":null,"summary":"Nginx rules","to_version":null,"type":"nginx_rules_change","type_label":"Nginx rules"},"revision":{"id":318,"number":3,"status":"saving"}}}},"schema":{"$ref":"#/components/schemas/NginxSaveResult"}}},"description":"The restore was saved as a new revision. Follow `operation`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"conflict":{"summary":"Another change to the platform landed first","value":{"code":"conflict","message":"Another change landed first. Reload and try again.","reason":"conflict"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"restore_running":{"summary":"A restore is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"stale":{"summary":"The rules changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The request was refused because of the site's state. `reason` says why: `stale` (the rules changed since your read: read them again and send the new `version`), `busy` or `change_pending` (another change is running or waiting), `restore_running`, `command_running` or `deployment_running` (a restore, a command or a deployment is running on the site), `conflict` (another change to the platform landed first: send the request again), `cluster_paused`, `cluster_not_ready` or `cluster_deleting` (the site's cluster cannot take changes at the moment), or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The change cannot wait for a window at the moment","value":{"code":"feature_off","message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}},"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"version":["version is a whole number."]},"field":"version","message":"version is a whole number.","reason":"invalid"}},"nginx_invalid":{"summary":"The rules break the policy","value":{"code":"nginx_invalid","diagnostics":[{"code":"root_outside_webroot","column":5,"hook":"server","line":4,"message":"Rules can serve files from the web root only.","severity":"error","source":"policy"}],"message":"These nginx rules cannot be saved: fix the errors shown.","reason":"nginx_invalid"}},"nginx_rules_locked":{"summary":"Corefinity has locked the site's Nginx rules","value":{"code":"nginx_rules_locked","diagnostics":[],"message":"Corefinity has locked this environment's nginx rules. Contact support to change them.","reason":"nginx_rules_locked"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `nginx_invalid` (the rules break the policy; `diagnostics` lists each problem), `nginx_test_failed` (the rules failed the test on the site's own Nginx; `diagnostics`), `hook_unavailable` (the site cannot use that hook yet), `nginx_rules_locked` (Corefinity manages the site's Nginx rules), or `feature_off` when `apply` asks for a window and changes cannot wait for one at the moment."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the API's general limit, or the 20 saves a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."},"500":{"$ref":"#/components/responses/NginxPlatformUnreadable"},"502":{"$ref":"#/components/responses/NginxChangeNotSaved"},"503":{"$ref":"#/components/responses/NginxConfigurationUnreadable"}},"summary":"Restore an Nginx revision","tags":["Web server rules"],"x-effect":["changes-settings","overwrites"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-long-running":"getSiteNginxOperation","x-rate-limit":{"also":[{"bucket":"corecluster-nginx-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/snippets":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Lists ready-made rules for the site's platform, each with the hook it belongs in and the values to fill in.\n","operationId":"listSiteNginxSnippets","responses":{"200":{"content":{"application/json":{"example":{"snippets":[{"available":true,"category":"security","description":"Answers 403 for every path that starts with one of the listed names.","id":"block-paths","needs":[],"parts":[{"content":"location ~ ^/(?:{{paths}})(?:/|$) {\n    return 403;\n}\n","hook":"server","placement":"cursor"}],"placeholders":[{"default":"private|internal","kind":"regex","label":"Paths (separated by |, no leading /)","name":"paths","validate":"^[A-Za-z0-9._\\-|/\\\\]+$"}],"platforms":["wordpress","magento2","laravel","php"],"requires":[],"title":"Block paths"}]},"schema":{"properties":{"snippets":{"items":{"$ref":"#/components/schemas/NginxSnippet"},"type":"array"}},"required":["snippets"],"type":"object"}}},"description":"The snippets. The list is shortened here."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List ready-made Nginx rules","tags":["Web server rules"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"bucket":"corecluster-nginx-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/tests/{test}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of a test run, from a check's `test.id`.","in":"path","name":"test","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers a test run's state. Read it again until `status` is no longer `queued` or `running`.\n","operationId":"getSiteNginxTest","responses":{"200":{"content":{"application/json":{"example":{"diagnostics":[],"duration_ms":4000,"finished_at":"2026-11-06T09:16:44Z","id":9,"output":"nginx: configuration file test is successful","reason":null,"started_at":"2026-11-06T09:16:40Z","status":"passed"},"schema":{"$ref":"#/components/schemas/NginxTestRun"}}},"description":"The test run."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an Nginx test run","tags":["Web server rules"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"bucket":"corecluster-nginx-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/nginx-rules/validate":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Checks the hooks sent in `content` against the policy; a hook left out is the saved one. When there are no errors the rules are also tested with the site's own Nginx, unless `sandbox` is false: `test` names the run, and reading it answers its result. Nothing is saved.\n","operationId":"checkSiteNginxRules","requestBody":{"content":{"application/json":{"examples":{"check_a_hook":{"summary":"Check the server hook and test it","value":{"content":{"server":"location = /private-report.pdf {\n    return 404;\n}\n"}}},"path_apps":{"summary":"Check a list of path apps and show the Nginx written for it","value":{"path_apps":[{"id":"a1","label":"Blog admin","php":{"dir_index":["wp-admin/"],"entries":["wp-admin/*.php","wp-login.php"],"router":["wp-json/"]},"prefix":"/wp/","preset":"wordpress-admin","root":"htdocs","type":"php-app"}],"render":true,"sandbox":false}},"without_the_test":{"summary":"Check against the policy only","value":{"content":{"server":"location = /private-report.pdf {\n    return 404;\n}\n"},"sandbox":false}}},"schema":{"$ref":"#/components/schemas/NginxRulesCheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"passes":{"summary":"The rules pass and a test run started","value":{"diagnostics":[],"policy_version":6,"test":{"id":9,"status":"queued"}}},"refused":{"summary":"The policy refuses a line","value":{"diagnostics":[{"code":"redirect_in_rules","column":5,"hook":"server","line":4,"message":"Redirects go in Redirects.","severity":"error","source":"policy"}],"policy_version":6,"test":null}}},"schema":{"$ref":"#/components/schemas/NginxCheckResult"}}},"description":"What the check found. An empty `diagnostics` means the rules pass."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere","description":"The site is managed by another control panel (`managed_elsewhere`)."},"413":{"content":{"application/json":{"examples":{"too_large":{"summary":"The server hook is over 64 KB","value":{"code":"too_large","hook":"server","max_bytes":65536,"message":"The server hook is larger than 64 KB.","reason":"too_large"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"A hook is over its size limit (`too_large`). `hook` names it and `max_bytes` is the limit."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"`sandbox` is not true or false","value":{"code":"invalid","errors":{"sandbox":["sandbox is true or false."]},"field":"sandbox","message":"sandbox is true or false.","reason":"invalid"}},"nothing_sent":{"summary":"Nothing to check was sent","value":{"code":"invalid","errors":{"content":["Send the content of at least one hook."]},"field":"content","message":"Send the content of at least one hook.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`)."},"429":{"$ref":"#/components/responses/TooManyRequestsOrOwnBudget","description":"Too many requests (`rate_limited`): the endpoint's request limit, or the ten sandbox tests a minute this environment takes from the API, the Control Panel and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats."},"500":{"$ref":"#/components/responses/NginxPlatformUnreadable","description":"The platform did not answer while the site's files were being read for the test on the site's own Nginx. Nothing was tested. Send the request again in a minute, or send `sandbox` false to check against the policy only. The answer is a sentence only, with no `reason`."}},"summary":"Check Nginx rules without saving","tags":["Web server rules"],"x-effect":["none"],"x-feature":"nginx-rules","x-file":"nginx-rules","x-gates":["nginx_rules"],"x-rate-limit":{"also":[{"bucket":"corecluster-nginx-test","limit":10,"minutes":1,"per":"environment"}],"bucket":"corecluster-nginx-validate","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/node-runtime":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the site's Node.js: the version it runs, the versions it may move to, the global packages, follow mode,\nthe caches and any change still running. `revision` is the write token every change sends back. `refresh=1`\nreads the site's report again first, which runs a command on the site; only that read counts on the live\nbudget of 10 a minute, shared with the package check and the cache clear, and a spent budget answers `429`.\n","operationId":"getNodeRuntime","parameters":[{"description":"Send `1` to read the running site's report again before answering.","in":"query","name":"refresh","required":false,"schema":{"enum":["1","0","true","false"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"node":{"$ref":"#/components/examples/RuntimeNodeRuntimeExample"}},"schema":{"$ref":"#/components/schemas/RuntimeNodeRuntime"}}},"description":"The Node.js configuration."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Only with `refresh`. The site is not running (`not_running`), another command or change is running on it (`busy`), or an earlier command has not been confirmed stopped (`exec_unresolved`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/SiteCommandUnavailable"}},"summary":"Get a site's Node.js configuration","tags":["Node.js"],"x-feature":"node-runtime","x-file":"runtime","x-gates":["node_runtime"],"x-rate-limit":{"also":[{"bucket":"corecluster-node-live","limit":10,"minutes":1,"per":"person"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Changes the Node.js version, the global packages or follow mode: send the `revision` of your last read and\nwhat you change. A new package or a changed selector is pinned to the version it resolves to now on the public\nnpm registry. Answers `201` with the operation that applies the change, or `200` when nothing differs or only\nfollow mode changed. When the platform does not confirm the save, the `201` carries an operation that is still\n`pending`: follow it, and do not send the change again meanwhile.\n","operationId":"updateNodeRuntime","requestBody":{"content":{"application/json":{"examples":{"follow_repository":{"summary":"Follow the version the repository asks for","value":{"follow_repository":true,"revision":4}},"packages":{"summary":"Add a package with its install scripts on","value":{"packages":[{"name":"sass","selector":"latest"},{"name":"sharp","scripts":true,"selector":"0.34"},{"name":"typescript","scripts":true}],"revision":4}},"tonight":{"summary":"Queue a version change for the site's window","value":{"apply":"tonight","major":22,"revision":4}},"update":{"summary":"Look for a newer version of a package","value":{"revision":4,"update":["sass"]}},"version":{"summary":"Move to Node.js 22","value":{"major":22,"revision":4}}},"schema":{"$ref":"#/components/schemas/RuntimeNodeRuntimeUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"already_newest":{"summary":"Nothing newer matches the selector","value":{"node_runtime":{"adopted":true,"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"apply":{"error":null,"operation":null,"pending_tonight":null},"caches":null,"follow_repository":false,"last_applied_at":null,"limits":{"max_packages":20},"locked":null,"major":24,"memory":null,"options":[{"arrives_with":null,"available_on_this_row":true,"codename":"Krypton","default_for_new":true,"end_of_life_on":"2028-04-30","label":"Node.js 24","major":24,"needs_ack":[],"reason":null,"recommended":true,"selectable":true,"status":"maintenance_lts"},{"arrives_with":null,"available_on_this_row":true,"codename":"Jod","default_for_new":false,"end_of_life_on":"2027-04-30","label":"Node.js 22","major":22,"needs_ack":[],"reason":null,"recommended":false,"selectable":true,"status":"maintenance_lts"}],"packages":[{"advisories":{"critical":0,"high":0},"bins":[],"error":null,"has_install_script":null,"installed_version":null,"latest":null,"name":"sass","origin":"panel","resolved":"1.93.2","scripts":false,"selector":"latest","state":"pending","update_available":false,"wanted":null},{"advisories":{"critical":0,"high":0},"bins":[],"error":null,"has_install_script":null,"installed_version":null,"latest":null,"name":"sharp","origin":"panel","resolved":"0.34.4","scripts":true,"selector":"0.34","state":"pending","update_available":false,"wanted":null}],"repository":null,"revision":4,"status":{"end_of_life_on":"2028-04-30","key":"maintenance_lts","label":"Maintenance LTS"},"unmanaged":[],"version":null},"operation":null,"warnings":[{"code":"already_newest","message":"Already the newest that matches."}]}},"follow_repository":{"summary":"Only follow mode changed","value":{"node_runtime":{"adopted":true,"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"apply":{"error":null,"operation":null,"pending_tonight":null},"caches":null,"follow_repository":true,"last_applied_at":null,"limits":{"max_packages":20},"locked":null,"major":24,"memory":null,"options":[{"arrives_with":null,"available_on_this_row":true,"codename":"Krypton","default_for_new":true,"end_of_life_on":"2028-04-30","label":"Node.js 24","major":24,"needs_ack":[],"reason":null,"recommended":true,"selectable":true,"status":"maintenance_lts"},{"arrives_with":null,"available_on_this_row":true,"codename":"Jod","default_for_new":false,"end_of_life_on":"2027-04-30","label":"Node.js 22","major":22,"needs_ack":[],"reason":null,"recommended":false,"selectable":true,"status":"maintenance_lts"}],"packages":[{"advisories":{"critical":0,"high":0},"bins":[],"error":null,"has_install_script":null,"installed_version":null,"latest":null,"name":"sass","origin":"panel","resolved":"1.93.2","scripts":false,"selector":"latest","state":"pending","update_available":false,"wanted":null},{"advisories":{"critical":0,"high":0},"bins":[],"error":null,"has_install_script":null,"installed_version":null,"latest":null,"name":"sharp","origin":"panel","resolved":"0.34.4","scripts":true,"selector":"0.34","state":"pending","update_available":false,"wanted":null}],"repository":null,"revision":4,"status":{"end_of_life_on":"2028-04-30","key":"maintenance_lts","label":"Maintenance LTS"},"unmanaged":[],"version":null},"operation":null,"warnings":[]}}},"schema":{"$ref":"#/components/schemas/RuntimeNodeRuntimeChange"}}},"description":"Nothing differs, or only follow mode changed. `operation` is null."},"201":{"content":{"application/json":{"examples":{"queued":{"summary":"The change waits for the site's window","value":{"item_id":5120,"node_runtime":{"adopted":true,"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"apply":{"error":null,"operation":null,"pending_tonight":{"item_id":5120,"window_date":"2026-11-09"}},"caches":null,"follow_repository":false,"last_applied_at":null,"limits":{"max_packages":20},"locked":null,"major":24,"memory":null,"options":[{"arrives_with":null,"available_on_this_row":true,"codename":"Krypton","default_for_new":true,"end_of_life_on":"2028-04-30","label":"Node.js 24","major":24,"needs_ack":[],"reason":null,"recommended":true,"selectable":true,"status":"maintenance_lts"},{"arrives_with":null,"available_on_this_row":true,"codename":"Jod","default_for_new":false,"end_of_life_on":"2027-04-30","label":"Node.js 22","major":22,"needs_ack":[],"reason":null,"recommended":false,"selectable":true,"status":"maintenance_lts"}],"packages":[{"advisories":{"critical":0,"high":0},"bins":[],"error":null,"has_install_script":null,"installed_version":null,"latest":null,"name":"sass","origin":"panel","resolved":"1.93.2","scripts":false,"selector":"latest","state":"pending","update_available":false,"wanted":null},{"advisories":{"critical":0,"high":0},"bins":[],"error":null,"has_install_script":null,"installed_version":null,"latest":null,"name":"sharp","origin":"panel","resolved":"0.34.4","scripts":true,"selector":"0.34","state":"pending","update_available":false,"wanted":null}],"repository":null,"revision":4,"status":{"end_of_life_on":"2028-04-30","key":"maintenance_lts","label":"Maintenance LTS"},"unmanaged":[],"version":null},"operation":null,"queued":true,"warnings":[],"window_date":"2026-11-09"}},"started":{"$ref":"#/components/examples/RuntimeNodeRuntimeStartedExample"}},"schema":{"$ref":"#/components/schemas/RuntimeNodeRuntimeChange"}}},"description":"The change started (`operation`), or was queued for the site's window (`queued`)."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/RuntimeNodeChangeConflict"},"422":{"$ref":"#/components/responses/RuntimeNodeChangeInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/RuntimeNotSaved"},"503":{"$ref":"#/components/responses/RuntimeNodeUnavailable"}},"summary":"Update a site's Node.js configuration","tags":["Node.js"],"x-effect":["changes-settings","runs-code"],"x-feature":"node-runtime","x-file":"runtime","x-gates":["node_runtime"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-node-sets","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"The packages turn install scripts on (`scripts` is true) for a package that does not run them on that site now"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/node-runtime/apply-to":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Copies this site's Node.js version, packages or follow mode to other environments of the same site. The request\nis checked whole first, so a refusal applies nothing anywhere. Then each target is changed on its own: a part a\ntarget refuses is left out there while its other parts apply, and the other targets still go ahead.\n","operationId":"copyNodeRuntime","requestBody":{"content":{"application/json":{"examples":{"to_staging":{"summary":"Copy the version and the packages to staging","value":{"parts":["version","packages"],"targets":[1043]}}},"schema":{"$ref":"#/components/schemas/RuntimeNodeRuntimeCopyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"copied":{"summary":"Copied to one staging environment","value":{"changes":[{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-09T21:35:28Z","completed_at":null,"created_at":"2026-11-09T21:35:28Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"staging-harbourandfinch-example-com.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"Sent to the site","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1043},"status":"committed","status_label":"Waiting for the platform","step":"sent","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"sent","label":"Sent to the site","state":"current"},{"key":"switched","label":"Node.js switched","state":"todo"},{"key":"checked","label":"Checked","state":"todo"}],"subject":null,"summary":"Node.js configuration","to_version":null,"type":"node_runtime","type_label":"Node.js configuration"},"refused":null,"site_id":1043,"warnings":[]}]}}},"schema":{"$ref":"#/components/schemas/RuntimeNodeRuntimeCopy"}}},"description":"One entry for each target, in the order asked."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"422":{"$ref":"#/components/responses/RuntimeNodeCopyInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Copy Node.js configuration to other environments","tags":["Node.js"],"x-effect":["overwrites","runs-code"],"x-feature":"node-runtime","x-file":"runtime","x-gates":["node_runtime"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-node-sets","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"exec","when":"The copied packages turn install scripts on for a package that does not run them on a target now"}],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/node-runtime/caches/clear":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Clears the package caches named in `which`, or all four when it is left out, and answers the bytes each freed.\nGlobal packages and projects are untouched.\n","operationId":"clearNodeCaches","requestBody":{"content":{"application/json":{"examples":{"all":{"summary":"Clear all four caches","value":{}},"two":{"summary":"Clear the npm and yarn caches","value":{"which":["npm","yarn"]}}},"schema":{"$ref":"#/components/schemas/RuntimeNodeCachesClearRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"examples":{"cleared":{"summary":"Two caches cleared","value":{"cleared":{"corepack_bytes":0,"npm_bytes":301989888,"pnpm_bytes":0,"yarn_bytes":14680064}}}},"schema":{"$ref":"#/components/schemas/RuntimeNodeCachesCleared"}}},"description":"The bytes each cache freed. A cache that was not cleared reads 0."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/RuntimeNodeLiveConflict"},"422":{"$ref":"#/components/responses/RuntimeNodeArgumentsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/RuntimeNodeCheckFailed"},"503":{"$ref":"#/components/responses/SiteCommandUnavailable"}},"summary":"Clear a site's package caches","tags":["Node.js"],"x-effect":["deletes"],"x-feature":"node-runtime","x-file":"runtime","x-gates":["node_runtime","exec"],"x-rate-limit":{"bucket":"corecluster-node-live","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/node-runtime/packages/check":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Answers which global packages have a newer version within their selector or beyond it, and the security\nadvisories reported for the installed set. The check runs on the site and is recorded in its activity; nothing\ninstalled changes. The person needs to be able to change the site, although the token needs only `read`.\n","operationId":"checkNodePackages","responses":{"200":{"content":{"application/json":{"examples":{"checked":{"summary":"One advisory and nothing newer","value":{"advisories":[{"installed":"2.8.0","name":"svgo","severity":"high","title":"Prototype pollution","url":"https://example.com/advisories/GHSA-0000-0000-0000"}],"audit":"ok","outdated":[],"read_at":"2026-11-09T21:35:28Z"}}},"schema":{"$ref":"#/components/schemas/RuntimeNodePackagesCheck"}}},"description":"The packages with a newer version and the advisories."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/RuntimeNodeLiveConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/RuntimeNodeCheckFailed"},"503":{"$ref":"#/components/responses/SiteCommandUnavailable"}},"summary":"Check a site's packages for updates","tags":["Node.js"],"x-effect":["none"],"x-feature":"node-runtime","x-file":"runtime","x-gates":["node_runtime","exec"],"x-rate-limit":{"bucket":"corecluster-node-live","limit":10,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/operations":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the operations of a site or environment, newest first. Paged by cursor: send `next_cursor` back as\n`cursor`; null means the last page.\n","operationId":"listSiteOperations","parameters":[{"$ref":"#/components/parameters/cursorLimit"},{"$ref":"#/components/parameters/cursor"},{"description":"Only operations of these types, such as `php_version` or `url_change`. Up to 20.","in":"query","name":"types[]","required":false,"schema":{"items":{"type":"string"},"maxItems":20,"type":"array"}}],"responses":{"200":{"content":{"application/json":{"examples":{"page":{"$ref":"#/components/examples/OperationsPageExample"}},"schema":{"$ref":"#/components/schemas/OperationsPage"}}},"description":"A page of operations."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"cursor":["That page does not exist. Reload the list."]},"field":"cursor","message":"That page does not exist. Reload the list.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A parameter is wrong, such as a `cursor` the list did not give you, a `limit` over 100 or a type that does not exist."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's operations","tags":["Operations"],"x-feature":"operations","x-file":"operations","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/package":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Moves a site to a larger package, billed at the new price from the hour the change starts; a smaller package\nis arranged with support. `apply` chooses when: a change that waits answers `queued` with the `item` that\nwaits and no `operation` yet. Send a quote's `id` as `quote_id` to make the change only at the price you were\nshown.\n","operationId":"updateSitePackage","requestBody":{"content":{"application/json":{"examples":{"now":{"summary":"Move to CS8 now","value":{"confirm_domain":"harbourandfinch.example.com","package":"CS8"}},"tonight":{"summary":"Move to CS8 tonight","value":{"apply":"tonight","confirm_domain":"harbourandfinch.example.com","package":"CS8"}}},"schema":{"$ref":"#/components/schemas/UpgradeSitePackageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"queued":{"$ref":"#/components/examples/UpgradeSiteChangeQueuedExample"},"started":{"$ref":"#/components/examples/UpgradeSiteChangeStartedExample"}},"schema":{"$ref":"#/components/schemas/UpgradeSiteChange"}}},"description":"The change has started, or is queued, in which case `queued` is `true`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/UpgradeWriteForbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"downgrade":{"summary":"A smaller package","value":{"code":"downgrade","message":"Choose a larger package; downgrades are arranged with support","reason":"downgrade"}},"same_package":{"summary":"Already on that package","value":{"code":"same_package","message":"This is already the package","reason":"same_package"}},"stale":{"summary":"The price has moved since the quote","value":{"code":"stale","message":"Prices changed. Review the quote again.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was changed. `same_package`: the site is on that package. `downgrade`: the package is smaller.\n`stale`: the price has moved since the quote. `cluster_site`: the site is inside a CoreCluster, whose\npackage it takes. `no_payment_method`: the billing account has no card or mandate. `not_resizable`,\n`disk_not_growable`: the site's package or disk cannot be changed here: contact support.\n`compute_blocked`: there is no room for the larger package at the moment. `busy`, `snapshot_running`,\n`provisioning`, `deleted`: another change or a snapshot is running, or the site is being created or\ndeleted. `change_pending`: another change of yours already waits for the night: apply it now or cancel it.\n`demo_keep_required`: the site is a demo that has not been kept (the answer adds `keep_url` and `change`).\n`managed_elsewhere`: the site is managed by another control panel.\n"},"422":{"content":{"application/json":{"examples":{"apply":{"summary":"A way to apply that is not offered","value":{"code":"invalid","errors":{"apply":["The selected apply is invalid."]},"field":"apply","message":"The selected apply is invalid.","reason":"invalid"}},"confirm_mismatch":{"$ref":"#/components/examples/UpgradeConfirmDomainMismatchExample"},"confirm_missing":{"summary":"confirm_domain is missing","value":{"code":"invalid","errors":{"confirm_domain":["The confirm domain field is required."]},"field":"confirm_domain","message":"The confirm domain field is required.","reason":"invalid"}},"package_platform":{"summary":"A package the site's platform cannot run","value":{"code":"invalid","errors":{"package":["package_platform"]},"field":"package","message":"Magento 2 starts at CS4","reason":"invalid"}},"package_unknown":{"summary":"A package that does not exist","value":{"code":"invalid","errors":{"package":["Choose a package"]},"field":"package","message":"Choose a package","reason":"invalid"}},"tonight_off":{"summary":"Tonight, while changes cannot wait for the night","value":{"code":"feature_off","errors":{"apply":["Queuing changes for the maintenance window is switched off at the moment"]},"message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`confirm_mismatch`: `confirm_domain` is not the site's domain. `invalid`: a field is missing or wrong\n(`field` names it). On `package` that is a package that does not exist, one the site's platform cannot\nrun (its `errors` entry is the code `package_platform`), one too small for the site's data, or the id of\nan environment, which has no package of its own; on `apply`, `window` while maintenance windows are off.\n`feature_off`: `apply: tonight` while changes cannot wait for the night.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"not_saved":{"summary":"The platform did not save the change","value":{"message":"The change could not be saved. Contact support."}},"settings_unreadable":{"summary":"The site's settings could not be read","value":{"code":"upstream_unavailable","message":"The site's settings could not be read; try again shortly.","reason":"upstream_unavailable"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The platform did not answer, or did not save the change. Send the request again in a minute. When the\nsite's settings could not be read the answer is `upstream_unavailable`; when the change could not be\nsaved it is a sentence only, with no `reason`.\n"}},"summary":"Update a site's package","tags":["Packages and capacity"],"x-effect":["billable"],"x-feature":"upgrades","x-file":"upgrades","x-gates":["packages","billing"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-upgrades","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/pagespeed":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the Google PageSpeed Insights tests of the site's home page: the newest result for mobile and for\ndesktop, the tests queued or running, every finished test of the last 30 or 90 days, and whether a test can be\nrun now.\n","operationId":"getSitePageSpeed","parameters":[{"description":"How far back the history and the series go.","example":"30d","in":"query","name":"range","required":false,"schema":{"default":"30d","enum":["30d","90d"],"type":"string"}},{"description":"Keeps the history and the series of one strategy. Both when left out.","in":"query","name":"strategy","required":false,"schema":{"$ref":"#/components/schemas/PageSpeedStrategy"}}],"responses":{"200":{"content":{"application/json":{"example":{"enabled":true,"history":[{"cls":0.04,"error":null,"fcp_ms":1200,"fetched_at":"2026-11-09T13:00:00Z","id":6203,"inp_ms":180,"lcp_ms":2100,"performance_score":91,"requested_by":null,"speed_index_ms":2400,"status":"succeeded","strategy":"desktop","tbt_ms":150,"ttfb_ms":320},{"cls":0.04,"error":null,"fcp_ms":1200,"fetched_at":"2026-11-09T13:00:00Z","id":6202,"inp_ms":180,"lcp_ms":2100,"performance_score":72,"requested_by":null,"speed_index_ms":2400,"status":"succeeded","strategy":"mobile","tbt_ms":150,"ttfb_ms":320},{"cls":0.04,"error":null,"fcp_ms":1200,"fetched_at":"2026-11-02T13:00:00Z","id":6201,"inp_ms":180,"lcp_ms":2100,"performance_score":64,"requested_by":null,"speed_index_ms":2400,"status":"succeeded","strategy":"mobile","tbt_ms":150,"ttfb_ms":320}],"in_flight":[],"latest":{"desktop":{"created_at":"2026-11-09T13:00:00Z","diagnostics":null,"error":null,"fetched_at":"2026-11-09T13:00:00Z","field":null,"finished_at":"2026-11-09T13:00:00Z","id":6203,"lighthouse_version":"12.6.0","metrics":{"cls":{"band":"good","value":0.04},"fcp":{"band":"good","value_ms":1200},"inp":{"band":"good","source":"field","value_ms":180},"lcp":{"band":"good","value_ms":2100},"speed_index":{"band":"good","value_ms":2400},"tbt":{"band":"good","value_ms":150},"ttfb":{"band":"good","value_ms":320}},"opportunities":[],"requested_by":null,"score":{"band":"good","value":91},"started_at":"2026-11-09T13:00:00Z","status":"succeeded","status_label":"Done","strategy":"desktop","url":"https://harbourandfinch.example.com/"},"mobile":{"created_at":"2026-11-09T13:00:00Z","diagnostics":{"dom_size":1290,"resources":[{"requests":31,"transfer_bytes":768400,"type":"script"},{"requests":28,"transfer_bytes":652100,"type":"image"}],"third_party_bytes":412600,"total_requests":84,"total_transfer_bytes":1843200},"error":null,"fetched_at":"2026-11-09T13:00:00Z","field":{"cls":0.05,"fcp_ms":1400,"inp_ms":180,"lcp_ms":2300,"overall":"AVERAGE","source":"page","ttfb_ms":700},"finished_at":"2026-11-09T13:00:00Z","id":6202,"lighthouse_version":"12.6.0","metrics":{"cls":{"band":"good","value":0.04},"fcp":{"band":"good","value_ms":1200},"inp":{"band":"good","source":"field","value_ms":180},"lcp":{"band":"good","value_ms":2100},"speed_index":{"band":"good","value_ms":2400},"tbt":{"band":"good","value_ms":150},"ttfb":{"band":"good","value_ms":320}},"opportunities":[{"display_value":"Est savings of 212 KiB","id":"unused-javascript","savings_ms":450,"title":"Reduce unused JavaScript"},{"display_value":null,"id":"render-blocking-resources","savings_ms":300,"title":"Eliminate render-blocking resources"}],"requested_by":null,"score":{"band":"needs_improvement","value":72},"started_at":"2026-11-09T13:00:00Z","status":"succeeded","status_label":"Done","strategy":"mobile","url":"https://harbourandfinch.example.com/"}},"run_now":{"available":true,"next_at":null,"reason":null,"remaining_this_hour":2},"series":{"desktop":[{"at":"2026-11-09T13:00:00Z","run_id":6203,"score":91}],"failures":[],"from":"2026-10-11T13:00:00Z","mobile":[{"at":"2026-11-09T13:00:00Z","run_id":6202,"score":72},{"at":"2026-11-02T13:00:00Z","run_id":6201,"score":64}],"range":"30d","to":"2026-11-10T13:00:00Z"},"site":{"domain":"harbourandfinch.example.com","id":1042,"skipped":null,"tested_url":"https://harbourandfinch.example.com/"},"trend":{"desktop":{"current":null,"delta":null,"previous":null},"mobile":{"current":null,"delta":null,"previous":null}}},"schema":{"$ref":"#/components/schemas/PageSpeedHistory"}}},"description":"The history."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is deleted (`deleted`) or still being created (`provisioning`)."},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"range":["The selected range is invalid."]},"field":"range","message":"The selected range is invalid.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`range` or `strategy` is not one of its values. `field` names it."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's PageSpeed history","tags":["PageSpeed"],"x-feature":"pagespeed","x-file":"pagespeed","x-gates":["pagespeed"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/pagespeed/runs":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Queues a mobile and a desktop test of the site's home page; read the history again for the results, which are\nin once the tests have left `in_flight`. A site can start two tests an hour, only while it is live, and\nCorefinity keeps a daily budget of tests for everyone.\n","operationId":"startSitePageSpeedRun","responses":{"202":{"content":{"application/json":{"example":{"runs":[{"created_at":"2026-11-10T13:00:00Z","diagnostics":null,"error":null,"fetched_at":null,"field":null,"finished_at":null,"id":6207,"lighthouse_version":null,"metrics":{"cls":{"band":null,"value":null},"fcp":{"band":null,"value_ms":null},"inp":{"band":null,"source":null,"value_ms":null},"lcp":{"band":null,"value_ms":null},"speed_index":{"band":null,"value_ms":null},"tbt":{"band":null,"value_ms":null},"ttfb":{"band":null,"value_ms":null}},"opportunities":[],"requested_by":{"id":2042,"name":"Tom Harbour"},"score":{"band":null,"value":null},"started_at":null,"status":"queued","status_label":"Queued","strategy":"mobile","url":"https://harbourandfinch.example.com/"},{"created_at":"2026-11-10T13:00:00Z","diagnostics":null,"error":null,"fetched_at":null,"field":null,"finished_at":null,"id":6208,"lighthouse_version":null,"metrics":{"cls":{"band":null,"value":null},"fcp":{"band":null,"value_ms":null},"inp":{"band":null,"source":null,"value_ms":null},"lcp":{"band":null,"value_ms":null},"speed_index":{"band":null,"value_ms":null},"tbt":{"band":null,"value_ms":null},"ttfb":{"band":null,"value_ms":null}},"opportunities":[],"requested_by":{"id":2042,"name":"Tom Harbour"},"score":{"band":null,"value":null},"started_at":null,"status":"queued","status_label":"Queued","strategy":"desktop","url":"https://harbourandfinch.example.com/"}]},"schema":{"$ref":"#/components/schemas/PageSpeedRunsStarted"}}},"description":"Both tests are queued."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"A test is already running","value":{"code":"busy","message":"A PageSpeed test is already running for this site.","reason":"busy"}},"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"preview_only":{"summary":"The site is not live yet","value":{"code":"preview_only","message":"This site is not live yet. Take it live first.","reason":"preview_only"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}},"removed":{"summary":"The site has been removed","value":{"code":"removed","message":"This site has been removed","reason":"removed"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"A test is already queued or running for the site (`busy`), the site is not live yet (`preview_only`), or it is deleted (`deleted`), removed (`removed`) or still being created (`provisioning`)."},"422":{"content":{"application/json":{"examples":{"maintenance":{"summary":"The site is in maintenance mode","value":{"code":"maintenance","message":"In maintenance mode; tests resume when it is switched off.","reason":"maintenance"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is in maintenance mode (`maintenance`): tests resume when it is switched off."},"429":{"content":{"application/json":{"examples":{"budget":{"summary":"Today's budget is used up","value":{"code":"rate_limited","message":"Today's PageSpeed budget is used up. Try again tomorrow.","next_at":"2026-11-11T00:00:00Z","reason":"rate_limited"}},"hourly":{"summary":"Two tests this hour already","value":{"code":"rate_limited","message":"Two runs an hour per site. Try again at 14:00","next_at":"2026-11-10T14:00:00Z","reason":"rate_limited"}},"requests":{"summary":"Too many requests in a minute","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests in a minute, two tests this hour already, or today's budget is used up. All are `rate_limited` and send `Retry-After`; the last two say when a test is possible again in `next_at`.\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"503":{"content":{"application/json":{"example":{"code":"switched_off","message":"PageSpeed Insights is switched off","reason":"switched_off"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has switched PageSpeed tests off for the moment (`switched_off`). Try again later."}},"summary":"Start a PageSpeed test","tags":["PageSpeed"],"x-effect":["none"],"x-feature":"pagespeed","x-file":"pagespeed","x-gates":["pagespeed"],"x-long-running":"getSitePageSpeed","x-rate-limit":{"also":[{"bucket":"pagespeed-runs","limit":2,"minutes":60,"per":"environment"}],"bucket":"reseller-pagespeed","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/pending-changes":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the changes waiting for the site's maintenance window, the window itself and whether they can be applied now.\n","operationId":"listSitePendingChanges","responses":{"200":{"content":{"application/json":{"examples":{"one_change":{"$ref":"#/components/examples/PendingChangesExample"}},"schema":{"$ref":"#/components/schemas/PendingChanges"}}},"description":"The pending changes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's pending changes","tags":["Pending changes"],"x-feature":"pending-changes","x-file":"operations","x-gates":["restart_batches"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/pending-changes/apply-now":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Applies every pending change of the site now, together, instead of in its window. Answers the operation to follow.\n","operationId":"applySitePendingChangesNow","requestBody":{"content":{"application/json":{"examples":{"confirm":{"summary":"Apply every pending change now","value":{"confirm":true}}},"schema":{"$ref":"#/components/schemas/PendingChangesApplyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"started":{"$ref":"#/components/examples/PendingChangesAppliedExample"}},"schema":{"$ref":"#/components/schemas/PendingChangesApplied"}}},"description":"The operation applying them."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"batch_held":{"value":{"code":"batch_held","message":"These changes are on hold.","reason":"batch_held"}},"batch_window":{"value":{"code":"batch_window","message":"These changes apply in tonight’s maintenance window.","reason":"batch_window"}},"busy":{"value":{"code":"busy","message":"The scheduled changes are being applied now.","reason":"busy"}},"managed_elsewhere":{"value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"nothing_pending":{"value":{"code":"nothing_pending","message":"Nothing is waiting for tonight.","reason":"nothing_pending"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The changes cannot be applied now. `reason` says why, among them `nothing_pending`, `busy` (they are being\napplied), `batch_window` (they wait for the window), `batch_held` and `managed_elsewhere`.\n"},"422":{"content":{"application/json":{"example":{"code":"confirm","message":"Confirm that the pending changes may be applied now.","reason":"confirm"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The body did not carry `confirm` as true (`confirm`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Apply a site's pending changes now","tags":["Pending changes"],"x-effect":["changes-settings","runs-code"],"x-feature":"pending-changes","x-file":"operations","x-gates":["restart_batches"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-pending","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/pending-changes/{item}":{"parameters":[{"$ref":"#/components/parameters/site"},{"$ref":"#/components/parameters/item"}],"delete":{"description":"Withdraws one change you asked for before its window takes it, and answers the pending changes without it.\n","operationId":"cancelSitePendingChange","responses":{"200":{"content":{"application/json":{"examples":{"withdrawn":{"$ref":"#/components/examples/PendingChangeWithdrawnExample"}},"schema":{"$ref":"#/components/schemas/PendingChangeWithdrawn"}}},"description":"The pending changes without it."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"A billing change that is the paying company's to withdraw","value":{"code":"forbidden","message":"Billing for this site is Harbour & Finch's.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), two-factor authentication is required and not set up\n(`two_factor_required`), or the change is a billing change, which only the company that pays for the site\nmay withdraw (`forbidden`).\n"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"item_state":{"value":{"code":"item_state","message":"This change can no longer be cancelled.","reason":"item_state"}},"managed_elsewhere":{"value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change was already applied or withdrawn, is not one of yours, or its window has started (`item_state`), or the site is managed by another control panel (`managed_elsewhere`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Cancel a pending change","tags":["Pending changes"],"x-effect":["changes-settings"],"x-feature":"pending-changes","x-file":"operations","x-gates":["restart_batches"],"x-rate-limit":{"bucket":"corecluster-pending","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/php-runtime":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the site's PHP: the versions it may move to, the extensions, the settings with their bounds, PHP-FPM,\nXdebug, the custom php.ini, warnings and any change still running. `version` is the write token every change\nsends back.\n","operationId":"getPhpRuntime","responses":{"200":{"content":{"application/json":{"examples":{"on_the_runtime":{"$ref":"#/components/examples/RuntimePhpRuntimeExample"}},"schema":{"$ref":"#/components/schemas/RuntimePhpRuntime"}}},"description":"The PHP configuration."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's PHP configuration","tags":["PHP"],"x-feature":"php-runtime","x-file":"runtime","x-gates":["php_runtime"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Changes the extensions, the settings, PHP-FPM, Xdebug or the custom php.ini. Send the `version` of your last\nread and only the parts you change: a part you leave out stays as it is. `extensions`, `xdebug` and\n`custom_ini` replace that part whole. `settings` and `fpm` are merged into what the site has: an entry you\nleave out keeps its value, and null puts one back to its default. Answers `201` with the operation that applies\nthe change, or `200` when nothing differs. When the platform does not confirm the save, the `201` carries an\noperation that is still `pending`: follow it, and do not send the change again meanwhile.\n","operationId":"updatePhpRuntime","requestBody":{"content":{"application/json":{"examples":{"extensions":{"summary":"Choose the optional extensions","value":{"extensions":["imagick","redis"],"version":12}},"fpm":{"summary":"Change PHP-FPM","value":{"fpm":{"max_requests":500,"pm":"ondemand","process_idle_timeout":20},"version":12}},"settings_and_ini":{"summary":"Change a directive and the custom php.ini","value":{"custom_ini":"realpath_cache_size = 16M\n","settings":{"max_input_vars":30000},"version":12}},"tonight":{"summary":"Queue a change for the site's window","value":{"apply":"tonight","settings":{"max_input_vars":30000},"version":12}},"unchanged":{"summary":"Values the site already has","value":{"settings":{"max_input_vars":20000},"version":12}},"xdebug":{"summary":"Set up Xdebug on a staging environment","value":{"version":12,"xdebug":{"idekey":"PHPSTORM","mode":"debug","start_with_request":"trigger"}}}},"schema":{"$ref":"#/components/schemas/RuntimePhpRuntimeUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"unchanged":{"$ref":"#/components/examples/RuntimePhpRuntimeUnchangedExample"}},"schema":{"$ref":"#/components/schemas/RuntimePhpRuntimeChange"}}},"description":"Nothing differs from what the site has. `operation` is null."},"201":{"content":{"application/json":{"examples":{"queued":{"$ref":"#/components/examples/RuntimePhpRuntimeQueuedExample"},"started":{"$ref":"#/components/examples/RuntimePhpRuntimeStartedExample"}},"schema":{"$ref":"#/components/schemas/RuntimePhpRuntimeChange"}}},"description":"The change started (`operation`), or was queued for the site's window (`queued`)."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/RuntimePhpChangeConflict"},"422":{"$ref":"#/components/responses/RuntimePhpChangeInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/RuntimeNotSaved"},"503":{"$ref":"#/components/responses/RuntimePhpChangesPaused"}},"summary":"Update a site's PHP configuration","tags":["PHP settings"],"x-effect":["changes-settings"],"x-feature":"php-settings","x-file":"runtime","x-gates":["php_runtime"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-php-sets","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/php-runtime/apply-to":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Copies this site's PHP configuration, without Xdebug, to other environments of the same site. The request is\nchecked whole first, so a refusal applies nothing anywhere; then each target is changed on its own, and the\nanswer has one entry for each in the order asked.\n","operationId":"copyPhpRuntime","requestBody":{"content":{"application/json":{"examples":{"to_staging":{"summary":"Copy the settings and the php.ini to staging","value":{"parts":["settings","ini"],"targets":[1043]}}},"schema":{"$ref":"#/components/schemas/RuntimePhpRuntimeCopyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"copied":{"summary":"Copied to one staging environment","value":{"changes":[{"adopting":false,"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-09T21:35:24Z","completed_at":null,"created_at":"2026-11-09T21:35:24Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com--staging","hostname":"staging-harbourandfinch-example-com.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"Picked up by PHP","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1043},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by PHP","state":"current"},{"key":"healthy","label":"Requests answered","state":"todo"}],"subject":null,"summary":"PHP configuration","to_version":null,"type":"php_runtime","type_label":"PHP configuration"},"refused":null,"site_id":1043,"warnings":[]}]}}},"schema":{"$ref":"#/components/schemas/RuntimePhpRuntimeCopy"}}},"description":"One entry for each target, in the order asked."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"422":{"$ref":"#/components/responses/RuntimePhpCopyInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Copy PHP configuration to other environments","tags":["PHP"],"x-effect":["overwrites"],"x-feature":"php-runtime","x-file":"runtime","x-gates":["php_runtime"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-php-sets","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/php-runtime/effective":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the values PHP runs with on the site: the command line measured on the site, the web side and any\n`.user.ini` calculated, with directives that hold secrets masked by name. The site must be on the runtime and\nrunning. Try-it is off because the read runs a command on the site.\n","operationId":"getPhpEffectiveConfiguration","responses":{"200":{"content":{"application/json":{"examples":{"effective":{"summary":"The command line measured, the web side calculated","value":{"cli":{"extensions":[{"name":"Core","version":"8.4.13"},{"name":"redis","version":"6.3.0"}],"ini":[{"layer":"image","measured":false,"name":"auto_prepend_file","value":""},{"layer":"platform","measured":false,"name":"display_errors","value":""},{"layer":"image","measured":true,"name":"max_execution_time","value":"0"},{"layer":"form","measured":true,"name":"max_input_vars","value":"20000"},{"layer":"form","measured":true,"name":"memory_limit","value":"512M"},{"layer":"ini","measured":true,"name":"realpath_cache_size","value":"8M"},{"layer":"image","measured":false,"name":"session.auto_start","value":"0"},{"layer":"form","measured":true,"name":"upload_max_filesize","value":"256M"}],"php_version":"8.4.13"},"fpm":{"extensions":[{"name":"Core","version":"8.4.13"},{"name":"redis","version":"6.3.0"}],"ini":[{"layer":"image","measured":false,"name":"auto_prepend_file","value":""},{"layer":"pool","measured":false,"name":"display_errors","value":""},{"layer":"form","measured":false,"name":"max_execution_time","value":"300"},{"layer":"form","measured":false,"name":"max_input_vars","value":"20000"},{"layer":"form","measured":false,"name":"memory_limit","value":"512M"},{"layer":"ini","measured":false,"name":"realpath_cache_size","value":"8M"},{"layer":"image","measured":false,"name":"session.auto_start","value":"0"},{"layer":"form","measured":false,"name":"upload_max_filesize","value":"256M"}],"php_version":"8.4.13"},"read_at":"2026-11-09T21:35:22Z","tools":[{"name":"7-Zip","version":"25.01"},{"name":"avifenc","version":"1.2.1"}],"user_ini":{"lines":[],"path":"htdocs/.user.ini"}}}},"schema":{"$ref":"#/components/schemas/RuntimePhpEffective"}}},"description":"The effective configuration."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/RuntimeLiveConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/RuntimeUpstreamUnavailable"},"503":{"$ref":"#/components/responses/SiteCommandUnavailable","description":"The read runs a command on the site, and Corefinity has switched commands on sites off for the moment\n(`switched_off`), the site's cluster could not be reached (`connect_failed`), or the site's files could not\nbe read (`temporarily_unavailable`). Try again later.\n"}},"summary":"Get what PHP runs with","tags":["PHP settings"],"x-feature":"php-settings","x-file":"runtime","x-gates":["php_runtime"],"x-rate-limit":{"bucket":"corecluster-php-live","limit":20,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/php-runtime/history":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers every change of the site's PHP configuration, newest first: who made it, how, what changed and whether\nit applied. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.\n","operationId":"listPhpRuntimeHistory","parameters":[{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"content":{"application/json":{"examples":{"history":{"summary":"One page of changes","value":{"next_cursor":null,"revisions":[{"actor":{"kind":"corefinity"},"at":"2026-11-09T21:35:23Z","current":false,"revision":5,"source":"panel","status":"applied","summary":"Starting configuration"}]}}},"schema":{"$ref":"#/components/schemas/RuntimePhpHistory"}}},"description":"A page of changes and the cursor of the next page."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"422":{"content":{"application/json":{"examples":{"cursor":{"summary":"A cursor this list never answered","value":{"code":"invalid","diagnostics":[],"errors":[{"code":"invalid","field":"cursor","message":"cursor is a next_cursor this list answered."}],"field":"cursor","message":"cursor is a next_cursor this list answered.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/RuntimePhpInvalidRefusal"}}},"description":"The `cursor` is not one this list answered (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's PHP changes","tags":["PHP"],"x-feature":"php-runtime","x-file":"runtime","x-gates":["php_runtime"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/php-runtime/history/{revision}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The number of a change, as the history lists it. Digits only.","example":5,"in":"path","name":"revision","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers the configuration a change left, in the units a change sends, so it can be compared or restored.","operationId":"getPhpRuntimeRevision","responses":{"200":{"content":{"application/json":{"examples":{"revision":{"summary":"The configuration change 5 left","value":{"revision":5,"state":{"custom_ini":null,"extensions":[],"fpm":{"max_requests":null,"pm":null,"process_idle_timeout":null},"settings":{"max_execution_time":300,"max_input_vars":20000,"memory_limit":536870912,"upload_max_filesize":268435456},"xdebug":null}}}},"schema":{"$ref":"#/components/schemas/RuntimePhpRevision"}}},"description":"The configuration of that change."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"No such site or change","value":{"message":"Not found."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/FeatureOffRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site or the change does not exist or is not yours to see, or PHP configuration is not on for your company (`feature_off`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get one earlier PHP configuration","tags":["PHP"],"x-feature":"php-runtime","x-file":"runtime","x-gates":["php_runtime"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/php-runtime/requirements":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers what the application asks of PHP, as last read from the site, with any extensions it needs that are not\nloaded and whether the PHP version is outside the range it accepts. `refresh=1` reads the site again first, at\nmost once every ten minutes. Try-it is off because that read runs a command on the site.\n","operationId":"getPhpRequirements","parameters":[{"description":"Send `1` to read the running site again before answering.","in":"query","name":"refresh","required":false,"schema":{"enum":["1","0","true","false"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"read":{"summary":"A WordPress site that needs an extension that is off","value":{"application":{"name":"WordPress","version":"6.8.3"},"ext":{"by":{"imagick":["wordpress"]},"required":["ext-json","ext-mysqli","ext-imagick"]},"missing_extensions":["imagick"],"outside_range":false,"php":{"constraint":">=7.4","packages":[],"range":"8.4"},"read_at":"2026-11-08T09:16:40Z","source":"probe"}}},"schema":{"$ref":"#/components/schemas/RuntimePhpRequirements"}}},"description":"The requirements. Every field is null or empty until the site has been read once."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"layout_unknown":{"summary":"Files that are not laid out as a deployed release","value":{"code":"layout_unknown","message":"The site's htdocs is not a release the control panel deployed, so the application's requirements cannot be read from it.","reason":"layout_unknown"}},"not_running":{"summary":"The site is not running","value":{"code":"not_running","message":"The site is not running","reason":"not_running"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Only with `refresh`. The site is not running (`not_running`), an earlier command on it has not been\nconfirmed stopped (`exec_unresolved`), or its files are not laid out as a release the Control Panel\ndeployed, so the requirements cannot be read (`layout_unknown`).\n"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Only with `refresh`. The application's requirements could not be read from its files (`requirements_unreadable`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/SiteCommandUnavailable","description":"The read runs a command on the site, and Corefinity has switched commands on sites off for the moment\n(`switched_off`), the site's cluster could not be reached (`connect_failed`), or the site's files could not\nbe read (`temporarily_unavailable`). Try again later.\n"}},"summary":"Get what the application needs from PHP","tags":["PHP"],"x-feature":"php-runtime","x-file":"runtime","x-gates":["php_runtime"],"x-rate-limit":{"bucket":"corecluster-php-requirements","limit":20,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/php-runtime/revert":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Applies the configuration of an earlier change again as a new change, checked against today's PHP and bounds.\nAnswers as a change does.\n","operationId":"restorePhpRuntimeRevision","requestBody":{"content":{"application/json":{"examples":{"revert":{"summary":"Restore change 5","value":{"revision":5,"version":12}}},"schema":{"$ref":"#/components/schemas/RuntimePhpRuntimeRevertRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"unchanged":{"$ref":"#/components/examples/RuntimePhpRuntimeUnchangedExample"}},"schema":{"$ref":"#/components/schemas/RuntimePhpRuntimeChange"}}},"description":"The site already has that configuration. `operation` is null."},"201":{"content":{"application/json":{"examples":{"started":{"$ref":"#/components/examples/RuntimePhpRuntimeRevertedExample"}},"schema":{"$ref":"#/components/schemas/RuntimePhpRuntimeChange"}}},"description":"The restore started (`operation`), or was queued for the site's window (`queued`)."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/FeatureOffRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site or the change does not exist or is not yours to change, or PHP configuration is not on for your company (`feature_off`)."},"409":{"$ref":"#/components/responses/RuntimePhpChangeConflict"},"422":{"$ref":"#/components/responses/RuntimePhpChangeInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/RuntimeNotSaved"},"503":{"$ref":"#/components/responses/RuntimePhpChangesPaused"}},"summary":"Restore a PHP configuration revision","tags":["PHP"],"x-effect":["overwrites"],"x-feature":"php-runtime","x-file":"runtime","x-gates":["php_runtime"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-php-sets","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/php-runtime/test":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Starts the site's own PHP once on its command line with the candidate php.ini, with every way of running site\ncode switched off, and answers whether PHP started, what it printed and the value it took for each directive.\nA php.ini with an error is refused `ini_invalid` and nothing runs. Nothing is saved.\n","operationId":"testPhpIni","requestBody":{"content":{"application/json":{"examples":{"candidate":{"summary":"Test a php.ini","value":{"custom_ini":"realpath_cache_size = 16M\n"}}},"schema":{"$ref":"#/components/schemas/RuntimePhpIniTestRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"PHP started with the candidate","value":{"completed":true,"effective":[{"directive":"max_execution_time","measured":true,"value":"0"},{"directive":"max_input_vars","measured":true,"value":"20000"},{"directive":"max_memory_limit","measured":false,"value":null},{"directive":"memory_limit","measured":true,"value":"512M"},{"directive":"post_max_size","measured":false,"value":null},{"directive":"realpath_cache_size","measured":true,"value":"8M"},{"directive":"upload_max_filesize","measured":true,"value":"256M"}],"startup":[]}}},"schema":{"$ref":"#/components/schemas/RuntimePhpIniTest"}}},"description":"The test ran. `completed` is false when PHP did not start with the candidate."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/RuntimeLiveConflict"},"422":{"$ref":"#/components/responses/RuntimePhpIniInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/RuntimeUpstreamUnavailable"},"503":{"$ref":"#/components/responses/SiteCommandUnavailable"}},"summary":"Test a php.ini","tags":["PHP settings"],"x-effect":["runs-code"],"x-feature":"php-settings","x-file":"runtime","x-gates":["php_runtime","php_ini"],"x-rate-limit":{"bucket":"corecluster-php-test","limit":10,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/php-runtime/validate":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Checks a custom php.ini against the configuration a save would have, or against the draft `settings` and\n`extensions` you send. Nothing is saved and nothing runs on the site. The token needs only `read`, but the\nperson must be able to change the site.\n","operationId":"checkPhpIni","requestBody":{"content":{"application/json":{"examples":{"locked_directive":{"summary":"A directive the platform keeps fixed","value":{"custom_ini":"\nopen_basedir = /\n"}},"valid":{"summary":"A php.ini with no problems","value":{"custom_ini":"realpath_cache_size = 16M\n"}},"with_draft":{"summary":"Checked against draft settings and extensions","value":{"custom_ini":"memory_limit = 768M\n","extensions":["redis"],"settings":{"max_input_vars":30000}}}},"schema":{"$ref":"#/components/schemas/RuntimePhpIniCheckRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"locked_directive":{"summary":"A directive the platform keeps fixed","value":{"diagnostics":[{"code":"locked","column":1,"end_column":16,"line":2,"message":"open_basedir: The platform sets the paths PHP serves.","severity":"error"}],"effective":[{"after":"/","before":null,"directive":"open_basedir","layer":"image"}],"ok":false}},"valid":{"summary":"A php.ini with no problems","value":{"diagnostics":[],"effective":[{"after":"16M","before":"8M","directive":"realpath_cache_size","layer":"custom"}],"ok":true}}},"schema":{"$ref":"#/components/schemas/RuntimePhpIniCheck"}}},"description":"The check. `ok` is false when a diagnostic is an error."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/ManagedElsewhere"},"422":{"$ref":"#/components/responses/RuntimePhpBodyInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Check a php.ini","tags":["PHP settings"],"x-effect":["none"],"x-feature":"php-settings","x-file":"runtime","x-gates":["php_runtime","php_ini"],"x-rate-limit":{"bucket":"corecluster-php-validate","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/php-settings":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the site's memory limit, upload size and execution time, each with the bounds of the site's platform\nand size, and the `version` a change sends back.\n","operationId":"getPhpSettings","responses":{"200":{"content":{"application/json":{"examples":{"settings":{"$ref":"#/components/examples/RuntimePhpSettingsExample"}},"schema":{"$ref":"#/components/schemas/RuntimePhpSettings"}}},"description":"The three settings and their bounds."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/RuntimePhpSettingsLifecycle"},"422":{"content":{"application/json":{"examples":{"not_available":{"summary":"A site with a custom size","value":{"code":"not_available","message":"PHP settings cannot be shown for this site. Contact support.","reason":"not_available"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The settings cannot be shown for this site (`not_available`), because it has a custom size with no bounds to offer."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get memory, upload and execution limits","tags":["PHP settings"],"x-feature":"php-settings","x-file":"runtime","x-gates":["php_settings"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Sets the memory limit, the upload size and the execution time, all three, within the site's bounds. Send the\n`version` of your last read. Answers `201` with the operation that applies them, `200` when nothing differs,\nor `202` while the platform has not yet confirmed the save.\n","operationId":"updatePhpSettings","requestBody":{"content":{"application/json":{"examples":{"longer_execution":{"summary":"Allow requests to run longer","value":{"max_execution_time_seconds":120,"memory_limit_bytes":536870912,"upload_max_filesize_bytes":268435456,"version":12}},"unchanged":{"summary":"The values the site already has","value":{"max_execution_time_seconds":300,"memory_limit_bytes":536870912,"upload_max_filesize_bytes":268435456,"version":12}}},"schema":{"$ref":"#/components/schemas/RuntimePhpSettingsUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"unchanged":{"summary":"Nothing differs","value":{"operation":null,"php_settings":{"apply":{"applied_at":null,"error":null,"operation":null,"state":"applied","state_label":"Applied"},"bounds":{"container_memory_limit_bytes":2617245696,"max_execution_time":{"options":[60,120,300]},"memory_headroom_bytes":268435456,"memory_limit":{"max":2147483648,"min":134217728,"step":67108864},"platform":"wordpress","post_max_size":{"max":1073741824,"min":2097152,"step":1048576},"tier":"M","upload_max_filesize":{"max":1073741824,"min":2097152,"step":1048576}},"container_memory_limit_bytes":2617245696,"notes":[],"php_version":"8.4","platform":"wordpress","settings":{"max_execution_time":{"default":300,"max":300,"min":60,"options":[60,120,300],"step":60,"unit":"seconds","value":300},"memory_limit":{"default":536870912,"max":2147483648,"min":134217728,"step":67108864,"unit":"bytes","value":536870912},"post_max_size":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456},"upload_max_filesize":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456}},"tier":"M","version":12}}}},"schema":{"$ref":"#/components/schemas/RuntimePhpSettingsChange"}}},"description":"Nothing differs from what the site has. `operation` is null."},"201":{"content":{"application/json":{"examples":{"started":{"summary":"The change started","value":{"operation":{"committed_at":"2026-11-09T21:35:24+00:00","completed_at":null,"created_at":"2026-11-09T21:35:24+00:00","error":null,"failure_reason":null,"from_version":null,"id":5121,"label":"Picked up by PHP","requested_by":{"id":2012,"name":"Daniel Reyes"},"result":null,"result_state":"none","status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by PHP","state":"current"},{"key":"healthy","label":"Requests answered","state":"todo"}],"to_version":null,"type":"php_runtime","type_label":"PHP configuration"},"php_settings":{"apply":{"applied_at":null,"error":null,"operation":null,"state":"applied","state_label":"Applied"},"bounds":{"container_memory_limit_bytes":2617245696,"max_execution_time":{"options":[60,120,300]},"memory_headroom_bytes":268435456,"memory_limit":{"max":2147483648,"min":134217728,"step":67108864},"platform":"wordpress","post_max_size":{"max":1073741824,"min":2097152,"step":1048576},"tier":"M","upload_max_filesize":{"max":1073741824,"min":2097152,"step":1048576}},"container_memory_limit_bytes":2617245696,"notes":[],"php_version":"8.4","platform":"wordpress","settings":{"max_execution_time":{"default":300,"max":300,"min":60,"options":[60,120,300],"step":60,"unit":"seconds","value":120},"memory_limit":{"default":536870912,"max":2147483648,"min":134217728,"step":67108864,"unit":"bytes","value":536870912},"post_max_size":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456},"upload_max_filesize":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456}},"tier":"M","version":13}}}},"schema":{"$ref":"#/components/schemas/RuntimePhpSettingsChange"}}},"description":"The change started (`operation`), or was queued for the site's window (`queued`)."},"202":{"content":{"application/json":{"example":{"operation":{"committed_at":null,"completed_at":null,"created_at":"2026-11-09T21:35:24+00:00","error":null,"failure_reason":null,"from_version":null,"id":5121,"label":"Saved","requested_by":{"id":2012,"name":"Daniel Reyes"},"result":null,"result_state":"none","status":"pending","status_label":"Saving change","step":"saved","steps":[{"key":"saved","label":"Saved","state":"current"},{"key":"applied","label":"Picked up by PHP","state":"todo"},{"key":"healthy","label":"Requests answered","state":"todo"}],"to_version":null,"type":"php_runtime","type_label":"PHP configuration"},"php_settings":{"apply":{"applied_at":null,"error":null,"operation":null,"state":"applied","state_label":"Applied"},"bounds":{"container_memory_limit_bytes":2617245696,"max_execution_time":{"options":[60,120,300]},"memory_headroom_bytes":268435456,"memory_limit":{"max":2147483648,"min":134217728,"step":67108864},"platform":"wordpress","post_max_size":{"max":1073741824,"min":2097152,"step":1048576},"tier":"M","upload_max_filesize":{"max":1073741824,"min":2097152,"step":1048576}},"container_memory_limit_bytes":2617245696,"notes":[],"php_version":"8.4","platform":"wordpress","settings":{"max_execution_time":{"default":300,"max":300,"min":60,"options":[60,120,300],"step":60,"unit":"seconds","value":120},"memory_limit":{"default":536870912,"max":2147483648,"min":134217728,"step":67108864,"unit":"bytes","value":536870912},"post_max_size":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456},"upload_max_filesize":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456}},"tier":"M","version":13}},"schema":{"$ref":"#/components/schemas/RuntimePhpSettingsChange"}}},"description":"The change was sent and its outcome is still being established: the operation is `pending`. Follow it by its `id`;\nit settles as saved or as failed within a few minutes. Do not send the change again meanwhile.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/RuntimePhpSettingsConflict"},"422":{"$ref":"#/components/responses/RuntimePhpSettingsInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/RuntimeNotSaved"},"503":{"content":{"application/json":{"examples":{"switched_off":{"summary":"PHP changes are paused","value":{"code":"switched_off","message":"PHP changes are paused while commands are switched off. Try again later.","reason":"switched_off"}},"unavailable":{"summary":"The site did not confirm the change","value":{"code":"unavailable","message":"The site did not confirm the change, so it was not saved. Try again in a minute: the next attempt puts the site in line first.","reason":"unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has paused PHP changes for the moment (`switched_off`), or the site did not confirm the change\n(`unavailable`). Nothing was saved; try again later.\n"}},"summary":"Update memory, upload and execution limits","tags":["PHP settings"],"x-effect":["changes-settings"],"x-feature":"php-settings","x-file":"runtime","x-gates":["php_settings"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-sets","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/php-version":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"Moves the site to another PHP version, one of the `versions` its PHP configuration lists as allowed. A version\nthat needs an acknowledgement, such as one past its end of life, is refused `ack_required` until you send it in\n`acknowledge`. Answers the operation that makes the change.\n","operationId":"updatePhpVersion","requestBody":{"content":{"application/json":{"examples":{"acknowledged":{"summary":"Move to a version past its end of life","value":{"acknowledge":["eol"],"to":"8.1"}},"newer":{"summary":"Move to PHP 8.4","value":{"to":"8.4"}},"tonight":{"summary":"Queue the move for the site's window","value":{"apply":"tonight","to":"8.4"}}},"schema":{"$ref":"#/components/schemas/RuntimePhpVersionChangeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"queued":{"summary":"The move waits for the site's window","value":{"item_id":5120,"operation":null,"queued":true,"window_date":"2026-11-09"}},"started":{"summary":"The change started","value":{"committed_at":"2026-11-09T21:35:25+00:00","completed_at":null,"created_at":"2026-11-09T21:35:25+00:00","error":null,"from_version":"8.3","id":5121,"requested_by":{"id":2012,"name":"Daniel Reyes"},"status":"committed","status_label":"Waiting for the platform","steps":[{"key":"saved","state":"done"},{"key":"applied","state":"current"},{"key":"restarted","state":"todo"},{"key":"healthy","state":"todo"}],"to_version":"8.4","type":"php_version","type_label":"PHP version"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/VersionChangeOperation"},{"$ref":"#/components/schemas/QueuedChange"}]}}},"description":"The change started (the operation), or was queued for the site's window (`queued`)."},"202":{"content":{"application/json":{"example":{"committed_at":null,"completed_at":null,"created_at":"2026-11-09T21:35:25+00:00","error":null,"from_version":"8.3","id":5121,"requested_by":{"id":2012,"name":"Daniel Reyes"},"status":"pending","status_label":"Saving change","steps":[{"key":"saved","state":"current"},{"key":"applied","state":"todo"},{"key":"restarted","state":"todo"},{"key":"healthy","state":"todo"}],"to_version":"8.4","type":"php_version","type_label":"PHP version"},"schema":{"$ref":"#/components/schemas/VersionChangeOperation"}}},"description":"The change was sent and its outcome is still being established: the operation is `pending`. Follow it by its `id`;\nit settles as saved or as failed within a few minutes. Do not send the change again meanwhile.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/RuntimeVersionConflict"},"422":{"$ref":"#/components/responses/RuntimePhpVersionInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/RuntimeNotSaved"}},"summary":"Update a site's PHP version","tags":["PHP"],"x-effect":["changes-settings"],"x-feature":"php-runtime","x-file":"runtime","x-gates":[],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-operations","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/platform-plugins":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers whether the platform's own plugins run on a WordPress site, the layout found, whether you may change the setting, and what turning them off would stop.","operationId":"getSitePlatformPlugins","responses":{"200":{"content":{"application/json":{"example":{"platform_plugins":{"applies":true,"applying":false,"can_change":true,"changed_at":null,"cut_over":false,"enabled":true,"keyed":true,"layout":"classic","layout_label":"Standard WordPress","needs_attention":null,"off_note":"Turning them off is refused once the site is past its go-live hold; the site gives the final answer when you confirm.","off_refused":null,"off_warning":"Turning them off also ends the go-live hold: email, outgoing requests, payment gateways and Action Scheduler tasks are no longer held back. This takes effect up to about a minute after the platform applies the change, and turning them back on brings the hold back the same way.","reason":"Needs the platform plugin, which is turned off for this site.","refused_functions":["wp_login_link"],"runtime_ready":true,"stops":["One-click login to wp-admin from the Control Panel","Viewing the site on its platform address: WordPress sends visitors to its own address instead","Before go-live: email, payments and outgoing requests are no longer held back","Before go-live: the platform address is no longer kept out of caches","The Control Panel's From address for email sent with PHP mail","On a preview environment: email from SMTP plugins is no longer caught, and known live integrations are no longer blocked"]}},"schema":{"$ref":"#/components/schemas/PlatformPluginsResult"}}},"description":"The setting."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's platform plugins","tags":["Platform plugins"],"x-feature":"platform-plugins","x-file":"platform-plugins","x-gates":[],"x-rate-limit":{"bucket":"reseller-platform-plugins-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Turns the platform's own plugins on or off for a WordPress site. Only the site's managing agency and Corefinity may change it. A turn-off needs `confirm_off: true`, sent once the person has agreed to what `stops` lists.","operationId":"updateSitePlatformPlugins","requestBody":{"content":{"application/json":{"examples":{"turn_off":{"summary":"Turn them off, agreed","value":{"confirm_off":true,"enabled":false}},"turn_on":{"summary":"Turn them on","value":{"enabled":true}}},"schema":{"$ref":"#/components/schemas/PlatformPluginsUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"turned_off":{"summary":"Turned off on a production site, with the operation applying it","value":{"changed":true,"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-03T09:16:40+00:00","completed_at":null,"created_at":"2026-11-03T09:16:40+00:00","environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"journal.harbourandfinch.example.com","id":1051},"status":"committed","status_label":"In progress","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Applied by the platform","state":"current"}],"subject":null,"summary":"Platform plugins","to_version":null,"type":"platform_plugins_key","type_label":"Platform plugins"},"platform_plugins":{"applies":true,"applying":true,"can_change":true,"changed_at":"2026-11-03T09:16:40+00:00","cut_over":false,"enabled":false,"keyed":true,"layout":"classic","layout_label":"Standard WordPress","needs_attention":null,"off_note":null,"off_refused":null,"off_warning":null,"reason":"Needs the platform plugin, which is turned off for this site.","refused_functions":["wp_login_link"],"runtime_ready":true,"stops":["One-click login to wp-admin from the Control Panel","Viewing the site on its platform address: WordPress sends visitors to its own address instead","Before go-live: email, payments and outgoing requests are no longer held back","Before go-live: the platform address is no longer kept out of caches","The Control Panel's From address for email sent with PHP mail","On a preview environment: email from SMTP plugins is no longer caught, and known live integrations are no longer blocked"]}}},"unchanged":{"summary":"The site already had the value","value":{"changed":false,"operation":null,"platform_plugins":{"applies":true,"applying":false,"can_change":true,"changed_at":null,"cut_over":false,"enabled":true,"keyed":true,"layout":"classic","layout_label":"Standard WordPress","needs_attention":null,"off_note":"Turning them off is refused once the site is past its go-live hold; the site gives the final answer when you confirm.","off_refused":null,"off_warning":"Turning them off also ends the go-live hold: email, outgoing requests, payment gateways and Action Scheduler tasks are no longer held back. This takes effect up to about a minute after the platform applies the change, and turning them back on brings the hold back the same way.","reason":"Needs the platform plugin, which is turned off for this site.","refused_functions":["wp_login_link"],"runtime_ready":true,"stops":["One-click login to wp-admin from the Control Panel","Viewing the site on its platform address: WordPress sends visitors to its own address instead","Before go-live: email, payments and outgoing requests are no longer held back","Before go-live: the platform address is no longer kept out of caches","The Control Panel's From address for email sent with PHP mail","On a preview environment: email from SMTP plugins is no longer caught, and known live integrations are no longer blocked"]}}}},"schema":{"$ref":"#/components/schemas/PlatformPluginsSaved"}}},"description":"The setting after the request. On a production site `operation` is the change being applied: follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"You can see the site but may not change this","value":{"code":"forbidden","message":"Only Corefinity staff or the site's managing agency can change the platform plugins.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope (`scope_required`), two-factor authentication is required and not set up, your account has no company that can use Managed Clusters (`company_not_enabled`), or you are not the site's managing agency (`forbidden`)."},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"command_busy":{"summary":"Another command holds the site","value":{"code":"busy","message":"Another command is running on this site. Try again in a moment.","reason":"busy"}},"command_running":{"summary":"A command is running on the site","value":{"code":"command_running","message":"Another action is still running on this site. Wait for it to finish.","reason":"command_running"}},"exec_unresolved":{"summary":"An earlier command has not been confirmed stopped","value":{"code":"exec_unresolved","message":"A previous command on this site has not been confirmed stopped. Contact support.","reason":"exec_unresolved"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_running":{"summary":"The site is not running","value":{"code":"not_running","message":"The site is not running","reason":"not_running"}},"runtime_lacks_capability":{"summary":"The site's software cannot turn them off yet","value":{"code":"runtime_lacks_capability","message":"This site's runtime cannot turn the platform plugins off yet. Corefinity support can move it to a newer runtime first.","reason":"runtime_lacks_capability"}},"site_cut_over":{"summary":"The site is past its go-live hold","value":{"code":"site_cut_over","message":"This site is past its go-live hold, so its platform plugins can no longer be turned off: they now send the site's email from its verified address.","reason":"site_cut_over"}},"wrong_platform":{"summary":"The site is not WordPress","value":{"code":"wrong_platform","message":"Only WordPress sites have platform plugins.","reason":"wrong_platform"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not WordPress (`wrong_platform`), its software cannot turn the plugins off yet (`runtime_lacks_capability`), it is past its go-live hold (`site_cut_over`), another change, deployment, restore or command is running on it (`busy`, `command_running` and their like), it is not running (`not_running`), an earlier command on it has not been confirmed stopped (`exec_unresolved`), or another control panel manages it (`managed_elsewhere`). Nothing was changed."},"422":{"content":{"application/json":{"examples":{"confirm":{"summary":"A turn-off without `confirm_off`","value":{"code":"confirm","message":"Turning the platform plugins off stops what is listed in stops. Send confirm_off: true once the person has agreed.","reason":"confirm","stops":["One-click login to wp-admin from the Control Panel","Viewing the site on its platform address: WordPress sends visitors to its own address instead","Before go-live: email, payments and outgoing requests are no longer held back","Before go-live: the platform address is no longer kept out of caches","The Control Panel's From address for email sent with PHP mail","On a preview environment: email from SMTP plugins is no longer caught, and known live integrations are no longer blocked"]}},"confirm_off":{"summary":"`confirm_off` is not a boolean","value":{"code":"invalid","errors":{"confirm_off":["The confirm_off field must be true or false."]},"field":"confirm_off","message":"The confirm_off field must be true or false.","reason":"invalid"}},"enabled":{"summary":"`enabled` is missing or not a boolean","value":{"code":"invalid","errors":{"enabled":["The enabled field must be true or false."]},"field":"enabled","message":"The enabled field must be true or false.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/PlatformPluginsConfirmRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"}]}}},"description":"A turn-off was not confirmed (`confirm`, with `stops`), or a field is not a boolean (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"content":{"application/json":{"examples":{"connect_failed":{"summary":"The site's cluster could not be reached","value":{"code":"connect_failed","message":"The cluster could not be reached","reason":"connect_failed"}},"cut_over_unknown":{"summary":"The site could not say whether it is past its go-live hold","value":{"code":"cut_over_unknown","message":"The platform plugins were not turned off: the site could not confirm whether it is past its go-live hold, so nothing was changed. Try again in a minute.","reason":"cut_over_unknown"}},"not_saved":{"summary":"The change could not be saved","value":{"code":"unavailable","message":"The platform plugins could not be changed just now, so nothing was changed. Try again in a minute.","reason":"unavailable"}},"switched_off":{"summary":"Corefinity has switched site commands off for the moment","value":{"code":"switched_off","message":"Site commands are switched off at the moment","reason":"switched_off"}},"unavailable":{"summary":"The site could not be changed","value":{"code":"unavailable","message":"The site could not be changed just now, so nothing was changed. Try again in a minute.","reason":"unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site could not be changed (`unavailable`), could not say whether it is past its go-live hold (`cut_over_unknown`), its cluster could not be reached (`connect_failed`), or Corefinity has switched site commands off for the moment (`switched_off`). Nothing was changed; try again later."}},"summary":"Update a site's platform plugins","tags":["Platform plugins"],"x-effect":["changes-settings"],"x-feature":"platform-plugins","x-file":"platform-plugins","x-gates":["exec"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-env-changes","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/progress":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"The stages of a site's create, with its state. It never shows the new site's admin login. A site that no create\nmade answers `404`.\n","operationId":"getSiteProgress","responses":{"200":{"content":{"application/json":{"example":{"capacity":null,"cluster":{"id":1009,"name":"CoreStack"},"elapsed_seconds":42,"environments":[],"failed":null,"operation":{"completed_at":null,"created_at":"2026-11-14T09:00:00Z","error":null,"id":5100,"scope":"site","status":"executing","status_label":"Running","steps":[{"key":"reserved","label":"Port and address reserved","state":"done"}],"type":"provision","type_label":"New site"},"order":null,"payment":null,"requested":{"at":"2026-11-14T09:00:00+00:00","by":{"id":2041,"name":"Eleanor Finch"}},"retried":null,"site":{"domain":"harbourandfinch.example.com","health":"unknown","id":1042,"kind":"corestack","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"mariadb":{"version":"11.8"},"mode":"staging","mode_label":"No domain","operation":null,"php":{"version":"8.3"},"primary_url":null,"removed":false,"tier":"S","usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}},"stages":[{"at":"2026-11-14T09:00:00+00:00","detail":null,"key":"requested","label":"Requested","state":"done"},{"at":"2026-11-14T09:00:02+00:00","detail":null,"key":"placed","label":"Server assigned","state":"done"},{"at":"2026-11-14T09:00:05+00:00","detail":null,"key":"committed","label":"Committed","state":"done"},{"at":null,"detail":null,"key":"starting","label":"Starting","state":"current"},{"at":null,"detail":null,"key":"installing","label":"Installing WordPress","state":"todo"},{"at":null,"detail":null,"key":"environments","label":"Environments","state":"skipped"},{"at":null,"detail":null,"key":"ready","label":"Ready","state":"todo"}],"state":"creating"},"schema":{"$ref":"#/components/schemas/SiteProgress"}}},"description":"The create's progress."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a new site's progress","tags":["Sites"],"x-feature":"sites","x-file":"sites","x-gates":["corestack_create"],"x-rate-limit":{"bucket":"corecluster-site-progress","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/provisioning":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"The create operation of a site made in one of your CoreClusters, with its steps. It never shows the new site's\nadmin login. A site that no create made answers `404`.\n","operationId":"getSiteProvisioning","responses":{"200":{"content":{"application/json":{"example":{"credentials":null,"credentials_state":"none","eta_seconds":null,"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-14T09:00:05Z","completed_at":"2026-11-14T09:03:40Z","created_at":"2026-11-14T09:00:00Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5100,"install":null,"notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"completed","status_label":"Ready","steps":[{"key":"reserved","label":"Port and address reserved","state":"done"}],"subject":null,"summary":"New site harbourandfinch.example.com","to_version":null,"type":"provision","type_label":"New site"},"preview_credentials_note":"The platform hostname is open to the web and hidden from search engines; attach a domain when you are ready.","reset_target":null,"revealed":null,"seed":null,"site":{"content":"empty","domain":"harbourandfinch.example.com","id":1042,"platform":"wordpress","preview_url":"https://harbourandfinch-example-com.northwind.cfstack.example.net","site_id":"rs-northwind-harbourandfinch-example-com","ssh_port":20031}},"schema":{"$ref":"#/components/schemas/SiteProvisioningProgress"}}},"description":"The install progress."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a CoreCluster site's install progress","tags":["Sites"],"x-feature":"sites","x-file":"sites","x-gates":["provisioning"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/provisioning/reveal":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Answers the admin login a fresh install created, once. Ask for it when the site's create has completed, with no body and `Accept: application/json`; the answer is never cached.","operationId":"revealSiteInstallLogin","responses":{"200":{"content":{"application/json":{"example":{"credentials":{"admin":{"password":"Example-admin-2026","url":"https://journal.harbourandfinch.example.com/wp-admin/","username":"shop_admin"},"note":"Shown once. Store it in your password manager.","revealed_at":"2026-11-19T09:20:00+00:00"},"remaining":0,"revealed_at":"2026-11-19T09:20:00+00:00"},"schema":{"$ref":"#/components/schemas/SiteInstallLogin"}}},"description":"The login, shown this once.","headers":{"Cache-Control":{"description":"Always `no-store, private`: the answer can carry a password.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"406":{"description":"The request did not send `Accept: application/json`. Nothing was revealed, so you can ask again. The answer is not JSON."},"409":{"content":{"application/json":{"examples":{"already_revealed":{"value":{"code":"already_revealed","message":"These credentials were already shown. Reset them from the site page","reason":"already_revealed"}},"busy":{"value":{"code":"busy","message":"Another change to this site is in progress","reason":"busy"}},"managed_elsewhere":{"value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The login cannot be shown. `already_revealed`: it was shown already, has expired, or the site has none (an empty site, or an install that has not finished). `busy`: another reveal of the same login is running. `managed_elsewhere`: another control panel manages the site."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Reveal a new site's admin login","tags":["Create a site"],"x-effect":["reveals-secret"],"x-feature":"site-create","x-file":"app-versions","x-gates":["app_versions_api","provisioning"],"x-rate-limit":{"bucket":"corecluster-reveal","limit":5,"minutes":10},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/redirects":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the redirect rules in the order they are tried, with the `version` every save sends back and the\ndomains a rule can be limited to.\n","operationId":"getSiteRedirects","responses":{"200":{"content":{"application/json":{"example":{"apply":{"applied_at":"2026-11-02T15:41:09Z","error":null,"operation":null,"state":"applied","state_label":"Applied"},"available_hosts":[{"host":"harbourandfinch.example.com","role":"primary"},{"host":"www.harbourandfinch.example.com","role":"alias"}],"formats":["nginx","apache","csv"],"host_scoping":true,"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"limits":{"from_max":2000,"import_max_bytes":524288,"regex_max":256,"rules_max":2000,"to_max":2000},"rules":[{"enabled":true,"from":"/about-us.html","hosts":null,"id":41,"keep_query":true,"note":"Old brochure page","position":1,"shadowed_by":null,"status":301,"to":"/about","type":"exact"},{"enabled":true,"from":"/blog","hosts":["www.harbourandfinch.example.com"],"id":42,"keep_query":true,"note":null,"position":2,"shadowed_by":null,"status":301,"to":"/news","type":"prefix"}],"version":12},"schema":{"$ref":"#/components/schemas/RedirectSet"}}},"description":"The redirect set."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/RedirectLifecycleConflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's redirects","tags":["Redirects"],"x-feature":"redirects","x-file":"redirects","x-gates":["redirects"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Replaces the whole table: send the `version` from the last read and every rule to keep, in the order they\nshould be tried. A rule left out is removed.\n","operationId":"replaceSiteRedirects","requestBody":{"content":{"application/json":{"examples":{"add_a_rule":{"summary":"Keep rule 41 and add a rule limited to one domain","value":{"rules":[{"enabled":true,"from":"/about-us.html","id":41,"keep_query":true,"note":"Old brochure page","status":301,"to":"/about","type":"exact"},{"enabled":true,"from":"/blog","hosts":["www.harbourandfinch.example.com"],"keep_query":true,"status":301,"to":"/news","type":"prefix"}],"version":12}},"remove_every_rule":{"summary":"Remove every rule","value":{"rules":[],"version":12}}},"schema":{"$ref":"#/components/schemas/RedirectSetUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"operation":null,"redirects":{"apply":{"applied_at":"2026-11-02T15:41:09Z","error":null,"operation":null,"state":"applied","state_label":"Applied"},"available_hosts":[{"host":"harbourandfinch.example.com","role":"primary"},{"host":"www.harbourandfinch.example.com","role":"alias"}],"formats":["nginx","apache","csv"],"host_scoping":true,"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"limits":{"from_max":2000,"import_max_bytes":524288,"regex_max":256,"rules_max":2000,"to_max":2000},"rules":[],"version":12}},"schema":{"$ref":"#/components/schemas/RedirectSaveResult"}}},"description":"The table sent is the table the site already has. Nothing was started and `operation` is null."},"201":{"content":{"application/json":{"example":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:42Z","completed_at":null,"created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":true,"id":142,"install":null,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"current"},{"key":"live","label":"Live","state":"todo"}],"subject":null,"summary":"1 redirect rule","to_version":null,"type":"redirects_change","type_label":"Redirects"},"redirects":{"apply":{"applied_at":"2026-11-02T15:41:09Z","error":null,"operation":{"id":142,"scope":"site","status":"committed","status_label":"Waiting for the platform","summary":"1 redirect rule","to_version":null,"type":"redirects_change","type_label":"Redirects"},"state":"applying","state_label":"Applying"},"available_hosts":[{"host":"harbourandfinch.example.com","role":"primary"},{"host":"www.harbourandfinch.example.com","role":"alias"}],"formats":["nginx","apache","csv"],"host_scoping":true,"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"limits":{"from_max":2000,"import_max_bytes":524288,"regex_max":256,"rules_max":2000,"to_max":2000},"rules":[{"enabled":true,"from":"/about-us.html","hosts":null,"id":41,"keep_query":true,"note":"Old brochure page","position":1,"shadowed_by":null,"status":301,"to":"/about","type":"exact"}],"version":13}},"schema":{"$ref":"#/components/schemas/RedirectSaveResult"}}},"description":"The table was saved and is being applied. Follow `operation.id` until it completes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"cluster_paused":{"summary":"Changes are paused for planned maintenance","value":{"code":"cluster_paused","message":"Changes on this site are paused for planned maintenance; please try again later.","reason":"cluster_paused"}},"conflict":{"summary":"Another change to the platform landed first","value":{"code":"conflict","message":"Another change landed first. Reload and try again.","reason":"conflict"}},"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_changeable":{"summary":"The site's files cannot be written from the Control Panel","value":{"message":"This site cannot be changed from the control panel. Contact support."}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}},"removed":{"summary":"The site has been removed","value":{"code":"removed","message":"This site has been removed","reason":"removed"}},"restore_running":{"summary":"A restore is running","value":{"code":"restore_running","message":"A restore of this site is running. Wait for it to finish.","reason":"restore_running"}},"stale":{"summary":"The table changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The save was refused because of the site's state. `reason` says why: `stale` (the table changed since your\nread, or a rule `id` is not one of this site's), `busy` (another change is running), `restore_running`,\n`conflict` (another change to the platform landed first: send the request again), `cluster_paused`\n(Corefinity has paused changes for planned maintenance: the message says until when, if that is known),\n`deleted`, `provisioning`, `removed` or `managed_elsewhere`. A site whose files the Control Panel cannot\nwrite answers a sentence only, with no `reason`.\n"},"422":{"content":{"application/json":{"examples":{"status":{"summary":"A rule's status is not one of the two","value":{"code":"invalid","errors":{"rules.1.status":["Rule 2: The status is 301 or 302"]},"field":"rules.1.status","message":"Rule 2: The status is 301 or 302","reason":"invalid"}},"target_query_kept":{"summary":"A target has a query string and the rule keeps the request's","value":{"code":"invalid","errors":{"rules.0.to":["Rule 1: A target with its own query string cannot also keep the request's. Turn Keep query off."]},"field":"rules.0.to","message":"Rule 1: A target with its own query string cannot also keep the request's. Turn Keep query off.","reason":"invalid"}},"target_query_on_prefix":{"summary":"A prefix rule's target has a query string","value":{"code":"invalid","errors":{"rules.0.to":["Rule 1: A prefix rule's target cannot carry a query string, because the rest of the path is added at its end"]},"field":"rules.0.to","message":"Rule 1: A prefix rule's target cannot carry a query string, because the rest of the path is added at its end","reason":"invalid"}},"target_too_long":{"summary":"A target is over 2,000 bytes as stored (the message says characters)","value":{"code":"invalid","errors":{"rules.0.to":["Rule 1: A target is at most 2000 characters"]},"field":"rules.0.to","message":"Rule 1: A target is at most 2000 characters","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong. A rule's fields are named by position, such as `rules.1.from`, and each\nmessage starts with the rule's number.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"no_answer":{"summary":"The platform did not answer","value":{"message":"The platform returned an error (HTTP 503). Try again shortly."}},"not_saved":{"summary":"The platform did not save the change","value":{"message":"The change could not be saved. Contact support."}}},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The platform did not answer, or did not save the change. Nothing was changed; try again shortly. The answer is a sentence only, with no `reason`."}},"summary":"Replace a site's redirects","tags":["Redirects"],"x-effect":["changes-settings","overwrites"],"x-feature":"redirects","x-file":"redirects","x-gates":["redirects"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-sets","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/redirects/export":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the saved table as a text file, as an attachment and never cached.\nThe answer is plain text, not JSON.\n","operationId":"exportSiteRedirects","parameters":[{"description":"The file format.","example":"csv","in":"query","name":"format","required":false,"schema":{"default":"nginx","enum":["nginx","apache","csv"],"type":"string"}}],"responses":{"200":{"content":{"text/plain":{"example":"type,from,to,status,keep_query,enabled,note\nexact,/about-us.html,/about,301,1,1,Old brochure page\nprefix,/blog,/news,301,1,1,\n","schema":{"type":"string"}}},"description":"The file.","headers":{"Cache-Control":{"description":"Always `no-store`.","schema":{"type":"string"}},"Content-Disposition":{"description":"`attachment`, with the file name.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/RedirectLifecycleConflict"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"format":["The selected format is invalid."]},"field":"format","message":"The selected format is invalid.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The `format` is not one of the formats offered."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Download a site's redirects","tags":["Redirects"],"x-feature":"redirects","x-file":"redirects","x-gates":["redirects"],"x-rate-limit":{"bucket":"reseller-validate","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/redirects/import":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Reads rules from the text of an nginx, Apache or CSV file and answers them with the lines it skipped.\nNothing is saved: add the rules to your table and save it.\n","operationId":"importSiteRedirects","requestBody":{"content":{"application/json":{"examples":{"apache":{"summary":"An Apache file","value":{"content":"Redirect 301 /about-us.html /about\nRedirect 302 /summer-offer /offers/autumn\n","format":"apache"}},"csv":{"summary":"Two lines of CSV","value":{"content":"/old-page,/new-page,301\n/team.html,/about/team,301\n","format":"csv"}}},"schema":{"$ref":"#/components/schemas/RedirectImportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"duplicates":0,"format":"apache","imported":1,"lines":[{"line":2,"reason":"Not a redirect","result":"skipped"},{"line":4,"reason":null,"result":"added","rule":{"enabled":true,"from":"/team.html","hosts":null,"id":null,"keep_query":true,"note":null,"position":1,"shadowed_by":null,"status":301,"to":"/about/team","type":"exact"}}],"rules":[{"enabled":true,"from":"/team.html","hosts":null,"id":null,"keep_query":true,"note":null,"position":1,"shadowed_by":null,"status":301,"to":"/about/team","type":"exact"}],"skipped":1,"warnings":[{"line":7,"message":"RewriteCond is not supported","text":"RewriteCond %{HTTP_HOST} ^www\\.example\\.com$ [NC]"}]},"schema":{"$ref":"#/components/schemas/RedirectImportResult"}}},"description":"The rules read from the file, and what happened to each line."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is deleted and waiting to be purged (`deleted`), still being created (`provisioning`), or managed by another control panel (`managed_elsewhere`)."},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"format":["The selected format is invalid."]},"field":"format","message":"The selected format is invalid.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong, such as a `format` that is not offered or `content` over the size limit."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Read redirects from a file","tags":["Redirects"],"x-effect":["none"],"x-feature":"redirects","x-file":"redirects","x-gates":["redirects"],"x-rate-limit":{"bucket":"reseller-validate","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/redirects/test":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Answers which rule matches an address and where it sends the visitor. Send `rules` to test an unsaved table\ninstead of the saved one. Nothing is saved.\n","operationId":"testSiteRedirect","requestBody":{"content":{"application/json":{"examples":{"saved_table":{"summary":"Test a path against the saved table","value":{"url":"/services/web-design/ecommerce?ref=footer"}},"unsaved_table":{"summary":"Test an unsaved table as one of the site's domains","value":{"host":"www.harbourandfinch.example.com","rules":[{"enabled":true,"from":"/draft","keep_query":false,"status":302,"to":"/final","type":"exact"}],"url":"/draft"}}},"schema":{"$ref":"#/components/schemas/RedirectTestRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"matched":{"summary":"A rule matches","value":{"chain":[{"from":"/services/web-design/ecommerce?ref=footer","status":301,"to":"/services/websites/ecommerce?ref=footer"}],"code":301,"host":"www.harbourandfinch.example.com","matched_rule":{"enabled":true,"from":"/services/web-design","hosts":null,"id":46,"keep_query":true,"note":null,"position":6,"shadowed_by":null,"status":301,"to":"/services/websites","type":"prefix"},"path":"/services/web-design/ecommerce","query":"ref=footer","target":"/services/websites/ecommerce?ref=footer","tried_before":[41,44,45],"type":"prefix","url":"https://www.harbourandfinch.example.com/services/web-design/ecommerce?ref=footer","warnings":[]}},"no_match":{"summary":"No rule matches, and a disabled rule would have","value":{"chain":[],"code":null,"disabled_match":49,"host":"harbourandfinch.example.com","matched_rule":null,"path":"/old-team","query":null,"target":null,"tried_before":[41,44,45],"type":null,"url":"https://harbourandfinch.example.com/old-team","warnings":["No rule matches this address"]}}},"schema":{"$ref":"#/components/schemas/RedirectTestResult"}}},"description":"What the table answers for the address."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/RedirectLifecycleConflict"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"url":["Enter a path such as /old-page, or a full address on this site"]},"field":"url","message":"Enter a path such as /old-page, or a full address on this site","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong, such as a `url` that is neither a path nor an address, or a `host` that is not one of the site's domains."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Test an address against the redirects","tags":["Redirects"],"x-effect":["none"],"x-feature":"redirects","x-file":"redirects","x-gates":["redirects"],"x-rate-limit":{"bucket":"reseller-validate","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/restore-deleted":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Brings a deleted site back while it can still be restored. The site counts against its CoreCluster again, so\nthe restore is checked as a create is and may grow the CoreCluster when automatic upgrades are on. Only a\nrestore that is accepted counts towards the rate limit.\n","operationId":"restoreDeletedSite","responses":{"200":{"content":{"application/json":{"example":{"site":{"deleted":null,"domain":"harbourandfinch.example.com","health":"unknown","id":1042,"kind":"corecluster","lifecycle":"active","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"mariadb":{"version":"11.8"},"mode":"production","mode_label":"Domain attached","operation":null,"php":{"version":"8.3"},"primary_url":"https://harbourandfinch.example.com","removed":false,"tier":"S","usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}}},"schema":{"$ref":"#/components/schemas/SiteAnswer"}}},"description":"The site, restored."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"capacity_blocked":{"summary":"The CoreCluster has no room for it","value":{"code":"capacity_blocked","dimension":"memory","message":"Not enough capacity left on this cluster for a M WordPress site (adds about 1536 MB; 29.4 of 32 GB in use over the last 24 h). Upgrade the package.","reason":"capacity_blocked"}},"cluster_deleting":{"summary":"The CoreCluster is being deleted","value":{"code":"cluster_deleting","message":"This cluster is being deleted","reason":"cluster_deleting"}},"conflict":{"summary":"The site is not deleted","value":{"code":"conflict","message":"This site is not deleted","reason":"conflict"}},"deleted":{"summary":"The site is being removed for good","value":{"code":"deleted","message":"This site is being purged and cannot be restored","reason":"deleted"}},"deletion_in_progress":{"summary":"The delete has not finished yet","value":{"code":"deletion_in_progress","message":"Deletion still in progress. Try again once the site shows as deleted.","reason":"deletion_in_progress"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"never_set_up":{"summary":"The site was deleted before it was set up","value":{"code":"not_restorable","message":"This site was deleted before it was set up, so there is nothing to restore. You can create it again.","reason":"not_restorable"}},"not_restorable":{"summary":"The row is an environment","value":{"code":"not_restorable","message":"Environments are removed at once. Recreate it from the final snapshot.","reason":"not_restorable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site cannot be restored now. `reason` says why."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"example":{"message":"The site was restored but could not be started. Contact Corefinity support to have it started."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The site was restored but could not be started."},"503":{"$ref":"#/components/responses/SwitchedOff"}},"summary":"Restore a deleted site","tags":["Sites"],"x-effect":["changes-settings","billable"],"x-feature":"restore-deleted","x-file":"sites","x-gates":["provisioning","delete"],"x-rate-limit":{"bucket":"reseller-restore-deleted","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/runtime":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers whether the site is on the runtime, the versions it runs, the last change of each part, anything\nwaiting for the site's window and whether the site can move onto the runtime.\n","operationId":"getRuntime","responses":{"200":{"content":{"application/json":{"examples":{"on_the_runtime":{"summary":"A site on the runtime","value":{"adopted":true,"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"handover":false,"hot_apply":{"nginx":true,"node":true,"php":true},"images":{"nginx":{"revision":null,"version":null},"node_toolchain":{"major":null,"revision":null,"status":null},"php":{"current":true,"latest_round":1,"minor":"8.4","patch":"8.4.9","round":1,"superseded_since":null}},"last_apply":{"nginx":null,"node":null,"php":null},"new_relic":{"app":null,"state":"none"},"pending":[],"queued_for":null,"revision":"v1","window_only":true}}},"schema":{"$ref":"#/components/schemas/RuntimeSummary"}}},"description":"The runtime summary."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's runtime","tags":["PHP"],"x-feature":"php-runtime","x-file":"runtime","x-gates":["runtime_adoption"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/runtime/adopt":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Moves the site onto the runtime, at once or in the site's window. The runtime summary says whether it can\n(`adoption.can_adopt_now`, `adoption.can_adopt_tonight`). A site that cannot move is refused `409` with the\nreason and its `adoption` state.\n","operationId":"adoptRuntime","requestBody":{"content":{"application/json":{"examples":{"now":{"summary":"Move at once","value":{"apply":"now"}},"tonight":{"summary":"Move in the site's window","value":{"apply":"tonight"}}},"schema":{"$ref":"#/components/schemas/RuntimeAdoptRequest"}}},"required":false},"responses":{"201":{"content":{"application/json":{"examples":{"queued":{"summary":"The move waits for the site's window","value":{"adoption":{"adopt_now_refusal":null,"adopted":false,"can_adopt_now":true,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":"2026-11-04","revision":null},"item_id":5120,"operation":null,"queued":true,"window_date":"2026-11-04"}}},"schema":{"$ref":"#/components/schemas/RuntimeAdoption"}}},"description":"The move started (`operation`), or was queued for the site's window (`queued`)."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"already_adopted":{"summary":"The site is already on the runtime","value":{"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"code":"already_adopted","message":"Instant changes are already on for this environment.","reason":"already_adopted"}}},"schema":{"$ref":"#/components/schemas/RuntimeAdoptionRefusal"}}},"description":"The site cannot move onto the runtime now. `reason` says why and `adoption` is the site's state. Also\n`managed_elsewhere`, without `adoption`, for a site managed by another control panel. Reasons include\n`already_adopted`, `adoption_in_progress`, `runtime_not_adopted` (sites cannot be moved yet),\n`batch_window` (the move can only be made in the site's window, or other maintenance is already queued:\nsend `apply` `tonight`), `change_pending`, `canary_pending` and `removed`.\n"},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"An apply that is neither now nor tonight","value":{"code":"invalid","errors":{"apply":["The selected apply is invalid."]},"field":"apply","message":"The selected apply is invalid.","reason":"invalid"}},"window_off":{"summary":"Queuing for the window is switched off","value":{"code":"feature_off","message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`apply` is not `now` or `tonight` (`invalid`), or it is `tonight` while queuing for the window is switched\noff (`feature_off`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Move a site onto the runtime","tags":["PHP"],"x-effect":["changes-settings"],"x-feature":"php-runtime","x-file":"runtime","x-gates":["runtime_adoption"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"corecluster-runtime","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/snapshot-frequency":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"Sets the site's own frequency, or null to follow the default of its CoreCluster or, for a CoreStack site, its\npackage. The next scheduled snapshot moves to the first slot of the new frequency.\n","operationId":"updateSiteSnapshotFrequency","requestBody":{"content":{"application/json":{"examples":{"every_six_hours":{"summary":"Every 6 hours","value":{"frequency":"6h"}},"follow_default":{"summary":"Follow the default","value":{"frequency":null}}},"schema":{"$ref":"#/components/schemas/SnapshotSiteFrequencyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"settings":{"$ref":"#/components/examples/SnapshotSiteSettingsExample"}},"schema":{"$ref":"#/components/schemas/SnapshotSiteSettings"}}},"description":"The site's snapshot settings as they are now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"removed":{"summary":"The site has been removed","value":{"code":"removed","message":"This site has been removed","reason":"removed"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site has been removed (`removed`), or it is managed by another control panel (`managed_elsewhere`)."},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update how often a site takes snapshots","tags":["Snapshots"],"x-effect":["changes-settings"],"x-feature":"snapshots","x-file":"snapshots","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/snapshots":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the site's snapshots, newest first, with its snapshot settings and any restore still running. The list\nis not paged; a snapshot deleted in the last day is still listed.\n","operationId":"listSiteSnapshots","responses":{"200":{"content":{"application/json":{"examples":{"list":{"$ref":"#/components/examples/SnapshotListExample"}},"schema":{"$ref":"#/components/schemas/SnapshotList"}}},"description":"The snapshots, the settings and the running restore, if any."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's snapshots","tags":["Snapshots"],"x-feature":"snapshots","x-file":"snapshots","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"Starts a one-off snapshot of the site and answers it with `status` `pending` or `creating`. Read it with\n`GET /corestack/snapshots/{snapshot}` until `status` is `ready` or `failed`.\n","operationId":"createSiteSnapshot","requestBody":{"content":{"application/json":{"examples":{"with_note":{"summary":"A snapshot with a note","value":{"note":"Before the PHP 8.4 move"}},"without_note":{"summary":"A snapshot without a note","value":{}}},"schema":{"$ref":"#/components/schemas/SnapshotCreateRequest"}}},"required":false},"responses":{"201":{"content":{"application/json":{"examples":{"creating":{"$ref":"#/components/examples/SnapshotCreatingExample"}},"schema":{"$ref":"#/components/schemas/Snapshot"}}},"description":"The snapshot, which is now being taken."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"in_flight":{"summary":"A snapshot is already being taken","value":{"code":"in_flight","message":"A snapshot of this site is already being taken. Try again in a minute.","reason":"in_flight"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"mariadb_change":{"summary":"The MariaDB version is changing","value":{"code":"mariadb_change","message":"The site is changing its MariaDB version. Try again when it has finished.","reason":"mariadb_change"}},"not_healthy":{"summary":"The database is not running normally","value":{"code":"not_healthy","message":"The database of this site is not running normally. Try again once it has recovered.","reason":"not_healthy"}},"not_taken":{"summary":"The site's storage did not accept the snapshot","value":{"code":"state","message":"The snapshot could not be taken","reason":"state"}},"removed":{"summary":"The site has been removed","value":{"code":"removed","message":"This site has been removed","reason":"removed"}},"restoring":{"summary":"A restore is running","value":{"code":"restoring","message":"A restore of this site is in progress. Try again when it has finished.","reason":"restoring"}},"setting_up":{"summary":"The site is still being set up","value":{"code":"setting_up","message":"This site is still being set up. Try again in a few minutes.","reason":"setting_up"}},"settling":{"summary":"The database started a few minutes ago","value":{"code":"settling","message":"The database of this site has only just started. Try again in a few minutes.","reason":"settling"}},"stale":{"summary":"The site changed while the snapshot was being prepared","value":{"code":"stale","message":"The site changed while the snapshot was being prepared. Try again.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"No snapshot can be taken now. `reason` says why: `in_flight` (one is already being taken), `restoring` (a\nrestore is running), `mariadb_change` (the MariaDB version is changing), `not_healthy` or `settling` (the\ndatabase is not running normally, or started a few minutes ago), `setting_up` (the site is still being set\nup), `stale` (the site changed while the snapshot was being prepared), `removed`, `managed_elsewhere`, or\n`state` (the message says why). When the site's storage does not accept the snapshot, the answer is\n`state` with the message \"The snapshot could not be taken\" and the status the storage gave, which is\nusually `409` and can be another `4xx` status: go by the `reason` and the message, not the status alone.\n"},"422":{"content":{"application/json":{"examples":{"disabled":{"summary":"Snapshots are not enabled","value":{"code":"disabled","message":"Snapshots are not enabled for this cluster","reason":"disabled"}},"invalid":{"summary":"The note is too long","value":{"code":"invalid","errors":{"note":["The note may not be greater than 140 characters."]},"field":"note","message":"The note may not be greater than 140 characters.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The `note` is wrong (`invalid`), or snapshots are not enabled for the site's cluster (`disabled`)."},"429":{"content":{"application/json":{"examples":{"google_cap":{"summary":"The hourly limit of all snapshots of the site","value":{"code":"google_cap","message":"Snapshot limit reached for this hour. Try again later.","reason":"google_cap"}},"manual_cap":{"summary":"The hourly limit of one-off snapshots","value":{"code":"manual_cap","message":"A site can have 20 one-off snapshots per hour. Try again later.","reason":"manual_cap"}},"too_many_requests":{"summary":"More than 10 requests in a minute","value":{"code":"rate_limited","message":"Too many requests. Try again in 42 seconds.","reason":"rate_limited","retry_after_seconds":42}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"Too many requests (`rate_limited`), the site's hourly limit of one-off snapshots (`manual_cap`), or the\nhourly limit of all snapshots of the site (`google_cap`).\n"},"502":{"content":{"application/json":{"examples":{"unreadable":{"value":{"code":"unreadable","message":"The site could not be checked. Try again in a minute.","reason":"unreadable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site could not be checked before the snapshot (`unreadable`). Try again in a minute."},"503":{"content":{"application/json":{"examples":{"unavailable":{"summary":"Snapshots are temporarily unavailable","value":{"code":"state","message":"Storage operations for this site are temporarily unavailable. Try again later or contact support.","reason":"state"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Snapshots of this site are temporarily unavailable (`state`). Try again later."}},"summary":"Create a snapshot","tags":["Snapshots"],"x-effect":["changes-settings"],"x-feature":"snapshots","x-file":"snapshots","x-gates":[],"x-rate-limit":{"bucket":"reseller-snapshots","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/terminal/sessions":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the newest 50 browser terminal sessions of a site, whoever opened them, and your own session when one\nis open now. A terminal is opened in the Control Panel, never through the API.\n","operationId":"listSiteTerminalSessions","responses":{"200":{"content":{"application/json":{"example":{"active":null,"sessions":[{"duration_seconds":600,"end_reason":"closed","ended_at":"2026-11-03T09:26:40Z","id":6318,"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-03T09:16:40Z","status":"ended","status_label":"Ended","transcript":{"available":true,"expires_at":"2027-02-01T09:26:40Z","url":"/api/corestack/terminal/sessions/6318/transcript"},"user":{"id":2041,"name":"Eleanor Finch"}},{"duration_seconds":1800,"end_reason":"idle","ended_at":"2026-11-02T14:32:11Z","id":6317,"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-02T14:02:11Z","status":"timed_out","status_label":"Timed out","transcript":{"available":false,"expires_at":null,"url":null},"user":{"id":2041,"name":"Eleanor Finch"}}]},"schema":{"$ref":"#/components/schemas/TerminalSessionList"}}},"description":"The sessions, newest first."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's terminal sessions","tags":["Terminal"],"x-feature":"terminal","x-file":"terminal","x-gates":["terminal"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/upgrade-options":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers what a site can change to and what each choice costs a month: its line's packages, its add-ons with\ntheir unit prices and ceilings, its staging sizes and the server types, and whether you may pay for a change\n(`rights.can_pay`). A site with no billing contract is offered the same changes without prices (`not_billed`),\nand a site inside a CoreCluster takes its package from the CoreCluster. An environment's id answers for its\nsite.\n","operationId":"getSiteUpgradeOptions","responses":{"200":{"content":{"application/json":{"examples":{"site":{"$ref":"#/components/examples/UpgradeOptionsSiteExample"}},"schema":{"$ref":"#/components/schemas/UpgradeOptions"}}},"description":"The upgrade options."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"managing_agency":{"summary":"You reach the site only as its managing agency","value":{"code":"forbidden","message":"Billing for this site is Harbour & Finch's.","reason":"forbidden"}},"read_scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `read` scope (`scope_required`), your company requires two-factor authentication and\nyou have not set it up (`two_factor_required`), or you reach the site only as its managing agency\n(`forbidden`): its billing is the client's, so its options and prices are not shown to you.\n"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's upgrade options","tags":["Packages and capacity"],"x-feature":"upgrades","x-file":"upgrades","x-gates":["packages","billing"],"x-rate-limit":{"bucket":"corecluster-billing-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/url-change":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Starts the change that a preview described. Send the preview's `preview_token` and, in `confirm_domain`, the\nsite's current main domain typed exactly.\n","operationId":"updateSiteMainDomain","requestBody":{"content":{"application/json":{"examples":{"new_domain":{"summary":"Move to a new bare domain, DNS handled by you","value":{"confirm_domain":"harbourandfinch.example.com","new_primary":"harbourandfinch.example.net","preview_token":"pReViEw-ToKeN-0123456789abcdefghijklmnopqr","www":"bare"}}},"schema":{"$ref":"#/components/schemas/UrlChangeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"started":{"$ref":"#/components/examples/UrlChangeStarted"}},"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"The change started. Follow it by `id`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/UrlChangeConflict"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"The current domain was not typed exactly","value":{"code":"confirm_mismatch","errors":{"confirm_domain":["Type the current domain to confirm"]},"field":"confirm_domain","message":"Type the current domain to confirm","reason":"confirm_mismatch"}},"preview_token":{"summary":"The preview is missing or too old","value":{"code":"preview_token","errors":{"preview_token":["Run the preview again. It is older than 15 minutes."]},"message":"Run the preview again. It is older than 15 minutes.","reason":"preview_token"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"`confirm_mismatch` (the current main domain was not typed exactly), `preview_token` (no preview for this\nplan, or one older than 15 minutes), `invalid` (a field is missing or wrong), `host_taken` or\n`domains_locked`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"$ref":"#/components/responses/DomainUpstreamFailed"}},"summary":"Update a site's main domain","tags":["Domains"],"x-effect":["changes-settings","overwrites","runs-code"],"x-feature":"domains","x-file":"domains","x-gates":["domains"],"x-long-running":"getOperation","x-rate-limit":{"bucket":"reseller-url-change","limit":5,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/url-change/preview":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Answers what changing the main domain would do: the hostnames, their DNS state, how many database rows mention\nthe old address, and a `preview_token` valid for 15 minutes. Nothing changes.\n","operationId":"previewSiteMainDomain","requestBody":{"content":{"application/json":{"examples":{"new_domain":{"summary":"Move to a new bare domain","value":{"new_primary":"harbourandfinch.example.net","www":"bare"}}},"schema":{"$ref":"#/components/schemas/UrlChangePreviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"new_domain":{"$ref":"#/components/examples/UrlChangePreviewed"}},"schema":{"$ref":"#/components/schemas/UrlChangePreview"}}},"description":"The preview."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"$ref":"#/components/responses/UrlChangeConflict"},"422":{"content":{"application/json":{"examples":{"host_taken":{"summary":"Another site uses the address","value":{"code":"host_taken","errors":{"new_primary":["This hostname is already used by another site."]},"message":"This hostname is already used by another site.","reason":"host_taken"}},"invalid":{"summary":"The address is already the main domain","value":{"code":"invalid","errors":{"new_primary":["That is already the primary address"]},"field":"new_primary","message":"That is already the primary address","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`), the new address is used by another site (`host_taken`), or the\nsite's domains are locked (`domains_locked`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/DomainCommandsSwitchedOffError"},"502":{"$ref":"#/components/responses/DomainUpstreamFailed"}},"summary":"Preview a main domain change","tags":["Domains"],"x-effect":["none"],"x-feature":"domains","x-file":"domains","x-gates":["domains"],"x-rate-limit":{"bucket":"reseller-url-preview","limit":6,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/usage":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"CPU, memory and disk use over a range, as series of points.","operationId":"getSiteUsage","parameters":[{"description":"The time range to read.","example":"7d","in":"query","name":"range","required":false,"schema":{"default":"24h","enum":["6h","24h","7d","30d"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"cpu":{"limit":2000,"points":[[1794561000000,164,310],[1794561300000,171,298]],"request":100,"unit":"millicores"},"disk":{"points":[[1794561000000,2147483648,2147483648],[1794561300000,2147483648,2147483648]],"size":10737418240,"unit":"bytes"},"from":"2026-11-13T09:10:00Z","last_sample_at":"2026-11-14T09:05:00Z","memory":{"limit":4294967296,"points":[[1794561000000,902261120,954261120],[1794561300000,912261120,961261120]],"request":536870912,"unit":"bytes"},"range":"24h","step_seconds":300,"to":"2026-11-14T09:10:00Z"},"schema":{"$ref":"#/components/schemas/Usage"}}},"description":"The usage series."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"range":["Choose a range of 6h, 24h, 7d or 30d."]},"field":"range","message":"Choose a range of 6h, 24h, 7d or 30d.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The range is not one of the four."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's usage history","tags":["Sites"],"x-feature":"resources","x-file":"sites","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/varnish":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers whether Varnish is on, its version and the versions the site may use, its share of the site's memory, whether Magento is set up for it, and the purges left this hour.\n","operationId":"getSiteVarnish","responses":{"200":{"content":{"application/json":{"example":{"default_version":"7.7","enabled":true,"live":null,"magento_config":{"checked_at":"2026-11-06T09:00:12Z","state":"varnish"},"memory_mib":1280,"offered":true,"opt_out":false,"options":[{"allowed":true,"current":false,"reason":null,"status":"eol","version":"8.0"},{"allowed":false,"current":true,"reason":"This is the current version","status":"eol","version":"7.7"},{"allowed":true,"current":false,"reason":null,"status":"lts","version":"6.0"}],"pending":null,"purge":{"available_in":0,"last":{"at":"2026-11-06T09:16:40Z","by":"Eleanor Finch","count":2,"items":["cat_p_1180","cat_c_27"],"mode":"tags","origin":"api","status":"succeeded"},"limit_per_hour":10,"remaining_this_hour":9},"redis_mib":{"off":768,"on":512},"site":{"domain":"harbourandfinch.example.com","environment":"Production","id":1042},"storage_mib":640,"switched_off":null,"version":"7.7"},"schema":{"$ref":"#/components/schemas/Varnish"}}},"description":"The site's Varnish."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not a Magento 2 site (`varnish_not_offered`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's Varnish","tags":["Varnish"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish"],"x-rate-limit":{"bucket":"corecluster-varnish-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"post":{"description":"The same switch as `PUT /corestack/sites/{site}/varnish`, kept for clients that send it as a POST. It takes the same body and answers the same.\n","operationId":"updateSiteVarnishByPost","requestBody":{"content":{"application/json":{"examples":{"switch_off":{"summary":"Switch Varnish off","value":{"enabled":false}}},"schema":{"$ref":"#/components/schemas/VarnishSwitch"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"queued":{"summary":"The switch waits for the site's window","value":{"item_id":77,"operation":null,"queued":true,"window_date":"2026-11-07"}},"started":{"summary":"Varnish is being switched off","value":{"operation":{"committed_at":null,"completed_at":null,"created_at":"2026-11-06T09:16:40+00:00","error":null,"failure_reason":null,"from_version":"7.7","id":5124,"label":"Magento switched to its built-in cache","requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","status":"executing","status_label":"Running","step":"magento","steps":[{"key":"magento","label":"Magento switched to its built-in cache","state":"current"},{"key":"purged","label":"Cache cleared","state":"todo"},{"key":"saved","label":"Saved","state":"todo"},{"key":"applied","label":"Picked up by the platform","state":"todo"},{"key":"cleared","label":"Done","state":"todo"}],"to_version":"7.7","type":"varnish_set","type_label":"Varnish"}}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/VarnishChangeStarted"},{"$ref":"#/components/schemas/QueuedChange"}]}}},"description":"The change started (`operation`), or waits for the site's window (`queued: true`). Follow a started change with the operation."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"image_not_offered":{"summary":"That version cannot be used at the moment","value":{"code":"image_not_offered","message":"The version this change needs is not available right now. Nothing was changed.","reason":"image_not_offered"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"memory_split":{"summary":"Corefinity has divided the site's memory by hand","value":{"code":"memory_split","message":"Corefinity staff have divided this environment's memory between its services by hand, and this change would undo that. Ask support to make this change.","reason":"memory_split"}},"unchanged":{"summary":"Varnish is already in that state","value":{"code":"unchanged","message":"Varnish is already on for this environment.","reason":"unchanged"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change was refused because of the site's state. `reason` says why: `unchanged` (Varnish is already in that state), `busy`, `restore_running`, `deployment_running`, `command_running` or `snapshot_running` (other work on the site has not finished), `cluster_paused` (changes to the site's cluster are paused), `change_pending` (with `apply`: a change already waits for the window), `image_not_offered` (that version cannot be used at the moment), `memory_split` (Corefinity has divided the site's memory by hand: ask support), `unmanageable` (the site's platform files cannot take the switch: contact support), `conflict` (another change landed first: try again), `removed` or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The change cannot wait for a window at the moment","value":{"code":"feature_off","errors":{"apply":["Queuing changes for the maintenance window is switched off at the moment"]},"message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}},"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"enabled":["The enabled field must be true or false."]},"field":"enabled","message":"The enabled field must be true or false.","reason":"invalid"}},"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish runs on Magento 2 environments only.","reason":"varnish_not_offered"}},"varnish_too_small":{"summary":"The cache would be below 512 MiB","value":{"code":"varnish_too_small","message":"Varnish needs at least 512 MiB from this package's cache and message-queue share. Choose a larger package, or switch RabbitMQ off.","reason":"varnish_too_small"}},"version_unsupported":{"summary":"That version is not offered","value":{"code":"version_unsupported","message":"Varnish 5.2 is not offered for this environment: it is not offered.","reason":"version_unsupported"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `varnish_not_offered` (the site is not a Magento 2 site, is smaller than Medium, 8 GB, or needs a platform update before it can use Varnish: the message says which), `varnish_too_small` (the cache would be below 512 MiB), `version_unsupported` (that version is not offered for the site) or `feature_off` when `apply` asks for a window and changes cannot wait for one at the moment."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"upstream_unavailable":{"summary":"The site's settings could not be read","value":{"code":"upstream_unavailable","message":"The site's settings could not be read; try again shortly.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site's settings could not be read, so nothing was changed (`upstream_unavailable`). Try again shortly."}},"summary":"Update a site's Varnish switch by POST","tags":["Varnish"],"x-effect":["changes-settings"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish"],"x-long-running":"getSiteVarnishOperation","x-rate-limit":{"bucket":"reseller-operations","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"put":{"description":"Switches Varnish on or off for a Magento 2 site. Switching on without `version` keeps the version the site had last while that version is still allowed for the site, and takes the site's default version (`default_version`) otherwise. The switch takes a few minutes: follow the operation in the answer. With `apply` set to `tonight` or `window`, the switch waits for the site's maintenance window.\n","operationId":"updateSiteVarnish","requestBody":{"content":{"application/json":{"examples":{"switch_off":{"summary":"Switch Varnish off","value":{"enabled":false}}},"schema":{"$ref":"#/components/schemas/VarnishSwitch"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"queued":{"summary":"The switch waits for the site's window","value":{"item_id":77,"operation":null,"queued":true,"window_date":"2026-11-07"}},"started":{"summary":"Varnish is being switched off","value":{"operation":{"committed_at":null,"completed_at":null,"created_at":"2026-11-06T09:16:40+00:00","error":null,"failure_reason":null,"from_version":"7.7","id":5124,"label":"Magento switched to its built-in cache","requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","status":"executing","status_label":"Running","step":"magento","steps":[{"key":"magento","label":"Magento switched to its built-in cache","state":"current"},{"key":"purged","label":"Cache cleared","state":"todo"},{"key":"saved","label":"Saved","state":"todo"},{"key":"applied","label":"Picked up by the platform","state":"todo"},{"key":"cleared","label":"Done","state":"todo"}],"to_version":"7.7","type":"varnish_set","type_label":"Varnish"}}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/VarnishChangeStarted"},{"$ref":"#/components/schemas/QueuedChange"}]}}},"description":"The change started (`operation`), or waits for the site's window (`queued: true`). Follow a started change with the operation."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"image_not_offered":{"summary":"That version cannot be used at the moment","value":{"code":"image_not_offered","message":"The version this change needs is not available right now. Nothing was changed.","reason":"image_not_offered"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"memory_split":{"summary":"Corefinity has divided the site's memory by hand","value":{"code":"memory_split","message":"Corefinity staff have divided this environment's memory between its services by hand, and this change would undo that. Ask support to make this change.","reason":"memory_split"}},"unchanged":{"summary":"Varnish is already in that state","value":{"code":"unchanged","message":"Varnish is already on for this environment.","reason":"unchanged"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change was refused because of the site's state. `reason` says why: `unchanged` (Varnish is already in that state), `busy`, `restore_running`, `deployment_running`, `command_running` or `snapshot_running` (other work on the site has not finished), `cluster_paused` (changes to the site's cluster are paused), `change_pending` (with `apply`: a change already waits for the window), `image_not_offered` (that version cannot be used at the moment), `memory_split` (Corefinity has divided the site's memory by hand: ask support), `unmanageable` (the site's platform files cannot take the switch: contact support), `conflict` (another change landed first: try again), `removed` or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The change cannot wait for a window at the moment","value":{"code":"feature_off","errors":{"apply":["Queuing changes for the maintenance window is switched off at the moment"]},"message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}},"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"enabled":["The enabled field must be true or false."]},"field":"enabled","message":"The enabled field must be true or false.","reason":"invalid"}},"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish runs on Magento 2 environments only.","reason":"varnish_not_offered"}},"varnish_too_small":{"summary":"The cache would be below 512 MiB","value":{"code":"varnish_too_small","message":"Varnish needs at least 512 MiB from this package's cache and message-queue share. Choose a larger package, or switch RabbitMQ off.","reason":"varnish_too_small"}},"version_unsupported":{"summary":"That version is not offered","value":{"code":"version_unsupported","message":"Varnish 5.2 is not offered for this environment: it is not offered.","reason":"version_unsupported"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `varnish_not_offered` (the site is not a Magento 2 site, is smaller than Medium, 8 GB, or needs a platform update before it can use Varnish: the message says which), `varnish_too_small` (the cache would be below 512 MiB), `version_unsupported` (that version is not offered for the site) or `feature_off` when `apply` asks for a window and changes cannot wait for one at the moment."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"upstream_unavailable":{"summary":"The site's settings could not be read","value":{"code":"upstream_unavailable","message":"The site's settings could not be read; try again shortly.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site's settings could not be read, so nothing was changed (`upstream_unavailable`). Try again shortly."}},"summary":"Update a site's Varnish switch","tags":["Varnish"],"x-effect":["changes-settings"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish"],"x-long-running":"getSiteVarnishOperation","x-rate-limit":{"bucket":"reseller-operations","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/commands/{command}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of a purge or a repair of this site, from its `command.id`.","in":"path","name":"command","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers a Varnish purge or a repair of Magento's cache settings on this site. Read it again until `status` is no longer `queued` or `running`.\n","operationId":"getSiteVarnishCommand","responses":{"200":{"content":{"application/json":{"example":{"blocked_until_verified":false,"duration_ms":840,"error":null,"exit_code":0,"finished_at":"2026-11-06T09:16:41Z","id":905,"input":{"host":null,"mode":"tags","tags":["cat_p_1180","cat_c_27"],"target":"varnish","via":"api"},"kind":"varnish_purge","label":"Varnish purged · by tag","operation_id":null,"output_excerpt":"200","queued_at":"2026-11-06T09:16:40Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"result":{"confirmed":true,"count":2,"hosts":[],"mode":"tags","objects":null,"requests":1,"seconds":0,"sent":1,"target":"varnish"},"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-06T09:16:40Z","status":"succeeded","status_label":"Done"},"schema":{"$ref":"#/components/schemas/VarnishCommand"}}},"description":"The command."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a purge or a repair's progress","tags":["Varnish"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish"],"x-rate-limit":{"bucket":"corecluster-varnish-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/operations/{operation}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"The id of a Varnish operation of this site: a switch, a version change or a VCL change.","in":"path","name":"operation","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers a switch, a version change or a custom VCL change of this site. Read it again until `status` is `completed` or `failed`. For a VCL change the answer adds `vcl`, which says whether Varnish loaded it.\n","operationId":"getSiteVarnishOperation","responses":{"200":{"content":{"application/json":{"example":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:40Z","completed_at":"2026-11-06T09:17:22Z","created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5125,"install":null,"label":null,"notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"completed","status_label":"Done","step":null,"steps":[{"key":"policy","label":"Checked against the policy","state":"done"},{"key":"compiled","label":"Compiled","state":"done"},{"key":"loaded","label":"Loaded by Varnish","state":"done"},{"key":"checked","label":"Checked","state":"done"}],"subject":null,"summary":"Varnish VCL","to_version":null,"type":"varnish_vcl_change","type_label":"Varnish VCL"},"vcl":{"applied":true,"applied_at":"2026-11-06T09:17:22Z","outcome":"applied","reason":null,"revision":2,"status":"applied","warnings":[]}},"schema":{"$ref":"#/components/schemas/VarnishOperationResult"}}},"description":"The operation."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a Varnish operation","tags":["Varnish"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish"],"x-rate-limit":{"bucket":"corecluster-varnish-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/purge":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Removes pages from the site's Varnish cache: everything, the pages carrying a Magento cache tag, single addresses, or every address matching a pattern. A site may ask for ten purges an hour; Magento's own purges and deployments are not counted. `host` limits a purge by address or by pattern to one of the site's hostnames; a purge of everything or by tag always covers every hostname. Follow the command in the answer.\n","operationId":"purgeSiteVarnish","requestBody":{"content":{"application/json":{"examples":{"by_address":{"summary":"Purge two addresses on every hostname","value":{"host":null,"include_query":false,"mode":"urls","urls":["/gravel-bikes","/gravel-bikes?colour=red"]}},"by_pattern":{"summary":"Purge every address matching a pattern","value":{"mode":"patterns","patterns":["/gravel-bikes(/|\\?|$)"]}},"by_tag":{"summary":"Purge by Magento cache tag","value":{"mode":"tags","tags":["cat_p_1180","cat_c_27"]}},"everything":{"summary":"Purge everything","value":{"mode":"all"}}},"schema":{"$ref":"#/components/schemas/VarnishPurge"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"command":{"blocked_until_verified":false,"duration_ms":840,"error":null,"exit_code":0,"finished_at":"2026-11-06T09:16:41Z","id":905,"input":{"host":null,"mode":"tags","tags":["cat_p_1180","cat_c_27"],"target":"varnish","via":"api"},"kind":"varnish_purge","label":"Varnish purged · by tag","operation_id":null,"output_excerpt":"200","queued_at":"2026-11-06T09:16:40Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"result":{"confirmed":true,"count":2,"hosts":[],"mode":"tags","objects":null,"requests":1,"seconds":0,"sent":1,"target":"varnish"},"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-06T09:16:40Z","status":"succeeded","status_label":"Done"}},"schema":{"$ref":"#/components/schemas/VarnishCommandResult"}}},"description":"The purge was sent. `command.status` says how it went."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"command_running":{"summary":"Another action is running on the site","value":{"code":"command_running","message":"Another action is still running on this site. Wait for it to finish.","reason":"command_running"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}},"varnish_off":{"summary":"Varnish is off","value":{"code":"varnish_off","message":"Varnish is off on this environment. Magento's built-in cache is serving pages; flushing the Magento cache clears it. Purge Varnish is available once Varnish is switched on.","reason":"varnish_off"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The purge cannot run now. `reason` says why: `varnish_off` (Varnish is off), `varnish_not_offered` (not a Magento 2 site), `deleted` or `provisioning` (the site is deleted, or still being created), `busy`, `command_running`, `restore_running` or `deployment_running` (other work on the site has not finished), `exec_unresolved` or `install_running` (contact support), `removed` or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"host_not_owned":{"summary":"An address on another site's hostname","value":{"code":"host_not_owned","errors":{"urls.0":["old.harbourandfinch.example.org is not one of this site's hosts."]},"message":"old.harbourandfinch.example.org is not one of this site's hosts.","offenders":[{"field":"urls","index":0,"message":"old.harbourandfinch.example.org is not one of this site's hosts.","value":"https://old.harbourandfinch.example.org/x"}],"reason":"host_not_owned"}},"invalid_arguments":{"summary":"No way of purging was chosen","value":{"code":"invalid_arguments","errors":{"mode":["Choose what to purge: everything, tags, addresses or patterns."]},"field":"mode","message":"Choose what to purge: everything, tags, addresses or patterns.","offenders":[],"reason":"invalid_arguments"}},"invalid_tags":{"summary":"Not a tag","value":{"code":"invalid_tags","errors":{"tags.0":["\"cat p 99\" is not a tag: letters, digits and underscores only, up to 64 characters, such as cat_p_99."]},"message":"\"cat p 99\" is not a tag: letters, digits and underscores only, up to 64 characters, such as cat_p_99.","offenders":[{"field":"tags","index":0,"message":"\"cat p 99\" is not a tag: letters, digits and underscores only, up to 64 characters, such as cat_p_99.","value":"cat p 99"}],"reason":"invalid_tags"}},"no_tags":{"summary":"A purge by tag without its tags","value":{"code":"invalid_tags","errors":{"tags":["Give 1 to 50 Magento cache tags."]},"message":"Give 1 to 50 Magento cache tags.","offenders":[],"reason":"invalid_tags"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"What to purge is missing or wrong. `reason` is `invalid_arguments` (with `field`), or names the list that was refused: `invalid_tags`, `invalid_urls`, `invalid_pattern` or `host_not_owned` (an address on a hostname that is not the site's). `offenders` lists each refused item."},"429":{"content":{"application/json":{"examples":{"purges":{"summary":"The site's ten purges this hour are used","value":{"available_at":"2026-11-03T10:16:40Z","code":"rate_limited","message":"Ten purges an hour for this site have been used. The next is available in 60 minutes. Magento's own purges and deployments are not affected.","reason":"rate_limited","retry_after":3600,"retry_after_seconds":3600}},"rate_limited":{"summary":"The endpoint's request limit is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests (`rate_limited`): the endpoint's request limit, or the site's ten purges this hour, which the Control Panel and AI assistants spend too. Wait for `Retry-After`, which `retry_after_seconds` repeats; the purge allowance's answer also carries `retry_after` and `available_at`.","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"503":{"$ref":"#/components/responses/CommandsSwitchedOff"}},"summary":"Purge a site's Varnish cache","tags":["Varnish"],"x-effect":["deletes"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish","exec"],"x-rate-limit":{"also":[{"bucket":"reseller-varnish-purge","limit":10,"minutes":60,"per":"environment"}],"bucket":"reseller-varnish-purge","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/repair":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Sets Magento's own cache settings to match the site's Varnish again, for when `magento_config.state` reads `needs_repair`. It runs a command on the site: follow it while its `status` is `queued` or `running`. A site takes six repairs an hour, whoever asks and from wherever. The endpoint is not found while site functions are off for the platform.\n","operationId":"repairSiteVarnishCacheSettings","responses":{"200":{"content":{"application/json":{"example":{"command":{"blocked_until_verified":false,"duration_ms":840,"error":null,"exit_code":0,"finished_at":"2026-11-06T09:16:41Z","id":906,"input":null,"kind":"magento_varnish_config","label":"Repair Magento cache settings","operation_id":null,"output_excerpt":null,"queued_at":"2026-11-06T09:16:40Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"result":{"changed":true,"mode":"varnish"},"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-06T09:16:40Z","status":"succeeded","status_label":"Done"}},"schema":{"$ref":"#/components/schemas/VarnishCommandResult"}}},"description":"The repair finished within the request. `command.status` is `succeeded` or `failed`."},"202":{"content":{"application/json":{"example":{"command":{"blocked_until_verified":false,"duration_ms":null,"error":null,"exit_code":null,"finished_at":null,"id":906,"input":null,"kind":"magento_varnish_config","label":"Repair Magento cache settings","operation_id":null,"output_excerpt":null,"queued_at":"2026-11-06T09:16:40Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"site":{"domain":"harbourandfinch.example.com","id":1042},"started_at":"2026-11-06T09:16:40Z","status":"running","status_label":"Running"}},"schema":{"$ref":"#/components/schemas/VarnishCommandResult"}}},"description":"The repair is still running. Follow `command`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The id does not exist or is something you cannot change, Varnish is not on for your company (`feature_off`), or site functions are switched off (the plain `Not found.`)."},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"command_running":{"summary":"Another action is running on the site","value":{"code":"command_running","message":"Another action is still running on this site. Wait for it to finish.","reason":"command_running"}},"exec_unresolved":{"summary":"An earlier command has not been confirmed stopped","value":{"code":"exec_unresolved","message":"A previous command on this site has not been confirmed stopped. Contact support.","reason":"exec_unresolved"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_running":{"summary":"The site is not running normally","value":{"code":"not_running","message":"The site is not running normally. Try again once it has recovered.","reason":"not_running"}},"wrong_platform":{"summary":"Not a Magento 2 site","value":{"code":"wrong_platform","message":"This function is not available for WordPress sites","reason":"wrong_platform"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The repair runs a command on the site, and the site cannot take one now. `reason` says why: `wrong_platform` (not a Magento 2 site), `deleted` or `provisioning` (the site is deleted, or still being created), `not_running` (the site is not running normally), `busy`, `command_running`, `restore_running` or `deployment_running` (other work on the site has not finished), `exec_unresolved` or `install_running` (contact support), `removed` or `managed_elsewhere`."},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"The endpoint's request limit is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}},"repairs":{"summary":"The site's six repairs this hour are used","value":{"code":"rate_limited","message":"Too many Repair Magento cache settings runs on this site in the last hour. Try again later.","reason":"rate_limited","retry_after_seconds":3600}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests (`rate_limited`): the endpoint's request limit, or the site's six repairs this hour, which the Control Panel and AI assistants spend too. Wait for `Retry-After`, which `retry_after_seconds` repeats.","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"503":{"$ref":"#/components/responses/CommandsSwitchedOff"}},"summary":"Repair Magento's cache settings","tags":["Varnish"],"x-effect":["runs-code"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish","functions","exec"],"x-rate-limit":{"also":[{"bucket":"magento-varnish-config-repairs","limit":6,"minutes":60,"per":"environment"}],"bucket":"reseller-functions","limit":20,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/stats":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the cache's figures over the last hour, day or week, in equal steps: hits, misses, requests, the hit ratio, cached pages and memory, with the totals and the recent purges. `available` is false, with a `reason`, until the site has been sampled.\n","operationId":"getSiteVarnishStats","parameters":[{"description":"How far back.","example":"24h","in":"query","name":"range","required":false,"schema":{"enum":["1h","24h","7d"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"available":true,"bucket_seconds":3600,"buckets":[{"at":"2026-11-06T08:00:00Z","backend_errors":0,"backend_fetches":840,"bytes_free":402653184,"bytes_used":268435456,"evictions":0,"hit_ratio":0.9,"hits":5400,"misses":600,"objects":4200,"passes":240,"requests":6240,"requests_per_s":1.73,"reset":false,"samples":12,"storage_bytes":671088640,"transient_bytes":1048576}],"from":"2026-11-05T09:00:00Z","hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"purges_this_hour":{"available_at":null,"limit":10,"used":1},"range":"24h","reason":null,"recent_purges":[{"at":"2026-11-06T09:16:40Z","by":{"name":"Eleanor Finch"},"confirmed":true,"hosts":[],"id":905,"item_count":2,"items":["cat_p_1180","cat_c_27"],"mode":"tags","reference":null,"source":"person","status":"succeeded","trigger":null,"via":"api"},{"at":"2026-11-06T08:41:07Z","by":null,"confirmed":true,"hosts":[],"id":902,"item_count":0,"items":[],"mode":"all","reference":4821,"source":"deployment","status":"succeeded","trigger":"deployment","via":null}],"sampled_at":"2026-11-06T08:55:00Z","stale":false,"to":"2026-11-06T09:00:00Z","totals":{"backend_errors":0,"backend_fetches":20160,"bytes_free":402653184,"bytes_used":268435456,"evictions":0,"hit_ratio":0.9,"hit_ratio_7d":0.88,"hits":129600,"misses":14400,"missing":[],"objects":4200,"pass_ratio":0.04,"passes":5760,"peak_requests_per_s":6.2,"requests":149760,"requests_per_s":1.73,"resets":0,"storage_bytes":671088640,"transient_bytes":1048576}},"schema":{"$ref":"#/components/schemas/VarnishStats"}}},"description":"The statistics. `buckets` is shortened here."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}},"varnish_off":{"summary":"Varnish is off","value":{"code":"varnish_off","message":"Varnish is off on this environment. Switch Varnish on to see its statistics.","reason":"varnish_off"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not a Magento 2 site (`varnish_not_offered`), or Varnish is off (`varnish_off`)."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not a range","value":{"code":"invalid","errors":{"range":["range must be 1h, 24h or 7d."]},"field":"range","message":"range must be 1h, 24h or 7d.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`range` is not one of the three (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's Varnish statistics","tags":["Varnish"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish"],"x-rate-limit":{"bucket":"corecluster-varnish-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/vcl":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the three snippets a site may add to the platform's VCL, the `version` every save sends back, the revision Varnish runs and the limits.\n","operationId":"getSiteVarnishVcl","responses":{"200":{"content":{"application/json":{"example":{"applied_at":"2026-11-02T15:41:09Z","applied_by":{"mcp":false,"name":"Eleanor Finch"},"applied_revision":1,"available":true,"enabled":true,"hooks":{"backend_response":"# Your vcl_backend_response snippet. Empty means the platform VCL only.\n","deliver":"# Your vcl_deliver snippet. Empty means the platform VCL only.\n","recv":"if (req.url ~ \"^/stock-checker/\") {\n    return (pass);\n}\n"},"limits":{"per_hook_bytes":16384,"statements_per_hook":200,"total_bytes":49152,"used":{"backend_response_bytes":72,"deliver_bytes":63,"recv_bytes":57,"total_bytes":192}},"locked":false,"platform":{"content_url":"/api/corestack/sites/1042/varnish/vcl/platform"},"policy_url":"/api/corestack/sites/1042/varnish/vcl/policy","refusal":null,"revert":null,"revision":1,"snippets_url":"/api/corestack/sites/1042/varnish/vcl/snippets","status":"applied","status_reason":null,"varnish_version":"7.7","version":1},"schema":{"$ref":"#/components/schemas/VarnishVcl"}}},"description":"The site's custom VCL."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not a Magento 2 site (`varnish_not_offered`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a site's custom VCL","tags":["Varnish"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish","varnish_vcl"],"x-rate-limit":{"bucket":"corecluster-varnish-vcl-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"put":{"description":"Saves the snippets sent in `hooks`: a snippet left out stays as it is. Send the `version` from the last read. The VCL is checked against the policy, compiled, saved and loaded by Varnish, which takes about a minute; one that Varnish refuses or that breaks the shop's home page is put back automatically.\n","operationId":"replaceSiteVarnishVcl","requestBody":{"content":{"application/json":{"examples":{"save":{"summary":"Cache the size guides for a day","value":{"hooks":{"backend_response":"if (bereq.url ~ \"^/size-guides/\") { set beresp.ttl = 1d; }"},"note":"Cache the size guides for a day","version":1}}},"schema":{"$ref":"#/components/schemas/VarnishVclUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"unchanged":{"summary":"The site already has this VCL","value":{"operation":null,"revision":null}},"varnish_off":{"summary":"Saved while Varnish is off","value":{"applied":false,"message":"Saved. Varnish is off on this environment, so the VCL applies when it is switched on.","operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:40Z","completed_at":"2026-11-06T09:17:22Z","created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5125,"install":null,"label":null,"notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"completed","status_label":"Done","step":null,"steps":[{"key":"policy","label":"Checked against the policy","state":"done"},{"key":"compiled","label":"Compiled","state":"done"},{"key":"loaded","label":"Loaded by Varnish","state":"done"},{"key":"checked","label":"Checked","state":"done"}],"subject":null,"summary":"Varnish VCL","to_version":null,"type":"varnish_vcl_change","type_label":"Varnish VCL"},"revision":{"number":2,"status":"saved_dormant"},"varnish_off":true,"warnings":[]}}},"schema":{"$ref":"#/components/schemas/VarnishVclSaveResult"}}},"description":"Nothing to follow: the VCL is what the site already has (`revision` and `operation` null), or Varnish is off, so the VCL was saved and loads when Varnish is switched on (`varnish_off: true`)."},"202":{"content":{"application/json":{"example":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:40Z","completed_at":null,"created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5125,"install":null,"label":"Loaded by Varnish","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"loaded","steps":[{"key":"policy","label":"Checked against the policy","state":"done"},{"key":"compiled","label":"Compiled","state":"done"},{"key":"loaded","label":"Loaded by Varnish","state":"current"},{"key":"checked","label":"Checked","state":"todo"}],"subject":null,"summary":"Varnish VCL","to_version":null,"type":"varnish_vcl_change","type_label":"Varnish VCL"},"revision":{"number":2,"status":"saving"},"warnings":[]},"schema":{"$ref":"#/components/schemas/VarnishVclSaveResult"}}},"description":"The VCL was saved and is being loaded, which takes about a minute. Follow `operation`: its `vcl.outcome` says whether Varnish loaded it."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"stale":{"summary":"The VCL changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale","version":1}},"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}},"varnish_off":{"summary":"Varnish has never been set up on the site","value":{"code":"varnish_off","message":"Switch Varnish on first: this environment has no VCL hooks yet.","reason":"varnish_off"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The save was refused because of the site's state. `reason` says why: `stale` (the VCL changed since your read; `version` is the current one), `varnish_off` (Varnish has never been set up on the site: switch it on first), `varnish_not_offered` (not a Magento 2 site), `busy`, `restore_running` or `cluster_paused` (other work has not finished, or changes to the site's cluster are paused), `conflict` (another change landed first: try again), `removed` or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"A field is missing or wrong","value":{"code":"invalid","errors":{"hooks":["hooks is an object of recv, backend_response and deliver, each text or null."]},"field":"hooks","message":"hooks is an object of recv, backend_response and deliver, each text or null.","reason":"invalid"}},"vcl_invalid":{"summary":"The VCL breaks the policy","value":{"code":"vcl_invalid","diagnostics":[{"code":"VN-POL-09","column":5,"hook":"recv","kind":"policy","line":1,"message":"vcl_recv runs after the front's access control (HTTP authentication, the allow-list, maintenance), which judged the original URL and host: a snippet may not change req.url, the Host header or another routing header (X-Original-URL, X-Rewrite-URL, X-HTTP-Method-Override, X-HTTP-Method, X-Method-Override). Redirect with return (synth(301, \"...\")) instead.","severity":"error"}],"message":"This VCL cannot be saved: fix the errors shown.","reason":"vcl_invalid"}},"vcl_locked":{"summary":"Corefinity manages the site's VCL","value":{"code":"vcl_locked","message":"Corefinity manages this environment's VCL. Contact support to change it.","reason":"vcl_locked"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), the VCL breaks the policy (`vcl_invalid`) or does not compile (`vcl_compile_failed`), each with `diagnostics`, or Corefinity manages the site's VCL (`vcl_locked`). Nothing was saved."},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"The endpoint's request limit is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}},"saves":{"summary":"The environment's 20 saves this minute are used","value":{"code":"rate_limited","message":"Too many VCL saves on this environment. Try again in 60 seconds.","reason":"rate_limited","retry_after":60,"retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests (`rate_limited`): the endpoint's request limit, or the 20 VCL saves and reverts a minute this environment takes from the API and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats; the save allowance's answer also carries `retry_after`.","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"503":{"content":{"application/json":{"examples":{"upstream_unavailable":{"summary":"The site's files could not be read","value":{"code":"upstream_unavailable","message":"The environment's files could not be read. Try again in a minute.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site's files could not be read, so nothing was saved (`upstream_unavailable`). Try again in a minute."}},"summary":"Replace a site's custom VCL","tags":["Varnish"],"x-effect":["changes-settings","overwrites"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish","varnish_vcl"],"x-long-running":"getSiteVarnishOperation","x-rate-limit":{"also":[{"bucket":"corecluster-varnish-vcl-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"corecluster-varnish-vcl-write","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/vcl/platform":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the VCL the platform runs for the site, read only, and where each of your snippets is inserted into it.\n","operationId":"getSiteVarnishPlatformVcl","responses":{"200":{"content":{"application/json":{"example":{"content":"vcl 4.1;\n\nimport std;\n\nsub vcl_recv {\n    # ...\n}\n","insertion":{"backend_response":212,"deliver":264,"recv":118}},"schema":{"$ref":"#/components/schemas/VarnishPlatformVcl"}}},"description":"The platform's VCL."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not a Magento 2 site (`varnish_not_offered`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the platform's part of the VCL","tags":["Varnish"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish","varnish_vcl"],"x-rate-limit":{"bucket":"corecluster-varnish-vcl-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/vcl/policy":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers every rule a snippet must follow: where each snippet runs, what it may read and set, what is refused and the limits. Each refusal's code, such as `VN-POL-09`, is the `code` of a diagnostic.\n","operationId":"getSiteVarnishVclPolicy","responses":{"200":{"content":{"application/json":{"example":{"hook_order":["recv","backend_response","deliver"],"hooks":{"deliver":{"header_root":"resp","key":"varnish-deliver.vcl","placement":"vcl_deliver, before the platform's header hygiene","refused_references":[],"reserved_headers":["Set-Cookie"],"returns":[],"routing_headers":[],"secret_headers_readable":false,"stub":"# Your vcl_deliver snippet. Empty means the platform VCL only.\n","sub":"vcl_deliver","writable":[]}},"name":"CoreStack Magento 2 customer VCL hooks","policy_version":2,"refused_hooks":{"hash":"VN-POL-05","pipe":"VN-POL-07"},"refused_writes":{"req.method":"VN-POL-02","req.url":"VN-POL-09"}},"schema":{"$ref":"#/components/schemas/VarnishVclPolicy"}}},"description":"The policy, shortened here."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not a Magento 2 site (`varnish_not_offered`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"content":{"application/json":{"examples":{"temporarily_unavailable":{"summary":"Try again in a moment","value":{"code":"temporarily_unavailable","message":"The VCL policy cannot be read right now. Please try again in a moment.","reason":"temporarily_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The policy cannot be read at the moment (`temporarily_unavailable`). Try again in a moment."}},"summary":"Get the VCL policy","tags":["Varnish"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish","varnish_vcl"],"x-rate-limit":{"bucket":"corecluster-varnish-vcl-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/vcl/revisions":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Lists the revisions of the site's custom VCL, newest first, 20 a page; revision 0 is the empty snippets the site started with. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.","operationId":"listSiteVarnishVclRevisions","parameters":[{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"content":{"application/json":{"example":{"next_cursor":null,"revisions":[{"applied":true,"author":"Eleanor Finch","created_at":"2026-11-02T15:41:09Z","current":true,"diagnostics":{"errors":0,"warnings":0},"hooks":["recv"],"id":41,"mcp":false,"note":"Never cache the stock checker","number":1,"operation_id":5120,"origin":"save","status":"applied"},{"applied":false,"author":"Corefinity","created_at":"2026-11-01T10:02:11Z","current":false,"diagnostics":{"errors":0,"warnings":0},"hooks":["recv","backend_response","deliver"],"id":40,"mcp":false,"number":0,"operation_id":null,"origin":"platform","status":"applied"}]},"schema":{"$ref":"#/components/schemas/VarnishVclRevisionPage"}}},"description":"A page of revisions."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not a Magento 2 site (`varnish_not_offered`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's VCL revisions","tags":["Varnish"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish","varnish_vcl"],"x-rate-limit":{"bucket":"corecluster-varnish-vcl-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/vcl/revisions/{number}":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"A revision's `number`, from the list. The first is 0.","in":"path","name":"number","required":true,"schema":{"minimum":0,"type":"integer"}}],"get":{"description":"Answers one revision with its three snippets and a unified diff of each against the VCL now, or against another revision.\n","operationId":"getSiteVarnishVclRevision","parameters":[{"description":"The number of the revision to compare with, or `current` (the default).","in":"query","name":"against","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"against":1,"applied":false,"author":"Corefinity","content":{"backend_response":"# Your vcl_backend_response snippet. Empty means the platform VCL only.\n","deliver":"# Your vcl_deliver snippet. Empty means the platform VCL only.\n","recv":"# Your vcl_recv snippet. Empty means the platform VCL only.\n"},"content_sha256":"3b4323671f111e8235c1f2dec5c8b2757c2ceddb81a234dda5df7b02c7306bfa","created_at":"2026-11-01T10:02:11Z","current":false,"diagnostics":{"errors":0,"warnings":0},"diagnostics_list":[],"diff":{"backend_response":null,"deliver":null,"recv":"--- revision 1\n+++ revision 0\n@@ -1,3 +1,1 @@\n-if (req.url ~ \"^/stock-checker/\") {\n-    return (pass);\n-}\n+# Your vcl_recv snippet. Empty means the platform VCL only.\n"},"hooks":["recv","backend_response","deliver"],"id":40,"mcp":false,"number":0,"operation_id":null,"origin":"platform","status":"applied"},"schema":{"$ref":"#/components/schemas/VarnishVclRevisionDetail"}}},"description":"The revision and its differences."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not a Magento 2 site (`varnish_not_offered`)."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not a revision","value":{"code":"invalid","errors":{"against":["against is current or a revision number."]},"field":"against","message":"against is current or a revision number.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`against` is not `current` or a revision number (`invalid`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get one VCL revision","tags":["Varnish"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish","varnish_vcl"],"x-rate-limit":{"bucket":"corecluster-varnish-vcl-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/vcl/revisions/{number}/revert":{"parameters":[{"$ref":"#/components/parameters/site"},{"description":"A revision's `number`, from the list. The first is 0.","in":"path","name":"number","required":true,"schema":{"minimum":0,"type":"integer"}}],"post":{"description":"Saves a revision's snippets again, as a new revision, and loads it like any save. It takes no body.\n","operationId":"restoreSiteVarnishVclRevision","responses":{"200":{"content":{"application/json":{"examples":{"unchanged":{"summary":"The site already has this VCL","value":{"operation":null,"revision":null}},"varnish_off":{"summary":"Saved while Varnish is off","value":{"applied":false,"message":"Saved. Varnish is off on this environment, so the VCL applies when it is switched on.","operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:40Z","completed_at":"2026-11-06T09:17:22Z","created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5125,"install":null,"label":null,"notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"completed","status_label":"Done","step":null,"steps":[{"key":"policy","label":"Checked against the policy","state":"done"},{"key":"compiled","label":"Compiled","state":"done"},{"key":"loaded","label":"Loaded by Varnish","state":"done"},{"key":"checked","label":"Checked","state":"done"}],"subject":null,"summary":"Varnish VCL","to_version":null,"type":"varnish_vcl_change","type_label":"Varnish VCL"},"revision":{"number":2,"status":"saved_dormant"},"varnish_off":true,"warnings":[]}}},"schema":{"$ref":"#/components/schemas/VarnishVclSaveResult"}}},"description":"Nothing to follow: the VCL is what the site already has (`revision` and `operation` null), or Varnish is off, so the VCL was saved and loads when Varnish is switched on (`varnish_off: true`)."},"202":{"content":{"application/json":{"example":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:16:40Z","completed_at":null,"created_at":"2026-11-06T09:16:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5125,"install":null,"label":"Loaded by Varnish","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"loaded","steps":[{"key":"policy","label":"Checked against the policy","state":"done"},{"key":"compiled","label":"Compiled","state":"done"},{"key":"loaded","label":"Loaded by Varnish","state":"current"},{"key":"checked","label":"Checked","state":"todo"}],"subject":null,"summary":"Varnish VCL","to_version":null,"type":"varnish_vcl_change","type_label":"Varnish VCL"},"revision":{"number":2,"status":"saving"},"warnings":[]},"schema":{"$ref":"#/components/schemas/VarnishVclSaveResult"}}},"description":"The VCL was saved and is being loaded, which takes about a minute. Follow `operation`: its `vcl.outcome` says whether Varnish loaded it."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The feature is not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"no_such_revision":{"summary":"The site has no revision with that number","value":{"code":"not_found","message":"That revision does not exist.","reason":"not_found"}},"not_found":{"summary":"Not found, or not yours to see","value":{"message":"Not found."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/FeatureOffRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site does not exist or is something you cannot change, the site has no revision with that number (`not_found`), or the feature is not on for your company (`feature_off`)."},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}},"varnish_off":{"summary":"Varnish has never been set up on the site","value":{"code":"varnish_off","message":"Switch Varnish on first: this environment has no VCL hooks yet.","reason":"varnish_off"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The revert was refused because of the site's state. `reason` says why: `varnish_off` (Varnish has never been set up on the site: switch it on first), `varnish_not_offered` (not a Magento 2 site), `busy`, `restore_running` or `cluster_paused` (other work has not finished, or changes to the site's cluster are paused), `conflict` (another change landed first: try again), `removed` or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"vcl_invalid":{"summary":"The VCL breaks the policy","value":{"code":"vcl_invalid","diagnostics":[{"code":"VN-POL-09","column":5,"hook":"recv","kind":"policy","line":1,"message":"vcl_recv runs after the front's access control (HTTP authentication, the allow-list, maintenance), which judged the original URL and host: a snippet may not change req.url, the Host header or another routing header (X-Original-URL, X-Rewrite-URL, X-HTTP-Method-Override, X-HTTP-Method, X-Method-Override). Redirect with return (synth(301, \"...\")) instead.","severity":"error"}],"message":"This VCL cannot be saved: fix the errors shown.","reason":"vcl_invalid"}},"vcl_locked":{"summary":"Corefinity manages the site's VCL","value":{"code":"vcl_locked","message":"Corefinity manages this environment's VCL. Contact support to change it.","reason":"vcl_locked"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The VCL breaks the policy (`vcl_invalid`) or does not compile on the site's Varnish version (`vcl_compile_failed`), each with `diagnostics`, or Corefinity manages the site's VCL (`vcl_locked`). Nothing was saved."},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"The endpoint's request limit is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}},"saves":{"summary":"The environment's 20 saves this minute are used","value":{"code":"rate_limited","message":"Too many VCL saves on this environment. Try again in 60 seconds.","reason":"rate_limited","retry_after":60,"retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests (`rate_limited`): the endpoint's request limit, or the 20 VCL saves and reverts a minute this environment takes from the API and AI assistants together. Wait for `Retry-After`, which `retry_after_seconds` repeats; the save allowance's answer also carries `retry_after`.","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"503":{"content":{"application/json":{"examples":{"upstream_unavailable":{"summary":"The site's files could not be read","value":{"code":"upstream_unavailable","message":"The environment's files could not be read. Try again in a minute.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site's files could not be read, so nothing was saved (`upstream_unavailable`). Try again in a minute."}},"summary":"Restore a VCL revision","tags":["Varnish"],"x-effect":["changes-settings","overwrites"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish","varnish_vcl"],"x-long-running":"getSiteVarnishOperation","x-rate-limit":{"also":[{"bucket":"corecluster-varnish-vcl-save","limit":20,"minutes":1,"per":"environment"}],"bucket":"corecluster-varnish-vcl-write","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/vcl/snippets":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Lists ready-made snippets, each with the hook it belongs in.\n","operationId":"listSiteVarnishVclSnippets","responses":{"200":{"content":{"application/json":{"example":{"snippets":[{"content":"# Never cache the stock checker\nif (req.url ~ \"^/stock-checker/\") {\n    return (pass);\n}\n","description":"Never cache requests under a path (a stock checker, a quote tool).","hook":"recv","id":"bypass-path","title":"Bypass a path"}]},"schema":{"properties":{"snippets":{"items":{"$ref":"#/components/schemas/VarnishVclSnippet"},"type":"array"}},"required":["snippets"],"type":"object"}}},"description":"The snippets, shortened here."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not a Magento 2 site (`varnish_not_offered`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List ready-made VCL","tags":["Varnish"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish","varnish_vcl"],"x-rate-limit":{"bucket":"corecluster-varnish-vcl-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/vcl/validate":{"parameters":[{"$ref":"#/components/parameters/site"}],"post":{"description":"Checks the snippets sent in `hooks` against the policy and, when they pass, compiles them with the site's Varnish version, or with `varnish_version`. Nothing is saved.\n","operationId":"checkSiteVarnishVcl","requestBody":{"content":{"application/json":{"examples":{"check":{"summary":"Check a snippet that never caches one path","value":{"hooks":{"recv":"if (req.url ~ \"^/stock-checker/\") {\n    return (pass);\n}\n"}}}},"schema":{"$ref":"#/components/schemas/VarnishVclCheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"refused":{"summary":"The policy refuses a line","value":{"diagnostics":[{"code":"VN-POL-09","column":5,"hook":"recv","kind":"policy","line":1,"message":"vcl_recv runs after the front's access control (HTTP authentication, the allow-list, maintenance), which judged the original URL and host: a snippet may not change req.url, the Host header or another routing header (X-Original-URL, X-Rewrite-URL, X-HTTP-Method-Override, X-HTTP-Method, X-Method-Override). Redirect with return (synth(301, \"...\")) instead.","severity":"error"}],"test":null,"valid":false}},"valid":{"summary":"The VCL passes and compiles","value":{"diagnostics":[],"test":{"id":21,"outcome":"passed","reason":null,"skipped":false,"varnish":"7.7.3"},"valid":true}}},"schema":{"$ref":"#/components/schemas/VarnishVclCheckResult"}}},"description":"What the check found. `valid` is false when a diagnostic is an error."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}},"varnish_off":{"summary":"Varnish has never been set up on the site","value":{"code":"varnish_off","message":"Switch Varnish on first: this environment has no VCL hooks yet.","reason":"varnish_off"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not a Magento 2 site (`varnish_not_offered`), Varnish has never been set up on it (`varnish_off`: switch it on first), or it is managed by another control panel (`managed_elsewhere`)."},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"No hooks","value":{"code":"invalid","errors":{"hooks":["hooks is an object of recv, backend_response and deliver, each text or null."]},"field":"hooks","message":"hooks is an object of recv, backend_response and deliver, each text or null.","reason":"invalid"}},"version_not_available":{"summary":"A version that is not available yet","value":{"code":"version_unsupported","message":"That Varnish version is not available yet.","reason":"version_unsupported"}},"version_unsupported":{"summary":"Not a version Varnish is offered in","value":{"code":"version_unsupported","message":"That Varnish version is not offered.","reason":"version_unsupported"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or `varnish_version` is not a version Varnish is offered in, or one that is not available yet (`version_unsupported`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"content":{"application/json":{"examples":{"upstream_unavailable":{"summary":"The site's files could not be read","value":{"code":"upstream_unavailable","message":"The environment's files could not be read. Try again in a minute.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site's files could not be read, so nothing was checked (`upstream_unavailable`). Try again in a minute."}},"summary":"Check custom VCL without saving","tags":["Varnish"],"x-effect":["none"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish","varnish_vcl"],"x-rate-limit":{"bucket":"corecluster-varnish-vcl-validate","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/version":{"parameters":[{"$ref":"#/components/parameters/site"}],"put":{"description":"Moves the site to another Varnish version while Varnish is on. A version past its end of life needs `acknowledge: [\"eol\"]` and is refused `ack_required` without it. The site's custom VCL is compiled on the new version first; one that does not compile is refused `vcl_incompatible`. Follow the operation in the answer; with `apply` set to `tonight` or `window`, the change waits for the site's maintenance window.\n","operationId":"updateSiteVarnishVersion","requestBody":{"content":{"application/json":{"examples":{"change":{"summary":"Move to Varnish 8.0","value":{"acknowledge":["eol"],"version":"8.0"}}},"schema":{"$ref":"#/components/schemas/VarnishVersionChange"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"queued":{"summary":"The change waits for the site's window","value":{"item_id":77,"operation":null,"queued":true,"window_date":"2026-11-07"}},"started":{"summary":"The version change started","value":{"operation":{"committed_at":"2026-11-06T09:16:41+00:00","completed_at":null,"created_at":"2026-11-06T09:16:40+00:00","error":null,"failure_reason":null,"from_version":"7.7","id":5124,"label":"Picked up by the platform","requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"current"},{"key":"restarted","label":"Applying","state":"todo"},{"key":"healthy","label":"Healthy","state":"todo"},{"key":"checked","label":"Checked","state":"todo"}],"to_version":"8.0","type":"varnish_version","type_label":"Varnish version"}}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/VarnishChangeStarted"},{"$ref":"#/components/schemas/QueuedChange"}]}}},"description":"The change started (`operation`), or waits for the site's window (`queued: true`)."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"image_not_offered":{"summary":"That version cannot be used at the moment","value":{"code":"image_not_offered","message":"The version this change needs is not available right now. Nothing was changed.","reason":"image_not_offered"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"unchanged":{"summary":"The site is on that version already","value":{"code":"unchanged","message":"This environment already runs Varnish 7.7.","reason":"unchanged"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change was refused because of the site's state. `reason` says why: `unchanged` (the site is on that version already), `stale` (the site's Varnish changed since the choice was made: read it again), `busy`, `restore_running`, `deployment_running`, `command_running` or `snapshot_running` (other work on the site has not finished), `cluster_paused` (changes to the site's cluster are paused), `change_pending` (with `apply`: a change already waits for the window), `image_not_offered` (that version cannot be used at the moment), `conflict` (another change landed first: try again), `removed` or `managed_elsewhere`."},"422":{"content":{"application/json":{"examples":{"ack_required":{"summary":"A version past its end of life, not acknowledged","value":{"code":"ack_required","detail":{"eol":"Varnish 8.0 no longer receives fixes from its upstream project; Corefinity keeps its image patched."},"message":"Confirm what this change does before it starts.","reason":"ack_required","required":["eol"]}},"feature_off":{"summary":"The change cannot wait for a window at the moment","value":{"code":"feature_off","errors":{"apply":["Queuing changes for the maintenance window is switched off at the moment"]},"message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}},"invalid":{"summary":"No version","value":{"code":"invalid","errors":{"version":["Send the version to change to."]},"field":"version","message":"Send the version to change to.","reason":"invalid"}},"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish runs on Magento 2 environments only.","reason":"varnish_not_offered"}},"varnish_off":{"summary":"Varnish is off","value":{"code":"varnish_off","message":"Switch Varnish on to choose its version.","reason":"varnish_off"}},"vcl_incompatible":{"summary":"The site's custom VCL does not compile on that version","value":{"code":"vcl_incompatible","diagnostics":[{"column":5,"hook":"recv","kind":"compile","line":2,"message":"Unknown variable in this version.","severity":"error"}],"message":"Your VCL does not compile on Varnish 8.0.","reason":"vcl_incompatible"}},"version_unsupported":{"summary":"That version is not offered","value":{"code":"version_unsupported","message":"Varnish 5.2 is not offered for this environment: it is not one of its versions.","reason":"version_unsupported"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`, with `field` and `errors`), or the change was refused for a reason of its own: `ack_required` (the version is past its end of life: `required` lists what `acknowledge` must carry and `detail` says why), `version_unsupported` (that version is not offered for the site), `varnish_off` (switch Varnish on first), `varnish_not_offered` (not a Magento 2 site), `vcl_incompatible` (the site's custom VCL does not compile on that version; `diagnostics` lists each problem), `unmanageable` (the site's Varnish version cannot be changed here: contact support) or `feature_off` when `apply` asks for a window and changes cannot wait for one at the moment."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"upstream_unavailable":{"summary":"The site's settings could not be read","value":{"code":"upstream_unavailable","message":"The site's settings could not be read; try again shortly.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site's settings could not be read, so nothing was changed (`upstream_unavailable`). Try again shortly."},"503":{"content":{"application/json":{"examples":{"vcl_check_unavailable":{"summary":"The VCL could not be checked just now","value":{"code":"vcl_check_unavailable","message":"Your VCL could not be checked against Varnish 8.0 just now. Try again in a minute.","reason":"vcl_check_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site's custom VCL could not be checked against that version just now (`vcl_check_unavailable`), so nothing was changed. Try again in a minute."}},"summary":"Update a site's Varnish version","tags":["Varnish"],"x-effect":["changes-settings"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish"],"x-long-running":"getSiteVarnishOperation","x-rate-limit":{"bucket":"reseller-operations","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/sites/{site}/varnish/versions":{"parameters":[{"$ref":"#/components/parameters/site"}],"get":{"description":"Answers the Varnish versions the site's Magento may use, on their own.\n","operationId":"listSiteVarnishVersions","responses":{"200":{"content":{"application/json":{"example":{"default_version":"7.7","enabled":true,"options":[{"allowed":true,"current":false,"reason":null,"status":"eol","version":"8.0"},{"allowed":false,"current":true,"reason":"This is the current version","status":"eol","version":"7.7"},{"allowed":true,"current":false,"reason":null,"status":"lts","version":"6.0"}],"version":"7.7"},"schema":{"$ref":"#/components/schemas/VarnishVersions"}}},"description":"The versions."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"409":{"content":{"application/json":{"examples":{"varnish_not_offered":{"summary":"Not a Magento 2 site","value":{"code":"varnish_not_offered","message":"Varnish is available for Magento 2 sites only.","reason":"varnish_not_offered"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not a Magento 2 site (`varnish_not_offered`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a site's Varnish versions","tags":["Varnish"],"x-feature":"varnish","x-file":"varnish","x-gates":["varnish"],"x-rate-limit":{"bucket":"corecluster-varnish-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/snapshots/{snapshot}":{"parameters":[{"$ref":"#/components/parameters/snapshot"}],"get":{"description":"Answers one snapshot. While it is being taken or deleted, a read checks its progress first when the last check\nis more than a few seconds old, so polling this endpoint follows it to `ready`, `failed` or `deleted`.\n","operationId":"getSnapshot","responses":{"200":{"content":{"application/json":{"examples":{"ready":{"$ref":"#/components/examples/SnapshotReadyExample"}},"schema":{"$ref":"#/components/schemas/Snapshot"}}},"description":"The snapshot."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a snapshot","tags":["Snapshots"],"x-feature":"snapshots","x-file":"snapshots","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"patch":{"description":"Sets the snapshot's `note`, keeps it (`protected` true) or stops keeping it. A kept snapshot is not removed by\nretention or by the quota. Both fields are optional.\n","operationId":"updateSnapshot","requestBody":{"content":{"application/json":{"examples":{"clear_note":{"summary":"Clear the note","value":{"note":null}},"note":{"summary":"Change the note","value":{"note":"Before the PHP 8.4 move"}}},"schema":{"$ref":"#/components/schemas/SnapshotUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"noted":{"$ref":"#/components/examples/SnapshotReadyExample"}},"schema":{"$ref":"#/components/schemas/Snapshot"}}},"description":"The snapshot as it is now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"deleted":{"summary":"The snapshot has been deleted","value":{"code":"state","message":"This snapshot has been deleted","reason":"state"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The snapshot cannot be changed now (`state`). The message says why: it has been deleted, it is the final\nsnapshot of a deleted site, or it cannot be kept.\n"},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"The note is too long","value":{"code":"invalid","errors":{"note":["The note may not be greater than 140 characters."]},"field":"note","message":"The note may not be greater than 140 characters.","reason":"invalid"}},"keep_cap_reached":{"summary":"Kept snapshots use the whole keep allowance","value":{"code":"keep_cap_reached","message":"Kept snapshots already use the most space allowed. Stop keeping another snapshot first.","reason":"keep_cap_reached"}},"not_ready":{"summary":"The snapshot is not ready","value":{"code":"state","message":"Only a ready snapshot can be protected","reason":"state"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is wrong (`invalid`), the snapshot cannot be kept (`state`: it is not ready, or its size is not\nknown yet), or kept snapshots already use your whole keep allowance (the examples show the reason it\nanswers).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a snapshot's note or keep","tags":["Snapshots"],"x-effect":["changes-settings"],"x-feature":"snapshots","x-file":"snapshots","x-gates":[],"x-rate-limit":{"bucket":"reseller-snapshot-changes","limit":30,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"},"delete":{"description":"Deletes the snapshot, kept or not, so it can no longer be restored. Answers `202` with `status` `deleting`;\nread it with `GET /corestack/snapshots/{snapshot}` until `status` is `deleted`.\n","operationId":"deleteSnapshot","responses":{"202":{"content":{"application/json":{"examples":{"deleting":{"$ref":"#/components/examples/SnapshotDeletingExample"}},"schema":{"$ref":"#/components/schemas/Snapshot"}}},"description":"The snapshot, which is now being deleted."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"in_flight":{"summary":"The snapshot is still being taken","value":{"code":"in_flight","message":"This snapshot is still being taken. Try again when it has finished.","reason":"in_flight"}},"in_use":{"summary":"A restore is using the snapshot","value":{"code":"state","message":"This snapshot is being used by a restore. Try again when it has finished.","reason":"state"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The snapshot cannot be deleted now: it is still being taken (`in_flight`), or it is in use by a restore or\na copy, already deleted or kept for a deleted site (`state`; the message says which).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"not_deleted":{"summary":"The delete could not be started","value":{"code":"state","message":"The snapshot could not be deleted. Try again later.","reason":"state"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The delete could not be started (`state`). Try again later. When the site's storage answers the delete\nwith an error, this same body is sent with the status the storage gave, which can be another `4xx` or\n`5xx` status than `502`: go by the `reason` and the message, not the status alone.\n"}},"summary":"Delete a snapshot","tags":["Snapshots"],"x-effect":["deletes"],"x-feature":"snapshots","x-file":"snapshots","x-gates":[],"x-rate-limit":{"bucket":"reseller-snapshot-changes","limit":30,"minutes":1},"x-scope":"destructive","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/terminal/sessions/{session}/transcript":{"parameters":[{"description":"The session's id, as the session list answers it.","example":6318,"in":"path","name":"session","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers the recording of a terminal session you opened, as an asciicast file. A recording shows everything\ntyped and printed in the session, so it needs the `exec` scope, is never cached, and each download is recorded. Recordings are kept\nfor 90 days.\n","operationId":"downloadTerminalTranscript","responses":{"200":{"content":{"application/x-asciicast":{"example":"{\"version\": 2, \"width\": 120, \"height\": 30}\n[0.5, \"o\", \"php -v\\r\\n\"]\n","schema":{"type":"string"}}},"description":"The recording, in asciicast version 2 format.","headers":{"Cache-Control":{"description":"Always `no-store, private`: a recording is never cached, and neither is any refusal of this endpoint.","schema":{"type":"string"}},"Content-Disposition":{"description":"`attachment`, with the file name.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff","description":"The id does not exist, the session is not one you opened, it has no recording, or the feature is not on for your company (`feature_off`)."},"410":{"content":{"application/json":{"example":{"code":"expired","message":"This transcript has been deleted. Transcripts are kept for 90 days.","reason":"expired"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The recording was deleted when its 90 days ended (`expired`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Download a terminal session's recording","tags":["Terminal"],"x-feature":"terminal","x-file":"terminal","x-gates":["terminal"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/corestack/uat-sizes":{"get":{"description":"Lists the sizes a CoreStack site's staging environment can have and the size each package includes. Any\nsigned-in person can read it.\n","operationId":"listStagingSizes","parameters":[{"description":"Answer the sizes and inclusions for one platform, such as `wordpress`, `magento2`, `laravel` or `shopware`. A platform that does not exist is refused `422` on `platform`.","example":"wordpress","in":"query","name":"platform","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"included":{"cs4":{"count":1,"size":"xsmall"}},"sizes":[{"cores":0.5,"disk_gb":20,"key":"xsmall","label":"Extra small","memory_gib":2,"requests":{"cpu_millicores":250,"memory_bytes":2147483648},"sort":1},{"cores":1,"disk_gb":50,"key":"small","label":"Small","memory_gib":4,"requests":{"cpu_millicores":500,"memory_bytes":4294967296},"sort":2},{"cores":2,"disk_gb":100,"key":"medium","label":"Medium","memory_gib":8,"requests":{"cpu_millicores":1000,"memory_bytes":8589934592},"sort":3},{"cores":4,"disk_gb":200,"key":"large","label":"Large","memory_gib":16,"requests":{"cpu_millicores":2000,"memory_bytes":17179869184},"sort":4}]},"schema":{"$ref":"#/components/schemas/EnvironmentStagingSizes"}}},"description":"The sizes."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/FeatureOff"},"422":{"content":{"application/json":{"examples":{"platform":{"summary":"A platform that does not exist","value":{"code":"invalid","errors":{"platform":["That platform is not one we offer."]},"field":"platform","message":"That platform is not one we offer.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`platform` is not a platform."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List the staging sizes","tags":["Environments"],"x-feature":"environments","x-file":"environments","x-gates":["corestack_create"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/websites":{"get":{"description":"Lists the websites of your own company and the CoreStack sites you can open that belong to another company: a\nclient's site your company manages as its agency. Each comes with its environments, most recently changed\nfirst. A client's other websites are the client's own and are not listed. Paged by page number: `page`, up to\n100000, and `per_page`.\n","operationId":"listManagedWebsites","parameters":[{"description":"Part of the website's name or address, its company's name, or an environment's name or address. Up to 200 characters.","in":"query","name":"search","required":false,"schema":{"maxLength":200,"type":"string"}},{"description":"Only websites of this product.","in":"query","name":"kind","required":false,"schema":{"enum":["enterprise","corestack","corecluster","mixed"],"type":"string"}},{"description":"Only websites in this status: 0 inactive, 1 pending setup, 2 onboarding, 3 active.","in":"query","name":"status","required":false,"schema":{"enum":[0,1,2,3],"type":"integer"}},{"description":"Only websites on this platform, such as `wordpress`.","in":"query","name":"platform","required":false,"schema":{"type":"string"}},{"description":"Only websites in this region, by its code, such as `uk`.","in":"query","name":"region","required":false,"schema":{"type":"string"}},{"description":"Only websites in this CoreCluster of yours. One that is not yours is refused `422` on `cluster_id`.","in":"query","name":"cluster_id","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Send `1` for only the websites that need attention.","in":"query","name":"attention","required":false,"schema":{"type":"boolean"}},{"description":"What to sort by.","in":"query","name":"sort","required":false,"schema":{"default":"updated","enum":["name","company","status","kind","updated"],"type":"string"}},{"description":"The direction to sort in.","in":"query","name":"dir","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"$ref":"#/components/parameters/page"},{"description":"Items a page: 25, 50 or 100, default 25.","in":"query","name":"per_page","required":false,"schema":{"default":25,"enum":[25,50,100],"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"can_create":{"corecluster":true,"corestack":true,"enterprise":false},"counts":{"all":2,"corecluster":1,"corestack":0,"enterprise":1,"mixed":0},"page":1,"per_page":25,"rows":[{"attention":2,"badge":{"kind":"corecluster","label":"CoreCluster"},"cluster":{"href":"https://manage.corefinity.com/managed-clusters/clusters/17","id":1017,"kind":"customer","label":"Northwind UK 1"},"company":{"id":1204,"name":"Harbour & Finch"},"environment_count":2,"environments":[{"group":"production","hosting_kind":"corestack","href":"https://manage.corefinity.com/managed-clusters/sites/1042","id":3110,"label":"Production","name":"Production","pending_changes":0,"reseller_site_id":1042,"role":"production","state":"ready"},{"group":"staging","hosting_kind":"corestack","href":"https://manage.corefinity.com/managed-clusters/sites/1043","id":3111,"label":"Staging","name":"Staging","pending_changes":0,"reseller_site_id":1043,"role":"staging","state":"ready","uat_size":null}],"hrefs":{"open":"https://manage.corefinity.com/managed-clusters/sites/1042"},"id":1302,"name":"harbourandfinch.example.com","pending_changes":0,"platform":{"key":"wordpress","label":"WordPress"},"region":null,"status":{"key":3,"label":"Active"},"updated_at":"2026-11-10T00:59:44Z","url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"},{"attention":0,"badge":{"kind":"enterprise","label":"CoreStack Enterprise"},"cluster":null,"company":{"id":1204,"name":"Harbour & Finch"},"environment_count":0,"environments":[],"hrefs":{"open":"https://manage.corefinity.com/resources/websites/951"},"id":1310,"name":"Harbour & Finch trade","pending_changes":0,"platform":null,"region":null,"status":{"key":1,"label":"Pending setup"},"updated_at":"2026-11-10T00:51:39Z","url":"https://trade.harbourandfinch.example.com"}],"sort":{"dir":"desc","key":"updated"},"total":2},"schema":{"$ref":"#/components/schemas/WebsiteList"}}},"description":"A page of websites."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/FeatureOff"},"422":{"content":{"application/json":{"examples":{"cluster_id":{"summary":"A CoreCluster that is not yours","value":{"code":"invalid","errors":{"cluster_id":["The selected cluster is invalid."]},"field":"cluster_id","message":"The selected cluster is invalid.","reason":"invalid"}},"per_page":{"summary":"A page size that is not offered","value":{"code":"invalid","errors":{"per_page":["Choose 25, 50 or 100"]},"field":"per_page","message":"Choose 25, 50 or 100","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A filter or the paging is wrong."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your company's websites","tags":["Sites"],"x-feature":"sites","x-file":"environments","x-gates":["managed_websites_v2"],"x-rate-limit":{"bucket":"corecluster-websites","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/corestack/websites/{website}":{"parameters":[{"description":"The id of a website of any product, from the websites list. Not the same number as a site row id. Digits only.","example":1302,"in":"path","name":"website","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers one website with every environment: a website of your own company, or one with a CoreStack site you\ncan open that belongs to another company, such as a client's site your company manages as its agency. Any\nother website answers `404`. Answered with `Cache-Control: no-store`.\n","operationId":"getManagedWebsite","responses":{"200":{"content":{"application/json":{"example":{"attention":2,"badge":{"kind":"corecluster","label":"CoreCluster"},"cluster":{"href":"https://manage.corefinity.com/managed-clusters/clusters/17","id":1017,"kind":"customer","label":"Northwind UK 1"},"company":{"id":1204,"name":"Harbour & Finch"},"environment_count":2,"environments":[{"group":"production","hosting_kind":"corestack","href":"https://manage.corefinity.com/managed-clusters/sites/1042","id":3110,"label":"Production","name":"Production","pending_changes":0,"reseller_site_id":1042,"role":"production","state":"ready"},{"group":"staging","hosting_kind":"corestack","href":"https://manage.corefinity.com/managed-clusters/sites/1043","id":3111,"label":"Staging","name":"Staging","pending_changes":0,"reseller_site_id":1043,"role":"staging","state":"ready","uat_size":null}],"hrefs":{"open":"https://manage.corefinity.com/managed-clusters/sites/1042"},"id":1302,"name":"harbourandfinch.example.com","pending_changes":0,"platform":{"key":"wordpress","label":"WordPress"},"region":null,"status":{"key":3,"label":"Active"},"updated_at":"2026-11-10T00:59:44Z","url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"},"schema":{"$ref":"#/components/schemas/WebsiteRow"}}},"description":"The website."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a website with its environments","tags":["Sites"],"x-feature":"sites","x-file":"environments","x-gates":["managed_websites_v2"],"x-rate-limit":{"bucket":"corecluster-websites","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"all"}},"/enterprise-copies":{"post":{"description":"Copies the environment's files and database into the site, replacing everything the site holds; nothing is\nwritten on the environment. Send the site's name as `confirm_target_site`, as the preview answers it in\n`confirm`, then read the copy at `poll` until `state` is no longer `running`.\n","operationId":"createEnterpriseCopy","requestBody":{"content":{"application/json":{"examples":{"start":{"summary":"Copy environment 1312 into site 1043","value":{"confirm_target_site":"harbourandfinch-example-com-staging","enterprise_env_id":1312,"target_site_id":1043}}},"schema":{"$ref":"#/components/schemas/EnterpriseCopyStart"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"started":{"$ref":"#/components/examples/EnterpriseCopyStartedExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseCopyStarted"}}},"description":"The copy started. Follow it at `poll`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"consumer_hold_off":{"summary":"Copies are paused, the second code this can carry","value":{"code":"consumer_hold_off","message":"Copies are paused at the moment. Try again later.","reason":"consumer_hold_off"}},"copy_exists":{"summary":"The site already has a copy that is not finished","value":{"code":"copy_exists","message":"This site already has a copy open (copy #6201): re-sync or finish it.","reason":"copy_exists"}},"neutralise_off":{"summary":"Copies are paused","value":{"code":"neutralise_off","message":"Copies are paused at the moment. Try again later.","reason":"neutralise_off"}},"platform_mismatch":{"summary":"The site runs another platform","value":{"code":"platform_mismatch","message":"The site runs WordPress and the environment Magento 2: a copy goes into a site of the same platform.","reason":"platform_mismatch"}},"source_moving":{"summary":"The environment is being moved","value":{"code":"source_moving","message":"This environment has a move open: copy it once the move is settled.","reason":"source_moving"}},"source_unsupported":{"summary":"The environment cannot be copied as it is","value":{"code":"source_unsupported","message":"This environment cannot be copied as it is. Contact support to find out why.","reason":"source_unsupported"}},"target_busy":{"summary":"A change is running on the site","value":{"code":"target_busy","message":"A change is running on this site: copy into it once it has finished.","reason":"target_busy"}},"target_crons_on":{"summary":"The site's scheduled tasks are on","value":{"code":"target_crons_on","message":"This site's scheduled tasks are on: switch them off before copying into it.","reason":"target_crons_on"}},"target_live":{"summary":"The site has a domain attached","value":{"code":"target_live","message":"This site has a domain attached: a copy never overwrites a live site.","reason":"target_live"}},"target_not_ready":{"summary":"The site is still being set up","value":{"code":"target_not_ready","message":"This site is not provisioned yet.","reason":"target_not_ready"}},"target_too_small":{"summary":"The site's disk cannot hold the copy","value":{"code":"target_too_small","message":"The site's disk (20.0 GiB) cannot hold this copy (40.0 GiB of files and database).","reason":"target_too_small"}},"target_unprotected":{"summary":"The site is not behind HTTP authentication","value":{"code":"target_unprotected","message":"This site is not protected by HTTP authentication over the whole environment (an enabled rule for /, with a user, opening no path): copied data must never be public.","reason":"target_unprotected"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The copy cannot start now. `reason` says why, and `message` is the preview's first blocker word for word.\nAbout the site: `platform_cluster` (it is not on a CoreCluster of your own), `other_company`,\n`target_not_ready`, `target_live`, `target_sends_mail`, `target_unprotected`, `target_crons_on`,\n`platform_mismatch`, `copy_exists`, `target_busy`, `target_moving`, `target_too_small`. About the\nenvironment: `source_unsupported`, `ssh_unreachable`, `source_moving`, `no_mail_neutraliser`. While copies\nare paused: `neutralise_off`, `consumer_hold_off`. A site with a change, a restore or a deployment under way\ncan also answer the refusal any change to it meets, such as `busy`.\n"},"422":{"$ref":"#/components/responses/EnterpriseCopyInvalidOrUnconfirmed"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create an Enterprise copy","tags":["Enterprise copies"],"x-effect":["overwrites"],"x-feature":"enterprise-copies","x-file":"enterprise-copies","x-gates":[],"x-long-running":"getEnterpriseCopy","x-rate-limit":{"bucket":"enterprise-copies-write","limit":5,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/enterprise-copies/preview":{"get":{"description":"Answers whether the environment can be copied into the site now, every reason it cannot (`blockers`, the first\nbeing the one a start refuses with), what to know first (`warnings`) and the value to send as\n`confirm_target_site`. It reads the environment and writes nothing.\n","operationId":"previewEnterpriseCopy","parameters":[{"description":"The id of the CoreStack Enterprise environment to copy from. An id above 2147483647 is refused `422`.","example":1312,"in":"query","name":"enterprise_env_id","required":true,"schema":{"maximum":2147483647,"minimum":1,"type":"integer"}},{"description":"The site row id of the CoreCluster site to copy into. An id above 2147483647 is refused `422`.","example":1043,"in":"query","name":"target_site_id","required":true,"schema":{"maximum":2147483647,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"blocked":{"summary":"The site's scheduled tasks are on","value":{"preview":{"blockers":[{"message":"This site's scheduled tasks are on: switch them off before copying into it.","reason":"target_crons_on"}],"can_copy":false,"confirm":"harbourandfinch-example-com-staging","copy_of":null,"source":{"environment_id":1312,"name":"Staging","platform":"magento2","sizes":{"db_bytes":10737418240,"files_bytes":32212254720},"versions":{"mariadb":"10.6.21-MariaDB-ubu2004","php":"8.1.27"},"website_id":1310},"target":{"cluster_id":1017,"domain":"staging.harbourandfinch.example.com","mariadb_version":"10.6","name":"harbourandfinch-example-com-staging","platform":"magento2","site_id":1043},"warnings":[]}}},"ready":{"summary":"Nothing stops the copy","value":{"preview":{"blockers":[],"can_copy":true,"confirm":"harbourandfinch-example-com-staging","copy_of":null,"source":{"environment_id":1312,"name":"Staging","platform":"magento2","sizes":{"db_bytes":10737418240,"files_bytes":32212254720},"versions":{"mariadb":"10.6.21-MariaDB-ubu2004","php":"8.1.27"},"website_id":1310},"target":{"cluster_id":1017,"domain":"staging.harbourandfinch.example.com","mariadb_version":"10.6","name":"harbourandfinch-example-com-staging","platform":"magento2","site_id":1043},"warnings":[]}}}},"schema":{"properties":{"preview":{"$ref":"#/components/schemas/EnterpriseCopyPreview"}},"required":["preview"],"type":"object"}}},"description":"The preview. `can_copy` is false while `blockers` lists anything."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnterpriseCopyInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Preview an Enterprise copy","tags":["Enterprise copies"],"x-feature":"enterprise-copies","x-file":"enterprise-copies","x-gates":[],"x-rate-limit":{"bucket":"enterprise-copies-preview","limit":10,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/enterprise-copies/{copy}":{"parameters":[{"$ref":"#/components/parameters/enterpriseCopy"}],"get":{"description":"Answers where the copy is and what it copied. A copy that failed says why in `failure_reason`, and in `error`\nwhat happened and what to do next.\n","operationId":"getEnterpriseCopy","responses":{"200":{"content":{"application/json":{"examples":{"copied":{"$ref":"#/components/examples/EnterpriseCopyCopiedExample"}},"schema":{"properties":{"copy":{"$ref":"#/components/schemas/EnterpriseCopy"}},"required":["copy"],"type":"object"}}},"description":"The copy."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnterpriseCopyIdInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an Enterprise copy","tags":["Enterprise copies"],"x-feature":"enterprise-copies","x-file":"enterprise-copies","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/enterprise-copies/{copy}/finish":{"parameters":[{"$ref":"#/components/parameters/enterpriseCopy"}],"post":{"description":"Ends a copy whose run has ended, while the site is still protected, its scheduled tasks are off and no\ndomain is attached; the site stays an ordinary protected site with the copied data. A finished copy cannot\nbe finished again, but while it is the site's latest copy it can still be re-synced, which makes a new copy.\n","operationId":"finishEnterpriseCopy","responses":{"200":{"content":{"application/json":{"examples":{"finished":{"$ref":"#/components/examples/EnterpriseCopyFinishedExample"}},"schema":{"properties":{"copy":{"$ref":"#/components/schemas/EnterpriseCopy"}},"required":["copy"],"type":"object"}}},"description":"The copy is finished."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"copy_ended":{"summary":"The copy has ended already","value":{"code":"copy_ended","message":"This copy has ended already.","reason":"copy_ended"}},"copy_running":{"summary":"The copy's run has not ended","value":{"code":"copy_running","message":"This copy is still running: finish it once its run has ended.","reason":"copy_running"}},"copy_unchecked":{"summary":"The copy's checks did not complete","value":{"code":"copy_unchecked","message":"This copy's checks did not complete, so it cannot be finished: re-sync it.","reason":"copy_unchecked"}},"target_crons_on":{"summary":"The site's scheduled tasks were switched on since the copy","value":{"code":"target_crons_on","message":"This site's scheduled tasks are on: switch them off before copying into it.","reason":"target_crons_on"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The copy cannot be finished now. `copy_running` (its run has not ended), `copy_ended` (it is finished, failed\nor followed by a newer copy), `copy_unchecked` (its checks did not complete: re-sync it), the site's own\nchecks (`target_live`, `target_sends_mail`, `target_unprotected`, `target_crons_on`), `target_not_ready`\n(the site is gone) or `managed_elsewhere`.\n"},"422":{"$ref":"#/components/responses/EnterpriseCopyIdInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Finish an Enterprise copy","tags":["Enterprise copies"],"x-effect":["changes-settings"],"x-feature":"enterprise-copies","x-file":"enterprise-copies","x-gates":[],"x-rate-limit":{"bucket":"enterprise-copies-write","limit":5,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/enterprise-copies/{copy}/resync":{"parameters":[{"$ref":"#/components/parameters/enterpriseCopy"}],"post":{"description":"Copies the environment into the same site again, once this copy's run has ended: the answer is a new copy\nwhose `copy_of` is this one. Only the site's latest copy can be re-synced, whether it is resting, finished\nor failed; the site and the environment are checked again as a start checks them, and `confirm_target_site`\nis asked again because everything the site holds is replaced.\n","operationId":"resyncEnterpriseCopy","requestBody":{"content":{"application/json":{"examples":{"resync":{"summary":"Copy into the same site again","value":{"confirm_target_site":"harbourandfinch-example-com-trial"}}},"schema":{"$ref":"#/components/schemas/EnterpriseCopyResync"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"resynced":{"$ref":"#/components/examples/EnterpriseCopyResyncedExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseCopyStarted"}}},"description":"A new copy started. Follow it at `poll`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"copy_not_latest":{"summary":"A newer copy of the site exists","value":{"code":"copy_not_latest","message":"A newer copy of this site exists: re-sync that one.","reason":"copy_not_latest"}},"copy_running":{"summary":"The copy's run has not ended","value":{"code":"copy_running","message":"This copy is still running: re-sync it once its run has ended.","reason":"copy_running"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The copy cannot be made again now. `copy_running` (its run has not ended), `copy_not_latest` (a newer copy\nof the site exists), `target_not_ready` (the site is gone), `managed_elsewhere`, or any reason a start\nrefuses with, judged again on the site and the environment as they are now.\n"},"422":{"$ref":"#/components/responses/EnterpriseCopyInvalidOrUnconfirmed"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Copy the environment again","tags":["Enterprise copies"],"x-effect":["overwrites"],"x-feature":"enterprise-copies","x-file":"enterprise-copies","x-gates":[],"x-long-running":"getEnterpriseCopy","x-rate-limit":{"bucket":"enterprise-copies-write","limit":5,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/environments":{"get":{"description":"Answers every environment of the websites you can see, in one list with no paging.","operationId":"listEnvironments","responses":{"200":{"content":{"application/json":{"example":{"environments":[{"access_server":null,"id":"1311","name":"Production","platform":{"id":"1","name":"Magento 2","slug":"magento2"},"platform_id":"1","type":4,"type_description":"Production","url":"https://trade.harbourandfinch.example.com","website_id":"1310"}]},"schema":{"properties":{"environments":{"items":{"$ref":"#/components/schemas/LegacyEnvironment"},"type":"array"}},"required":["environments"],"type":"object"}}},"description":"The environments."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List environments","tags":["Websites and environments"],"x-feature":"enterprise-websites","x-file":"websites","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/environments/{environment}":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers one environment by its id.","operationId":"getEnvironment","responses":{"200":{"content":{"application/json":{"examples":{"environment":{"summary":"An environment","value":{"environment":{"access_server":null,"id":"1311","name":"Production","platform":{"id":"1","name":"Magento 2","slug":"magento2"},"platform_id":"1","type":4,"type_description":"Production","url":"https://trade.harbourandfinch.example.com","website_id":"1310"}}},"with_question":{"summary":"An environment whose move asks about its staging size","value":{"environment":{"access_server":null,"id":"1311","name":"Production","platform":{"id":"1","name":"Magento 2","slug":"magento2"},"platform_id":"1","type":4,"type_description":"Production","url":"https://trade.harbourandfinch.example.com","website_id":"1310"},"move_size":{"answer":null,"asked_at":"2026-11-03T09:16:40Z","disk_size":"medium","id":5312,"measured":"Over the last 14 days this environment used up to 2.9 GB for PHP; Large gives PHP 4 GB.","memory_size":"large","options":[{"answer":"accept","confirm_cost":true,"currency":"GBP","delta":"150.00","included":false,"label":"Large, £150.00/month (+£150.00)","monthly":"150.00","uat_size":"large","warning":null},{"answer":"keep","confirm_cost":false,"currency":"GBP","delta":null,"included":true,"label":"Medium, included at no charge","monthly":"0.00","uat_size":"medium","warning":"This environment used more memory than Medium gives. It may run out of memory and stop commands or pages; you can resize later."}],"price_note":null,"priced":true,"rule_version":"1","state":"open","window_days":14}}}},"schema":{"properties":{"environment":{"$ref":"#/components/schemas/LegacyEnvironment"},"move_size":{"$ref":"#/components/schemas/MoveSizeQuestion","description":"The staging size the environment's move to CoreStack asks about. Sent only while the move asks which staging size to use, and only to a person with billing rights for the website."}},"required":["environment"],"type":"object"}}},"description":"The environment."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an environment","tags":["Websites and environments"],"x-feature":"enterprise-websites","x-file":"websites","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/environments/{environment}/deployment-pipelines":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers the environment's deployment pipelines: the folders each one deploys to and, for a classic pipeline,\nthe commands it runs in `classic`, with credentials redacted. A deployment names one of these by its `id`.\n","operationId":"listEnvironmentDeploymentPipelines","responses":{"200":{"content":{"application/json":{"examples":{"pipelines":{"$ref":"#/components/examples/EnterprisePipelineListExample"}},"schema":{"$ref":"#/components/schemas/EnterprisePipelineList"}}},"description":"The environment's pipelines."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List an environment's pipelines","tags":["Enterprise deployments"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/environments/{environment}/deployment-settings":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers how the environment deploys: whether its pipeline is on, its deployment source, whether a push deploys\non its own, and each of its pipelines with its folders and build switches.\n","operationId":"getEnvironmentDeploymentSettings","responses":{"200":{"content":{"application/json":{"examples":{"settings":{"$ref":"#/components/examples/EnterpriseDeploymentSettingsExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentSettingsAnswer"}}},"description":"The deployment settings."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnterpriseDeploymentNotEnterprise"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an environment's deployment settings","tags":["Enterprise deployments"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"patch":{"description":"Changes the settings you send and answers them all as they are now. Moving the source off git removes the\nenvironment's repositories, so it needs `confirm_remove_repositories` true when there are any. To change a\npipeline's folders or build switches, send its `pipeline_id` with them; a refused folder refuses the whole\nrequest.\n","operationId":"updateEnvironmentDeploymentSettings","requestBody":{"content":{"application/json":{"examples":{"automatic":{"summary":"Deploy every push on its own","value":{"git_deploys":"automatic"}},"folder":{"summary":"Change a pipeline's web folder","value":{"pipeline_id":2210,"root_directory":"/var/www/harbourandfinch.example.com/current/"}},"off_git":{"summary":"Move off git and remove the repositories","value":{"confirm_remove_repositories":true,"deployment_source":"manual"}},"pipeline_off":{"summary":"Turn the deployment pipeline off","value":{"pipeline_enabled":false}}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentSettingsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"automatic":{"$ref":"#/components/examples/EnterpriseDeploymentSettingsAutomaticExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentSettingsAnswer"}}},"description":"The deployment settings after the change."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"permission":{"summary":"The role lacks Manage Deployment Source","value":{"code":"forbidden","message":"You need the Manage Deployment Source permission to do this. An owner of your company can grant it in Roles.","permission":"manageDeploymentSource","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and\nyou have not set it up, or your role lacks a permission the change needs (`forbidden`, with `permission`):\nManage Deployment Source for `deployment_source` and `git_deploys`, Manage Deployment Repositories as well\nto move off git, Create Deployments as well to make a push deploy on its own, and Edit Environment\nDeployment Pipeline for a pipeline's folders and build switches.\n"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"not_git":{"summary":"The environment does not deploy from git","value":{"code":"not_available","message":"Git deploys apply only to an environment that deploys from git.","reason":"not_available"}},"pipeline_off":{"summary":"The pipeline is off","value":{"code":"not_available","message":"The deployment pipeline is off: turn it on to choose how this environment deploys.","reason":"not_available"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The setting does not apply to the environment as it is (`not_available`): a DevBox environment, a source\nor git setting while the pipeline is off, `git_deploys` on an environment that does not deploy from git,\nor a build switch on a pipeline it does not apply to.\n"},"422":{"content":{"application/json":{"examples":{"confirm":{"summary":"Moving off git without the confirmation","value":{"code":"confirm","errors":{"confirm_remove_repositories":["Moving this environment off git deployments removes its repository and that repository's webhook. Ask the person, then send confirm_remove_repositories: true."]},"message":"Moving this environment off git deployments removes its repository and that repository's webhook. Ask the person, then send confirm_remove_repositories: true.","reason":"confirm"}},"folder":{"summary":"A folder outside the site's own","value":{"code":"invalid","errors":{"root_directory":["Choose a folder under /var/www/, /var/www_m2/, /var/www_vsf/ or /var/www_blog/, such as /var/www/example.com/."]},"field":"root_directory","message":"Choose a folder under /var/www/, /var/www_m2/, /var/www_vsf/ or /var/www_blog/, such as /var/www/example.com/.","reason":"invalid"}},"nothing":{"summary":"No setting was named","value":{"code":"invalid","errors":{"pipeline_enabled":["Name at least one setting to change."]},"field":"pipeline_enabled","message":"Name at least one setting to change.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"A value is not offered, no setting was named or a folder is refused (`invalid`), or moving off git would\nremove repositories and `confirm_remove_repositories` is not true (`confirm`). A folder is refused when it\nis not written plainly under `/var/www/`, `/var/www_m2/`, `/var/www_vsf/` or `/var/www_blog/`, is longer\nthan 255 characters, is a folder every site shares, or is one another site on the same build server uses,\nand while another folder change on the same build server is being saved (try again in a moment). A CoreStack or CoreCluster\nenvironment is refused `invalid` on `environment`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update an environment's deployment settings","tags":["Enterprise deployments"],"x-effect":["changes-settings","deletes"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"cse-deployment-settings-write","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/environments/{environment}/deployments":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Without `limit`, `cursor` or `status` the answer is every deployment of the environment, oldest first, with no\n`next_cursor`. Send any of the three and the list is paged instead, newest first. Paged by cursor: send\n`next_cursor` back as `cursor`; null means the last page.\n","operationId":"listEnvironmentDeployments","parameters":[{"description":"Items a page: 1 to 100, default 25. Sending it pages the list.","example":10,"in":"query","name":"limit","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"The `next_cursor` of the previous answer. At most 40 characters; a cursor the list did not give you is refused `422` on `cursor`.","in":"query","name":"cursor","required":false,"schema":{"maxLength":40,"type":"string"}},{"description":"Only deployments in this status. `pending` is a deployment that waits to be deployed by hand.","in":"query","name":"status","required":false,"schema":{"enum":["scheduled","running","failed","succeeded","cancelled","pending","queued"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"all":{"$ref":"#/components/examples/EnterpriseDeploymentListExample"},"page":{"$ref":"#/components/examples/EnterpriseDeploymentPageExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentList"}}},"description":"The deployments. `next_cursor` is present only when the list is paged."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"examples":{"cursor":{"summary":"A cursor the list did not give","value":{"code":"invalid","errors":{"cursor":["That page does not exist. Reload the list."]},"field":"cursor","message":"That page does not exist. Reload the list.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A paging parameter is wrong (`invalid`). `field` is `limit`, `cursor` or `status`."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List an environment's deployments","tags":["Enterprise deployments"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"post":{"description":"Starts a deployment and answers it with `status` `7` (Queued): send JSON with `git` true to deploy a commit of\none of the environment's repositories, or `multipart/form-data` to deploy a release archive you upload through\nthe pipeline `pipeline_id` names. Your role needs the Create Deployments permission, and the token the\n`deploy` ability as well as the `write` scope.\n","operationId":"createEnvironmentDeployment","requestBody":{"content":{"application/json":{"examples":{"commit":{"summary":"Deploy a commit","value":{"git":true,"git_commit":"93ac3ee17c1306a5c478c583f0946e40d2e291f0","git_repository":3301,"name":"Release 2026.11.1","notes":"Checkout fixes"}},"commit_only":{"summary":"Deploy a commit without a name","value":{"git":true,"git_commit":"93ac3ee17c1306a5c478c583f0946e40d2e291f0","git_repository":3301}}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentGitRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentArchiveRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"queued":{"$ref":"#/components/examples/EnterpriseDeploymentQueuedExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentAnswer"}}},"description":"The new deployment, queued."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"permission":{"summary":"The role lacks Create Deployments","value":{"code":"forbidden","message":"You need the Create Deployments permission to do this. An owner of your company can grant it in Roles.","permission":"createDeployments","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"token_cannot_deploy":{"summary":"The token lacks the deploy ability","value":{"code":"scope_required","message":"This access token cannot deploy.","reason":"scope_required","scope":"deploy"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope or the `deploy` ability (`scope_required`; `scope` names which), your\nrole lacks the Create Deployments permission (`forbidden`, with `permission`), or you may not deploy to\nthis environment. For an archive uploaded to an environment of a CoreStack or CoreCluster site, also a\nperson who cannot deploy the site.\n"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"no_namespace":{"summary":"The environment has nowhere to deploy to","value":{"code":"no_namespace","message":"This environment has no namespace on its cluster, so there is nothing to deploy to.","reason":"no_namespace"}},"stale":{"summary":"The repository's pipeline is gone","value":{"code":"stale","message":"This deployment's pipeline is no longer available in its environment.","reason":"stale"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"Nothing was created. `reason` says why: `no_namespace` (the environment has nowhere to deploy to) or\n`stale` (the pipeline the deployment would use is no longer the environment's). An archive uploaded to an\nenvironment of a CoreStack or CoreCluster site that cannot take it answers a message only.\n"},"422":{"content":{"application/json":{"examples":{"archive":{"summary":"An archive in a format that is not accepted","value":{"message":"That archive could not be accepted: only .tar, .tar.gz, .tar.xz, .tar.zst and .zip archives are supported. (unsupported_archive_type)"}},"invalid":{"summary":"The commit is not a full commit id","value":{"code":"invalid","errors":{"git_commit":["The git commit field format is invalid."]},"field":"git_commit","message":"The git commit field format is invalid.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"A field is missing or wrong (`invalid`). An uploaded archive that is refused answers a message that says\nwhy and ends with a code in brackets, such as `(unsupported_archive_type)` or `(unsafe_entry_path)`. An\narchive uploaded to an environment of a site that is not live answers a message only.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create an environment deployment","tags":["Enterprise deployments"],"x-effect":["runs-code"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-long-running":"getEnvironmentDeployment","x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"deploy","when":"Always"}],"x-try-it":"off","x-two-factor":"none"}},"/environments/{environment}/deployments/{deployment}":{"parameters":[{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/EnterpriseDeploymentId"}],"get":{"description":"Answers one deployment of the environment, with `view` (what its page in the Control Panel shows you) and\n`retry_warning`. Read it again to follow a deployment until `status` is `3` (Failed), `4` (Succeeded) or `5`\n(Cancelled).\n","operationId":"getEnvironmentDeployment","responses":{"200":{"content":{"application/json":{"examples":{"failed":{"$ref":"#/components/examples/EnterpriseDeploymentDetailExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentDetail"}}},"description":"The deployment, its view and its retry warning."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a deployment","tags":["Enterprise deployments"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/environments/{environment}/deployments/{deployment}/cancel":{"parameters":[{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/EnterpriseDeploymentId"}],"post":{"description":"Cancels a deployment that has not finished: one that is scheduled, queued, waiting to be deployed or running,\nwhich stops at its current step. Your role needs the Cancel Deployments permission. A deployment of a\nCoreStack or CoreCluster site is stopped from the site instead.\n","operationId":"cancelEnvironmentDeployment","parameters":[{"$ref":"#/components/parameters/idempotencyKey"}],"requestBody":{"content":{"application/json":{"examples":{"cancel":{"summary":"Cancel the deployment as it is now","value":{}}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentCommandRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"examples":{"cancelled":{"$ref":"#/components/examples/EnterpriseDeploymentCancelledExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentCommandAnswer"}}},"description":"The deployment, cancelled. `replayed` is true when the `Idempotency-Key` was used before."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnterpriseDeploymentCommandForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"finished":{"summary":"The deployment has finished","value":{"code":"stale","message":"Only a deployment that has not finished can be cancelled.","reason":"stale","result":"stale_attempt"}},"moved_on":{"summary":"The deployment moved on since it was read","value":{"code":"stale","message":"This deployment has moved on since it was read. Read it again and cancel it if it still applies.","reason":"stale","result":"stale_attempt"}},"site":{"$ref":"#/components/examples/EnterpriseDeploymentSiteOnlyExample"}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was cancelled. `reason` says why: `stale` (the deployment has finished, or moved on since you read\nit), `busy` (the same request is still being applied) or `conflict` (the `Idempotency-Key` belongs to\nanother request, or the environment is a CoreStack or CoreCluster site's).\n"},"422":{"$ref":"#/components/responses/EnterpriseDeploymentCommandInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/EnterpriseDeploymentCommandFailed"}},"summary":"Cancel a deployment","tags":["Enterprise deployments"],"x-effect":["changes-settings"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"deploy","when":"Always"}],"x-try-it":"off","x-two-factor":"none"}},"/environments/{environment}/deployments/{deployment}/retry":{"parameters":[{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/EnterpriseDeploymentId"}],"post":{"description":"Runs the deployment again and answers it with `status` `7` (Queued). Retrying a deployment that is not the\nenvironment's newest puts an older release live, so it needs `confirm_older` true. Your role needs the Retry\nDeployments permission. On an environment of a CoreStack or CoreCluster site the site's own rules apply:\nwhoever may deploy the site can retry a failed deployment, or one that was stopped in its after-deploy\ncommands once its release was live (the site's `can_retry`).\n","operationId":"retryEnvironmentDeployment","parameters":[{"$ref":"#/components/parameters/idempotencyKey"}],"requestBody":{"content":{"application/json":{"examples":{"confirm_older":{"summary":"Retry a deployment that is not the newest","value":{"confirm_older":true}},"from_start":{"summary":"Run the whole pipeline again","value":{"from":"start"}},"newest":{"summary":"Retry the newest deployment","value":{}}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentRetryRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"examples":{"queued":{"$ref":"#/components/examples/EnterpriseDeploymentRetriedExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentCommandAnswer"}}},"description":"The deployment, queued again. `replayed` is true when the `Idempotency-Key` was used before."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnterpriseDeploymentCommandForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"abandoned":{"summary":"An earlier attempt did not finish cleanly","value":{"code":"stale","message":"A previous attempt did not finish cleanly. Read the deployment to see where it got to, then try again.","reason":"stale","result":"abandoned"}},"artifact_pruned":{"summary":"The release archive was removed","value":{"code":"artifact_pruned","message":"This deployment's archive was removed after 30 days, so it can't be retried or rolled back. Deploy again from the branch or commit.","reason":"artifact_pruned","result":"artifact_pruned"}},"key_conflict":{"summary":"The key was used for another request","value":{"code":"conflict","message":"That Idempotency-Key belongs to a different request.","reason":"conflict","result":"key_conflict"}},"pipeline_changed_since_build":{"summary":"The pipeline changed after the build","value":{"code":"pipeline_changed_since_build","message":"The pipeline changed after this build. Retry deploys the same built files; use Deploy again to run the new build.","reason":"pipeline_changed_since_build","result":"pipeline_changed_since_build"}},"stale":{"summary":"The deployment moved on, or cannot be retried now","value":{"code":"stale","message":"This deployment has moved on, or cannot be retried in its current state. Read it again and retry if it still applies.","reason":"stale","result":"stale_attempt"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was retried. `reason` says why: `stale` (the deployment moved on since you read it, cannot be\nretried in its state, or an earlier attempt did not finish cleanly), `busy` (the same request is still\nbeing applied), `conflict` (the `Idempotency-Key` belongs to another request), `artifact_pruned` (its\nrelease archive was removed) or `pipeline_changed_since_build`. An environment of a CoreStack or\nCoreCluster site answers the site's own refusals, such as `not_failed`.\n"},"422":{"content":{"application/json":{"examples":{"confirm":{"summary":"An older deployment without confirm_older","value":{"code":"confirm","errors":{"confirm_older":["This will put an older release live: commit abc1234 from 18 Oct. The newest deployment is def5678 from 22 Oct."]},"message":"This will put an older release live: commit abc1234 from 18 Oct. The newest deployment is def5678 from 22 Oct. To retry it anyway, repeat the request with confirm_older set to true.","reason":"confirm"}},"invalid":{"summary":"A field of the wrong type","value":{"code":"invalid","errors":{"expected_action_id":["The expected action id must be an integer."]},"field":"expected_action_id","message":"The expected action id must be an integer.","reason":"invalid"}},"key":{"summary":"A key that is not a UUID","value":{"message":"The Idempotency-Key header must be a UUID."}},"retry_from_step_unavailable":{"summary":"The deployment cannot carry on from its failed step","value":{"code":"retry_from_step_unavailable","errors":{"from":["Retry from the failed step is not available for this deployment","so retry it from the start instead."]},"message":"Retry from the failed step is not available for this deployment, so retry it from the start instead.","reason":"retry_from_step_unavailable"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"A field or the `Idempotency-Key` header is wrong (`invalid`; a header that is not a UUID answers a message\nonly), the deployment is not the newest and `confirm_older` is not true (`confirm`), or `from` is\n`failed_step` on a deployment that cannot carry on from its failed step (`retry_from_step_unavailable`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/EnterpriseDeploymentCommandFailed"}},"summary":"Retry a deployment","tags":["Enterprise deployments"],"x-effect":["runs-code"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-long-running":"getEnvironmentDeployment","x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"deploy","when":"Always"}],"x-try-it":"off","x-two-factor":"none"}},"/environments/{environment}/deployments/{deployment}/rollback":{"parameters":[{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/EnterpriseDeploymentId"}],"post":{"description":"Deploys an earlier successful deployment again and answers it with `status` `7` (Queued). Only a successful\ndeployment with a commit, that is not the live release and whose release is still kept, can be rolled back\nto. Your role needs the Rollback Deployments permission. A CoreStack or CoreCluster site is rolled back from\nthe site instead.\n","operationId":"rollBackEnvironmentDeployment","parameters":[{"$ref":"#/components/parameters/idempotencyKey"}],"requestBody":{"content":{"application/json":{"examples":{"roll_back":{"summary":"Roll back to the deployment","value":{}}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentCommandRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"examples":{"queued":{"$ref":"#/components/examples/EnterpriseDeploymentRetriedExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentCommandAnswer"}}},"description":"The deployment, queued again. `replayed` is true when the `Idempotency-Key` was used before."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnterpriseDeploymentCommandForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"artifact_pruned":{"summary":"The release archive was removed","value":{"code":"artifact_pruned","message":"This deployment's archive was removed after 30 days, so it can't be retried or rolled back. Deploy again from the branch or commit.","reason":"artifact_pruned","result":"artifact_pruned"}},"site":{"$ref":"#/components/examples/EnterpriseDeploymentSiteOnlyExample"},"stale":{"summary":"Not a release that can be rolled back to","value":{"code":"stale","message":"Only a successful deployment with a commit, that is not already the live release and whose release is still kept, can be rolled back to.","reason":"stale","result":"stale_attempt"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was rolled back. `reason` says why: `stale` (the deployment cannot be rolled back to, or moved on\nsince you read it), `busy`, `conflict` (the `Idempotency-Key` belongs to another request, or the\nenvironment is a CoreStack or CoreCluster site's) or `artifact_pruned` (its release archive was removed).\n"},"422":{"$ref":"#/components/responses/EnterpriseDeploymentCommandInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/EnterpriseDeploymentCommandFailed"}},"summary":"Roll back to a deployment","tags":["Enterprise deployments"],"x-effect":["runs-code","overwrites"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-long-running":"getEnvironmentDeployment","x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"deploy","when":"Always"}],"x-try-it":"off","x-two-factor":"none"}},"/environments/{environment}/deployments/{deployment}/run":{"parameters":[{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/EnterpriseDeploymentId"}],"post":{"description":"Starts a deployment that waits to be deployed (`status` `6`, Pending), as an environment whose `git_deploys`\nis `manual` leaves each push, from its pipeline as it is now or the one `pipeline_id` names. Your role needs\nthe Deploy Deployments permission; a CoreStack or CoreCluster site deploys from the site instead.\n","operationId":"startEnvironmentDeployment","parameters":[{"$ref":"#/components/parameters/idempotencyKey"}],"requestBody":{"content":{"application/json":{"examples":{"another_pipeline":{"summary":"Deploy it on another pipeline of the environment","value":{"pipeline_id":2210}},"run":{"summary":"Deploy it on its own pipeline","value":{}}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentRunRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"examples":{"queued":{"$ref":"#/components/examples/EnterpriseDeploymentRetriedExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentCommandAnswer"}}},"description":"The deployment, queued. `replayed` is true when the `Idempotency-Key` was used before."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnterpriseDeploymentCommandForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"site":{"$ref":"#/components/examples/EnterpriseDeploymentSiteOnlyExample"},"stale":{"summary":"Not a waiting deployment","value":{"code":"stale","message":"Only a waiting deployment the environment has not moved past can be started.","reason":"stale","result":"stale_attempt"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Nothing was started. `reason` says why: `stale` (the deployment is not waiting, the environment has moved\npast it, or it moved on since you read it), `busy` or `conflict` (the `Idempotency-Key` belongs to another\nrequest, or the environment is a CoreStack or CoreCluster site's).\n"},"422":{"$ref":"#/components/responses/EnterpriseDeploymentCommandInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/EnterpriseDeploymentCommandFailed"}},"summary":"Start a waiting deployment","tags":["Enterprise deployments"],"x-effect":["runs-code"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-long-running":"getEnvironmentDeployment","x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[{"needs":"deploy","when":"Always"}],"x-try-it":"off","x-two-factor":"none"}},"/environments/{environment}/firewall":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers every address that reaches the environment, from every level, with the presets attached, the address this\nrequest came from, and how far the firewall is in force on the environment.\n","operationId":"getEnvironmentFirewall","responses":{"200":{"content":{"application/json":{"examples":{"environment":{"$ref":"#/components/examples/FirewallEnvironmentViewExample"}},"schema":{"$ref":"#/components/schemas/FirewallEnvironmentView"}}},"description":"The environment's firewall."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an environment's firewall","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/environments/{environment}/firewall/activity":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers every firewall change that reaches the environment, at any level, newest first. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.","operationId":"listEnvironmentFirewallActivity","parameters":[{"$ref":"#/components/parameters/firewallCursor"}],"responses":{"200":{"content":{"application/json":{"examples":{"activity":{"$ref":"#/components/examples/FirewallActivityPageExample"}},"schema":{"$ref":"#/components/schemas/FirewallActivityPage"}}},"description":"A page of activity."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"$ref":"#/components/responses/FirewallInvalidQuery"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List an environment's firewall activity","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/environments/{environment}/move-size":{"parameters":[{"$ref":"#/components/parameters/environment"}],"post":{"description":"Records which staging size the environment gets when it moves to CoreStack: `accept` the larger size its measured memory suggests, or `keep` the smaller one. The larger size can cost more each month. The answer can be changed until the move uses it.","operationId":"updateEnvironmentMoveSize","requestBody":{"content":{"application/json":{"examples":{"accept":{"summary":"Take the larger size and agree to its cost","value":{"answer":"accept","confirm_cost":true,"question_id":5312}},"keep":{"summary":"Keep the smaller size, having read the warning","value":{"acknowledge_warning":true,"answer":"keep","question_id":5312}}},"schema":{"$ref":"#/components/schemas/MoveSizeAnswer"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"answer":{"answer":"accept","answered_at":"2026-11-03T09:20:05Z","on_behalf":false,"uat_size":"large","warning_acknowledged":false},"asked_at":"2026-11-03T09:16:40Z","disk_size":"medium","id":5312,"measured":"Over the last 14 days this environment used up to 2.9 GB for PHP; Large gives PHP 4 GB.","memory_size":"large","options":[{"answer":"accept","confirm_cost":true,"currency":"GBP","delta":"150.00","included":false,"label":"Large, £150.00/month (+£150.00)","monthly":"150.00","uat_size":"large","warning":null},{"answer":"keep","confirm_cost":false,"currency":"GBP","delta":null,"included":true,"label":"Medium, included at no charge","monthly":"0.00","uat_size":"medium","warning":"This environment used more memory than Medium gives. It may run out of memory and stop commands or pages; you can resize later."}],"price_note":null,"priced":true,"rule_version":"1","state":"answered","window_days":14}},"schema":{"properties":{"data":{"$ref":"#/components/schemas/MoveSizeQuestion"}},"required":["data"],"type":"object"}}},"description":"The question with the answer recorded."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"billing_forbidden":{"summary":"You have no billing rights for the website","value":{"code":"billing_forbidden","message":"Billing is available to your company's owner and billing contacts.","reason":"billing_forbidden"}},"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you have not set it up, or you have no billing rights for the website (`billing_forbidden`)."},"404":{"content":{"application/json":{"examples":{"feature_off":{"summary":"Staging sizes are not measured from memory","value":{"code":"feature_off","message":"Staging sizes measured from memory are not available.","reason":"feature_off"}},"not_found":{"summary":"No such environment, not yours to see, or not this environment's question","value":{"message":"Not found."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The environment does not exist or is not yours to see, `question_id` is not a question of this environment, or staging sizes are not measured from memory at the moment (`feature_off`)."},"409":{"content":{"application/json":{"examples":{"replaced":{"summary":"The question was replaced by a newer one","value":{"code":"stale","message":"This question was replaced by a newer one (the figures or a price changed). Answer the newer one.","reason":"stale"}},"used":{"summary":"The move has already started with the choice","value":{"code":"stale","message":"This choice has already been used: the move has started.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The question is no longer the current one (`stale`): read the environment again."},"422":{"content":{"application/json":{"examples":{"answer":{"summary":"`answer` is not accept or keep","value":{"code":"invalid","errors":{"answer":["The selected answer is invalid."]},"field":"answer","message":"The selected answer is invalid.","reason":"invalid"}},"confirm_cost":{"summary":"Accepting a size that costs more without confirming the cost","value":{"code":"confirm_cost","message":"Large costs £150.00/month more. Send confirm_cost: true once the customer has agreed to the extra cost.","reason":"confirm_cost"}},"warning_not_acknowledged":{"summary":"Keeping the smaller size without acknowledging the warning","value":{"code":"warning_not_acknowledged","message":"This environment used more memory than Medium gives. It may run out of memory and stop commands or pages; you can resize later. Tick the warning to keep the smaller size.","reason":"warning_not_acknowledged"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing or wrong (`invalid`), `keep` was sent without `acknowledge_warning` (`warning_not_acknowledged`), or `accept` costs more a month and was sent without `confirm_cost` (`confirm_cost`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update an environment's staging size answer","tags":["Websites and environments"],"x-effect":["billable"],"x-feature":"enterprise-websites","x-file":"websites","x-gates":["reseller.cse_move.memory_sizing"],"x-rate-limit":{"bucket":"api-move-size","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/environments/{environment}/repositories":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers the git repositories the environment deploys from, with whether your role may change them. A\nrepository set up with a git account you cannot use is listed with `connection_hidden` true and without its\nprovider, repository or branch.\n","operationId":"listEnvironmentRepositories","responses":{"200":{"content":{"application/json":{"examples":{"repositories":{"$ref":"#/components/examples/EnterpriseRepositoryListExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseRepositoryList"}}},"description":"The repositories, and what your role may do with them."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List an environment's repositories","tags":["Enterprise deployments"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"post":{"description":"Connects a git repository to the environment through one of the git accounts `GET\n/environments/{environment}/repositories/connections` lists. Your role needs the Manage Deployment\nRepositories permission and, while a push deploys on its own (`git_deploys` is `automatic`), Create\nDeployments as well.\n","operationId":"createEnvironmentRepository","requestBody":{"content":{"application/json":{"examples":{"add":{"summary":"Add a GitHub repository","value":{"branch":"main","connection_id":4216,"pipeline_id":2210,"repo":"northwind-digital/harbourandfinch-trade-theme","root_directory":"/"}}},"schema":{"$ref":"#/components/schemas/EnterpriseRepositoryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"added":{"value":{"environment_repository":{"branch":"main","connection_hidden":false,"connection_owner":null,"environment_deployment_pipeline_id":"2210","id":"3302","provider":"github","repo":"northwind-digital/harbourandfinch-trade-theme"}}}},"schema":{"$ref":"#/components/schemas/EnterpriseRepositoryAnswer"}}},"description":"The repository, as the list shows it."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnterpriseRepositoryForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnterpriseRepositoryInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create an environment's repository","tags":["Enterprise deployments"],"x-effect":["changes-settings"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"cse-deployment-settings-write","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/environments/{environment}/repositories/connections":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers the git accounts you may set a repository of this environment up with: those of the environment's\ncompany and of the agencies that manage it, as far as you may use them. Send an account's `id` as\n`connection_id` when you add or change a repository.\n","operationId":"listEnvironmentRepositoryConnections","responses":{"200":{"content":{"application/json":{"examples":{"connections":{"value":{"connections":[{"company":"Harbour & Finch","id":"4216","provider":"github","username":"daniel-reyes"}]}}},"schema":{"$ref":"#/components/schemas/EnterpriseRepositoryConnectionList"}}},"description":"The git accounts. Empty when there is none you may use."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnterpriseDeploymentNotEnterprise"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List the git accounts for a repository","tags":["Enterprise deployments"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/environments/{environment}/repositories/{repository}":{"parameters":[{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/EnterpriseRepositoryId"}],"patch":{"description":"Replaces the repository's git account, pipeline, repository path, branch and folder. Send every field, as when\nadding one. The permissions are those of adding a repository.\n","operationId":"updateEnvironmentRepository","requestBody":{"content":{"application/json":{"examples":{"branch":{"summary":"Deploy from another branch","value":{"branch":"release","connection_id":4216,"pipeline_id":2210,"repo":"northwind-digital/harbourandfinch-trade","root_directory":"/"}}},"schema":{"$ref":"#/components/schemas/EnterpriseRepositoryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"changed":{"value":{"environment_repository":{"branch":"release","connection_hidden":false,"connection_owner":null,"environment_deployment_pipeline_id":"2210","id":"3301","provider":"github","repo":"northwind-digital/harbourandfinch-trade"}}}},"schema":{"$ref":"#/components/schemas/EnterpriseRepositoryAnswer"}}},"description":"The repository as it is now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnterpriseRepositoryForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnterpriseRepositoryInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update an environment's repository","tags":["Enterprise deployments"],"x-effect":["changes-settings"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"cse-deployment-settings-write","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Disconnects the repository from the environment. Deployments already made keep their commit. Your role needs\nthe Manage Deployment Repositories permission.\n","operationId":"deleteEnvironmentRepository","responses":{"204":{"description":"The repository was removed. No body."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnterpriseRepositoryForbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnterpriseDeploymentNotEnterprise"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete an environment's repository","tags":["Enterprise deployments"],"x-effect":["deletes"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"cse-deployment-settings-write","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/environments/{environment}/ssh":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers how to connect to the environment and every key that can log in, grouped by username, with the level\neach key comes from. `add_options` lists the levels you may add a key at.\n","operationId":"getEnvironmentSsh","responses":{"200":{"content":{"application/json":{"examples":{"environment":{"$ref":"#/components/examples/SshEnvironmentAccessExample"}},"schema":{"$ref":"#/components/schemas/SshEnvironmentAccess"}}},"description":"The environment's SSH access."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/SshNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an environment's SSH access","tags":["SSH keys"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-rate-limit":{"bucket":"ssh-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/environments/{environment}/ssh/activity":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers what changed about SSH access to the environment, newest first, 50 a page: keys added, changed and\nremoved at any level that reaches it, usernames issued, host keys rotated and changes applied. Paged by\ncursor: send `next_cursor` back as `cursor`; null means the last page.\n","operationId":"listEnvironmentSshActivity","parameters":[{"$ref":"#/components/parameters/sshCursor"}],"responses":{"200":{"content":{"application/json":{"examples":{"activity":{"$ref":"#/components/examples/SshActivityPageExample"}},"schema":{"$ref":"#/components/schemas/SshActivityPage"}}},"description":"A page of activity."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/SshNotFound"},"422":{"$ref":"#/components/responses/SshInvalidQuery"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List an environment's SSH activity","tags":["SSH keys"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-rate-limit":{"bucket":"ssh-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/environments/{environment}/ssh/host-keys":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers the host keys the environment presents, as fingerprints and as `known_hosts` lines, the latest rotation\nand whether you can rotate them. Only public keys are ever answered.\n","operationId":"getEnvironmentSshHostKeys","responses":{"200":{"content":{"application/json":{"examples":{"host_keys":{"$ref":"#/components/examples/SshHostKeysViewExample"}},"schema":{"$ref":"#/components/schemas/SshHostKeysView"}}},"description":"The environment's host keys."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/SshNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an environment's host keys","tags":["SSH keys"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-rate-limit":{"bucket":"ssh-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/environments/{environment}/ssh/host-keys/rotation":{"parameters":[{"$ref":"#/components/parameters/environment"}],"post":{"description":"Starts or moves on a host-key rotation of a CoreStack or CoreCluster environment: `stage` offers new host keys\nbeside the current ones, `finish` switches to them, `cancel` drops a staged rotation and `now` switches at\nonce, so every client then sees a changed host key. Type the environment's name in `confirm_environment`; an\nenvironment takes six rotation steps an hour.\n","operationId":"rotateSshHostKeys","requestBody":{"content":{"application/json":{"examples":{"now":{"summary":"Switch to new host keys at once","value":{"action":"now","confirm_environment":"Production"}},"stage":{"summary":"Offer new host keys beside the current ones","value":{"action":"stage","confirm_environment":"Production"}}},"schema":{"$ref":"#/components/schemas/SshHostKeyRotationRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"change_id":0,"rotation":{"id":3301,"last_error_public":null,"mode":"staged","offered_at":"2026-11-06T09:20:00+00:00","promote_after":"2026-11-13T09:20:00+00:00","rotation_id":"hkr-0f1e2d3c4b5a","state":"offered"},"rotation_id":"hkr-0f1e2d3c4b5a"},"schema":{"$ref":"#/components/schemas/SshRotationStarted"}}},"description":"The rotation step was started. `rotation_id` is the rotation's id and `rotation` is the rotation as it\nstands. Follow it by reading `GET /environments/{environment}/ssh/host-keys` until `rotation.state` is\n`done`, `cancelled`, `aborted` or `failed` for the same `rotation.rotation_id`; a staged rotation waits in\n`offered` until it is finished or its day comes. `change_id` is always 0: a rotation is not a change\nthat `GET /ssh/changes/{change}` answers.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/SshNotFound"},"409":{"content":{"application/json":{"example":{"code":"ssh_rotation_in_progress","field":null,"message":"A host-key rotation is already in progress.","reason":"ssh_rotation_in_progress"},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"`stage` or `now` was asked while another rotation of this environment's host keys is still open\n(`ssh_rotation_in_progress`). Finish or cancel that one first.\n"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"The typed name is not the environment's","value":{"code":"confirm_mismatch","errors":{"confirm_environment":["The name you typed is not this environment's name."]},"field":"confirm_environment","message":"The name you typed is not this environment's name.","reason":"confirm_mismatch"}},"invalid_arguments":{"summary":"The action is not one of the four","value":{"code":"invalid_arguments","errors":{"action":["action is one of stage, now, finish, cancel."]},"field":"action","message":"action is one of stage, now, finish, cancel.","reason":"invalid_arguments"}},"ssh_host_keys_unmanaged":{"summary":"A CoreStack Enterprise environment","value":{"code":"ssh_host_keys_unmanaged","field":null,"message":"Host keys on this environment are managed by Corefinity.","reason":"ssh_host_keys_unmanaged"}},"ssh_rotation_unavailable":{"summary":"Nothing is staged to finish","value":{"code":"ssh_rotation_unavailable","field":null,"message":"There is no staged rotation to finish.","reason":"ssh_rotation_unavailable"}}},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"The request was refused. `reason` says why: `invalid_arguments` (a field is missing or wrong; `field` names\nit), `confirm_mismatch` (`confirm_environment` is not the environment's name), `ssh_host_keys_unmanaged`\n(the host keys of a CoreStack Enterprise environment are managed by Corefinity) or\n`ssh_rotation_unavailable` (host keys cannot be rotated here yet, there is no staged rotation to finish\nor cancel, the staged rotation is past the step that was asked, or the environment is not ready or is\nbeing moved; the message says which).\n"},"429":{"content":{"application/json":{"examples":{"ssh_throttled":{"summary":"Six rotation requests for this environment in the last hour","value":{"code":"ssh_throttled","field":null,"message":"Too many host-key rotations on this environment. Try again later.","reason":"ssh_throttled","retry_after":1840,"retry_after_seconds":1840}},"too_many_attempts":{"summary":"Your own request budget is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 42 seconds.","reason":"rate_limited","retry_after_seconds":42}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/SshRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"Too many requests: more than 30 rotation requests in an hour from you (`rate_limited`), or six rotation\nsteps already taken for this environment in the last hour (`ssh_throttled`, with the wait in\n`retry_after_seconds` and no `Retry-After` header).\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}}},"summary":"Rotate an environment's host keys","tags":["SSH keys"],"x-effect":["changes-settings","overwrites"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api","ssh_keys","sshkeys.host_keys.cscc"],"x-long-running":"getEnvironmentSshHostKeys","x-rate-limit":{"also":[{"bucket":"ssh-host-key-rotation","limit":6,"minutes":60,"per":"environment"}],"bucket":"ssh-api-rotation","limit":30,"minutes":60},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/environments/{environment}/variables":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers every variable of a CoreStack Enterprise environment by name, with its value masked and the deployment\nstages that read it. A build sees each variable with the `CF_` prefix, so `API_TOKEN` is read as\n`$CF_API_TOKEN`.\n","operationId":"listEnterpriseVariables","responses":{"200":{"content":{"application/json":{"examples":{"variables":{"$ref":"#/components/examples/EnterpriseVariableListExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseVariableList"}}},"description":"The environment's variables, in name order."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnterpriseVariableInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List an environment's variables","tags":["Environment variables"],"x-feature":"enterprise-variables","x-file":"enterprise-variables","x-gates":[],"x-rate-limit":{"bucket":"cse-variables-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/environments/{environment}/variables/{name}":{"parameters":[{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/EnterpriseVariableName"}],"put":{"description":"Creates the variable when the environment does not have it (`201`), and changes it otherwise (`200`). Leave\n`value` out to keep the stored value, so a rename never needs it; a new variable needs one. The answer carries\nthe mask, never the value.\n","operationId":"updateEnterpriseVariable","requestBody":{"content":{"application/json":{"examples":{"change":{"summary":"Change a variable's value","value":{"value":"example-value-not-a-real-secret"}},"clear":{"summary":"Clear a variable's value","value":{"value":""}},"create":{"summary":"Create a variable","value":{"value":"example-value-not-a-real-secret"}},"rename":{"summary":"Rename a variable and keep its value","value":{"rename_to":"PAYMENTS_API_TOKEN"}}},"schema":{"$ref":"#/components/schemas/EnterpriseVariableSetRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"examples":{"changed":{"summary":"A changed variable","value":{"variable":{"masked":"••••••••cret","name":"API_TOKEN","updated_at":"2026-11-09T10:42:07Z"}}},"cleared":{"summary":"A cleared variable","value":{"variable":{"masked":"••••••••","name":"API_TOKEN","updated_at":"2026-11-09T10:42:07Z"}}},"renamed":{"summary":"A renamed variable","value":{"variable":{"masked":"••••••••cret","name":"PAYMENTS_API_TOKEN","updated_at":"2026-11-09T10:42:07Z"}}}},"schema":{"$ref":"#/components/schemas/EnterpriseVariableSaved"}}},"description":"The variable after the change."},"201":{"content":{"application/json":{"examples":{"created":{"summary":"A new variable","value":{"variable":{"masked":"••••••••cret","name":"SEARCH_API_KEY","updated_at":"2026-11-09T10:42:07Z"}}}},"schema":{"$ref":"#/components/schemas/EnterpriseVariableSaved"}}},"description":"The variable was created."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"exists":{"summary":"The name is taken","value":{"code":"exists","message":"This environment already has a variable with that name.","reason":"exists"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The new name, or `rename_to`, is one another variable of the environment already has (`exists`). Names are compared without case."},"422":{"content":{"application/json":{"examples":{"name":{"summary":"A name the rules refuse","value":{"code":"variable_invalid","errors":{"name":["Use letters, digits and underscores, starting with a letter or underscore, without the CF_ prefix (CoreStack adds it)."]},"message":"Use letters, digits and underscores, starting with a letter or underscore, without the CF_ prefix (CoreStack adds it).","reason":"variable_invalid"}},"reserved":{"summary":"A name CoreStack sets itself","value":{"code":"variable_reserved","errors":{"name":["CF_DOMAIN is set by CoreStack. Choose another name."]},"message":"CF_DOMAIN is set by CoreStack. Choose another name.","reason":"variable_reserved"}},"site_environment":{"$ref":"#/components/examples/EnterpriseVariableSiteEnvironmentExample"},"too_many":{"summary":"The environment is full","value":{"code":"too_many_variables","errors":{"name":["This environment already has the most variables it can hold."]},"message":"This environment already has the most variables it can hold.","reason":"too_many_variables"}},"tool_credential":{"summary":"A name a build tool reads its credentials from","value":{"code":"variable_tool_credential","errors":{"name":["Builds see this variable as CF_NPM_TOKEN, so npm never reads it. Add the credentials under Deployments > Private registries instead."]},"message":"Builds see this variable as CF_NPM_TOKEN, so npm never reads it. Add the credentials under Deployments > Private registries instead.","reason":"variable_tool_credential"}},"value":{"summary":"A new variable without a value, or a value the rules refuse","value":{"code":"variable_invalid","errors":{"value":["Use at most 2,048 characters, with no line breaks, control or invisible formatting characters."]},"message":"Use at most 2,048 characters, with no line breaks, control or invisible formatting characters.","reason":"variable_invalid"}},"wrong_type":{"summary":"A value that is not a string","value":{"code":"invalid","errors":{"value":["The value argument must be string or null."]},"field":"value","message":"Some arguments are not valid.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"The request was refused and nothing was stored. `errors` names the field.\n\n- `variable_invalid` on `name` or `rename_to`: the name is not letters, digits and underscores starting\n  with a letter or underscore, is longer than 64 characters, or starts with `CF_`.\n- `variable_invalid` on `value`: a new variable without a value, a value longer than 2,048 characters, or\n  one with a line break, control or invisible formatting character.\n- `variable_reserved` on `name` or `rename_to`: a name CoreStack sets itself.\n- `variable_tool_credential` on `name` or `rename_to`: a name a build tool reads its own credentials from,\n  such as `NPM_TOKEN` or `COMPOSER_AUTH`.\n- `too_many_variables` on `name`: the environment holds as many variables as it can.\n- `invalid`: a field of the wrong type, a field this endpoint does not take, or an environment that\n  belongs to a CoreStack or CoreCluster site (on `environment`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update an environment's variable","tags":["Environment variables"],"x-effect":["changes-settings"],"x-feature":"enterprise-variables","x-file":"enterprise-variables","x-gates":[],"x-rate-limit":{"bucket":"cse-variables-write","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes the variable from the environment, by its stored name as it is. The next deployment no longer has it.\n","operationId":"deleteEnterpriseVariable","responses":{"204":{"description":"The variable was removed. No body."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/EnterpriseVariableInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a variable","tags":["Environment variables"],"x-effect":["deletes"],"x-feature":"enterprise-variables","x-file":"enterprise-variables","x-gates":[],"x-rate-limit":{"bucket":"cse-variables-write","limit":20,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/environments/{environment}/variables/{name}/reveal":{"parameters":[{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/EnterpriseVariableName"}],"post":{"description":"Answers the variable's stored value, the only endpoint that does. It needs a token with the `exec` scope, and\nthe answer is never cached.\n","operationId":"revealEnterpriseVariable","responses":{"200":{"content":{"application/json":{"examples":{"revealed":{"summary":"A revealed value","value":{"name":"API_TOKEN","value":"example-value-not-a-real-secret"}}},"schema":{"$ref":"#/components/schemas/EnterpriseVariableRevealed"}}},"description":"The variable's name and its value.","headers":{"Cache-Control":{"description":"Always `no-store, private`. Do not keep the answer.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ForbiddenScopeOrTwoFactor","description":"The token lacks the `exec` scope (`scope_required`), or your company requires two-factor authentication and you have not set it up."},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"unreadable":{"summary":"The value can no longer be read","value":{"code":"not_available","errors":{"name":["This value can no longer be read. Set it again."]},"message":"This value can no longer be read. Set it again.","reason":"not_available"}}},"schema":{"$ref":"#/components/schemas/NamedFieldRefusal"}}},"description":"The stored value can no longer be read (`not_available`). Set the variable again."},"422":{"$ref":"#/components/responses/EnterpriseVariableInvalid"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Reveal a variable's value","tags":["Environment variables"],"x-effect":["reveals-secret"],"x-feature":"enterprise-variables","x-file":"enterprise-variables","x-gates":[],"x-rate-limit":{"bucket":"reseller-credentials","limit":10,"minutes":1},"x-scope":"exec","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/environments/{environment}/web-access":{"parameters":[{"$ref":"#/components/parameters/environment"}],"get":{"description":"For a CoreStack or CoreCluster environment, answers whether HTTP authentication and maintenance mode are on, the\nlogins (never their passwords), and what an address with website access skips.\n","operationId":"getEnvironmentWebAccess","responses":{"200":{"content":{"application/json":{"examples":{"web_access":{"$ref":"#/components/examples/FirewallWebAccessExample"}},"schema":{"$ref":"#/components/schemas/FirewallWebAccess"}}},"description":"The environment's website access."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"$ref":"#/components/responses/FirewallWebAccessUnavailable"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an environment's website access","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/firewall/changes/{change}":{"parameters":[{"$ref":"#/components/parameters/firewallChange"}],"get":{"description":"Answers how far a firewall change has been applied. Read it again until `state` is `applied`, `failed` or\n`recorded`.\n","operationId":"getFirewallChange","responses":{"200":{"content":{"application/json":{"examples":{"change":{"$ref":"#/components/examples/FirewallChangeExample"}},"schema":{"$ref":"#/components/schemas/FirewallChange"}}},"description":"The change."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a firewall change","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-changes","limit":240,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/firewall/entries":{"post":{"description":"Adds an address or a range at one level: a company, a website, one environment, or yourself. A range may be as\nwide as /24 (IPv6 /48); ask for a wider one with a range request. The address works once the change has been\napplied.\n","operationId":"createFirewallEntry","requestBody":{"content":{"application/json":{"examples":{"company_range":{"summary":"An office range for the whole company, SSH only","value":{"address":"198.51.100.0/24","comment":"Head office","owner_id":1204,"owner_type":"company","scope":"ssh"}},"environment_address":{"summary":"One address for one environment, for 90 days","value":{"address":"203.0.113.42","comment":"Contractor","expires_in_days":90,"owner_id":1311,"owner_type":"environment"}},"own_address":{"summary":"An address of your own","value":{"address":"192.0.2.44","owner_id":2041,"owner_type":"user"}}},"schema":{"$ref":"#/components/schemas/FirewallEntryCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"added":{"$ref":"#/components/examples/FirewallEntryAddedExample"}},"schema":{"$ref":"#/components/schemas/FirewallEntrySaved"}}},"description":"The address was added. Follow `change_id` with `GET /firewall/changes/{change}` to see it applied.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/FirewallWriteForbidden"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"content":{"application/json":{"examples":{"firewall_address_invalid":{"summary":"Not an address","value":{"code":"firewall_address_invalid","field":"address","message":"Enter an IPv4 or IPv6 address, or a range in CIDR form (for example 203.0.113.0/24).","reason":"firewall_address_invalid"}},"firewall_address_refused":{"summary":"A private address","value":{"code":"firewall_address_refused","field":"address","message":"That address is in a private range and cannot be allowed.","reason":"firewall_address_refused"}},"firewall_approval_required":{"summary":"A range that needs approval","value":{"code":"firewall_approval_required","field":"address","message":"Ranges wider than /24 (IPv6 /48) need approval from Corefinity. Send it as a range request.","reason":"firewall_approval_required"}},"firewall_cap_exceeded":{"summary":"The list holds its limit","value":{"code":"firewall_cap_exceeded","field":null,"message":"This list already holds its limit of 200 addresses.","reason":"firewall_cap_exceeded"}},"firewall_duplicate":{"summary":"The address is already listed here","value":{"code":"firewall_duplicate","field":"address","message":"That address is already on this list.","reason":"firewall_duplicate"}},"firewall_width_refused":{"summary":"A range that is never accepted","value":{"code":"firewall_width_refused","field":"address","message":"That range is far too wide to allow. Ranges of /8 or wider are never accepted.","reason":"firewall_width_refused"}},"invalid_arguments":{"summary":"A field that is not part of the request","value":{"code":"invalid_arguments","errors":{"note":["note is not part of this request."]},"field":"note","message":"note is not part of this request.","reason":"invalid_arguments"}},"invalid_expiry":{"summary":"An expiry that is not offered","value":{"code":"invalid_arguments","errors":{"expires_in_days":["Some of the details are missing or not valid."]},"field":"expires_in_days","message":"Some of the details are missing or not valid.","reason":"invalid_arguments"}}},"schema":{"$ref":"#/components/schemas/FirewallRefusal"}}},"description":"The request was refused. `reason` says why:\n\n- `invalid_arguments`: a field is missing, wrong or not part of the request; `field` names it.\n- `firewall_address_invalid`: `address` is not an IPv4 or IPv6 address or a range in CIDR form.\n- `firewall_width_refused`: a range of /8 or wider. These are never accepted.\n- `firewall_approval_required`: a range wider than /24 (IPv6 /48). Send it as a range request.\n- `firewall_address_refused`: a private, reserved or provider range; the message names which. The\n  documentation ranges the examples on this page use (192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24,\n  2001:db8::/32) are refused too: send an address of your own.\n- `firewall_duplicate`: the address is already on this list.\n- `firewall_scope_invalid`: the scope cannot apply to this address here, such as SSH only for an IPv6\n  address, or website access on CoreStack Enterprise.\n- `firewall_cap_exceeded`: the list, or an environment it reaches, holds its limit of addresses.\n"},"429":{"$ref":"#/components/responses/FirewallTooManyWrites"}},"summary":"Create a firewall entry","tags":["Firewall"],"x-effect":["changes-settings"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-long-running":"getFirewallChange","x-rate-limit":{"also":[{"bucket":"firewall-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"firewall-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"firewall-api-write-requests","limit":120,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/firewall/entries/{entry}":{"parameters":[{"$ref":"#/components/parameters/firewallEntry"}],"patch":{"description":"Changes an entry's comment, expiry or scope. Send at least one of them. The address itself cannot be changed:\nremove the entry and add another.\n","operationId":"updateFirewallEntry","requestBody":{"content":{"application/json":{"examples":{"comment":{"summary":"Change the comment","value":{"comment":"Head office"}},"expiry":{"summary":"Let the address expire in 90 days","value":{"expires_in_days":90}},"scope":{"summary":"Limit the address to SSH","value":{"scope":"ssh"}}},"schema":{"$ref":"#/components/schemas/FirewallEntryUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"updated":{"$ref":"#/components/examples/FirewallEntryUpdatedExample"}},"schema":{"$ref":"#/components/schemas/FirewallEntrySaved"}}},"description":"The entry as it is now. `change_id` is null when nothing needs applying, as after a new comment."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/FirewallWriteForbidden"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"409":{"$ref":"#/components/responses/FirewallStateConflict"},"422":{"content":{"application/json":{"examples":{"firewall_scope_invalid":{"summary":"A scope that cannot apply","value":{"code":"firewall_scope_invalid","field":"scope","message":"That scope cannot apply to this address here.","reason":"firewall_scope_invalid"}},"invalid_arguments":{"summary":"Nothing to change","value":{"code":"invalid_arguments","errors":{"comment":["Change the comment, the expiry or the scope."]},"field":"comment","message":"Change the comment, the expiry or the scope.","reason":"invalid_arguments"}}},"schema":{"$ref":"#/components/schemas/FirewallRefusal"}}},"description":"The request was refused. `reason` says why: `invalid_arguments` (a field is wrong or not part of the\nrequest, or nothing was sent to change; `field` names it), `firewall_scope_invalid` (the scope cannot\napply to this address here) or `firewall_cap_exceeded` (a wider scope, or a new expiry for an entry that\nhad expired, would take an environment it reaches over its limit of addresses).\n"},"429":{"$ref":"#/components/responses/FirewallTooManyWrites"}},"summary":"Update a firewall entry","tags":["Firewall"],"x-effect":["changes-settings"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-long-running":"getFirewallChange","x-rate-limit":{"also":[{"bucket":"firewall-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"firewall-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"firewall-api-write-requests","limit":120,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes an address from its list. Send the address back in `confirm_address`, in the request body, exactly as\nthe list shows it in `cidr`. The entry reads `removing` until the address is gone from every environment it\nreached.\n","operationId":"deleteFirewallEntry","requestBody":{"content":{"application/json":{"examples":{"remove":{"summary":"Remove the address","value":{"confirm_address":"203.0.113.7/32"}}},"schema":{"$ref":"#/components/schemas/FirewallEntryRemoveRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"change_id":5313},"schema":{"$ref":"#/components/schemas/FirewallChangeStarted"}}},"description":"The removal was started. Follow `change_id` with `GET /firewall/changes/{change}`. An entry that is\nalready being removed answers the change of the removal under way.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/FirewallWriteForbidden"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"The address is not the entry's","value":{"code":"confirm_mismatch","errors":{"confirm_address":["The confirmation does not match."]},"field":"confirm_address","message":"The confirmation does not match.","reason":"confirm_mismatch"}},"invalid_arguments":{"summary":"No address was sent back","value":{"code":"invalid_arguments","errors":{"confirm_address":["Some of the details are missing or not valid."]},"field":"confirm_address","message":"Some of the details are missing or not valid.","reason":"invalid_arguments"}}},"schema":{"$ref":"#/components/schemas/FirewallRefusal"}}},"description":"The request was refused. `reason` says why: `invalid_arguments` (`confirm_address` is missing, or a field\nis not part of the request; `field` names it) or `confirm_mismatch` (`confirm_address` is not the entry's\naddress).\n"},"429":{"$ref":"#/components/responses/FirewallTooManyWrites"}},"summary":"Delete a firewall entry","tags":["Firewall"],"x-effect":["deletes"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-long-running":"getFirewallChange","x-rate-limit":{"also":[{"bucket":"firewall-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"firewall-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"firewall-api-write-requests","limit":120,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/firewall/my-ip":{"get":{"description":"Answers the address this request came from, whether it can connect to the environment now, and the levels it\ncan be added at with what each opens. The address is always the one the request came from; it cannot be sent.\n","operationId":"getMyIp","parameters":[{"description":"The environment to check the address against.","example":1311,"in":"query","name":"environment_id","required":true,"schema":{"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"my_ip":{"$ref":"#/components/examples/FirewallMyIpExample"}},"schema":{"$ref":"#/components/schemas/FirewallMyIp"}}},"description":"The address and where it can be added."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"content":{"application/json":{"example":{"code":"invalid_arguments","errors":{"environment_id":["Some of the details are missing or not valid."]},"field":"environment_id","message":"Some of the details are missing or not valid.","reason":"invalid_arguments"},"schema":{"$ref":"#/components/schemas/FirewallRefusal"}}},"description":"`environment_id` is missing or is not an environment id (`invalid_arguments`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the address you are calling from","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"post":{"description":"Adds the address this request came from, for SSH and for the website, at the level you choose: `me` (every environment you can reach), this `environment`, its `website` or your `company`. When the address can already connect, nothing is added and the answer says what allows it. When the level already holds the address for SSH only or for the website only, that entry is widened to both rather than a second one added, and it keeps its expiry unless the one you ask for is later: an entry with no expiry stays without one, so `expires_in_days` never shortens it. Read `entry.expires_at` in the answer for when the address stops being allowed.","operationId":"createFirewallEntryForMyIp","requestBody":{"content":{"application/json":{"examples":{"for_yourself":{"summary":"Add it for yourself, for 30 days","value":{"comment":"Home","environment_id":1311,"expires_in_days":30,"level":"me"}}},"schema":{"$ref":"#/components/schemas/FirewallMyIpRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"present":{"$ref":"#/components/examples/FirewallMyIpPresentExample"}},"schema":{"$ref":"#/components/schemas/FirewallMyIpPresent"}}},"description":"The address can already connect. Nothing was added."},"201":{"content":{"application/json":{"examples":{"added":{"$ref":"#/components/examples/FirewallMyIpAddedExample"}},"schema":{"$ref":"#/components/schemas/FirewallMyIpAdded"}}},"description":"The address was added, or the entry the level already held for it was widened to SSH and the website.\n`entry` is the entry as it now stands, with the expiry it has. Follow `change_id` with\n`GET /firewall/changes/{change}`.\n"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/FirewallWriteForbidden"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"content":{"application/json":{"examples":{"firewall_address_refused":{"summary":"A request from a private address","value":{"code":"firewall_address_refused","field":"address","message":"That address is in a private range and cannot be allowed.","reason":"firewall_address_refused"}},"invalid_arguments":{"summary":"No environment was named","value":{"code":"invalid_arguments","errors":{"environment_id":["Some of the details are missing or not valid."]},"field":"environment_id","message":"Some of the details are missing or not valid.","reason":"invalid_arguments"}}},"schema":{"$ref":"#/components/schemas/FirewallRefusal"}}},"description":"The request was refused. `reason` says why: `invalid_arguments` (`environment_id`, `level`,\n`expires_in_days` or `comment` is missing or wrong, or a field is not part of the request; `field` names\nit), `firewall_address_refused` (the address is in a private, reserved or provider range; the message\nnames which), `firewall_cap_exceeded` (the list, or an environment it reaches, holds its limit of\naddresses), `firewall_scope_invalid` (an IPv6 address at a level that reaches only CoreStack Enterprise\nenvironments, which have SSH only) or `firewall_duplicate` (the address is already at that level, waiting\nfor approval).\n"},"429":{"$ref":"#/components/responses/FirewallTooManyWrites"}},"summary":"Create an entry for your address","tags":["Firewall"],"x-effect":["changes-settings"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-long-running":"getFirewallChange","x-rate-limit":{"also":[{"bucket":"firewall-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"firewall-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"firewall-my-ip","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/firewall/preset-subscriptions":{"post":{"description":"Attaches a preset at a company, a website, one environment or yourself, so every range of the preset may\nconnect over SSH. The ranges follow the preset as Corefinity updates it.\n","operationId":"attachFirewallPreset","requestBody":{"content":{"application/json":{"examples":{"company":{"summary":"Attach a preset for the whole company","value":{"owner_id":1204,"owner_type":"company","preset_id":12}}},"schema":{"$ref":"#/components/schemas/FirewallPresetAttachRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"attached":{"$ref":"#/components/examples/FirewallPresetAttachedExample"}},"schema":{"$ref":"#/components/schemas/FirewallPresetSubscriptionSaved"}}},"description":"The preset was attached. Follow `change_id` with `GET /firewall/changes/{change}`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/FirewallWriteForbidden"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"content":{"application/json":{"examples":{"firewall_preset_present":{"summary":"The preset is already attached here","value":{"code":"firewall_preset_present","field":"preset_id","message":"That preset is already attached here.","reason":"firewall_preset_present"}},"invalid_arguments":{"summary":"No preset was named","value":{"code":"invalid_arguments","errors":{"preset_id":["Some of the details are missing or not valid."]},"field":"preset_id","message":"Some of the details are missing or not valid.","reason":"invalid_arguments"}}},"schema":{"$ref":"#/components/schemas/FirewallRefusal"}}},"description":"The request was refused. `reason` says why: `invalid_arguments` (a field is missing, wrong or not part of\nthe request; `field` names it) or `firewall_preset_present` (the preset is already attached at this\nowner).\n"},"429":{"$ref":"#/components/responses/FirewallTooManyWrites"}},"summary":"Attach a firewall preset","tags":["Firewall"],"x-effect":["changes-settings"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-long-running":"getFirewallChange","x-rate-limit":{"also":[{"bucket":"firewall-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"firewall-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"firewall-api-write-requests","limit":120,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/firewall/preset-subscriptions/{subscription}":{"parameters":[{"$ref":"#/components/parameters/firewallSubscription"}],"delete":{"description":"Detaches a preset from its owner. Send the preset's `slug` in `confirm_preset`, in the request body. The\npreset's ranges stop being allowed through this owner.\n","operationId":"detachFirewallPreset","requestBody":{"content":{"application/json":{"examples":{"detach":{"summary":"Detach the preset","value":{"confirm_preset":"github-actions"}}},"schema":{"$ref":"#/components/schemas/FirewallPresetDetachRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"change_id":5314},"schema":{"$ref":"#/components/schemas/FirewallChangeStarted"}}},"description":"The preset was detached. Follow `change_id` with `GET /firewall/changes/{change}`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/FirewallWriteForbidden"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"The slug is not the preset's","value":{"code":"confirm_mismatch","errors":{"confirm_preset":["The confirmation does not match."]},"field":"confirm_preset","message":"The confirmation does not match.","reason":"confirm_mismatch"}},"invalid_arguments":{"summary":"No slug was sent","value":{"code":"invalid_arguments","errors":{"confirm_preset":["Some of the details are missing or not valid."]},"field":"confirm_preset","message":"Some of the details are missing or not valid.","reason":"invalid_arguments"}}},"schema":{"$ref":"#/components/schemas/FirewallRefusal"}}},"description":"The request was refused. `reason` says why: `invalid_arguments` (`confirm_preset` is missing, or a field\nis not part of the request; `field` names it) or `confirm_mismatch` (`confirm_preset` is not the preset's\nslug).\n"},"429":{"$ref":"#/components/responses/FirewallTooManyWrites"}},"summary":"Detach a firewall preset","tags":["Firewall"],"x-effect":["deletes"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-long-running":"getFirewallChange","x-rate-limit":{"also":[{"bucket":"firewall-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"firewall-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"firewall-api-write-requests","limit":120,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/firewall/presets":{"get":{"description":"Answers the presets you can attach: the published address ranges of common services, which Corefinity keeps up to\ndate. A preset opens SSH only.\n","operationId":"listFirewallPresets","responses":{"200":{"content":{"application/json":{"examples":{"presets":{"$ref":"#/components/examples/FirewallPresetListExample"}},"schema":{"$ref":"#/components/schemas/FirewallPresetList"}}},"description":"The presets."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List firewall presets","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/firewall/range-requests":{"post":{"description":"Asks Corefinity to allow a range wider than /24: IPv4 /9 to /23, or IPv6 /9 to /47. The entry is made at once with the status `pending_approval` and allows nothing until Corefinity approves it; it then reads `active`, or `rejected` with the reason.","operationId":"createFirewallRangeRequest","requestBody":{"content":{"application/json":{"examples":{"office_network":{"summary":"An IPv6 office network for the whole company","value":{"address":"2001:db8:4a00::/40","owner_id":1204,"owner_type":"company","reason":"Our office network. Every workstation gets an address from this range."}}},"schema":{"$ref":"#/components/schemas/FirewallRangeRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"requested":{"$ref":"#/components/examples/FirewallRangeRequestedExample"}},"schema":{"$ref":"#/components/schemas/FirewallRangeRequested"}}},"description":"The request was filed. `entry.status` is `pending_approval`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/FirewallWriteForbidden"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"content":{"application/json":{"examples":{"firewall_cap_exceeded":{"summary":"The list holds its limit","value":{"code":"firewall_cap_exceeded","field":null,"message":"This list already holds its limit of 200 addresses.","reason":"firewall_cap_exceeded"}},"invalid_arguments":{"summary":"No reason was given","value":{"code":"invalid_arguments","errors":{"reason":["Some of the details are missing or not valid."]},"field":"reason","message":"Some of the details are missing or not valid.","reason":"invalid_arguments"}},"not_wide_enough":{"summary":"A range that needs no approval","value":{"code":"invalid_arguments","errors":{"address":["That address can be added directly; a range request is only for ranges wider than /24 (IPv6 /48)."]},"field":"address","message":"That address can be added directly; a range request is only for ranges wider than /24 (IPv6 /48).","reason":"invalid_arguments"}}},"schema":{"$ref":"#/components/schemas/FirewallRefusal"}}},"description":"The request was refused. `reason` says why: `invalid_arguments` (a field is missing, wrong or not part of\nthe request, or `address` is an address or a range of /24 (IPv6 /48) or narrower, which needs no approval;\n`field` names it), `firewall_address_invalid`, `firewall_width_refused` (a range of /8 or wider),\n`firewall_address_refused` (a private, reserved or provider range), `firewall_duplicate`,\n`firewall_scope_invalid` or `firewall_cap_exceeded` (the list holds its limit of addresses; a request\nwaiting for approval counts).\n"},"429":{"$ref":"#/components/responses/FirewallTooManyWrites"}},"summary":"Create a request for a wider range","tags":["Firewall"],"x-effect":["changes-settings"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"also":[{"bucket":"firewall-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"firewall-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"firewall-range-requests","limit":10,"minutes":60},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/maintenance-windows/upcoming":{"get":{"description":"Answers the next seven days of windows with what is queued for each: for one site (`site`), for the sites of one CoreCluster (`cluster`), or for every site you can see, up to 200.","operationId":"listUpcomingMaintenanceWindows","parameters":[{"description":"The id of one site row.","in":"query","name":"site","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"The id of one CoreCluster. Read only when `site` is not sent.","in":"query","name":"cluster","required":false,"schema":{"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"days":[{"local_date":"2026-11-04","slots":[{"domain":"harbourandfinch.example.com","ends_at":"2026-11-04T04:00:00Z","environment":null,"label":"00:00–04:00 UK time","pending":[],"site_id":1042,"starts_at":"2026-11-04T00:00:00Z"}]}]},"schema":{"$ref":"#/components/schemas/UpcomingMaintenanceWindows"}}},"description":"The days that have a window, soonest first."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List upcoming maintenance windows","tags":["Maintenance windows"],"x-feature":"maintenance-windows","x-file":"maintenance-windows","x-gates":["maintenance_windows.api"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/performance-audits":{"get":{"description":"Answers the audits of the companies you may access, newest first, without their results. Paged by cursor: send\n`next_cursor` back as `cursor`; null means the last page.\n","operationId":"listPerformanceAudits","parameters":[{"$ref":"#/components/parameters/cursorLimit"},{"description":"The `next_cursor` of the previous answer. Anything that is not a whole number is refused `422` on `cursor`.","in":"query","name":"cursor","required":false,"schema":{"pattern":"^[1-9][0-9]{0,18}$","type":"string"}},{"description":"Keeps the audits of one company among those you may access.","in":"query","name":"company_id","required":false,"schema":{"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"company_id":1204,"created_at":"2026-11-01T09:00:00+00:00","domains":[{"environment":"Current host","http_auth":false,"url":"https://old.harbourandfinch.example.org"},{"environment":"Corefinity","http_auth":true,"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"}],"id":5210,"name":"Before and after the move","number_of_requests":5,"page_types":[{"check_cache":true,"path":"/","title":"Home"},{"check_cache":false,"path":"/shop/","title":"Category"}],"report":{"frozen_at":null,"legacy_link_live":false,"password_protected":false,"revoked_at":null,"sections":[{"enabled":true,"key":"hero","label":"Headline","tab":"simple"},{"enabled":true,"key":"at_a_glance","label":"At a glance","tab":"simple"},{"enabled":true,"key":"response_times","label":"Response times","tab":"simple"},{"enabled":true,"key":"gap","label":"The gap, measurement by measurement","tab":"simple"},{"enabled":true,"key":"improvement","label":"Improvement per measurement","tab":"simple"},{"enabled":true,"key":"absolute_times","label":"Absolute times, side by side","tab":"simple"},{"enabled":true,"key":"waterfall","label":"Where the time actually goes","tab":"simple"},{"enabled":true,"key":"filmstrip","label":"Loading filmstrip","tab":"simple"},{"enabled":true,"key":"full_table","label":"The full table","tab":"simple"},{"enabled":true,"key":"google_scores","label":"Google scores","tab":"simple"},{"enabled":true,"key":"definitions","label":"Definitions","tab":"simple"},{"enabled":true,"key":"method","label":"Method","tab":"technical"},{"enabled":true,"key":"timing_breakdown","label":"Timing breakdown","tab":"technical"},{"enabled":true,"key":"samples","label":"Individual samples","tab":"technical"},{"enabled":true,"key":"status_codes","label":"Status codes and redirect chains","tab":"technical"},{"enabled":true,"key":"response_headers","label":"Response headers","tab":"technical"},{"enabled":true,"key":"raw_lighthouse_json","label":"Raw Lighthouse response","tab":"technical"},{"enabled":true,"key":"all_metrics","label":"Every available metric","tab":"technical"},{"enabled":true,"key":"cta","label":"Contact Corefinity","tab":"both"}],"shared":false,"shared_at":null,"username":null},"run":{"error":null,"finished_at":"2026-11-03T12:35:00+00:00","requested_at":"2026-11-03T12:30:00+00:00","started_at":"2026-11-03T12:30:00+00:00","status":"completed"},"server_location":{"id":12,"name":"London"},"updated_at":"2026-11-03T12:35:00+00:00","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36"}],"next_cursor":null},"schema":{"$ref":"#/components/schemas/PerformanceAuditList"}}},"description":"One page of audits."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"422":{"content":{"application/json":{"examples":{"cursor":{"summary":"A cursor the list did not give","value":{"code":"invalid","errors":{"cursor":["The cursor format is invalid."]},"field":"cursor","message":"The cursor format is invalid.","reason":"invalid"}},"limit":{"summary":"A limit above 100","value":{"code":"invalid","errors":{"limit":["The limit may not be greater than 100."]},"field":"limit","message":"The limit may not be greater than 100.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`limit`, `cursor` or `company_id` is not valid. `field` names it."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List performance audits","tags":["Performance audits"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-rate-limit":{"bucket":"performance-audits-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"post":{"description":"Creates an audit and starts its first run: each page of each environment is loaded `number_of_requests` times\nfrom the server location, uncached and, where `check_cache` is set, cached as well. The answer is the audit\nwith `run.status` `queued`; read the audit until `run.status` is `completed` or `failed`.\n","operationId":"createPerformanceAudit","requestBody":{"content":{"application/json":{"examples":{"two_environments":{"summary":"Two environments and two pages, one tested cached as well","value":{"domains":[{"environment":"Current host","url":"https://old.harbourandfinch.example.org"},{"environment":"Corefinity","http_password":"made-up-preview-password","http_username":"preview","url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"}],"name":"Shop audit","number_of_requests":5,"page_types":[{"check_cache":true,"path":"/","title":"Home"},{"path":"/shop/","title":"Category"}]}}},"schema":{"$ref":"#/components/schemas/PerformanceAuditRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"company_id":1204,"created_at":"2026-11-03T12:30:00+00:00","domains":[{"environment":"Current host","http_auth":false,"url":"https://old.harbourandfinch.example.org"},{"environment":"Corefinity","http_auth":true,"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"}],"id":5211,"name":"Shop audit","number_of_requests":5,"page_types":[{"check_cache":true,"path":"/","title":"Home"},{"check_cache":false,"path":"/shop/","title":"Category"}],"report":{"frozen_at":null,"legacy_link_live":false,"password_protected":false,"revoked_at":null,"sections":[{"enabled":true,"key":"hero","label":"Headline","tab":"simple"},{"enabled":true,"key":"at_a_glance","label":"At a glance","tab":"simple"},{"enabled":true,"key":"response_times","label":"Response times","tab":"simple"},{"enabled":true,"key":"gap","label":"The gap, measurement by measurement","tab":"simple"},{"enabled":true,"key":"improvement","label":"Improvement per measurement","tab":"simple"},{"enabled":true,"key":"absolute_times","label":"Absolute times, side by side","tab":"simple"},{"enabled":true,"key":"waterfall","label":"Where the time actually goes","tab":"simple"},{"enabled":true,"key":"filmstrip","label":"Loading filmstrip","tab":"simple"},{"enabled":true,"key":"full_table","label":"The full table","tab":"simple"},{"enabled":true,"key":"google_scores","label":"Google scores","tab":"simple"},{"enabled":true,"key":"definitions","label":"Definitions","tab":"simple"},{"enabled":true,"key":"method","label":"Method","tab":"technical"},{"enabled":true,"key":"timing_breakdown","label":"Timing breakdown","tab":"technical"},{"enabled":true,"key":"samples","label":"Individual samples","tab":"technical"},{"enabled":true,"key":"status_codes","label":"Status codes and redirect chains","tab":"technical"},{"enabled":true,"key":"response_headers","label":"Response headers","tab":"technical"},{"enabled":true,"key":"raw_lighthouse_json","label":"Raw Lighthouse response","tab":"technical"},{"enabled":true,"key":"all_metrics","label":"Every available metric","tab":"technical"},{"enabled":true,"key":"cta","label":"Contact Corefinity","tab":"both"}],"shared":false,"shared_at":null,"username":null},"run":{"error":null,"finished_at":null,"requested_at":"2026-11-03T12:30:00+00:00","started_at":null,"status":"queued"},"server_location":{"id":12,"name":"London"},"updated_at":"2026-11-03T12:30:00+00:00","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36"},"schema":{"$ref":"#/components/schemas/PerformanceAuditSummary"}}},"description":"The audit was created and its run is queued."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Your account cannot create audits","value":{"code":"forbidden","message":"Your account cannot create performance audits. Ask an owner of your company for access.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The token lacks the `write` scope (`scope_required`), or your account cannot create performance audits (`forbidden`)."},"409":{"content":{"application/json":{"examples":{"location_gone":{"summary":"The server location cannot run tests any more","value":{"code":"location_gone","message":"This audit's server location no longer exists. Choose another server location for the audit first.","reason":"location_gone"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The server location cannot run tests any more (`location_gone`). The audit was created, and no run was\nqueued: find it in the list, choose another server location for it, then start a run.\n"},"422":{"content":{"application/json":{"examples":{"missing":{"summary":"No environments","value":{"code":"invalid","errors":{"domains":["The domains field is required."]},"field":"domains","message":"The domains field is required.","reason":"invalid"}},"url":{"summary":"An address that is not http or https","value":{"code":"invalid","errors":{"domains.0.url":["The domains.0.url format is invalid."]},"field":"domains.0.url","message":"The domains.0.url format is invalid.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong. `field` names the first one."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"content":{"application/json":{"examples":{"temporarily_unavailable":{"summary":"Audits cannot run right now","value":{"code":"temporarily_unavailable","message":"Performance audits cannot run right now. Try again later.","reason":"temporarily_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Audits cannot run right now (`temporarily_unavailable`). Nothing was saved."}},"summary":"Create a performance audit","tags":["Performance audits"],"x-effect":["changes-settings"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-long-running":"getPerformanceAudit","x-rate-limit":{"bucket":"performance-audits-run","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/performance-audits/gtmetrix-locations":{"get":{"description":"Answers the locations GTmetrix can test from, for generating an audit's GTmetrix reports.\n","operationId":"listGtmetrixLocations","responses":{"200":{"content":{"application/json":{"example":{"items":[{"id":"2","name":"London, UK"},{"id":"7","name":"Sydney, Australia"}]},"schema":{"$ref":"#/components/schemas/GtmetrixLocations"}}},"description":"The locations."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Your account cannot use audits","value":{"code":"forbidden","message":"Your account cannot use performance audits. Ask an owner of your company for access.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The token lacks the `read` scope (`scope_required`), or your account cannot use performance audits (`forbidden`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"upstream_unavailable":{"summary":"GTmetrix did not answer","value":{"code":"upstream_unavailable","message":"GTmetrix could not list its locations: GTmetrix request failed (HTTP 500). Try again later.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"GTmetrix refused a request or did not answer (`upstream_unavailable`). Nothing was saved; try again later."},"503":{"content":{"application/json":{"examples":{"temporarily_unavailable":{"summary":"GTmetrix reports are not available","value":{"code":"temporarily_unavailable","message":"GTmetrix reports are not available right now. Try again later.","reason":"temporarily_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"GTmetrix reports are not available right now (`temporarily_unavailable`). Nothing was sent."}},"summary":"List GTmetrix test locations","tags":["Performance audits"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-rate-limit":{"bucket":"performance-audits-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/performance-audits/{audit}":{"parameters":[{"description":"The id of an audit. Digits only.","example":5210,"in":"path","name":"audit","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers the audit with its results, one cell for each environment, page and cache state, and its request log.\nThis is also how a run is followed: `run.status` is `queued`, `running`, `completed` or `failed`, and a run\nthat has not finished in time is ended as `failed`.\n","operationId":"getPerformanceAudit","responses":{"200":{"content":{"application/json":{"example":{"company_id":1204,"created_at":"2026-11-01T09:00:00+00:00","domains":[{"environment":"Current host","http_auth":false,"url":"https://old.harbourandfinch.example.org"},{"environment":"Corefinity","http_auth":true,"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"}],"id":5210,"log":"URL: https://old.harbourandfinch.example.org/ - Response code: 200 - TTFB: 612.40 ms - Total: 638.95 ms - Size: 48210 bytes - DNS 1.0 / connect 20.0 / TLS 60.0 ms - 192.0.2.1\n","name":"Before and after the move","number_of_requests":5,"page_types":[{"check_cache":true,"path":"/","title":"Home"},{"check_cache":false,"path":"/shop/","title":"Category"}],"report":{"frozen_at":null,"legacy_link_live":false,"password_protected":false,"revoked_at":null,"sections":[{"enabled":true,"key":"hero","label":"Headline","tab":"simple"},{"enabled":true,"key":"at_a_glance","label":"At a glance","tab":"simple"},{"enabled":true,"key":"response_times","label":"Response times","tab":"simple"},{"enabled":true,"key":"gap","label":"The gap, measurement by measurement","tab":"simple"},{"enabled":true,"key":"improvement","label":"Improvement per measurement","tab":"simple"},{"enabled":true,"key":"absolute_times","label":"Absolute times, side by side","tab":"simple"},{"enabled":true,"key":"waterfall","label":"Where the time actually goes","tab":"simple"},{"enabled":true,"key":"filmstrip","label":"Loading filmstrip","tab":"simple"},{"enabled":true,"key":"full_table","label":"The full table","tab":"simple"},{"enabled":true,"key":"google_scores","label":"Google scores","tab":"simple"},{"enabled":true,"key":"definitions","label":"Definitions","tab":"simple"},{"enabled":true,"key":"method","label":"Method","tab":"technical"},{"enabled":true,"key":"timing_breakdown","label":"Timing breakdown","tab":"technical"},{"enabled":true,"key":"samples","label":"Individual samples","tab":"technical"},{"enabled":true,"key":"status_codes","label":"Status codes and redirect chains","tab":"technical"},{"enabled":true,"key":"response_headers","label":"Response headers","tab":"technical"},{"enabled":true,"key":"raw_lighthouse_json","label":"Raw Lighthouse response","tab":"technical"},{"enabled":true,"key":"all_metrics","label":"Every available metric","tab":"technical"},{"enabled":true,"key":"cta","label":"Contact Corefinity","tab":"both"}],"shared":false,"shared_at":null,"username":null},"results":[{"active":true,"cache":"uncached","environment":"Current host","error":null,"http_code":200,"ipv4_requests":5,"ipv6_requests":0,"mean_ttfb_ms":612.4,"page":"Home","path":"/","ran":true,"server_response_ms":552.4,"timing_ms":{"dns":1,"tcp":19,"tls":40,"total":638.95,"transfer":26.55,"ttfb":552.4}},{"active":true,"cache":"cached","environment":"Current host","error":null,"http_code":200,"ipv4_requests":5,"ipv6_requests":0,"mean_ttfb_ms":188.2,"page":"Home","path":"/","ran":true,"server_response_ms":128.2,"timing_ms":{"dns":1,"tcp":19,"tls":40,"total":214.75,"transfer":26.55,"ttfb":128.2}},{"active":true,"cache":"uncached","environment":"Current host","error":null,"http_code":200,"ipv4_requests":5,"ipv6_requests":0,"mean_ttfb_ms":704.9,"page":"Category","path":"/shop/","ran":true,"server_response_ms":644.9,"timing_ms":{"dns":1,"tcp":19,"tls":40,"total":731.45,"transfer":26.55,"ttfb":644.9}},{"active":false,"cache":"cached","environment":"Current host","error":null,"http_code":null,"ipv4_requests":null,"ipv6_requests":null,"mean_ttfb_ms":null,"page":"Category","path":"/shop/","ran":false,"server_response_ms":null,"timing_ms":null},{"active":true,"cache":"uncached","environment":"Corefinity","error":null,"http_code":200,"ipv4_requests":5,"ipv6_requests":0,"mean_ttfb_ms":241.3,"page":"Home","path":"/","ran":true,"server_response_ms":181.3,"timing_ms":{"dns":1,"tcp":19,"tls":40,"total":267.85,"transfer":26.55,"ttfb":181.3}},{"active":true,"cache":"cached","environment":"Corefinity","error":null,"http_code":200,"ipv4_requests":5,"ipv6_requests":0,"mean_ttfb_ms":63.5,"page":"Home","path":"/","ran":true,"server_response_ms":3.5,"timing_ms":{"dns":1,"tcp":19,"tls":40,"total":90.05,"transfer":26.55,"ttfb":3.5}},{"active":true,"cache":"uncached","environment":"Corefinity","error":null,"http_code":200,"ipv4_requests":5,"ipv6_requests":0,"mean_ttfb_ms":286.75,"page":"Category","path":"/shop/","ran":true,"server_response_ms":226.75,"timing_ms":{"dns":1,"tcp":19,"tls":40,"total":313.3,"transfer":26.55,"ttfb":226.75}},{"active":false,"cache":"cached","environment":"Corefinity","error":null,"http_code":null,"ipv4_requests":null,"ipv6_requests":null,"mean_ttfb_ms":null,"page":"Category","path":"/shop/","ran":false,"server_response_ms":null,"timing_ms":null}],"run":{"error":null,"finished_at":"2026-11-03T12:35:00+00:00","requested_at":"2026-11-03T12:30:00+00:00","started_at":"2026-11-03T12:30:00+00:00","status":"completed"},"server_location":{"id":12,"name":"London"},"updated_at":"2026-11-03T12:35:00+00:00","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36"},"schema":{"$ref":"#/components/schemas/PerformanceAudit"}}},"description":"The audit."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a performance audit","tags":["Performance audits"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-rate-limit":{"bucket":"performance-audits-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"patch":{"description":"Changes the fields sent, as the audit's edit form does in the Control Panel, including the shared report's\nsections, username and password; the saved results stay until the audit runs again. Changing the protection,\nthe username or the password signs out everyone who unlocked the link before. Only the shared report's\nsettings can be changed while a run is queued or running.\n","operationId":"updatePerformanceAudit","requestBody":{"content":{"application/json":{"examples":{"report":{"summary":"Protect the shared report and hide one section","value":{"report_password":"made-up-report-password","report_password_protected":true,"report_sections":[{"enabled":false,"key":"definitions"}],"report_username":"client"}},"settings":{"summary":"Time each page ten times","value":{"name":"Before and after the move","number_of_requests":10}}},"schema":{"$ref":"#/components/schemas/PerformanceAuditUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"company_id":1204,"created_at":"2026-11-01T09:00:00+00:00","domains":[{"environment":"Current host","http_auth":false,"url":"https://old.harbourandfinch.example.org"},{"environment":"Corefinity","http_auth":true,"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"}],"id":5210,"name":"Before and after the move","number_of_requests":10,"page_types":[{"check_cache":true,"path":"/","title":"Home"},{"check_cache":false,"path":"/shop/","title":"Category"}],"report":{"frozen_at":null,"legacy_link_live":false,"password_protected":false,"revoked_at":null,"sections":[{"enabled":true,"key":"hero","label":"Headline","tab":"simple"},{"enabled":true,"key":"at_a_glance","label":"At a glance","tab":"simple"},{"enabled":true,"key":"response_times","label":"Response times","tab":"simple"},{"enabled":true,"key":"gap","label":"The gap, measurement by measurement","tab":"simple"},{"enabled":true,"key":"improvement","label":"Improvement per measurement","tab":"simple"},{"enabled":true,"key":"absolute_times","label":"Absolute times, side by side","tab":"simple"},{"enabled":true,"key":"waterfall","label":"Where the time actually goes","tab":"simple"},{"enabled":true,"key":"filmstrip","label":"Loading filmstrip","tab":"simple"},{"enabled":true,"key":"full_table","label":"The full table","tab":"simple"},{"enabled":true,"key":"google_scores","label":"Google scores","tab":"simple"},{"enabled":true,"key":"definitions","label":"Definitions","tab":"simple"},{"enabled":true,"key":"method","label":"Method","tab":"technical"},{"enabled":true,"key":"timing_breakdown","label":"Timing breakdown","tab":"technical"},{"enabled":true,"key":"samples","label":"Individual samples","tab":"technical"},{"enabled":true,"key":"status_codes","label":"Status codes and redirect chains","tab":"technical"},{"enabled":true,"key":"response_headers","label":"Response headers","tab":"technical"},{"enabled":true,"key":"raw_lighthouse_json","label":"Raw Lighthouse response","tab":"technical"},{"enabled":true,"key":"all_metrics","label":"Every available metric","tab":"technical"},{"enabled":true,"key":"cta","label":"Contact Corefinity","tab":"both"}],"shared":false,"shared_at":null,"username":null},"run":{"error":null,"finished_at":"2026-11-03T12:35:00+00:00","requested_at":"2026-11-03T12:30:00+00:00","started_at":"2026-11-03T12:30:00+00:00","status":"completed"},"server_location":{"id":12,"name":"London"},"updated_at":"2026-11-03T12:35:00+00:00","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36"},"schema":{"$ref":"#/components/schemas/PerformanceAuditSummary"}}},"description":"The audit, without its results."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"run_in_progress":{"summary":"A run is queued or running","value":{"code":"run_in_progress","message":"This audit is running. Wait for it to finish, then change or delete it.","reason":"run_in_progress"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"A run is queued or running and the request changes something the run reads: `name`, `domains`,\n`page_types`, `number_of_requests`, `user_agent` or `server_location` (`run_in_progress`). Nothing was\nchanged. A request that changes only the shared report's settings is not refused.\n"},"422":{"content":{"application/json":{"examples":{"report_username":{"summary":"Protection without a username","value":{"code":"invalid","errors":{"report_username":["Give the shared report a username to protect it with."]},"field":"report_username","message":"Give the shared report a username to protect it with.","reason":"invalid"}},"requests":{"summary":"More than 20 requests","value":{"code":"invalid","errors":{"number_of_requests":["The number of requests may not be greater than 20."]},"field":"number_of_requests","message":"The number of requests may not be greater than 20.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is wrong, or the shared report would be protected without a username or a password. `field` names the first one."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a performance audit","tags":["Performance audits"],"x-effect":["changes-settings"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-rate-limit":{"bucket":"performance-audits-run","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"},"delete":{"description":"Deletes an audit, its results and its share link for good: send the audit's name, typed exactly, as\n`confirm_name`. An audit cannot be deleted while a run is queued or running.\n","operationId":"deletePerformanceAudit","requestBody":{"content":{"application/json":{"examples":{"confirm":{"summary":"Delete the audit","value":{"confirm_name":"Before and after the move"}}},"schema":{"$ref":"#/components/schemas/PerformanceAuditConfirmName"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"deleted":true,"id":5210},"schema":{"properties":{"deleted":{"const":true,"type":"boolean"},"id":{"minimum":1,"type":"integer"}},"required":["id","deleted"],"type":"object"}}},"description":"The audit was deleted."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"run_in_progress":{"summary":"A run is queued or running","value":{"code":"run_in_progress","message":"This audit is running. Wait for it to finish, then change or delete it.","reason":"run_in_progress"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"A run is queued or running (`run_in_progress`)."},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"A name that is not the audit's","value":{"code":"confirm_mismatch","errors":{"confirm_name":["The name you typed does not match this audit's name. Nothing was deleted."]},"field":"confirm_name","message":"The name you typed does not match this audit's name. Nothing was deleted.","reason":"confirm_mismatch"}},"missing":{"summary":"No name","value":{"code":"invalid","errors":{"confirm_name":["The confirm name field is required."]},"field":"confirm_name","message":"The confirm name field is required.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"}]}}},"description":"`confirm_name` is missing (`invalid`) or is not the audit's name (`confirm_mismatch`). Nothing was deleted."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a performance audit","tags":["Performance audits"],"x-effect":["deletes"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-rate-limit":{"bucket":"performance-audits-run","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/performance-audits/{audit}/gtmetrix-reports":{"parameters":[{"description":"The id of an audit. Digits only.","example":5210,"in":"path","name":"audit","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers the audit's GTmetrix reports, environment by page, each read from GTmetrix as you ask; `generation` is\nthe last request to generate reports, which is how one is followed. Paged by cursor: send `next_cursor` back\nas `cursor`; null means the last page.\n","operationId":"listPerformanceAuditGtmetrixReports","parameters":[{"description":"Items a page: 1 to 10, default 5.","example":5,"in":"query","name":"limit","required":false,"schema":{"default":5,"maximum":10,"minimum":1,"type":"integer"}},{"description":"The `next_cursor` of the previous answer. Anything that is not a whole number is refused `422` on `cursor`.","in":"query","name":"cursor","required":false,"schema":{"pattern":"^(0|[1-9][0-9]{0,5})$","type":"string"}},{"description":"`1` adds each filmstrip image to a completed report, as a base64 JPEG. Only `0` and `1` are taken: the words `true` and `false` are refused `422` on `frames`.","in":"query","name":"frames","required":false,"schema":{"default":"0","enum":["0","1"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"generation":null,"items":[{"error":null,"filmstrip_timings_ms":[0,500],"metrics":{"cumulative_layout_shift":0.12345,"dom_content_loaded_time_ms":900,"first_contentful_paint_ms":800,"first_paint_time_ms":700,"fully_loaded_time_ms":2500,"gtmetrix_grade":"B","largest_contentful_paint_ms":1300,"performance_score":88,"speed_index_ms":1100,"structure_score":91,"time_to_first_byte_ms":100,"time_to_interactive_ms":1500,"total_blocking_time_ms":50},"name":"Current host Home","state":"completed","status":"completed","test_id":"Abc12Def"},{"error":null,"filmstrip_timings_ms":[],"metrics":null,"name":"Current host Category","state":"started","status":"pending","test_id":"Ghi34Jkl"},{"error":null,"filmstrip_timings_ms":[],"metrics":null,"name":"Corefinity Home","state":null,"status":"not_started","test_id":null},{"error":"The page could not be loaded.","filmstrip_timings_ms":[],"metrics":null,"name":"Corefinity Category","state":"error","status":"failed","test_id":"Mno56Pqr"}],"next_cursor":null},"schema":{"$ref":"#/components/schemas/GtmetrixReportList"}}},"description":"One page of reports."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"examples":{"cursor":{"summary":"A cursor the list did not give","value":{"code":"invalid","errors":{"cursor":["The cursor format is invalid."]},"field":"cursor","message":"The cursor format is invalid.","reason":"invalid"}},"frames":{"summary":"The word true where 1 is meant","value":{"code":"invalid","errors":{"frames":["The frames field must be true or false."]},"field":"frames","message":"The frames field must be true or false.","reason":"invalid"}},"limit":{"summary":"A limit above 10","value":{"code":"invalid","errors":{"limit":["The limit may not be greater than 10."]},"field":"limit","message":"The limit may not be greater than 10.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`limit`, `cursor` or `frames` is not valid. `field` names it."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"content":{"application/json":{"examples":{"temporarily_unavailable":{"summary":"GTmetrix reports are not available","value":{"code":"temporarily_unavailable","message":"GTmetrix reports are not available right now. Try again later.","reason":"temporarily_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"GTmetrix reports are not available right now (`temporarily_unavailable`). Nothing was sent."}},"summary":"List an audit's GTmetrix reports","tags":["Performance audits"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-rate-limit":{"bucket":"performance-audits-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"post":{"description":"Starts one GTmetrix test for each environment and page of the audit, in the background: read the audit's\nGTmetrix reports until `generation.status` is `completed` or `failed`. Each test uses GTmetrix credits, so\nsend the number it starts as `confirm_count`: any other number is refused with the right number in the\nmessage. When some tests were not started, the next generation at the same location starts only those.\n","operationId":"createPerformanceAuditGtmetrixReports","requestBody":{"content":{"application/json":{"examples":{"four_tests":{"summary":"Two environments and two pages, tested from London","value":{"confirm_count":4,"location_id":"2"}}},"schema":{"properties":{"confirm_count":{"description":"The number of tests this starts.","minimum":1,"type":"integer"},"location_id":{"description":"The `id` of one of GTmetrix's locations, as the GTmetrix locations list answers it.","maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9_-]{1,64}$","type":"string"}},"required":["location_id","confirm_count"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"audit_id":5210,"error":null,"failures":[],"finished_at":null,"id":"0d9c1a4e-6f1b-4f5e-9b8a-2d7c3e4f5a6b","location_id":"2","reports":[],"requested_at":"2026-11-03T12:30:00+00:00","resumed":false,"started":0,"status":"queued","tests":4},"schema":{"$ref":"#/components/schemas/GtmetrixGeneration"}}},"description":"The generation is queued."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"conflict":{"summary":"Two pairs with one report name","value":{"code":"conflict","message":"Two of this audit's environment and page pairs have the same report name, \"Shop Home Home\", and GTmetrix reports are kept by that name. Rename an environment or a page of the audit first. Nothing was started.","reason":"conflict"}},"nothing_to_run":{"summary":"No environments or pages","value":{"code":"nothing_to_run","message":"This audit has no domains or pages to report on. Add them to the audit first.","reason":"nothing_to_run"}},"run_in_progress":{"summary":"A generation is already running","value":{"code":"run_in_progress","message":"GTmetrix reports are already being started for this audit. Wait for them to finish, then generate again.","reason":"run_in_progress"}},"too_large":{"summary":"More than 200 pairs","value":{"code":"too_large","message":"This audit has 220 environment and page pairs. GTmetrix reports start at most 200 at once, as many as the audit form allows. Remove environments or pages from the audit first. Nothing was started.","reason":"too_large"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"A generation is already queued or running (`run_in_progress`), the audit has no environments or pages (`nothing_to_run`), it has more than 200 environment and page pairs (`too_large`), or two pairs have the same report name (`conflict`). Nothing was started."},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"A count that is not the number of tests","value":{"code":"confirm_mismatch","errors":{"confirm_count":["This starts 4 GTmetrix tests, one for each environment and page, and each uses GTmetrix credits. Send confirm_count 4 to go ahead. Nothing was started."]},"field":"confirm_count","message":"This starts 4 GTmetrix tests, one for each environment and page, and each uses GTmetrix credits. Send confirm_count 4 to go ahead. Nothing was started.","reason":"confirm_mismatch"}},"location":{"summary":"A location GTmetrix does not list","value":{"code":"invalid","errors":{"location_id":["Choose one of GTmetrix's locations (the GTmetrix locations list)."]},"field":"location_id","message":"Choose one of GTmetrix's locations (the GTmetrix locations list).","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"}]}}},"description":"`confirm_count` is not the number of tests (`confirm_mismatch`), or a field is missing or `location_id` is not one of GTmetrix's locations (`invalid`). Nothing was started."},"429":{"$ref":"#/components/responses/TooManyRequests"},"502":{"content":{"application/json":{"examples":{"upstream_unavailable":{"summary":"GTmetrix did not answer","value":{"code":"upstream_unavailable","message":"GTmetrix could not list its locations: GTmetrix request failed (HTTP 500). Try again later.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"GTmetrix refused a request or did not answer (`upstream_unavailable`). Nothing was saved; try again later."},"503":{"content":{"application/json":{"examples":{"temporarily_unavailable":{"summary":"GTmetrix reports are not available","value":{"code":"temporarily_unavailable","message":"GTmetrix reports are not available right now. Try again later.","reason":"temporarily_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"GTmetrix reports are not available right now (`temporarily_unavailable`). Nothing was sent."}},"summary":"Create GTmetrix reports","tags":["Performance audits"],"x-effect":["billable"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-long-running":"listPerformanceAuditGtmetrixReports","x-rate-limit":{"bucket":"performance-audits-run","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/performance-audits/{audit}/report":{"parameters":[{"description":"The id of an audit. Digits only.","example":5210,"in":"path","name":"audit","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers the report as the report preview of the Control Panel shows it: the comparison between your\nenvironments, each page's measurements and, when the audit has them, Google's scores and the Lighthouse\ncomparison. These are today's figures, not the frozen ones a shared link shows.\n","operationId":"getPerformanceAuditReport","responses":{"200":{"content":{"application/json":{"example":{"built_at":"2026-11-03T12:30:00+00:00","report":{"audit":{"company":"Harbour & Finch","created_at":"2026-11-01T09:00:00+00:00","id":5210,"name":"Before and after the move","requests_per_measurement":5,"run_at":"2026-11-03T12:30:00+00:00","server_location":"London","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36"},"baseline":{"environment":"Current host","host":"old.harbourandfinch.example.org","url":"https://old.harbourandfinch.example.org"},"built_at":"2026-11-03T12:30:00+00:00","comparisons":[{"environment":"Corefinity","excluded":[],"faster_on":2,"host":"harbourandfinch-example-com.northwind.cfstack.example.net","of":2,"summary":{"cached":{"baseline_avg_ms":188.2,"comparison_avg_ms":63.5,"diff_percent":66.3,"measurements":1,"saved_ms":124.7,"speed_multiplier":2.96},"overall":{"baseline_avg_ms":400.3,"comparison_avg_ms":152.4,"diff_percent":61.9,"measurements":2,"saved_ms":247.9,"speed_multiplier":2.63},"uncached":{"baseline_avg_ms":612.4,"comparison_avg_ms":241.3,"diff_percent":60.6,"measurements":1,"saved_ms":371.1,"speed_multiplier":2.54}},"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"}],"coverage":{"lighthouse":false,"redirect_chains":false,"response_headers":false,"samples":true,"stage_timings":true},"lighthouse":null,"lighthouse_failure":null,"lighthouse_state":"unavailable","metric":"ttfb","pages":[{"path":"/","states":{"cached":{"key":"cached","label":"Cached","measurements":{"Corefinity":{"cache_busted":false,"cache_miss":null,"comparable":true,"headers":null,"http_code":200,"invalid":null,"measured":true,"metric":"ttfb","ms":63.5,"redirect_chain":null,"redirect_not_followed":false,"runner_average_ms":null,"runner_format":"v2","runner_median_ms":null,"sample_count":1,"samples":[{"cache_busted":false,"http_code":200,"ms":63.5,"size_bytes":48210,"timing":{"dns":1,"tcp":19,"tls":40,"total":90.05,"transfer":26.55,"ttfb":3.5},"total_ms":90.05,"ttfb_ms":63.5,"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net/"}],"timing":{"dns":1,"tcp":19,"tls":40,"total":90.05,"transfer":26.55,"ttfb":3.5},"timing_scope":"single_request","url":"https://harbourandfinch-example-com.northwind.cfstack.example.net/","warm_ups":0},"Current host":{"cache_busted":false,"cache_miss":null,"comparable":true,"headers":null,"http_code":200,"invalid":null,"measured":true,"metric":"ttfb","ms":188.2,"redirect_chain":null,"redirect_not_followed":false,"runner_average_ms":null,"runner_format":"v2","runner_median_ms":null,"sample_count":1,"samples":[{"cache_busted":false,"http_code":200,"ms":188.2,"size_bytes":48210,"timing":{"dns":1,"tcp":19,"tls":40,"total":214.75,"transfer":26.55,"ttfb":128.2},"total_ms":214.75,"ttfb_ms":188.2,"url":"https://old.harbourandfinch.example.org/"}],"timing":{"dns":1,"tcp":19,"tls":40,"total":214.75,"transfer":26.55,"ttfb":128.2},"timing_scope":"single_request","url":"https://old.harbourandfinch.example.org/","warm_ups":0}},"requested":true},"uncached":{"key":"uncached","label":"Uncached","measurements":{"Corefinity":{"cache_busted":false,"cache_miss":null,"comparable":true,"headers":null,"http_code":200,"invalid":null,"measured":true,"metric":"ttfb","ms":241.3,"redirect_chain":null,"redirect_not_followed":false,"runner_average_ms":null,"runner_format":"v2","runner_median_ms":null,"sample_count":1,"samples":[{"cache_busted":false,"http_code":200,"ms":241.3,"size_bytes":48210,"timing":{"dns":1,"tcp":19,"tls":40,"total":267.85,"transfer":26.55,"ttfb":181.3},"total_ms":267.85,"ttfb_ms":241.3,"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net/"}],"timing":{"dns":1,"tcp":19,"tls":40,"total":267.85,"transfer":26.55,"ttfb":181.3},"timing_scope":"single_request","url":"https://harbourandfinch-example-com.northwind.cfstack.example.net/","warm_ups":0},"Current host":{"cache_busted":false,"cache_miss":null,"comparable":true,"headers":null,"http_code":200,"invalid":null,"measured":true,"metric":"ttfb","ms":612.4,"redirect_chain":null,"redirect_not_followed":false,"runner_average_ms":null,"runner_format":"v2","runner_median_ms":null,"sample_count":1,"samples":[{"cache_busted":false,"http_code":200,"ms":612.4,"size_bytes":48210,"timing":{"dns":1,"tcp":19,"tls":40,"total":638.95,"transfer":26.55,"ttfb":552.4},"total_ms":638.95,"ttfb_ms":612.4,"url":"https://old.harbourandfinch.example.org/"}],"timing":{"dns":1,"tcp":19,"tls":40,"total":638.95,"transfer":26.55,"ttfb":552.4},"timing_scope":"single_request","url":"https://old.harbourandfinch.example.org/","warm_ups":0}},"requested":true}},"title":"Home"}],"psi":null,"scale":{"max_ms":700,"observed_max_ms":612.4},"schema_version":2},"sections":{"contact":true,"simple":["hero","at_a_glance","response_times","gap","improvement","absolute_times","waterfall","full_table","definitions"],"technical":["method","timing_breakdown","samples","all_metrics"]}},"schema":{"$ref":"#/components/schemas/PerformanceAuditReport"}}},"description":"The report."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an audit's report","tags":["Performance audits"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-rate-limit":{"bucket":"performance-audits-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/performance-audits/{audit}/report/refresh":{"parameters":[{"description":"The id of an audit. Digits only.","example":5210,"in":"path","name":"audit","required":true,"schema":{"minimum":1,"type":"integer"}}],"post":{"description":"Rebuilds the figures the shared link shows from the audit's current results: everyone holding the link sees\nthe new figures at once and the earlier ones are gone, so send the audit's name, typed exactly, as\n`confirm_name`. Google's scores and the Lighthouse comparison follow a few minutes later when the audit has\nnone for its sites yet.\n","operationId":"refreshPerformanceAuditReport","requestBody":{"content":{"application/json":{"examples":{"confirm":{"summary":"Publish the current figures","value":{"confirm_name":"Before and after the move"}}},"schema":{"$ref":"#/components/schemas/PerformanceAuditConfirmName"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"frozen_at":"2026-11-03T12:35:00+00:00"},"schema":{"properties":{"frozen_at":{"description":"When the figures the link shows were built.","format":"date-time","type":["string","null"]}},"required":["frozen_at"],"type":"object"}}},"description":"The shared report shows the current figures."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"not_shared":{"summary":"The audit is not shared","value":{"code":"not_shared","message":"This audit has no live share link. Share it first.","reason":"not_shared"}},"run_in_progress":{"summary":"A run is queued or running","value":{"code":"run_in_progress","message":"This audit is running. Wait for it to finish, then refresh its shared report.","reason":"run_in_progress"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The audit has no working report link (`not_shared`), or a run is still writing its results (`run_in_progress`)."},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"A name that is not the audit's","value":{"code":"confirm_mismatch","errors":{"confirm_name":["The name you typed does not match this audit's name. The shared report was not changed."]},"field":"confirm_name","message":"The name you typed does not match this audit's name. The shared report was not changed.","reason":"confirm_mismatch"}},"missing":{"summary":"No name","value":{"code":"invalid","errors":{"confirm_name":["The confirm name field is required."]},"field":"confirm_name","message":"The confirm name field is required.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"}]}}},"description":"`confirm_name` is missing (`invalid`) or is not the audit's name (`confirm_mismatch`). The shared report was not changed."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Refresh an audit's shared report","tags":["Performance audits"],"x-effect":["overwrites"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-rate-limit":{"bucket":"performance-audits-run","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/performance-audits/{audit}/run":{"parameters":[{"description":"The id of an audit. Digits only.","example":5210,"in":"path","name":"audit","required":true,"schema":{"minimum":1,"type":"integer"}}],"post":{"description":"Runs every page of the audit again with its saved settings, as Refresh All does in the Control Panel. One run at a time: read the audit until `run.status` is `completed` or `failed`.\n","operationId":"startPerformanceAuditRun","responses":{"202":{"content":{"application/json":{"example":{"company_id":1204,"created_at":"2026-11-01T09:00:00+00:00","domains":[{"environment":"Current host","http_auth":false,"url":"https://old.harbourandfinch.example.org"},{"environment":"Corefinity","http_auth":true,"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"}],"id":5210,"name":"Before and after the move","number_of_requests":5,"page_types":[{"check_cache":true,"path":"/","title":"Home"},{"check_cache":false,"path":"/shop/","title":"Category"}],"report":{"frozen_at":null,"legacy_link_live":false,"password_protected":false,"revoked_at":null,"sections":[{"enabled":true,"key":"hero","label":"Headline","tab":"simple"},{"enabled":true,"key":"at_a_glance","label":"At a glance","tab":"simple"},{"enabled":true,"key":"response_times","label":"Response times","tab":"simple"},{"enabled":true,"key":"gap","label":"The gap, measurement by measurement","tab":"simple"},{"enabled":true,"key":"improvement","label":"Improvement per measurement","tab":"simple"},{"enabled":true,"key":"absolute_times","label":"Absolute times, side by side","tab":"simple"},{"enabled":true,"key":"waterfall","label":"Where the time actually goes","tab":"simple"},{"enabled":true,"key":"filmstrip","label":"Loading filmstrip","tab":"simple"},{"enabled":true,"key":"full_table","label":"The full table","tab":"simple"},{"enabled":true,"key":"google_scores","label":"Google scores","tab":"simple"},{"enabled":true,"key":"definitions","label":"Definitions","tab":"simple"},{"enabled":true,"key":"method","label":"Method","tab":"technical"},{"enabled":true,"key":"timing_breakdown","label":"Timing breakdown","tab":"technical"},{"enabled":true,"key":"samples","label":"Individual samples","tab":"technical"},{"enabled":true,"key":"status_codes","label":"Status codes and redirect chains","tab":"technical"},{"enabled":true,"key":"response_headers","label":"Response headers","tab":"technical"},{"enabled":true,"key":"raw_lighthouse_json","label":"Raw Lighthouse response","tab":"technical"},{"enabled":true,"key":"all_metrics","label":"Every available metric","tab":"technical"},{"enabled":true,"key":"cta","label":"Contact Corefinity","tab":"both"}],"shared":false,"shared_at":null,"username":null},"run":{"error":null,"finished_at":null,"requested_at":"2026-11-03T12:30:00+00:00","started_at":null,"status":"queued"},"server_location":{"id":12,"name":"London"},"updated_at":"2026-11-03T12:35:00+00:00","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36"},"schema":{"$ref":"#/components/schemas/PerformanceAuditSummary"}}},"description":"The run is queued."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"location_gone":{"summary":"The server location no longer exists","value":{"code":"location_gone","message":"This audit's server location no longer exists. Choose another server location for the audit first.","reason":"location_gone"}},"nothing_to_run":{"summary":"No environments or pages","value":{"code":"nothing_to_run","message":"This audit has no domains or pages to test. Add them to the audit first.","reason":"nothing_to_run"}},"run_in_progress":{"summary":"A run is already queued or running","value":{"code":"run_in_progress","message":"This audit is already running. Wait for it to finish, then run it again.","reason":"run_in_progress"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"A run is already queued or running (`run_in_progress`), the audit has no environments or pages (`nothing_to_run`), or its server location no longer exists (`location_gone`)."},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"content":{"application/json":{"examples":{"temporarily_unavailable":{"summary":"Audits cannot run right now","value":{"code":"temporarily_unavailable","message":"Performance audits cannot run right now. Try again later.","reason":"temporarily_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Audits cannot run right now (`temporarily_unavailable`). Nothing was queued."}},"summary":"Start a performance audit run","tags":["Performance audits"],"x-effect":["changes-settings"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-long-running":"getPerformanceAudit","x-rate-limit":{"bucket":"performance-audits-run","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/performance-audits/{audit}/share-link":{"parameters":[{"description":"The id of an audit. Digits only.","example":5210,"in":"path","name":"audit","required":true,"schema":{"minimum":1,"type":"integer"}}],"post":{"description":"Shares the audit's report and answers its link, which anyone who has it can read, after the username and\npassword when the audit sets them. An audit has one link, and its figures are frozen when the audit is first\nshared: running the audit again does not change them until you refresh the shared report.\n","operationId":"createPerformanceAuditShareLink","responses":{"200":{"content":{"application/json":{"example":{"shared_at":"2026-11-03T12:30:00+00:00","url":"https://manage.corefinity.com/audits/5210/report/ExampleShareLinkTokenNotARealOne1"},"schema":{"$ref":"#/components/schemas/PerformanceAuditShareLink"}}},"description":"The link."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"run_in_progress":{"summary":"A run is queued or running","value":{"code":"run_in_progress","message":"This audit is running. Wait for it to finish, then share it.","reason":"run_in_progress"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The audit is shared for the first time while a run is still writing its results (`run_in_progress`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create an audit's share link","tags":["Performance audits"],"x-effect":["changes-settings","reveals-secret"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-rate-limit":{"bucket":"performance-audits-run","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"},"delete":{"description":"Takes the report's link out of service: it answers not found until the audit is shared again, which opens the same link again and asks everyone for the password again. Revoking an audit that is not shared changes nothing and is not refused.\n","operationId":"deletePerformanceAuditShareLink","responses":{"200":{"content":{"application/json":{"example":{"revoked_at":"2026-11-03T12:35:00+00:00"},"schema":{"properties":{"revoked_at":{"format":"date-time","type":["string","null"]}},"required":["revoked_at"],"type":"object"}}},"description":"The link is revoked. `revoked_at` is when it was revoked, and null for an audit that was never shared."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete an audit's share link","tags":["Performance audits"],"x-effect":["changes-settings"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-rate-limit":{"bucket":"performance-audits-run","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/performance-audits/{audit}/share-link/regenerate":{"parameters":[{"description":"The id of an audit. Digits only.","example":5210,"in":"path","name":"audit","required":true,"schema":{"minimum":1,"type":"integer"}}],"post":{"description":"Gives the report a new link. The current link, and a link made before the report existed, stop working for good, so send the audit's name, typed exactly, as `confirm_name`.\n","operationId":"regeneratePerformanceAuditShareLink","requestBody":{"content":{"application/json":{"examples":{"confirm":{"summary":"Give the report a new link","value":{"confirm_name":"Before and after the move"}}},"schema":{"$ref":"#/components/schemas/PerformanceAuditConfirmName"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"shared_at":"2026-11-03T12:35:00+00:00","url":"https://manage.corefinity.com/audits/5210/report/ExampleShareLinkTokenNotARealOne2"},"schema":{"$ref":"#/components/schemas/PerformanceAuditShareLink"}}},"description":"The new link."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"run_in_progress":{"summary":"A run is queued or running","value":{"code":"run_in_progress","message":"This audit is running. Wait for it to finish, then regenerate its link.","reason":"run_in_progress"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The audit has never been shared and a run is still writing its results (`run_in_progress`)."},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"A name that is not the audit's","value":{"code":"confirm_mismatch","errors":{"confirm_name":["The name you typed does not match this audit's name. The link was not changed."]},"field":"confirm_name","message":"The name you typed does not match this audit's name. The link was not changed.","reason":"confirm_mismatch"}},"missing":{"summary":"No name","value":{"code":"invalid","errors":{"confirm_name":["The confirm name field is required."]},"field":"confirm_name","message":"The confirm name field is required.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"$ref":"#/components/schemas/InvalidRefusal"}]}}},"description":"`confirm_name` is missing (`invalid`) or is not the audit's name (`confirm_mismatch`). The link was not changed."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Regenerate an audit's share link","tags":["Performance audits"],"x-effect":["changes-settings","deletes","reveals-secret"],"x-feature":"performance-audits","x-file":"performance-audits","x-gates":[],"x-rate-limit":{"bucket":"performance-audits-run","limit":10,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/permissions":{"get":{"description":"Answers the permissions your roles give you, as slugs. A custom role you create or update may give only these.\n","operationId":"listOwnPermissions","responses":{"200":{"content":{"application/json":{"example":{"data":["viewUsers","inviteUsers","editUsers","viewWebsites","viewTickets"],"message":"All permissions for Eleanor Finch was loaded.","status":"success"},"schema":{"$ref":"#/components/schemas/TeamPermissionsAnswer"}}},"description":"Your permissions. The message carries your name."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your permissions","tags":["Team"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/roles":{"get":{"description":"Answers the roles you may give somebody in your own company. `data` is a list with one item: an object whose\nkeys are role slugs and whose values are role names. For each role's permissions, use `GET /team/roles`.\n","operationId":"listAssignableRoles","responses":{"200":{"content":{"application/json":{"example":{"data":[{"client-member-full":"Member (Full Access)","client-member-limited":"Member (Limited Access)","client-owner":"Owner","release-managers-0b9c7a52-3f7e-4c1d-9a55-2f6f1f0e8d11":"Release managers"}],"message":"all roles allowed loaded successfully","status":"success"},"schema":{"$ref":"#/components/schemas/TeamAssignableRolesAnswer"}}},"description":"The roles you may give, slug to name."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List the roles you may give","tags":["Team"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/roles/attach":{"post":{"description":"Adds a role to a member, beside the roles they already hold. You can give only a role whose permissions you\nhold yourself; an owner is exempt for standard roles.\n","operationId":"attachRoleToUser","requestBody":{"content":{"application/json":{"examples":{"attach":{"summary":"Add the limited member role","value":{"role":"client-member-limited","user_id":2042}}},"schema":{"$ref":"#/components/schemas/TeamRoleMembershipRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"company_id":"1204","email":"tom.harbour@harbourandfinch.example.com","id":"2042","mobile":null,"name":"Tom Harbour","role":[{"name":"Member (Full Access)","permissions":["viewWebsites","viewDeployments","viewTickets","createTickets"],"slug":"client-member-full"},{"name":"Member (Limited Access)","permissions":["viewWebsites","viewTickets","createTickets"],"slug":"client-member-limited"}]},"message":"User attached to role.","status":"success"},"schema":{"$ref":"#/components/schemas/TeamUserAnswer"}}},"description":"The member with their roles as they are now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"You may not attach roles","value":{"code":"forbidden","message":"You are not allowed to attach roles.","reason":"forbidden","status":"error"}},"owner_grant":{"summary":"Making somebody an owner","value":{"code":"owner_grant","message":"Only an owner or Corefinity staff can make someone an owner.","reason":"owner_grant","status":"error"}},"permission_grant":{"summary":"The role carries a permission you do not hold","value":{"code":"permission_grant","message":"You can only give someone a role if you hold all of its permissions yourself.","reason":"permission_grant","status":"error"}},"privileged_target":{"summary":"The account is not yours to change","value":{"code":"privileged_target","message":"You are not allowed to change this account.","reason":"privileged_target","status":"error"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/TeamRefusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), you may not attach roles (`forbidden`), the account\nis not yours to change (`privileged_target`), only an owner or Corefinity staff can make somebody an owner\n(`owner_grant`), or the role carries a permission you do not hold (`permission_grant`).\n"},"422":{"content":{"application/json":{"examples":{"already_held":{"summary":"The person already holds the role","value":{"code":"invalid","errors":{"user":["This user is already attached to this role."]},"field":"user","message":"This user is already attached to this role.","reason":"invalid"}},"user_id":{"summary":"Nobody you can see has this id","value":{"code":"invalid","errors":{"user_id":["The user id field must be a valid user id."]},"field":"user_id","message":"The user id field must be a valid user id.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`). `user_id` is refused for a person you cannot see as for an id that\ndoes not exist. A role that cannot be given to this person is refused on `message`, and a role the person\nalready holds on `user`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Give a team member a role","tags":["Team"],"x-effect":["changes-settings"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/roles/create":{"post":{"description":"Makes a custom role for your company. It may give only permissions you hold yourself, which\n`GET /permissions` lists. The role's `slug` is made from its name and a unique suffix.\n","operationId":"createCustomRole","requestBody":{"content":{"application/json":{"examples":{"create":{"summary":"A role that reads users","value":{"name":"Release managers","permissions":["viewUsers"]}}},"schema":{"$ref":"#/components/schemas/TeamRoleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"id":3107,"name":"Release managers","permissions":["viewUsers"],"slug":"release-managers-0b9c7a52-3f7e-4c1d-9a55-2f6f1f0e8d11"},"message":"Role was created.","status":"success"},"schema":{"$ref":"#/components/schemas/TeamRoleAnswer"}}},"description":"The role that was made."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"You may not create roles","value":{"code":"forbidden","message":"You are not allowed to create roles.","reason":"forbidden","status":"error"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/TeamRefusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), or you may not create roles (`forbidden`)."},"422":{"content":{"application/json":{"examples":{"not_a_permission":{"summary":"A name that is not a permission","value":{"code":"invalid","errors":{"permissions":["readEverything is not a permission."]},"field":"permissions","message":"readEverything is not a permission.","reason":"invalid"}},"not_held":{"summary":"A permission you do not hold","value":{"code":"invalid","errors":{"permissions":["You are not allowed to add deleteUsers permission."]},"field":"permissions","message":"You are not allowed to add deleteUsers permission.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`). On `permissions`: a name that is not a permission, a permission\nyou do not hold yourself, or one that only Corefinity's own roles may hold.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a custom role","tags":["Team"],"x-effect":["changes-settings"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/roles/detach":{"post":{"description":"Removes one role from a member. The other roles they hold stay.","operationId":"detachRoleFromUser","requestBody":{"content":{"application/json":{"examples":{"detach":{"summary":"Take the limited member role away","value":{"role":"client-member-limited","user_id":2042}}},"schema":{"$ref":"#/components/schemas/TeamRoleMembershipRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"company_id":"1204","email":"tom.harbour@harbourandfinch.example.com","id":"2042","mobile":null,"name":"Tom Harbour","role":[{"name":"Member (Full Access)","permissions":["viewWebsites","viewDeployments","viewTickets","createTickets"],"slug":"client-member-full"}]},"message":"User detached from role.","status":"success"},"schema":{"$ref":"#/components/schemas/TeamUserAnswer"}}},"description":"The member with their roles as they are now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"You may not detach roles","value":{"code":"forbidden","message":"You are not allowed to detach roles.","reason":"forbidden","status":"error"}},"privileged_target":{"summary":"The account is not yours to change","value":{"code":"privileged_target","message":"You are not allowed to change this account.","reason":"privileged_target","status":"error"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/TeamRefusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), you may not detach roles (`forbidden`), or the\naccount is not yours to change (`privileged_target`).\n"},"422":{"content":{"application/json":{"examples":{"last_owner":{"summary":"The company would have no owner","value":{"code":"invalid","errors":{"roles":["There must be at least one owner for the company."]},"field":"roles","message":"There must be at least one owner for the company.","reason":"invalid"}},"not_held":{"summary":"The person does not hold the role","value":{"code":"invalid","errors":{"user":["This user is not attached to this role."]},"field":"user","message":"This user is not attached to this role.","reason":"invalid"}},"role":{"summary":"The role does not exist","value":{"code":"invalid","errors":{"role":["The role field must be a valid role slug."]},"field":"role","message":"The role field must be a valid role slug.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`). `user_id` is refused for a person you cannot see as for an id that\ndoes not exist. A role you may not take from this person is refused on `role`, a role the person does\nnot hold on `user`, and the owner role of the company's only owner on `roles`.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Take a role from a team member","tags":["Team"],"x-effect":["changes-settings"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/roles/{id}/delete":{"parameters":[{"$ref":"#/components/parameters/TeamRoleId"}],"delete":{"description":"Deletes a custom role of your company. A role somebody still holds is refused: give those people another role\nfirst.\n","operationId":"deleteCustomRole","responses":{"200":{"content":{"application/json":{"example":{"message":"Role deleted.","status":"success"},"schema":{"$ref":"#/components/schemas/LegacyEnvelope"}}},"description":"The role was deleted."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"You may not delete roles","value":{"code":"forbidden","message":"You are not allowed to delete roles.","reason":"forbidden","status":"error"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/TeamRefusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), or you may not delete roles (`forbidden`)."},"404":{"$ref":"#/components/responses/NotFound","description":"No custom role of your company has this id. A standard role and another company's role answer the same."},"409":{"content":{"application/json":{"example":{"code":"in_use","message":"This custom role has users assigned to it. Please reassign them before deleting the role.","reason":"in_use","status":"error"},"schema":{"$ref":"#/components/schemas/TeamRefusal"}}},"description":"Somebody still holds the role (`in_use`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a custom role","tags":["Team"],"x-effect":["deletes"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/roles/{id}/update":{"parameters":[{"$ref":"#/components/parameters/TeamRoleId"}],"post":{"description":"Renames a custom role of your company and replaces its permissions with the list you send. Everybody who holds\nthe role gets the new set. Standard roles cannot be changed.\n","operationId":"updateCustomRole","requestBody":{"content":{"application/json":{"examples":{"update":{"summary":"Rename the role and set its permissions","value":{"name":"Release leads","permissions":["viewUsers","viewWebsites"]}}},"schema":{"$ref":"#/components/schemas/TeamRoleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"id":3107,"name":"Release leads","permissions":["viewUsers","viewWebsites"],"slug":"release-managers-0b9c7a52-3f7e-4c1d-9a55-2f6f1f0e8d11"},"message":"Role updated.","status":"success"},"schema":{"$ref":"#/components/schemas/TeamRoleAnswer"}}},"description":"The role as saved."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"You may not update roles","value":{"code":"forbidden","message":"You are not allowed to update roles.","reason":"forbidden","status":"error"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/TeamRefusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), or you may not update roles (`forbidden`)."},"404":{"$ref":"#/components/responses/NotFound","description":"No custom role of your company has this id. A standard role and another company's role answer the same."},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"permissions":["The permissions field is required."]},"field":"permissions","message":"The permissions field is required.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`). On `permissions`: a name that is not a permission, a permission\nyou do not hold yourself, or one that only Corefinity's own roles may hold.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a custom role","tags":["Team"],"x-effect":["changes-settings"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/ssh/changes/{change}":{"parameters":[{"$ref":"#/components/parameters/sshChange"}],"get":{"description":"Answers how far a change to keys has been applied. Read it again until `state` is `applied` or `failed`. You\ncan read a change you started, or one that goes to an environment you can reach.\n","operationId":"getSshChange","responses":{"200":{"content":{"application/json":{"examples":{"applying":{"summary":"Still being applied","value":{"applied":1,"failed":[],"id":48211,"not_on_new_system":0,"state":"applying","total":3,"waiting":1}},"failed":{"summary":"Failed on one environment","value":{"applied":2,"failed":[{"environment_id":1312,"reason":"The environment did not confirm the change in time."}],"id":48212,"not_on_new_system":0,"state":"failed","total":3,"waiting":0}}},"schema":{"$ref":"#/components/schemas/SshChange"}}},"description":"The change."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/SshNotFound"},"422":{"content":{"application/json":{"examples":{"ssh_environment_unmanaged":{"summary":"A removal waiting for a check by Corefinity","value":{"code":"ssh_environment_unmanaged","field":null,"message":"SSH removal requires staff verification of an earlier delivery.","reason":"ssh_environment_unmanaged"}}},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"The change is a removal that Corefinity must check before it can be reported\n(`ssh_environment_unmanaged`). Contact support.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get an SSH change","tags":["SSH keys"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-rate-limit":{"bucket":"ssh-api-changes","limit":240,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/ssh/keys":{"post":{"description":"Adds a public key at one level: a company or a website (for all or for selected environments), one\nenvironment, or yourself. A personal key logs in with your own username; every other key logs in as `web`.\nAdding a company key needs the Create Company SSH Keys permission.\n","operationId":"createSshKey","requestBody":{"content":{"application/json":{"examples":{"company_selected":{"summary":"A company key for selected environments","value":{"applies_to":{"environment_ids":[1311],"mode":"selected"},"name":"Build server","owner":{"id":1204,"type":"company"},"public_key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAAAExampleKeyOnlyDoNotUseThisIsNotARealKey2"}},"environment":{"summary":"A key for one environment","value":{"name":"Deployment service","owner":{"id":1311,"type":"environment"},"public_key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAAAExampleKeyOnlyDoNotUseThisIsNotARealKey4"}},"personal":{"summary":"Your own key","value":{"name":"Eleanor's laptop","owner":{"id":2041,"type":"user"},"public_key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAAAExampleKeyOnlyDoNotUseThisIsNotARealKey1 eleanor@laptop"}}},"schema":{"$ref":"#/components/schemas/SshKeyCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"added":{"$ref":"#/components/examples/SshKeyAddedExample"}},"schema":{"$ref":"#/components/schemas/SshKeySaved"}}},"description":"The key was added. Follow `change_id` with `GET /ssh/changes/{change}` to see it applied."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SshWriteForbidden"},"404":{"$ref":"#/components/responses/SshNotFound"},"409":{"content":{"application/json":{"examples":{"ssh_key_duplicate":{"summary":"The key is already held here","value":{"code":"ssh_key_duplicate","field":"public_key","message":"That key is already added here.","reason":"ssh_key_duplicate"}},"ssh_managed_on_another_environment":{"$ref":"#/components/examples/SshManagedOnAnotherExample"}},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"The key is already held at this owner (`ssh_key_duplicate`), or the environment shares a server with\nanother environment that manages its keys (`ssh_managed_on_another_environment`; `managed_on` names it).\n"},"422":{"content":{"application/json":{"examples":{"invalid_arguments":{"summary":"A field that is not part of the request","value":{"code":"invalid_arguments","errors":{"comment":["comment is not part of this request."]},"field":"comment","message":"comment is not part of this request.","reason":"invalid_arguments"}},"ssh_cap_exceeded":{"summary":"The owner holds its limit of keys","value":{"code":"ssh_cap_exceeded","field":"owner","message":"At most 200 keys here.","reason":"ssh_cap_exceeded"}},"ssh_key_invalid":{"summary":"Not a public key","value":{"code":"ssh_key_invalid","field":"public_key","message":"Paste the public key in OpenSSH format (one line starting with ssh-ed25519, ecdsa-sha2-nistp256/384/521 or ssh-rsa)","reason":"ssh_key_invalid"}},"ssh_key_too_long":{"summary":"More than 16,384 bytes","value":{"code":"ssh_key_invalid","field":"public_key","message":"That is too long to be a public key","reason":"ssh_key_invalid"}},"ssh_key_weak":{"summary":"A weak key","value":{"code":"ssh_key_weak","field":"public_key","message":"RSA keys must be at least 3072 bits","reason":"ssh_key_weak"}}},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"The request was refused. `reason` says why:\n\n- `invalid_arguments`: a field is missing, wrong or not part of the request; `field` names it.\n- `ssh_key_invalid`: `public_key` is not one OpenSSH public key of a type that is accepted, or is longer\n  than 16,384 bytes.\n- `ssh_private_key_refused`: a private key was sent. It was not stored.\n- `ssh_key_weak`: a DSA key, or an RSA key under 3072 bits; the message says which.\n- `ssh_key_type_unsupported`: a security key (`sk-` types), or a key of an algorithm that cannot be used\n  for SSH.\n- `ssh_options_refused`: the line carries options in front of the key type.\n- `ssh_staff_key_refused`: the key is on Corefinity's list of staff and system keys.\n- `ssh_cap_exceeded`: the owner holds its limit of keys, or an environment the key reaches cannot take\n  another (`environment` names it).\n- `ssh_login_unavailable`, `ssh_uid_range_exhausted`: a personal key needs a username, and one cannot be\n  issued for your account yet.\n"},"429":{"$ref":"#/components/responses/SshTooManyWrites"}},"summary":"Create an SSH key","tags":["SSH keys"],"x-effect":["changes-settings"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-long-running":"getSshChange","x-rate-limit":{"also":[{"bucket":"ssh-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"ssh-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/ssh/keys/{key}":{"parameters":[{"$ref":"#/components/parameters/sshKey"}],"patch":{"description":"Renames a key, or changes the environments a company or website key applies to. A change that can take an\nenvironment away from the key (any move to `selected` from `all`, or a shorter selection) must also send the\nkey's fingerprint in `confirm_fingerprint`. Changing a company key needs the Edit Company SSH Keys permission.\n","operationId":"updateSshKey","requestBody":{"content":{"application/json":{"examples":{"narrow":{"summary":"Limit the key to one environment","value":{"applies_to":{"environment_ids":[1311],"mode":"selected"},"confirm_fingerprint":"SHA256:o6poLLVqPDVYtxLTdagh8mUo96coeRXfX7Uxorxr158"}},"rename":{"summary":"Rename the key","value":{"name":"Office workstation (reception)"}}},"schema":{"$ref":"#/components/schemas/SshKeyUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"renamed":{"$ref":"#/components/examples/SshKeyRenamedExample"}},"schema":{"$ref":"#/components/schemas/SshKeySaved"}}},"description":"The key as it is now. `change_id` is null when nothing needs applying, as after a rename."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SshWriteForbidden"},"404":{"$ref":"#/components/responses/SshNotFound"},"409":{"content":{"application/json":{"examples":{"ssh_managed_on_another_environment":{"$ref":"#/components/examples/SshManagedOnAnotherExample"}},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"The key's environment shares a server with another environment that manages its keys\n(`ssh_managed_on_another_environment`; `managed_on` names it).\n"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"The fingerprint is not the key's","value":{"code":"confirm_mismatch","errors":{"confirm_fingerprint":["The fingerprint you typed is not this key's."]},"field":"confirm_fingerprint","message":"The fingerprint you typed is not this key's.","reason":"confirm_mismatch"}},"invalid_arguments":{"summary":"Nothing to change","value":{"code":"invalid_arguments","errors":{"name":["Change the name or applies_to."]},"field":"name","message":"Change the name or applies_to.","reason":"invalid_arguments"}},"ssh_key_invalid":{"summary":"A key set aside as not valid","value":{"code":"ssh_key_invalid","field":null,"message":"This key is quarantined; remove it and add a valid key.","reason":"ssh_key_invalid"}}},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"The request was refused. `reason` says why: `invalid_arguments` (a field is wrong, nothing was sent to\nchange, `applies_to` was sent for an environment or personal key, or a narrowing came without\n`confirm_fingerprint`; `field` names it), `confirm_mismatch` (`confirm_fingerprint` was sent and is not\nthe key's fingerprint, whatever the change), `ssh_cap_exceeded` (an environment the key would now reach\ncannot take another key) or `ssh_key_invalid` (the key is set aside as not valid and can only be removed).\n"},"429":{"$ref":"#/components/responses/SshTooManyWrites"}},"summary":"Update an SSH key","tags":["SSH keys"],"x-effect":["changes-settings"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-long-running":"getSshChange","x-rate-limit":{"also":[{"bucket":"ssh-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"ssh-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"},"delete":{"description":"Removes a key, a Legacy key included, from its owner. Send the key's fingerprint in `confirm_fingerprint`, in\nthe request body; the key stops working on every environment it reached through this owner, and\n`remaining_sources` lists the places the same key is still held. Removing a company key needs the Delete or\nthe Edit Company SSH Keys permission.\n","operationId":"deleteSshKey","requestBody":{"content":{"application/json":{"examples":{"remove":{"summary":"Remove the key","value":{"confirm_fingerprint":"SHA256:o6poLLVqPDVYtxLTdagh8mUo96coeRXfX7Uxorxr158"}}},"schema":{"$ref":"#/components/schemas/SshKeyRemoveRequest"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"removed":{"summary":"The key is held nowhere else","value":{"change_id":48215,"remaining_sources":[]}},"still_allowed":{"summary":"The same key is still held at the company","value":{"change_id":48216,"remaining_sources":[{"environments":2,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"}}]}}},"schema":{"$ref":"#/components/schemas/SshKeyRemoved"}}},"description":"The removal was started. Follow `change_id` with `GET /ssh/changes/{change}`."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SshWriteForbidden"},"404":{"$ref":"#/components/responses/SshNotFound"},"409":{"content":{"application/json":{"examples":{"ssh_managed_on_another_environment":{"$ref":"#/components/examples/SshManagedOnAnotherExample"}},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"The key's environment shares a server with another environment that manages its keys\n(`ssh_managed_on_another_environment`; `managed_on` names it).\n"},"422":{"content":{"application/json":{"examples":{"confirm_mismatch":{"summary":"The fingerprint is not the key's","value":{"code":"confirm_mismatch","errors":{"confirm_fingerprint":["The fingerprint you typed is not this key's."]},"field":"confirm_fingerprint","message":"The fingerprint you typed is not this key's.","reason":"confirm_mismatch"}},"invalid_arguments":{"summary":"No fingerprint was sent","value":{"code":"invalid_arguments","errors":{"confirm_fingerprint":["Type the key's fingerprint (SHA256:…) to confirm."]},"field":"confirm_fingerprint","message":"Type the key's fingerprint (SHA256:…) to confirm.","reason":"invalid_arguments"}}},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"The request was refused. `reason` says why: `invalid_arguments` (`confirm_fingerprint` is missing, or a\nfield is not part of the request; `field` names it) or `confirm_mismatch` (`confirm_fingerprint` is not\nthe key's fingerprint).\n"},"429":{"$ref":"#/components/responses/SshTooManyWrites"}},"summary":"Delete an SSH key","tags":["SSH keys"],"x-effect":["deletes"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-long-running":"getSshChange","x-rate-limit":{"also":[{"bucket":"ssh-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"ssh-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/ssh/keys/{key}/keep":{"parameters":[{"$ref":"#/components/parameters/sshKey"}],"post":{"description":"Keeps a Legacy key by giving it an owner, so it goes on working after the day Legacy keys end. `owner` is\nthe environment the key is on, that environment's website or company, or yourself. Keeping it as a company key\nneeds the Create Company SSH Keys permission.\n","operationId":"keepSshLegacyKey","requestBody":{"content":{"application/json":{"examples":{"keep_for_company":{"summary":"Keep it as a company key","value":{"owner":{"id":1204,"type":"company"}}},"keep_for_environment":{"summary":"Keep it on its environment","value":{"owner":{"id":1311,"type":"environment"}}}},"schema":{"$ref":"#/components/schemas/SshLegacyKeepRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"kept":{"$ref":"#/components/examples/SshKeyKeptExample"}},"schema":{"$ref":"#/components/schemas/SshKeySaved"}}},"description":"The key was kept. `key` is the key at its new owner."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/SshWriteForbidden"},"404":{"$ref":"#/components/responses/SshNotFound"},"409":{"content":{"application/json":{"examples":{"ssh_key_duplicate":{"summary":"The key is already held here","value":{"code":"ssh_key_duplicate","field":"public_key","message":"That key is already added here.","reason":"ssh_key_duplicate"}},"ssh_managed_on_another_environment":{"$ref":"#/components/examples/SshManagedOnAnotherExample"}},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"The key is already held at this owner (`ssh_key_duplicate`), or the environment shares a server with\nanother environment that manages its keys (`ssh_managed_on_another_environment`; `managed_on` names it).\n"},"422":{"content":{"application/json":{"examples":{"ssh_legacy_ended":{"summary":"The key has already stopped working","value":{"code":"ssh_legacy_ended","field":null,"message":"This Legacy key's cut-off has passed.","reason":"ssh_legacy_ended"}},"ssh_not_legacy":{"summary":"Not a Legacy key","value":{"code":"ssh_not_legacy","field":null,"message":"Only Legacy keys can be kept.","reason":"ssh_not_legacy"}}},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"The request was refused. `reason` says why: `invalid_arguments` (`owner` is missing or wrong, or is not\nthe key's environment, its website, its company or yourself; `field` names it), `ssh_not_legacy` (the key\nis not a Legacy key), `ssh_legacy_ended` (the key has already stopped working), `ssh_cap_exceeded` (the\nowner holds its limit of keys), `ssh_staff_key_refused` (kept at a website, a company or yourself, and the\nkey is on Corefinity's list of staff and system keys) or `ssh_login_unavailable` and\n`ssh_uid_range_exhausted` (kept as your own, and a username cannot be issued for your account yet).\n"},"429":{"$ref":"#/components/responses/SshTooManyWrites"}},"summary":"Keep a Legacy SSH key","tags":["SSH keys"],"x-effect":["changes-settings"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-long-running":"getSshChange","x-rate-limit":{"also":[{"bucket":"ssh-writes","limit":30,"minutes":1,"per":"person"},{"bucket":"ssh-writes","limit":120,"minutes":1,"per":"company"}],"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"all"}},"/support/ticket-options":{"get":{"description":"Answers what the New Ticket form offers you: the departments, the priorities, the websites a ticket can be\nabout and, once you give websites, their environments. An agency chooses a company first: until `company_id`\nis given, `websites` is null, and websites given without it are refused.\n","operationId":"getSupportTicketOptions","parameters":[{"description":"The company the ticket would be for, when the form asks.","in":"query","name":"company_id","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"The websites whose environments to list: up to 50 ids, comma-separated.","example":"1310","in":"query","name":"website_ids","required":false,"schema":{"type":"string"}},{"description":"One website, in place of `website_ids`.","in":"query","name":"website_id","required":false,"schema":{"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"chooses_company":false,"companies":null,"company_id":null,"default_priority":"medium","departments":[{"id":21,"name":"Support"},{"id":22,"name":"Billing"}],"emergency_notice":null,"environment_groups":[{"environments":[{"id":1311,"name":"Production"},{"id":1312,"name":"Staging"}],"website_id":1310,"website_name":"Harbour & Finch trade"}],"environments":[{"id":1311,"name":"Production","website_id":1310},{"id":1312,"name":"Staging","website_id":1310}],"priorities":[{"label":"Emergency","value":"emergency"},{"label":"High","value":"high"},{"label":"Medium","value":"medium"},{"label":"Low","value":"low"}],"website_id":1310,"website_ids":[1310],"websites":[{"id":1310,"name":"Harbour & Finch trade"},{"id":1320,"name":"Harbour & Finch outlet"}]},"schema":{"$ref":"#/components/schemas/SupportTicketOptions"}}},"description":"The choices."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"422":{"content":{"application/json":{"examples":{"company":{"summary":"A company, from somebody who raises tickets for their own","value":{"code":"invalid","errors":{"company_id":["You raise tickets for your own company, so there is no company to choose."]},"field":"company_id","message":"You raise tickets for your own company, so there is no company to choose.","reason":"invalid"}},"company_first":{"summary":"Websites from an agency, without the company","value":{"code":"invalid","errors":{"company_id":["Choose the company first: its websites depend on it."]},"field":"company_id","message":"Choose the company first: its websites depend on it.","reason":"invalid"}},"company_other":{"summary":"A company an agency cannot raise a ticket for","value":{"code":"invalid","errors":{"company_id":["You cannot raise a ticket for that company."]},"field":"company_id","message":"You cannot raise a ticket for that company.","reason":"invalid"}},"website":{"summary":"A website you cannot raise a ticket about","value":{"code":"invalid","errors":{"website_ids":["That website is not one you can raise a ticket about."]},"field":"website_ids","message":"That website is not one you can raise a ticket about.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A parameter is not valid, or names a company or a website the form does not offer you. `field` names it."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the choices for a new ticket","tags":["Support"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/support/ticket-uploads":{"post":{"description":"Opens an upload for one file a reply will carry, for a caller that cannot send a multipart form. Send the file\nwith a `PUT` to the `url` this answers, which carries no token, then name the `upload_id` in the reply's\n`upload_ids`; a file nobody attaches is deleted a day after its upload was opened.\n","operationId":"createSupportTicketUpload","requestBody":{"content":{"application/json":{"examples":{"screenshot":{"summary":"A screenshot of 180 KB","value":{"filename":"checkout-error.png","size_bytes":184320}}},"schema":{"properties":{"filename":{"description":"The file's name, of a type the ticket page takes.","maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._ -]*$","type":"string"},"size_bytes":{"description":"The size of the file, exactly. At most the `max_bytes` an upload answers, which is never more than 512 MB.","maximum":536870912,"minimum":1,"type":"integer"}},"required":["filename","size_bytes"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"expires_at":"2026-11-04T16:40:11Z","lines":{"note":"Send the whole file in one request, exactly size_bytes long, before url_expires_at. Then pass upload_id in upload_ids when you reply to the ticket.","one_request":"curl --fail -X PUT --upload-file 'checkout-error.png' 'https://manage.corefinity.com/api/support/ticket-uploads/0d9c1a4e-6f1b-4f5e-9b8a-2d7c3e4f5a6b?expires=1792604411&signature=0000000000000000000000000000000000000000000000000000000000000000'"},"max_bytes":104857600,"method":"PUT","upload_id":"0d9c1a4e-6f1b-4f5e-9b8a-2d7c3e4f5a6b","url":"https://manage.corefinity.com/api/support/ticket-uploads/0d9c1a4e-6f1b-4f5e-9b8a-2d7c3e4f5a6b?expires=1792604411&signature=0000000000000000000000000000000000000000000000000000000000000000","url_expires_at":"2026-11-03T17:40:11Z"},"schema":{"$ref":"#/components/schemas/SupportTicketUpload"}}},"description":"The upload is open."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"422":{"content":{"application/json":{"examples":{"name":{"summary":"A name with other characters","value":{"code":"invalid","errors":{"filename":["Letters, digits, spaces, dots, dashes and underscores, starting with a letter or a digit."]},"field":"filename","message":"Letters, digits, spaces, dots, dashes and underscores, starting with a letter or a digit.","reason":"invalid"}},"type":{"summary":"A type the ticket page refuses","value":{"code":"invalid","errors":{"filename":["File type .exe is not allowed."]},"field":"filename","message":"File type .exe is not allowed.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`filename` or `size_bytes` is missing or wrong, or the file is of a type the ticket page refuses. `field` names it."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create an upload for a reply","tags":["Support"],"x-effect":["none"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/support/ticket-uploads/{upload}":{"parameters":[{"description":"The `upload_id` of the upload, as part of the `url` it answered.","example":"0d9c1a4e-6f1b-4f5e-9b8a-2d7c3e4f5a6b","in":"path","name":"upload","required":true,"schema":{"format":"uuid","type":"string"}}],"put":{"description":"Sends the file an upload was opened for, to the `url` the upload answered, exactly as given: the request\ncarries no token, and the signed address is its only credential until the upload's `url_expires_at`. Send the\nwhole file as the body of one request, exactly `size_bytes` long and with its `Content-Length`; the file is\ntaken once, and a second request is refused. At most 30 of these requests a minute are taken from one address.\n","operationId":"uploadSupportTicketFile","parameters":[{"description":"Part of the signed address. Send it as given.","in":"query","name":"expires","required":true,"schema":{"type":"string"}},{"description":"Part of the signed address. Send it as given.","in":"query","name":"signature","required":true,"schema":{"type":"string"}},{"description":"The size of the file in bytes: exactly the upload's `size_bytes`.","in":"header","name":"Content-Length","required":true,"schema":{"minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"expires_at":"2026-11-04T16:40:11Z","filename":"checkout-error.png","mime_type":"image/png","size_bytes":184320,"upload_id":"0d9c1a4e-6f1b-4f5e-9b8a-2d7c3e4f5a6b"},"schema":{"$ref":"#/components/schemas/SupportTicketUploadStored"}}},"description":"The file was stored and waits for a reply to attach it."},"403":{"content":{"application/json":{"example":{"code":"invalid_signature","message":"This upload address has changed or expired. Open a new upload.","reason":"invalid_signature"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The address was changed or has expired (`invalid_signature`). Open a new upload."},"404":{"$ref":"#/components/responses/NotFound","description":"The upload does not exist or is past its day."},"409":{"content":{"application/json":{"examples":{"already_received":{"summary":"A second request","value":{"code":"already_received","message":"This upload has its file already. Open a new upload for another file.","reason":"already_received"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The upload has its file already (`already_received`). The first file is kept."},"422":{"content":{"application/json":{"examples":{"length":{"summary":"No Content-Length","value":{"code":"invalid","errors":{"size_bytes":["Send the whole file in one request with a Content-Length of 184320 bytes."]},"field":"size_bytes","message":"Send the whole file in one request with a Content-Length of 184320 bytes.","reason":"invalid"}},"size":{"summary":"A file of another size","value":{"code":"invalid","errors":{"size_bytes":["The file is not the size the upload was opened for (184320 bytes)."]},"field":"size_bytes","message":"The file is not the size the upload was opened for (184320 bytes).","reason":"invalid"}},"type":{"summary":"Contents that are not what the name says","value":{"code":"invalid","errors":{"filename":["This kind of file is not allowed."]},"field":"filename","message":"This kind of file is not allowed.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The file is not the size the upload was opened for, was sent without its length, or its contents are not what its name says. `field` names `size_bytes` or `filename`. Nothing was stored."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[],"summary":"Send a file to an upload","tags":["Support"],"x-effect":["none"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"support-ticket-uploads","limit":30,"minutes":1},"x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/support/tickets":{"get":{"description":"Answers the tickets you can see (your company's, those of the companies your agency looks after and any you\nfollow) in the order of the Tickets page of the Control Panel: new tickets first, then open and in-progress\nones by priority, then the rest, newest first within each. Paged by page number: `page` and `per_page`.\n","operationId":"listSupportTickets","parameters":[{"description":"`all_open_with_waiting` (the default: every ticket that is not resolved or closed), `all_open` (new, open, in progress and on hold), `all`, or one or more statuses, comma-separated: `pending`, `open`, `in_progress`, `waiting_on_customer`, `waiting_on_thirdparty`, `on_hold`, `scheduled`, `resolved`, `closed`.","example":"all_open_with_waiting","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"One or more of `emergency`, `high`, `medium` and `low`, comma-separated.","example":"high,emergency","in":"query","name":"priority","required":false,"schema":{"type":"string"}},{"description":"One company's tickets, for an agency with more than one company.","in":"query","name":"company_id","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Tickets about any of these websites: up to 50 ids, comma-separated.","in":"query","name":"website_ids","required":false,"schema":{"type":"string"}},{"description":"Tickets about one website.","in":"query","name":"website_id","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Tickets about any of these environments: up to 50 ids, comma-separated.","in":"query","name":"environment_ids","required":false,"schema":{"type":"string"}},{"description":"Tickets about one environment.","in":"query","name":"environment_id","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Tickets for that person.","in":"query","name":"requester_id","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Tickets in that department.","in":"query","name":"department_id","required":false,"schema":{"minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/perPage"}],"responses":{"200":{"content":{"application/json":{"example":{"last_page":1,"page":1,"per_page":25,"tickets":[{"company":{"id":1204,"name":"Harbour & Finch"},"created_at":"2026-11-02T08:14:03Z","department":{"id":21,"name":"Support"},"environment":{"id":1311,"name":"Production"},"environments":[{"id":1311,"name":"Production"}],"id":48210,"priority":"high","priority_label":"High","requester":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"scheduled_for":null,"status":"waiting_on_customer","status_label":"Waiting on customer","subject":"Checkout returns a 502","updated_at":"2026-11-03T16:40:11Z","url":"https://manage.corefinity.com/resources/tickets/48210","website":{"id":1310,"name":"Harbour & Finch trade"},"websites":[{"id":1310,"name":"Harbour & Finch trade"}]}],"total":1},"schema":{"$ref":"#/components/schemas/SupportTicketList"}}},"description":"One page of tickets."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"422":{"content":{"application/json":{"examples":{"per_page":{"summary":"More than 100 a page","value":{"code":"invalid","errors":{"per_page":["The per page may not be greater than 100."]},"field":"per_page","message":"The per page may not be greater than 100.","reason":"invalid"}},"status":{"summary":"A status that is not one","value":{"code":"invalid","errors":{"status.0":["The selected status.0 is invalid."]},"field":"status.0","message":"The selected status.0 is invalid.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A parameter is not valid. `field` names it."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List support tickets","tags":["Support"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"post":{"description":"Opens a ticket as the New Ticket form does, with the choices the ticket choices endpoint answers, and answers\nthe ticket; Corefinity's support team is told straight away and you are emailed. An `emergency` pages\nCorefinity's on-call engineers, so it is refused unless `confirm_emergency` is `true`.\n","operationId":"createSupportTicket","requestBody":{"content":{"application/json":{"examples":{"checkout":{"summary":"A ticket about one website and its production environment","value":{"body":"Every order fails at the **payment** step since 09:00.","department_id":21,"environment_ids":[1311],"priority":"high","replication_step":"1. Add any product to the basket\n2. Pay by card","subject":"Checkout fails at the payment step","website_ids":[1310]}}},"schema":{"$ref":"#/components/schemas/SupportTicketOpen"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"attachments":[],"body_html":"<p>Every order fails at the <strong>payment</strong> step since 09:00.</p>","body_text":"Every order fails at the payment step since 09:00.","can":{"change_priority":true,"close":true,"reopen":false,"reply":true},"company":{"id":1204,"name":"Harbour & Finch"},"created_at":"2026-11-03T16:40:11Z","department":{"id":21,"name":"Support"},"environment":{"id":1311,"name":"Production"},"environments":[{"id":1311,"name":"Production"}],"id":48211,"priority":"high","priority_label":"High","raised_by":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"replication_step_html":"<ol><li>Add any product to the basket</li><li>Pay by card</li></ol>","replies":[],"reply_count":0,"requester":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"scheduled_for":null,"status":"pending","status_label":"Pending","subject":"Checkout fails at the payment step","updated_at":"2026-11-03T16:40:11Z","url":"https://manage.corefinity.com/resources/tickets/48211","website":{"id":1310,"name":"Harbour & Finch trade"},"websites":[{"id":1310,"name":"Harbour & Finch trade"}]},"schema":{"$ref":"#/components/schemas/SupportTicket"}}},"description":"The ticket was opened."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"422":{"content":{"application/json":{"examples":{"company":{"summary":"Another company","value":{"code":"invalid","errors":{"company_id":["You cannot raise a ticket for that company."]},"field":"company_id","message":"You cannot raise a ticket for that company.","reason":"invalid"}},"company_required":{"summary":"No company, from an agency","value":{"code":"invalid","errors":{"company_id":["Choose the company the ticket is for."]},"field":"company_id","message":"Choose the company the ticket is for.","reason":"invalid"}},"confirm":{"summary":"An emergency without confirm_emergency","value":{"code":"confirm","errors":{"confirm_emergency":["Confirm the Emergency: it pages Corefinity's on-call engineers."]},"message":"An Emergency pages Corefinity's on-call engineers. Send confirm_emergency: true once the person has agreed.","reason":"confirm"}},"department":{"summary":"A department the form does not offer","value":{"code":"invalid","errors":{"department_id":["Choose one of the departments the form offers."]},"field":"department_id","message":"Choose one of the departments the form offers.","reason":"invalid"}},"environment":{"summary":"An environment of another website","value":{"code":"invalid","errors":{"environment_ids":["That environment is not one you can choose for the chosen websites."]},"field":"environment_ids","message":"That environment is not one you can choose for the chosen websites.","reason":"invalid"}},"environment_first":{"summary":"An environment without its website","value":{"code":"invalid","errors":{"environment_ids":["Choose the website first: its environments depend on it."]},"field":"environment_ids","message":"Choose the website first: its environments depend on it.","reason":"invalid"}},"subject":{"summary":"No subject","value":{"code":"invalid","errors":{"subject":["The subject field is required."]},"field":"subject","message":"The subject field is required.","reason":"invalid"}},"website":{"summary":"A website you cannot raise a ticket about","value":{"code":"invalid","errors":{"website_ids":["That website is not one you can raise a ticket about."]},"field":"website_ids","message":"That website is not one you can raise a ticket about.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"A field is missing or is a choice the form does not offer (`invalid`, with `field` and `errors`), or the ticket is an emergency without `confirm_emergency` (`confirm`). Nothing was opened."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a support ticket","tags":["Support"],"x-effect":["sends"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/support/tickets/{ticket}":{"parameters":[{"description":"The number of a ticket. Digits only.","example":48210,"in":"path","name":"ticket","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers one ticket with its whole conversation: the first message, its files and every reply, yours and\nCorefinity's, oldest first. Notes Corefinity's staff keep for themselves are never part of the answer.\n","operationId":"getSupportTicket","responses":{"200":{"content":{"application/json":{"example":{"attachments":[{"download_url":"https://manage.corefinity.com/api/support/tickets/48210/attachments/77120","id":77120,"mime_type":"image/png","name":"checkout-error.png","size":184320,"url":"https://manage.corefinity.com/nova-vendor/nova-support-ticketing-system/attachments/77120"}],"body_html":"<p>Every order fails at the <strong>payment</strong> step since 09:00.</p>","body_text":"Every order fails at the payment step since 09:00.","can":{"change_priority":true,"close":true,"reopen":false,"reply":true},"company":{"id":1204,"name":"Harbour & Finch"},"created_at":"2026-11-02T08:14:03Z","department":{"id":21,"name":"Support"},"environment":{"id":1311,"name":"Production"},"environments":[{"id":1311,"name":"Production"}],"id":48210,"priority":"high","priority_label":"High","raised_by":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"replication_step_html":"<ol><li>Add any product to the basket</li><li>Pay by card</li></ol>","replies":[{"attachments":[],"author":{"email":"support@example.com","id":7002,"name":"Corefinity support"},"body_html":"<p>We are looking at it. Can you send the time of the last failed order?</p>","body_text":"We are looking at it. Can you send the time of the last failed order?","created_at":"2026-11-02T08:31:47Z","id":90311}],"reply_count":1,"requester":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"scheduled_for":null,"status":"waiting_on_customer","status_label":"Waiting on customer","subject":"Checkout returns a 502","updated_at":"2026-11-03T16:40:11Z","url":"https://manage.corefinity.com/resources/tickets/48210","website":{"id":1310,"name":"Harbour & Finch trade"},"websites":[{"id":1310,"name":"Harbour & Finch trade"}]},"schema":{"$ref":"#/components/schemas/SupportTicket"}}},"description":"The ticket."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a support ticket","tags":["Support"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/support/tickets/{ticket}/attachments/{attachment}":{"parameters":[{"description":"The number of a ticket. Digits only.","example":48210,"in":"path","name":"ticket","required":true,"schema":{"minimum":1,"type":"integer"}},{"description":"The id of one of the ticket's files, as the ticket answers it. Digits only.","example":77120,"in":"path","name":"attachment","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers one file of the ticket or of one of its replies, with its name: the file itself, never cached.\nAnything else, such as another ticket's file, answers `404`.\n","operationId":"downloadSupportTicketAttachment","responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"The file.","headers":{"Content-Disposition":{"description":"The file's name.","schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Download a ticket's file","tags":["Support"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"also":[{"bucket":"api","limit":60,"minutes":1,"per":"person"}],"bucket":"support-ticket-files","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/support/tickets/{ticket}/close":{"parameters":[{"description":"The number of a ticket. Digits only.","example":48210,"in":"path","name":"ticket","required":true,"schema":{"minimum":1,"type":"integer"}}],"post":{"description":"Closes the ticket and answers it as the list shows it. Closing a closed ticket changes nothing.\n","operationId":"closeSupportTicket","responses":{"200":{"content":{"application/json":{"example":{"company":{"id":1204,"name":"Harbour & Finch"},"created_at":"2026-11-02T08:14:03Z","department":{"id":21,"name":"Support"},"environment":{"id":1311,"name":"Production"},"environments":[{"id":1311,"name":"Production"}],"id":48210,"priority":"high","priority_label":"High","requester":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"scheduled_for":null,"status":"closed","status_label":"Closed","subject":"Checkout returns a 502","updated_at":"2026-11-03T16:40:11Z","url":"https://manage.corefinity.com/resources/tickets/48210","website":{"id":1310,"name":"Harbour & Finch trade"},"websites":[{"id":1310,"name":"Harbour & Finch trade"}]},"schema":{"$ref":"#/components/schemas/SupportTicketSummary"}}},"description":"The ticket, closed."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound","description":"The ticket does not exist, is not one you can see, or is one you can read but not change, such as a ticket you follow from another company. All answer the same body."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Close a support ticket","tags":["Support"],"x-effect":["changes-settings"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/support/tickets/{ticket}/priority":{"parameters":[{"description":"The number of a ticket. Digits only.","example":48210,"in":"path","name":"ticket","required":true,"schema":{"minimum":1,"type":"integer"}}],"patch":{"description":"Changes the priority and answers the ticket as the list shows it; the change is emailed to everyone following\nthe ticket, and sending the priority it already has changes nothing. Raising it to `emergency` pages\nCorefinity's on-call engineers instead, and is refused unless `confirm_emergency` is `true`.\n","operationId":"updateSupportTicketPriority","requestBody":{"content":{"application/json":{"examples":{"low":{"summary":"Lower the priority","value":{"priority":"low"}}},"schema":{"properties":{"confirm_emergency":{"description":"`true` for `emergency`, once you agree to what the `emergency_notice` of the ticket choices says.","type":"boolean"},"priority":{"enum":["emergency","high","medium","low"],"type":"string"}},"required":["priority"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"company":{"id":1204,"name":"Harbour & Finch"},"created_at":"2026-11-02T08:14:03Z","department":{"id":21,"name":"Support"},"environment":{"id":1311,"name":"Production"},"environments":[{"id":1311,"name":"Production"}],"id":48210,"priority":"low","priority_label":"Low","requester":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"scheduled_for":null,"status":"waiting_on_customer","status_label":"Waiting on customer","subject":"Checkout returns a 502","updated_at":"2026-11-03T16:40:11Z","url":"https://manage.corefinity.com/resources/tickets/48210","website":{"id":1310,"name":"Harbour & Finch trade"},"websites":[{"id":1310,"name":"Harbour & Finch trade"}]},"schema":{"$ref":"#/components/schemas/SupportTicketSummary"}}},"description":"The ticket with its new priority."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound","description":"The ticket does not exist, is not one you can see, or is one you can read but not change, such as a ticket you follow from another company. All answer the same body."},"422":{"content":{"application/json":{"examples":{"confirm":{"summary":"An emergency without confirm_emergency","value":{"code":"confirm","errors":{"confirm_emergency":["Confirm the Emergency: it pages Corefinity's on-call engineers."]},"message":"An Emergency pages Corefinity's on-call engineers. Send confirm_emergency: true once the person has agreed.","reason":"confirm"}},"priority":{"summary":"A priority that is not one","value":{"code":"invalid","errors":{"priority":["The value you have entered is invalid."]},"field":"priority","message":"The value you have entered is invalid.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"`priority` is missing or not one of the four (`invalid`), or it is `emergency` without `confirm_emergency` (`confirm`). Nothing was changed."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a ticket's priority","tags":["Support"],"x-effect":["sends"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/support/tickets/{ticket}/reopen":{"parameters":[{"description":"The number of a ticket. Digits only.","example":48210,"in":"path","name":"ticket","required":true,"schema":{"minimum":1,"type":"integer"}}],"post":{"description":"Opens a closed ticket again and answers it as the list shows it. Only a closed ticket can be reopened.\n","operationId":"reopenSupportTicket","responses":{"200":{"content":{"application/json":{"example":{"company":{"id":1204,"name":"Harbour & Finch"},"created_at":"2026-11-02T08:14:03Z","department":{"id":21,"name":"Support"},"environment":{"id":1311,"name":"Production"},"environments":[{"id":1311,"name":"Production"}],"id":48210,"priority":"high","priority_label":"High","requester":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"scheduled_for":null,"status":"open","status_label":"Open","subject":"Checkout returns a 502","updated_at":"2026-11-03T16:40:11Z","url":"https://manage.corefinity.com/resources/tickets/48210","website":{"id":1310,"name":"Harbour & Finch trade"},"websites":[{"id":1310,"name":"Harbour & Finch trade"}]},"schema":{"$ref":"#/components/schemas/SupportTicketSummary"}}},"description":"The ticket, open again."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound","description":"The ticket does not exist, is not one you can see, or is one you can read but not change, such as a ticket you follow from another company. All answer the same body."},"422":{"content":{"application/json":{"examples":{"state":{"summary":"A ticket that is not closed","value":{"code":"state","message":"Only a closed ticket can be reopened.","reason":"state"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The ticket is not closed (`state`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Reopen a support ticket","tags":["Support"],"x-effect":["changes-settings"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/support/tickets/{ticket}/replies":{"parameters":[{"description":"The number of a ticket. Digits only.","example":48210,"in":"path","name":"ticket","required":true,"schema":{"minimum":1,"type":"integer"}}],"post":{"description":"Posts a reply the customer and Corefinity both read: `body` in Markdown, up to 20 files, or both. Everyone\nfollowing the ticket is told, and a ticket that was waiting on you, resolved or closed goes back to\nCorefinity. Send files as `attachments[]` in a multipart form, or send each ahead through an upload and name\nits `upload_id` in `upload_ids`; an internal note is refused.\n","operationId":"createSupportTicketReply","requestBody":{"content":{"application/json":{"examples":{"text":{"summary":"A reply","value":{"body":"The error stopped after we cleared the cache."}},"with_a_file_sent_ahead":{"summary":"A reply with a file sent ahead","value":{"body":"Screenshot attached.","upload_ids":["0d9c1a4e-6f1b-4f5e-9b8a-2d7c3e4f5a6b"]}}},"schema":{"$ref":"#/components/schemas/SupportTicketReplyRequest"}},"multipart/form-data":{"schema":{"properties":{"attachments[]":{"items":{"format":"binary","type":"string"},"maxItems":20,"type":"array"},"body":{"description":"The reply, in Markdown.","type":"string"},"upload_ids[]":{"items":{"format":"uuid","type":"string"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"text":{"summary":"A reply","value":{"attachments":[],"author":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"body_html":"\n<p>The error stopped after we cleared the cache.</p>\n","body_text":"The error stopped after we cleared the cache.","created_at":"2026-11-03T16:40:11Z","id":90312,"ticket":{"company":{"id":1204,"name":"Harbour & Finch"},"created_at":"2026-11-02T08:14:03Z","department":{"id":21,"name":"Support"},"environment":{"id":1311,"name":"Production"},"environments":[{"id":1311,"name":"Production"}],"id":48210,"priority":"high","priority_label":"High","requester":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"scheduled_for":null,"status":"open","status_label":"Open","subject":"Checkout returns a 502","updated_at":"2026-11-03T16:40:11Z","url":"https://manage.corefinity.com/resources/tickets/48210","website":{"id":1310,"name":"Harbour & Finch trade"},"websites":[{"id":1310,"name":"Harbour & Finch trade"}]}}},"with_a_file":{"summary":"A reply with a file","value":{"attachments":[{"download_url":"https://manage.corefinity.com/api/support/tickets/48210/attachments/77121","id":77121,"mime_type":"image/png","name":"checkout-error.png","size":184320,"url":"https://manage.corefinity.com/nova-vendor/nova-support-ticketing-system/attachments/77121"}],"author":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"body_html":"\n<p>Screenshot attached.</p>\n","body_text":"Screenshot attached.","created_at":"2026-11-03T16:40:11Z","id":90313,"ticket":{"company":{"id":1204,"name":"Harbour & Finch"},"created_at":"2026-11-02T08:14:03Z","department":{"id":21,"name":"Support"},"environment":{"id":1311,"name":"Production"},"environments":[{"id":1311,"name":"Production"}],"id":48210,"priority":"high","priority_label":"High","requester":{"email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},"scheduled_for":null,"status":"open","status_label":"Open","subject":"Checkout returns a 502","updated_at":"2026-11-03T16:40:11Z","url":"https://manage.corefinity.com/resources/tickets/48210","website":{"id":1310,"name":"Harbour & Finch trade"},"websites":[{"id":1310,"name":"Harbour & Finch trade"}]}}}},"schema":{"$ref":"#/components/schemas/SupportTicketReplyAnswer"}}},"description":"The reply was posted."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound","description":"The ticket does not exist, is not one you can see, or is one you can read but not change, such as a ticket you follow from another company. All answer the same body."},"422":{"content":{"application/json":{"examples":{"empty":{"summary":"Neither a body nor a file","value":{"code":"invalid","errors":{"attachments":["The attachments field is required when none of body / upload ids are present."],"body":["The body field is required when none of attachments / upload ids are present."]},"field":"body","message":"The body field is required when none of attachments / upload ids are present. (and 1 more error)","reason":"invalid"}},"internal":{"summary":"An internal note","value":{"code":"invalid","errors":{"is_comment":["Only Corefinity staff can leave internal comments. Your message has not been sent."]},"field":"is_comment","message":"Only Corefinity staff can leave internal comments. Your message has not been sent.","reason":"invalid"}},"too_many":{"summary":"More than 20 files, counting those sent ahead","value":{"code":"invalid","errors":{"upload_ids":["At most 20 files in one reply."]},"field":"upload_ids","message":"At most 20 files in one reply.","reason":"invalid"}},"upload_empty":{"summary":"An upload with no file yet","value":{"code":"invalid","errors":{"upload_ids":["Upload 3f2a9c1e-7b4d-4e6a-8c5f-1a2b3c4d5e6f has no file yet: PUT the file to its url first."]},"field":"upload_ids","message":"Upload 3f2a9c1e-7b4d-4e6a-8c5f-1a2b3c4d5e6f has no file yet: PUT the file to its url first.","reason":"invalid"}},"upload_unknown":{"summary":"An upload that is not yours","value":{"code":"invalid","errors":{"upload_ids":["Upload 3f2a9c1e-7b4d-4e6a-8c5f-1a2b3c4d5e6f is not one of yours, or it has expired. Open a new upload."]},"field":"upload_ids","message":"Upload 3f2a9c1e-7b4d-4e6a-8c5f-1a2b3c4d5e6f is not one of yours, or it has expired. Open a new upload.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The reply has neither a body nor a file, carries more than 20 files, a file is of a type the ticket page refuses, an upload is not yours, has expired or has no file yet, or the reply is an internal note. `field` names it. Nothing was posted."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a reply to a support ticket","tags":["Support"],"x-effect":["sends"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/support/tickets/{ticket}/subscriber-candidates":{"parameters":[{"description":"The number of a ticket. Digits only.","example":48210,"in":"path","name":"ticket","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers the people you may add as followers, as the picker on the ticket page offers them: up to six active people whose name contains `search`, from the companies that may follow the ticket. For an agency these are the ticket's client company and the agency itself; for a client, its own company.\n","operationId":"listSupportTicketSubscriberCandidates","parameters":[{"description":"Part of a name. The first six people when left out.","example":"Tom","in":"query","name":"search","required":false,"schema":{"maxLength":255,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"candidates":[{"company_name":"Harbour & Finch","email":"tom.harbour@harbourandfinch.example.com","id":2042,"name":"Tom Harbour"}],"search":"Tom","ticket_id":48210},"schema":{"$ref":"#/components/schemas/SupportTicketSubscriberCandidates"}}},"description":"The people you may add."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"You may not change who follows this ticket","value":{"code":"forbidden","message":"You cannot change who follows this ticket.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The token lacks the `read` scope (`scope_required`), or you can read the ticket but may not change who follows it (`forbidden`), for example a ticket you only follow from another company."},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"examples":{"search":{"summary":"A search of more than 255 characters","value":{"code":"invalid","errors":{"search":["The search may not be greater than 255 characters."]},"field":"search","message":"The search may not be greater than 255 characters.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`search` is not text, or is longer than 255 characters. `field` names it."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List people who can follow a ticket","tags":["Support"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/support/tickets/{ticket}/subscribers":{"parameters":[{"description":"The number of a ticket. Digits only.","example":48210,"in":"path","name":"ticket","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers everyone who follows the ticket, and whether you may change that. Followers are told of the ticket's replies.\n","operationId":"listSupportTicketSubscribers","responses":{"200":{"content":{"application/json":{"example":{"can_manage":true,"subscribers":[{"company_name":"Harbour & Finch","email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"}],"ticket_id":48210},"schema":{"$ref":"#/components/schemas/SupportTicketSubscribers"}}},"description":"The followers."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a ticket's followers","tags":["Support"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/support/tickets/{ticket}/subscribers/{subscriber}":{"parameters":[{"description":"The number of a ticket. Digits only.","example":48210,"in":"path","name":"ticket","required":true,"schema":{"minimum":1,"type":"integer"}},{"description":"The id of a person. Digits only.","example":2042,"in":"path","name":"subscriber","required":true,"schema":{"minimum":1,"type":"integer"}}],"put":{"description":"Adds a person as a follower and answers the followers afterwards. Adding someone who already follows changes\nnothing, and no email is sent for the change.\n","operationId":"createSupportTicketSubscriber","responses":{"200":{"content":{"application/json":{"example":{"can_manage":true,"subscribers":[{"company_name":"Harbour & Finch","email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"},{"company_name":"Harbour & Finch","email":"tom.harbour@harbourandfinch.example.com","id":2042,"name":"Tom Harbour"}],"ticket_id":48210},"schema":{"$ref":"#/components/schemas/SupportTicketSubscribers"}}},"description":"The followers."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"You may not change who follows this ticket","value":{"code":"forbidden","message":"You cannot change who follows this ticket.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The token lacks the `write` scope (`scope_required`), or you can read the ticket but may not change who follows it (`forbidden`), for example a ticket you only follow from another company."},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"examples":{"person":{"summary":"Somebody who cannot follow the ticket","value":{"code":"invalid","errors":{"user_id":["Choose an active person from a company that can follow this ticket."]},"field":"user_id","message":"Choose an active person from a company that can follow this ticket.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The person does not exist, is not active or is not in a company that can follow the ticket: one answer for all three. `field` is `user_id`."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Create a ticket follower","tags":["Support"],"x-effect":["changes-settings"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"},"delete":{"description":"Removes a follower and answers the followers afterwards. Removing someone who does not follow changes nothing.\n","operationId":"deleteSupportTicketSubscriber","responses":{"200":{"content":{"application/json":{"example":{"can_manage":true,"subscribers":[{"company_name":"Harbour & Finch","email":"eleanor.finch@harbourandfinch.example.com","id":2041,"name":"Eleanor Finch"}],"ticket_id":48210},"schema":{"$ref":"#/components/schemas/SupportTicketSubscribers"}}},"description":"The followers."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"You may not change who follows this ticket","value":{"code":"forbidden","message":"You cannot change who follows this ticket.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The token lacks the `write` scope (`scope_required`), or you can read the ticket but may not change who follows it (`forbidden`), for example a ticket you only follow from another company."},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a ticket follower","tags":["Support"],"x-effect":["changes-settings"],"x-feature":"support","x-file":"support","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/team/members":{"get":{"description":"Answers your company's people and those invited into it, by name: everybody whose `status` is `active`,\n`invite_sent` or `invite_expired`. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.\n","operationId":"listTeamMembers","parameters":[{"$ref":"#/components/parameters/cursorLimit"},{"$ref":"#/components/parameters/TeamMembersCursor"},{"$ref":"#/components/parameters/TeamMembersSearch"}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"items":[{"company_id":1204,"email":"rosa.whitlock@harbourandfinch.example.com","id":2044,"invitation_expires_at":"2026-11-16T10:15:00+00:00","invited_at":"2026-11-09T10:15:00+00:00","name":"Rosa Whitlock","notifications":{"alerts_notifications":true,"email_notifications":true,"maintenance_window_notifications":true,"subscribe_to_deployment_alerts":true,"subscribe_to_emergency_alerts":true,"subscribe_to_newsletters":false},"position":null,"roles":[{"name":"Member (Full Access)","slug":"client-member-full"}],"status":"invite_sent"},{"company_id":1204,"email":"tom.harbour@harbourandfinch.example.com","id":2042,"invitation_expires_at":null,"invited_at":null,"name":"Tom Harbour","notifications":{"alerts_notifications":true,"email_notifications":true,"maintenance_window_notifications":true,"subscribe_to_deployment_alerts":true,"subscribe_to_emergency_alerts":true,"subscribe_to_newsletters":false},"position":"Developer","roles":[{"name":"Member (Full Access)","slug":"client-member-full"}],"status":"active"}],"next_cursor":null}},"schema":{"$ref":"#/components/schemas/TeamMemberPageAnswer"}}},"description":"One page of the team."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"422":{"content":{"application/json":{"example":{"code":"invalid","errors":{"limit":["The limit may not be greater than 100."]},"field":"limit","message":"The limit may not be greater than 100.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A query parameter is wrong (`invalid`), such as a `limit` above 100."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your team","tags":["Team"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/team/members/{member}":{"parameters":[{"$ref":"#/components/parameters/TeamMemberId"}],"get":{"description":"Answers one person in the shape the team list uses. An agency can read the people of the client companies it\nmanages. Somebody you cannot see answers the same `404` as an id that does not exist.\n","operationId":"getTeamMember","responses":{"200":{"content":{"application/json":{"example":{"data":{"company_id":1204,"email":"tom.harbour@harbourandfinch.example.com","id":2042,"invitation_expires_at":null,"invited_at":null,"name":"Tom Harbour","notifications":{"alerts_notifications":true,"email_notifications":true,"maintenance_window_notifications":true,"subscribe_to_deployment_alerts":true,"subscribe_to_emergency_alerts":true,"subscribe_to_newsletters":false},"position":"Developer","roles":[{"name":"Member (Full Access)","slug":"client-member-full"}],"status":"active"}},"schema":{"$ref":"#/components/schemas/TeamMemberAnswer"}}},"description":"The person."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a team member","tags":["Team"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/team/roles":{"get":{"description":"Answers your company's custom roles and the standard roles for your kind of company, by name, each with the\npermissions it gives and whether you may give it to somebody.\n","operationId":"listTeamRoles","responses":{"200":{"content":{"application/json":{"example":{"data":{"roles":[{"assignable":true,"custom":false,"id":3012,"name":"Member (Full Access)","permissions":["viewWebsites","viewDeployments","viewTickets","createTickets"],"slug":"client-member-full"},{"assignable":true,"custom":true,"id":3107,"name":"Release managers","permissions":["viewUsers"],"slug":"release-managers-0b9c7a52-3f7e-4c1d-9a55-2f6f1f0e8d11"}]}},"schema":{"$ref":"#/components/schemas/TeamRoleCatalogueAnswer"}}},"description":"The roles."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List roles and their permissions","tags":["Team"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/user":{"get":{"description":"Answers the person the access token belongs to, with their company, their roles and each role's permissions.\nUse it to check that a token works and whose it is.\n","operationId":"getCurrentUser","responses":{"200":{"content":{"application/json":{"example":{"user":{"company":{"address":"14 Quay Street, Anytown, AB1 2CD","country":"GB","id":"1204","name":"Harbour & Finch","phone":"+44 20 7946 0142"},"company_id":"1204","email":"eleanor.finch@harbourandfinch.example.com","id":"2041","mobile":null,"name":"Eleanor Finch","role":[{"name":"Owner","permissions":["viewWebsites","viewEnvironments","viewUsers","inviteUsers","viewInvoices"],"slug":"client-owner"}]}},"schema":{"$ref":"#/components/schemas/UserEnvelope"}}},"description":"The token's user."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get the token's user","tags":["Account"],"x-feature":"account","x-file":"users","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/user/firewall":{"get":{"description":"Answers the addresses held for you. Each opens every environment you can reach.\n","operationId":"getOwnFirewall","responses":{"200":{"content":{"application/json":{"examples":{"me":{"$ref":"#/components/examples/FirewallUserViewExample"}},"schema":{"$ref":"#/components/schemas/FirewallUserView"}}},"description":"Your addresses."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get your own firewall","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/user/firewall/activity":{"get":{"description":"Answers the changes to your own addresses, newest first. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.","operationId":"listOwnFirewallActivity","parameters":[{"$ref":"#/components/parameters/firewallCursor"}],"responses":{"200":{"content":{"application/json":{"examples":{"activity":{"$ref":"#/components/examples/FirewallActivityPageExample"}},"schema":{"$ref":"#/components/schemas/FirewallActivityPage"}}},"description":"A page of activity."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"$ref":"#/components/responses/FirewallInvalidQuery"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your own firewall activity","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/user/invite":{"post":{"description":"Invites a person into your own company with one role and emails them. The answer is the same whether or not\nthe address already has a Control Panel account; the invitation is listed on your team as `invite_sent`.\nYou need to be an owner or hold the `inviteUsers` permission.\n","operationId":"inviteTeamUser","requestBody":{"content":{"application/json":{"examples":{"invite":{"summary":"Invite a member with full access","value":{"email":"rosa.whitlock@harbourandfinch.example.com","name":"Rosa Whitlock","role":"client-member-full"}}},"schema":{"$ref":"#/components/schemas/TeamInviteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"created_at":"2026-11-09T10:15:00.000000Z","email":"rosa.whitlock@harbourandfinch.example.com","id":"2044","name":"Rosa Whitlock","role":"Member (Full Access)"},"message":"User has been invited successfully","status":"success"},"schema":{"$ref":"#/components/schemas/TeamInviteAnswer"}}},"description":"The invitation was made."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"You may not invite users","value":{"code":"forbidden","message":"You are not allowed to invite users.","reason":"forbidden","status":"error"}},"owner_grant":{"summary":"Inviting somebody as an owner","value":{"code":"owner_grant","message":"Only an owner or Corefinity staff can make someone an owner.","reason":"owner_grant","status":"error"}},"permission_grant":{"summary":"The role carries a permission you do not hold","value":{"code":"permission_grant","message":"You can only give someone a role if you hold all of its permissions yourself.","reason":"permission_grant","status":"error"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/TeamRefusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), you may not invite users (`forbidden`), only an owner\nor Corefinity staff can invite somebody as an owner (`owner_grant`), or the role carries a permission you\ndo not hold yourself (`permission_grant`).\n"},"409":{"content":{"application/json":{"example":{"code":"invite_company_gone","message":"This company is not active, so nobody can be invited to its team until it is.","reason":"invite_company_gone","status":"error"},"schema":{"$ref":"#/components/schemas/TeamRefusal"}}},"description":"Your company is not active, so nobody can be invited yet (`invite_company_gone`)."},"422":{"content":{"application/json":{"examples":{"already_in_team":{"summary":"The address is already on your team","value":{"code":"invalid","errors":{"email":["Someone with this email address is already on this team."]},"field":"email","message":"Someone with this email address is already on this team.","reason":"invalid"}},"role":{"summary":"A role you may not give in your company","value":{"code":"invalid","errors":{"role":["You are not allowed to add this role to this company."]},"field":"role","message":"You are not allowed to add this role to this company.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`): a role that does not exist or that you may not give in your\ncompany, or an address that is already on your team.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"content":{"application/json":{"example":{"message":"Failed to invite user","status":"error"},"schema":{"$ref":"#/components/schemas/LegacyRefusal"}}},"description":"The invitation could not be made. Nothing was saved."}},"summary":"Invite somebody to your team","tags":["Team"],"x-effect":["sends"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/user/sign-in-settings":{"get":{"description":"How long you stay signed in to the Control Panel before you are asked to sign in again, how long a trusted\nbrowser skips your two-factor code, and the values you can choose. These are your own settings, whatever\ncompany the token works in.\n","operationId":"getSignInSettings","responses":{"200":{"content":{"application/json":{"example":{"choices":[{"key":"8h","label":"8 hours","minutes":480},{"key":"16h","label":"16 hours","minutes":960},{"key":"1d","label":"1 day","minutes":1440},{"key":"3d","label":"3 days","minutes":4320},{"key":"7d","label":"7 days","minutes":10080}],"session_limit":{"default":true,"key":"8h","label":"8 hours","minutes":480},"staff_cap":false,"two_factor_trust":{"applies":true,"default":true,"key":"8h","label":"8 hours","minutes":480}},"schema":{"$ref":"#/components/schemas/AccountSecuritySignInSettings"}}},"description":"Your sign-in limits."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get your sign-in limits","tags":["Account security"],"x-feature":"account-security","x-file":"account-security","x-gates":["sign_in_limits"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"},"patch":{"description":"Changes one or both limits, at once and everywhere you are signed in. Lowering the session limit below your\ntwo-factor trust lowers the trust with it, and `trust_lowered` says so. Lengthening either limit is never\nsaved from the API: it is refused `409 confirmation_required` with a `confirm_url`, where you confirm it is\nyou in the Control Panel.\n","operationId":"updateSignInSettings","requestBody":{"content":{"application/json":{"examples":{"both":{"summary":"Both limits at once","value":{"session_limit":"1d","two_factor_trust":"8h"}},"null_is_not_sent":{"summary":"A null session limit is left as it is","value":{"session_limit":null,"two_factor_trust":"8h"}},"session_limit":{"summary":"Stay signed in for 16 hours","value":{"session_limit":"16h"}}},"schema":{"description":"At least one of the two with a value. A `null` value counts as not sent, so a body whose values are\nall `null` is refused as one with no value at all.\n","minProperties":1,"properties":{"session_limit":{"description":"How long you stay signed in. `null` leaves it as it is.","oneOf":[{"$ref":"#/components/schemas/AccountSecurityChoiceKey"},{"type":"null"}]},"two_factor_trust":{"description":"How long a trusted browser skips your two-factor code. `null` leaves it as it is.","oneOf":[{"$ref":"#/components/schemas/AccountSecurityChoiceKey"},{"type":"null"}]}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"choices":[{"key":"8h","label":"8 hours","minutes":480},{"key":"16h","label":"16 hours","minutes":960},{"key":"1d","label":"1 day","minutes":1440},{"key":"3d","label":"3 days","minutes":4320},{"key":"7d","label":"7 days","minutes":10080}],"session_limit":{"default":false,"key":"16h","label":"16 hours","minutes":960},"staff_cap":false,"trust_lowered":true,"two_factor_trust":{"applies":true,"default":false,"key":"16h","label":"16 hours","minutes":960}},"schema":{"allOf":[{"$ref":"#/components/schemas/AccountSecuritySignInSettings"},{"properties":{"trust_lowered":{"description":"Whether the two-factor trust was lowered to follow the session limit down.","type":"boolean"}},"required":["trust_lowered"],"type":"object"}]}}},"description":"Your sign-in limits as they are now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FeatureOff"},"409":{"content":{"application/json":{"example":{"code":"confirmation_required","confirm_url":"https://manage.corefinity.com/profile?session_limit=3d&two_factor_trust=1d&from=api#sessions","message":"Confirm it's you in the Control Panel to stay signed in longer.","reason":"confirmation_required"},"schema":{"allOf":[{"$ref":"#/components/schemas/Refusal"},{"properties":{"confirm_url":{"description":"Your profile's Sessions section, with the requested values chosen and the confirmation open.","format":"uri","type":"string"}},"required":["confirm_url"],"type":"object"}]}}},"description":"The change would lengthen a limit (`confirmation_required`). Nothing was saved. Open `confirm_url` in a\nbrowser to confirm it in the Control Panel.\n"},"422":{"content":{"application/json":{"examples":{"invalid":{"summary":"Not one of the choices","value":{"code":"invalid","errors":{"session_limit":["Choose 8 hours, 16 hours, 1 day, 3 days or 7 days."]},"field":"session_limit","message":"Choose 8 hours, 16 hours, 1 day, 3 days or 7 days.","reason":"invalid"}},"trust_above_session_limit":{"summary":"A trust longer than the session limit","value":{"code":"trust_above_session_limit","message":"A trusted browser can't skip the code for longer than you stay signed in.","reason":"trust_above_session_limit"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A value that is not one of the choices, or no value at all (`invalid`), or a two-factor trust longer than\nthe session limit (`trust_above_session_limit`).\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update your sign-in limits","tags":["Account security"],"x-effect":["changes-settings"],"x-feature":"account-security","x-file":"account-security","x-gates":["sign_in_limits"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/user/sign-out-everywhere":{"post":{"description":"Ends every browser session of yours and forgets every trusted browser, so each browser signs in again with\nyour two-factor code. API tokens (the one that makes this request included), MCP connections and display\nlinks keep working. Limited to 5 a minute, beside the API's 60 requests a minute.\n","operationId":"signOutEverywhere","responses":{"200":{"content":{"application/json":{"example":{"trusted_devices_removed":2},"schema":{"additionalProperties":false,"properties":{"trusted_devices_removed":{"description":"How many trusted browsers were forgotten.","type":"integer"}},"required":["trusted_devices_removed"],"type":"object"}}},"description":"Every browser session has ended."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests","description":"More than 5 sign-outs, or 60 API requests in a minute (`rate_limited` for each). Wait for the number of seconds in `Retry-After`."}},"summary":"Sign out of every browser","tags":["Account security"],"x-effect":["deletes"],"x-feature":"account-security","x-file":"account-security","x-gates":["sign_in_limits"],"x-rate-limit":{"also":[{"bucket":"api","limit":60,"minutes":1,"per":"person"}],"bucket":"account-sign-out-everywhere","limit":5,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/user/ssh":{"get":{"description":"Answers your personal keys, your SSH username and the environments it reaches. The first read issues your\nusername when your account can have one; `reason` says why not when it cannot.\n","operationId":"getOwnSsh","responses":{"200":{"content":{"application/json":{"examples":{"me":{"$ref":"#/components/examples/SshPersonalKeysExample"}},"schema":{"$ref":"#/components/schemas/SshPersonalKeys"}}},"description":"Your keys and username."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FeatureOff","description":"SSH keys are not on for your account (`feature_off`)."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get your own SSH keys","tags":["SSH keys"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-rate-limit":{"bucket":"ssh-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/user/trusted-devices":{"get":{"description":"The browsers that skip your two-factor code when you sign in, newest first. A browser is listed until its\ntrust runs out or you remove it.\n","operationId":"listTrustedDevices","responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-11-09T10:15:00+00:00","current":false,"id":"01jc8z3k5m7n9p2q4r6s8t0v1w","label":"Chrome on macOS","last_used_at":"2026-11-09T16:40:00+00:00","last_used_ip":"203.0.113.9","trusted_until":"2026-11-09T18:15:00+00:00"}]},"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AccountSecurityTrustedDevice"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"Your trusted browsers."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List your trusted browsers","tags":["Account security"],"x-feature":"account-security","x-file":"account-security","x-gates":["sign_in_limits"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/user/trusted-devices/{device}":{"parameters":[{"description":"The `id` of one of your trusted browsers, as the list gives it.","example":"01jc8z3k5m7n9p2q4r6s8t0v1w","in":"path","name":"device","required":true,"schema":{"type":"string"}}],"delete":{"description":"Removes one of your trusted browsers: it is signed out on its next request and asked for your two-factor\ncode at its next sign-in. A browser that is not yours, or is already removed, answers the same `404` as an id\nthat does not exist.\n","operationId":"deleteTrustedDevice","responses":{"204":{"description":"The browser is no longer trusted. No body."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFoundOrFeatureOff"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a trusted browser","tags":["Account security"],"x-effect":["deletes"],"x-feature":"account-security","x-file":"account-security","x-gates":["sign_in_limits"],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/user/{id}/delete":{"parameters":[{"$ref":"#/components/parameters/TeamUserId"}],"delete":{"description":"Deletes the member's account. For somebody who has not accepted yet, this cancels the invitation and its link\nstops working. The company's last owner and its only user cannot be removed. You need to be an owner or hold\nthe `deleteUsers` permission.\n","operationId":"deleteTeamUser","responses":{"200":{"content":{"application/json":{"example":{"data":{"company_id":"1204","email":"tom.harbour@harbourandfinch.example.com","id":"2042","mobile":null,"name":"Tom Harbour","role":[{"name":"Member (Full Access)","permissions":["viewWebsites","viewDeployments","viewTickets","createTickets"],"slug":"client-member-full"}]},"message":"User has been deleted successfully","status":"success"},"schema":{"$ref":"#/components/schemas/TeamUserAnswer"}}},"description":"The member who was removed."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"You may not delete users","value":{"code":"forbidden","message":"You are not allowed to delete users.","reason":"forbidden","status":"error"}},"last_owner":{"summary":"The company's last owner","value":{"code":"last_owner","message":"The company should have at least one owner.","reason":"last_owner","status":"error"}},"only_user":{"summary":"The company's only user","value":{"code":"only_user","message":"You cannot delete this user because it is the only user in the company.","reason":"only_user","status":"error"}},"privileged_target":{"summary":"The account is not yours to change","value":{"code":"privileged_target","message":"You are not allowed to change this account.","reason":"privileged_target","status":"error"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/TeamRefusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), you may not delete users (`forbidden`), the account\nis not yours to change (`privileged_target`), the member is the company's last owner (`last_owner`) or its\nonly user (`only_user`).\n"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Delete a team member","tags":["Team"],"x-effect":["deletes"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/user/{id}/resend-invite":{"parameters":[{"$ref":"#/components/parameters/TeamUserId"}],"post":{"description":"Emails the invitation again, also after it has expired. Each re-send makes a new link, and the link in an\nearlier email stops working. You need to be an owner or hold the `inviteUsers` permission.\n","operationId":"resendTeamInvitation","responses":{"200":{"content":{"application/json":{"example":{"data":{"company_id":"1204","email":"rosa.whitlock@harbourandfinch.example.com","id":"2044","mobile":null,"name":"Rosa Whitlock","role":[{"name":"Member (Full Access)","permissions":["viewWebsites","viewDeployments","viewTickets","createTickets"],"slug":"client-member-full"}]},"message":"The invite has been resent successfully.","status":"success"},"schema":{"$ref":"#/components/schemas/TeamUserAnswer"}}},"description":"The invitation was sent again."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"already_active":{"summary":"The person has already accepted","value":{"code":"already_active","message":"You cannot invite this user because it is already active.","reason":"already_active","status":"error"}},"forbidden":{"summary":"The invitation is for another company","value":{"code":"forbidden","message":"You are not allowed to invite this user.","reason":"forbidden","status":"error"}},"privileged_target":{"summary":"The account is not yours to change","value":{"code":"privileged_target","message":"You are not allowed to change this account.","reason":"privileged_target","status":"error"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/TeamRefusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), you may not invite users or may not invite this one\ninto the company the invitation is for (`forbidden`), the account is not yours to re-invite\n(`privileged_target`), or the person has already accepted (`already_active`).\n"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/json":{"examples":{"gone":{"summary":"The company no longer exists","value":{"code":"invite_company_gone","message":"The company this user was invited to no longer exists, so the invitation cannot be sent again.","reason":"invite_company_gone","status":"error"}},"not_active":{"summary":"The company is not active","value":{"code":"invite_company_gone","message":"The company this user was invited to is not active, or is not the company they belong to, so the invitation cannot be sent again.","reason":"invite_company_gone","status":"error"}}},"schema":{"$ref":"#/components/schemas/TeamRefusal"}}},"description":"The company the invitation was for no longer exists, is not active, or is not the company the person\nbelongs to (`invite_company_gone`). The message says which.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"content":{"application/json":{"example":{"message":"Failed to invite again user","status":"error"},"schema":{"$ref":"#/components/schemas/LegacyRefusal"}}},"description":"The invitation could not be sent again."}},"summary":"Send an invitation again","tags":["Team"],"x-effect":["sends"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/user/{id}/update":{"parameters":[{"$ref":"#/components/parameters/TeamUserId"}],"post":{"description":"Changes a member's name, role, position and notification preferences. `name`, `email` and `role` are always\nsent; a preference you leave out stays as it is. Only the role you may give is replaced; other roles the member\nholds stay. A new `email` for somebody else is never saved: the member is emailed to say you asked, the rest of\nthe update saves, and `email_change` says so. You need to be an owner or hold the `editUsers` permission.\n","operationId":"updateTeamUser","requestBody":{"content":{"application/json":{"examples":{"ask_new_email":{"summary":"Ask the member to change their address","value":{"email":"t.harbour@harbourandfinch.example.com","name":"Tom Harbour","role":"client-member-full"}},"role_and_position":{"summary":"Change the role and the position","value":{"email":"tom.harbour@harbourandfinch.example.com","name":"Tom Harbour","position":"Developer","role":"client-member-limited","subscribe_to_newsletters":false}}},"schema":{"$ref":"#/components/schemas/TeamUserUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"member_asked":{"summary":"The member was asked to change their address","value":{"data":{"company_id":"1204","email":"tom.harbour@harbourandfinch.example.com","id":"2042","mobile":null,"name":"Tom Harbour","role":[{"name":"Member (Full Access)","permissions":["viewWebsites","viewDeployments","viewTickets","createTickets"],"slug":"client-member-full"}]},"email_change":{"message":"Only the member can change their sign-in email address, on their Profile page. We have emailed them to say you asked.","requested_email":"t.harbour@harbourandfinch.example.com","status":"member_asked"},"message":"User has been updated successfully","status":"success"}},"updated":{"summary":"The member was updated","value":{"data":{"company_id":"1204","email":"tom.harbour@harbourandfinch.example.com","id":"2042","mobile":null,"name":"Tom Harbour","role":[{"name":"Member (Limited Access)","permissions":["viewWebsites","viewTickets","createTickets"],"slug":"client-member-limited"}]},"email_change":null,"message":"User has been updated successfully","status":"success"}}},"schema":{"$ref":"#/components/schemas/TeamUserUpdateAnswer"}}},"description":"The member as saved. `email_change` is null unless the update asked for a new address."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"You may not edit users","value":{"code":"forbidden","message":"You are not allowed to edit users.","reason":"forbidden","status":"error"}},"last_owner":{"summary":"The company would have no owner","value":{"code":"last_owner","message":"The company should have at least one owner.","reason":"last_owner","status":"error"}},"owner_grant":{"summary":"Making somebody an owner","value":{"code":"owner_grant","message":"Only an owner or Corefinity staff can make someone an owner.","reason":"owner_grant","status":"error"}},"permission_grant":{"summary":"The role carries a permission you do not hold","value":{"code":"permission_grant","message":"You can only give someone a role if you hold all of its permissions yourself.","reason":"permission_grant","status":"error"}},"privileged_target":{"summary":"The account is not yours to change","value":{"code":"privileged_target","message":"You are not allowed to change this account.","reason":"privileged_target","status":"error"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/TeamRefusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), you may not edit users (`forbidden`), the account is\nnot yours to change (`privileged_target`: an owner's, unless you are an owner of the same company), the\nchange would leave the company without an owner (`last_owner`), only an owner or Corefinity staff can make\nsomebody an owner (`owner_grant`), or the role carries a permission you do not hold (`permission_grant`).\n"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"content":{"application/json":{"examples":{"own_address":{"summary":"A new address for yourself","value":{"code":"invalid","errors":{"email":["Change your own email address on your Profile page, where the new address is confirmed before it is used."]},"field":"email","message":"Change your own email address on your Profile page, where the new address is confirmed before it is used.","reason":"invalid"}},"pending_invitee":{"summary":"A new address for somebody who has not accepted","value":{"code":"invalid","errors":{"email":["They have not accepted their invitation yet, so its address cannot be changed. Remove them from the team to cancel the invitation, then invite them again at the right address."]},"field":"email","message":"They have not accepted their invitation yet, so its address cannot be changed. Remove them from the team to cancel the invitation, then invite them again at the right address.","reason":"invalid"}},"role":{"summary":"The role does not exist","value":{"code":"invalid","errors":{"role":["The selected role is invalid."]},"field":"role","message":"The selected role is invalid.","reason":"invalid"}},"too_many_asks":{"summary":"Too many requests for the same member to change their address","value":{"code":"invalid","errors":{"email":["You have asked this member to change their email address too many times. Try again later."]},"field":"email","message":"You have asked this member to change their email address too many times. Try again later.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`). On `email`: a new address for yourself (change it on your Profile\npage), a new address for somebody who has not accepted their invitation, or too many requests for the same\nmember to change their address.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Update a team member","tags":["Team"],"x-effect":["changes-settings","sends"],"x-feature":"team","x-file":"team","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}},"/websites":{"get":{"description":"Answers every website of the companies you can see, in one list with no paging.","operationId":"listWebsites","responses":{"200":{"content":{"application/json":{"example":{"websites":[{"company_id":"1204","id":"1310","name":"Harbour & Finch trade","url":"https://trade.harbourandfinch.example.com"}]},"schema":{"properties":{"websites":{"items":{"$ref":"#/components/schemas/LegacyWebsite"},"type":"array"}},"required":["websites"],"type":"object"}}},"description":"The websites."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List websites","tags":["Websites and environments"],"x-feature":"enterprise-websites","x-file":"websites","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/websites/{website}":{"parameters":[{"$ref":"#/components/parameters/website"}],"get":{"description":"Answers one website by its id.","operationId":"getWebsite","responses":{"200":{"content":{"application/json":{"example":{"website":{"company_id":"1204","id":"1310","name":"Harbour & Finch trade","url":"https://trade.harbourandfinch.example.com"}},"schema":{"properties":{"website":{"$ref":"#/components/schemas/LegacyWebsite"}},"required":["website"],"type":"object"}}},"description":"The website."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a website","tags":["Websites and environments"],"x-feature":"enterprise-websites","x-file":"websites","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/websites/{website}/environments":{"parameters":[{"$ref":"#/components/parameters/website"}],"get":{"description":"Answers the environments of one website.","operationId":"listWebsiteEnvironments","responses":{"200":{"content":{"application/json":{"example":{"environments":[{"access_server":null,"id":"1311","name":"Production","platform":{"id":"1","name":"Magento 2","slug":"magento2"},"platform_id":"1","type":4,"type_description":"Production","url":"https://trade.harbourandfinch.example.com","website_id":"1310"}]},"schema":{"properties":{"environments":{"items":{"$ref":"#/components/schemas/LegacyEnvironment"},"type":"array"}},"required":["environments"],"type":"object"}}},"description":"The environments."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a website's environments","tags":["Websites and environments"],"x-feature":"enterprise-websites","x-file":"websites","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/websites/{website}/environments/{environment}":{"parameters":[{"$ref":"#/components/parameters/website"},{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers one environment of a website. An environment of another website is not found.","operationId":"getWebsiteEnvironment","responses":{"200":{"content":{"application/json":{"example":{"environment":{"access_server":null,"id":"1311","name":"Production","platform":{"id":"1","name":"Magento 2","slug":"magento2"},"platform_id":"1","type":4,"type_description":"Production","url":"https://trade.harbourandfinch.example.com","website_id":"1310"}},"schema":{"properties":{"environment":{"$ref":"#/components/schemas/LegacyEnvironment"}},"required":["environment"],"type":"object"}}},"description":"The environment."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a website's environment","tags":["Websites and environments"],"x-feature":"enterprise-websites","x-file":"websites","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/websites/{website}/environments/{environment}/deployment-pipelines":{"parameters":[{"$ref":"#/components/parameters/website"},{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers the deployment pipelines of one environment of a website. The answer is the same as\n`GET /environments/{environment}/deployment-pipelines`; an environment that is not the website's is not found.\n","operationId":"listWebsiteEnvironmentDeploymentPipelines","responses":{"200":{"content":{"application/json":{"examples":{"pipelines":{"$ref":"#/components/examples/EnterprisePipelineListExample"}},"schema":{"$ref":"#/components/schemas/EnterprisePipelineList"}}},"description":"The environment's pipelines."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List an environment's pipelines by website","tags":["Enterprise deployments"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/websites/{website}/environments/{environment}/deployments":{"parameters":[{"$ref":"#/components/parameters/website"},{"$ref":"#/components/parameters/environment"}],"get":{"description":"Answers every deployment of one environment of a website, oldest first. The list is not paged; to page it,\nuse `GET /environments/{environment}/deployments`.\n","operationId":"listWebsiteEnvironmentDeployments","responses":{"200":{"content":{"application/json":{"examples":{"all":{"$ref":"#/components/examples/EnterpriseDeploymentListExample"}},"schema":{"$ref":"#/components/schemas/EnterpriseDeploymentList"}}},"description":"Every deployment of the environment, oldest first."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List an environment's deployments by website","tags":["Enterprise deployments"],"x-feature":"enterprise-deployments","x-file":"deployments","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/websites/{website}/firewall":{"parameters":[{"$ref":"#/components/parameters/website"}],"get":{"description":"Answers the addresses and presets that reach the website, its own and those of its company and agency (`layer`\nsays which), and its environments with the state of the firewall on each.\n","operationId":"getWebsiteFirewall","responses":{"200":{"content":{"application/json":{"examples":{"website":{"$ref":"#/components/examples/FirewallWebsiteViewExample"}},"schema":{"$ref":"#/components/schemas/FirewallWebsiteView"}}},"description":"The website's addresses."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a website's firewall","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/websites/{website}/firewall/activity":{"parameters":[{"$ref":"#/components/parameters/website"}],"get":{"description":"Answers the changes to the website's own addresses and presets, newest first. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.","operationId":"listWebsiteFirewallActivity","parameters":[{"$ref":"#/components/parameters/firewallCursor"}],"responses":{"200":{"content":{"application/json":{"examples":{"activity":{"$ref":"#/components/examples/FirewallActivityPageExample"}},"schema":{"$ref":"#/components/schemas/FirewallActivityPage"}}},"description":"A page of activity."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/FirewallNotFound"},"422":{"$ref":"#/components/responses/FirewallInvalidQuery"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List a website's firewall activity","tags":["Firewall"],"x-feature":"firewall","x-file":"firewall","x-gates":["firewall.api"],"x-rate-limit":{"bucket":"firewall-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/websites/{website}/ssh":{"parameters":[{"$ref":"#/components/parameters/website"}],"get":{"description":"Answers the keys held at the website, the keys it inherits from its company and agency, and its environments\nwith the state of each one's keys.\n","operationId":"getWebsiteSsh","responses":{"200":{"content":{"application/json":{"examples":{"website":{"$ref":"#/components/examples/SshWebsiteKeysExample"}},"schema":{"$ref":"#/components/schemas/SshWebsiteKeys"}}},"description":"The website's keys."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/SshNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get a website's SSH keys","tags":["SSH keys"],"x-feature":"ssh-keys","x-file":"ssh","x-gates":["sshkeys.api"],"x-rate-limit":{"bucket":"ssh-api-read","limit":120,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/whats-new":{"get":{"description":"Answers the released change log entries and announcements you may read, newest first, as the What's new? page\nof the Control Panel lists them. Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.\n","operationId":"listWhatsNew","parameters":[{"description":"Keeps the entries of one category.","in":"query","name":"type","required":false,"schema":{"$ref":"#/components/schemas/WhatsNewType"}},{"description":"`1` keeps the entries you have not read yet. `0` (the default) lists every entry. Only `1` and `0` are taken: the words `true` and `false` are refused `422` on `unseen`.","example":"1","in":"query","name":"unseen","required":false,"schema":{"enum":["0","1"],"type":"string"}},{"description":"Items a page: 1 to 50, default 10.","example":10,"in":"query","name":"limit","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"}},{"description":"The `next_cursor` of the previous answer. Anything that is not a whole number is refused `422` on `cursor`.","in":"query","name":"cursor","required":false,"schema":{"pattern":"^[1-9][0-9]{0,18}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"items":[{"content_html":"<h4>New features</h4><ul><li><strong>What's new in the API.</strong> Read the release notes with an access token.</li></ul>","content_text":"New features\nWhat's new in the API. Read the release notes with an access token.","id":4120,"published_on":"2026-11-09","seen":false,"title":"Release notes, 9 November 2026","type":"new_feature","type_label":"New feature"},{"content_html":"<p>Site lists load sooner.</p>","content_text":"Site lists load sooner.","id":4090,"published_on":"2026-11-02","seen":false,"title":"Faster site lists","type":"improvement","type_label":"Improvement"}],"next_cursor":null}},"schema":{"$ref":"#/components/schemas/WhatsNewListAnswer"}}},"description":"One page of entries."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"422":{"content":{"application/json":{"examples":{"cursor":{"summary":"A cursor the list did not give","value":{"code":"invalid","errors":{"cursor":["The cursor format is invalid."]},"field":"cursor","message":"The cursor format is invalid.","reason":"invalid"}},"limit":{"summary":"A limit above 50","value":{"code":"invalid","errors":{"limit":["The limit may not be greater than 50."]},"field":"limit","message":"The limit may not be greater than 50.","reason":"invalid"}},"type":{"summary":"A type that is not a category","value":{"code":"invalid","errors":{"type":["The selected type is invalid."]},"field":"type","message":"The selected type is invalid.","reason":"invalid"}},"unseen":{"summary":"The word true where 1 is meant","value":{"code":"invalid","errors":{"unseen":["The unseen field must be true or false."]},"field":"unseen","message":"The unseen field must be true or false.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A parameter is not valid: a `type` that is not a category, a `limit` outside 1 to 50, a `cursor` that is\nnot one, or an `unseen` that is not `1` or `0`. `field` names it.\n"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"List what's new","tags":["What's new"],"x-feature":"whats-new","x-file":"whats-new","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/whats-new/seen":{"post":{"description":"Marks up to 50 entries as read for you, so the What's new pop-up of the Control Panel no longer opens with\nthem; sending the same request again changes nothing. Every id must be an entry you may read: if one is not,\nnothing is marked and the answer is `404`.\n","operationId":"markWhatsNewSeen","requestBody":{"content":{"application/json":{"examples":{"two_entries":{"summary":"Mark two entries as read","value":{"announcement_ids":[4120,4090]}}},"schema":{"$ref":"#/components/schemas/WhatsNewMarkSeen"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"seen":[4120,4090],"unseen":3}},"schema":{"$ref":"#/components/schemas/WhatsNewSeenAnswer"}}},"description":"The entries are read now."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired","description":"The token lacks the `write` scope (`scope_required`)."},"404":{"$ref":"#/components/responses/NotFound","description":"One of the ids is not an entry you may read, or does not exist. Nothing was marked."},"422":{"content":{"application/json":{"examples":{"missing":{"summary":"No ids","value":{"code":"invalid","errors":{"announcement_ids":["The announcement ids field is required."]},"field":"announcement_ids","message":"The announcement ids field is required.","reason":"invalid"}},"not_an_id":{"summary":"An id that is not a whole number above zero","value":{"code":"invalid","errors":{"announcement_ids.0":["The announcement_ids.0 must be at least 1."]},"field":"announcement_ids.0","message":"The announcement_ids.0 must be at least 1.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`announcement_ids` is missing, empty, longer than 50 or holds something that is not an id. `field` names it."},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Mark entries as read","tags":["What's new"],"x-effect":["changes-settings"],"x-feature":"whats-new","x-file":"whats-new","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"write","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/whats-new/{announcement}":{"parameters":[{"description":"The id of an entry, as the list answers it. Digits only.","example":4120,"in":"path","name":"announcement","required":true,"schema":{"minimum":1,"type":"integer"}}],"get":{"description":"Answers one entry in the shape of a list item. An entry you may not read answers exactly as an id that does\nnot exist.\n","operationId":"getWhatsNewEntry","responses":{"200":{"content":{"application/json":{"example":{"data":{"content_html":"<h4>New features</h4><ul><li><strong>What's new in the API.</strong> Read the release notes with an access token.</li></ul>","content_text":"New features\nWhat's new in the API. Read the release notes with an access token.","id":4120,"published_on":"2026-11-09","seen":false,"title":"Release notes, 9 November 2026","type":"new_feature","type_label":"New feature"}},"schema":{"$ref":"#/components/schemas/WhatsNewEntryAnswer"}}},"description":"The entry."},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/ScopeRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"summary":"Get one entry","tags":["What's new"],"x-feature":"whats-new","x-file":"whats-new","x-gates":[],"x-rate-limit":{"bucket":"api","limit":60,"minutes":1},"x-scope":"read","x-scope-extra":[],"x-try-it":"on","x-two-factor":"none"}},"/{provider}/webhooks/environments/{environment}/repositories/{repository}":{"parameters":[{"description":"The git provider that delivers the push.","example":"github","in":"path","name":"provider","required":true,"schema":{"enum":["github","gitlab","bitbucket"],"type":"string"}},{"description":"The id of the CoreStack Enterprise environment the repository deploys to.","example":1311,"in":"path","name":"environment","required":true,"schema":{"minimum":1,"type":"integer"}},{"description":"The id of the environment's repository, as the Control Panel lists it.","example":4471,"in":"path","name":"repository","required":true,"schema":{"minimum":1,"type":"integer"}}],"post":{"description":"You do not call this endpoint. When you add a repository to an environment that deploys automatically, the\nControl Panel installs a webhook at your git provider that points here, with a secret of its own, and a push\nto the branch the repository deploys starts a deployment. A delivery is verified by the provider's signature\nover the exact bytes of the body, never by a token.\n\nEvery delivery to a repository that exists is answered `204` with no body, whether or not it started a\ndeployment, so the answer does not say what was done with it: read the repository in the Control Panel to\nsee whether your deliveries arrive. Limited to 120 a minute for one repository and to 600 a minute from one\naddress.\n","operationId":"receiveGitPushWebhook","requestBody":{"content":{"application/json":{"examples":{"github_push":{"summary":"A GitHub push to main","value":{"after":"abc123def456789012345678901234567890abcd","before":"9999999999999999999999999999999999999999","head_commit":{"author":{"name":"Daniel Reyes"},"id":"abc123def456789012345678901234567890abcd","message":"Add the autumn sale banner"},"pusher":{"name":"danielreyes"},"ref":"refs/heads/main","repository":{"full_name":"northwind-digital/harbourandfinch"}}}},"schema":{"additionalProperties":true,"description":"A push event of GitHub, GitLab or Bitbucket. The Control Panel reads the branch, the commit and its message, and who pushed.","type":"object"}}},"description":"The provider's own push payload, as it sends it, with its own event and delivery headers. The provider\nsigns each delivery with the hook's secret, and each signs it its own way:\n\n- GitHub sends `X-Hub-Signature-256` and Bitbucket `X-Hub-Signature`: `sha256=` and the hex HMAC-SHA256 of\n  the body alone.\n- GitLab sends `webhook-id`, `webhook-timestamp` and `webhook-signature`. What is signed is the id, a full\n  stop, the timestamp, a full stop and the body (`<webhook-id>.<webhook-timestamp>.<body>`); the signature\n  is `v1,` and the base64 of that HMAC-SHA256, made with the decoded signing key (the base64 after `whsec_`\n  in the secret; a secret without that prefix is the key as it is). Several signatures may be sent, separated by spaces. A delivery whose timestamp is more\n  than five minutes from the Control Panel's clock is not acted on.\n- A GitLab instance that cannot sign is verified by its `X-Gitlab-Token`.\n\nA body of more than 1 MiB is not acted on.\nThe example is a GitHub push, cut down to what the Control Panel reads.\n","required":true},"responses":{"204":{"description":"Received. No body, whatever the Control Panel did with the delivery; a delivery that is sent twice is acted on once."},"404":{"$ref":"#/components/responses/NotFound","description":"A delivery that verified names an environment that does not exist. A delivery whose signature does not verify is answered `204` like any other, whether or not its ids exist."},"429":{"$ref":"#/components/responses/TooManyRequests","description":"Too many deliveries for this repository or from this address in a minute (`rate_limited`, with `Retry-After`). The provider delivers again later."}},"security":[],"summary":"Receive a push from a git provider","tags":["Webhooks"],"x-effect":["runs-code"],"x-feature":"git-webhooks","x-file":"git-webhooks","x-gates":[],"x-rate-limit":{"also":[{"bucket":"git-webhooks","limit":600,"minutes":1,"per":"address"}],"bucket":"git-webhooks","limit":120,"minutes":1},"x-scope-extra":[],"x-try-it":"off","x-two-factor":"none"}}},"components":{"examples":{"AttachDomainStarted":{"summary":"The attach, just started","value":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-06T09:16:41Z","environment":{"env_id":"rs-harbourandfinch-example-org","hostname":"example-org-example.cfstack.io","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":77142,"label":"Saved to the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":5021,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"harbourandfinch.example.org","id":1042},"status":"pending","status_label":"Saving change","step":"committed","steps":[{"key":"checks","label":"DNS checked","state":"done"},{"key":"committed","label":"Saved to the platform","state":"current"},{"key":"rolled","label":"Change applied","state":"todo"},{"key":"rewritten","label":"Site URL updated","state":"todo"},{"key":"certificate","label":"Certificate issued","state":"todo"},{"key":"live","label":"Domain attached","state":"todo"}],"summary":"Attach www.harbourandfinch.example.org","to_version":null,"type":"attach_domain","type_label":"Attach domain"}},"AutoUpgradesOnExample":{"summary":"On, with a limit of 250.00 a month and one upgrade made","value":{"active":true,"available":true,"can_change":true,"can_turn_off":true,"company_id":1180,"consented_at":"2026-11-02T09:12:44Z","currency":"GBP","enabled":true,"max_monthly_limit":{"amount":"100000.00","currency":"GBP"},"max_purchases_per_month":20,"month":"2026-11","monthly_limit":{"amount":"250.00","currency":"GBP"},"purchases_this_month":1,"recent":[{"at":"2026-11-09T14:03:27Z","cluster_id":1017,"kind":"cluster_addons","monthly_delta":{"amount":"18.00","currency":"GBP"},"operation_id":5120,"state":"bought","summary":"1 core and 2 GB of RAM added"}],"remaining_this_month":{"amount":"232.00","currency":"GBP"},"spent_this_month":{"amount":"18.00","currency":"GBP"},"unavailable_reason":null}},"BillingAccountConflictExample":{"summary":"account and account_id name different accounts","value":{"code":"invalid","errors":{"account_id":["Send account or account_id, not both: they name different billing accounts."]},"field":"account_id","message":"Send account or account_id, not both: they name different billing accounts.","reason":"invalid"}},"BillingAccountExample":{"summary":"An account with a card, one CoreCluster and an open invoice","value":{"address":{"city":"Manchester","country":"GB","line1":"14 Quay Street","line2":null,"postcode":"M1 1AA"},"auto_charge":true,"backup_method":null,"balance":{"accrued_this_period":{"amount":"337.10","currency":"GBP"},"balance":{"amount":"1057.10","currency":"GBP"},"credits_available":{"amount":"25.00","currency":"GBP"},"currency":"GBP","last_accrual_at":null,"lines":[{"accrued":{"amount":"337.10","currency":"GBP"},"contract_line":{"id":9001,"kind":"package","label":"CC8"},"hourly":{"amount":"0.806452","currency":"GBP"},"hours":418,"monthly":{"amount":"600.00","currency":"GBP"}}],"next_invoice_at":"2027-02-01T00:30:00Z","outstanding":{"amount":"720.00","currency":"GBP"},"period":{"end":"2027-02-01T00:00:00Z","start":"2027-01-01T00:00:00Z"},"recent_activity":[{"amount":{"amount":"337.10","currency":"GBP"},"contract_id":5120,"currency":"GBP","kind":"usage_mtd","product":"CC8 · Northwind UK 1","through":null},{"amount":{"amount":"25.00","currency":"GBP"},"at":"2027-01-12T14:20:00Z","description":"Credit granted · Goodwill credit","invoice":null,"kind":"credit_grant"},{"amount":{"amount":"720.00","currency":"GBP"},"at":"2027-01-01T00:30:00Z","description":"Invoice CF-100057","invoice":{"id":8140,"number":"CF-100057"},"kind":"invoice"},{"amount":{"amount":"-660.00","currency":"GBP"},"at":"2026-12-01T00:31:12Z","description":"Payment for CF-100042","invoice":{"id":8123,"number":"CF-100042"},"kind":"payment"},{"amount":{"amount":"-60.00","currency":"GBP"},"at":"2026-12-01T00:30:00Z","description":"Credit applied to CF-100042","invoice":{"id":8123,"number":"CF-100042"},"kind":"credit_applied"},{"amount":{"amount":"720.00","currency":"GBP"},"at":"2026-12-01T00:30:00Z","description":"Invoice CF-100042","invoice":{"id":8123,"number":"CF-100042"},"kind":"invoice"},{"amount":{"amount":"50.00","currency":"GBP"},"at":"2026-11-01T09:00:00Z","description":"Credit granted · Welcome credit","invoice":null,"kind":"credit_grant"}]},"billing_contacts":[{"email":"maya.okafor@northwind-digital.example.com","id":2051,"name":"Maya Okafor","role":"owner"}],"billing_email":"accounts@northwind-digital.example.com","billing_name":"Northwind Digital Ltd","company":{"id":1180,"name":"Northwind Digital"},"contracts":[{"contract":{"billing_model":"metered","billing_period":"monthly","billing_starts":"started","billing_starts_at":"2026-11-01T01:00:00Z","billing_starts_note":null,"first_billed_at":"2027-01-01T00:00:00Z","id":5120,"money_back":null,"reference":"MC-1180-1","starts_on":"2026-11-01","status":"active","trial_ends_at":null},"hourly":{"amount":"0.806452","currency":"GBP"},"id":9001,"kind":"package","label":"CC8 · Northwind UK 1","modifiers":[],"monthly":{"amount":"600.00","currency":"GBP"},"product":{"line":"cc","region":"United Kingdom","server_type":"Standard"},"quantity":1,"since":"2026-11-01T01:00:00Z","subject":{"href":"/managed-clusters/clusters/1017","ref":{"id":1017,"name":"Northwind UK 1"},"type":"cluster"},"unit":null,"until":null}],"countries":[{"code":"GB","name":"United Kingdom"},{"code":"IE","name":"Ireland"},{"code":"US","name":"United States"}],"currency":"GBP","currency_locked":false,"default_method":{"added_at":"2026-11-01T09:05:00Z","brand":"visa","exp_month":12,"exp_year":2030,"id":4410,"kind":"card","label":null,"last4":"4242","provider":"stripe","role":"primary","state":"active","wallet":null},"demos":[],"id":3107,"is_default":true,"mandate":null,"monthly_total":{"amount":"600.00","currency":"GBP"},"name":"Northwind Digital's default billing account","next_invoice":{"estimate":{"amount":"937.10","currency":"GBP"},"issues_at":"2027-02-01T00:30:00Z","period_end":"2027-02-01T00:00:00Z","trial":false},"po_reference":"PO-2027-014","rights":{"can_edit":true,"can_pay":false,"can_view":true,"reason":null},"trial":null,"vat":{"buyer":null,"check":null,"country":"GB","kind":"standard","label":"UK VAT 20 %","rate_percent":20,"validation":{"state":"none","validated_at":null}},"vat_number":null,"version":1184934486}},"BillingBalanceExample":{"summary":"Seventeen days into the month, with one open invoice","value":{"accrued_this_period":{"amount":"337.10","currency":"GBP"},"balance":{"amount":"1057.10","currency":"GBP"},"credits_available":{"amount":"25.00","currency":"GBP"},"currency":"GBP","last_accrual_at":null,"lines":[{"accrued":{"amount":"337.10","currency":"GBP"},"contract_line":{"id":9001,"kind":"package","label":"CC8"},"hourly":{"amount":"0.806452","currency":"GBP"},"hours":418,"monthly":{"amount":"600.00","currency":"GBP"}}],"next_invoice_at":"2027-02-01T00:30:00Z","outstanding":{"amount":"720.00","currency":"GBP"},"period":{"end":"2027-02-01T00:00:00Z","start":"2027-01-01T00:00:00Z"},"recent_activity":[{"amount":{"amount":"337.10","currency":"GBP"},"contract_id":5120,"currency":"GBP","kind":"usage_mtd","product":"CC8 · Northwind UK 1","through":null},{"amount":{"amount":"25.00","currency":"GBP"},"at":"2027-01-12T14:20:00Z","description":"Credit granted · Goodwill credit","invoice":null,"kind":"credit_grant"},{"amount":{"amount":"720.00","currency":"GBP"},"at":"2027-01-01T00:30:00Z","description":"Invoice CF-100057","invoice":{"id":8140,"number":"CF-100057"},"kind":"invoice"},{"amount":{"amount":"-660.00","currency":"GBP"},"at":"2026-12-01T00:31:12Z","description":"Payment for CF-100042","invoice":{"id":8123,"number":"CF-100042"},"kind":"payment"},{"amount":{"amount":"-60.00","currency":"GBP"},"at":"2026-12-01T00:30:00Z","description":"Credit applied to CF-100042","invoice":{"id":8123,"number":"CF-100042"},"kind":"credit_applied"},{"amount":{"amount":"720.00","currency":"GBP"},"at":"2026-12-01T00:30:00Z","description":"Invoice CF-100042","invoice":{"id":8123,"number":"CF-100042"},"kind":"invoice"},{"amount":{"amount":"50.00","currency":"GBP"},"at":"2026-11-01T09:00:00Z","description":"Credit granted · Welcome credit","invoice":null,"kind":"credit_grant"}]}},"BillingCatalogueExample":{"summary":"The CoreCluster line, shortened to two of each list","value":{"addons":[{"key":"core","label":"Extra core","max":16,"monthly":{"amount":"45.00","currency":"GBP"},"step":1,"unit":"core","unit_prices":{"cc":{"general":"45.000000","optimised":"54.000000"},"cs":{"general":"45.000000","optimised":"54.000000"}}},{"key":"memory_gb","label":"Extra memory","max":64,"monthly":{"amount":"5.00","currency":"GBP"},"step":1,"unit":"GB","unit_prices":{"cc":{"general":"5.000000","optimised":"6.000000"},"cs":{"general":"5.000000","optimised":"6.000000"}}}],"compute_optimised":{"available":true,"label":"Performance","product_lines":{"cc":{"available":true,"reason":null}},"reason":null},"currency":"GBP","hidden":[],"modifiers":[{"applies_to":["cs","cc"],"key":"compute_optimised","label":"Performance","scope":"compute_family","value_percent":"20"},{"applies_to":["cs","cc"],"key":"region_uk","label":"United Kingdom","scope":"region","value_percent":"0"}],"packages":[{"code":"CC4","cores":4,"disk_gb":200,"included_uat":null,"key":"cc4","log_quota_gb":250,"log_retention_days":90,"memory_gib":16,"money_back_days":0,"monthly":{"amount":"300.00","currency":"GBP"},"monthly_optimised":{"amount":"360.00","currency":"GBP"},"name":"CoreCluster CC4","platforms_allowed":["wordpress","laravel","magento2"],"product_line":"cc","tiers":["S","M","L"],"trial_days":0},{"code":"CC6","cores":6,"disk_gb":300,"included_uat":null,"key":"cc6","log_quota_gb":300,"log_retention_days":90,"memory_gib":24,"money_back_days":0,"monthly":{"amount":"450.00","currency":"GBP"},"monthly_optimised":{"amount":"540.00","currency":"GBP"},"name":"CoreCluster CC6","platforms_allowed":["wordpress","laravel","magento2"],"product_line":"cc","tiers":["S","M","L"],"trial_days":0}],"platform":null,"region":"uk","uat_sizes":[{"cores":0.5,"disk_gb":20,"key":"xsmall","label":"Extra small","memory_gib":2,"monthly":{"amount":"40.00","currency":"GBP"}},{"cores":1,"disk_gb":50,"key":"small","label":"Small","memory_gib":4,"monthly":{"amount":"75.00","currency":"GBP"}}],"vat":{"country":"GB","kind":"standard","rate_percent":20}}},"BillingContractLinesExample":{"summary":"One CoreCluster on CC8","value":[{"contract":{"billing_model":"metered","billing_period":"monthly","billing_starts":"started","billing_starts_at":"2026-11-01T01:00:00Z","billing_starts_note":null,"first_billed_at":"2027-01-01T00:00:00Z","id":5120,"money_back":null,"reference":"MC-1180-1","starts_on":"2026-11-01","status":"active","trial_ends_at":null},"hourly":{"amount":"0.806452","currency":"GBP"},"id":9001,"kind":"package","label":"CC8 · Northwind UK 1","modifiers":[],"monthly":{"amount":"600.00","currency":"GBP"},"product":{"line":"cc","region":"United Kingdom","server_type":"Standard"},"quantity":1,"since":"2026-11-01T01:00:00Z","subject":{"href":"/managed-clusters/clusters/1017","ref":{"id":1017,"name":"Northwind UK 1"},"type":"cluster"},"unit":null,"until":null}]},"BillingCreditsExample":{"summary":"One credit with something left and one applied to an invoice","value":[{"amount":{"amount":"25.00","currency":"GBP"},"applications":[],"expires_at":"2027-12-31T00:00:00Z","granted_at":"2027-01-12T14:20:00Z","id":311,"public_note":"Goodwill credit","remaining":{"amount":"25.00","currency":"GBP"},"state":"available"},{"amount":{"amount":"50.00","currency":"GBP"},"applications":[{"amount":{"amount":"50.00","currency":"GBP"},"at":"2026-12-01T00:30:00Z","invoice":{"id":8123,"number":"CF-100042"}}],"expires_at":null,"granted_at":"2026-11-01T09:00:00Z","id":310,"public_note":"Welcome credit","remaining":{"amount":"0.00","currency":"GBP"},"state":"applied"}]},"BillingInvoiceExample":{"summary":"A paid invoice with a credit applied","value":{"account":{"company":{"id":1180,"name":"Northwind Digital"},"id":3107},"amount_due":{"amount":"660.00","currency":"GBP"},"credit_notes":[{"amount":{"amount":"50.00","currency":"GBP"},"kind":"applied_credit","number":"CN-CF-100042","pdf_href":"/billing/invoices/8123/credit-notes/CN-CF-100042/pdf"}],"credit_tax_amount":{"amount":"10.00","currency":"GBP"},"credits":[{"amount":{"amount":"50.00","currency":"GBP"},"credit":{"id":310,"public_note":"Welcome credit"}}],"credits_applied":{"amount":"50.00","currency":"GBP"},"currency":"GBP","due_at":"2026-12-01T00:30:00Z","id":8123,"issued_at":"2026-12-01T00:30:00Z","lines":[{"amount":{"amount":"600.00","currency":"GBP"},"contract_line":{"id":9001,"kind":"package","label":"CC8 · Northwind UK 1"},"description":"CC8 · Northwind UK 1","id":61020,"period":{"end":"2026-12-01T00:00:00Z","start":"2026-11-01T00:00:00Z"},"quantity":"720","unit":"hour","unit_price":{"amount":"0.833333","currency":"GBP"}}],"next_collection_at":null,"number":"CF-100042","paid_at":"2026-12-01T00:31:12Z","payment_terms_days":0,"payments":[{"attempt":{"amount":{"amount":"660.00","currency":"GBP"},"attempt_no":1,"failure":null,"id":7731,"mandate":null,"method":{"added_at":"2026-11-01T09:05:00Z","brand":"visa","exp_month":12,"exp_year":2030,"id":4410,"kind":"card","label":null,"last4":"4242","provider":"stripe","role":"primary","state":"active","wallet":null},"provider":"stripe","refunded":null,"scheduled_for":null,"settled_at":"2026-12-01T00:31:12Z","started_at":"2026-12-01T00:31:00Z","state":"succeeded"}}],"pdf":{"available":true},"period":{"end":"2026-12-01T00:00:00Z","start":"2026-11-01T00:00:00Z"},"status":"paid","status_label":"Paid","subtotal":{"amount":"600.00","currency":"GBP"},"tax":{"amount":{"amount":"120.00","currency":"GBP"},"kind":"standard","note":null,"rate_percent":20},"total":{"amount":"720.00","currency":"GBP"}}},"BillingInvoicePageExample":{"summary":"Two invoices with their lines","value":{"items":[{"account":{"company":{"id":1180,"name":"Northwind Digital"},"id":3107},"amount_due":{"amount":"720.00","currency":"GBP"},"credit_notes":[],"credit_tax_amount":{"amount":"0.00","currency":"GBP"},"credits":[],"credits_applied":{"amount":"0.00","currency":"GBP"},"currency":"GBP","due_at":"2027-01-15T00:30:00Z","id":8140,"issued_at":"2027-01-01T00:30:00Z","lines":[{"amount":{"amount":"600.00","currency":"GBP"},"contract_line":{"id":9001,"kind":"package","label":"CC8 · Northwind UK 1"},"description":"CC8 · Northwind UK 1","id":61020,"period":{"end":"2027-01-01T00:00:00Z","start":"2026-12-01T00:00:00Z"},"quantity":"744","unit":"hour","unit_price":{"amount":"0.806452","currency":"GBP"}}],"next_collection_at":null,"number":"CF-100057","paid_at":null,"payment_terms_days":14,"payments":[],"pdf":{"available":false},"period":{"end":"2027-01-01T00:00:00Z","start":"2026-12-01T00:00:00Z"},"status":"open","status_label":"Open","subtotal":{"amount":"600.00","currency":"GBP"},"tax":{"amount":{"amount":"120.00","currency":"GBP"},"kind":"standard","note":null,"rate_percent":20},"total":{"amount":"720.00","currency":"GBP"}},{"account":{"company":{"id":1180,"name":"Northwind Digital"},"id":3107},"amount_due":{"amount":"660.00","currency":"GBP"},"credit_notes":[{"amount":{"amount":"50.00","currency":"GBP"},"kind":"applied_credit","number":"CN-CF-100042","pdf_href":"/billing/invoices/8123/credit-notes/CN-CF-100042/pdf"}],"credit_tax_amount":{"amount":"10.00","currency":"GBP"},"credits":[{"amount":{"amount":"50.00","currency":"GBP"},"credit":{"id":310,"public_note":"Welcome credit"}}],"credits_applied":{"amount":"50.00","currency":"GBP"},"currency":"GBP","due_at":"2026-12-01T00:30:00Z","id":8123,"issued_at":"2026-12-01T00:30:00Z","lines":[{"amount":{"amount":"600.00","currency":"GBP"},"contract_line":{"id":9001,"kind":"package","label":"CC8 · Northwind UK 1"},"description":"CC8 · Northwind UK 1","id":61020,"period":{"end":"2026-12-01T00:00:00Z","start":"2026-11-01T00:00:00Z"},"quantity":"720","unit":"hour","unit_price":{"amount":"0.833333","currency":"GBP"}}],"next_collection_at":null,"number":"CF-100042","paid_at":"2026-12-01T00:31:12Z","payment_terms_days":0,"payments":[{"attempt":{"amount":{"amount":"660.00","currency":"GBP"},"attempt_no":1,"failure":null,"id":7731,"mandate":null,"method":{"added_at":"2026-11-01T09:05:00Z","brand":"visa","exp_month":12,"exp_year":2030,"id":4410,"kind":"card","label":null,"last4":"4242","provider":"stripe","role":"primary","state":"active","wallet":null},"provider":"stripe","refunded":null,"scheduled_for":null,"settled_at":"2026-12-01T00:31:12Z","started_at":"2026-12-01T00:31:00Z","state":"succeeded"}}],"pdf":{"available":true},"period":{"end":"2026-12-01T00:00:00Z","start":"2026-11-01T00:00:00Z"},"status":"paid","status_label":"Paid","subtotal":{"amount":"600.00","currency":"GBP"},"tax":{"amount":{"amount":"120.00","currency":"GBP"},"kind":"standard","note":null,"rate_percent":20},"total":{"amount":"720.00","currency":"GBP"}}],"next_cursor":null,"total":2}},"BillingLedgerExample":{"summary":"The invoices in the ledger","value":{"items":[{"amount":{"amount":"720.000000","currency":"GBP"},"contract_line":null,"credit":null,"description":"Invoice CF-100057","id":88410,"invoice":{"id":8140,"number":"CF-100057"},"occurred_at":"2027-01-01T00:30:00Z","period":null,"type":"invoice"},{"amount":{"amount":"720.000000","currency":"GBP"},"contract_line":null,"credit":null,"description":"Invoice CF-100042","id":88403,"invoice":{"id":8123,"number":"CF-100042"},"occurred_at":"2026-12-01T00:30:00Z","period":null,"type":"invoice"}],"next_cursor":null}},"BillingPaymentMethodsExample":{"summary":"One card, charged first","value":{"cards":{"can_add":true,"max":2},"default":"card","mandate":null,"methods":[{"added_at":"2026-11-01T09:05:00Z","blocked":{"backup":"primary_required","primary":null,"remove":"last_method"},"brand":"visa","exp_month":12,"exp_year":2030,"id":4410,"kind":"card","label":null,"last4":"4242","provider":"stripe","role":"primary","state":"active","wallet":null}],"rights":{"can_edit":true,"can_pay":false,"can_view":true,"reason":null}}},"BillingQuoteExample":{"summary":"A CoreCluster moving from CC8 to CC12","value":{"applies":"now","currency":"GBP","effective_from":"2027-01-18T11:00:00Z","expires_at":"2027-01-18T10:30:00Z","id":"c798dc86-3497-421e-a481-91bac3c92fd9","lines":[{"after":{"amount":"900.00","currency":"GBP"},"before":{"amount":"600.00","currency":"GBP"},"delta":{"amount":"300.00","currency":"GBP"},"key":"package","label":"Package: CC8 → CC12"}],"monthly_after":{"amount":"900.00","currency":"GBP"},"monthly_before":{"amount":"600.00","currency":"GBP"},"monthly_delta":{"amount":"300.00","currency":"GBP"},"prorata":{"amount":{"amount":"131.05","currency":"GBP"},"from":"2027-01-18T11:00:00Z","hours":325,"to":"2027-02-01T00:00:00Z"},"tax":{"amount":{"amount":"60.00","currency":"GBP"},"kind":"standard","note":"UK VAT 20 %","rate_percent":20},"trial":null}},"BillingStandingFinalNoticeExample":{"summary":"A final notice has been sent for one invoice","value":{"cases":[{"currency":"GBP","delete_on":null,"disputed":false,"due_at":"2026-11-01T00:00:00Z","final_notice_at":"2026-11-07T06:00:00Z","invoice_id":8140,"number":"CF-100057","outstanding":240,"overdue_days":8,"retrieval_until":null,"stage":"final_notice","suspend_on":"2026-11-16T10:00:00Z","suspended_at":null,"terminate_on":null,"terminated_at":null}],"paused_until":null,"restore":{"how":"none"},"state":"final_notice","suspended_services":[]}},"BillingUsageExample":{"summary":"January so far, the first three days shown","value":{"credits_applied":[],"currency":"GBP","days":[{"amount":{"amount":"19.35","currency":"GBP"},"day":"2027-01-01"},{"amount":{"amount":"19.35","currency":"GBP"},"day":"2027-01-02"},{"amount":{"amount":"19.35","currency":"GBP"},"day":"2027-01-03"}],"lines":[{"amount":{"amount":"337.10","currency":"GBP"},"contract_line":{"id":9001,"kind":"package","label":"CC8 · Northwind UK 1"},"days":[{"amount":{"amount":"19.35","currency":"GBP"},"day":"2027-01-01","hours":24},{"amount":{"amount":"19.35","currency":"GBP"},"day":"2027-01-02","hours":24},{"amount":{"amount":"19.35","currency":"GBP"},"day":"2027-01-03","hours":24}],"hours":418}],"month":"2027-01","total":{"amount":"337.10","currency":"GBP"}}},"CloudflareConnected":{"summary":"A connected account with one zone","value":{"can_change":true,"company":{"id":1204,"name":"Harbour & Finch"},"connect":{"instructions":["Open the token form in Cloudflare. It opens with the permissions the Control Panel needs already chosen."],"url":"https://dash.cloudflare.com/profile/api-tokens"},"connected_by":{"id":5021,"name":"Eleanor Finch"},"last_error":null,"method":"api_token","scopes":{"missing":[],"required":["Zone:Read","DNS:Edit","Cache Purge:Purge","Zone Settings:Read","Zone Settings:Edit"]},"status":"connected","status_label":"Connected","token_id":"c0ffee000000000000000000f1c7e912","token_last4":"0000","unmapped_sites":[],"verified_at":"2026-11-02T12:02:30Z","zones":[{"dns01":null,"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"harbourandfinch.example.com","permissions":{"cache_purge":true,"dns_edit":true,"zone_settings":true},"plan":"Free","refreshed_at":"2026-11-06T03:00:14Z","sites":[{"mapping":"auto","site":{"domain":"harbourandfinch.example.com","id":1042}}],"ssl_mode":"full","ssl_ok":false,"ssl_recommended":"strict","status":"active"}]}},"CloudflareDisconnected":{"summary":"The connection after it was removed","value":{"connection":{"can_change":true,"company":{"id":1204,"name":"Harbour & Finch"},"connect":{"instructions":["Delete the token in Cloudflare as well. The Control Panel cannot revoke it."],"url":"https://dash.cloudflare.com/profile/api-tokens"},"connected_by":null,"last_error":null,"method":"api_token","scopes":{"missing":[],"required":["Zone:Read","DNS:Edit","Cache Purge:Purge","Zone Settings:Read","Zone Settings:Edit"]},"status":"not_connected","status_label":"Not connected","token_id":null,"token_last4":null,"unmapped_sites":[{"domain":"harbourandfinch.example.com","id":1042}],"verified_at":null,"zones":[]}}},"CloudflareZoneSslSet":{"summary":"The zone, now Full (strict)","value":{"zone":{"dns01":null,"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"harbourandfinch.example.com","permissions":{"cache_purge":true,"dns_edit":true,"zone_settings":true},"plan":"Free","refreshed_at":"2026-11-06T09:19:48Z","sites":[{"mapping":"auto","site":{"domain":"harbourandfinch.example.com","id":1042}}],"ssl_mode":"strict","ssl_ok":true,"ssl_recommended":"strict","status":"active"}}},"ClusterAcceptedExample":{"summary":"A create whose first step is still being confirmed","value":{"cluster":{"actions":{"create_environment":{"available":false,"reason":"This cluster is still being created"},"create_site":{"available":false,"reason":"This cluster is still being created"},"delete":{"available":false,"reason":"This cluster is still being created"},"upgrade_package":{"available":false,"downgrade":false,"reason":"This cluster is still being created"}},"allowance":{"cpu_millicores":4000,"disk_bytes":214748364800,"memory_bytes":17179869184},"capacity":{"basis":"estimate","cpu":{"capacity_millicores":4000,"level":"ok","percent":0,"used_p95_millicores":0},"evaluated_at":null,"level":"ok","memory":{"capacity_bytes":17179869184,"level":"ok","percent":0,"used_p95_bytes":0},"package":{"cores":4,"key":"xsmall","memory_bytes":17179869184,"name":"Extra small"},"sites":{"count":0,"environments":0},"storage":{"capacity_bytes":214748364800,"level":"ok","percent":0,"provisioned_bytes":0}},"created_at":"2026-11-14T10:00:00Z","created_by":{"id":2041,"name":"Eleanor Finch"},"environments":0,"id":1018,"kind":"customer","label":"Northwind UK 2","location":{"arch":"arm64","label":"London (europe-west2)"},"logs":null,"name":"Northwind UK 2","operation":{"id":5130,"scope":"cluster","status":"pending","status_label":"Saving change","summary":"New cluster","to_version":null,"type":"cluster_create","type_label":"New cluster"},"package":{"cores":4,"key":"xsmall","name":"Extra small"},"pending_changes":{"count":0,"window_starts_at":null},"ready_at":null,"region":{"key":"uk","label":"United Kingdom","place":"London (europe-west2)"},"reserved":{"cpu_limit_millicores":0,"cpu_request_millicores":0,"disk_bytes":0,"memory_limit_bytes":0,"memory_request_bytes":0},"sites":{"applying":0,"degraded":0,"down":0,"environments":0,"healthy":0,"live":0,"preview":0,"total":0,"unknown":0},"slug":"northwind-uk-2","snapshots":{"frequency":"6h","over_quota":false,"pruned_recently":false,"quota_bytes":429496729600,"retention_days":30,"usage_bytes":null},"ssh_host":"ssh-northwind-uk-2.example.net","state":"creating","state_label":"Creating","state_reason":null,"synced":{"inventory_at":"2026-11-14T10:00:00Z","live_at":null,"usage_at":null},"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1018,"name":"Northwind UK 2"},"committed_at":null,"completed_at":null,"created_at":"2026-11-14T10:00:00Z","environment":null,"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5130,"install":null,"label":"Requested","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"cluster","site":null,"status":"pending","status_label":"Preparing the cluster","step":"requested","steps":[{"key":"requested","label":"Requested","state":"current"},{"key":"gateway_ready","label":"SSH gateway ready","state":"todo"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New cluster","to_version":null,"type":"cluster_create","type_label":"New cluster"},"sites":[]}},"ClusterActivityExample":{"summary":"One page with one item","value":{"items":[{"actor":{"id":2041,"name":"Eleanor Finch"},"at":"2026-11-14T09:12:00Z","cluster":{"id":1017,"name":"Northwind UK 1"},"environment":null,"href":"/managed-clusters/sites/1042#activity","id":"operation:5120","kind":"operation","origin":"panel","ref":{"id":5120,"type":"operation"},"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"completed","status_label":"Done","summary":"Scheduled tasks","title":"Scheduled tasks","unfinished":false}],"next_before":null,"next_before_id":null}},"ClusterAnswerExample":{"summary":"A CoreCluster with one site","value":{"cluster":{"actions":{"create_environment":{"available":true,"reason":null},"create_site":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"upgrade_package":{"available":true,"downgrade":false,"reason":null}},"allowance":{"cpu_millicores":4000,"disk_bytes":214748364800,"memory_bytes":17179869184},"capacity":{"basis":"p95","cpu":{"capacity_millicores":4000,"level":"ok","percent":6,"used_p95_millicores":240},"evaluated_at":"2026-11-14T09:50:00Z","level":"ok","memory":{"capacity_bytes":17179869184,"level":"ok","percent":6,"used_p95_bytes":1073741824},"package":{"cores":4,"key":"xsmall","memory_bytes":17179869184,"name":"Extra small"},"sites":{"count":1,"environments":0},"storage":{"capacity_bytes":214748364800,"level":"ok","percent":5,"provisioned_bytes":10737418240}},"created_at":"2026-11-02T08:14:00Z","created_by":{"id":2041,"name":"Eleanor Finch"},"environments":0,"id":1017,"kind":"customer","label":"Northwind UK 1","location":{"arch":"arm64","label":"London (europe-west2)"},"logs":null,"name":"Northwind UK 1","operation":null,"package":{"cores":4,"key":"xsmall","name":"Extra small"},"pending_changes":{"count":0,"window_starts_at":null},"ready_at":"2026-11-02T08:19:00Z","region":{"key":"uk","label":"United Kingdom","place":"London (europe-west2)"},"reserved":{"cpu_limit_millicores":2000,"cpu_request_millicores":100,"disk_bytes":10737418240,"memory_limit_bytes":4294967296,"memory_request_bytes":536870912},"sites":{"applying":0,"degraded":0,"down":0,"environments":0,"healthy":1,"live":1,"preview":0,"total":1,"unknown":0},"slug":"northwind-uk-1","snapshots":{"frequency":"6h","over_quota":false,"pruned_recently":false,"quota_bytes":429496729600,"retention_days":30,"usage_bytes":1288490188},"ssh_host":"ssh-northwind.example.net","state":"ready","state_label":"Ready","state_reason":null,"synced":{"inventory_at":"2026-11-14T09:55:00Z","live_at":"2026-11-14T09:58:00Z","usage_at":"2026-11-14T09:55:00Z"},"usage":{"cpu_millicores":180,"disk_used_bytes":2362232012,"memory_bytes":912261120,"observed_at":"2026-11-14T09:58:00Z","source":"live"}},"sites":[{"compute_family":"general","domain":"harbourandfinch.example.com","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environment_count":0,"environments":[{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"healthy","hosting":{"cluster_kind":"customer","label":"CoreCluster Northwind UK 1"},"id":1042,"kind":"corecluster","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"mariadb":{"version":"11.8"},"mode":"production","mode_label":"Domain attached","operation":null,"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://harbourandfinch-example-com.northwind.cfstack.example.net","primary_url":"https://harbourandfinch.example.com","removed":false,"restore":null,"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":"rs-northwind-harbourandfinch-example-com","snapshots":{"count":2,"effective_frequency":"6h","effective_label":"Every 6 hours","latest":null,"latest_ready_at":"2026-11-14T06:05:00Z","next_scheduled_at":"2026-11-14T12:05:00Z","overridden":false,"stored_gb":1.2},"tier":"S","uat_size":null,"usage":{"cpu_millicores":180,"disk_used_bytes":2362232012,"memory_bytes":912261120,"observed_at":"2026-11-14T09:58:00Z","source":"live"}}]}},"ClusterCapacityExample":{"summary":"One more small WordPress site fits the CoreCluster","value":{"added":{"cpu_millicores":150,"disk_bytes":10737418240,"environments":0,"memory_bytes":805306368,"sites":1},"blocking":[],"cluster":{"id":1017,"name":"Northwind UK 1"},"current":{"basis":"p95","cpu":{"capacity_millicores":4000,"level":"ok","percent":6,"used_p95_millicores":240},"evaluated_at":"2026-11-14T09:50:00Z","level":"ok","memory":{"capacity_bytes":17179869184,"level":"ok","percent":6,"used_p95_bytes":1073741824},"package":{"cores":4,"key":"xsmall","memory_bytes":17179869184,"name":"Extra small"},"sites":{"count":1,"environments":0},"storage":{"capacity_bytes":214748364800,"level":"ok","percent":5,"provisioned_bytes":10737418240}},"evaluated_at":"2026-11-14T09:50:00Z","ok":true,"package":{"key":"xsmall","name":"Extra small"},"projected":{"basis":"mixed","cpu":{"capacity_millicores":4000,"level":"ok","percent":9,"used_p95_millicores":390},"evaluated_at":"2026-11-14T09:50:00Z","level":"ok","memory":{"capacity_bytes":17179869184,"level":"ok","percent":10,"used_p95_bytes":1879048192},"package":{"cores":4,"key":"xsmall","memory_bytes":17179869184,"name":"Extra small"},"sites":{"count":2,"environments":0},"storage":{"capacity_bytes":214748364800,"level":"ok","percent":10,"provisioned_bytes":21474836480}},"warnings":[]}},"ClusterCreatedExample":{"summary":"A new CoreCluster with no first sites","value":{"cluster":{"actions":{"create_environment":{"available":false,"reason":"This cluster is still being created"},"create_site":{"available":false,"reason":"This cluster is still being created"},"delete":{"available":false,"reason":"This cluster is still being created"},"upgrade_package":{"available":false,"downgrade":false,"reason":"This cluster is still being created"}},"allowance":{"cpu_millicores":4000,"disk_bytes":214748364800,"memory_bytes":17179869184},"capacity":{"basis":"estimate","cpu":{"capacity_millicores":4000,"level":"ok","percent":0,"used_p95_millicores":0},"evaluated_at":null,"level":"ok","memory":{"capacity_bytes":17179869184,"level":"ok","percent":0,"used_p95_bytes":0},"package":{"cores":4,"key":"xsmall","memory_bytes":17179869184,"name":"Extra small"},"sites":{"count":0,"environments":0},"storage":{"capacity_bytes":214748364800,"level":"ok","percent":0,"provisioned_bytes":0}},"created_at":"2026-11-14T10:00:00Z","created_by":{"id":2041,"name":"Eleanor Finch"},"environments":0,"id":1018,"kind":"customer","label":"Northwind UK 2","location":{"arch":"arm64","label":"London (europe-west2)"},"logs":null,"name":"Northwind UK 2","operation":{"id":5130,"scope":"cluster","status":"committed","status_label":"Waiting for the platform","summary":"New cluster","to_version":null,"type":"cluster_create","type_label":"New cluster"},"package":{"cores":4,"key":"xsmall","name":"Extra small"},"pending_changes":{"count":0,"window_starts_at":null},"ready_at":null,"region":{"key":"uk","label":"United Kingdom","place":"London (europe-west2)"},"reserved":{"cpu_limit_millicores":0,"cpu_request_millicores":0,"disk_bytes":0,"memory_limit_bytes":0,"memory_request_bytes":0},"sites":{"applying":0,"degraded":0,"down":0,"environments":0,"healthy":0,"live":0,"preview":0,"total":0,"unknown":0},"slug":"northwind-uk-2","snapshots":{"frequency":"6h","over_quota":false,"pruned_recently":false,"quota_bytes":429496729600,"retention_days":30,"usage_bytes":null},"ssh_host":"ssh-northwind-uk-2.example.net","state":"creating","state_label":"Creating","state_reason":null,"synced":{"inventory_at":"2026-11-14T10:00:00Z","live_at":null,"usage_at":null},"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1018,"name":"Northwind UK 2"},"committed_at":"2026-11-14T10:00:01Z","completed_at":null,"created_at":"2026-11-14T10:00:00Z","environment":null,"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5130,"install":null,"label":"SSH gateway ready","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"cluster","site":null,"status":"committed","status_label":"Publishing the SSH gateway","step":"gateway_ready","steps":[{"key":"requested","label":"Requested","state":"done"},{"key":"gateway_ready","label":"SSH gateway ready","state":"current"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New cluster","to_version":null,"type":"cluster_create","type_label":"New cluster"},"sites":[]}},"ClusterDeleteAcceptedExample":{"summary":"The deletion has started","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-14T10:00:00Z","environment":null,"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5140,"install":null,"label":"Sites removed","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"cluster","site":null,"status":"pending","status_label":"Removing the sites, 1 site left","step":"sites_removed","steps":[{"key":"requested","label":"Requested","state":"done"},{"key":"sites_removed","label":"Sites removed","state":"current"},{"key":"snapshots_deleted","label":"Snapshots deleted","state":"todo"}],"subject":null,"summary":"Delete cluster","to_version":null,"type":"cluster_delete","type_label":"Delete cluster"}}},"ClusterDeletionExample":{"summary":"A CoreCluster with one site and two snapshots","value":{"cluster":{"id":1017,"name":"Northwind UK 1","ssh_host":"ssh-northwind.example.net"},"empty":false,"kept_snapshots":{"bytes":0,"count":0},"removed_sites_snapshots":{"bytes":0,"count":0},"sites":[{"deleted_at":null,"domain":"harbourandfinch.example.com","environments":[],"environments_more":0,"id":1042,"snapshots":{"bytes":1288490188,"count":2},"state":"live"}],"sites_more":0,"totals":{"deleted_sites":0,"domains":1,"environments":0,"mail_domains":0,"sites":1,"snapshot_bytes":1288490188,"snapshots":2}}},"ClusterListExample":{"summary":"One CoreCluster","value":{"can_create":{"available":true,"reason":null},"clusters":[{"actions":{"create_environment":{"available":true,"reason":null},"create_site":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"upgrade_package":{"available":true,"downgrade":false,"reason":null}},"allowance":{"cpu_millicores":4000,"disk_bytes":214748364800,"memory_bytes":17179869184},"capacity":{"basis":"p95","cpu":{"capacity_millicores":4000,"level":"ok","percent":6,"used_p95_millicores":240},"evaluated_at":"2026-11-14T09:50:00Z","level":"ok","memory":{"capacity_bytes":17179869184,"level":"ok","percent":6,"used_p95_bytes":1073741824},"package":{"cores":4,"key":"xsmall","memory_bytes":17179869184,"name":"Extra small"},"sites":{"count":1,"environments":0},"storage":{"capacity_bytes":214748364800,"level":"ok","percent":5,"provisioned_bytes":10737418240}},"created_at":"2026-11-02T08:14:00Z","created_by":{"id":2041,"name":"Eleanor Finch"},"environments":0,"id":1017,"kind":"customer","label":"Northwind UK 1","location":{"arch":"arm64","label":"London (europe-west2)"},"logs":null,"name":"Northwind UK 1","operation":null,"package":{"cores":4,"key":"xsmall","name":"Extra small"},"pending_changes":{"count":0,"window_starts_at":null},"ready_at":"2026-11-02T08:19:00Z","region":{"key":"uk","label":"United Kingdom","place":"London (europe-west2)"},"reserved":{"cpu_limit_millicores":2000,"cpu_request_millicores":100,"disk_bytes":10737418240,"memory_limit_bytes":4294967296,"memory_request_bytes":536870912},"sites":{"applying":0,"degraded":0,"down":0,"environments":0,"healthy":1,"live":1,"preview":0,"total":1,"unknown":0},"slug":"northwind-uk-1","snapshots":{"frequency":"6h","over_quota":false,"pruned_recently":false,"quota_bytes":429496729600,"retention_days":30,"usage_bytes":1288490188},"ssh_host":"ssh-northwind.example.net","state":"ready","state_label":"Ready","state_reason":null,"synced":{"inventory_at":"2026-11-14T09:55:00Z","live_at":"2026-11-14T09:58:00Z","usage_at":"2026-11-14T09:55:00Z"},"usage":{"cpu_millicores":180,"disk_used_bytes":2362232012,"memory_bytes":912261120,"observed_at":"2026-11-14T09:58:00Z","source":"live"}}],"generated_at":"2026-11-14T10:00:00+00:00"}},"ClusterLogsContextExample":{"summary":"A line with one line either side","value":{"after":[{"fields":{"level":"info","method":"GET","src":"nginx-access","status":200},"msg":"GET /basket/4 200","site":{"environment":"Production","id":1051,"label":"journal.harbourandfinch.example.com"},"source":"web-access","stream_id":"00000001000000003e23e8160039594a33894f6564e1b134","time":"2026-11-03T09:54:00Z"}],"before":[{"fields":{"level":"info","method":"GET","src":"nginx-access","status":200},"msg":"GET /basket/2 200","site":{"environment":"Production","id":1051,"label":"journal.harbourandfinch.example.com"},"source":"web-access","stream_id":"00000001000000003e23e8160039594a33894f6564e1b134","time":"2026-11-03T09:52:00Z"}],"line":{"fields":{"level":"info","method":"GET","src":"nginx-access","status":200},"msg":"GET /basket/3 200","site":{"environment":"Production","id":1051,"label":"journal.harbourandfinch.example.com"},"source":"web-access","stream_id":"00000001000000003e23e8160039594a33894f6564e1b134","time":"2026-11-03T09:53:00Z"}}},"ClusterLogsQueryExample":{"summary":"Lines of two sites","value":{"effective_query":"status:>=500","kind":"records","lines":[{"fields":{"level":"error","method":"GET","src":"nginx-access","status":502},"msg":"GET /checkout 502","site":{"environment":"Production","id":1042,"label":"harbourandfinch.example.com"},"source":"web-access","stream_id":"00000001000000006754af9632a2745e85c293e5aac08633","time":"2026-11-03T09:55:41.215Z"},{"fields":{"level":"error","method":"GET","src":"nginx-access","status":500},"msg":"GET /basket/3 500","site":{"environment":"Production","id":1051,"label":"journal.harbourandfinch.example.com"},"source":"web-access","stream_id":"00000001000000003e23e8160039594a33894f6564e1b134","time":"2026-11-03T09:53:00Z"}],"next_cursor":null,"stats":{"duration_ms":112},"table":null,"tenant":{"percent":8,"quota_gb":120,"retention_days":30,"state":"ok","stored_gb":10},"truncated":false,"warnings":[],"window":{"from":"2026-11-03T09:00:00.000000000Z","to":"2026-11-03T10:00:00.000000000Z"}}},"ClusterLogsSavedQueryExample":{"summary":"A query kept for one CoreCluster","value":{"can_delete":true,"cluster":{"id":1017,"name":"Northwind UK 1"},"created_at":"2026-11-03T10:00:00Z","filters":null,"id":3319,"name":"Checkout errors","query":"status:>=500","range":"24h","shared":false,"site":null,"source":"web-access"}},"ClusterLogsSavedQueryListExample":{"summary":"One query for the CoreCluster and one for everywhere","value":{"items":[{"can_delete":true,"cluster":{"id":1017,"name":"Northwind UK 1"},"created_at":"2026-11-03T10:00:00Z","filters":null,"id":3319,"name":"Checkout errors","query":"status:>=500","range":"24h","shared":false,"site":null,"source":"web-access"},{"can_delete":true,"created_at":"2026-11-01T14:31:07Z","filters":{"level":["warning","error"]},"id":3290,"name":"PHP warnings","query":null,"range":"7d","shared":false,"site":null,"source":"php"}]}},"ClusterLogsStreamsExample":{"summary":"The sources and sites of a CoreCluster","value":{"limits":{"max_limit":1000,"max_query_bytes":4096,"max_range_days":30,"queries_per_minute":150,"timeout_seconds":15},"ranges":["15m","1h","6h","24h","7d","30d"],"sites":[{"available":true,"environment":"Production","id":1042,"label":"harbourandfinch.example.com"},{"available":true,"environment":"Production","id":1051,"label":"journal.harbourandfinch.example.com"}],"sources":[{"available":true,"key":"all","label":"All","reason":null},{"available":true,"key":"web-access","label":"Web access","reason":null},{"available":true,"key":"web-error","label":"Web errors","reason":null},{"available":true,"key":"php","label":"PHP","reason":null},{"available":true,"key":"app","label":"Application","reason":null},{"available":true,"key":"cron","label":"Cron","reason":null},{"available":true,"key":"database","label":"Database","reason":null},{"available":true,"key":"cache","label":"Cache","reason":null},{"available":false,"key":"search","label":"Search","reason":"not_collected"},{"available":false,"key":"queue","label":"Queue","reason":"not_collected"}],"tenant":{"percent":8,"quota_gb":120,"retention_days":30,"state":"ok","stored_gb":10},"unpack_json":true}},"ClusterLogsUsageExample":{"summary":"A CoreCluster's usage, the last three of its 30 days shown","value":{"by_environment":[{"environment":{"env_id":"harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"percent":61,"stored_bytes":61000000000},{"environment":{"env_id":"journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},"percent":39,"stored_bytes":39400000000}],"daily":[{"day":"2026-11-01","ingested_bytes":12400000000,"rows":9800000,"stored_bytes":3100000000},{"day":"2026-11-02","ingested_bytes":12800000000,"rows":10100000,"stored_bytes":3200000000},{"day":"2026-11-03","ingested_bytes":5100000000,"rows":4000000,"stored_bytes":1270000000}],"forecast":{"days_to_quota":6,"next_enforce_at":"2026-11-04T02:00:00Z"},"percent":84,"quota":{"included_gb":100,"purchased_gb":20},"quota_gb":120,"retention_days":30,"stored_gb":100.4,"tenant":{"owner":{"ref":{"id":1017,"name":"Northwind UK 1"},"type":"corecluster"},"state":"warning"}}},"ClusterPackageCapacityExample":{"summary":"One small WordPress site fits the package","value":{"added":{"cpu_millicores":150,"disk_bytes":10737418240,"environments":0,"memory_bytes":805306368,"sites":1},"blocking":[],"cluster":null,"current":{"basis":"estimate","cpu":{"capacity_millicores":4000,"level":"ok","percent":0,"used_p95_millicores":0},"evaluated_at":null,"level":"ok","memory":{"capacity_bytes":17179869184,"level":"ok","percent":0,"used_p95_bytes":0},"package":{"cores":4,"key":"xsmall","memory_bytes":17179869184,"name":"Extra small"},"sites":{"count":0,"environments":0},"storage":{"capacity_bytes":214748364800,"level":"ok","percent":0,"provisioned_bytes":0}},"evaluated_at":"2026-11-14T10:00:00Z","ok":true,"package":{"key":"xsmall","name":"Extra small"},"projected":{"basis":"estimate","cpu":{"capacity_millicores":4000,"level":"ok","percent":3,"used_p95_millicores":150},"evaluated_at":null,"level":"ok","memory":{"capacity_bytes":17179869184,"level":"ok","percent":4,"used_p95_bytes":805306368},"package":{"cores":4,"key":"xsmall","memory_bytes":17179869184,"name":"Extra small"},"sites":{"count":1,"environments":0},"storage":{"capacity_bytes":214748364800,"level":"ok","percent":5,"provisioned_bytes":10737418240}},"warnings":[]}},"ClusterProgressExample":{"summary":"A create with no first sites, part of the way through","value":{"cluster":{"actions":{"create_environment":{"available":false,"reason":"This cluster is still being created"},"create_site":{"available":false,"reason":"This cluster is still being created"},"delete":{"available":false,"reason":"This cluster is still being created"},"upgrade_package":{"available":false,"downgrade":false,"reason":"This cluster is still being created"}},"allowance":{"cpu_millicores":4000,"disk_bytes":214748364800,"memory_bytes":17179869184},"capacity":{"basis":"estimate","cpu":{"capacity_millicores":4000,"level":"ok","percent":0,"used_p95_millicores":0},"evaluated_at":null,"level":"ok","memory":{"capacity_bytes":17179869184,"level":"ok","percent":0,"used_p95_bytes":0},"package":{"cores":4,"key":"xsmall","memory_bytes":17179869184,"name":"Extra small"},"sites":{"count":0,"environments":0},"storage":{"capacity_bytes":214748364800,"level":"ok","percent":0,"provisioned_bytes":0}},"created_at":"2026-11-14T10:00:00Z","created_by":{"id":2041,"name":"Eleanor Finch"},"environments":0,"id":1018,"kind":"customer","label":"Northwind UK 2","location":{"arch":"arm64","label":"London (europe-west2)"},"logs":null,"name":"Northwind UK 2","operation":{"id":5130,"scope":"cluster","status":"committed","status_label":"Waiting for the platform","summary":"New cluster","to_version":null,"type":"cluster_create","type_label":"New cluster"},"package":{"cores":4,"key":"xsmall","name":"Extra small"},"pending_changes":{"count":0,"window_starts_at":null},"ready_at":null,"region":{"key":"uk","label":"United Kingdom","place":"London (europe-west2)"},"reserved":{"cpu_limit_millicores":0,"cpu_request_millicores":0,"disk_bytes":0,"memory_limit_bytes":0,"memory_request_bytes":0},"sites":{"applying":0,"degraded":0,"down":0,"environments":0,"healthy":0,"live":0,"preview":0,"total":0,"unknown":0},"slug":"northwind-uk-2","snapshots":{"frequency":"6h","over_quota":false,"pruned_recently":false,"quota_bytes":429496729600,"retention_days":30,"usage_bytes":null},"ssh_host":"ssh-northwind-uk-2.example.net","state":"creating","state_label":"Creating","state_reason":null,"synced":{"inventory_at":"2026-11-14T10:00:00Z","live_at":null,"usage_at":null},"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}},"copy":null,"elapsed_seconds":42,"eta_seconds":null,"failed":null,"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1018,"name":"Northwind UK 2"},"committed_at":"2026-11-14T10:00:01Z","completed_at":null,"created_at":"2026-11-14T10:00:00Z","environment":null,"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5130,"install":null,"label":"SSH gateway ready","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"cluster","site":null,"status":"committed","status_label":"Publishing the SSH gateway","step":"gateway_ready","steps":[{"key":"requested","label":"Requested","state":"done"},{"key":"gateway_ready","label":"SSH gateway ready","state":"current"},{"key":"ready","label":"Ready","state":"todo"}],"subject":null,"summary":"New cluster","to_version":null,"type":"cluster_create","type_label":"New cluster"},"order":null,"retrying":null,"sites":[],"stages":[{"at":"2026-11-14T10:00:00+00:00","detail":null,"key":"requested","label":"Requested","state":"done"},{"at":null,"detail":null,"key":"gateway_ready","label":"SSH gateway ready","state":"current"},{"at":null,"detail":null,"key":"sites_scheduled","label":"Sites scheduled","state":"skipped"},{"at":null,"detail":null,"key":"images_pulled","label":"Images pulled","state":"skipped"},{"at":null,"detail":null,"key":"installing","label":"Installing","state":"skipped"},{"at":null,"detail":null,"key":"ready","label":"Ready","state":"todo"}]}},"ClusterUsageExample":{"summary":"Seven days, shortened to two steps","value":{"allowance":{"cpu_millicores":4000,"disk_bytes":214748364800,"memory_bytes":17179869184},"coverage":[[1794045600000,1,1],[1794049200000,1,1]],"cpu":{"limit":2000,"points":[[1794045600000,172,410],[1794049200000,180,395]],"request":100,"unit":"millicores"},"disk":{"points":[[1794045600000,2351746252,null],[1794049200000,2362232012,null]],"size":10737418240,"unit":"bytes"},"from":"2026-11-07T10:00:00Z","last_sample_at":"2026-11-14T09:55:00Z","memory":{"limit":4294967296,"points":[[1794045600000,901775360,955252736],[1794049200000,912261120,960495616]],"request":536870912,"unit":"bytes"},"range":"7d","step_seconds":3600,"to":"2026-11-14T10:00:00Z"}},"CompanyDeploySecretListExample":{"summary":"One Composer credential","value":{"can_share":true,"data":[{"auth_type":"bearer","id":318,"kind":"composer","label":"Example packages","last4":"oken","last_used_at":null,"registry":"repo.example.com","scope":"","shared_with_managed":false,"used_by":{"environments":1,"overridden_on":0},"verified_at":null}]}},"CompanyDeploySecretVerifiedExample":{"summary":"A credential the registry accepted","value":{"can_share":true,"data":[{"auth_type":"bearer","id":318,"kind":"composer","label":"Private packages","last4":"oken","last_used_at":null,"registry":"repo.example.com","scope":"","shared_with_managed":false,"used_by":{"environments":1,"overridden_on":0},"verified_at":"2026-11-09T10:42:07Z"}],"verification":{"id":318,"message":"The registry accepted these credentials.","verified":true,"verified_at":"2026-11-09T10:42:07Z"}}},"CompanyDeployVariableListExample":{"summary":"Two variables, one shared","value":{"can_share":true,"data":[{"masked":"••••••••.com","name":"API_URL","shared_with_managed":true,"tool_credential":null,"updated_at":"2026-11-09T10:42:07Z","updated_by":"Maya Okafor","used_by":{"environments":1,"not_set_on":0,"overridden_on":0}},{"masked":"••••••••cret","name":"SLACK_URL","shared_with_managed":false,"tool_credential":null,"updated_at":"2026-11-09T10:42:07Z","updated_by":"Maya Okafor","used_by":{"environments":1,"not_set_on":0,"overridden_on":0}}]}},"CompanyDeployVariableNameFormatExample":{"summary":"A name that is not in the expected format","value":{"code":"invalid","errors":{"name":["The name argument is not in the expected format."]},"field":"name","message":"Some arguments are not valid.","reason":"invalid"}},"CompanyOrderPageExample":{"summary":"Three orders: one being built, one completed, one expired","value":{"company":{"name":"Northwind Digital"},"counts":{"all":3,"completed":1,"ended":1,"failed":0,"open":1},"data":[{"continue_href":null,"created_at":"2027-01-18T09:31:00Z","ended_at":null,"id":4227,"label":"building","line":"cs","line_label":"CoreStack","mine":true,"name":"journal.harbourandfinch.example.com","package":"CS2","phase":"requesting","placed_at":"2027-01-18T09:40:00Z","placed_by":{"name":"Maya Okafor"},"platform":"WordPress","reason":"Placed · your site is being requested","region":{"key":"uk","label":"United Kingdom"},"restart_href":null,"status_href":"/order/status/4227","step":null,"step_label":null,"target":null,"trial_ends_at":null,"vat":{"check_open":false,"kind":null,"status":null}},{"continue_href":null,"created_at":"2027-01-10T10:48:00Z","ended_at":"2027-01-10T11:20:00Z","id":4218,"label":"completed","line":"cc","line_label":"CoreCluster","mine":true,"name":"Northwind UK 1","package":"CC8","phase":null,"placed_at":"2027-01-10T11:02:00Z","placed_by":{"name":"Maya Okafor"},"platform":null,"reason":"Completed on 10 Jan 2027","region":{"key":"uk","label":"United Kingdom"},"restart_href":null,"status_href":"/order/status/4218","step":null,"step_label":null,"target":{"href":"/managed-clusters/clusters/1017","kind":"cluster","name":"Northwind UK 1"},"trial_ends_at":null,"vat":{"check_open":false,"kind":null,"status":null}},{"continue_href":null,"created_at":"2027-01-04T08:00:00Z","ended_at":"2027-01-05T08:00:00Z","id":4209,"label":"expired","line":"cs","line_label":"CoreStack","mine":true,"name":"harbourandfinch.example.com","package":"CS2","phase":null,"placed_at":null,"placed_by":{"name":"Maya Okafor"},"platform":"WordPress","reason":"Not placed before it expired","region":{"key":"uk","label":"United Kingdom"},"restart_href":"/order?package=CS2&platform=wordpress&region=uk&currency=GBP&new=1","status_href":"/order/status/4209","step":null,"step_label":null,"target":null,"trial_ends_at":null,"vat":{"check_open":false,"kind":null,"status":null}}],"next_cursor":null,"placers":[{"id":2051,"name":"Maya Okafor"}],"start_href":"/order?new=1","total":3}},"CronSaveExample":{"summary":"A task was added","value":{"crons":{"apply":{"applied_at":"2026-11-04T14:12:31Z","error":null,"operation":{"id":77141,"scope":"site","status":"committed","status_label":"Waiting for the platform","summary":"3 cron entries, enabled","to_version":null,"type":"crons_change","type_label":"Scheduled tasks"},"state":"applying","state_label":"Applying"},"builtin":{"active":true,"command":"wp cron event run --due-now","enabled":true,"label":"WordPress cron","last_run":{"at":"2026-11-06T09:15:04Z","duration_s":4,"exit_code":0,"status":"ok"},"locked":true,"note":"Runs WordPress's scheduled events every 5 minutes. It runs only while Scheduled tasks are on. Built into the platform: you can switch it off or back on at any time, but not edit or remove it.","schedule":"*/5 * * * *","timeout":240,"toggleable":true},"enabled":true,"enabled_default":true,"entries":[{"command":"wp db export /tmp/db.sql","enabled":true,"id":12,"label":"Nightly database export","last_run":{"at":"2026-11-06T01:31:12Z","duration_s":72,"exit_code":0,"status":"ok"},"next_run_at":"2026-11-07T02:30:00+01:00","no_overlap":true,"position":1,"schedule":"30 2 * * *","schedule_label":"Daily at 02:30","timeout":3600},{"command":"wp transient delete --expired","enabled":false,"id":13,"label":"Clear expired transients","last_run":null,"next_run_at":null,"no_overlap":false,"position":2,"schedule":"0 */6 * * *","schedule_label":"Every 6 hours","timeout":900},{"command":"curl -s -o /dev/null https://www.harbourandfinch.example.com/","enabled":true,"id":14,"label":"Warm the cache","last_run":null,"next_run_at":"2026-11-06T10:30:00+01:00","no_overlap":true,"position":3,"schedule":"*/15 * * * *","schedule_label":"Every 15 minutes","timeout":900}],"limits":{"command_max":500,"entries_max":49,"label_max":60,"min_interval_seconds":60,"timeouts":[900,3600,21600]},"presets":[{"key":"every_minute","label":"Every minute","schedule":"* * * * *"},{"key":"every_5_minutes","label":"Every 5 minutes","schedule":"*/5 * * * *"},{"key":"every_15_minutes","label":"Every 15 minutes","schedule":"*/15 * * * *"},{"key":"hourly","label":"Hourly, on the hour","schedule":"0 * * * *"},{"key":"daily","label":"Daily at 03:00","schedule":"0 3 * * *"},{"key":"weekly","label":"Mondays at 03:00","schedule":"0 3 * * 1"},{"key":"monthly","label":"On the 1st of each month at 03:00","schedule":"0 3 1 * *"}],"runs":{"builtin":{"at":"2026-11-06T09:15:04Z","duration_s":4,"exit_code":0,"status":"ok"},"c12":{"at":"2026-11-06T01:31:12Z","duration_s":72,"exit_code":0,"status":"ok"}},"timezone":"Europe/London","version":8},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:14:04Z","completed_at":null,"created_at":"2026-11-06T09:14:02Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":true,"id":77141,"install":null,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":5021,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"current"},{"key":"live","label":"Live","state":"todo"}],"subject":null,"summary":"3 cron entries, enabled","to_version":null,"type":"crons_change","type_label":"Scheduled tasks"}}},"CronSaveUnchangedExample":{"summary":"Only a label changed","value":{"crons":{"apply":{"applied_at":"2026-11-04T14:12:31Z","error":null,"operation":null,"state":"applied","state_label":"Applied"},"builtin":{"active":true,"command":"wp cron event run --due-now","enabled":true,"label":"WordPress cron","last_run":{"at":"2026-11-06T09:15:04Z","duration_s":4,"exit_code":0,"status":"ok"},"locked":true,"note":"Runs WordPress's scheduled events every 5 minutes. It runs only while Scheduled tasks are on. Built into the platform: you can switch it off or back on at any time, but not edit or remove it.","schedule":"*/5 * * * *","timeout":240,"toggleable":true},"enabled":true,"enabled_default":true,"entries":[{"command":"wp db export /tmp/db.sql","enabled":true,"id":12,"label":"Nightly database export","last_run":{"at":"2026-11-06T01:31:12Z","duration_s":72,"exit_code":0,"status":"ok"},"next_run_at":"2026-11-07T02:30:00+01:00","no_overlap":true,"position":1,"schedule":"30 2 * * *","schedule_label":"Daily at 02:30","timeout":3600},{"command":"wp transient delete --expired","enabled":false,"id":13,"label":"Clear expired transients","last_run":null,"next_run_at":null,"no_overlap":false,"position":2,"schedule":"0 */6 * * *","schedule_label":"Every 6 hours","timeout":900}],"limits":{"command_max":500,"entries_max":49,"label_max":60,"min_interval_seconds":60,"timeouts":[900,3600,21600]},"presets":[{"key":"every_minute","label":"Every minute","schedule":"* * * * *"},{"key":"every_5_minutes","label":"Every 5 minutes","schedule":"*/5 * * * *"},{"key":"every_15_minutes","label":"Every 15 minutes","schedule":"*/15 * * * *"},{"key":"hourly","label":"Hourly, on the hour","schedule":"0 * * * *"},{"key":"daily","label":"Daily at 03:00","schedule":"0 3 * * *"},{"key":"weekly","label":"Mondays at 03:00","schedule":"0 3 * * 1"},{"key":"monthly","label":"On the 1st of each month at 03:00","schedule":"0 3 1 * *"}],"runs":{"builtin":{"at":"2026-11-06T09:15:04Z","duration_s":4,"exit_code":0,"status":"ok"},"c12":{"at":"2026-11-06T01:31:12Z","duration_s":72,"exit_code":0,"status":"ok"}},"timezone":"Europe/London","version":7},"operation":null}},"CronSetExample":{"summary":"A WordPress site with two tasks","value":{"apply":{"applied_at":"2026-11-04T14:12:31Z","error":null,"operation":null,"state":"applied","state_label":"Applied"},"builtin":{"active":true,"command":"wp cron event run --due-now","enabled":true,"label":"WordPress cron","last_run":{"at":"2026-11-06T09:15:04Z","duration_s":4,"exit_code":0,"status":"ok"},"locked":true,"note":"Runs WordPress's scheduled events every 5 minutes. It runs only while Scheduled tasks are on. Built into the platform: you can switch it off or back on at any time, but not edit or remove it.","schedule":"*/5 * * * *","timeout":240,"toggleable":true},"enabled":true,"enabled_default":true,"entries":[{"command":"wp db export /tmp/db.sql","enabled":true,"id":12,"label":"Nightly database export","last_run":{"at":"2026-11-06T01:31:12Z","duration_s":72,"exit_code":0,"status":"ok"},"next_run_at":"2026-11-07T02:30:00+01:00","no_overlap":true,"position":1,"schedule":"30 2 * * *","schedule_label":"Daily at 02:30","timeout":3600},{"command":"wp transient delete --expired","enabled":false,"id":13,"label":"Clear expired transients","last_run":null,"next_run_at":null,"no_overlap":false,"position":2,"schedule":"0 */6 * * *","schedule_label":"Every 6 hours","timeout":900}],"limits":{"command_max":500,"entries_max":49,"label_max":60,"min_interval_seconds":60,"timeouts":[900,3600,21600]},"presets":[{"key":"every_minute","label":"Every minute","schedule":"* * * * *"},{"key":"every_5_minutes","label":"Every 5 minutes","schedule":"*/5 * * * *"},{"key":"every_15_minutes","label":"Every 15 minutes","schedule":"*/15 * * * *"},{"key":"hourly","label":"Hourly, on the hour","schedule":"0 * * * *"},{"key":"daily","label":"Daily at 03:00","schedule":"0 3 * * *"},{"key":"weekly","label":"Mondays at 03:00","schedule":"0 3 * * 1"},{"key":"monthly","label":"On the 1st of each month at 03:00","schedule":"0 3 1 * *"}],"runs":{"builtin":{"at":"2026-11-06T09:15:04Z","duration_s":4,"exit_code":0,"status":"ok"},"c12":{"at":"2026-11-06T01:31:12Z","duration_s":72,"exit_code":0,"status":"ok"}},"timezone":"Europe/London","version":7}},"DeployTemplateExample":{"summary":"A template that sets the production after-deploy stage","value":{"can":{"edit":true,"edit_reason":null},"chain_note":null,"company":{"id":1180,"name":"Northwind Digital"},"configs":{"production":{"build":{"mode":"inherit"},"database":{"mode":"inherit"},"post_deploy":{"mode":"replace","value":{"lines":["php bin/magento cache:flush"]}},"settings":{"mode":"inherit"}},"uat":{"build":{"mode":"inherit"},"database":{"mode":"inherit"},"post_deploy":{"mode":"inherit"},"settings":{"mode":"inherit"}}},"locked":null,"platform":"magento2","presets":{"offered":[{"key":"magento2_standard","kind":"platform","label":"Magento 2 standard","node_floor":null,"node_floor_when":null},{"key":"none","kind":"platform","label":"No build","node_floor":null,"node_floor_when":null}]},"revision":2,"template_id":12,"upstreams":[{"agency":null,"chain":[{"company":null,"level":"corefinity","revision":2,"template_id":null},{"company":{"id":1180,"name":"Northwind Digital"},"level":"owner","revision":2,"template_id":12}],"environments":{"production":1,"total":1},"stages":{"production":{"post_deploy":{"differs_from_none":false,"effective":{"lines":["php bin/magento cache:flush"]},"inherited":{"company":null,"level":"corefinity","revision":2,"value":{"lines":[]}}}}},"upstream":"none"}]}},"DeployTemplateSavedExample":{"summary":"A saved change that reached one production environment","value":{"can":{"edit":true,"edit_reason":null},"chain_note":null,"company":{"id":1180,"name":"Northwind Digital"},"configs":{"production":{"build":{"mode":"inherit"},"database":{"mode":"inherit"},"post_deploy":{"mode":"replace","value":{"lines":["php bin/magento cache:flush","php bin/magento cron:install"]}},"settings":{"mode":"inherit"}},"uat":{"build":{"mode":"inherit"},"database":{"mode":"inherit"},"post_deploy":{"mode":"inherit"},"settings":{"mode":"inherit"}}},"dry_run":false,"locked":null,"platform":"magento2","presets":{"offered":[]},"reach":{"cannot_take":[],"confirm":{"count":1,"required":true},"digest":"3b50f766bb040794","environments":1,"in_flight":[],"list_max":50,"not_reached":[],"production":[{"binding_id":2210,"environment":{"name":"Production","slug":"production"},"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":1042,"stages":["post_deploy"]}],"production_count":1,"tunnels":{"access_update":[],"runtime_needed":[]},"uat":[],"uat_count":0,"unchanged":0},"revision":3,"template_id":12,"upstreams":[],"written":{"environments":1,"kept":0,"revisions":1,"tunnel_access_started":[]}}},"DeploymentConnectionListExample":{"summary":"Two connections, one needing re-authorisation","value":{"connections":[{"base_url":null,"can_remove":false,"connected_at":"2026-11-02T09:30:00+00:00","environments":[{"environment_id":1311,"name":"production","site_id":null,"website":"Harbour & Finch trade","website_id":1310}],"id":4217,"needs_reauth_since":"2026-11-09T03:12:45+00:00","organisation_access_url":null,"other_environments":0,"provider":"gitlab","provider_label":"GitLab","reconnect_note":"Open reconnect_url in a browser signed in to the control panel, then sign in to GitLab as daniel-reyes. Signing in as a different account adds a new connection instead of repairing this one.","reconnect_url":"https://manage.corefinity.com/company/auth/version-control/gitlab?company=1180","status":"needs_reauthorisation","username":"daniel-reyes"},{"base_url":"https://gitlab.example.com","can_remove":true,"connected_at":"2026-11-05T14:05:11+00:00","environments":[],"id":4230,"needs_reauth_since":null,"organisation_access_url":null,"other_environments":0,"provider":"gitlab_self_hosted","provider_label":"GitLab (self-hosted)","reconnect_note":"Self-hosted GitLab has no sign-in link: create a new personal access token (api scope) while signed in as northwind-deploy, then use Replace access token on this connection in the control panel (Company, Deployment Connections).","reconnect_url":null,"status":"connected","username":"northwind-deploy"}],"next_cursor":null}},"DnsPointed":{"summary":"One record created","value":{"applied":[{"action":"create","existing":null,"host":"harbourandfinch.example.com","reason":null,"record":{"content":"203.0.113.10","name":"harbourandfinch.example.com","proxied":true,"type":"A"}}],"hosts":[{"cloudflare_zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"harbourandfinch.example.com","proxied":null,"record_id":null},"dns_answers":[{"type":"A","value":"203.0.113.10"}],"dns_checked_at":"2026-11-06T09:16:05Z","dns_detail":null,"dns_state":"points_here","dns_state_since":"2026-11-01T10:14:03Z","expected_ip":"203.0.113.10","host":"harbourandfinch.example.com","ok":true,"problems":[],"redirects_to":null,"role":"primary","tls":{"checked_at":"2026-11-06T09:14:41Z","issuer":"Let's Encrypt","not_after":"2026-12-08T05:41:17Z","reason":null,"state":"ready"}}]}},"DomainsSaved":{"summary":"An extra domain was added","value":{"domains":{"advice":null,"apply":{"applied_at":"2026-11-02T14:37:55Z","error":null,"operation":{"id":77162,"scope":"site","status":"committed","status_label":"Waiting for the platform","summary":"Alias added: shop.harbourandfinch.example.com","to_version":null,"type":"domains_change","type_label":"Domains"},"state":"applying","state_label":"Applying"},"canonical_url":"https://harbourandfinch.example.com","cloudflare":{"connected":false,"zone":null},"hosts":[{"cloudflare_zone":null,"dns_answers":[{"type":"A","value":"203.0.113.10"}],"dns_checked_at":"2026-11-06T09:16:05Z","dns_detail":null,"dns_state":"points_here","dns_state_since":"2026-11-01T10:14:03Z","expected_ip":"203.0.113.10","host":"harbourandfinch.example.com","noindex":false,"redirects_to":null,"role":"primary","tls":{"checked_at":"2026-11-06T09:14:41Z","issuer":"Let's Encrypt","not_after":"2026-12-08T05:41:17Z","reason":null,"state":"ready"}},{"cloudflare_zone":null,"dns_answers":[{"type":"A","value":"203.0.113.10"}],"dns_checked_at":"2026-11-06T09:16:05Z","dns_detail":null,"dns_state":"points_here","dns_state_since":"2026-11-01T10:14:03Z","expected_ip":"203.0.113.10","host":"www.harbourandfinch.example.com","noindex":false,"redirects_to":"harbourandfinch.example.com","role":"alias","tls":{"checked_at":"2026-11-06T09:14:41Z","issuer":"Let's Encrypt","not_after":"2026-12-08T05:41:17Z","reason":null,"state":"ready"}},{"cloudflare_zone":null,"dns_answers":[{"type":"A","value":"203.0.113.10"}],"dns_checked_at":"2026-11-06T09:16:05Z","dns_detail":null,"dns_state":"points_here","dns_state_since":"2026-11-06T09:16:05Z","expected_ip":"203.0.113.10","host":"shop.harbourandfinch.example.com","noindex":false,"redirects_to":"harbourandfinch.example.com","role":"alias","tls":{"checked_at":null,"issuer":null,"not_after":null,"reason":null,"state":"pending"}}],"ingress_ip":"203.0.113.10","limits":{"hosts_max":10},"locked_reason":null,"mode":"production","noindex":false,"noindex_source":"flags","primary":"harbourandfinch.example.com","url_change":{"can_change":{"available":false,"reason":"Another change to this site is in progress. Wait for it to finish."},"in_flight":null},"version":5,"www":"bare"},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-06T09:17:15Z","completed_at":null,"created_at":"2026-11-06T09:17:12Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":77162,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":5021,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"current"},{"key":"restarted","label":"Change applied","state":"todo"},{"key":"healthy","label":"Healthy","state":"todo"}],"summary":"Alias added: shop.harbourandfinch.example.com","to_version":null,"type":"domains_change","type_label":"Domains"}}},"DomainsUnchanged":{"summary":"Nothing differs, so nothing started","value":{"domains":{"advice":null,"apply":{"applied_at":"2026-11-02T14:37:55Z","error":null,"operation":null,"state":"applied","state_label":"Applied"},"canonical_url":"https://harbourandfinch.example.com","cloudflare":{"connected":false,"zone":null},"hosts":[{"cloudflare_zone":null,"dns_answers":[{"type":"A","value":"203.0.113.10"}],"dns_checked_at":"2026-11-06T09:16:05Z","dns_detail":null,"dns_state":"points_here","dns_state_since":"2026-11-01T10:14:03Z","expected_ip":"203.0.113.10","host":"harbourandfinch.example.com","noindex":false,"redirects_to":null,"role":"primary","tls":{"checked_at":"2026-11-06T09:14:41Z","issuer":"Let's Encrypt","not_after":"2026-12-08T05:41:17Z","reason":null,"state":"ready"}},{"cloudflare_zone":null,"dns_answers":[{"type":"A","value":"203.0.113.10"}],"dns_checked_at":"2026-11-06T09:16:05Z","dns_detail":null,"dns_state":"points_here","dns_state_since":"2026-11-01T10:14:03Z","expected_ip":"203.0.113.10","host":"www.harbourandfinch.example.com","noindex":false,"redirects_to":"harbourandfinch.example.com","role":"alias","tls":{"checked_at":"2026-11-06T09:14:41Z","issuer":"Let's Encrypt","not_after":"2026-12-08T05:41:17Z","reason":null,"state":"ready"}}],"ingress_ip":"203.0.113.10","limits":{"hosts_max":10},"locked_reason":null,"mode":"production","noindex":false,"noindex_source":"flags","primary":"harbourandfinch.example.com","url_change":{"can_change":{"available":true,"reason":null},"in_flight":null},"version":4,"www":"bare"},"operation":null}},"EnterpriseCopyCopiedExample":{"summary":"A copy whose run has ended","value":{"copy":{"copied":{"at":"2026-11-03T12:41:07+00:00","dangling_links":0,"db_bytes":10522669875,"duration_seconds":2467,"files_bytes":31876710400,"neutralised_at":"2026-11-03T12:40:12+00:00","unreadable_files":0},"copied_at":"2026-11-03T12:41:07+00:00","copy_of":null,"created_at":"2026-11-03T12:00:00+00:00","database_bytes":10737418240,"error":null,"failure_reason":null,"files_bytes":32212254720,"finishable":true,"finished_at":null,"id":6201,"operation":{"id":5141,"status":"completed","step":"checked"},"phase":"presync","source_environment_id":1311,"state":"waiting","step":"copied","superseded_by":null,"target_cluster_id":1017,"target_site_id":1081,"unactivated_at":"2026-11-03T12:41:05+00:00"}}},"EnterpriseCopyFinishedExample":{"summary":"A finished copy","value":{"copy":{"copied":{"at":"2026-11-03T12:41:07+00:00","dangling_links":0,"db_bytes":10522669875,"duration_seconds":2467,"files_bytes":31876710400,"neutralised_at":"2026-11-03T12:40:12+00:00","unreadable_files":0},"copied_at":"2026-11-03T12:41:07+00:00","copy_of":null,"created_at":"2026-11-03T12:00:00+00:00","database_bytes":10737418240,"error":null,"failure_reason":null,"files_bytes":32212254720,"finishable":false,"finished_at":"2026-11-03T15:02:44+00:00","id":6201,"operation":{"id":5141,"status":"completed","step":"checked"},"phase":"done","source_environment_id":1311,"state":"waiting","step":"finished","superseded_by":null,"target_cluster_id":1017,"target_site_id":1081,"unactivated_at":"2026-11-03T12:41:05+00:00"}}},"EnterpriseCopyResyncedExample":{"summary":"A new copy that follows copy 6201","value":{"copy":{"copied":null,"copied_at":null,"copy_of":6201,"created_at":"2026-11-03T14:30:00+00:00","database_bytes":10737418240,"error":null,"failure_reason":null,"files_bytes":32212254720,"finishable":false,"finished_at":null,"id":6202,"operation":{"id":5143,"status":"executing","step":"protected"},"phase":"presync","source_environment_id":1311,"state":"running","step":"guard","superseded_by":null,"target_cluster_id":1017,"target_site_id":1081,"unactivated_at":null},"poll":"/api/enterprise-copies/6202"}},"EnterpriseCopyStartedExample":{"summary":"A copy at its first step","value":{"copy":{"copied":null,"copied_at":null,"copy_of":null,"created_at":"2026-11-03T12:00:00+00:00","database_bytes":10737418240,"error":null,"failure_reason":null,"files_bytes":32212254720,"finishable":false,"finished_at":null,"id":6202,"operation":{"id":5142,"status":"executing","step":"protected"},"phase":"presync","source_environment_id":1312,"state":"running","step":"guard","superseded_by":null,"target_cluster_id":1017,"target_site_id":1043,"unactivated_at":null},"poll":"/api/enterprise-copies/6202"}},"EnterpriseDeploymentCancelledExample":{"summary":"The deployment, cancelled","value":{"deployment":{"artifact_pruned_at":null,"attempt_id":190419,"environment_deployment_pipeline_id":"2210","environment_id":"1311","error":null,"git_author":null,"git_commit":"5c1d0e9a7b3f42d68a0c9e1f7b2d4a6c8e0f1a3b","git_commit_url":null,"git_merge_request":null,"hash":"71a7eaca-89a7-4a5f-a7af-17d38ca685e6","id":"4410","name":"Release 2026.10.4","notes":null,"status":"5","status_description":"Cancelled"},"replayed":false}},"EnterpriseDeploymentDetailExample":{"summary":"A failed deployment that can be retried","value":{"deployment":{"artifact_pruned_at":null,"attempt_id":190419,"environment_deployment_pipeline_id":"2210","environment_id":"1311","error":null,"git_author":null,"git_commit":"5c1d0e9a7b3f42d68a0c9e1f7b2d4a6c8e0f1a3b","git_commit_url":null,"git_merge_request":null,"hash":"71a7eaca-89a7-4a5f-a7af-17d38ca685e6","id":"4410","name":"Release 2026.10.4","notes":null,"status":"3","status_description":"Failed"},"retry_warning":null,"view":{"actions":["download_log"],"blocked_by":null,"crons_paused":null,"is_stopping":false,"maintenance_lift":null,"primary_action":{"action":"retry","disabled_reason":null,"enabled":true},"queued_mode":null,"refused_actions":[],"state":"failed","stop_termination":null,"superseded_by":null}}},"EnterpriseDeploymentListExample":{"summary":"Every deployment, oldest first","value":{"deployments":[{"artifact_pruned_at":null,"attempt_id":190388,"environment_deployment_pipeline_id":"2210","environment_id":"1311","error":null,"git_author":null,"git_commit":"0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a1b","git_commit_url":null,"git_merge_request":null,"hash":"2f0c7d5e-1b7a-4c38-9a55-0d6e2b8f4c11","id":"88190","name":"Release 2026.10.3","notes":null,"status":"4","status_description":"Succeeded"},{"artifact_pruned_at":null,"attempt_id":190419,"environment_deployment_pipeline_id":"2210","environment_id":"1311","error":null,"git_author":null,"git_commit":"5c1d0e9a7b3f42d68a0c9e1f7b2d4a6c8e0f1a3b","git_commit_url":null,"git_merge_request":null,"hash":"71a7eaca-89a7-4a5f-a7af-17d38ca685e6","id":"4410","name":"Release 2026.10.4","notes":null,"status":"3","status_description":"Failed"}]}},"EnterpriseDeploymentPageExample":{"summary":"The first page, newest first","value":{"deployments":[{"artifact_pruned_at":null,"attempt_id":190419,"environment_deployment_pipeline_id":"2210","environment_id":"1311","error":null,"git_author":null,"git_commit":"5c1d0e9a7b3f42d68a0c9e1f7b2d4a6c8e0f1a3b","git_commit_url":null,"git_merge_request":null,"hash":"71a7eaca-89a7-4a5f-a7af-17d38ca685e6","id":"4410","name":"Release 2026.10.4","notes":null,"status":"3","status_description":"Failed"}],"next_cursor":"ODgyMTQ"}},"EnterpriseDeploymentQueuedExample":{"summary":"A new deployment of a commit","value":{"deployment":{"artifact_pruned_at":null,"attempt_id":190417,"environment_deployment_pipeline_id":"2210","environment_id":"1311","error":null,"git_author":null,"git_commit":"93ac3ee17c1306a5c478c583f0946e40d2e291f0","git_commit_url":null,"git_merge_request":null,"hash":"8697839e-ee34-4255-8328-61f0651f63b4","id":"88231","name":"Release 2026.11.1","notes":"Checkout fixes","status":"7","status_description":"Queued"}}},"EnterpriseDeploymentRetriedExample":{"summary":"The deployment, queued again","value":{"deployment":{"artifact_pruned_at":null,"attempt_id":190422,"environment_deployment_pipeline_id":"2210","environment_id":"1311","error":null,"git_author":{"avatar_url":null,"name":"Maya Okafor"},"git_commit":"5c1d0e9a7b3f42d68a0c9e1f7b2d4a6c8e0f1a3b","git_commit_url":"https://git.example.com/northwind-digital/harbourandfinch-trade/commit/5c1d0e9a7b3f42d68a0c9e1f7b2d4a6c8e0f1a3b","git_merge_request":{"kind":"pull_request","ref":"#42","url":"https://git.example.com/northwind-digital/harbourandfinch-trade/pull/42"},"hash":"a1ad2149-9907-53b6-ba91-5b042673f595","id":"4410","name":"Release 2026.10.4","notes":null,"status":"7","status_description":"Queued"},"replayed":false}},"EnterpriseDeploymentSettingsAutomaticExample":{"summary":"Every push now deploys on its own","value":{"deployment_settings":{"deployment_source":"git","deployment_sources":["manual","git"],"enterprise_env_id":1311,"git_deploys":"automatic","pipeline_enabled":true,"pipelines":[{"build_switches_editable":false,"folders_editable":true,"isolate_build_var":null,"name":"Storefront (Wordpress)","notes":[],"pause_crons_during_build":null,"pipeline_id":2210,"root_directory":"/var/www/harbourandfinch.example.com/","root_storage":"/var/www/harbourandfinch.example.com/shared/"}],"repositories":1}}},"EnterpriseDeploymentSettingsExample":{"summary":"An environment that deploys from git by hand","value":{"deployment_settings":{"deployment_source":"git","deployment_sources":["manual","git"],"enterprise_env_id":1311,"git_deploys":"manual","pipeline_enabled":true,"pipelines":[{"build_switches_editable":false,"folders_editable":true,"isolate_build_var":null,"name":"Storefront (Wordpress)","notes":[],"pause_crons_during_build":null,"pipeline_id":2210,"root_directory":"/var/www/harbourandfinch.example.com/","root_storage":"/var/www/harbourandfinch.example.com/shared/"}],"repositories":1}}},"EnterpriseDeploymentSiteOnlyExample":{"summary":"The environment is a CoreStack or CoreCluster site's","value":{"code":"conflict","message":"This is a CoreStack or CoreCluster site's environment: stop, roll back and deploy its deployments from the site, on its Deployments tab or with the site's own deployment actions.","reason":"conflict"}},"EnterprisePipelineListExample":{"summary":"One classic pipeline","value":{"environment_deployment_pipelines":[{"classic":{"pipeline_version":1,"runs":true,"sections":[{"key":"build","label":"Build command","lines":[{"command":"composer install --no-dev","comments":[],"label":"Build command 1"},{"command":"npm ci && npm run build","comments":[],"label":"Build command 2"}],"source":"custom"},{"key":"post_build","label":"Post build command","lines":[],"source":"shared"}]},"custom_commands":"composer install --no-dev\nnpm ci && npm run build","deployment_pipeline":{"id":"4","name":"Wordpress","platforms":[{"id":"4","name":"Wordpress","slug":"wordpress"}],"slug":"wordpress"},"id":"2210","notes":"Storefront","pipeline_id":"4","post_hook_commands":null,"root_directory":"/var/www/harbourandfinch.example.com/","root_storage":"/var/www/harbourandfinch.example.com/shared/","stage_model":null,"tag":null,"use_custom_commands":true,"use_custom_post_hook_commands":false}]}},"EnterpriseRepositoryListExample":{"summary":"One repository you may change and one set up by an agency","value":{"can_manage":{"available":true,"reason":null},"can_set":{"available":true,"reason":null},"environment_repositories":[{"branch":"main","connection_hidden":false,"connection_owner":null,"environment_deployment_pipeline_id":"2210","id":"3301","provider":"github","repo":"northwind-digital/harbourandfinch-trade"},{"branch":null,"connection_hidden":true,"connection_owner":"Northwind Digital","environment_deployment_pipeline_id":"2210","id":"3304","provider":null,"repo":null}]}},"EnterpriseVariableListExample":{"summary":"Two variables","value":{"count":2,"limit":100,"variables":[{"masked":"••••••••cret","name":"API_TOKEN","replaces_platform":false,"tool_credential":null,"updated_at":"2026-11-09T10:42:07Z","used_in":["post_deploy"]},{"masked":"••••••••","name":"SENTRY_DSN","replaces_platform":false,"tool_credential":null,"updated_at":"2026-11-04T08:15:30Z","used_in":[]}]}},"EnterpriseVariableSiteEnvironmentExample":{"summary":"An environment of a CoreStack or CoreCluster site","value":{"code":"invalid","errors":{"environment":["This is a CoreStack or CoreCluster environment: name it by its site_id."]},"field":"environment","message":"This is a CoreStack or CoreCluster environment: name it by its site_id.","reason":"invalid"}},"EnvironmentRegistrySecretSiteEnvironmentExample":{"summary":"An environment of a CoreStack or CoreCluster site","value":{"code":"invalid","errors":{"environment":["This is a CoreStack or CoreCluster environment: name it by its site_id."]},"field":"environment","message":"This is a CoreStack or CoreCluster environment: name it by its site_id.","reason":"invalid"}},"FirewallActivityPageExample":{"summary":"An address added in the Control Panel, then a preset attached through the API","value":{"events":[{"action":"preset_attached","actor":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"at":"2026-11-06T09:18:02.000Z","channel":"api","cidr":null,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"reason":null},{"action":"entry_added","actor":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"at":"2026-11-06T09:16:40.000Z","channel":"ui","cidr":"203.0.113.7/32","layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"reason":null}],"next_cursor":null}},"FirewallChangeExample":{"summary":"Applied on one of two environments so far","value":{"applied":1,"deferred":0,"failed":[],"id":5308,"state":"applying","total":2}},"FirewallCompanyViewExample":{"summary":"A company with one address and one preset","value":{"agency":null,"company":{"id":1204,"is_agency":false,"name":"Harbour & Finch"},"entries":[{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"carried_from":null,"changed_at":"2026-11-01T10:02:44Z","cidr":"203.0.113.7/32","comment":"Office","created_at":"2026-11-01T10:02:44Z","decision_reason":null,"editable":true,"expires_at":null,"family":4,"id":9001,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"path":null,"request_reason":null,"scope":{"ssh":true,"web":true},"source":"manual","status":"active","web_paused":false}],"presets":[{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"created_at":"2026-11-01T10:05:10Z","editable":true,"id":310,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"preset":{"description":"The addresses GitHub Actions runners connect from.","id":14,"name":"GitHub Actions","ranges_count":1,"slug":"github-actions"}}],"reach":{"environments":1,"items":[{"id":1311,"name":"Production","product":"corecluster","website":{"id":1310,"name":"harbourandfinch.example.com"}}],"websites":1}}},"FirewallEntryAddedExample":{"summary":"One address added for one environment, for 90 days","value":{"change_id":5310,"covered_by":null,"entry":{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"carried_from":null,"changed_at":"2026-11-06T09:16:40Z","cidr":"203.0.113.42/32","comment":"Contractor","created_at":"2026-11-06T09:16:40Z","decision_reason":null,"editable":true,"expires_at":"2027-01-04T09:16:40Z","family":4,"id":9002,"layer":"environment","owner":{"id":1311,"name":"Production","type":"environment"},"path":null,"request_reason":null,"scope":{"ssh":true,"web":true},"source":"manual","status":"active","web_paused":false}}},"FirewallEntryUpdatedExample":{"summary":"An address limited to SSH","value":{"change_id":5311,"covered_by":null,"entry":{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"carried_from":null,"changed_at":"2026-11-06T09:16:40Z","cidr":"203.0.113.7/32","comment":"Office","created_at":"2026-11-01T10:02:44Z","decision_reason":null,"editable":true,"expires_at":null,"family":4,"id":9001,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"path":null,"request_reason":null,"scope":{"ssh":true,"web":false},"source":"manual","status":"active","web_paused":false}}},"FirewallEnvironmentViewExample":{"summary":"An environment reached by one company address and one company preset","value":{"closed_by_default":true,"covered":true,"enforcement":{"stage":"enforce"},"entries":[{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"carried_from":null,"changed_at":"2026-11-01T10:02:44Z","cidr":"203.0.113.7/32","comment":"Office","created_at":"2026-11-01T10:02:44Z","decision_reason":null,"editable":true,"expires_at":null,"family":4,"id":9001,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"path":null,"request_reason":null,"scope":{"ssh":true,"web":true},"source":"manual","status":"active","web_paused":false}],"environment":{"company":{"id":1204,"name":"Harbour & Finch"},"id":1311,"name":"Production","product":"corecluster","site_id":1042,"website":{"id":1310,"name":"harbourandfinch.example.com"}},"legacy":{"banner":false,"ends_on":null,"state":"none"},"presets":[{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"created_at":"2026-11-01T10:05:10Z","editable":true,"id":310,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"preset":{"description":"The addresses GitHub Actions runners connect from.","id":14,"name":"GitHub Actions","ranges_count":1,"slug":"github-actions"}}],"ssh_reach":{"ends_on":null,"state":"restricted"},"targets":[{"applied_at":"2026-11-01T10:05:31Z","last_error_public":null,"moving":false,"port":21044,"state":"applied"}],"your_address":{"address":"203.0.113.7","allowed":true,"via":[{"cidr":"203.0.113.7/32","entry_id":9001,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"subscription_id":null}]}}},"FirewallMyIpAddedExample":{"summary":"The address added for yourself, for 30 days","value":{"change_id":5309,"entry":{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"carried_from":null,"changed_at":"2026-11-06T09:16:40Z","cidr":"198.51.100.24/32","comment":"Home","created_at":"2026-11-06T09:16:40Z","decision_reason":null,"editable":true,"expires_at":"2026-11-05T09:16:40Z","family":4,"id":9005,"layer":"user","owner":{"id":2041,"name":"Eleanor Finch","type":"user"},"path":null,"request_reason":null,"scope":{"ssh":true,"web":true},"source":"one_click","status":"active","web_paused":false}}},"FirewallMyIpExample":{"summary":"An address that cannot connect yet, and the four levels it can be added at","value":{"address":"198.51.100.24","allowed":false,"family":4,"options":[{"description":"Every environment you can reach","label":"Me","level":"me","reach":{"environments":1,"websites":1}},{"description":"Production of harbourandfinch.example.com","label":"This environment","level":"environment","reach":{"environments":1,"websites":1}},{"description":"Every environment of harbourandfinch.example.com","label":"This website","level":"website","reach":{"environments":1,"websites":1}},{"description":"Every Harbour & Finch environment","label":"My company","level":"company","reach":{"environments":1,"websites":1}}],"reason":null,"usable":true,"via":[]}},"FirewallMyIpPresentExample":{"summary":"A company address already allows it","value":{"present":true,"via":[{"cidr":"198.51.100.0/24","entry_id":9003,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"subscription_id":null}]}},"FirewallPresetAttachedExample":{"summary":"A preset attached for the whole company","value":{"change_id":5312,"subscription":{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"created_at":"2026-11-06T09:16:40Z","editable":true,"id":311,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"preset":{"description":"The addresses Bitbucket Pipelines builds connect from.","id":12,"name":"Bitbucket Pipelines","ranges_count":2,"slug":"bitbucket-pipelines"}}}},"FirewallPresetListExample":{"summary":"Two presets","value":{"presets":[{"description":"The addresses Bitbucket Pipelines builds connect from.","id":12,"name":"Bitbucket Pipelines","ranges_count":2,"slug":"bitbucket-pipelines"},{"description":"The addresses GitHub Actions runners connect from.","id":14,"name":"GitHub Actions","ranges_count":1,"slug":"github-actions"}]}},"FirewallRangeRequestedExample":{"summary":"A range waiting for approval","value":{"entry":{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"carried_from":null,"changed_at":"2026-11-06T09:16:40Z","cidr":"2001:db8:4a00::/40","comment":null,"created_at":"2026-11-06T09:16:40Z","decision_reason":null,"editable":true,"expires_at":null,"family":6,"id":9006,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"path":null,"request_reason":"Our office network. Every workstation gets an address from this range.","scope":{"ssh":true,"web":true},"source":"manual","status":"pending_approval","web_paused":false}}},"FirewallUserViewExample":{"summary":"One address of your own, added from where you were calling","value":{"entries":[{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"carried_from":null,"changed_at":"2026-11-06T09:16:40Z","cidr":"198.51.100.24/32","comment":"Home","created_at":"2026-11-06T09:16:40Z","decision_reason":null,"editable":true,"expires_at":"2026-11-05T09:16:40Z","family":4,"id":9005,"layer":"user","owner":{"id":2041,"name":"Eleanor Finch","type":"user"},"path":null,"request_reason":null,"scope":{"ssh":true,"web":true},"source":"one_click","status":"active","web_paused":false}],"reach":{"environments":1,"items":[{"id":1311,"name":"Production","product":"corecluster","website":{"id":1310,"name":"harbourandfinch.example.com"}}],"websites":1},"user":{"id":2041,"name":"Eleanor Finch"}}},"FirewallWebAccessExample":{"summary":"A site behind HTTP authentication, with one address that skips the login","value":{"bypass":{"applied_at":"2026-11-01T10:05:31Z","count":1,"covers":{"http_auth":true,"maintenance":true},"entries":[{"id":9001,"state":"applied"}],"last_error_public":null,"state":"applied"},"http_auth":{"enabled":true,"rules_count":1,"users":[{"id":77,"revealable":true,"username":"client"}],"version":4},"maintenance":{"on":false},"site_id":1042}},"FirewallWebsiteViewExample":{"summary":"A website reached by a company address and one of its own","value":{"entries":[{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"carried_from":null,"changed_at":"2026-11-01T10:02:44Z","cidr":"203.0.113.7/32","comment":"Office","created_at":"2026-11-01T10:02:44Z","decision_reason":null,"editable":true,"expires_at":null,"family":4,"id":9001,"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"path":null,"request_reason":null,"scope":{"ssh":true,"web":true},"source":"manual","status":"active","web_paused":false},{"added_by":{"name":"Eleanor Finch","on_behalf_of":null,"support":false},"carried_from":null,"changed_at":"2026-11-06T09:16:40Z","cidr":"203.0.113.60/32","comment":"Agency office","created_at":"2026-11-06T09:16:40Z","decision_reason":null,"editable":true,"expires_at":null,"family":4,"id":9010,"layer":"website","owner":{"id":1310,"name":"harbourandfinch.example.com","type":"website"},"path":null,"request_reason":null,"scope":{"ssh":true,"web":true},"source":"manual","status":"active","web_paused":false}],"environments":[{"id":1311,"name":"Production","site_id":1042,"status_summary":"applied"}],"presets":[],"website":{"id":1310,"name":"harbourandfinch.example.com","product":"corecluster"}}},"LogsExportReadyExample":{"summary":"An export that is ready to collect","value":{"bytes":9873412,"error":null,"expires_at":"2026-11-04T10:00:00Z","format":"csv","id":"01JB2Y8N7Q4X3R5T6V8W9Z0A1B","lines":41220,"state":"ready","truncated":false}},"LogsExportStartedExample":{"summary":"An export that is being prepared","value":{"capability":"Example-export-capability-0000000000000000000001","download":{"bytes":null,"error":null,"expires_at":"2026-11-04T10:00:00Z","format":"csv","id":"01JB2Y8N7Q4X3R5T6V8W9Z0A1B","lines":null,"state":"preparing","truncated":false}}},"LogsFacetsExample":{"summary":"The facets of the web access lines","value":{"facets":{"level":[{"count":41203,"value":"info"},{"count":17,"value":"error"}],"method":[{"count":39870,"value":"GET"},{"count":1350,"value":"POST"}],"status":[{"count":41203,"value":"200"},{"count":812,"value":"404"},{"count":17,"value":"500"}]}}},"LogsFieldValuesExample":{"summary":"The values of status","value":{"field":"status","truncated":false,"values":[{"count":41203,"value":"200"},{"count":812,"value":"404"},{"count":17,"value":"500"}]}},"LogsFieldsExample":{"summary":"The fields of the web access lines","value":{"fields":[{"name":"level","top":[{"count":41203,"value":"info"},{"count":17,"value":"error"}],"type":"string"},{"name":"method","top":[{"count":39870,"value":"GET"},{"count":1350,"value":"POST"}],"type":"string"},{"name":"status","top":[{"count":41203,"value":"200"},{"count":812,"value":"404"},{"count":17,"value":"500"}],"type":"number"}],"range":{"from":"2026-11-03T09:00:00Z","to":"2026-11-03T10:00:00Z"},"source":"web-access"}},"LogsHistogramExample":{"summary":"An hour in twelve slices, the first three shown","value":{"buckets":[{"count":3420,"from":"2026-11-03T09:00:00Z","levels":{"error":2,"info":3418}},{"count":3391,"from":"2026-11-03T09:05:00Z","levels":{"info":3391}},{"count":0,"from":"2026-11-03T09:10:00Z","levels":{}}],"warnings":[]}},"LogsSavedQueryRemainingExample":{"summary":"The one query still kept","value":{"items":[{"can_delete":true,"created_at":"2026-11-01T14:31:07Z","filters":{"level":["warning","error"]},"id":3290,"name":"PHP warnings","query":null,"range":"7d","shared":false,"site":null,"source":"php"}]}},"MagentoStoresRead":{"summary":"A Magento website with one store view","value":{"default_hosts":["shop.example.com"],"default_store":{"code":"base","type":"website"},"domains_version":0,"nginx_version":0,"read_at":"2026-11-11T12:00:00Z","store_hosts":[],"warnings":[],"websites":[{"active":true,"base_url":"https://shop.example.com/","base_url_elsewhere":false,"base_url_own":true,"code":"base","default_group_id":1,"id":1,"is_default":true,"name":"Main shop","shown_on":["shop.example.com"],"store_views":[{"active":true,"base_url":"https://shop.example.com/","base_url_elsewhere":true,"base_url_own":true,"code":"default","group_id":1,"id":1,"is_active":true,"name":"English","shown_on":[],"website_id":1}]}]}},"OperationFailedExample":{"summary":"A failed change of a site's main address, which can be retried","value":{"applied_at":null,"can_retry":true,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-03T09:12:05Z","completed_at":null,"created_at":"2026-11-03T09:12:03Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":"The change was not applied within 15 minutes — staff have been notified","failure_reason":"step_failed","from_version":null,"hot":false,"id":5120,"install":null,"label":"Site URL updated","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"failed","status_label":"Failed","step":"rewritten","steps":[{"key":"committed","label":"New address added","state":"done"},{"key":"rewritten","label":"Site URL updated","state":"failed"},{"key":"finalising","label":"Redirect saved","state":"todo"},{"key":"finalised","label":"Old address redirects","state":"todo"}],"subject":null,"summary":"Primary URL","to_version":null,"type":"url_change","type_label":"Primary URL"}},"OperationRetriedExample":{"summary":"The new attempt","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-03T09:12:05Z","completed_at":null,"created_at":"2026-11-03T09:12:03Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"Site URL updated","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":5120,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Running","step":"rewritten","steps":[{"key":"committed","label":"New address added","state":"done"},{"key":"rewritten","label":"Site URL updated","state":"current"},{"key":"finalising","label":"Redirect saved","state":"todo"},{"key":"finalised","label":"Old address redirects","state":"todo"}],"subject":null,"summary":"Primary URL","to_version":null,"type":"url_change","type_label":"Primary URL"}}},"OperationsPageExample":{"summary":"One operation, and no further page","value":{"items":[{"applied_at":null,"can_retry":true,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-03T09:12:05Z","completed_at":null,"created_at":"2026-11-03T09:12:03Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":"The change was not applied within 15 minutes — staff have been notified","failure_reason":"step_failed","from_version":null,"hot":false,"id":5120,"install":null,"label":"Site URL updated","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"failed","status_label":"Failed","step":"rewritten","steps":[{"key":"committed","label":"New address added","state":"done"},{"key":"rewritten","label":"Site URL updated","state":"failed"},{"key":"finalising","label":"Redirect saved","state":"todo"},{"key":"finalised","label":"Old address redirects","state":"todo"}],"subject":null,"summary":"Primary URL","to_version":null,"type":"url_change","type_label":"Primary URL"}],"next_cursor":null}},"OrderLinkPreviewExample":{"summary":"A CoreCluster on Performance servers with upgrades","value":{"addon_steps":{"cores":{"max":8,"step":1},"disk_gb":{"max":102400,"step":10},"memory_gb":{"max":32,"step":1}},"quote":{"currency":"GBP","lines":[{"key":"package","label":"CoreCluster CC8","monthly":"720.00"},{"key":"addon_cores","label":"2 extra cores","monthly":"108.00","quantity":2,"unit":"54.00"},{"key":"addon_memory_gb","label":"8 GB extra memory","monthly":"48.00","quantity":8,"unit":"6.00"},{"key":"addon_disk_gb","label":"50 GB extra disk","monthly":"12.00","quantity":50,"unit":"0.24"}],"subtotal_monthly":"888.00","vat":"excluded"},"spec":{"addons":{"cores":2,"disk_gb":50,"memory_gb":8},"billing":"monthly","compute_family":"optimised","currency":"GBP","package":"CC8","platform":null,"product_line":"cc","region":"uk"},"url":"https://manage.corefinity.com/order?package=CC8&region=uk&currency=GBP&optimised=1&addon_cores=2&addon_memory_gb=8&addon_disk_gb=50"}},"PendingChangeWithdrawnExample":{"summary":"Nothing is left waiting","value":{"pending":{"batch":null,"can_apply_now":{"available":false,"reason":"nothing_pending"},"environment":{"id":1042,"name":"Production","role":"production","slug":"production"},"items":[],"site":{"domain":"harbourandfinch.example.com","id":1042},"window":{"date":"2026-11-04","ends_at":"2026-11-05T07:00:00Z","label":"Tonight 21:00–07:00 (Europe/London)","starts_at":"2026-11-04T21:00:00Z"}}}},"PendingChangesAppliedExample":{"summary":"The operation applying the changes","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":null,"committed_at":"2026-11-04T11:00:00Z","completed_at":null,"created_at":"2026-11-04T11:00:00Z","environment":{"id":1042,"name":"Production","role":"production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5130,"label":"Built","parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"batch","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"built","steps":[{"key":"built","label":"Built","state":"current"},{"key":"committed","label":"Committed","state":"todo"},{"key":"verified","label":"Verified","state":"todo"},{"key":"completed","label":"Completed","state":"todo"}],"subject":{"href":null,"id":4120,"label":"harbourandfinch.example.com · Production","type":"restart_batch"},"summary":"Scheduled maintenance on harbourandfinch.example.com","to_version":null,"type":"restart_batch_apply","type_label":"Apply tonight's changes","window":null}}},"PendingChangesExample":{"summary":"One change of yours waiting for tonight's window","value":{"batch":{"id":4120,"status":"open","window_date":"2026-11-04"},"can_apply_now":{"available":true,"reason":null},"environment":{"id":1042,"name":"Production","role":"production","slug":"production"},"items":[{"applied_at":null,"customer_change":{"can_cancel":true,"requested_at":"2026-11-04T11:00:00Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"summary":"PHP settings","type":"php_settings"},"error":null,"id":5320,"kind":"customer_change","label":"PHP settings","position":1,"source_operation":null,"status":"pending"}],"site":{"domain":"harbourandfinch.example.com","id":1042},"window":{"date":"2026-11-04","ends_at":"2026-11-05T07:00:00Z","label":"Tonight 21:00–07:00 (Europe/London)","starts_at":"2026-11-04T21:00:00Z"}}},"RuntimeNodeRuntimeExample":{"summary":"A site on Node.js 24 with two packages","value":{"adopted":true,"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"apply":{"error":null,"operation":null,"pending_tonight":null},"caches":null,"follow_repository":false,"last_applied_at":null,"limits":{"max_packages":20},"locked":null,"major":24,"memory":null,"options":[{"arrives_with":null,"available_on_this_row":true,"codename":"Krypton","default_for_new":true,"end_of_life_on":"2028-04-30","label":"Node.js 24","major":24,"needs_ack":[],"reason":null,"recommended":true,"selectable":true,"status":"maintenance_lts"},{"arrives_with":null,"available_on_this_row":true,"codename":"Jod","default_for_new":false,"end_of_life_on":"2027-04-30","label":"Node.js 22","major":22,"needs_ack":[],"reason":null,"recommended":false,"selectable":true,"status":"maintenance_lts"},{"arrives_with":null,"available_on_this_row":true,"codename":"Hydrogen","default_for_new":false,"end_of_life_on":"2025-04-30","label":"Node.js 18","major":18,"needs_ack":["eol"],"reason":null,"recommended":false,"selectable":true,"status":"end_of_life"}],"packages":[{"advisories":{"critical":0,"high":0},"bins":[],"error":null,"has_install_script":null,"installed_version":null,"latest":null,"name":"sass","origin":"panel","resolved":"1.93.2","scripts":false,"selector":"latest","state":"pending","update_available":false,"wanted":null},{"advisories":{"critical":0,"high":0},"bins":[],"error":null,"has_install_script":null,"installed_version":null,"latest":null,"name":"sharp","origin":"panel","resolved":"0.34.4","scripts":true,"selector":"0.34","state":"pending","update_available":false,"wanted":null}],"repository":null,"revision":4,"status":{"end_of_life_on":"2028-04-30","key":"maintenance_lts","label":"Maintenance LTS"},"unmanaged":[],"version":null}},"RuntimeNodeRuntimeStartedExample":{"summary":"The version change started","value":{"node_runtime":{"adopted":true,"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"apply":{"error":null,"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-09T21:35:26Z","completed_at":null,"created_at":"2026-11-09T21:35:26Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"Sent to the site","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"sent","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"sent","label":"Sent to the site","state":"current"},{"key":"switched","label":"Node.js switched","state":"todo"},{"key":"checked","label":"Checked","state":"todo"}],"subject":null,"summary":"Node.js configuration","to_version":null,"type":"node_runtime","type_label":"Node.js configuration"},"pending_tonight":null},"caches":null,"follow_repository":false,"last_applied_at":null,"limits":{"max_packages":20},"locked":null,"major":22,"memory":null,"options":[{"arrives_with":null,"available_on_this_row":true,"codename":"Krypton","default_for_new":true,"end_of_life_on":"2028-04-30","label":"Node.js 24","major":24,"needs_ack":[],"reason":null,"recommended":true,"selectable":true,"status":"maintenance_lts"},{"arrives_with":null,"available_on_this_row":true,"codename":"Jod","default_for_new":false,"end_of_life_on":"2027-04-30","label":"Node.js 22","major":22,"needs_ack":[],"reason":null,"recommended":false,"selectable":true,"status":"maintenance_lts"}],"packages":[{"advisories":{"critical":0,"high":0},"bins":[],"error":null,"has_install_script":null,"installed_version":null,"latest":null,"name":"sass","origin":"panel","resolved":"1.93.2","scripts":false,"selector":"latest","state":"installing","update_available":false,"wanted":null},{"advisories":{"critical":0,"high":0},"bins":[],"error":null,"has_install_script":null,"installed_version":null,"latest":null,"name":"sharp","origin":"panel","resolved":"0.34.4","scripts":true,"selector":"0.34","state":"installing","update_available":false,"wanted":null}],"repository":null,"revision":5,"status":{"end_of_life_on":"2027-04-30","key":"maintenance_lts","label":"Maintenance LTS"},"unmanaged":[],"version":null},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-09T21:35:26Z","completed_at":null,"created_at":"2026-11-09T21:35:26Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"Sent to the site","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"sent","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"sent","label":"Sent to the site","state":"current"},{"key":"switched","label":"Node.js switched","state":"todo"},{"key":"checked","label":"Checked","state":"todo"}],"subject":null,"summary":"Node.js configuration","to_version":null,"type":"node_runtime","type_label":"Node.js configuration"},"warnings":[]}},"RuntimePhpRuntimeExample":{"summary":"A production site on the runtime","value":{"adopted":true,"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"apply":{"error":null,"operation":null,"pending_tonight":null},"custom_ini":{"banner":["; cf-runtime v1 php-custom.ini site=rs-northwind-harbourandfinch-example-com","; Managed by the control panel. Edits made here are overwritten."],"bytes":145,"content":"realpath_cache_size = 8M\n","lines":1,"max_bytes":32768,"overrides":[{"directive":"realpath_cache_size","line":1}]},"extensions":[{"available":true,"conflicts":[],"description":"Keeps compiled PHP code in memory so pages run faster. Always on.","enabled":true,"group":"caching","kind":"zend_extension","label":"OPcache","locked":true,"locked_reason":"OPcache is always on","name":"opcache","non_production_only":false,"recommended":false,"required_by_app":false,"version":"8.4.26"},{"available":true,"conflicts":[],"description":"Image processing through ImageMagick: resizing, format conversion and PDF thumbnails.","enabled":false,"group":"images","kind":"extension","label":"Imagick","locked":false,"locked_reason":null,"name":"imagick","non_production_only":false,"recommended":true,"required_by_app":true,"version":"3.8.1"},{"available":true,"conflicts":[],"description":"Connects to MySQL and MariaDB databases.","enabled":true,"group":"databases","kind":"extension","label":"MySQLi","locked":true,"locked_reason":"WordPress needs MySQLi","name":"mysqli","non_production_only":false,"recommended":true,"required_by_app":true,"version":"8.4.26"},{"available":true,"conflicts":[],"description":"A client for Redis and Valkey, for caches, sessions and queues.","enabled":false,"group":"caching","kind":"extension","label":"Redis","locked":false,"locked_reason":null,"name":"redis","non_production_only":false,"recommended":true,"required_by_app":false,"version":"6.3.0"}],"fpm":{"bounds":{"max_requests":{"max":100000,"min":100},"pm":["dynamic","ondemand","static"],"process_idle_timeout":{"max":300,"min":5}},"live":null,"max_children":null,"max_requests":500,"pm":"dynamic","process_idle_timeout":null,"source":{"max_children":"package","max_requests":"platform","pm":"platform","process_idle_timeout":"platform"}},"image":{"line":"new","minor":"8.4","patch":"8.4.9"},"last_applied_at":null,"locked":null,"requirements":{"application":{"name":"WordPress","version":"6.8.3"},"ext":{"by":{"imagick":["wordpress"]},"required":["ext-json","ext-mysqli","ext-imagick"]},"php":{"constraint":">=7.4","packages":[]},"read_at":"2026-11-08T09:16:40Z","source":"probe"},"role":"production","settings":{"fields":[{"bounds":{"default":536870912,"max":2147483648,"min":134217728,"step":67108864,"unit":"bytes"},"effective":536870912,"locked":false,"locked_reason":null,"name":"memory_limit","source":"site","value":536870912},{"bounds":{"default":300,"max":300,"min":60,"options":[60,120,300],"step":60,"unit":"seconds"},"effective":300,"locked":false,"locked_reason":null,"name":"max_execution_time","source":"site","value":300},{"bounds":{"max":200000,"min":1000,"type":"int"},"effective":20000,"locked":false,"locked_reason":null,"name":"max_input_vars","source":"site","value":20000},{"bounds":{"type":"bool"},"effective":false,"locked":true,"locked_reason":"production","name":"display_errors","source":"locked","value":null}],"legacy":{"apply":{"applied_at":null,"error":null,"operation":null,"state":"applied","state_label":"Applied"},"bounds":{"container_memory_limit_bytes":2617245696,"max_execution_time":{"options":[60,120,300]},"memory_headroom_bytes":268435456,"memory_limit":{"max":2147483648,"min":134217728,"step":67108864},"platform":"wordpress","post_max_size":{"max":1073741824,"min":2097152,"step":1048576},"tier":"M","upload_max_filesize":{"max":1073741824,"min":2097152,"step":1048576}},"container_memory_limit_bytes":2617245696,"notes":[],"php_version":"8.4","platform":"wordpress","settings":{"max_execution_time":{"default":300,"max":300,"min":60,"options":[60,120,300],"step":60,"unit":"seconds","value":300},"memory_limit":{"default":536870912,"max":2147483648,"min":134217728,"step":67108864,"unit":"bytes","value":536870912},"post_max_size":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456},"upload_max_filesize":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456}},"tier":"M","version":12},"shm":{"cap_mb":998,"percent":40}},"tools":[{"label":"7-Zip","name":"7z","path":"/usr/bin/7z","purpose":"Packs and unpacks 7z and other archives.","version":"25.01"},{"label":"avifenc","name":"avifenc","path":"/usr/bin/avifenc","purpose":"Converts images to AVIF.","version":"1.2.1"}],"version":12,"versions":[{"ack_detail":[],"allowed":false,"changes":[],"current":true,"eol_date":"2028-12-31","label":"PHP 8.4","reason":"This is the current version","requires_ack":[],"status":"supported","version":"8.4"}],"warnings":[],"xdebug":null}},"RuntimePhpRuntimeQueuedExample":{"summary":"The change waits for the site's window","value":{"adopting":false,"item_id":5120,"operation":null,"php_runtime":{"adopted":true,"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"apply":{"error":null,"operation":null,"pending_tonight":null},"custom_ini":{"banner":["; cf-runtime v1 php-custom.ini site=rs-northwind-harbourandfinch-example-com","; Managed by the control panel. Edits made here are overwritten."],"bytes":145,"content":"realpath_cache_size = 8M\n","lines":1,"max_bytes":32768,"overrides":[{"directive":"realpath_cache_size","line":1}]},"extensions":[{"available":true,"conflicts":[],"description":"A client for Redis and Valkey, for caches, sessions and queues.","enabled":false,"group":"caching","kind":"extension","label":"Redis","locked":false,"locked_reason":null,"name":"redis","non_production_only":false,"recommended":true,"required_by_app":false,"version":"6.3.0"}],"fpm":{"bounds":{"max_requests":{"max":100000,"min":100},"pm":["dynamic","ondemand","static"],"process_idle_timeout":{"max":300,"min":5}},"live":null,"max_children":null,"max_requests":500,"pm":"dynamic","process_idle_timeout":null,"source":{"max_children":"package","max_requests":"platform","pm":"platform","process_idle_timeout":"platform"}},"image":{"line":"new","minor":"8.4","patch":"8.4.9"},"last_applied_at":null,"locked":null,"requirements":{"application":{"name":"WordPress","version":"6.8.3"},"ext":{"by":{"imagick":["wordpress"]},"required":["ext-json","ext-mysqli","ext-imagick"]},"php":{"constraint":">=7.4","packages":[]},"read_at":"2026-11-08T09:16:40Z","source":"probe"},"role":"production","settings":{"fields":[{"bounds":{"max":200000,"min":1000,"type":"int"},"effective":20000,"locked":false,"locked_reason":null,"name":"max_input_vars","source":"site","value":20000}],"legacy":{"apply":{"applied_at":null,"error":null,"operation":null,"state":"applied","state_label":"Applied"},"bounds":{"container_memory_limit_bytes":2617245696,"max_execution_time":{"options":[60,120,300]},"memory_headroom_bytes":268435456,"memory_limit":{"max":2147483648,"min":134217728,"step":67108864},"platform":"wordpress","post_max_size":{"max":1073741824,"min":2097152,"step":1048576},"tier":"M","upload_max_filesize":{"max":1073741824,"min":2097152,"step":1048576}},"container_memory_limit_bytes":2617245696,"notes":[],"php_version":"8.4","platform":"wordpress","settings":{"max_execution_time":{"default":300,"max":300,"min":60,"options":[60,120,300],"step":60,"unit":"seconds","value":300},"memory_limit":{"default":536870912,"max":2147483648,"min":134217728,"step":67108864,"unit":"bytes","value":536870912},"post_max_size":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456},"upload_max_filesize":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456}},"tier":"M","version":12},"shm":{"cap_mb":998,"percent":40}},"tools":[{"label":"7-Zip","name":"7z","path":"/usr/bin/7z","purpose":"Packs and unpacks 7z and other archives.","version":"25.01"}],"version":12,"versions":[{"ack_detail":[],"allowed":false,"changes":[],"current":true,"eol_date":"2028-12-31","label":"PHP 8.4","reason":"This is the current version","requires_ack":[],"status":"supported","version":"8.4"}],"warnings":[],"xdebug":null},"queued":true,"warnings":[],"window_date":"2026-11-09"}},"RuntimePhpRuntimeRevertedExample":{"summary":"The restore started","value":{"adopting":false,"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-09T21:35:23Z","completed_at":null,"created_at":"2026-11-09T21:35:23Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"Picked up by PHP","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by PHP","state":"current"},{"key":"healthy","label":"Requests answered","state":"todo"}],"subject":null,"summary":"PHP configuration","to_version":null,"type":"php_runtime","type_label":"PHP configuration"},"php_runtime":{"adopted":true,"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"apply":{"error":null,"operation":{"id":5121,"status":"committed","status_label":"Waiting for the platform","summary":"custom_ini","to_version":null,"type":"php_runtime","type_label":"PHP configuration"},"pending_tonight":null},"custom_ini":{"banner":["; cf-runtime v1 php-custom.ini site=rs-northwind-harbourandfinch-example-com","; Managed by the control panel. Edits made here are overwritten."],"bytes":120,"content":"","lines":0,"max_bytes":32768,"overrides":[]},"extensions":[{"available":true,"conflicts":[],"description":"A client for Redis and Valkey, for caches, sessions and queues.","enabled":false,"group":"caching","kind":"extension","label":"Redis","locked":false,"locked_reason":null,"name":"redis","non_production_only":false,"recommended":true,"required_by_app":false,"version":"6.3.0"}],"fpm":{"bounds":{"max_requests":{"max":100000,"min":100},"pm":["dynamic","ondemand","static"],"process_idle_timeout":{"max":300,"min":5}},"live":null,"max_children":null,"max_requests":500,"pm":"dynamic","process_idle_timeout":null,"source":{"max_children":"package","max_requests":"platform","pm":"platform","process_idle_timeout":"platform"}},"image":{"line":"new","minor":"8.4","patch":"8.4.9"},"last_applied_at":null,"locked":null,"requirements":{"application":{"name":"WordPress","version":"6.8.3"},"ext":{"by":{"imagick":["wordpress"]},"required":["ext-json","ext-mysqli","ext-imagick"]},"php":{"constraint":">=7.4","packages":[]},"read_at":"2026-11-08T09:16:40Z","source":"probe"},"role":"production","settings":{"fields":[{"bounds":{"max":200000,"min":1000,"type":"int"},"effective":20000,"locked":false,"locked_reason":null,"name":"max_input_vars","source":"site","value":20000}],"legacy":{"apply":{"applied_at":null,"error":null,"operation":null,"state":"applied","state_label":"Applied"},"bounds":{"container_memory_limit_bytes":2617245696,"max_execution_time":{"options":[60,120,300]},"memory_headroom_bytes":268435456,"memory_limit":{"max":2147483648,"min":134217728,"step":67108864},"platform":"wordpress","post_max_size":{"max":1073741824,"min":2097152,"step":1048576},"tier":"M","upload_max_filesize":{"max":1073741824,"min":2097152,"step":1048576}},"container_memory_limit_bytes":2617245696,"notes":[],"php_version":"8.4","platform":"wordpress","settings":{"max_execution_time":{"default":300,"max":300,"min":60,"options":[60,120,300],"step":60,"unit":"seconds","value":300},"memory_limit":{"default":536870912,"max":2147483648,"min":134217728,"step":67108864,"unit":"bytes","value":536870912},"post_max_size":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456},"upload_max_filesize":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456}},"tier":"M","version":13},"shm":{"cap_mb":998,"percent":40}},"tools":[{"label":"7-Zip","name":"7z","path":"/usr/bin/7z","purpose":"Packs and unpacks 7z and other archives.","version":"25.01"}],"version":13,"versions":[{"ack_detail":[],"allowed":false,"changes":[],"current":true,"eol_date":"2028-12-31","label":"PHP 8.4","reason":"This is the current version","requires_ack":[],"status":"supported","version":"8.4"}],"warnings":[],"xdebug":null},"warnings":[]}},"RuntimePhpRuntimeStartedExample":{"summary":"The change started","value":{"adopting":false,"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":"2026-11-09T21:35:20Z","completed_at":null,"created_at":"2026-11-09T21:35:20Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"Picked up by PHP","notes":[],"parent_operation_id":null,"requested_by":{"id":2012,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by PHP","state":"current"},{"key":"healthy","label":"Requests answered","state":"todo"}],"subject":null,"summary":"PHP configuration","to_version":null,"type":"php_runtime","type_label":"PHP configuration"},"php_runtime":{"adopted":true,"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"apply":{"error":null,"operation":{"id":5121,"status":"committed","status_label":"Waiting for the platform","summary":"settings, custom_ini","to_version":null,"type":"php_runtime","type_label":"PHP configuration"},"pending_tonight":null},"custom_ini":{"banner":["; cf-runtime v1 php-custom.ini site=rs-northwind-harbourandfinch-example-com","; Managed by the control panel. Edits made here are overwritten."],"bytes":146,"content":"realpath_cache_size = 16M\n","lines":1,"max_bytes":32768,"overrides":[{"directive":"realpath_cache_size","line":1}]},"extensions":[{"available":true,"conflicts":[],"description":"A client for Redis and Valkey, for caches, sessions and queues.","enabled":false,"group":"caching","kind":"extension","label":"Redis","locked":false,"locked_reason":null,"name":"redis","non_production_only":false,"recommended":true,"required_by_app":false,"version":"6.3.0"}],"fpm":{"bounds":{"max_requests":{"max":100000,"min":100},"pm":["dynamic","ondemand","static"],"process_idle_timeout":{"max":300,"min":5}},"live":null,"max_children":null,"max_requests":500,"pm":"dynamic","process_idle_timeout":null,"source":{"max_children":"package","max_requests":"platform","pm":"platform","process_idle_timeout":"platform"}},"image":{"line":"new","minor":"8.4","patch":"8.4.9"},"last_applied_at":null,"locked":null,"requirements":{"application":{"name":"WordPress","version":"6.8.3"},"ext":{"by":{"imagick":["wordpress"]},"required":["ext-json","ext-mysqli","ext-imagick"]},"php":{"constraint":">=7.4","packages":[]},"read_at":"2026-11-08T09:16:40Z","source":"probe"},"role":"production","settings":{"fields":[{"bounds":{"max":200000,"min":1000,"type":"int"},"effective":30000,"locked":false,"locked_reason":null,"name":"max_input_vars","source":"site","value":30000}],"legacy":{"apply":{"applied_at":null,"error":null,"operation":null,"state":"applied","state_label":"Applied"},"bounds":{"container_memory_limit_bytes":2617245696,"max_execution_time":{"options":[60,120,300]},"memory_headroom_bytes":268435456,"memory_limit":{"max":2147483648,"min":134217728,"step":67108864},"platform":"wordpress","post_max_size":{"max":1073741824,"min":2097152,"step":1048576},"tier":"M","upload_max_filesize":{"max":1073741824,"min":2097152,"step":1048576}},"container_memory_limit_bytes":2617245696,"notes":[],"php_version":"8.4","platform":"wordpress","settings":{"max_execution_time":{"default":300,"max":300,"min":60,"options":[60,120,300],"step":60,"unit":"seconds","value":300},"memory_limit":{"default":536870912,"max":2147483648,"min":134217728,"step":67108864,"unit":"bytes","value":536870912},"post_max_size":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456},"upload_max_filesize":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456}},"tier":"M","version":13},"shm":{"cap_mb":998,"percent":40}},"tools":[{"label":"7-Zip","name":"7z","path":"/usr/bin/7z","purpose":"Packs and unpacks 7z and other archives.","version":"25.01"}],"version":13,"versions":[{"ack_detail":[],"allowed":false,"changes":[],"current":true,"eol_date":"2028-12-31","label":"PHP 8.4","reason":"This is the current version","requires_ack":[],"status":"supported","version":"8.4"}],"warnings":[],"xdebug":null},"warnings":[]}},"RuntimePhpRuntimeUnchangedExample":{"summary":"Nothing differs","value":{"adopting":false,"operation":null,"php_runtime":{"adopted":true,"adoption":{"adopt_now_refusal":null,"adopted":true,"can_adopt_now":false,"can_adopt_tonight":false,"in_progress":false,"planned_for":null,"queued_for":null,"revision":"v1"},"apply":{"error":null,"operation":null,"pending_tonight":null},"custom_ini":{"banner":["; cf-runtime v1 php-custom.ini site=rs-northwind-harbourandfinch-example-com","; Managed by the control panel. Edits made here are overwritten."],"bytes":145,"content":"realpath_cache_size = 8M\n","lines":1,"max_bytes":32768,"overrides":[{"directive":"realpath_cache_size","line":1}]},"extensions":[{"available":true,"conflicts":[],"description":"A client for Redis and Valkey, for caches, sessions and queues.","enabled":false,"group":"caching","kind":"extension","label":"Redis","locked":false,"locked_reason":null,"name":"redis","non_production_only":false,"recommended":true,"required_by_app":false,"version":"6.3.0"}],"fpm":{"bounds":{"max_requests":{"max":100000,"min":100},"pm":["dynamic","ondemand","static"],"process_idle_timeout":{"max":300,"min":5}},"live":null,"max_children":null,"max_requests":500,"pm":"dynamic","process_idle_timeout":null,"source":{"max_children":"package","max_requests":"platform","pm":"platform","process_idle_timeout":"platform"}},"image":{"line":"new","minor":"8.4","patch":"8.4.9"},"last_applied_at":null,"locked":null,"requirements":{"application":{"name":"WordPress","version":"6.8.3"},"ext":{"by":{"imagick":["wordpress"]},"required":["ext-json","ext-mysqli","ext-imagick"]},"php":{"constraint":">=7.4","packages":[]},"read_at":"2026-11-08T09:16:40Z","source":"probe"},"role":"production","settings":{"fields":[{"bounds":{"max":200000,"min":1000,"type":"int"},"effective":20000,"locked":false,"locked_reason":null,"name":"max_input_vars","source":"site","value":20000}],"legacy":{"apply":{"applied_at":null,"error":null,"operation":null,"state":"applied","state_label":"Applied"},"bounds":{"container_memory_limit_bytes":2617245696,"max_execution_time":{"options":[60,120,300]},"memory_headroom_bytes":268435456,"memory_limit":{"max":2147483648,"min":134217728,"step":67108864},"platform":"wordpress","post_max_size":{"max":1073741824,"min":2097152,"step":1048576},"tier":"M","upload_max_filesize":{"max":1073741824,"min":2097152,"step":1048576}},"container_memory_limit_bytes":2617245696,"notes":[],"php_version":"8.4","platform":"wordpress","settings":{"max_execution_time":{"default":300,"max":300,"min":60,"options":[60,120,300],"step":60,"unit":"seconds","value":300},"memory_limit":{"default":536870912,"max":2147483648,"min":134217728,"step":67108864,"unit":"bytes","value":536870912},"post_max_size":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456},"upload_max_filesize":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456}},"tier":"M","version":12},"shm":{"cap_mb":998,"percent":40}},"tools":[{"label":"7-Zip","name":"7z","path":"/usr/bin/7z","purpose":"Packs and unpacks 7z and other archives.","version":"25.01"}],"version":12,"versions":[{"ack_detail":[],"allowed":false,"changes":[],"current":true,"eol_date":"2028-12-31","label":"PHP 8.4","reason":"This is the current version","requires_ack":[],"status":"supported","version":"8.4"}],"warnings":[],"xdebug":null},"warnings":[]}},"RuntimePhpSettingsExample":{"summary":"A WordPress site","value":{"apply":{"applied_at":null,"error":null,"operation":null,"state":"applied","state_label":"Applied"},"bounds":{"container_memory_limit_bytes":2617245696,"max_execution_time":{"options":[60,120,300]},"memory_headroom_bytes":268435456,"memory_limit":{"max":2147483648,"min":134217728,"step":67108864},"platform":"wordpress","post_max_size":{"max":1073741824,"min":2097152,"step":1048576},"tier":"M","upload_max_filesize":{"max":1073741824,"min":2097152,"step":1048576}},"container_memory_limit_bytes":2617245696,"notes":[],"php_version":"8.4","platform":"wordpress","settings":{"max_execution_time":{"default":300,"max":300,"min":60,"options":[60,120,300],"step":60,"unit":"seconds","value":300},"memory_limit":{"default":536870912,"max":2147483648,"min":134217728,"step":67108864,"unit":"bytes","value":536870912},"post_max_size":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456},"upload_max_filesize":{"default":268435456,"max":1073741824,"min":2097152,"step":1048576,"unit":"bytes","value":268435456}},"tier":"M","version":12}},"SiteAccessExample":{"summary":"A site with the built-in user and one named user","value":{"apply":{"applied_at":"2026-11-03T10:03:10+00:00","error":null,"operation":null,"state":"applied","state_label":"Applied"},"company_keys":[],"connection":{"host":"ssh-northwind.example.net","port":20101,"ssh_user":"web","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20101 web@ssh-northwind.example.net"},"host_keys":{"current":[{"fingerprint":"SHA256:ExampleHostKeyEd25519FingerprintNotARealOne","type":"ed25519"}],"managed_by":"panel","next":null},"known_hosts":["[ssh-northwind.example.net]:20101 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAAAExampleHostKeyOnlyThisIsNotARealHostKey1"],"limits":{"company_keys_max":50,"keys_per_user_max":50,"root_path_suggestions":["htdocs","htdocs/wp-content/uploads","shared"],"users_max":25},"logins":{"web":{"command":"ssh -p 20101 web@ssh-northwind.example.net","login":"web"},"you":{"command":"ssh -p 20101 maya-northwind@ssh-northwind.example.net","delivered":true,"login":"maya-northwind","state":"ready"}},"persons":[],"ready_lines":{"rsync":"rsync -e 'ssh -p 20101' -a ./ web@ssh-northwind.example.net:/var/www/harbourandfinch.example.com/htdocs/","sftp":"sftp -P 20101 web@ssh-northwind.example.net","ssh":"ssh -p 20101 web@ssh-northwind.example.net","tunnel":"ssh -N -L 3306:127.0.0.1:3306 -p 20101 web@ssh-northwind.example.net"},"terminal":{"active_session":null,"available":true,"reason":null},"users":[{"can_change":false,"can_delete":false,"connection":{"command":"ssh -p 20101 web@ssh-northwind.example.net","sftp_command":"sftp -P 20101 web@ssh-northwind.example.net"},"created_at":"2026-11-02T10:15:00+00:00","created_by":null,"id":417,"keys":[{"added_at":"2026-11-03T10:02:44+00:00","added_by":{"id":2011,"name":"Maya Okafor"},"bits":null,"can_delete":true,"comment":null,"company_key_id":null,"fingerprint":"SHA256:O2Hqs6Iw0tDmPEeRkLTcr6n4V7Vhu5oPJRWviv9+2Ro","id":7308,"name":"Deployment service","origin":{"layer":"environment","owner":{"id":1342,"name":"Production","type":"environment"}},"restricted":false,"restrictions":[],"source":"user","status":"applied","status_label":"Applied","type":"ssh-ed25519"},{"added_at":"2026-11-02T10:15:00+00:00","added_by":null,"bits":null,"can_delete":false,"comment":null,"company_key_id":null,"fingerprint":"SHA256:ExampleDeployKeyFingerprintNotARealOne00000","id":0,"name":"Corefinity deploy key","origin":{"layer":"system","owner":null},"restricted":false,"restrictions":[],"source":"system","status":"applied","status_label":"Applied","type":"ssh-rsa"}],"kind":"built_in","label":null,"password":{"set":false,"set_at":null,"set_by":null},"root_path":null,"root_path_absolute":null,"status":"applied","status_label":"Applied","type":"ssh","type_label":"SSH + SFTP","uid":9991,"username":"web"},{"can_change":true,"can_delete":true,"connection":{"command":"ssh -p 20101 supplier@ssh-northwind.example.net","sftp_command":"sftp -P 20101 supplier@ssh-northwind.example.net"},"created_at":"2026-11-02T10:15:00+00:00","created_by":{"id":2011,"name":"Maya Okafor"},"id":3418,"keys":[{"added_at":"2026-11-03T10:02:44+00:00","added_by":null,"bits":null,"can_delete":true,"comment":null,"company_key_id":null,"fingerprint":"SHA256:KhDfvkk2rdhCA9zaR3SurL80w/B/MbslK5FOxIaEpY0","id":7312,"name":"Supplier laptop","restricted":false,"restrictions":[],"source":"user","status":"applied","status_label":"Applied","type":"ssh-ed25519"}],"kind":"named","label":"Print supplier","password":{"set":false,"set_at":null,"set_by":null},"root_path":null,"root_path_absolute":null,"status":"applied","status_label":"Applied","type":"ssh","type_label":"SSH + SFTP","uid":20001,"username":"supplier"}]}},"SiteAccessKeyAddedExample":{"summary":"A key added to a named user","value":{"key":{"added_at":"2026-11-05T09:16:40+00:00","added_by":{"id":2011,"name":"Maya Okafor"},"bits":null,"can_delete":true,"comment":"supplier@desktop","company_key_id":null,"fingerprint":"SHA256:oQwAERONEv3/COhZ7GWPxEIkoR6bRrONqBuTfNZJHBs","id":7313,"name":"Supplier desktop","restricted":false,"restrictions":[],"source":"user","status":"pending","status_label":"Applying","type":"ssh-ed25519"},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":17,"name":"WordPress Cluster 1"},"committed_at":"2026-11-05T09:16:40Z","completed_at":null,"created_at":"2026-11-05T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":true,"id":146,"install":null,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":2011,"name":"Maya Okafor"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"current"},{"key":"live","label":"Live","state":"todo"}],"subject":null,"summary":"Add key \"Supplier desktop\" to supplier","to_version":null,"type":"keys_change","type_label":"SSH keys"}}},"SiteAccessKeyRemovedExample":{"summary":"A key of a named user being removed","value":{"key":{"added_at":"2026-11-03T10:02:44+00:00","added_by":null,"bits":null,"can_delete":true,"comment":null,"company_key_id":null,"fingerprint":"SHA256:KhDfvkk2rdhCA9zaR3SurL80w/B/MbslK5FOxIaEpY0","id":7312,"name":"Supplier laptop","restricted":false,"restrictions":[],"source":"user","status":"removing","status_label":"Removing","type":"ssh-ed25519"},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":17,"name":"WordPress Cluster 1"},"committed_at":"2026-11-05T09:16:40Z","completed_at":null,"created_at":"2026-11-05T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":true,"id":147,"install":null,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":2011,"name":"Maya Okafor"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"current"},{"key":"live","label":"Live","state":"todo"}],"subject":null,"summary":"Remove key \"Supplier laptop\" from supplier","to_version":null,"type":"keys_change","type_label":"SSH keys"}}},"SiteAccessOperationExample":{"summary":"A completed change","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":17,"name":"WordPress Cluster 1"},"committed_at":"2026-11-05T09:16:40Z","completed_at":"2026-11-05T09:17:21Z","created_at":"2026-11-05T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":true,"id":5120,"install":null,"label":null,"notes":[],"parent_operation_id":null,"requested_by":{"id":2011,"name":"Maya Okafor"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"completed","status_label":"Done","step":null,"steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"done"},{"key":"live","label":"Live","state":"done"}],"subject":null,"summary":"Add SSH user supplier","to_version":null,"type":"users_change","type_label":"SSH / SFTP users"}}},"SiteAccessUserCreatedExample":{"summary":"An SFTP user with a generated password","value":{"access":{"apply":{"applied_at":"2026-11-03T10:03:10+00:00","error":null,"operation":{"id":5120,"scope":"site","status":"committed","status_label":"Waiting for the platform","summary":"Add SFTP user photographer","to_version":null,"type":"users_change","type_label":"SSH / SFTP users"},"state":"applying","state_label":"Applying"},"company_keys":[],"connection":{"host":"ssh-northwind.example.net","port":20101,"ssh_user":"web","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20101 web@ssh-northwind.example.net"},"limits":{"company_keys_max":50,"keys_per_user_max":50,"root_path_suggestions":["htdocs","htdocs/wp-content/uploads","shared"],"users_max":25},"terminal":{"active_session":null,"available":true,"reason":null},"users":[{"can_change":false,"can_delete":false,"connection":{"command":"ssh -p 20101 web@ssh-northwind.example.net","sftp_command":"sftp -P 20101 web@ssh-northwind.example.net"},"created_at":"2026-11-02T10:15:00+00:00","created_by":null,"id":417,"keys":[{"added_at":"2026-11-02T10:15:00+00:00","added_by":null,"bits":3072,"can_delete":false,"comment":"cfcp:deploy","company_key_id":null,"fingerprint":"SHA256:ExampleDeployKeyFingerprintNotARealOne00000","id":0,"name":"cfcp-deploy","restricted":false,"restrictions":[],"source":"system","status":"applied","status_label":"Applied","type":"ssh-rsa"}],"kind":"built_in","label":null,"password":{"set":false,"set_at":null,"set_by":null},"root_path":null,"root_path_absolute":null,"status":"applied","status_label":"Applied","type":"ssh","type_label":"SSH + SFTP","uid":9991,"username":"web"},{"can_change":true,"can_delete":true,"connection":{"command":null,"sftp_command":"sftp -P 20101 photographer@ssh-northwind.example.net"},"created_at":"2026-11-05T09:16:40+00:00","created_by":{"id":2011,"name":"Maya Okafor"},"id":419,"keys":[],"kind":"named","label":"Photographer","password":{"set":true,"set_at":"2026-11-05T09:16:40+00:00","set_by":{"id":2011,"name":"Maya Okafor"}},"root_path":"htdocs/wp-content/uploads","root_path_absolute":"/var/www/harbourandfinch.example.com/htdocs/wp-content/uploads","status":"pending","status_label":"Applying","type":"sftp","type_label":"SFTP only","uid":20002,"username":"photographer"},{"can_change":true,"can_delete":true,"connection":{"command":"ssh -p 20101 supplier@ssh-northwind.example.net","sftp_command":"sftp -P 20101 supplier@ssh-northwind.example.net"},"created_at":"2026-11-02T10:15:00+00:00","created_by":{"id":2011,"name":"Maya Okafor"},"id":3418,"keys":[{"added_at":"2026-11-03T10:02:44+00:00","added_by":null,"bits":null,"can_delete":true,"comment":null,"company_key_id":null,"fingerprint":"SHA256:KhDfvkk2rdhCA9zaR3SurL80w/B/MbslK5FOxIaEpY0","id":7312,"name":"Supplier laptop","restricted":false,"restrictions":[],"source":"user","status":"applied","status_label":"Applied","type":"ssh-ed25519"}],"kind":"named","label":"Print supplier","password":{"set":false,"set_at":null,"set_by":null},"root_path":null,"root_path_absolute":null,"status":"applied","status_label":"Applied","type":"ssh","type_label":"SSH + SFTP","uid":20001,"username":"supplier"}]},"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":17,"name":"WordPress Cluster 1"},"committed_at":"2026-11-05T09:16:40Z","completed_at":null,"created_at":"2026-11-05T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":true,"id":5120,"install":null,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":2011,"name":"Maya Okafor"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"current"},{"key":"live","label":"Live","state":"todo"}],"subject":null,"summary":"Add SFTP user photographer","to_version":null,"type":"users_change","type_label":"SSH / SFTP users"},"password":{"revealed_at":"2026-11-05T09:16:40+00:00","value":"ExamplePasswordAbc23"},"user":{"can_change":true,"can_delete":true,"connection":{"command":null,"sftp_command":"sftp -P 20101 photographer@ssh-northwind.example.net"},"created_at":"2026-11-05T09:16:40+00:00","created_by":{"id":2011,"name":"Maya Okafor"},"id":419,"keys":[],"kind":"named","label":"Photographer","password":{"set":true,"set_at":"2026-11-05T09:16:40+00:00","set_by":{"id":2011,"name":"Maya Okafor"}},"root_path":"htdocs/wp-content/uploads","root_path_absolute":"/var/www/harbourandfinch.example.com/htdocs/wp-content/uploads","status":"pending","status_label":"Applying","type":"sftp","type_label":"SFTP only","uid":20002,"username":"photographer"}}},"SiteAccessUserLabelledExample":{"summary":"A new label, answered at once","value":{"user":{"can_change":true,"can_delete":true,"connection":{"command":"ssh -p 20101 supplier@ssh-northwind.example.net","sftp_command":"sftp -P 20101 supplier@ssh-northwind.example.net"},"created_at":"2026-11-02T10:15:00+00:00","created_by":{"id":2011,"name":"Maya Okafor"},"id":3418,"keys":[{"added_at":"2026-11-03T10:02:44+00:00","added_by":null,"bits":null,"can_delete":true,"comment":null,"company_key_id":null,"fingerprint":"SHA256:KhDfvkk2rdhCA9zaR3SurL80w/B/MbslK5FOxIaEpY0","id":7312,"name":"Supplier laptop","restricted":false,"restrictions":[],"source":"user","status":"applied","status_label":"Applied","type":"ssh-ed25519"}],"kind":"named","label":"Print supplier (Leeds)","password":{"set":false,"set_at":null,"set_by":null},"root_path":null,"root_path_absolute":null,"status":"applied","status_label":"Applied","type":"ssh","type_label":"SSH + SFTP","uid":20001,"username":"supplier"}}},"SiteAccessUserRemovedExample":{"summary":"A user being removed","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":17,"name":"WordPress Cluster 1"},"committed_at":"2026-11-05T09:16:40Z","completed_at":null,"created_at":"2026-11-05T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":true,"id":145,"install":null,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":2011,"name":"Maya Okafor"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"current"},{"key":"live","label":"Live","state":"todo"}],"subject":null,"summary":"Remove user supplier","to_version":null,"type":"users_change","type_label":"SSH / SFTP users"},"user":{"can_change":false,"can_delete":false,"connection":{"command":"ssh -p 20101 supplier@ssh-northwind.example.net","sftp_command":"sftp -P 20101 supplier@ssh-northwind.example.net"},"created_at":"2026-11-02T10:15:00+00:00","created_by":{"id":2011,"name":"Maya Okafor"},"id":3418,"keys":[{"added_at":"2026-11-03T10:02:44+00:00","added_by":null,"bits":null,"can_delete":true,"comment":null,"company_key_id":null,"fingerprint":"SHA256:KhDfvkk2rdhCA9zaR3SurL80w/B/MbslK5FOxIaEpY0","id":7312,"name":"Supplier laptop","restricted":false,"restrictions":[],"source":"user","status":"applied","status_label":"Applied","type":"ssh-ed25519"}],"kind":"named","label":"Print supplier","password":{"set":false,"set_at":null,"set_by":null},"root_path":null,"root_path_absolute":null,"status":"removing","status_label":"Removing","type":"ssh","type_label":"SSH + SFTP","uid":20001,"username":"supplier"}}},"SiteAccessUserUpdatedExample":{"summary":"A generated password for an existing user","value":{"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":17,"name":"WordPress Cluster 1"},"committed_at":"2026-11-05T09:16:40Z","completed_at":null,"created_at":"2026-11-05T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":true,"id":144,"install":null,"label":"Picked up by the platform","notes":[],"parent_operation_id":null,"requested_by":{"id":2011,"name":"Maya Okafor"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"saved","label":"Saved","state":"done"},{"key":"applied","label":"Picked up by the platform","state":"current"},{"key":"live","label":"Live","state":"todo"}],"subject":null,"summary":"Set the password of supplier","to_version":null,"type":"users_change","type_label":"SSH / SFTP users"},"password":{"revealed_at":"2026-11-05T09:16:40+00:00","value":"ExamplePasswordAbc23"},"user":{"can_change":true,"can_delete":true,"connection":{"command":"ssh -p 20101 supplier@ssh-northwind.example.net","sftp_command":"sftp -P 20101 supplier@ssh-northwind.example.net"},"created_at":"2026-11-02T10:15:00+00:00","created_by":{"id":2011,"name":"Maya Okafor"},"id":3418,"keys":[{"added_at":"2026-11-03T10:02:44+00:00","added_by":null,"bits":null,"can_delete":true,"comment":null,"company_key_id":null,"fingerprint":"SHA256:KhDfvkk2rdhCA9zaR3SurL80w/B/MbslK5FOxIaEpY0","id":7312,"name":"Supplier laptop","restricted":false,"restrictions":[],"source":"user","status":"applied","status_label":"Applied","type":"ssh-ed25519"}],"kind":"named","label":"Print supplier","password":{"set":true,"set_at":"2026-11-05T09:16:40+00:00","set_by":{"id":2011,"name":"Maya Okafor"}},"root_path":null,"root_path_absolute":null,"status":"applied","status_label":"Applied","type":"ssh","type_label":"SSH + SFTP","uid":20001,"username":"supplier"}}},"SiteAccessWebKeyAddedExample":{"summary":"A key added to the built-in user, as an environment key","value":{"change_id":48218,"converted_from":null,"key":{"added_at":"2026-11-05T09:16:40+00:00","added_by":{"former":false,"name":"Maya Okafor","support":false},"also_granted":[],"applies_to":null,"bits":null,"delivery":{"applied":0,"not_on_new_system":0,"removed":0,"state":"applying","total":1,"waiting":0,"waiting_platform_update":0},"editable":true,"fingerprint":"SHA256:CLqzToSA4nOd3+meykf1UbpDyB5Jwm32ErgxuitkRIU","id":7307,"last_used_at":null,"layer":"environment","legacy":null,"lifecycle":"active","login":"web","name":"Build server","owner":{"id":1342,"name":"Production","type":"environment"},"quarantine_reason":null,"reach":{"clients":0,"environments":1,"websites":1},"removable":true,"restricted":false,"restrictions":[],"type":"ssh-ed25519","weak":false},"notices":[]}},"SiteDeploymentArtifactPrunedRefusalExample":{"summary":"The release archive was removed","value":{"code":"artifact_pruned","message":"This deployment's archive was removed after 30 days, so it can't be retried or rolled back. Deploy again from the branch or commit.","reason":"artifact_pruned"}},"SiteDeploymentBusyRefusalExample":{"summary":"Another change to the site is in progress","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"SiteDeploymentModeGitExample":{"summary":"The site's files are being moved into the releases layout","value":{"operation":{"applied_at":"2026-11-09T09:16:40Z","can_retry":false,"cluster":{"id":17,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-09T09:16:40Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":"plain","hot":false,"id":4410,"install":null,"label":"Release prepared","notes":[],"parent_operation_id":null,"requested_by":{"id":3301,"name":"Daniel Reyes"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"executing","status_label":"Preparing the first release","step":"prepared","steps":[{"key":"prepared","label":"Release prepared","state":"current"},{"key":"converted","label":"Files moved into releases","state":"todo"},{"key":"verified","label":"Verified","state":"todo"}],"subject":null,"summary":"Move the site's files into the releases layout","to_version":"releases","type":"releases_convert","type_label":"Deployment layout"},"settings":{"can_deploy":{"available":false,"reason":"Connect a repository first"},"can_rollback":{"available":false,"reason":"There is no earlier release to roll back to"},"connections":[],"conversion":{"id":4410,"scope":"site","status":"executing","status_label":"Running","summary":"Move the site's files into the releases layout","to_version":"releases","type":"releases_convert","type_label":"Deployment layout"},"deployments":[],"layout":"plain","manual":{"note":"Files you change over SFTP or in the terminal are live on refresh","sftp_command":"sftp -P 20001 web@ssh-northwind.example.net"},"mode":"git","mode_label":"Git","node":{"adopted":false,"major":null},"pipeline":{"bindings":[],"version":3},"releases":{"count":0,"current":null,"keep":5,"previous":null},"repository":null,"repository_options":{"default_contents":"whole_site","default_target_path":null,"layout_target_path":"wp-content","release_root":"","site_content":true}}}},"SiteDeploymentModeManualExample":{"summary":"The site already deploys by upload","value":{"command":null,"settings":{"can_change_mode":{"available":true,"reason":null},"can_change_repository":{"available":true,"reason":null},"can_deploy":{"available":false,"reason":"Switch this site to git deployments first"},"can_retry_deployments":{"available":true,"reason":null},"can_rollback":{"available":false,"reason":"Switch this site to git deployments first"},"can_stop_deployments":{"available":true,"reason":null},"can_switch_to_git":{"available":true,"reason":null},"can_turn_off_auto_deploy":{"available":true,"reason":null},"can_turn_on_auto_deploy":{"available":true,"reason":null},"connections":[{"id":4217,"label":"GitLab (self-hosted) · daniel-reyes","needs_reauth":false,"provider":"gitlab_self_hosted","provider_label":"GitLab (self-hosted)"}],"conversion":null,"deployments":[],"layout":"plain","manual":{"note":"Files you change over SFTP or in the terminal are live on refresh","sftp_command":"sftp -P 20001 web@ssh-northwind.example.net"},"mode":"manual","mode_label":"Manual","node":{"adopted":false,"major":null},"pipeline":{"bindings":[],"version":3},"releases":{"count":0,"current":null,"keep":5,"previous":null},"repository":null,"repository_options":{"default_contents":"whole_site","default_target_path":null,"layout_target_path":"wp-content","release_root":"","site_content":true}}}},"SiteDeploymentModeRefusalExample":{"summary":"The site deploys by upload","value":{"code":"mode","message":"Switch this site to git deployments first","reason":"mode"}},"SiteDeploymentPipelineExample":{"summary":"A Laravel site's pipeline","value":{"binding_id":2210,"bindings":[{"id":2210,"is_default":false,"label":"harbourandfinch.example.com","tag":null}],"can":{"edit":true,"edit_code":null,"edit_reason":null,"rehearse":true,"rehearse_code":null,"rehearse_reason":null},"carry_over":null,"classic":null,"conversion":null,"locked":null,"options":{"build_reads":[],"cloudflare_purge":false,"extra_shared_paths":[],"migrate":false,"platform_shared":[{"kind":"dir","path":"storage"},{"kind":"file","path":".env"}],"pre_switch_check":false,"snapshot_before_upgrade":false,"warm_up":false},"origin":null,"presets":{"detected":[],"offered":[{"key":"laravel_standard","kind":"platform","label":"Laravel standard"},{"key":"none","kind":"platform","label":"No build"},{"key":"vite","kind":"frontend","label":"Vite"},{"key":"laravel_mix","kind":"frontend","label":"Laravel Mix"}]},"revision":"1537f080a2c1e2d9","saved":{"at":"2026-11-09T10:42:07Z","by":{"name":"Maya Okafor","token":null},"number":1,"source":"editor"},"settings":{"keep_node_modules":false,"maintenance_policy":"off","pause_crons":"auto","run_migrations":null,"timeouts":{"build":3600,"build_line":3600,"database_line":600,"post_line":600},"tunnels":"auto"},"stage_model":"three_stage","stages":{"build":{"effective":[],"hooks":[],"lines":[],"mode":"preset","preset":{"frontend":[],"options":[],"platform":"none"}},"database":{"lines":[],"platform_step_at":0},"post_deploy":{"lines":[{"badges":[],"comments":[],"origin":"custom","text":"php artisan queue:restart","verdict":"services"},{"badges":[{"id":"replaced_by_platform","label":"Replaced by a CoreStack step","severity":"info"}],"comments":[],"origin":"custom","text":"php artisan config:cache","verdict":"platform_duplicate"}]}}}},"SiteDeploymentQueuedExample":{"summary":"A deployment that is queued","value":{"deployment":{"attempt_id":8035,"binding":{"id":2211,"label":"Default pipeline"},"can_retry":false,"can_rollback":false,"can_stop":false,"crons_paused":null,"duration_seconds":null,"error":null,"finished_at":null,"git_author":null,"git_commit_url":null,"git_merge_request":null,"href":"/resources/deployments/5127","id":5127,"is_current":false,"maintenance_lift":null,"queued_at":"2026-11-09T09:16:40Z","ref":{"branch":"main","message":"Fix the basket count in the mobile header","sha":"9730595c6ec7aa59b77674ada74e30d961b1817c","short_sha":"9730595"},"release_id":null,"requested_by":{"id":3301,"name":"Daniel Reyes"},"retry_warning":null,"stage":null,"stage_label":null,"started_at":null,"status":"queued","status_label":"Queued","stop_termination":null,"task":null,"trigger":"manual"}}},"SiteDeploymentRepoShapeRefusalExample":{"summary":"The repository is not written as owner/name","value":{"code":"invalid","errors":{"repo":["Enter the repository as owner/name","or group/subgroup/name on GitLab"]},"field":"repo","message":"Enter the repository as owner/name, or group/subgroup/name on GitLab","reason":"invalid"}},"SiteDeploymentRepositorySavedExample":{"summary":"The repository is connected","value":{"settings":{"can_change_mode":{"available":true,"reason":null},"can_change_repository":{"available":true,"reason":null},"can_deploy":{"available":true,"reason":null},"can_retry_deployments":{"available":true,"reason":null},"can_rollback":{"available":true,"reason":null},"can_stop_deployments":{"available":true,"reason":null},"can_switch_to_git":{"available":true,"reason":null},"can_turn_off_auto_deploy":{"available":true,"reason":null},"can_turn_on_auto_deploy":{"available":true,"reason":null},"connections":[{"id":4217,"label":"GitLab (self-hosted) · daniel-reyes","needs_reauth":false,"provider":"gitlab_self_hosted","provider_label":"GitLab (self-hosted)"}],"conversion":null,"deployments":[{"attempt_id":8035,"binding":{"id":2211,"label":"Default pipeline"},"can_retry":false,"can_rollback":false,"can_stop":false,"crons_paused":null,"duration_seconds":131,"error":null,"finished_at":"2026-11-09T09:18:55Z","git_author":{"avatar_url":null,"name":"Daniel Reyes"},"git_commit_url":"https://gitlab.example.com/northwind-digital/harbourandfinch/-/commit/9730595c6ec7aa59b77674ada74e30d961b1817c","git_merge_request":null,"href":"/resources/deployments/5127","id":5127,"is_current":true,"maintenance_lift":null,"queued_at":"2026-11-09T09:16:40Z","ref":{"branch":"main","message":"Fix the basket count in the mobile header","sha":"9730595c6ec7aa59b77674ada74e30d961b1817c","short_sha":"9730595"},"release_id":"10f3c268-99c9-4c4e-9e8c-d467a321b123","requested_by":null,"retry_warning":null,"stage":null,"stage_label":null,"started_at":"2026-11-09T09:16:44Z","status":"succeeded","status_label":"Succeeded","stop_termination":null,"task":null,"trigger":"webhook"},{"attempt_id":7990,"binding":{"id":2211,"label":"Default pipeline"},"can_retry":false,"can_rollback":true,"can_stop":false,"crons_paused":null,"duration_seconds":136,"error":null,"finished_at":"2026-11-02T14:07:31Z","git_author":null,"git_commit_url":null,"git_merge_request":null,"href":"/resources/deployments/5098","id":5098,"is_current":false,"maintenance_lift":null,"queued_at":"2026-11-02T14:05:12Z","ref":{"branch":"main","message":"Update the header","sha":"f7ba9cd79a612311f0487855eb0d96839161550e","short_sha":"f7ba9cd"},"release_id":"2245ae09-7793-49fa-850b-225c62855fce","requested_by":{"id":3301,"name":"Daniel Reyes"},"retry_warning":null,"stage":null,"stage_label":null,"started_at":"2026-11-02T14:05:15Z","status":"succeeded","status_label":"Succeeded","stop_termination":null,"task":null,"trigger":"manual"}],"layout":"releases","manual":{"note":"Files you change over SFTP or in the terminal are live on refresh","sftp_command":"sftp -P 20001 web@ssh-northwind.example.net"},"mode":"git","mode_label":"Git","node":{"adopted":false,"major":null},"pipeline":{"bindings":[{"id":2211,"is_default":true,"label":"Default pipeline","tag":null}],"version":3},"releases":{"count":2,"current":{"deployed_at":"2026-11-09T09:18:55Z","id":"10f3c268-99c9-4c4e-9e8c-d467a321b123","ref":{"branch":"main","message":"Fix the basket count in the mobile header","sha":"9730595c6ec7aa59b77674ada74e30d961b1817c","short_sha":"9730595"}},"keep":5,"previous":{"deployed_at":"2026-11-02T14:07:31Z","id":"2245ae09-7793-49fa-850b-225c62855fce"}},"repository":{"auto_deploy":true,"branch":"main","connection":{"id":4217,"label":"GitLab (self-hosted) · daniel-reyes","needs_reauth":false,"provider":"gitlab_self_hosted","provider_label":"GitLab (self-hosted)"},"contents":"whole_site","effective_target_path":null,"repo":"northwind-digital/harbourandfinch","root_directory":"","target_path":null,"url":"https://gitlab.example.com/northwind-digital/harbourandfinch","webhook":{"error":null,"last_received_at":"2026-11-09T09:16:38Z","state":"active"}},"repository_options":{"default_contents":"whole_site","default_target_path":null,"layout_target_path":"wp-content","release_root":"","site_content":true}}}},"SiteDeploymentRollbackExample":{"summary":"A rollback that is queued","value":{"deployment":{"attempt_id":8038,"binding":{"id":2211,"label":"Default pipeline"},"can_retry":false,"can_rollback":false,"can_stop":false,"crons_paused":null,"duration_seconds":null,"error":null,"finished_at":null,"git_author":null,"git_commit_url":null,"git_merge_request":null,"href":"/resources/deployments/5131","id":5131,"is_current":false,"maintenance_lift":null,"queued_at":"2026-11-09T10:02:11Z","ref":{"branch":"main","message":null,"sha":"f7ba9cd79a612311f0487855eb0d96839161550e","short_sha":"f7ba9cd"},"release_id":"26474c25-c9ec-427f-9c8c-e9ed06a7863a","requested_by":{"id":3301,"name":"Daniel Reyes"},"retry_warning":null,"stage":null,"stage_label":null,"started_at":null,"status":"queued","status_label":"Queued","stop_termination":null,"task":null,"trigger":"rollback"}}},"SiteDeploymentRunningRefusalExample":{"summary":"Another deployment is running","value":{"code":"deployment_running","message":"A deployment is running. Wait for it to finish, or stop it from its page.","reason":"deployment_running"}},"SiteDeploymentSecretListExample":{"summary":"One Composer credential","value":{"data":[{"auth_type":"bearer","id":318,"kind":"composer","label":"Harbour & Finch packages","last4":"oken","last_used_at":null,"registry":"repo.example.com","scope":"","verified_at":null}]}},"SiteDeploymentSecretVerifiedExample":{"summary":"A credential the registry accepted","value":{"data":[{"auth_type":"bearer","id":318,"kind":"composer","label":"Private packages","last4":"oken","last_used_at":null,"registry":"repo.example.com","scope":"","verified_at":"2026-11-09T10:42:07Z"}],"verification":{"id":318,"message":"The registry accepted these credentials.","verified":true,"verified_at":"2026-11-09T10:42:07Z"}}},"SiteDeploymentSettingsGitExample":{"summary":"A site that deploys from git","value":{"can_change_mode":{"available":true,"reason":null},"can_change_repository":{"available":true,"reason":null},"can_deploy":{"available":true,"reason":null},"can_retry_deployments":{"available":true,"reason":null},"can_rollback":{"available":true,"reason":null},"can_stop_deployments":{"available":true,"reason":null},"can_switch_to_git":{"available":true,"reason":null},"can_turn_off_auto_deploy":{"available":true,"reason":null},"can_turn_on_auto_deploy":{"available":true,"reason":null},"connections":[{"id":4217,"label":"GitLab (self-hosted) · daniel-reyes","needs_reauth":false,"provider":"gitlab_self_hosted","provider_label":"GitLab (self-hosted)"}],"conversion":null,"deployments":[{"attempt_id":8035,"binding":{"id":2211,"label":"Default pipeline"},"can_retry":false,"can_rollback":false,"can_stop":false,"crons_paused":null,"duration_seconds":131,"error":null,"finished_at":"2026-11-09T09:18:55Z","git_author":{"avatar_url":null,"name":"Daniel Reyes"},"git_commit_url":"https://gitlab.example.com/northwind-digital/harbourandfinch/-/commit/9730595c6ec7aa59b77674ada74e30d961b1817c","git_merge_request":null,"href":"/resources/deployments/5127","id":5127,"is_current":true,"maintenance_lift":null,"queued_at":"2026-11-09T09:16:40Z","ref":{"branch":"main","message":"Fix the basket count in the mobile header","sha":"9730595c6ec7aa59b77674ada74e30d961b1817c","short_sha":"9730595"},"release_id":"10f3c268-99c9-4c4e-9e8c-d467a321b123","requested_by":null,"retry_warning":null,"stage":null,"stage_label":null,"started_at":"2026-11-09T09:16:44Z","status":"succeeded","status_label":"Succeeded","stop_termination":null,"task":null,"trigger":"webhook"},{"attempt_id":7990,"binding":{"id":2211,"label":"Default pipeline"},"can_retry":false,"can_rollback":true,"can_stop":false,"crons_paused":null,"duration_seconds":136,"error":null,"finished_at":"2026-11-02T14:07:31Z","git_author":null,"git_commit_url":null,"git_merge_request":null,"href":"/resources/deployments/5098","id":5098,"is_current":false,"maintenance_lift":null,"queued_at":"2026-11-02T14:05:12Z","ref":{"branch":"main","message":"Update the header","sha":"f7ba9cd79a612311f0487855eb0d96839161550e","short_sha":"f7ba9cd"},"release_id":"2245ae09-7793-49fa-850b-225c62855fce","requested_by":{"id":3301,"name":"Daniel Reyes"},"retry_warning":null,"stage":null,"stage_label":null,"started_at":"2026-11-02T14:05:15Z","status":"succeeded","status_label":"Succeeded","stop_termination":null,"task":null,"trigger":"manual"}],"layout":"releases","manual":{"note":"Files you change over SFTP or in the terminal are live on refresh","sftp_command":"sftp -P 20001 web@ssh-northwind.example.net"},"mode":"git","mode_label":"Git","node":{"adopted":false,"major":null},"pipeline":{"bindings":[{"id":2211,"is_default":true,"label":"Default pipeline","tag":null}],"version":3},"releases":{"count":2,"current":{"deployed_at":"2026-11-09T09:18:55Z","id":"10f3c268-99c9-4c4e-9e8c-d467a321b123","ref":{"branch":"main","message":"Fix the basket count in the mobile header","sha":"9730595c6ec7aa59b77674ada74e30d961b1817c","short_sha":"9730595"}},"keep":5,"previous":{"deployed_at":"2026-11-02T14:07:31Z","id":"2245ae09-7793-49fa-850b-225c62855fce"}},"repository":{"auto_deploy":true,"branch":"main","connection":{"id":4217,"label":"GitLab (self-hosted) · daniel-reyes","needs_reauth":false,"provider":"gitlab_self_hosted","provider_label":"GitLab (self-hosted)"},"contents":"whole_site","effective_target_path":null,"repo":"northwind-digital/harbourandfinch","root_directory":"","target_path":null,"url":"https://gitlab.example.com/northwind-digital/harbourandfinch","webhook":{"error":null,"last_received_at":"2026-11-09T09:16:38Z","state":"active"}},"repository_options":{"default_contents":"whole_site","default_target_path":null,"layout_target_path":"wp-content","release_root":"","site_content":true}}},"SiteDeploymentSettingsManualExample":{"summary":"A site that deploys by upload","value":{"can_change_mode":{"available":true,"reason":null},"can_change_repository":{"available":true,"reason":null},"can_deploy":{"available":false,"reason":"Switch this site to git deployments first"},"can_retry_deployments":{"available":true,"reason":null},"can_rollback":{"available":false,"reason":"Switch this site to git deployments first"},"can_stop_deployments":{"available":true,"reason":null},"can_switch_to_git":{"available":true,"reason":null},"can_turn_off_auto_deploy":{"available":true,"reason":null},"can_turn_on_auto_deploy":{"available":true,"reason":null},"connections":[{"id":4217,"label":"GitLab (self-hosted) · daniel-reyes","needs_reauth":false,"provider":"gitlab_self_hosted","provider_label":"GitLab (self-hosted)"}],"conversion":null,"deployments":[],"layout":"plain","manual":{"note":"Files you change over SFTP or in the terminal are live on refresh","sftp_command":"sftp -P 20001 web@ssh-northwind.example.net"},"mode":"manual","mode_label":"Manual","node":{"adopted":false,"major":null},"pipeline":{"bindings":[],"version":3},"releases":{"count":0,"current":null,"keep":5,"previous":null},"repository":null,"repository_options":{"default_contents":"whole_site","default_target_path":null,"layout_target_path":"wp-content","release_root":"","site_content":true}}},"SiteDeploymentStoppedExample":{"summary":"A deployment that was stopped","value":{"deployment":{"attempt_id":8035,"binding":{"id":2211,"label":"Default pipeline"},"can_retry":false,"can_rollback":false,"can_stop":false,"crons_paused":null,"duration_seconds":null,"error":null,"finished_at":"2026-11-09T09:17:02Z","git_author":null,"git_commit_url":null,"git_merge_request":null,"href":"/resources/deployments/5127","id":5127,"is_current":false,"maintenance_lift":null,"queued_at":"2026-11-09T09:16:40Z","ref":{"branch":"main","message":"Fix the basket count in the mobile header","sha":"9730595c6ec7aa59b77674ada74e30d961b1817c","short_sha":"9730595"},"release_id":null,"requested_by":{"id":3301,"name":"Daniel Reyes"},"retry_warning":null,"stage":null,"stage_label":null,"started_at":null,"status":"cancelled","status_label":"Cancelled","stop_termination":null,"task":null,"trigger":"manual"}}},"SiteDeploymentVariableListExample":{"summary":"Two variables","value":{"data":[{"log_visibility":"hidden","masked":"••••••••cret","name":"API_TOKEN","overrides":null,"replaces_platform":false,"tool_credential":null,"updated_at":"2026-11-09T10:42:07Z","updated_by":null,"used_in":[]},{"log_visibility":"shown","masked":"••••••••.com","name":"API_URL","overrides":null,"replaces_platform":false,"tool_credential":null,"updated_at":"2026-11-09T10:42:07Z","updated_by":null,"used_in":[]}],"inherited":[]}},"SiteDeploymentVariableNameFormatExample":{"summary":"A name that is not in the expected format","value":{"code":"invalid","errors":{"name":["The name argument is not in the expected format."]},"field":"name","message":"Some arguments are not valid.","reason":"invalid"}},"SiteDetailExample":{"summary":"A WordPress site in a CoreCluster","value":{"site":{"access_summary":{"apply_state":"applied","company_keys":0,"keys":0,"users":1},"actions":{"attach_domain":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"restore_deleted":{"available":false,"reason":"This site is not deleted"}},"adoption":"adopted","cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"Northwind UK 1"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":false,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"journal.harbourandfinch.example.com","domains_summary":{"aliases":0,"dns":"unknown","noindex":false,"primary":"journal.harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"preview"},"environment":{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-journal-harbourandfinch-example-com","hostname":"journal-harbourandfinch-example-com.northwind.cfstack.example.net","id":1051,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"healthy","hosting":{"cluster_kind":"customer","label":"CoreCluster Northwind UK 1"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1051,"kind":"corecluster","lifecycle":"active","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.8"},"mode":"production","mode_label":"Domain attached","operation":null,"operations":[],"package":null,"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://journal-harbourandfinch-example-com.northwind.cfstack.example.net"},"primary_url":"https://journal.harbourandfinch.example.com","production_hosts":["journal.harbourandfinch.example.com"],"provisioning":null,"removed":false,"restore":null,"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"journal.harbourandfinch.example.com","id":1051},"site_id":"rs-northwind-journal-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"off","effective_label":"Off","latest":null,"latest_ready_at":null,"next_scheduled_at":null,"overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20031 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20031,"sftp_command":"sftp -P 20031 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20031 web@ssh-northwind.example.net","user":"web","users":1},"tier":"S","uat_size":null,"usage":{"cpu_millicores":180,"disk_used_bytes":2147483648,"memory_bytes":912261120,"observed_at":"2026-11-03T09:10:00Z","source":"live"}}}},"SiteLogsContextExample":{"summary":"A line with one line either side","value":{"after":[{"fields":{"level":"info","method":"GET","src":"nginx-access","status":200},"msg":"GET /products/4 200","source":"web-access","stream_id":"00000001000000006754af9632a2745e85c293e5aac08633","time":"2026-11-03T09:54:00Z"}],"before":[{"fields":{"level":"info","method":"GET","src":"nginx-access","status":200},"msg":"GET /products/2 200","source":"web-access","stream_id":"00000001000000006754af9632a2745e85c293e5aac08633","time":"2026-11-03T09:52:00Z"}],"line":{"fields":{"level":"info","method":"GET","src":"nginx-access","status":200},"msg":"GET /products/3 200","source":"web-access","stream_id":"00000001000000006754af9632a2745e85c293e5aac08633","time":"2026-11-03T09:53:00Z"}}},"SiteLogsQueryExample":{"summary":"Two server errors","value":{"effective_query":"status:>=500","kind":"records","lines":[{"fields":{"level":"error","method":"GET","src":"nginx-access","status":502},"msg":"GET /checkout 502","source":"web-access","stream_id":"00000001000000006754af9632a2745e85c293e5aac08633","time":"2026-11-03T09:55:41.215Z"},{"fields":{"level":"error","method":"POST","src":"nginx-access","status":500},"msg":"POST /basket/add 500","source":"web-access","stream_id":"00000001000000006754af9632a2745e85c293e5aac08633","time":"2026-11-03T09:52:07.004Z"}],"next_cursor":null,"stats":{"duration_ms":84},"table":null,"tenant":{"percent":42,"quota_gb":20,"retention_days":90,"state":"ok","stored_gb":8.4},"truncated":false,"warnings":[],"window":{"from":"2026-11-03T09:00:00.000000000Z","to":"2026-11-03T10:00:00.000000000Z"}}},"SiteLogsSavedQueryExample":{"summary":"A query kept for one site","value":{"can_delete":true,"created_at":"2026-11-03T10:00:00Z","filters":null,"id":3318,"name":"Checkout errors","query":"status:>=500","range":"24h","shared":false,"site":{"domain":"harbourandfinch.example.com","id":1042},"source":"web-access"}},"SiteLogsSavedQueryListExample":{"summary":"One query for the site and one for every site","value":{"items":[{"can_delete":true,"created_at":"2026-11-03T10:00:00Z","filters":null,"id":3318,"name":"Checkout errors","query":"status:>=500","range":"24h","shared":false,"site":{"domain":"harbourandfinch.example.com","id":1042},"source":"web-access"},{"can_delete":true,"created_at":"2026-11-01T14:31:07Z","filters":{"level":["warning","error"]},"id":3290,"name":"PHP warnings","query":null,"range":"7d","shared":false,"site":null,"source":"php"}]}},"SiteLogsStreamsExample":{"summary":"The sources of a WordPress site","value":{"limits":{"max_limit":1000,"max_query_bytes":4096,"max_range_days":90,"queries_per_minute":150,"timeout_seconds":15},"ranges":["15m","1h","6h","24h","7d","30d"],"sources":[{"available":true,"key":"all","label":"All","reason":null},{"available":true,"key":"web-access","label":"Web access","reason":null},{"available":true,"key":"web-error","label":"Web errors","reason":null},{"available":true,"key":"php","label":"PHP","reason":null},{"available":true,"key":"app","label":"Application","reason":null},{"available":true,"key":"cron","label":"Cron","reason":null},{"available":true,"key":"database","label":"Database","reason":null},{"available":true,"key":"cache","label":"Cache","reason":null},{"available":false,"key":"search","label":"Search","reason":"not_collected"},{"available":false,"key":"queue","label":"Queue","reason":"not_collected"}],"tenant":{"percent":42,"quota_gb":20,"retention_days":90,"state":"ok","stored_gb":8.4},"unpack_json":true}},"SiteLogsUsageExample":{"summary":"A website's usage, the last three of its 30 days shown","value":{"addon":{"monthly":{"amount":"2.00","currency":"GBP"},"purchased_gb":20,"unit":"log_storage_gb","unit_price":{"amount":"0.10","currency":"GBP"}},"by_environment":[{"environment":{"env_id":"harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"percent":90,"stored_bytes":7600000000},{"environment":{"env_id":"harbourandfinch-example-com--staging","hostname":"staging-harbourandfinch-example-com.northwind.cfstack.example.net","id":1043,"name":"Staging","role":"staging","role_label":"Staging","slug":"staging"},"percent":10,"stored_bytes":800000000}],"daily":[{"day":"2026-11-01","ingested_bytes":1580000000,"rows":1230000,"stored_bytes":395000000},{"day":"2026-11-02","ingested_bytes":1600000000,"rows":1245000,"stored_bytes":400000000},{"day":"2026-11-03","ingested_bytes":610000000,"rows":470000,"stored_bytes":152000000}],"forecast":{"days_to_quota":62,"next_enforce_at":null},"percent":21,"quota":{"included_gb":20,"purchased_gb":20},"quota_gb":40,"retention_days":90,"stored_gb":8.4,"tenant":{"owner":{"ref":{"domain":"harbourandfinch.example.com","id":1042},"type":"site"},"state":"ok"}}},"SnapshotClusterSettingsExample":{"summary":"A CoreCluster that takes snapshots daily","value":{"can_change_frequency":true,"can_change_limits":false,"enabled":true,"frequency":"daily","frequency_label":"Daily","frequency_options":[{"label":"Every hour","value":"1h"},{"label":"Every 2 hours","value":"2h"},{"label":"Every 3 hours","value":"3h"},{"label":"Every 4 hours","value":"4h"},{"label":"Every 6 hours","value":"6h"},{"label":"Every 12 hours","value":"12h"},{"label":"Daily","value":"daily"},{"label":"Weekly","value":"weekly"},{"label":"Monthly","value":"monthly"},{"label":"Off","value":"off"}],"over_quota":false,"protect_cap_bytes":53687091200,"protected_bytes":6442450944,"pruned_recently":false,"quota_bytes":107374182400,"retention_days":30,"usage_bytes":21474836480,"usage_synced_at":"2026-11-03T18:00:00Z"}},"SnapshotCreatingExample":{"summary":"A snapshot that is being taken","value":{"archived":false,"can_delete":false,"can_protect":false,"created_at":"2026-11-03T16:02:11Z","delete_reason":null,"delete_reason_label":null,"deleted_at":null,"error":null,"expires_at":"2026-12-03T16:02:11Z","id":3302,"kind":"manual","kind_label":"One-off","mariadb_version":"11.8","note":"Before the PHP 8.4 move","php_version":"8.3","protected":false,"ready_at":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"restorable":{"database":false,"everything":false,"files":false,"reason":"This snapshot is still being taken"},"restore_size_bytes":null,"status":"creating","status_label":"Creating…","stored_bytes":null}},"SnapshotDeletingExample":{"summary":"A snapshot that is being deleted","value":{"archived":false,"can_delete":false,"can_protect":false,"created_at":"2026-11-03T15:12:40Z","delete_reason":"manual","delete_reason_label":"Deleted by Eleanor Finch","deleted_at":null,"error":null,"expires_at":"2026-12-03T15:12:40Z","id":3301,"kind":"manual","kind_label":"One-off","mariadb_version":"11.8","note":"Before the PHP 8.4 move","php_version":"8.3","protected":false,"ready_at":"2026-11-03T15:14:02Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"restorable":{"database":false,"everything":false,"files":false,"reason":"This snapshot is being deleted"},"restore_size_bytes":6442450944,"status":"deleting","status_label":"Deleting…","stored_bytes":1288490188}},"SnapshotListExample":{"summary":"One snapshot, no restore running","value":{"restore":null,"settings":{"cluster_frequency":"6h","cluster_label":"Every 6 hours","effective_frequency":"6h","effective_label":"Every 6 hours","enabled":true,"frequency":null,"frequency_options":[{"label":"Every hour","value":"1h"},{"label":"Every 2 hours","value":"2h"},{"label":"Every 3 hours","value":"3h"},{"label":"Every 4 hours","value":"4h"},{"label":"Every 6 hours","value":"6h"},{"label":"Every 12 hours","value":"12h"},{"label":"Daily","value":"daily"},{"label":"Weekly","value":"weekly"},{"label":"Monthly","value":"monthly"},{"label":"Off","value":"off"}],"last_scheduled_failed":null,"manual_remaining_this_hour":19,"next_scheduled_at":"2026-11-03T17:23:00Z","over_quota":false,"per_site":false,"policy_source":"cluster","protect_cap_bytes":null,"protected_bytes":0,"pruned_recently":false,"quota_bytes":null,"retention_days":30,"usage_bytes":null,"usage_synced_at":null},"snapshots":[{"archived":false,"can_delete":true,"can_protect":true,"created_at":"2026-11-03T15:12:40Z","delete_reason":null,"delete_reason_label":null,"deleted_at":null,"error":null,"expires_at":"2026-12-03T15:12:40Z","id":3301,"kind":"manual","kind_label":"One-off","mariadb_version":"11.8","note":"Before the PHP 8.4 move","php_version":"8.3","protected":false,"ready_at":"2026-11-03T15:14:02Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"restorable":{"database":true,"everything":true,"files":true,"reason":null},"restore_size_bytes":6442450944,"status":"ready","status_label":"Ready","stored_bytes":1288490188}]}},"SnapshotReadyExample":{"summary":"A one-off snapshot that is ready","value":{"archived":false,"can_delete":true,"can_protect":true,"created_at":"2026-11-03T15:12:40Z","delete_reason":null,"delete_reason_label":null,"deleted_at":null,"error":null,"expires_at":"2026-12-03T15:12:40Z","id":3301,"kind":"manual","kind_label":"One-off","mariadb_version":"11.8","note":"Before the PHP 8.4 move","php_version":"8.3","protected":false,"ready_at":"2026-11-03T15:14:02Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"restorable":{"database":true,"everything":true,"files":true,"reason":null},"restore_size_bytes":6442450944,"status":"ready","status_label":"Ready","stored_bytes":1288490188}},"SnapshotSiteSettingsExample":{"summary":"A site on a CoreCluster that follows the default","value":{"cluster_frequency":"6h","cluster_label":"Every 6 hours","effective_frequency":"6h","effective_label":"Every 6 hours","enabled":true,"frequency":null,"frequency_options":[{"label":"Every hour","value":"1h"},{"label":"Every 2 hours","value":"2h"},{"label":"Every 3 hours","value":"3h"},{"label":"Every 4 hours","value":"4h"},{"label":"Every 6 hours","value":"6h"},{"label":"Every 12 hours","value":"12h"},{"label":"Daily","value":"daily"},{"label":"Weekly","value":"weekly"},{"label":"Monthly","value":"monthly"},{"label":"Off","value":"off"}],"last_scheduled_failed":null,"manual_remaining_this_hour":19,"next_scheduled_at":"2026-11-03T17:23:00Z","over_quota":false,"per_site":false,"policy_source":"cluster","protect_cap_bytes":null,"protected_bytes":0,"pruned_recently":false,"quota_bytes":null,"retention_days":30,"usage_bytes":null,"usage_synced_at":null}},"SshActivityPageExample":{"summary":"A key added through the API, then applied","value":{"events":[{"action":"delivery.applied","actor":null,"at":"2026-11-05T09:17:02+00:00","channel":"system","fingerprint":null,"layer":null,"login":null,"owner":null,"reason":null},{"action":"key.added","actor":{"former":false,"name":"Eleanor Finch","support":false},"at":"2026-11-05T09:16:40+00:00","channel":"api","fingerprint":"SHA256:o6poLLVqPDVYtxLTdagh8mUo96coeRXfX7Uxorxr158","layer":"company","login":"web","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"reason":null}],"next_cursor":null}},"SshCompanyKeysExample":{"summary":"A company with one key that applies to all its environments","value":{"agency":null,"can_add":{"allowed":true,"message":null,"refused":null},"company":{"handle":"harbourfinch","id":1204,"is_agency":false,"name":"Harbour & Finch"},"grants":[{"added_at":"2026-11-03T10:02:44+00:00","added_by":{"former":false,"name":"Eleanor Finch","support":false},"also_granted":[],"applies_to":{"environment_ids":[],"mode":"all"},"bits":null,"delivery":{"applied":1,"not_on_new_system":0,"removed":0,"state":"applied","total":1,"waiting":0,"waiting_platform_update":0},"editable":true,"fingerprint":"SHA256:o6poLLVqPDVYtxLTdagh8mUo96coeRXfX7Uxorxr158","id":7305,"last_used_at":"2026-11-04T16:20:11+00:00","layer":"company","legacy":null,"lifecycle":"active","login":"web","name":"Office workstation","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"quarantine_reason":null,"reach":{"clients":0,"environments":1,"websites":1},"removable":true,"restricted":false,"restrictions":[],"type":"ssh-ed25519","weak":false}],"inherited":[],"legacy":{"count":1,"ends_on":"2026-12-09","environments":1},"reach":{"clients":0,"environments":1,"items":[{"company":{"id":1204,"name":"Harbour & Finch"},"id":1311,"name":"Production","product":"corecluster","site_id":1042,"website":{"id":1310,"name":"Harbour & Finch trade"}}],"websites":1}}},"SshEnvironmentAccessExample":{"summary":"An environment with a company key, a Legacy key and your own key","value":{"add_options":[{"level":"environment","login":"web","owner":{"id":1311,"name":"Production","type":"environment"},"reach":{"clients":0,"environments":1,"websites":1}},{"level":"website","login":"web","owner":{"id":1310,"name":"Harbour & Finch trade","type":"website"},"reach":{"clients":0,"environments":1,"websites":1}},{"level":"company","login":"web","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"reach":{"clients":0,"environments":1,"websites":1}},{"level":"user","login":"eleanor-harbourfinch","owner":{"id":2041,"name":"Eleanor Finch","type":"user"},"reach":{"clients":0,"environments":1,"websites":1}}],"add_refusals":[],"can_add":{"allowed":true,"refused":null},"connection":{"host":"ssh-northwind.example.net","host_keys":{"changed_at":"2026-11-02T01:12:40+00:00","current":[{"fingerprint":"SHA256:ExampleHostKeyEd25519FingerprintNotARealOne","type":"ed25519"},{"fingerprint":"SHA256:ExampleHostKeyEcdsaFingerprintNotARealOne00","type":"ecdsa"},{"fingerprint":"SHA256:ExampleHostKeyRsaFingerprintNotARealOne0000","type":"rsa"}],"known_hosts":["[ssh-northwind.example.net]:21044 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAAAExampleHostKeyOnlyThisIsNotARealHostKey1","[ssh-northwind.example.net]:21044 ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBExampleHostKeyOnlyThisIsNotARealHostKey2ExampleHostKeyOnlyThisIsNotARealHostKey2Exampl=","[ssh-northwind.example.net]:21044 ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQExampleHostKeyOnlyThisIsNotARealHostKey3ExampleHostKeyOnlyThisIsNotARealHostKey3ExampleHostKeyOnlyThisIsNotARealHostKey3"],"managed_by":"panel","next":null},"port":21044,"tunnel_target":"127.0.0.1:3306","web_command":"ssh -p 21044 web@ssh-northwind.example.net","your_login":{"command":"ssh -p 21044 eleanor-harbourfinch@ssh-northwind.example.net","delivered":true,"login":"eleanor-harbourfinch","state":"ready"}},"delivery":{"applied_at":"2026-11-05T09:17:02+00:00","group_write":null,"last_error_public":null,"mode":"managed","next_attempt_at":null,"not_on_new_system":false,"planned_for":null,"state":"applied","verified_at":"2026-11-05T09:17:05+00:00","waiting_for":null},"environment":{"company":{"id":1204,"name":"Harbour & Finch"},"id":1311,"name":"Production","product":"corecluster","site_id":1042,"website":{"id":1310,"name":"Harbour & Finch trade"}},"forwarding":{"restricted":false,"targets":[]},"legacy":{"count":1,"ends_on":"2026-12-09"},"logins":[{"keys":[{"added_at":"2026-11-03T10:02:44+00:00","added_by":{"former":false,"name":"Eleanor Finch","support":false},"bits":null,"delivery":{"planned_for":null,"state":"applied"},"editable":false,"fingerprint":"SHA256:o6poLLVqPDVYtxLTdagh8mUo96coeRXfX7Uxorxr158","id":7305,"last_used_at":"2026-11-04T16:20:11+00:00","legacy":null,"name":"Office workstation","removable":false,"restricted":false,"restrictions":[],"source":{"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"}},"type":"ssh-ed25519","weak":false},{"added_at":"2026-11-02T00:00:00+00:00","added_by":null,"bits":null,"delivery":{"planned_for":null,"state":"applied"},"editable":false,"fingerprint":"SHA256:Ploa6Hz7DwoHuC3xPgwJD+qGdTytelbFQ+lXDSmu+lY","id":7290,"last_used_at":null,"legacy":{"ci_hint":null,"ends_on":"2026-12-09","placed_at":null,"state":"legacy"},"name":"deploy@build-server","removable":true,"restricted":false,"restrictions":[],"source":{"layer":"legacy","owner":{"id":1311,"name":"Production","type":"environment"}},"type":"ssh-ed25519","weak":false}],"kind":"web","login":"web","person":null,"you":false},{"keys":[{"added_at":"2026-11-05T09:16:40+00:00","added_by":{"former":false,"name":"Eleanor Finch","support":false},"bits":null,"delivery":{"planned_for":null,"state":"applied"},"editable":true,"fingerprint":"SHA256:8LnkAlf64yNQsvTdVFxkoxM//vjpVpE8t+3gzVg1UjM","id":7306,"last_used_at":null,"legacy":null,"name":"Eleanor's laptop","removable":true,"restricted":false,"restrictions":[],"source":{"layer":"user","owner":{"id":2041,"name":"Eleanor Finch","type":"user"}},"type":"ssh-ed25519","weak":false}],"kind":"person","login":"eleanor-harbourfinch","person":{"former":false,"name":"Eleanor Finch","user_id":2041},"you":true}],"managed_on":null,"notes":["The browser terminal and AI tools connect through Corefinity, not through SSH keys or the firewall."]}},"SshHostKeysViewExample":{"summary":"Host keys managed here, with no rotation yet","value":{"environment":{"company":{"id":1204,"name":"Harbour & Finch"},"id":1311,"name":"Production","product":"corecluster","site_id":1042,"website":{"id":1310,"name":"Harbour & Finch trade"}},"host_keys":{"changed_at":"2026-11-02T01:12:40+00:00","current":[{"fingerprint":"SHA256:ExampleHostKeyEd25519FingerprintNotARealOne","type":"ed25519"},{"fingerprint":"SHA256:ExampleHostKeyEcdsaFingerprintNotARealOne00","type":"ecdsa"},{"fingerprint":"SHA256:ExampleHostKeyRsaFingerprintNotARealOne0000","type":"rsa"}],"known_hosts":["[ssh-northwind.example.net]:21044 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAAAExampleHostKeyOnlyThisIsNotARealHostKey1","[ssh-northwind.example.net]:21044 ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBExampleHostKeyOnlyThisIsNotARealHostKey2ExampleHostKeyOnlyThisIsNotARealHostKey2Exampl=","[ssh-northwind.example.net]:21044 ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQExampleHostKeyOnlyThisIsNotARealHostKey3ExampleHostKeyOnlyThisIsNotARealHostKey3ExampleHostKeyOnlyThisIsNotARealHostKey3"],"managed_by":"panel","next":null},"reason":null,"rotatable":true,"rotation":null}},"SshKeyAddedExample":{"summary":"A company key added for one environment","value":{"change_id":48211,"converted_from":null,"key":{"added_at":"2026-11-05T09:16:40+00:00","added_by":{"former":false,"name":"Eleanor Finch","support":false},"also_granted":[],"applies_to":{"environment_ids":[1311],"mode":"selected"},"bits":null,"delivery":{"applied":0,"not_on_new_system":0,"removed":0,"state":"applying","total":1,"waiting":0,"waiting_platform_update":0},"editable":true,"fingerprint":"SHA256:CLqzToSA4nOd3+meykf1UbpDyB5Jwm32ErgxuitkRIU","id":7307,"last_used_at":null,"layer":"company","legacy":null,"lifecycle":"active","login":"web","name":"Build server","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"quarantine_reason":null,"reach":{"clients":0,"environments":1,"websites":1},"removable":true,"restricted":false,"restrictions":[],"type":"ssh-ed25519","weak":false},"notices":[]}},"SshKeyKeptExample":{"summary":"A Legacy key kept as a company key","value":{"change_id":48214,"converted_from":null,"key":{"added_at":"2026-11-05T09:16:40+00:00","added_by":{"former":false,"name":"Eleanor Finch","support":false},"also_granted":[{"environments":1,"layer":"environment","owner":{"id":1311,"name":"Production","type":"environment"}}],"applies_to":{"environment_ids":[],"mode":"all"},"bits":null,"delivery":{"applied":0,"not_on_new_system":0,"removed":0,"state":"applying","total":1,"waiting":0,"waiting_platform_update":0},"editable":true,"fingerprint":"SHA256:Ploa6Hz7DwoHuC3xPgwJD+qGdTytelbFQ+lXDSmu+lY","id":7309,"last_used_at":null,"layer":"company","legacy":null,"lifecycle":"active","login":"web","name":"deploy@build-server","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"quarantine_reason":null,"reach":{"clients":0,"environments":1,"websites":1},"removable":true,"restricted":false,"restrictions":[],"type":"ssh-ed25519","weak":false},"notices":[]}},"SshKeyRenamedExample":{"summary":"A renamed key","value":{"change_id":null,"converted_from":null,"key":{"added_at":"2026-11-05T09:16:40+00:00","added_by":{"former":false,"name":"Eleanor Finch","support":false},"also_granted":[],"applies_to":{"environment_ids":[],"mode":"all"},"bits":null,"delivery":{"applied":0,"not_on_new_system":0,"removed":0,"state":"applying","total":1,"waiting":0,"waiting_platform_update":0},"editable":true,"fingerprint":"SHA256:o6poLLVqPDVYtxLTdagh8mUo96coeRXfX7Uxorxr158","id":7305,"last_used_at":null,"layer":"company","legacy":null,"lifecycle":"active","login":"web","name":"Office workstation (reception)","owner":{"id":1204,"name":"Harbour & Finch","type":"company"},"quarantine_reason":null,"reach":{"clients":0,"environments":1,"websites":1},"removable":true,"restricted":false,"restrictions":[],"type":"ssh-ed25519","weak":false},"notices":[]}},"SshLegacyKeysExample":{"summary":"One Legacy key on one environment","value":{"company":{"id":1204,"name":"Harbour & Finch"},"ends_on":"2026-12-09","environments":[{"environment":{"company":{"id":1204,"name":"Harbour & Finch"},"id":1311,"name":"Production","product":"corecluster","site_id":1042,"website":{"id":1310,"name":"Harbour & Finch trade"}},"keys":[{"added_at":"2026-11-02T00:00:00+00:00","added_by":null,"bits":null,"delivery":{"planned_for":null,"state":"applied"},"editable":false,"fingerprint":"SHA256:Ploa6Hz7DwoHuC3xPgwJD+qGdTytelbFQ+lXDSmu+lY","id":7290,"last_used_at":null,"legacy":{"ci_hint":null,"ends_on":"2026-12-09","placed_at":null,"state":"legacy"},"name":"deploy@build-server","removable":true,"restricted":false,"restrictions":[],"source":{"layer":"legacy","owner":{"id":1311,"name":"Production","type":"environment"}},"type":"ssh-ed25519","weak":false}],"not_on_new_system":false}],"extension":null,"next_cursor":null}},"SshManagedOnAnotherExample":{"summary":"The keys are managed on another environment of the same server","value":{"code":"ssh_managed_on_another_environment","field":null,"managed_on":{"id":1312,"name":"Staging"},"message":"SSH for this server is managed on Staging.","reason":"ssh_managed_on_another_environment"}},"SshPersonalKeysExample":{"summary":"Your username, one personal key and the environment it reaches","value":{"can_add":{"allowed":true,"refused":null},"can_have_login":true,"keys":[{"added_at":"2026-11-05T09:16:40+00:00","added_by":{"former":false,"name":"Eleanor Finch","support":false},"also_granted":[],"applies_to":null,"bits":null,"delivery":{"applied":1,"not_on_new_system":0,"removed":0,"state":"applied","total":1,"waiting":0,"waiting_platform_update":0},"editable":true,"fingerprint":"SHA256:8LnkAlf64yNQsvTdVFxkoxM//vjpVpE8t+3gzVg1UjM","id":7306,"last_used_at":null,"layer":"user","legacy":null,"lifecycle":"active","login":"eleanor-harbourfinch","name":"Eleanor's laptop","owner":{"id":2041,"name":"Eleanor Finch","type":"user"},"quarantine_reason":null,"reach":{"clients":0,"environments":1,"websites":1},"removable":true,"restricted":false,"restrictions":[],"type":"ssh-ed25519","weak":false}],"login":{"handle":"harbourfinch","issued_at":"2026-11-03T10:01:58+00:00","login":"eleanor-harbourfinch","uid":40118},"reach":[{"command":"ssh -p 21044 eleanor-harbourfinch@ssh-northwind.example.net","environment":{"company":{"id":1204,"name":"Harbour & Finch"},"id":1311,"name":"Production","product":"corecluster","site_id":1042,"website":{"id":1310,"name":"Harbour & Finch trade"}},"host":"ssh-northwind.example.net","port":21044,"state":"ready"}],"reason":null,"ssh_config":"Host harbourandfinch-example-com-production\n  HostName ssh-northwind.example.net\n  Port 21044\n  User eleanor-harbourfinch\n","user_id":2041}},"SshWebsiteKeysExample":{"summary":"A website with no keys of its own and one company key","value":{"can_add":{"allowed":true,"refused":null},"environments":[{"delivery_state":"applied","id":1311,"name":"Production","site_id":1042}],"grants":[],"inherited":[{"added_at":"2026-11-03T10:02:44+00:00","added_by":{"former":false,"name":"Eleanor Finch","support":false},"bits":null,"delivery":{"planned_for":null,"state":"applied"},"editable":false,"fingerprint":"SHA256:o6poLLVqPDVYtxLTdagh8mUo96coeRXfX7Uxorxr158","id":7305,"last_used_at":null,"legacy":null,"name":"Office workstation","removable":false,"restricted":false,"restrictions":[],"source":{"layer":"company","owner":{"id":1204,"name":"Harbour & Finch","type":"company"}},"type":"ssh-ed25519","weak":false}],"website":{"company":{"id":1204,"name":"Harbour & Finch"},"id":1310,"name":"Harbour & Finch trade","product":"corecluster"}}},"TeamCompanyDetailsExample":{"summary":"A company with Slack connected","value":{"data":{"address":"14 Quay Street, Anytown, AB1 2CD","can_change":true,"country":"GB","id":1204,"name":"Harbour & Finch","phone":"+44 20 7946 0142","settings":{"alerts_notifications":false,"deployment_started_notifications":true,"slack_channels":{"alerts":"#alerts","deployment_started":null,"deployments":"#deployments","maintenance_windows":null,"tickets":null}},"slack":{"connected":true,"delivery":[],"workspace":"harbourandfinch"},"type":"client"}}},"UpgradeAddonBoundsExample":{"summary":"More extra cores than a change takes","value":{"code":"addon_bounds","message":"Cores must be a whole number from 0 to 16.","reason":"addon_bounds"}},"UpgradeAddonsMissingExample":{"summary":"Add-ons left out","value":{"code":"invalid","errors":{"disk_gb":["The disk gb field is required."],"log_storage_gb":["The log storage gb field is required."],"memory_gb":["The memory gb field is required."]},"field":"memory_gb","message":"The memory gb field is required. (and 2 more errors)","reason":"invalid"}},"UpgradeClusterAddonsExample":{"summary":"Two extra cores and 8 GB of memory, applied","value":{"cluster":{"actions":{"create_environment":{"available":true,"reason":null},"create_site":{"available":true,"reason":null},"delete":{"available":false,"reason":"This cluster is managed by Corefinity and cannot be deleted here"},"upgrade_package":{"available":true,"downgrade":false,"reason":null}},"allowance":{"cpu_millicores":10000,"disk_bytes":429496729600,"memory_bytes":42949672960},"capacity":{"basis":"estimate","cpu":{"capacity_millicores":10000,"level":"ok","percent":1,"used_p95_millicores":150},"evaluated_at":"2026-11-03T09:00:00Z","level":"ok","memory":{"capacity_bytes":42949672960,"level":"ok","percent":1,"used_p95_bytes":805306368},"package":{"cores":8,"key":"cc8","memory_bytes":34359738368,"name":"CC8"},"sites":{"count":1,"environments":0},"storage":{"capacity_bytes":429496729600,"level":"ok","percent":2,"provisioned_bytes":10737418240}},"created_at":"2026-11-03T09:00:00Z","created_by":null,"environments":0,"id":1017,"kind":"customer","label":"Northwind UK 1","location":{"label":"London (europe-west2)"},"logs":null,"name":"Northwind UK 1","operation":null,"package":{"cores":8,"key":"cc8","name":"CC8"},"pending_changes":{"count":0,"window_starts_at":null},"ready_at":null,"region":{"key":"uk","label":"United Kingdom","place":"London (europe-west2)"},"reserved":{"cpu_limit_millicores":2000,"cpu_request_millicores":100,"disk_bytes":10737418240,"memory_limit_bytes":4294967296,"memory_request_bytes":536870912},"sites":{"applying":0,"degraded":0,"down":0,"environments":0,"healthy":0,"live":1,"preview":0,"total":1,"unknown":1},"slug":"wordpress-cluster-1","snapshots":{"frequency":"6h","over_quota":false,"pruned_recently":false,"quota_bytes":858993459200,"retention_days":30,"usage_bytes":null},"ssh_host":"ssh-northwind.example.net","state":"ready","state_label":"Ready","state_reason":null,"synced":{"inventory_at":null,"live_at":null,"usage_at":null},"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}},"operation":{"applied_at":"2026-11-03T09:00:00+00:00","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":"2026-11-03T09:00:00+00:00","created_at":"2026-11-03T09:00:00+00:00","environment":null,"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5123,"notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"cluster","site":null,"status":"completed","status_label":"Done","steps":[{"key":"quoted","label":"Quoted","state":"done"},{"key":"committed","label":"Committed","state":"skipped"},{"key":"applied","label":"Applied","state":"done"},{"key":"contract_changed","label":"Contract updated","state":"done"}],"subject":null,"summary":"Change add-ons","to_version":null,"type":"addon_change","type_label":"Change add-ons"},"quote":{"applies":"now","currency":"GBP","effective_from":"2026-11-03T09:00:00Z","expires_at":"2026-11-03T09:15:00Z","id":"728d4699-2ce9-4c2d-b455-466f42eedba6","lines":[{"after":{"amount":"90.00","currency":"GBP"},"before":null,"delta":{"amount":"90.00","currency":"GBP"},"key":"addon_cores","label":"Add-on: 2 cores"},{"after":{"amount":"40.00","currency":"GBP"},"before":null,"delta":{"amount":"40.00","currency":"GBP"},"key":"addon_memory_gb","label":"Add-on: 8 GB memory"}],"monthly_after":{"amount":"130.00","currency":"GBP"},"monthly_before":{"amount":"0.00","currency":"GBP"},"monthly_delta":{"amount":"130.00","currency":"GBP"},"prorata":{"amount":{"amount":"120.04","currency":"GBP"},"from":"2026-11-03T09:00:00Z","hours":687,"to":"2026-12-01T00:00:00Z"},"tax":{"amount":{"amount":"26.00","currency":"GBP"},"kind":"standard","note":"UK VAT 20 %","rate_percent":20},"trial":null}}},"UpgradeClusterPackageExample":{"summary":"A CoreCluster moving from CC8 to CC12","value":{"cluster":{"actions":{"create_environment":{"available":true,"reason":null},"create_site":{"available":true,"reason":null},"delete":{"available":false,"reason":"This cluster is managed by Corefinity and cannot be deleted here"},"upgrade_package":{"available":true,"downgrade":false,"reason":null}},"allowance":{"cpu_millicores":12000,"disk_bytes":644245094400,"memory_bytes":51539607552},"capacity":{"basis":"estimate","cpu":{"capacity_millicores":12000,"level":"ok","percent":1,"used_p95_millicores":150},"evaluated_at":"2026-11-03T09:00:00Z","level":"ok","memory":{"capacity_bytes":51539607552,"level":"ok","percent":1,"used_p95_bytes":805306368},"package":{"cores":12,"key":"cc12","memory_bytes":51539607552,"name":"CC12"},"sites":{"count":1,"environments":0},"storage":{"capacity_bytes":644245094400,"level":"ok","percent":1,"provisioned_bytes":10737418240}},"created_at":"2026-11-03T09:00:00Z","created_by":null,"environments":0,"id":1017,"kind":"customer","label":"Northwind UK 1","location":{"label":"London (europe-west2)"},"logs":null,"name":"Northwind UK 1","operation":null,"package":{"cores":12,"key":"cc12","name":"CC12"},"pending_changes":{"count":0,"window_starts_at":null},"ready_at":null,"region":{"key":"uk","label":"United Kingdom","place":"London (europe-west2)"},"reserved":{"cpu_limit_millicores":2000,"cpu_request_millicores":100,"disk_bytes":10737418240,"memory_limit_bytes":4294967296,"memory_request_bytes":536870912},"sites":{"applying":0,"degraded":0,"down":0,"environments":0,"healthy":0,"live":1,"preview":0,"total":1,"unknown":1},"slug":"wordpress-cluster-1","snapshots":{"frequency":"6h","over_quota":false,"pruned_recently":false,"quota_bytes":1288490188800,"retention_days":30,"usage_bytes":null},"ssh_host":"ssh-northwind.example.net","state":"ready","state_label":"Ready","state_reason":null,"synced":{"inventory_at":null,"live_at":null,"usage_at":null},"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}},"operation":{"applied_at":"2026-11-03T09:00:00Z","can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":"2026-11-03T09:00:00Z","created_at":"2026-11-03T09:00:00Z","environment":null,"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5122,"install":null,"label":null,"notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"cluster","site":null,"status":"completed","status_label":"Done","step":null,"steps":[{"key":"checked","label":"Checked","state":"done"},{"key":"applied","label":"Applied","state":"done"}],"subject":null,"summary":"CC8 → CC12","to_version":null,"type":"package_change","type_label":"Change package"},"quote":{"applies":"now","currency":"GBP","effective_from":"2026-11-03T09:00:00Z","expires_at":"2026-11-03T09:15:00Z","id":"e1393f30-606e-453b-a7de-b0e9e1fe6985","lines":[{"after":{"amount":"900.00","currency":"GBP"},"before":{"amount":"600.00","currency":"GBP"},"delta":{"amount":"300.00","currency":"GBP"},"key":"package","label":"Package: CC8 → CC12"}],"monthly_after":{"amount":"900.00","currency":"GBP"},"monthly_before":{"amount":"600.00","currency":"GBP"},"monthly_delta":{"amount":"300.00","currency":"GBP"},"prorata":{"amount":{"amount":"277.02","currency":"GBP"},"from":"2026-11-03T09:00:00Z","hours":687,"to":"2026-12-01T00:00:00Z"},"tax":{"amount":{"amount":"60.00","currency":"GBP"},"kind":"standard","note":"UK VAT 20 %","rate_percent":20},"trial":null},"shape_change":false,"warnings":[]}},"UpgradeConfirmDomainMismatchExample":{"summary":"confirm_domain is not the site's domain","value":{"code":"confirm_mismatch","errors":{"confirm_domain":["Type the site's domain to confirm"]},"field":"confirm_domain","message":"Type the site's domain to confirm","reason":"confirm_mismatch"}},"UpgradeConfirmNameMismatchExample":{"summary":"confirm_name is not the CoreCluster's name","value":{"code":"confirm_mismatch","errors":{"confirm_name":["Type the cluster's name to confirm"]},"field":"confirm_name","message":"Type the cluster's name to confirm","reason":"confirm_mismatch"}},"UpgradeFamilyUnknownExample":{"summary":"A server type that does not exist","value":{"code":"invalid","errors":{"family":["Choose Standard or Performance"]},"field":"family","message":"Choose Standard or Performance","reason":"invalid"}},"UpgradeOptionsClusterExample":{"summary":"A CoreCluster on CC8","value":{"addons":{"available":{"available":true,"reason":null},"current":{"cores":0,"disk_gb":0,"log_storage_gb":0,"memory_gb":0},"max":{"cores":16,"disk_gb":102400,"log_storage_gb":1000,"memory_gb":64},"unit":[{"key":"core","label":"Extra core","max":16,"monthly":{"amount":"45.00","currency":"GBP"},"step":1,"unit":"core"},{"key":"memory_gb","label":"Extra memory","max":64,"monthly":{"amount":"5.00","currency":"GBP"},"step":1,"unit":"GB"},{"key":"disk_gb","label":"Extra disk","max":102400,"monthly":{"amount":"0.20","currency":"GBP"},"step":10,"unit":"GB"},{"key":"log_storage_gb","label":"Extra log storage","max":1000,"monthly":{"amount":"0.10","currency":"GBP"},"step":1,"unit":"GB"}]},"apply_default":"now","can_apply_tonight":true,"contract":{"id":8169,"reference":"MC-2-2"},"currency":"GBP","family":[{"available":true,"current":true,"key":"general","label":"Standard","monthly_delta":{"amount":"0.00","currency":"GBP"},"note":null,"provisioned":false,"reason":"first"},{"available":true,"current":false,"key":"optimised","label":"Performance","monthly_delta":{"amount":"120.00","currency":"GBP"},"note":null,"provisioned":false,"reason":"first"}],"not_billed":null,"packages":[{"available":{"available":false,"reason":"Ask us to move to a smaller package"},"change":{"direction":"downgrade","notes":[]},"code":"CC4","cores":4,"disk_gb":200,"key":"cc4","memory_gib":16,"monthly":{"amount":"300.00","currency":"GBP"},"name":"CoreCluster CC4"},{"available":{"available":false,"reason":"Ask us to move to a smaller package"},"change":{"direction":"downgrade","notes":[]},"code":"CC6","cores":6,"disk_gb":300,"key":"cc6","memory_gib":24,"monthly":{"amount":"450.00","currency":"GBP"},"name":"CoreCluster CC6"},{"available":{"available":true,"reason":null},"change":null,"code":"CC8","cores":8,"disk_gb":400,"key":"cc8","memory_gib":32,"monthly":{"amount":"600.00","currency":"GBP"},"name":"CoreCluster CC8"}],"pending":null,"rights":{"can_edit":true,"can_pay":false,"can_view":true,"reason":null},"subject":{"family":"general","monthly":{"amount":"600.00","currency":"GBP"},"package":{"code":"CC8","key":"cc8"},"ref":{"id":1017,"name":"Northwind UK 1"},"region":{"key":"uk","label":"United Kingdom"},"type":"cluster"},"uat":null}},"UpgradeOptionsSiteExample":{"summary":"A CoreStack site on CS4","value":{"addons":{"available":{"available":true,"reason":null},"current":{"cores":0,"disk_gb":0,"log_storage_gb":0,"memory_gb":0},"max":{"cores":16,"disk_gb":102400,"log_storage_gb":1000,"memory_gb":64},"unit":[{"key":"core","label":"Extra core","max":16,"monthly":{"amount":"45.00","currency":"GBP"},"step":1,"unit":"core"},{"key":"memory_gb","label":"Extra memory","max":64,"monthly":{"amount":"5.00","currency":"GBP"},"step":1,"unit":"GB"},{"key":"disk_gb","label":"Extra disk","max":102400,"monthly":{"amount":"0.20","currency":"GBP"},"step":10,"unit":"GB"},{"key":"log_storage_gb","label":"Extra log storage","max":1000,"monthly":{"amount":"0.10","currency":"GBP"},"step":1,"unit":"GB"}]},"apply_default":"now","can_apply_tonight":true,"contract":{"id":8158,"reference":"MC-2-1"},"currency":"GBP","family":[{"available":true,"current":true,"key":"general","label":"Standard","monthly_delta":{"amount":"0.00","currency":"GBP"},"note":null,"provisioned":false,"reason":"first"},{"available":true,"current":false,"key":"optimised","label":"Performance","monthly_delta":{"amount":"60.00","currency":"GBP"},"note":null,"provisioned":false,"reason":"first"}],"not_billed":null,"packages":[{"available":{"available":false,"reason":"Ask us to move to a smaller package"},"change":{"direction":"downgrade","notes":[]},"code":"CS2","cores":2,"disk_gb":100,"key":"cs2","memory_gib":8,"monthly":{"amount":"150.00","currency":"GBP"},"name":"CoreStack CS2"},{"available":{"available":true,"reason":null},"change":null,"code":"CS4","cores":4,"disk_gb":200,"key":"cs4","memory_gib":16,"monthly":{"amount":"300.00","currency":"GBP"},"name":"CoreStack CS4"},{"available":{"available":true,"reason":null},"change":{"direction":"upgrade","notes":[]},"code":"CS6","cores":6,"disk_gb":300,"key":"cs6","memory_gib":24,"monthly":{"amount":"450.00","currency":"GBP"},"name":"CoreStack CS6"}],"pending":{"batch":null,"can_apply_now":{"available":false,"reason":"nothing_pending"},"environment":{"id":1042,"name":"Production","role":"production","slug":"production"},"items":[],"site":{"domain":"harbourandfinch.example.com","id":1042},"tier":null,"window":{"date":"2026-11-03","ends_at":"2026-11-04T07:00:00Z","label":"Tonight 21:00–07:00 (Europe/London)","starts_at":"2026-11-03T21:00:00Z"}},"rights":{"can_edit":true,"can_pay":false,"can_view":true,"reason":null},"subject":{"family":"general","monthly":{"amount":"300.00","currency":"GBP"},"package":{"code":"CS4","key":"cs4"},"ref":{"domain":"harbourandfinch.example.com","id":1042},"region":{"key":"uk","label":"United Kingdom"},"type":"site"},"uat":[]}},"UpgradePackageListExample":{"summary":"The CoreCluster packages, shortened","value":{"ladder":["xsmall","medium","large"],"packages":[{"capacity":{"cpu_millicores":4000,"memory_bytes":17179869184},"change":null,"code":"XSMALL","cores":4,"current":false,"estimates":{"laravel":{"L":{"cpu_millicores":600,"disk_bytes":64424509440,"memory_bytes":3221225472},"M":{"cpu_millicores":300,"disk_bytes":32212254720,"memory_bytes":1610612736},"S":{"cpu_millicores":150,"disk_bytes":10737418240,"memory_bytes":805306368}},"magento2":{"L":{"cpu_millicores":1500,"disk_bytes":64424509440,"memory_bytes":6442450944},"M":{"cpu_millicores":750,"disk_bytes":32212254720,"memory_bytes":3221225472}},"wordpress":{"L":{"cpu_millicores":600,"disk_bytes":64424509440,"memory_bytes":3221225472},"M":{"cpu_millicores":300,"disk_bytes":32212254720,"memory_bytes":1610612736},"S":{"cpu_millicores":150,"disk_bytes":10737418240,"memory_bytes":805306368}}},"families":["general","optimised"],"included_uat":null,"key":"xsmall","limits":{"snapshot_frequency":"6h","snapshot_quota_bytes":429496729600,"snapshot_retention_days":30,"storage_bytes":214748364800},"log_quota_gb":null,"log_retention_days":90,"memory_per_core_gib":4,"name":"Extra small","platforms":["wordpress"],"product_line":"cc","regions":["uk"],"tiers":["S","M","L"]},{"capacity":{"cpu_millicores":8000,"memory_bytes":34359738368},"change":null,"code":"MEDIUM","cores":8,"current":false,"estimates":{"laravel":{"L":{"cpu_millicores":600,"disk_bytes":64424509440,"memory_bytes":3221225472},"M":{"cpu_millicores":300,"disk_bytes":32212254720,"memory_bytes":1610612736},"S":{"cpu_millicores":150,"disk_bytes":10737418240,"memory_bytes":805306368}},"magento2":{"L":{"cpu_millicores":1500,"disk_bytes":64424509440,"memory_bytes":6442450944},"M":{"cpu_millicores":750,"disk_bytes":32212254720,"memory_bytes":3221225472}},"wordpress":{"L":{"cpu_millicores":600,"disk_bytes":64424509440,"memory_bytes":3221225472},"M":{"cpu_millicores":300,"disk_bytes":32212254720,"memory_bytes":1610612736},"S":{"cpu_millicores":150,"disk_bytes":10737418240,"memory_bytes":805306368}}},"families":["general","optimised"],"included_uat":null,"key":"medium","limits":{"snapshot_frequency":"6h","snapshot_quota_bytes":1288490188800,"snapshot_retention_days":30,"storage_bytes":644245094400},"log_quota_gb":null,"log_retention_days":90,"memory_per_core_gib":4,"name":"Medium","platforms":["wordpress"],"product_line":"cc","regions":["uk"],"tiers":["S","M","L"]},{"capacity":{"cpu_millicores":12000,"memory_bytes":51539607552},"change":null,"code":"LARGE","cores":12,"current":false,"estimates":{"laravel":{"L":{"cpu_millicores":600,"disk_bytes":64424509440,"memory_bytes":3221225472},"M":{"cpu_millicores":300,"disk_bytes":32212254720,"memory_bytes":1610612736},"S":{"cpu_millicores":150,"disk_bytes":10737418240,"memory_bytes":805306368}},"magento2":{"L":{"cpu_millicores":1500,"disk_bytes":64424509440,"memory_bytes":6442450944},"M":{"cpu_millicores":750,"disk_bytes":32212254720,"memory_bytes":3221225472}},"wordpress":{"L":{"cpu_millicores":600,"disk_bytes":64424509440,"memory_bytes":3221225472},"M":{"cpu_millicores":300,"disk_bytes":32212254720,"memory_bytes":1610612736},"S":{"cpu_millicores":150,"disk_bytes":10737418240,"memory_bytes":805306368}}},"families":["general","optimised"],"included_uat":null,"key":"large","limits":{"snapshot_frequency":"6h","snapshot_quota_bytes":1288490188800,"snapshot_retention_days":30,"storage_bytes":644245094400},"log_quota_gb":null,"log_retention_days":90,"memory_per_core_gib":4,"name":"Large","platforms":["wordpress"],"product_line":"cc","regions":["uk"],"tiers":["S","M","L"]}],"platforms":[{"available":true,"content":{"empty":{"available":true,"reason":null},"fresh":{"available":true,"reason":null}},"default_tier":"S","fresh_install_inputs":[{"default":"sam@example.com","label":"Admin email","name":"admin_email","required":false},{"default":"reseller_tq8glzxn","label":"Admin username","name":"admin_username","required":false},{"default":null,"label":"Site title","name":"site_title","required":false},{"default":"en_GB","label":"Language","name":"locale","required":false}],"key":"wordpress","label":"WordPress","mariadb_versions":[{"default":false,"label":"MariaDB 11.4","version":"11.4"},{"default":true,"label":"MariaDB 11.8","version":"11.8"}],"php_versions":[{"default":true,"eol_date":"2027-12-31","label":"PHP 8.3","status":"supported","version":"8.3"},{"default":false,"eol_date":"2028-12-31","label":"PHP 8.4","status":"supported","version":"8.4"}],"reason":null,"tiers":[{"available":true,"disk_bytes":10737418240,"estimate":{"cpu_millicores":150,"disk_bytes":10737418240,"memory_bytes":805306368},"fits":true,"fits_reason":null,"key":"S","label":"Small","limits":{"cpu_millicores":2000,"memory_bytes":4294967296},"php_ini_defaults":{"max_execution_time_seconds":300,"memory_limit_bytes":536870912,"upload_max_filesize_bytes":268435456},"php_max_children":8,"php_memory_limit_bytes":2617245696,"plain":"0.1 vCPU guaranteed, up to 2 vCPU · 512 MB guaranteed, up to 4 GB · 10 GB disk","reason":null,"requests":{"cpu_millicores":100,"memory_bytes":536870912}},{"available":true,"disk_bytes":32212254720,"estimate":{"cpu_millicores":300,"disk_bytes":32212254720,"memory_bytes":1610612736},"fits":true,"fits_reason":null,"key":"M","label":"Medium","limits":{"cpu_millicores":4000,"memory_bytes":8589934592},"php_ini_defaults":{"max_execution_time_seconds":300,"memory_limit_bytes":536870912,"upload_max_filesize_bytes":268435456},"php_max_children":16,"php_memory_limit_bytes":5301600256,"plain":"0.2 vCPU guaranteed, up to 4 vCPU · 1 GB guaranteed, up to 8 GB · 30 GB disk","reason":null,"requests":{"cpu_millicores":200,"memory_bytes":1073741824}},{"available":true,"disk_bytes":64424509440,"estimate":{"cpu_millicores":600,"disk_bytes":64424509440,"memory_bytes":3221225472},"fits":true,"fits_reason":null,"key":"L","label":"Large","limits":{"cpu_millicores":8000,"memory_bytes":17179869184},"php_ini_defaults":{"max_execution_time_seconds":300,"memory_limit_bytes":536870912,"upload_max_filesize_bytes":268435456},"php_max_children":32,"php_memory_limit_bytes":10737418240,"plain":"0.4 vCPU guaranteed, up to 8 vCPU · 2 GB guaranteed, up to 16 GB · 60 GB disk","reason":null,"requests":{"cpu_millicores":400,"memory_bytes":2147483648}}]}],"product_line":"cc"}},"UpgradeRegionListExample":{"summary":"Two of the regions","value":{"checked_at":"2026-11-03T09:00:00+00:00","regions":[{"default":true,"key":"uk","label":"United Kingdom","latency_hint":"Best for visitors in the UK and Ireland","packages":["xsmall","medium","large"],"place":"London (europe-west2)","reason":"Available soon","state":"coming_soon"},{"default":false,"key":"us","label":"United States","latency_hint":"Best for visitors in North America","packages":["cc4","cc6","cc8"],"place":"Ashburn (us-east4)","reason":"Available soon","state":"coming_soon"}]}},"UpgradeSameFamilyExample":{"summary":"Already on that server type","value":{"code":"same_family","message":"This is already the server type","reason":"same_family"}},"UpgradeSiteAddonsExample":{"summary":"Two extra cores, started now","value":{"item":null,"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"CoreStack"},"committed_at":"2026-11-03T09:00:00+00:00","completed_at":null,"created_at":"2026-11-03T09:00:00+00:00","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"In progress","steps":[{"key":"quoted","label":"Quoted","state":"done"},{"key":"committed","label":"Committed","state":"done"},{"key":"applied","label":"Applied","state":"current"},{"key":"contract_changed","label":"Contract updated","state":"todo"}],"subject":null,"summary":"Change add-ons","to_version":null,"type":"addon_change","type_label":"Change add-ons"},"pending":{"batch":null,"can_apply_now":{"available":false,"reason":"nothing_pending"},"environment":{"id":1042,"name":"Production","role":"production","slug":"production"},"items":[],"site":{"domain":"harbourandfinch.example.com","id":1042},"tier":null,"window":{"date":"2026-11-03","ends_at":"2026-11-04T07:00:00Z","label":"Tonight 21:00–07:00 (Europe/London)","starts_at":"2026-11-03T21:00:00Z"}},"queued":false,"quote":{"applies":"now","currency":"GBP","effective_from":"2026-11-03T09:00:00Z","expires_at":"2026-11-03T09:15:00Z","id":"5e68f8fe-7f67-4cf9-8253-ac2f9582cf88","lines":[{"after":{"amount":"90.00","currency":"GBP"},"before":null,"delta":{"amount":"90.00","currency":"GBP"},"key":"addon_cores","label":"Add-on: 2 cores"}],"monthly_after":{"amount":"90.00","currency":"GBP"},"monthly_before":{"amount":"0.00","currency":"GBP"},"monthly_delta":{"amount":"90.00","currency":"GBP"},"prorata":{"amount":{"amount":"83.10","currency":"GBP"},"from":"2026-11-03T09:00:00Z","hours":687,"to":"2026-12-01T00:00:00Z"},"tax":{"amount":{"amount":"18.00","currency":"GBP"},"kind":"standard","note":"UK VAT 20 %","rate_percent":20},"trial":null},"site":{"access_summary":{"apply_state":"never","company_keys":0,"keys":0,"users":0},"actions":{"apply_pending_now":{"available":false,"reason":"Nothing is waiting for tonight."},"attach_domain":{"available":false,"reason":"This environment already has a domain attached"},"change_url":{"available":false,"reason":"Domains are switched off at the moment"},"clone":{"available":false,"reason":"Copying data into an environment is switched off at the moment"},"create_environment":{"available":true,"reason":null},"delete":{"available":false,"reason":"Another change to this site is in progress. Wait for it to finish."},"go_live":{"available":false,"reason":"This environment already has a domain attached"},"maintenance":{"available":true,"reason":null},"push_to_live":{"available":false,"reason":"This is production"},"restore_deleted":{"available":false,"reason":"This site is not deleted"},"terminal":{"available":false,"reason":"The terminal is available once the site is running"}},"adoption":"adopted","billing":{"account_id":9102},"cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"CoreStack"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":true,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"harbourandfinch.example.com","domains_summary":{"aliases":1,"dns":"unknown","noindex":false,"primary":"harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"not_set_up"},"environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"applying","hosting":{"cluster_kind":"platform","label":"CoreStack"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1042,"kind":"corestack","lifecycle":"active","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"live":null,"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.4"},"mode":"production","mode_label":"Domain attached","operation":{"id":5121,"scope":"site","status":"committed","status_label":"Waiting for the platform","summary":"Add-ons: 2 cores, 0 GB RAM, 0 GB disk, 0 GB log storage","to_version":null,"type":"addon_change","type_label":"Change add-ons"},"operations":[{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"CoreStack"},"committed_at":"2026-11-03T09:00:00Z","completed_at":null,"created_at":"2026-11-03T09:00:00Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5121,"install":null,"label":"Applied","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Waiting for the platform","step":"applied","steps":[{"key":"quoted","label":"Quoted","state":"done"},{"key":"committed","label":"Committed","state":"done"},{"key":"applied","label":"Applied","state":"current"},{"key":"contract_changed","label":"Contract updated","state":"todo"}],"subject":null,"summary":"Add-ons: 2 cores, 0 GB RAM, 0 GB disk, 0 GB log storage","to_version":null,"type":"addon_change","type_label":"Change add-ons"}],"package":{"code":"CS4","key":"cs4","name":"CS4"},"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_plugins":{"anchor":"#platform-plugins","enabled":true,"layout":"classic","reason":null},"platform_url":"https://harbourandfinch-example-com.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"},"primary_url":"https://harbourandfinch.example.com","production_hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"provisioning":null,"removed":false,"restore":null,"runtime":{"container_memory_limits":{"cli":268435456,"mariadb":1073741824,"nginx":134217728,"php":2617245696,"redis":134217728},"mariadb":{"options":[{"allowed":false,"current":true,"label":"MariaDB 11.4","reason":"This is the current version","version":"11.4"},{"allowed":false,"current":false,"label":"MariaDB 11.8","reason":"Live status is unavailable. Try again in a minute.","version":"11.8"},{"allowed":false,"current":false,"label":"MariaDB 12.3","reason":"Upgrade one LTS release at a time","version":"12.3"}],"upgrade_only":true,"version":"11.4"},"node":{"major":null,"status":null},"php":{"eol_date":"2027-12-31","options":[{"ack_detail":[],"allowed":false,"changes":[],"current":false,"eol_date":"2026-12-31","label":"PHP 8.2","reason":"Another change is in progress","requires_ack":[],"status":"security","version":"8.2"},{"ack_detail":[],"allowed":false,"changes":[],"current":true,"eol_date":"2027-12-31","label":"PHP 8.3","reason":"This is the current version","requires_ack":[],"status":"supported","version":"8.3"},{"ack_detail":[],"allowed":false,"changes":[],"current":false,"eol_date":"2028-12-31","label":"PHP 8.4","reason":"Another change is in progress","requires_ack":[],"status":"supported","version":"8.4"},{"ack_detail":[],"allowed":false,"changes":[],"current":false,"eol_date":"2029-12-31","label":"PHP 8.5","reason":"Another change is in progress","requires_ack":[],"status":"supported","version":"8.5"}],"status":"supported","version":"8.3"},"requests":{"cpu_millicores":100,"memory_bytes":536870912}},"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":"rs-northwind-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"6h","effective_label":"Every 6 hours","latest":null,"latest_ready_at":null,"next_scheduled_at":"2026-11-03T12:11:00Z","overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20001 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20001,"sftp_command":"sftp -P 20001 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20001 web@ssh-northwind.example.net","user":"web","users":0},"tier":"cs4","uat_size":null,"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}}}},"UpgradeSiteChangeQueuedExample":{"summary":"A package change queued for tonight","value":{"item":{"applied_at":null,"customer_change":{"can_cancel":true,"requested_at":"2026-11-03T09:00:00Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"summary":"Change package","type":"package_change"},"error":null,"id":7201,"kind":"customer_change","label":"Change package","position":1,"source_operation":null,"status":"pending"},"operation":null,"pending":{"batch":{"id":7101,"not_before":null,"priority":0,"status":"open","window_date":"2026-11-03"},"can_apply_now":{"available":true,"reason":null},"environment":{"id":1042,"name":"Production","role":"production","slug":"production"},"items":[{"applied_at":null,"customer_change":{"can_cancel":true,"requested_at":"2026-11-03T09:00:00Z","requested_by":{"id":2041,"name":"Eleanor Finch"},"summary":"Change package","type":"package_change"},"error":null,"id":7201,"kind":"customer_change","label":"Change package","position":1,"source_operation":null,"status":"pending"}],"site":{"domain":"harbourandfinch.example.com","id":1042},"tier":null,"window":{"date":"2026-11-03","ends_at":"2026-11-04T07:00:00Z","label":"Tonight 21:00–07:00 (Europe/London)","starts_at":"2026-11-03T21:00:00Z"}},"queued":true,"quote":{"applies":"now","currency":"GBP","effective_from":"2026-11-03T09:00:00Z","expires_at":"2026-11-03T09:15:00Z","id":"689f95c6-7747-4255-a377-fb5effe807cd","lines":[{"after":{"amount":"600.00","currency":"GBP"},"before":{"amount":"300.00","currency":"GBP"},"delta":{"amount":"300.00","currency":"GBP"},"key":"package","label":"Package: CS4 → CS8"}],"monthly_after":{"amount":"600.00","currency":"GBP"},"monthly_before":{"amount":"300.00","currency":"GBP"},"monthly_delta":{"amount":"300.00","currency":"GBP"},"prorata":{"amount":{"amount":"277.02","currency":"GBP"},"from":"2026-11-03T09:00:00Z","hours":687,"to":"2026-12-01T00:00:00Z"},"tax":{"amount":{"amount":"60.00","currency":"GBP"},"kind":"standard","note":"UK VAT 20 %","rate_percent":20},"trial":null},"site":{"access_summary":{"apply_state":"never","company_keys":0,"keys":0,"users":0},"actions":{"apply_pending_now":{"available":true,"reason":null},"attach_domain":{"available":false,"reason":"This environment already has a domain attached"},"change_url":{"available":false,"reason":"Domains are switched off at the moment"},"clone":{"available":false,"reason":"Copying data into an environment is switched off at the moment"},"create_environment":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"go_live":{"available":false,"reason":"This environment already has a domain attached"},"maintenance":{"available":true,"reason":null},"push_to_live":{"available":false,"reason":"This is production"},"restore_deleted":{"available":false,"reason":"This site is not deleted"},"terminal":{"available":false,"reason":"The terminal is available once the site is running"}},"adoption":"adopted","billing":{"account_id":9102},"cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"CoreStack"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":true,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"harbourandfinch.example.com","domains_summary":{"aliases":1,"dns":"unknown","noindex":false,"primary":"harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"not_set_up"},"environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"unknown","hosting":{"cluster_kind":"platform","label":"CoreStack"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1042,"kind":"corestack","lifecycle":"active","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"live":null,"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.4"},"mode":"production","mode_label":"Domain attached","operation":null,"operations":[],"package":{"code":"CS4","key":"cs4","name":"CS4"},"pending_changes":{"count":1,"outcome_at":null,"state":"pending","window_starts_at":"2026-11-03T21:00:00Z"},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_plugins":{"anchor":"#platform-plugins","enabled":true,"layout":"classic","reason":null},"platform_url":"https://harbourandfinch-example-com.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"},"primary_url":"https://harbourandfinch.example.com","production_hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"provisioning":null,"removed":false,"restore":null,"runtime":{"container_memory_limits":{"cli":268435456,"mariadb":1073741824,"nginx":134217728,"php":2617245696,"redis":134217728},"mariadb":{"options":[{"allowed":false,"current":true,"label":"MariaDB 11.4","reason":"This is the current version","version":"11.4"},{"allowed":false,"current":false,"label":"MariaDB 11.8","reason":"Live status is unavailable. Try again in a minute.","version":"11.8"},{"allowed":false,"current":false,"label":"MariaDB 12.3","reason":"Upgrade one LTS release at a time","version":"12.3"}],"upgrade_only":true,"version":"11.4"},"node":{"major":null,"status":null},"php":{"eol_date":"2027-12-31","options":[{"ack_detail":[],"allowed":true,"changes":[],"current":false,"eol_date":"2026-12-31","label":"PHP 8.2","reason":null,"requires_ack":[],"status":"security","version":"8.2"},{"ack_detail":[],"allowed":false,"changes":[],"current":true,"eol_date":"2027-12-31","label":"PHP 8.3","reason":"This is the current version","requires_ack":[],"status":"supported","version":"8.3"},{"ack_detail":[],"allowed":true,"changes":[],"current":false,"eol_date":"2028-12-31","label":"PHP 8.4","reason":null,"requires_ack":[],"status":"supported","version":"8.4"},{"ack_detail":[],"allowed":true,"changes":[],"current":false,"eol_date":"2029-12-31","label":"PHP 8.5","reason":null,"requires_ack":[],"status":"supported","version":"8.5"}],"status":"supported","version":"8.3"},"requests":{"cpu_millicores":100,"memory_bytes":536870912}},"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":"rs-northwind-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"6h","effective_label":"Every 6 hours","latest":null,"latest_ready_at":null,"next_scheduled_at":"2026-11-03T12:03:00Z","overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20001 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20001,"sftp_command":"sftp -P 20001 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20001 web@ssh-northwind.example.net","user":"web","users":0},"tier":"cs4","uat_size":null,"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}}}},"UpgradeSiteChangeStartedExample":{"summary":"A package change that started now","value":{"item":null,"operation":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"CoreStack"},"committed_at":"2026-11-03T09:00:00+00:00","completed_at":null,"created_at":"2026-11-03T09:00:00+00:00","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"In progress","steps":[{"key":"checked","label":"Checked","state":"done"},{"key":"committed","label":"Committed","state":"done"},{"key":"applied","label":"Applied","state":"current"}],"subject":null,"summary":"Change package","to_version":null,"type":"package_change","type_label":"Change package"},"pending":{"batch":null,"can_apply_now":{"available":false,"reason":"nothing_pending"},"environment":{"id":1042,"name":"Production","role":"production","slug":"production"},"items":[],"site":{"domain":"harbourandfinch.example.com","id":1042},"tier":null,"window":{"date":"2026-11-03","ends_at":"2026-11-04T07:00:00Z","label":"Tonight 21:00–07:00 (Europe/London)","starts_at":"2026-11-03T21:00:00Z"}},"queued":false,"quote":{"applies":"now","currency":"GBP","effective_from":"2026-11-03T09:00:00Z","expires_at":"2026-11-03T09:15:00Z","id":"0ac9bc53-841e-47e5-8bc7-ad529017272b","lines":[{"after":{"amount":"600.00","currency":"GBP"},"before":{"amount":"300.00","currency":"GBP"},"delta":{"amount":"300.00","currency":"GBP"},"key":"package","label":"Package: CS4 → CS8"}],"monthly_after":{"amount":"600.00","currency":"GBP"},"monthly_before":{"amount":"300.00","currency":"GBP"},"monthly_delta":{"amount":"300.00","currency":"GBP"},"prorata":{"amount":{"amount":"277.02","currency":"GBP"},"from":"2026-11-03T09:00:00Z","hours":687,"to":"2026-12-01T00:00:00Z"},"tax":{"amount":{"amount":"60.00","currency":"GBP"},"kind":"standard","note":"UK VAT 20 %","rate_percent":20},"trial":null},"site":{"access_summary":{"apply_state":"never","company_keys":0,"keys":0,"users":0},"actions":{"apply_pending_now":{"available":false,"reason":"Nothing is waiting for tonight."},"attach_domain":{"available":false,"reason":"This environment already has a domain attached"},"change_url":{"available":false,"reason":"Domains are switched off at the moment"},"clone":{"available":false,"reason":"Copying data into an environment is switched off at the moment"},"create_environment":{"available":true,"reason":null},"delete":{"available":false,"reason":"Another change to this site is in progress. Wait for it to finish."},"go_live":{"available":false,"reason":"This environment already has a domain attached"},"maintenance":{"available":true,"reason":null},"push_to_live":{"available":false,"reason":"This is production"},"restore_deleted":{"available":false,"reason":"This site is not deleted"},"terminal":{"available":false,"reason":"The terminal is available once the site is running"}},"adoption":"adopted","billing":{"account_id":9102},"cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"CoreStack"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":true,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"harbourandfinch.example.com","domains_summary":{"aliases":1,"dns":"unknown","noindex":false,"primary":"harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"not_set_up"},"environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"applying","hosting":{"cluster_kind":"platform","label":"CoreStack"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1042,"kind":"corestack","lifecycle":"active","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"live":null,"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.4"},"mode":"production","mode_label":"Domain attached","operation":{"id":5120,"scope":"site","status":"committed","status_label":"Waiting for the platform","summary":"Change package","to_version":null,"type":"package_change","type_label":"Change package"},"operations":[{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"CoreStack"},"committed_at":"2026-11-03T09:00:00Z","completed_at":null,"created_at":"2026-11-03T09:00:00Z","environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":5120,"install":null,"label":"Applied","notes":[],"parent_operation_id":null,"requested_by":{"id":2041,"name":"Eleanor Finch"},"reset_target":null,"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"revealed":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"committed","status_label":"Updating the package","step":"applied","steps":[{"key":"checked","label":"Checked","state":"done"},{"key":"committed","label":"Capacity updated","state":"done"},{"key":"applied","label":"Applied","state":"current"}],"subject":null,"summary":"Change package","to_version":null,"type":"package_change","type_label":"Change package"}],"package":{"code":"CS8","key":"cs8","name":"CS8"},"pending_changes":{"count":0,"outcome_at":null,"state":null,"window_starts_at":null},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_plugins":{"anchor":"#platform-plugins","enabled":true,"layout":"classic","reason":null},"platform_url":"https://harbourandfinch-example-com.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"},"primary_url":"https://harbourandfinch.example.com","production_hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"provisioning":null,"removed":false,"restore":null,"runtime":{"container_memory_limits":{"cli":268435456,"mariadb":1073741824,"nginx":134217728,"php":2617245696,"redis":134217728},"mariadb":{"options":[{"allowed":false,"current":true,"label":"MariaDB 11.4","reason":"This is the current version","version":"11.4"},{"allowed":false,"current":false,"label":"MariaDB 11.8","reason":"Live status is unavailable. Try again in a minute.","version":"11.8"},{"allowed":false,"current":false,"label":"MariaDB 12.3","reason":"Upgrade one LTS release at a time","version":"12.3"}],"upgrade_only":true,"version":"11.4"},"node":{"major":null,"status":null},"php":{"eol_date":"2027-12-31","options":[{"ack_detail":[],"allowed":false,"changes":[],"current":false,"eol_date":"2026-12-31","label":"PHP 8.2","reason":"Another change is in progress","requires_ack":[],"status":"security","version":"8.2"},{"ack_detail":[],"allowed":false,"changes":[],"current":true,"eol_date":"2027-12-31","label":"PHP 8.3","reason":"This is the current version","requires_ack":[],"status":"supported","version":"8.3"},{"ack_detail":[],"allowed":false,"changes":[],"current":false,"eol_date":"2028-12-31","label":"PHP 8.4","reason":"Another change is in progress","requires_ack":[],"status":"supported","version":"8.4"},{"ack_detail":[],"allowed":false,"changes":[],"current":false,"eol_date":"2029-12-31","label":"PHP 8.5","reason":"Another change is in progress","requires_ack":[],"status":"supported","version":"8.5"}],"status":"supported","version":"8.3"},"requests":{"cpu_millicores":100,"memory_bytes":536870912}},"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":"rs-northwind-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"6h","effective_label":"Every 6 hours","latest":null,"latest_ready_at":null,"next_scheduled_at":"2026-11-03T12:28:00Z","overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20001 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20001,"sftp_command":"sftp -P 20001 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20001 web@ssh-northwind.example.net","user":"web","users":0},"tier":"cs4","uat_size":null,"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}}}},"UpgradeSiteFamilyQueuedExample":{"summary":"A move to Performance servers queued for tonight","value":{"item":{"applied_at":null,"customer_change":null,"error":null,"id":7202,"kind":"placement_move","label":"Scheduled maintenance","position":1,"source_operation":null,"status":"pending"},"operation":null,"pending":{"batch":{"id":7102,"not_before":null,"priority":0,"status":"open","window_date":"2026-11-03"},"can_apply_now":{"available":true,"reason":null},"environment":{"id":1042,"name":"Production","role":"production","slug":"production"},"items":[{"applied_at":null,"customer_change":null,"error":null,"id":7202,"kind":"placement_move","label":"Scheduled maintenance","position":1,"source_operation":null,"status":"pending"}],"site":{"domain":"harbourandfinch.example.com","id":1042},"tier":null,"window":{"date":"2026-11-03","ends_at":"2026-11-04T07:00:00Z","label":"Tonight 21:00–07:00 (Europe/London)","starts_at":"2026-11-03T21:00:00Z"}},"queued":true,"quote":{"applies":"now","currency":"GBP","effective_from":"2026-11-03T09:00:00Z","expires_at":"2026-11-03T09:15:00Z","id":"5b1d7c2e-3a4f-4c6d-9e8b-7f6a5d4c3b2a","lines":[{"after":{"amount":"360.00","currency":"GBP"},"before":{"amount":"300.00","currency":"GBP"},"delta":{"amount":"60.00","currency":"GBP"},"key":"package","label":"Package: CS4, server type Performance"}],"monthly_after":{"amount":"360.00","currency":"GBP"},"monthly_before":{"amount":"300.00","currency":"GBP"},"monthly_delta":{"amount":"60.00","currency":"GBP"},"prorata":{"amount":{"amount":"55.40","currency":"GBP"},"from":"2026-11-03T09:00:00Z","hours":687,"to":"2026-12-01T00:00:00Z"},"tax":{"amount":{"amount":"12.00","currency":"GBP"},"kind":"standard","note":"UK VAT 20 %","rate_percent":20},"trial":null},"site":{"access_summary":{"apply_state":"never","company_keys":0,"keys":0,"users":0},"actions":{"apply_pending_now":{"available":true,"reason":null},"attach_domain":{"available":false,"reason":"This environment already has a domain attached"},"change_url":{"available":false,"reason":"Domains are switched off at the moment"},"clone":{"available":false,"reason":"Copying data into an environment is switched off at the moment"},"create_environment":{"available":true,"reason":null},"delete":{"available":true,"reason":null},"go_live":{"available":false,"reason":"This environment already has a domain attached"},"maintenance":{"available":true,"reason":null},"push_to_live":{"available":false,"reason":"This is production"},"restore_deleted":{"available":false,"reason":"This site is not deleted"},"terminal":{"available":false,"reason":"The terminal is available once the site is running"}},"adoption":"adopted","billing":{"account_id":9102},"cloudflare":{"connected":false,"zone":null},"cluster":{"id":1017,"name":"CoreStack"},"commands":[],"compute_family":"general","counts":{"crons":1},"crons_enabled":true,"database":{"host":"127.0.0.1","name":"wordpress","password_revealable":true,"port":3306,"username":"application","via":"SSH tunnel"},"deleted":null,"deploy_mode":"manual","deploy_mode_label":"Manual","deployments_summary":{"last":null,"mode":"manual"},"domain":"harbourandfinch.example.com","domains_summary":{"aliases":1,"dns":"unknown","noindex":false,"primary":"harbourandfinch.example.com","tls":"none","www":null},"email_summary":{"sending_domain":null,"state":"not_set_up"},"environment":{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"environments":[{"env_id":"rs-northwind-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"}],"health":"unknown","hosting":{"cluster_kind":"platform","label":"CoreStack"},"http_auth_summary":{"apply_state":"applied","enabled":false,"rules":0,"users":0},"id":1042,"kind":"corestack","lifecycle":"active","limits":{"cpu_millicores":2000,"disk_bytes":10737418240,"memory_bytes":4294967296},"live":null,"logs":null,"maintenance":{"bypass_corefinity":1,"bypass_ips":[],"enabled":false,"since":null},"mariadb":{"version":"11.4"},"mode":"production","mode_label":"Domain attached","operation":null,"operations":[],"package":{"code":"CS4","key":"cs4","name":"CS4"},"pending_changes":{"count":1,"outcome_at":null,"state":"pending","window_starts_at":"2026-11-03T21:00:00Z"},"php":{"version":"8.3"},"platform":{"key":"wordpress","label":"WordPress"},"platform_plugins":{"anchor":"#platform-plugins","enabled":true,"layout":"classic","reason":null},"platform_url":"https://harbourandfinch-example-com.northwind.cfstack.example.net","preview":{"label":"Platform address","protected":false,"url":"https://harbourandfinch-example-com.northwind.cfstack.example.net"},"primary_url":"https://harbourandfinch.example.com","production_hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"provisioning":null,"removed":false,"restore":null,"runtime":{"container_memory_limits":{"cli":268435456,"mariadb":1073741824,"nginx":134217728,"php":2617245696,"redis":134217728},"mariadb":{"options":[{"allowed":false,"current":true,"label":"MariaDB 11.4","reason":"This is the current version","version":"11.4"},{"allowed":false,"current":false,"label":"MariaDB 11.8","reason":"Live status is unavailable. Try again in a minute.","version":"11.8"},{"allowed":false,"current":false,"label":"MariaDB 12.3","reason":"Upgrade one LTS release at a time","version":"12.3"}],"upgrade_only":true,"version":"11.4"},"node":{"major":null,"status":null},"php":{"eol_date":"2027-12-31","options":[{"ack_detail":[],"allowed":true,"changes":[],"current":false,"eol_date":"2026-12-31","label":"PHP 8.2","reason":null,"requires_ack":[],"status":"security","version":"8.2"},{"ack_detail":[],"allowed":false,"changes":[],"current":true,"eol_date":"2027-12-31","label":"PHP 8.3","reason":"This is the current version","requires_ack":[],"status":"supported","version":"8.3"},{"ack_detail":[],"allowed":true,"changes":[],"current":false,"eol_date":"2028-12-31","label":"PHP 8.4","reason":null,"requires_ack":[],"status":"supported","version":"8.4"},{"ack_detail":[],"allowed":true,"changes":[],"current":false,"eol_date":"2029-12-31","label":"PHP 8.5","reason":null,"requires_ack":[],"status":"supported","version":"8.5"}],"status":"supported","version":"8.3"},"requests":{"cpu_millicores":100,"memory_bytes":536870912}},"settings":{"auto_deploy":false,"http_auth_enabled":false,"scheduled_snapshots":true},"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":"rs-northwind-harbourandfinch-example-com","snapshots":{"count":0,"effective_frequency":"6h","effective_label":"Every 6 hours","latest":null,"latest_ready_at":null,"next_scheduled_at":"2026-11-03T12:03:00Z","overridden":false,"stored_gb":0},"ssh":{"command":"ssh -p 20001 web@ssh-northwind.example.net","host":"ssh-northwind.example.net","key_management":false,"keys":[],"port":20001,"sftp_command":"sftp -P 20001 web@ssh-northwind.example.net","tunnel_command":"ssh -N -L 3306:127.0.0.1:3306 -p 20001 web@ssh-northwind.example.net","user":"web","users":0},"tier":"cs4","uat_size":null,"usage":{"cpu_millicores":null,"disk_used_bytes":null,"memory_bytes":null,"observed_at":null,"source":null}}},"x-unverified":true},"UrlChangePreviewed":{"summary":"A move to a new bare domain","value":{"blockers":[],"can_proceed":true,"checks":{"advice":null,"dns_plan":{"actions":[{"action":"keep","existing":null,"host":"harbourandfinch.example.net","reason":null,"record":{"content":"203.0.113.10","name":"harbourandfinch.example.net","proxied":true,"type":"A"}}],"can_apply":false,"requires_confirmation":false,"zone":null},"hosts":[{"cloudflare_zone":null,"dns_answers":[{"type":"A","value":"203.0.113.10"}],"dns_checked_at":"2026-11-06T09:16:05Z","dns_detail":null,"dns_state":"points_here","dns_state_since":null,"expected_ip":"203.0.113.10","host":"harbourandfinch.example.net","noindex":false,"ok":true,"problems":[],"redirects_to":null,"role":"primary","tls":{"checked_at":null,"issuer":null,"not_after":null,"reason":null,"state":"none"}}],"ok":true},"current_primary":"harbourandfinch.example.com","expires_at":"2026-11-06T09:46:12Z","new_canonical_url":"https://harbourandfinch.example.net","new_primary":"harbourandfinch.example.net","platform":"wordpress","preview_token":"pReViEw-ToKeN-0123456789abcdefghijklmnopqr","replacements":{"laravel":null,"magento2":null,"wordpress":{"by_table":[{"column":"post_content","rows":734,"table":"wp_posts"}],"duration_ms":18420,"rows":1876,"serialised_safe":true,"tables":9}},"warnings":[]}},"UrlChangeStarted":{"summary":"The change, just started","value":{"applied_at":null,"can_retry":false,"cluster":{"id":1017,"name":"Northwind UK 1"},"committed_at":null,"completed_at":null,"created_at":"2026-11-06T09:33:40Z","environment":{"env_id":"rs-harbourandfinch-example-com","hostname":"harbourandfinch-example-com.northwind.cfstack.example.net","id":1042,"name":"Production","role":"production","role_label":"Production","slug":"production"},"error":null,"failure_reason":null,"from_version":null,"hot":false,"id":77173,"label":"New address added","notes":[],"parent_operation_id":null,"requested_by":{"id":5021,"name":"Eleanor Finch"},"result":null,"result_state":"none","retried_by_operation_id":null,"retries_operation_id":null,"retry_requires":null,"scope":"site","site":{"domain":"harbourandfinch.example.com","id":1042},"status":"pending","status_label":"Saving change","step":"committed","steps":[{"key":"committed","label":"New address added","state":"current"},{"key":"rewritten","label":"Site URL updated","state":"todo"},{"key":"finalising","label":"Redirect saved","state":"todo"},{"key":"finalised","label":"Old address redirects","state":"todo"}],"summary":"harbourandfinch.example.com → harbourandfinch.example.net","to_version":null,"type":"url_change","type_label":"Primary URL"}}},"headers":{"RateLimitLimit":{"description":"Requests allowed in the current minute for this limit.","schema":{"type":"integer"}},"RateLimitRemaining":{"description":"Requests left in the current minute for this limit.","schema":{"type":"integer"}},"RateLimitReset":{"description":"Unix time when the limit resets. Sent only with a 429.","schema":{"type":"integer"}},"RetryAfter":{"description":"Seconds to wait before the next request.","schema":{"minimum":0,"type":"integer"}}},"parameters":{"AgencyCursor":{"description":"The `next_cursor` of the previous answer. It is a page number as a string of digits; anything else is refused `422` on `cursor`.","in":"query","name":"cursor","required":false,"schema":{"pattern":"^[1-9][0-9]{0,8}$","type":"string"}},"AgencyLinksAgency":{"description":"The id of an agency your company is a client of, as `GET /company/agencies` lists it. Digits only.","example":1180,"in":"path","name":"agency","required":true,"schema":{"minimum":1,"type":"integer"}},"AgencyLinksClient":{"description":"The id of one of your agency's clients, as `GET /company/clients` lists it. Digits only.","example":1204,"in":"path","name":"client","required":true,"schema":{"minimum":1,"type":"integer"}},"CompanyDeploySecretId":{"description":"The id of a registry secret of this company, as the list answers it. Digits only.","example":318,"in":"path","name":"secret","required":true,"schema":{"minimum":1,"type":"integer"}},"CompanyDeployVariableName":{"description":"The variable's name, without the `CF_` prefix builds see it with: letters, digits and underscores, starting\nwith a letter or underscore, at most 64 characters. Any other name is refused `422` `invalid` on `name`.\n","example":"SLACK_URL","in":"path","name":"name","required":true,"schema":{"pattern":"^[A-Za-z_][A-Za-z0-9_]{0,63}$","type":"string"}},"DatabaseUsername":{"description":"A database user's name, as the database details list it.","example":"reporting_ro","in":"path","name":"username","required":true,"schema":{"maxLength":128,"type":"string"}},"DemoId":{"description":"The id of a demo, as the list gives it. Digits only.","example":3310,"in":"path","name":"demo","required":true,"schema":{"minimum":1,"type":"integer"}},"DeployTemplateCursor":{"description":"The `next_cursor` of the previous answer, a whole number here. Anything else is refused `422` `invalid` on `cursor`.","in":"query","name":"cursor","required":false,"schema":{"maximum":999999,"minimum":0,"type":"integer"}},"DeployTemplatePlatform":{"description":"The platform the template is for, such as `magento2`, `laravel` or `wordpress`. The list answers the ones your company can have.","example":"magento2","in":"path","name":"platform","required":true,"schema":{"pattern":"^[a-z0-9_]{1,32}$","type":"string"}},"DeploymentConnectionCursor":{"description":"The `next_cursor` of the previous answer. Digits only, at most 20; anything else is refused `422`.\n","in":"query","name":"cursor","required":false,"schema":{"maxLength":20,"pattern":"^[0-9]+$","type":"string"}},"DeploymentConnectionId":{"description":"The id of a connection, as the list answers it. Digits only.","example":4217,"in":"path","name":"connection","required":true,"schema":{"minimum":1,"type":"integer"}},"EmailDomain":{"description":"A sending domain of the site, by its name (such as `mg.harbourandfinch.example.net`) or by its `id` in the email settings.","example":"mg.harbourandfinch.example.net","in":"path","name":"domain","required":true,"schema":{"pattern":"^[A-Za-z0-9.-]{1,253}$","type":"string"}},"EnterpriseDeploymentId":{"description":"The id of a deployment of the environment. A deployment of another environment is not found.","example":4410,"in":"path","name":"deployment","required":true,"schema":{"minimum":1,"type":"integer"}},"EnterpriseRepositoryId":{"description":"The id of a repository of the environment, as `GET /environments/{environment}/repositories` lists it. Digits only.","example":3301,"in":"path","name":"repository","required":true,"schema":{"minimum":1,"type":"integer"}},"EnterpriseVariableName":{"description":"The variable's name, without the `CF_` prefix builds see it with. A new name is letters, digits and\nunderscores, starting with a letter or underscore, at most 64 characters; a variable the environment already\nhas is found by its stored name as it is, whatever the rules were when it was saved.\n","example":"API_TOKEN","in":"path","name":"name","required":true,"schema":{"type":"string"}},"EnvironmentRegistrySecretId":{"description":"The id of a registry secret of this environment, as the list answers it. Digits only.","example":318,"in":"path","name":"secret","required":true,"schema":{"minimum":1,"type":"integer"}},"SiteDeploymentConnection":{"description":"The id of a repository connection you may use on this site, as the settings list them in `connections`.","example":4217,"in":"query","name":"connection","required":true,"schema":{"type":"integer"}},"SiteDeploymentId":{"description":"The id of a deployment of this site, as the settings list it. Digits only.","example":5127,"in":"path","name":"deployment","required":true,"schema":{"minimum":1,"type":"integer"}},"SiteDeploymentPipelineBinding":{"description":"The id of one of the environment's pipelines, as the pipeline read answers it in `binding_id` and `bindings[].id`. Digits only.","example":2210,"in":"path","name":"binding","required":true,"schema":{"minimum":1,"type":"integer"}},"SiteDeploymentSecretId":{"description":"The id of a registry secret of this environment, as the list answers it. Digits only.","example":318,"in":"path","name":"secret","required":true,"schema":{"minimum":1,"type":"integer"}},"SiteDeploymentVariableName":{"description":"The variable's name, without the `CF_` prefix builds see it with: letters, digits and underscores, starting\nwith a letter or underscore, at most 64 characters. Any other name is refused `422` `invalid` on `name`.\n","example":"API_TOKEN","in":"path","name":"name","required":true,"schema":{"pattern":"^[A-Za-z_][A-Za-z0-9_]{0,63}$","type":"string"}},"TeamMemberId":{"description":"The id of a user. Digits only; anything else answers `404`.","example":2042,"in":"path","name":"member","required":true,"schema":{"minimum":1,"type":"integer"}},"TeamMembersCursor":{"description":"The `next_cursor` of the previous answer. Anything that is not a page number of up to nine digits is refused `422` on `cursor`.","in":"query","name":"cursor","required":false,"schema":{"pattern":"^[1-9][0-9]{0,8}$","type":"string"}},"TeamMembersSearch":{"description":"Lists only people whose name or email address contains this text.","in":"query","name":"search","required":false,"schema":{"maxLength":255,"type":"string"}},"TeamRoleId":{"description":"The id of a custom role of your company, as `GET /team/roles` lists it. Digits only; anything else answers `404`.","example":3107,"in":"path","name":"id","required":true,"schema":{"minimum":1,"type":"integer"}},"TeamUserId":{"description":"The id of a user. Digits only; anything else answers `404`.","example":2042,"in":"path","name":"id","required":true,"schema":{"minimum":1,"type":"integer"}},"billingAccount":{"description":"The billing account to read, by its `id` (see `GET /corestack/billing/account`). Left out, the request acts on\nyour company's default billing account. An account that does not exist and one that is not your company's\nanswer the same 404.\n","in":"query","name":"account","schema":{"minimum":1,"type":"integer"}},"billingAccountId":{"description":"The same as `account`, under the name the MCP tools use. Send one of the two: when they name different\naccounts the request is refused `422 invalid` on `account_id`.\n","in":"query","name":"account_id","schema":{"minimum":1,"type":"integer"}},"billingInvoice":{"description":"The invoice's `id`. Digits only.","in":"path","name":"invoice","required":true,"schema":{"minimum":1,"type":"integer"}},"cluster":{"description":"The id of a CoreCluster. Digits only.","example":1017,"in":"path","name":"cluster","required":true,"schema":{"minimum":1,"type":"integer"}},"clusterLogsLine":{"description":"The line, as `<stream_id>,<time>`.","example":"00000001000000003e23e8160039594a33894f6564e1b134,2026-11-03T09:53:00Z","in":"query","name":"line","required":true,"schema":{"maxLength":200,"type":"string"}},"company":{"description":"The id of a company you belong to or manage. Digits only.","example":1204,"in":"path","name":"company","required":true,"schema":{"minimum":1,"type":"integer"}},"cursor":{"description":"The `next_cursor` of the previous answer. Send only a cursor the list gave you; the list's own page says what any other value answers.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},"cursorLimit":{"description":"Items a page.","in":"query","name":"limit","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},"enterpriseCopy":{"description":"The id of a copy, as a start or a re-sync answers it. Digits only; 0 or an id above 2147483647 is refused `422`.","example":6201,"in":"path","name":"copy","required":true,"schema":{"maximum":2147483647,"minimum":1,"type":"integer"}},"environment":{"description":"The id of a CoreStack Enterprise environment. Not the same number as a site row id.","example":1311,"in":"path","name":"environment","required":true,"schema":{"minimum":1,"type":"integer"}},"firewallChange":{"description":"The id of a change, as a firewall request answers it in `change_id`. Digits only.","example":5308,"in":"path","name":"change","required":true,"schema":{"minimum":1,"type":"integer"}},"firewallCursor":{"description":"The `next_cursor` of the previous answer. A value of more than 200 characters is refused `422` `invalid_arguments` on `cursor`; any other value the list did not give you is ignored and answers the first page.","in":"query","name":"cursor","required":false,"schema":{"maxLength":200,"type":"string"}},"firewallEntry":{"description":"The id of a firewall entry, as the lists answer it in `id`. Digits only.","example":9001,"in":"path","name":"entry","required":true,"schema":{"minimum":1,"type":"integer"}},"firewallSubscription":{"description":"The id of an attached preset, as the lists answer it in `presets[].id`. Digits only.","example":310,"in":"path","name":"subscription","required":true,"schema":{"minimum":1,"type":"integer"}},"idempotencyKey":{"description":"A UUID you choose, to make the request safe to repeat. Only the endpoints that list this header read it; each\nsays what a repeated key answers.\n","example":"0d9c1a4e-6f1b-4f5e-9b8a-2d7c3e4f5a6b","in":"header","name":"Idempotency-Key","required":false,"schema":{"format":"uuid","type":"string"}},"item":{"description":"The id of a pending change, from the site's pending changes. Digits only.","example":5320,"in":"path","name":"item","required":true,"schema":{"minimum":1,"type":"integer"}},"logsAfter":{"description":"How many later lines to answer.","example":1,"in":"query","name":"after","required":false,"schema":{"default":20,"maximum":100,"minimum":0,"type":"integer"}},"logsBefore":{"description":"How many earlier lines to answer.","example":1,"in":"query","name":"before","required":false,"schema":{"default":20,"maximum":100,"minimum":0,"type":"integer"}},"logsBuckets":{"description":"How many slices to cut the time range into.","example":12,"in":"query","name":"buckets","required":false,"schema":{"default":60,"maximum":200,"minimum":10,"type":"integer"}},"logsDownload":{"description":"The `id` of an export, as its start answered it. 26 characters.","example":"01JB2Y8N7Q4X3R5T6V8W9Z0A1B","in":"path","name":"download","required":true,"schema":{"pattern":"^[0-9A-HJKMNP-TVW-Z]{26}$","type":"string"}},"logsEnvironment":{"description":"`production` reads each site's production environment. `all` reads every environment.","in":"query","name":"environment","required":false,"schema":{"default":"production","enum":["production","all"],"type":"string"}},"logsEnvironmentId":{"description":"The site row id of another environment of the same website to read instead of `{site}`.","in":"query","name":"environment_id","required":false,"schema":{"minimum":1,"type":"integer"}},"logsField":{"description":"The name of a field, as the fields list answers it. Letters, digits and `_`, `.`, `:`, `@` and `-`.","example":"status","in":"path","name":"field","required":true,"schema":{"pattern":"^[A-Za-z0-9_.:@-]+$","type":"string"}},"logsFiltersEncoded":{"description":"The filters of a search (see the search's `filters`), as JSON encoded in base64.","in":"query","name":"filters","required":false,"schema":{"type":"string"}},"logsFrom":{"description":"The start of the time range, as a date and time. It must be inside the time your logs are kept for.","in":"query","name":"from","required":false,"schema":{"type":"string"}},"logsLine":{"description":"The line, as `<stream_id>,<time>`.","example":"00000001000000006754af9632a2745e85c293e5aac08633,2026-11-03T09:53:00Z","in":"query","name":"line","required":true,"schema":{"maxLength":200,"type":"string"}},"logsPrefix":{"description":"Answer only the values that start with this text.","in":"query","name":"prefix","required":false,"schema":{"maxLength":256,"type":"string"}},"logsQuery":{"description":"A LogsQL query, sent as written. Every line when left out. Up to 4 KB.","in":"query","name":"query","required":false,"schema":{"maxLength":4096,"type":"string"}},"logsRange":{"description":"How far back from now to read. Ignored when `from` is sent.","example":"1h","in":"query","name":"range","required":false,"schema":{"$ref":"#/components/schemas/LogsRange"}},"logsSavedQuery":{"description":"The id of a saved query. Digits only.","example":3318,"in":"path","name":"query","required":true,"schema":{"minimum":1,"type":"integer"}},"logsScope":{"description":"`env` reads the one environment. `site` reads every environment of the website that you can see.","in":"query","name":"scope","required":false,"schema":{"default":"env","enum":["env","site"],"type":"string"}},"logsSites":{"description":"The sites of this CoreCluster to read, by site row id: a list (`sites[]=1042&sites[]=1051`) or one\ncomma-separated value. At most 200. Every site you can see when left out. A site that is not on this\nCoreCluster, or that you cannot see, answers `404`.\n","in":"query","name":"sites","required":false,"schema":{"items":{"minimum":1,"type":"integer"},"maxItems":200,"type":"array","uniqueItems":true}},"logsSourceExample":{"description":"The log source to read.","example":"web-access","in":"query","name":"source","required":false,"schema":{"$ref":"#/components/schemas/LogsSource"}},"logsTo":{"description":"The end of the time range, as a date and time. Now when left out.","in":"query","name":"to","required":false,"schema":{"type":"string"}},"operation":{"description":"The id of an operation. Digits only.","example":5120,"in":"path","name":"operation","required":true,"schema":{"minimum":1,"type":"integer"}},"page":{"description":"The page to read, starting at 1.","in":"query","name":"page","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},"perPage":{"description":"Items a page. Each endpoint names the sizes it accepts.","in":"query","name":"per_page","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},"site":{"description":"The id of a site row. A website's production site and each of its environments has its own id. Digits only.","example":1042,"in":"path","name":"site","required":true,"schema":{"minimum":1,"type":"integer"}},"siteAccessKey":{"description":"The id of a key, as a user's `keys` list answers it. Digits only.","example":7312,"in":"path","name":"key","required":true,"schema":{"minimum":1,"type":"integer"}},"siteAccessOperation":{"description":"The id of an operation, as a change answers it in `operation.id`. Digits only.","example":5120,"in":"path","name":"operation","required":true,"schema":{"minimum":1,"type":"integer"}},"siteAccessUser":{"description":"The id of one of the site's users, as `GET /corestack/sites/{site}/access` answers it. Digits only.","example":3418,"in":"path","name":"user","required":true,"schema":{"minimum":1,"type":"integer"}},"snapshot":{"description":"The id of a snapshot. Digits only.","example":3301,"in":"path","name":"snapshot","required":true,"schema":{"minimum":1,"type":"integer"}},"sshChange":{"description":"The id of a change, as a key request answers it in `change_id`. Digits only. A host-key rotation answers `change_id` 0, which is not a change to read here.","example":48211,"in":"path","name":"change","required":true,"schema":{"minimum":1,"type":"integer"}},"sshCursor":{"description":"The `next_cursor` of the previous answer, sent back as it was given. Anything else (a value that is not a cursor of these lists, or more than 200 characters) is refused `422` `invalid_arguments` on `cursor`.","in":"query","name":"cursor","required":false,"schema":{"maxLength":200,"type":"string"}},"sshKey":{"description":"The id of a key, as the key lists answer it in `id`. Digits only.","example":7305,"in":"path","name":"key","required":true,"schema":{"minimum":1,"type":"integer"}},"website":{"description":"The id of a CoreStack Enterprise website. Not the same number as a site row id.","example":1310,"in":"path","name":"website","required":true,"schema":{"minimum":1,"type":"integer"}}},"requestBodies":{"DeploymentConnectionRemoval":{"content":{"application/json":{"examples":{"confirm":{"summary":"Confirm with the connection's id","value":{"confirm_connection":4217}}},"schema":{"$ref":"#/components/schemas/DeploymentConnectionRemovalRequest"}}},"required":true}},"responses":{"AgencyForbiddenChangeRequestsRead":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Your role may not view change requests","value":{"code":"forbidden","message":"You are not allowed to view agency page change requests.","reason":"forbidden","status":"error"}},"read_scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/LegacyRefusal"}]}}},"description":"The token lacks the `read` scope (`scope_required`), or your role may not view page change requests (`forbidden`)."},"AgencyForbiddenReferralsRead":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Your role may not view referrals","value":{"code":"forbidden","message":"You are not allowed to view partner referrals.","reason":"forbidden","status":"error"}},"read_scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/LegacyRefusal"}]}}},"description":"The token lacks the `read` scope (`scope_required`), or your role may not view partner referrals (`forbidden`)."},"AgencyInvalidPage":{"content":{"application/json":{"example":{"code":"invalid","errors":{"limit":["The limit may not be greater than 100."]},"field":"limit","message":"The limit may not be greater than 100.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A `limit` outside 1 to 100, a `cursor` the list did not give you, or a `search` that is too long (`invalid`)."},"AgencyLinksForbiddenPreview":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your company has been deleted","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"corefinity":{"summary":"A link only Corefinity support can change","value":{"code":"forbidden","message":"Contact Corefinity support to change this link.","reason":"forbidden"}},"read_scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `read` scope (`scope_required`), the link is one only Corefinity support can change\n(`forbidden`), or your company has been deleted (`company_unavailable`).\n"},"AgencyLinksForbiddenRead":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your company has been deleted","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"read_scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `read` scope (`scope_required`), or your company has been deleted (`company_unavailable`)."},"AppVersionCatalogueUnavailable":{"content":{"application/json":{"example":{"code":"catalogue_unavailable","message":"Application versions are unavailable right now. Try again in a few minutes.","reason":"catalogue_unavailable"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The list of versions cannot be read at the moment (`catalogue_unavailable`). Try again in a few minutes."},"BillingAccountConflict":{"content":{"application/json":{"examples":{"account_conflict":{"$ref":"#/components/examples/BillingAccountConflictExample"}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"`account` and `account_id` name different billing accounts (`invalid`, on `account_id`)."},"BillingForbidden":{"content":{"application/json":{"examples":{"billing_forbidden":{"summary":"You may not read your company's billing","value":{"code":"billing_forbidden","message":"Billing is available to your company's owner and billing contacts.","reason":"billing_forbidden"}},"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor\nauthentication and you have not set it up (`two_factor_required`), or you may not read your company's billing\n(`billing_forbidden`): billing is for the company's owner, its billing contacts and its primary user.\n"},"CloudflareSslRuleUnavailable":{"content":{"application/json":{"examples":{"no_answer":{"summary":"Cloudflare did not answer","value":{"code":"unavailable","message":"Cloudflare did not answer. Try again in a minute.","reason":"unavailable"}},"recheck":{"summary":"An earlier rule for these domains could not be checked","value":{"code":"unavailable","message":"Cloudflare could not be read to check the rule set earlier for these domains, so nothing was written. Try again in a moment.","reason":"unavailable","rule":{"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"id":318,"removed_at":null,"set_at":null,"site_id":1042,"ssl":"full","state":"setting","state_reason":null,"zone":{"id":"zone-example-1","name":"harbourandfinch.example.com"}}}},"unconfirmed":{"summary":"Cloudflare did not confirm the rule","value":{"code":"unavailable","message":"Cloudflare did not confirm the rule. The Control Panel will check it again; nothing else was changed.","reason":"unavailable","rule":{"hosts":["harbourandfinch.example.com","www.harbourandfinch.example.com"],"id":318,"removed_at":null,"set_at":null,"site_id":1042,"ssl":"full","state":"setting","state_reason":null,"zone":{"id":"zone-example-1","name":"harbourandfinch.example.com"}}}}},"schema":{"$ref":"#/components/schemas/CloudflareSslRuleRefusal"}}},"description":"Cloudflare did not answer or did not confirm the change (`unavailable`). `rule` is sent when a rule was recorded: read the list again to see where it stands."},"CloudflareTooManyRequests":{"content":{"application/json":{"examples":{"hour_spent":{"summary":"The company's hour of Cloudflare changes is spent","value":{"code":"rate_limited","message":"Too many Cloudflare changes this hour. Try again later.","reason":"rate_limited","retry_after_seconds":3600}},"rate_limited":{"summary":"The endpoint's request limit is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests (`rate_limited`): the endpoint's request limit, or your company's 60 Cloudflare changes this\nhour, which the Control Panel and AI assistants spend too. Wait for `Retry-After`, which `retry_after_seconds`\nrepeats.\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"CloudflareUnreachable":{"content":{"application/json":{"example":{"message":"Cloudflare could not be reached"},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"Cloudflare could not be reached. Try again later."},"ClusterLogsReadConflict":{"content":{"application/json":{"examples":{"logs_not_collected":{"summary":"Logs are not collected yet","value":{"code":"logs_not_collected","message":"Logs are not being collected for this environment yet","reason":"logs_not_collected"}},"logs_range":{"summary":"The start is before the retention","value":{"code":"logs_range","message":"Choose a range inside the last 30 days","reason":"logs_range"}},"logs_scope_split":{"summary":"The sites keep their logs in different places","value":{"code":"logs_scope_split","message":"These sites keep their logs in different places. Choose a cluster or site","reason":"logs_scope_split"}},"query_too_wide":{"summary":"Too many sites at once","value":{"code":"query_too_wide","message":"This covers too many sites at once. Choose a cluster or site","reason":"query_too_wide"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The read cannot be made. `reason` says why: `logs_not_collected` (logs are not collected for this CoreCluster,\nor for any site of the read, yet), `logs_unavailable` (this source starts once the sites' next platform update\nhas applied), `logs_range` (`from` is before the time your logs are kept for), `query_too_wide` (the query\nreads too much, or covers too many sites at once) or `logs_scope_split` (the sites keep their logs in\ndifferent places: choose fewer sites).\n"},"ClusterLogsScopeConflict":{"content":{"application/json":{"examples":{"logs_not_collected":{"summary":"Logs are not collected yet","value":{"code":"logs_not_collected","message":"Logs are not being collected for this environment yet","reason":"logs_not_collected"}},"logs_scope_split":{"summary":"The sites keep their logs in different places","value":{"code":"logs_scope_split","message":"These sites keep their logs in different places. Choose a cluster or site","reason":"logs_scope_split"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The read cannot be made. `reason` says why: `logs_not_collected` (logs are not collected for this CoreCluster,\nor for any site of the read, yet), `query_too_wide` (the read covers too many sites at once) or\n`logs_scope_split` (the sites keep their logs in different places: choose fewer sites).\n"},"CommandsSwitchedOff":{"content":{"application/json":{"example":{"code":"switched_off","message":"Site commands are switched off at the moment","reason":"switched_off"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has switched commands on sites off for the moment (`switched_off`). Try again later."},"CompanyDeploySecretExists":{"content":{"application/json":{"examples":{"exists":{"summary":"The registry is already saved","value":{"code":"exists","id":318,"message":"A registry for this host is already saved. Edit it instead.","reason":"exists"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The company already has a credential for this registry and scope (`exists`, with the saved one's `id`). Change that one instead."},"CompanyDeploySecretRefused":{"content":{"application/json":{"examples":{"auth_type":{"summary":"A Composer credential without its sign-in type","value":{"code":"secret_invalid","errors":{"auth_type":["Choose how the registry signs in: http-basic, bearer, github-oauth or gitlab-token."]},"message":"Choose how the registry signs in: http-basic, bearer, github-oauth or gitlab-token.","reason":"secret_invalid"}},"kind":{"summary":"A kind that is not offered","value":{"code":"invalid","errors":{"kind":["The kind argument must be one of: \"npm\", \"composer\"."]},"field":"kind","message":"Some arguments are not valid.","reason":"invalid"}},"label":{"summary":"A label that is empty or longer than 255 characters","value":{"code":"secret_invalid","errors":{"label":["Enter a name for this registry (up to 255 characters)."]},"message":"Enter a name for this registry (up to 255 characters).","reason":"secret_invalid"}},"nothing":{"summary":"A change that names nothing to change","value":{"code":"invalid","errors":{"secret_id":["Send what to change, or verify: true."]},"field":"secret_id","message":"Send what to change, or verify: true.","reason":"invalid"}},"private":{"summary":"A registry on a private address","value":{"code":"secret_invalid","errors":{"registry":["This registry's address is not public. Builds reach only public registries."]},"message":"This registry's address is not public. Builds reach only public registries.","reason":"secret_invalid"}},"scope_length":{"summary":"A scope longer than 214 characters","value":{"code":"invalid","errors":{"scope":["The scope argument must be at most 214 characters."]},"field":"scope","message":"Some arguments are not valid.","reason":"invalid"}},"token":{"summary":"A token that is empty, longer than 4,096 characters or holds a control character","value":{"code":"secret_invalid","errors":{"secret":["Enter the token. It may not contain line breaks or control characters."]},"message":"Enter the token. It may not contain line breaks or control characters.","reason":"secret_invalid"}},"too_many":{"summary":"The company holds as many registry secrets as it can","value":{"code":"too_many_secrets","errors":{"secret":["This company already has the most registry secrets it can hold."]},"message":"This company already has the most registry secrets it can hold.","reason":"too_many_secrets"}},"unknown":{"summary":"A field the endpoint does not take","value":{"code":"invalid","errors":{"secret":["The secret argument is not part of this request."]},"field":"secret","message":"Some arguments are not valid.","reason":"invalid"}},"username":{"summary":"An http-basic credential without a username, or with one longer than 255 characters","value":{"code":"secret_invalid","errors":{"username":["Enter the username for http-basic sign-in."]},"message":"Enter the username for http-basic sign-in.","reason":"secret_invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"The request was refused and nothing was saved. `errors` names the field.\n\n- `secret_invalid`: a value the rules refuse (the label, the registry, the scope, the sign-in type, the\n  username for `http-basic`, the token), or a registry whose address is not public or does not resolve.\n- `too_many_secrets`: the company holds as many registry secrets as it can.\n- `invalid`: a field of the wrong type or one this endpoint does not take (the token is `token`), a `scope`\n  longer than 214 characters, or a change that names nothing to change and no `verify` true (on `secret_id`).\n"},"CronSiteNotReady":{"content":{"application/json":{"examples":{"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is deleted (`deleted`) or still being created (`provisioning`)."},"DatabaseBillingForbidden":{"content":{"application/json":{"examples":{"billing_forbidden":{"summary":"Somebody else pays for the site","value":{"code":"billing_forbidden","message":"Billing for this site is Harbour & Finch's.","reason":"billing_forbidden"}},"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the scope (`scope_required`), your company requires two-factor authentication and you have\nnot set it up, your account has no company that can use Managed Clusters\n(`company_not_enabled`), or you cannot change the site's billing\n(`billing_forbidden`): an agency that manages a site it does not pay for asks the site's owner.\n"},"DatabaseChangeConflict":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change was refused because of the site's state. `reason` says why: `deleted`, `provisioning`, `busy`\n(another change is running), `restore_running`, `removed` or `managed_elsewhere`.\n"},"DatabaseUserNotFound":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The feature is not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_found":{"summary":"No such site, or not one you can change","value":{"message":"Not found."}},"user_not_found":{"summary":"No user of that name can be changed from here","value":{"code":"user_not_found","message":"There is no such database user on this environment.","reason":"user_not_found"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site id does not exist or is a site you cannot change, the feature is not on for your company\n(`feature_off`), or no user of that name on this environment can be changed from here (`user_not_found`):\nan unknown name, the site's own `application` login and the platform's own accounts all answer the same body.\n"},"DatabaseUsersSwitchedOff":{"content":{"application/json":{"example":{"code":"switched_off","message":"Database users can't be changed just now. Try again later.","reason":"switched_off"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has switched changes to database users off for the moment (`switched_off`). Try again later."},"DeployTemplateArgumentRefused":{"content":{"application/json":{"examples":{"name_format":{"$ref":"#/components/examples/CompanyDeployVariableNameFormatExample"},"unknown":{"summary":"A parameter the endpoint does not take","value":{"code":"invalid","errors":{"platform":["The platform argument is not part of this request."]},"field":"platform","message":"Some arguments are not valid.","reason":"invalid"}},"version":{"summary":"A version that is not a number","value":{"code":"invalid","errors":{"version":["The version argument must be integer."]},"field":"version","message":"Some arguments are not valid.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field or query parameter is wrong, or is one this endpoint does not take (`invalid`, with the `field`)."},"DeployTemplateConflict":{"content":{"application/json":{"examples":{"reach_changed":{"summary":"The reach is not the one confirmed","value":{"code":"reach_changed","message":"The environments this change reaches have changed since you reviewed it. Review them again, then confirm.","reach":{"cannot_take":[],"confirm":{"count":1,"required":true},"digest":"3b50f766bb040794","environments":1,"in_flight":[],"list_max":50,"not_reached":[],"production":[{"binding_id":2210,"environment":{"name":"Production","slug":"production"},"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":1042,"stages":["post_deploy"]}],"production_count":1,"tunnels":{"access_update":[],"runtime_needed":[]},"uat":[],"uat_count":0,"unchanged":0},"reason":"reach_changed"}},"stale":{"summary":"The template changed since you read it","value":{"code":"stale","message":"This template changed since you opened it. Review the latest version, then save again.","reason":"stale","revision":2}},"template_locked":{"summary":"Corefinity has locked the template","value":{"code":"template_locked","message":"Corefinity has locked this template: Held while a change is reviewed.","reason":"template_locked"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The template changed since the `revision` you sent (`stale`, with the `revision` it is at now): read it again.\nOr the environments the change reaches are not the ones you confirmed (`reach_changed`, with the new `reach`,\nor with `refused` naming an environment that can no longer take the change): review them and confirm again.\nOr Corefinity has locked the template (`template_locked`).\n"},"DeployTemplateSaveRefused":{"content":{"application/json":{"examples":{"confirm":{"summary":"Production environments, not confirmed","value":{"code":"confirm","errors":{"confirm_count":["Type the number of production environments to confirm the change."]},"message":"Type the number of production environments to confirm the change.","reach":{"cannot_take":[],"confirm":{"count":1,"required":true},"digest":"3b50f766bb040794","environments":1,"in_flight":[],"list_max":50,"not_reached":[],"production":[{"binding_id":2210,"environment":{"name":"Production","slug":"production"},"site":{"domain":"harbourandfinch.example.com","id":1042},"site_id":1042,"stages":["post_deploy"]}],"production_count":1,"tunnels":{"access_update":[],"runtime_needed":[]},"uat":[],"uat_count":0,"unchanged":0},"reason":"confirm"}},"restore_choice":{"summary":"A restore that names no version, or both a revision and Corefinity's default","value":{"code":"invalid","errors":{"version_id":["Choose a version to restore."]},"field":"version_id","message":"Choose a version to restore.","reason":"invalid"}},"revision":{"summary":"No revision","value":{"code":"invalid","errors":{"revision":["The revision argument is required."]},"field":"revision","message":"Some arguments are not valid.","reason":"invalid"}},"shape":{"summary":"A build stage that is neither a preset nor commands","value":{"code":"invalid","errors":{"production.build.mode":["Choose a preset or your own commands for the build."]},"field":"production.build.mode","message":"Choose a preset or your own commands for the build.","reason":"invalid"}},"site_content_off":{"summary":"Site content repositories are not on","value":{"code":"feature_off","errors":{"production.settings.repository_contents":["Site content repositories are paused by Corefinity."]},"message":"Site content repositories are paused by Corefinity.","reason":"feature_off"}},"timeout_key":{"summary":"A timeout the pipeline does not have","value":{"code":"invalid","errors":{"production.settings.timeouts.deploy":["That is not one of the pipeline's timeouts."]},"field":"production.settings.timeouts.deploy","message":"That is not one of the pipeline's timeouts.","reason":"invalid"}},"timeout_out_of_range":{"summary":"A timeout outside 60 to 3600 seconds","value":{"code":"timeout_out_of_range","errors":{"production.settings.timeouts.build":["Choose a timeout between 60 and 3600 seconds."]},"message":"Choose a timeout between 60 and 3600 seconds.","reason":"timeout_out_of_range"}},"version_unavailable":{"summary":"A version the template does not keep","value":{"code":"version_unavailable","errors":{"version":["This version is not available here."]},"message":"This version is not available here.","reason":"version_unavailable"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The request was refused and nothing was saved.\n\n- `invalid`: a field is missing, of the wrong type or not one this endpoint takes, or the stage's `value` is\n  not in the stage's shape. `field` names it; inside a value it is the path, such as `production.build.mode`.\n- `confirm`: the change reaches production environments and is not confirmed. The answer carries the `reach`.\n- `version_unavailable`: the version to restore is not one this template keeps.\n- `preset_unavailable`, `node_too_old`: a build preset, or a Node.js version, that cannot be used here, or two\n  presets that cannot be used together.\n- `line_credentials`, `too_many_lines`, `line_too_long`: a line that holds a credential, a stage or a hook of\n  more than 200 commands, or a line of more than 8,192 bytes.\n- `maintenance_policy_unavailable`, `wrong_platform`, `timeout_out_of_range`: a setting the platform does not\n  offer, or a timeout outside its bounds.\n- `template_refused_on`: an environment the change reaches cannot take it and is not named in `keep_on`. The\n  answer's `refused_on` lists each one's `site_id`, `stage`, `reason` and `message`.\n\nEvery reason but `invalid` names its field in `errors` only.\n"},"DeployTemplateWriteForbidden":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"exec_required":{"summary":"The token lacks the exec scope","value":{"code":"scope_required","message":"This access token does not have the exec scope this needs. Use a token with the exec scope.","reason":"scope_required","scope":"exec"}},"permission":{"summary":"The role lacks Edit Environment Deployment Pipeline","value":{"code":"forbidden","message":"You need the Edit Environment Deployment Pipeline permission to do this. An owner of your company can grant it in Roles.","permission":"editEnvironmentDeploymentPipeline","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the scope (`scope_required`, with the `scope` to use: `write`, or `exec` for a reveal and for\na change that brings a new command), your company requires two-factor authentication and you have not set it\nup, or your role lacks the Edit Environment Deployment Pipeline permission (`forbidden`, with `permission`).\n"},"DeploymentConnectionConfirmMismatch":{"content":{"application/json":{"examples":{"confirm_mismatch":{"value":{"code":"confirm_mismatch","errors":{"confirm_connection":["Removing the GitLab connection for daniel-reyes cannot be undone. To remove it, send confirm_connection set to its id, 4217. Nothing was removed."]},"field":"confirm_connection","message":"Removing the GitLab connection for daniel-reyes cannot be undone. To remove it, send confirm_connection set to its id, 4217. Nothing was removed.","reason":"confirm_mismatch"}}},"schema":{"$ref":"#/components/schemas/ConfirmMismatchRefusal"}}},"description":"`confirm_connection` is missing or is not the connection's id (`confirm_mismatch`). Nothing was removed."},"DeploymentConnectionCursorRefused":{"content":{"application/json":{"examples":{"invalid_cursor":{"summary":"Not a cursor of this list","value":{"code":"invalid_cursor","message":"That cursor is not one of ours: start again from the first page.","reason":"invalid_cursor"}},"too_long":{"summary":"A cursor of more than 20 characters","value":{"code":"invalid","errors":{"cursor":["The cursor may not be greater than 20 characters."]},"field":"cursor","message":"The cursor may not be greater than 20 characters.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The `cursor` is longer than 20 characters (`invalid`), or it is not a cursor the list gave you\n(`invalid_cursor`).\n"},"DeploymentConnectionInUse":{"content":{"application/json":{"examples":{"connection_in_use":{"value":{"code":"connection_in_use","environments":[{"environment_id":1311,"name":"production","site_id":null,"website":"Harbour & Finch trade","website_id":1310}],"message":"This connection is still used by 1 environment: Harbour & Finch trade / production (environment 1311). Choose another connection in its deployment settings first; nothing was removed.","other_environments":0,"reason":"connection_in_use"}}},"schema":{"$ref":"#/components/schemas/DeploymentConnectionInUseRefusal"}}},"description":"Environments still deploy through the connection (`connection_in_use`). `environments` names the ones you can\nsee and `other_environments` counts the rest. Choose another connection for each of them first.\n"},"DeploymentConnectionRemovalForbidden":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"You are not an owner","value":{"code":"forbidden","message":"Only the company's owners or Corefinity support can remove a deployment connection.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you\nhave not set it up, or you are not an owner (`forbidden`).\n"},"DeploymentConnectionRemoved":{"content":{"application/json":{"examples":{"removed":{"value":{"removed":{"id":4217,"provider":"gitlab","username":"daniel-reyes"}}}},"schema":{"$ref":"#/components/schemas/DeploymentConnectionRemoved"}}},"description":"The connection that was removed. Nothing else is deleted."},"DomainCommandsSwitchedOffError":{"content":{"application/json":{"example":{"message":"Server Error"},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"Corefinity has switched commands on sites off for the moment, and this endpoint needs one to read the site.\nIt answers a server error here, not `503 switched_off`. Nothing changed: try again later.\n"},"DomainLifecycleConflict":{"content":{"application/json":{"examples":{"deleted":{"summary":"The site is deleted","value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"provisioning":{"summary":"The site is still being created","value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is deleted (`deleted`) or still being created (`provisioning`)."},"DomainUpstreamFailed":{"content":{"application/json":{"example":{"message":"The DNS check could not run. Try again in a moment."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"A check or a write outside the Control Panel could not run. Try again in a moment."},"EmailDomainNotFound":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The feature is not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_found":{"summary":"No such site, or not one you can change","value":{"message":"Not found."}},"unknown_domain":{"summary":"The site has no sending domain by that name","value":{"code":"tenant_mismatch","message":"This site has no sending domain by that name.","reason":"tenant_mismatch"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site id does not exist or is a site you cannot change, the feature is not on for your company\n(`feature_off`), or the site has no sending domain by that name or id (`tenant_mismatch`).\n"},"EmailLifecycleConflict":{"content":{"application/json":{"examples":{"deleted":{"value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"provisioning":{"value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is deleted and waiting to be purged (`deleted`), or still being created (`provisioning`)."},"EmailProviderFailed":{"content":{"application/json":{"example":{"code":"upstream_unavailable","message":"Mailgun is busy. Try again in a minute.","reason":"upstream_unavailable"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The email provider did not answer, or refused the request (`upstream_unavailable`). Nothing was changed. Try again in a minute."},"EnterpriseCopyIdInvalid":{"content":{"application/json":{"examples":{"copy_id":{"summary":"A copy id of 0","value":{"code":"invalid","errors":{"copy":["The copy must be a whole number from 1 to 2147483647."]},"field":"copy","message":"The copy must be a whole number from 1 to 2147483647.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The copy's id in the path is not a whole number from 1 to 2147483647."},"EnterpriseCopyInvalid":{"content":{"application/json":{"examples":{"missing_environment":{"summary":"No environment id","value":{"code":"invalid","errors":{"enterprise_env_id":["The enterprise env id field is required."]},"field":"enterprise_env_id","message":"The enterprise env id field is required.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"An id is missing or is not a whole number from 1 to 2147483647. `field` names the first one."},"EnterpriseCopyInvalidOrUnconfirmed":{"content":{"application/json":{"examples":{"confirm_mismatch_resync":{"summary":"No typed name, on a re-sync","value":{"code":"confirm_mismatch","field":"confirm_target_site","message":"Type the site's name (harbourandfinch-example-com-trial) to confirm: the copy replaces its files and its database.","reason":"confirm_mismatch"}},"confirm_mismatch_start":{"summary":"The typed name is not the site's, on a start","value":{"code":"confirm_mismatch","field":"confirm_target_site","message":"Type the site's name (harbourandfinch-example-com-staging) to confirm: the copy replaces its files and its database.","reason":"confirm_mismatch"}},"invalid":{"summary":"A site id of 0","value":{"code":"invalid","errors":{"target_site_id":["The target site id must be at least 1."]},"field":"target_site_id","message":"The target site id must be at least 1.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/ConfirmMismatchRefusal"}]}}},"description":"An id is missing or is not a whole number from 1 to 2147483647 (`invalid`; `copy` names the id in the path), or\n`confirm_target_site` is missing or is not the site's name (`confirm_mismatch`).\n"},"EnterpriseDeploymentCommandFailed":{"content":{"application/json":{"examples":{"cancel":{"summary":"A cancellation","value":{"code":"internal_error","message":"The cancellation could not be completed. Try again in a moment.","reason":"internal_error","result":"failed"}},"retry":{"summary":"A retry","value":{"code":"internal_error","message":"The retry could not be completed. Try again in a moment.","reason":"internal_error","result":"failed"}},"rollback":{"summary":"A rollback","value":{"code":"internal_error","message":"The rollback could not be completed. Try again in a moment.","reason":"internal_error","result":"failed"}},"start":{"summary":"A start","value":{"code":"internal_error","message":"The start could not be completed. Try again in a moment.","reason":"internal_error","result":"failed"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The action could not be completed (`internal_error`, with `result` `failed`). Read the deployment, then try again."},"EnterpriseDeploymentCommandForbidden":{"content":{"application/json":{"examples":{"not_this_deployment":{"summary":"You may not take the action on this deployment","value":{"code":"forbidden","message":"You may not retry this deployment.","reason":"forbidden","result":"forbidden"}},"permission":{"summary":"The role lacks the permission","value":{"code":"forbidden","message":"You need the Retry Deployments permission to do this. An owner of your company can grant it in Roles.","permission":"retryDeployments","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"site":{"summary":"A site's environment, by somebody who cannot deploy the site","value":{"code":"forbidden","message":"You cannot deploy to this site.","reason":"forbidden"}},"token_cannot_deploy":{"summary":"The token lacks the deploy ability","value":{"code":"scope_required","message":"This access token cannot deploy.","reason":"scope_required","scope":"deploy"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope or the `deploy` ability (`scope_required`; `scope` names which), or your role\nlacks the permission the action needs (`forbidden`, with `permission`), or you may not take the action on this\ndeployment or deploy to its site (`forbidden`).\n"},"EnterpriseDeploymentCommandInvalid":{"content":{"application/json":{"examples":{"invalid":{"summary":"A field of the wrong type","value":{"code":"invalid","errors":{"expected_action_id":["The expected action id must be an integer."]},"field":"expected_action_id","message":"The expected action id must be an integer.","reason":"invalid"}},"key":{"summary":"A key that is not a UUID","value":{"message":"The Idempotency-Key header must be a UUID."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"A field is wrong (`invalid`), or the `Idempotency-Key` header is not a UUID (a message only).\n"},"EnterpriseDeploymentNotEnterprise":{"content":{"application/json":{"examples":{"site_environment":{"summary":"An environment of a CoreStack or CoreCluster site","value":{"code":"invalid","errors":{"environment":["This is a CoreStack or CoreCluster environment: name it by its site_id."]},"field":"environment","message":"This is a CoreStack or CoreCluster environment: name it by its site_id.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The environment is a CoreStack or CoreCluster site's (`invalid` on `environment`). Use the site's endpoints instead."},"EnterpriseRepositoryForbidden":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"not_your_account":{"summary":"Set up with a git account you cannot use","value":{"code":"forbidden","message":"This repository was set up with a git account you cannot use, so you cannot change it.","reason":"forbidden"}},"not_yours_to_change":{"summary":"You may not change this environment's repositories","value":{"code":"forbidden","message":"You cannot change this environment's repositories.","reason":"forbidden"}},"permission":{"summary":"The role lacks Manage Deployment Repositories","value":{"code":"forbidden","message":"You need the Manage Deployment Repositories permission to do this. An owner of your company can grant it in Roles.","permission":"manageDeploymentRepositories","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you\nhave not set it up, or you may not change the repository (`forbidden`): your role lacks a permission\n(`permission` names it), the environment's repositories are not yours to change, or the repository was set up\nwith a git account you cannot use.\n"},"EnterpriseRepositoryInvalid":{"content":{"application/json":{"examples":{"connection":{"summary":"A git account that does not exist or is not yours to use","value":{"code":"invalid","errors":{"connection_id":["The selected git account could not be found."]},"field":"connection_id","message":"The selected git account could not be found.","reason":"invalid"}},"fields":{"summary":"Fields left out","value":{"code":"invalid","errors":{"branch":["The branch field is required."],"environment_deployment_pipeline_id":["The environment deployment pipeline id field is required."],"repo":["The repo field is required."],"root_directory":["The root directory field is required."]},"field":"environment_deployment_pipeline_id","message":"The environment deployment pipeline id field is required. (and 3 more errors)","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`). `connection_id` is checked first; the other fields are then checked\ntogether and `errors` lists each one: a `repo` that is not a repository path of the account's provider, a\n`branch` that is not a branch name, a `root_directory` that is not a folder path, or any of them longer than\n255 characters. A git account you cannot use answers as one that does not exist, on\n`connection_id`, or, when it is an agency's, on `deployment_connection`. A CoreStack or CoreCluster environment\nis refused on `environment`.\n"},"EnterpriseVariableInvalid":{"content":{"application/json":{"examples":{"site_environment":{"$ref":"#/components/examples/EnterpriseVariableSiteEnvironmentExample"},"unknown_field":{"summary":"A field the endpoint does not take","value":{"code":"invalid","errors":{"force":["The force argument is not part of this request."]},"field":"force","message":"Some arguments are not valid.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The environment belongs to a CoreStack or CoreCluster site (`invalid` on `environment`): use the site's\ndeployment variables instead. A field or query parameter this endpoint does not take is refused the same way,\non that field.\n"},"EnvironmentRegistrySecretExists":{"content":{"application/json":{"examples":{"exists":{"summary":"The registry is already saved","value":{"code":"exists","id":318,"message":"A registry for this host is already saved. Edit it instead.","reason":"exists"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The environment already has a credential for this registry (`exists`). `id` is the saved one. Change that one instead."},"EnvironmentRegistrySecretForbidden":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"permission":{"summary":"The role lacks Edit Environment Deployment Pipeline","value":{"code":"forbidden","message":"You need the Edit Environment Deployment Pipeline permission to do this. An owner of your company can grant it in Roles.","permission":"editEnvironmentDeploymentPipeline","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you\nhave not set it up, or your role lacks the Edit Environment Deployment Pipeline permission (`forbidden`, with\n`permission`).\n"},"EnvironmentRegistrySecretNotEnterprise":{"content":{"application/json":{"examples":{"site_environment":{"$ref":"#/components/examples/EnvironmentRegistrySecretSiteEnvironmentExample"}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"The environment belongs to a CoreStack or CoreCluster site (`invalid` on `environment`). Use the site's registry secrets instead."},"EnvironmentRegistrySecretRefused":{"content":{"application/json":{"examples":{"auth_type":{"summary":"A sign-in type that is not offered","value":{"code":"secret_invalid","errors":{"auth_type":["Choose how the registry signs in: http-basic, bearer, github-oauth or gitlab-token."]},"message":"Choose how the registry signs in: http-basic, bearer, github-oauth or gitlab-token.","reason":"secret_invalid"}},"label":{"summary":"No label","value":{"code":"secret_invalid","errors":{"label":["Enter a name for this registry (up to 255 characters)."]},"message":"Enter a name for this registry (up to 255 characters).","reason":"secret_invalid"}},"not_an_object":{"summary":"A body that is not a JSON object","value":{"code":"invalid","errors":{"request":["Send the fields as a JSON object: label, registry, auth_type, username and secret."]},"field":"request","message":"Send the fields as a JSON object: label, registry, auth_type, username and secret.","reason":"invalid"}},"nothing":{"summary":"A change that names nothing to change","value":{"code":"invalid","errors":{"secret_id":["Send what to change, or verify: true."]},"field":"secret_id","message":"Send what to change, or verify: true.","reason":"invalid"}},"private":{"summary":"A registry on a private address","value":{"code":"secret_invalid","errors":{"registry":["This registry's address is not public. Builds reach only public registries."]},"message":"This registry's address is not public. Builds reach only public registries.","reason":"secret_invalid"}},"registry":{"summary":"A registry that is not a host name","value":{"code":"secret_invalid","errors":{"registry":["Enter the registry's host name, with a port if it needs one. No scheme, path or spaces."]},"message":"Enter the registry's host name, with a port if it needs one. No scheme, path or spaces.","reason":"secret_invalid"}},"site_environment":{"$ref":"#/components/examples/EnvironmentRegistrySecretSiteEnvironmentExample"},"token":{"summary":"No token, or one with a line break","value":{"code":"secret_invalid","errors":{"secret":["Enter the token. It may not contain line breaks or control characters."]},"message":"Enter the token. It may not contain line breaks or control characters.","reason":"secret_invalid"}},"too_many":{"summary":"The environment is full","value":{"code":"secret_invalid","errors":{"secret":["This environment already has the most registry secrets it can hold."]},"message":"This environment already has the most registry secrets it can hold.","reason":"secret_invalid"}},"username":{"summary":"No username for http-basic","value":{"code":"secret_invalid","errors":{"username":["Enter the username for http-basic sign-in."]},"message":"Enter the username for http-basic sign-in.","reason":"secret_invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"The request was refused and nothing was saved. `errors` names the field.\n\n- `secret_invalid`: a field is missing or is a value the rules refuse (the label, the registry's host, the\n  sign-in type, the username for `http-basic`, the token), the registry's address is not public or does not\n  resolve, the environment holds as many credentials as it can, or its credentials would be too large together.\n- `invalid`: the body is not a JSON object (on `request`), a change names nothing to change, or the environment\n  belongs to a CoreStack or CoreCluster site (on `environment`).\n"},"FeatureOff":{"content":{"application/json":{"example":{"code":"feature_off","message":"Not found.","reason":"feature_off"},"schema":{"$ref":"#/components/schemas/FeatureOffRefusal"}}},"description":"The feature is not on for your company."},"FirewallInvalidQuery":{"content":{"application/json":{"example":{"code":"invalid_arguments","errors":{"cursor":["Some of the details are missing or not valid."]},"field":"cursor","message":"Some of the details are missing or not valid.","reason":"invalid_arguments"},"schema":{"$ref":"#/components/schemas/FirewallRefusal"}}},"description":"`cursor` is longer than 200 characters (`invalid_arguments`). A shorter value that no page answered is not refused: it answers the first page."},"FirewallNotFound":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The firewall is not on","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_found":{"summary":"Not found, or not yours to reach","value":{"code":"not_found","field":null,"message":"Not found.","reason":"not_found"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/NotFoundRefusal"},{"$ref":"#/components/schemas/FeatureOffRefusal"}]}}},"description":"The id does not exist or is something you cannot reach (`not_found`; both answer the same body), or the\nfirewall is not on for it (`feature_off`).\n"},"FirewallStateConflict":{"content":{"application/json":{"example":{"code":"firewall_state_conflict","field":null,"message":"This entry has changed. Reload and try again.","reason":"firewall_state_conflict"},"schema":{"$ref":"#/components/schemas/FirewallRefusal"}}},"description":"The entry is not in a state that allows this, such as one that is being removed (`firewall_state_conflict`).\nRead it again.\n"},"FirewallTooManyWrites":{"content":{"application/json":{"examples":{"firewall_throttled":{"summary":"Too many firewall changes in a minute","value":{"code":"firewall_throttled","field":null,"message":"Too many firewall changes. Wait a minute and try again.","reason":"firewall_throttled"}},"rate_limited":{"summary":"The endpoint's request limit is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/FirewallRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"Too many requests: the endpoint's request limit (`rate_limited`, with `Retry-After`), or the firewall's own\nbudget of 30 changes a minute for you and 120 for your company, which the Control Panel and AI assistants spend\ntoo (`firewall_throttled`). The budget's answer names no wait: try again after a minute.\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"FirewallWebAccessUnavailable":{"content":{"application/json":{"example":{"code":"firewall_scope_unavailable","field":null,"message":"Website access is not available for this environment.","reason":"firewall_scope_unavailable"},"schema":{"$ref":"#/components/schemas/FirewallRefusal"}}},"description":"Website access is not available for this environment (`firewall_scope_unavailable`): it is a CoreStack\nEnterprise environment, or its site has been removed.\n"},"FirewallWriteForbidden":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"firewall_not_editable":{"summary":"An entry you can see but not change","value":{"code":"firewall_not_editable","field":null,"message":"You can see this entry but you cannot change it.","reason":"firewall_not_editable"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/FirewallRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you\nhave not set it up (`two_factor_required`), or you can see the entry or preset but may not change it, as with\none your agency holds (`firewall_not_editable`).\n"},"Forbidden":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"destructive_scope_required":{"summary":"The token lacks the destructive scope","value":{"code":"scope_required","message":"This access token does not have the destructive scope this needs. Use a token with the destructive scope.","reason":"scope_required","scope":"destructive"}},"exec_scope_required":{"summary":"The token lacks the exec scope","value":{"code":"scope_required","message":"This access token does not have the exec scope this needs. Use a token with the exec scope.","reason":"scope_required","scope":"exec"}},"read_scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}},"write_scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor\nauthentication and you have not set it up, or your account has no company that can use Managed Clusters, for\nexample because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route\nchecks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.\n"},"ForbiddenScopeOrManagedClusters":{"content":{"application/json":{"examples":{"destructive_scope_required":{"summary":"The token lacks the destructive scope","value":{"code":"scope_required","message":"This access token does not have the destructive scope this needs. Use a token with the destructive scope.","reason":"scope_required","scope":"destructive"}},"exec_scope_required":{"summary":"The token lacks the exec scope","value":{"code":"scope_required","message":"This access token does not have the exec scope this needs. Use a token with the exec scope.","reason":"scope_required","scope":"exec"}},"read_scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}},"write_scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the scope (`scope_required`, with the `scope` to use), or your account has no company that\ncan use Managed Clusters, for example because the company was closed (`company_not_enabled`). For Managed\nClusters routes that do not ask for two-factor authentication.\n"},"ForbiddenScopeOrTwoFactor":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"destructive_scope_required":{"summary":"The token lacks the destructive scope","value":{"code":"scope_required","message":"This access token does not have the destructive scope this needs. Use a token with the destructive scope.","reason":"scope_required","scope":"destructive"}},"exec_scope_required":{"summary":"The token lacks the exec scope","value":{"code":"scope_required","message":"This access token does not have the exec scope this needs. Use a token with the exec scope.","reason":"scope_required","scope":"exec"}},"read_scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}},"write_scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the scope (`scope_required`, with the `scope` to use), or your company requires two-factor\nauthentication and you have not set it up. For routes outside Managed Clusters.\n"},"Invalid":{"content":{"application/json":{"example":{"code":"invalid","errors":{"enabled":["The enabled field is required."]},"field":"enabled","message":"The enabled field is required.","reason":"invalid"},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong. `field` names the first one and `errors` lists every one."},"LogsInvalid":{"content":{"application/json":{"examples":{"query":{"summary":"The query is too long","value":{"code":"invalid","errors":{"query":["Keep the query under 4 KB."]},"field":"query","message":"Keep the query under 4 KB.","reason":"invalid"}},"saved_max":{"summary":"50 saved queries already","value":{"code":"invalid","errors":{"saved_max":["You can keep up to 50 saved queries. Delete one first."]},"field":"saved_max","message":"You can keep up to 50 saved queries. Delete one first.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field is missing or wrong. `field` names the first one and `errors` lists every one. Beside the request's\nown fields, `errors` can name `query` (the LogsQL is not valid, is over 4 KB, uses the `stream_context` pipe or\nthe `time_offset` option, or is an aggregating query sent to an export), `filters.<name>` (a filter is not\nvalid), `filters_max` (too many text or field filters), `cursor` (the cursor is not this request's or this\ntoken's) and `saved_max` (you already keep 50 saved queries).\n"},"LogsLineNotFound":{"content":{"application/json":{"examples":{"feature_off":{"summary":"Logs are not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"line_not_found":{"summary":"The line is not available","value":{"code":"line_not_found","message":"This line is no longer available","reason":"line_not_found"}},"not_found":{"summary":"Not found, or not yours to see","value":{"message":"Not found."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The id does not exist or is something you cannot see, logs are not on for your company (`feature_off`), or the\nline is not one of yours or is older than your logs are kept for (`line_not_found`).\n"},"LogsNotCollectedConflict":{"content":{"application/json":{"examples":{"logs_not_collected":{"value":{"code":"logs_not_collected","message":"Logs are not being collected for this environment yet","reason":"logs_not_collected"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Logs are not collected for this environment, site or CoreCluster yet (`logs_not_collected`)."},"LogsReadConflict":{"content":{"application/json":{"examples":{"logs_not_collected":{"summary":"Logs are not collected yet","value":{"code":"logs_not_collected","message":"Logs are not being collected for this environment yet","reason":"logs_not_collected"}},"logs_range":{"summary":"The start is before the retention","value":{"code":"logs_range","message":"Choose a range inside the last 90 days","reason":"logs_range"}},"logs_unavailable":{"summary":"The source is not available yet","value":{"code":"logs_unavailable","message":"Web, PHP, application and cron logs start once this site's next platform update has applied","reason":"logs_unavailable"}},"query_too_wide":{"summary":"The query reads too much","value":{"code":"query_too_wide","message":"This query is too wide. Add a source or narrow the time range","reason":"query_too_wide"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The read cannot be made. `reason` says why: `logs_not_collected` (logs are not collected for this environment\nyet), `logs_unavailable` (this source starts once the environment's next platform update has applied),\n`logs_range` (`from` is before the time your logs are kept for) or `query_too_wide` (the query reads too much:\nadd a source or narrow the time range).\n"},"LogsStoreUnavailable":{"content":{"application/json":{"examples":{"logs_busy":{"summary":"The logs store is busy","value":{"code":"logs_busy","message":"Logs are busy at the moment. Try again in a few seconds","reason":"logs_busy"}},"logs_cluster_unavailable":{"summary":"The logs store did not answer","value":{"code":"logs_cluster_unavailable","message":"Logs are not available at the moment. Try again shortly","reason":"logs_cluster_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The logs store did not answer (`logs_cluster_unavailable`), or it is serving as many reads as it can\n(`logs_busy`, with `Retry-After`). The request itself is fine: try again shortly.\n","headers":{"Retry-After":{"description":"Seconds to wait before the next request. Sent with `logs_busy`.","schema":{"type":"integer"}}}},"MagentoKeysRemovalNotConfirmed":{"content":{"application/json":{"examples":{"not_confirmed":{"summary":"`confirm_company` was not sent, or is another name","value":{"code":"invalid","commerce_sites":1,"errors":{"confirm_company":["1 Adobe Commerce site uses these keys: their installs and builds will fail until new keys are added. Type the company name to remove them."]},"field":"confirm_company","message":"1 Adobe Commerce site uses these keys: their installs and builds will fail until new keys are added. Type the company name to remove them.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"Adobe Commerce sites use the keys, and `confirm_company` is missing or is not the company's name. Both answer\n`invalid` on `confirm_company`; `commerce_sites` says how many sites. Nothing was removed.\n"},"MagentoStoreMappingInvalid":{"content":{"application/json":{"examples":{"domains_locked":{"value":{"code":"domains_locked","message":"This site's domains are managed by staff. Contact support.","reason":"domains_locked"}},"feature_off":{"value":{"code":"feature_off","message":"Nginx rules are not available for this site.","reason":"feature_off"}},"invalid":{"value":{"code":"invalid","message":"Some arguments are not valid.","reason":"invalid"}},"nginx_invalid":{"value":{"code":"nginx_invalid","message":"These nginx rules cannot be saved: fix the errors shown.","reason":"nginx_invalid"}},"nginx_rules_locked":{"value":{"code":"nginx_rules_locked","message":"Corefinity has locked this environment's nginx rules. Contact support to change them.","reason":"nginx_rules_locked"}},"nginx_rules_not_adopted":{"value":{"code":"nginx_rules_not_adopted","message":"This site's nginx rules need a one-off update before a store can be mapped. Save them once in the Nginx tab.","reason":"nginx_rules_not_adopted"}},"store_code_format":{"value":{"code":"store_code_format","field":"hosts.guns.example.com","message":"Magento store codes with capital letters can't be used for an address yet. Rename the code in Magento to lower case.","reason":"store_code_format"}},"store_host_not_served":{"value":{"code":"store_host_not_served","message":"This address does not show its own store on this site yet. Add it as an alias that shows a store first.","reason":"store_host_not_served"}},"store_inactive":{"value":{"code":"store_inactive","field":"hosts.guns.example.com","message":"The store view `guns_en` is switched off in Magento. Switch it on first, or choose another.","reason":"store_inactive"}},"store_mapping_foreign":{"value":{"code":"store_mapping_foreign","message":"Your nginx rules already set the Magento store outside the Control Panel's store mapping. Remove that from the Nginx tab first.","reason":"store_mapping_foreign"}},"store_unknown":{"value":{"code":"store_unknown","field":"hosts.guns.example.com","message":"Magento has no website with the code `missing`.","reason":"store_unknown"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"A store choice is missing or unusable, the host does not serve this site, or the Nginx settings need attention. Invalid arguments answer invalid with errors; a service refusal may name field. Nothing was started."},"MagentoStoresConflict":{"content":{"application/json":{"examples":{"stale":{"value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}},"store_hosts":{"value":{"code":"store_hosts","message":"This site serves extra Magento stores on their own addresses. Ask Corefinity support to change its domains.","reason":"store_hosts"}},"store_mapping_unreadable":{"value":{"code":"store_mapping_unreadable","message":"The store mapping in this site's nginx rules has been edited by hand. Remove the edit in the Nginx tab, or ask Corefinity support.","reason":"store_mapping_unreadable"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site cannot take the change or read now. A write may answer managed_elsewhere, stale, busy, deleted, provisioning, removed, restore_running or store_hosts; a read may answer not_running, command_running or exec_unresolved. An edited store mapping answers store_mapping_unreadable. Read both versions again after stale."},"MagentoStoresNotFound":{"content":{"application/json":{"examples":{"feature_off":{"value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_found":{"value":{"message":"Not found."}},"not_magento":{"value":{"code":"not_magento","message":"Only a Magento 2 site has Magento stores.","reason":"not_magento"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site is missing or not yours to see, the feature is unavailable (`feature_off`), or this is not Magento 2 (`not_magento`)."},"MagentoStoresUnreadable":{"content":{"application/json":{"example":{"code":"stores_unreadable","message":"Magento's stores could not be read. Try again in a moment.","reason":"stores_unreadable"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Magento's stores could not be read (`stores_unreadable`). Try again in a moment."},"MaintenanceWindowWriteBudget":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"The endpoint's request limit is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}},"throttled":{"summary":"Too many window changes this hour","value":{"code":"throttled","message":"Too many window changes — try again later.","reason":"throttled","retry_after_seconds":3600}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests (`rate_limited`, with `Retry-After`), or too many window changes in the last hour (`throttled`): ten for one site, CoreCluster or company, thirty for one person, counted with the Control Panel and AI assistants. Both answers carry `Retry-After`, which `retry_after_seconds` repeats.","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"ManagedElsewhere":{"content":{"application/json":{"example":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"},"schema":{"$ref":"#/components/schemas/ManagedElsewhereRefusal"}}},"description":"The site is managed by another control panel, so it cannot be changed here."},"NginxChangeNotSaved":{"content":{"application/json":{"examples":{"not_saved":{"summary":"The platform did not save the change","value":{"message":"The change could not be saved. Contact support."}}},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The platform did not save the change. Nothing was changed. Send the request again in a minute. The answer is a sentence only, with no `reason`."},"NginxConfigurationUnreadable":{"content":{"application/json":{"examples":{"upstream_unavailable":{"summary":"Try again in a few minutes","value":{"code":"upstream_unavailable","message":"This environment's configuration repository can't be read right now. Try again in a few minutes.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The rules sent are the saved ones, a change made outside the Control Panel is waiting, and the site's configuration cannot be read at the moment to put the saved rules back (`upstream_unavailable`). Try again in a few minutes."},"NginxPlatformUnreadable":{"content":{"application/json":{"examples":{"server_error":{"summary":"The site's files could not be read","value":{"message":"Server Error"}}},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The platform did not answer while the site's files were being read for the change, or the Control Panel may not write this site's files. Nothing was changed. When the platform is at fault, send the request again in a minute. The answer is a sentence only, with no `reason`."},"NotFound":{"content":{"application/json":{"example":{"message":"Not found."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The id does not exist, or it is something you cannot see. Both answer the same body."},"NotFoundOrFeatureOff":{"content":{"application/json":{"examples":{"feature_off":{"summary":"The feature is not on for your company","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"not_found":{"summary":"Not found, or not yours to see","value":{"message":"Not found."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/FeatureOffRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The id does not exist or is something you cannot see, or the feature is not on for your company\n(`feature_off`).\n"},"ProviderNoAnswer":{"content":{"application/json":{"example":{"message":"GitLab did not answer. Try again."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"A provider the request depends on did not answer. Nothing was changed; try again."},"RedirectLifecycleConflict":{"content":{"application/json":{"examples":{"deleted":{"value":{"code":"deleted","message":"This site is deleted and waiting to be purged. Restore it first.","reason":"deleted"}},"provisioning":{"value":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is deleted and waiting to be purged (`deleted`), or still being created (`provisioning`)."},"RuntimeLiveConflict":{"content":{"application/json":{"examples":{"not_running":{"summary":"The site is not running","value":{"code":"not_running","message":"The site is not running","reason":"not_running"}},"runtime_not_adopted":{"summary":"The site is not on the runtime","value":{"code":"runtime_not_adopted","message":"This environment does not run the runtime component yet, so its effective PHP configuration cannot be read.","reason":"runtime_not_adopted"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not on the runtime yet (`runtime_not_adopted`), is not running (`not_running`), another command or\nchange is running on it (`busy`), an earlier command has not been confirmed stopped (`exec_unresolved`), or the\nsite is managed by another control panel (`managed_elsewhere`).\n"},"RuntimeMariadbVersionInvalid":{"content":{"application/json":{"examples":{"one_step":{"summary":"More than one version ahead","value":{"code":"invalid","errors":{"to":["Upgrade one LTS release at a time"]},"field":"to","message":"Upgrade one LTS release at a time","reason":"invalid"}},"try_later":{"summary":"The site's live status could not be read","value":{"code":"temporarily_unavailable","message":"Live status is unavailable. Try again in a minute.","reason":"temporarily_unavailable"}},"window_off":{"summary":"Queuing for the window is switched off","value":{"code":"feature_off","errors":{"apply":["Queuing changes for the maintenance window is switched off at the moment"]},"message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"A field is missing or wrong (`invalid`; `acknowledge` is not accepted here); `apply` `tonight` while queuing\nfor the window is switched off (`feature_off`); the version is not the next one (`invalid` on `to`); or the\nsite cannot change version at the moment (`temporarily_unavailable`, `busy`, `not_available` or `removed`: the\nmessage says why).\n"},"RuntimeNodeArgumentsInvalid":{"content":{"application/json":{"example":{"code":"invalid_arguments","errors":{"which":["One or more of npm, corepack, pnpm, yarn, each once."]},"field":"which","message":"Caches are named from npm, corepack, pnpm, yarn, each once.","reason":"invalid_arguments"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"A field or query parameter is missing or wrong (`invalid_arguments`). `field` names the first one and `errors` lists every one."},"RuntimeNodeChangeConflict":{"content":{"application/json":{"examples":{"conflict":{"summary":"Other changes kept landing first","value":{"code":"conflict","message":"Other changes to the platform kept landing first, so nothing was saved. Retry it.","reason":"conflict"}},"runtime_locked":{"summary":"Corefinity has locked the configuration","value":{"code":"runtime_locked","message":"Corefinity has locked this environment's Node.js settings. Contact support to change them.","reason":"runtime_locked"}},"stale":{"summary":"The configuration changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The change cannot be made now. `reason` says why: `stale` (the configuration changed since your read), `busy`,\n`change_pending` (a change already waits for the window), `runtime_locked`, `runtime_not_adopted` (with the\nsite's `adoption` state), `batch_window` (the change can only be made in the site's window: send it again with\n`apply` `tonight`), `conflict` (other changes kept landing first: send it again), `restore_running`,\n`command_running`, `deployment_running`, `cluster_paused`, `deleted`, `provisioning`, `removed` or\n`managed_elsewhere`. A site that cannot be changed from the Control Panel at all answers a `message` with no\n`reason`.\n"},"RuntimeNodeChangeInvalid":{"content":{"application/json":{"examples":{"ack_required":{"summary":"A version past its end of life","value":{"code":"ack_required","detail":{"end_of_life_on":"2025-04-30","major":18},"message":"Node.js 18 reached its end of life on 30 April 2025 and gets no security fixes.","reason":"ack_required","required":["eol"]}},"scripts_memory":{"summary":"Install scripts where the command line has too little memory","value":{"cli_memory_mib":224,"code":"scripts_memory","message":"sharp runs an install script, and this environment's command line has 224 MiB of memory; install scripts need at least 512 MiB. Turn install scripts off for sharp, or choose a larger size.","min_cli_memory_mib":512,"packages":["sharp"],"reason":"scripts_memory"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change is not valid. `invalid_arguments` names the refused field in `errors`. `ack_required` asks for an\nacknowledgement (`required`, and the version in `detail`). `package_spec_invalid` refuses a name or selector\nthat cannot be installed from the registry; its `code` says what is wrong with it, such as\n`spec_not_registry`. `package_unresolvable` means no version matches. `package_limit` and `package_duplicate` refuse\nthe list. `scripts_memory` refuses install scripts where the command line has too little memory, with\n`packages`, `cli_memory_mib` and `min_cli_memory_mib`. `node_major_unavailable`, `node_major_existing_only`\nand `node_platform_minimum` refuse a version the site may not use. `feature_off` refuses `apply` `tonight`\nwhile queuing for the window is switched off.\n"},"RuntimeNodeCheckFailed":{"content":{"application/json":{"example":{"code":"node_check_failed","message":"The package check answered something the control panel cannot read.","reason":"node_check_failed"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site's answer could not be read (`node_check_failed`). Try again in a moment."},"RuntimeNodeCopyInvalid":{"content":{"application/json":{"examples":{"confirm":{"summary":"A target is production","value":{"code":"confirm","errors":{"confirm_production":["Copying Node.js settings into production changes what it runs. Confirm to continue."]},"message":"Copying Node.js settings into production changes what it runs. Confirm to continue.","reason":"confirm"}},"copy_target_invalid":{"summary":"A target is not another environment of this site","value":{"code":"copy_target_invalid","errors":{"targets":["Node.js settings can only be copied to another environment of this site."]},"message":"Node.js settings can only be copied to another environment of this site.","reason":"copy_target_invalid"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The copy is refused whole and nothing is applied. `invalid_arguments` names the refused field in `errors`;\n`copy_target_invalid` means a target is not another environment of this site; `confirm` means a target is\nproduction and `confirm_production` is not true.\n"},"RuntimeNodeLiveConflict":{"content":{"application/json":{"examples":{"busy":{"summary":"Another command is running","value":{"code":"busy","message":"Another command is running on this site. Try again in a moment.","reason":"busy"}},"not_running":{"summary":"The site is not running","value":{"code":"not_running","message":"The site is not running","reason":"not_running"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is not running (`not_running`), another command or change is running on it (`busy`), an earlier\ncommand has not been confirmed stopped (`exec_unresolved`), or it is managed by another control panel\n(`managed_elsewhere`).\n"},"RuntimeNodePackageInvalid":{"content":{"application/json":{"examples":{"name_missing":{"summary":"No name","value":{"code":"invalid_arguments","errors":{"name":["Name the package to look up."]},"field":"name","message":"Name the package to look up.","reason":"invalid_arguments"}},"package_spec_invalid":{"summary":"A git address instead of a name","value":{"code":"spec_not_registry","message":"A package comes from the npm registry by name: no URL, git, GitHub, file, link, npm alias or workspace spec.","package":"git+https://example.com/x.git","reason":"package_spec_invalid"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`name` is missing (`invalid_arguments`), or the name or selector cannot be installed from the registry\n(`package_spec_invalid`). For the second, `code` is not the same as `reason`: it says what is wrong, such as\n`spec_not_registry`, and `package` repeats what was asked.\n"},"RuntimeNodeUnavailable":{"content":{"application/json":{"example":{"code":"switched_off","message":"Global package changes are paused while commands are switched off. Try again later.","reason":"switched_off"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has paused package changes for the moment (`switched_off`), or the npm registry could not be reached\n(`registry_unavailable`, with the `package`). Try again later.\n"},"RuntimeNotSaved":{"content":{"application/json":{"example":{"message":"The change could not be saved. Contact support."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The platform did not save the change. Nothing was changed; the body carries a `message` and no `reason`."},"RuntimePhpBodyInvalid":{"content":{"application/json":{"examples":{"invalid":{"summary":"A key that is not accepted","value":{"code":"invalid","diagnostics":[],"errors":[{"code":"invalid","field":"php_version","message":"php_version is not one of version, extensions, settings, fpm, xdebug, custom_ini, apply."}],"field":"php_version","message":"php_version is not one of version, extensions, settings, fpm, xdebug, custom_ini, apply.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/RuntimePhpInvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`). `errors` is a list, each entry with its `field`, `code` and `message`."},"RuntimePhpChangeConflict":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"runtime_locked":{"summary":"Corefinity has locked the configuration","value":{"code":"runtime_locked","message":"Corefinity has locked this environment's PHP configuration. Contact support to change it.","reason":"runtime_locked"}},"stale":{"summary":"The configuration changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The change cannot be made now. `reason` says why: `stale` (the configuration changed since your read: read it\nagain), `busy` (another change to the site is running), `change_pending` (a change already waits for the\nwindow), `runtime_locked` (Corefinity has locked the site's PHP configuration), `runtime_not_adopted` (the site\nis not on the runtime and cannot move onto it yet; the answer adds its `adoption` state), `batch_window` (the\nchange can only be made in the site's window, or other maintenance is already queued for the site: send it\nagain with `apply` `tonight`), `conflict` (other changes kept landing first: send it again), `restore_running`,\n`command_running` or `deployment_running` (a restore, a command or a deployment is running on the site),\n`cluster_paused` (the site's cluster is paused for planned maintenance), `deleted`, `provisioning`, `removed`\nor `managed_elsewhere`. A site that cannot be changed from the Control Panel at all answers a `message` with\nno `reason`.\n"},"RuntimePhpChangeInvalid":{"content":{"application/json":{"examples":{"ini_invalid":{"summary":"The php.ini sets a directive the platform keeps fixed","value":{"code":"ini_invalid","diagnostics":[{"code":"locked","column":1,"end_column":16,"line":1,"message":"open_basedir: The platform sets the paths PHP serves.","severity":"error"}],"errors":[],"message":"open_basedir: The platform sets the paths PHP serves.","reason":"ini_invalid"}},"invalid":{"summary":"Two settings are refused","value":{"code":"invalid","diagnostics":[],"errors":[{"code":"bounds","field":"settings.max_input_vars","message":"max_input_vars is outside the allowed range."},{"code":"setting_unknown","field":"settings.nope","message":"nope is not a Settings form directive."}],"field":"settings.max_input_vars","message":"max_input_vars is outside the allowed range.","reason":"invalid"}},"window_off":{"summary":"Queuing for the window is switched off","value":{"code":"feature_off","message":"Queuing changes for the maintenance window is switched off at the moment","reason":"feature_off"}},"xdebug_on_production":{"summary":"Xdebug on production","value":{"code":"invalid","diagnostics":[],"errors":[{"code":"non_production_only","field":"xdebug","message":"Xdebug is for non-production environments only."}],"field":"xdebug","message":"Xdebug is for non-production environments only.","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/RuntimePhpInvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The change is not valid. `invalid` lists every refused field in `errors`, each with its own `code`, and the\nphp.ini's findings in `diagnostics`. `ini_invalid` means only the php.ini is wrong: see `diagnostics`.\n`feature_off` refuses a custom php.ini while it is not on for your company, and `apply` `tonight` while\nqueuing for the window is switched off.\n"},"RuntimePhpChangesPaused":{"content":{"application/json":{"example":{"code":"switched_off","message":"PHP changes are paused while commands are switched off. Try again later.","reason":"switched_off"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Corefinity has paused PHP changes for the moment (`switched_off`). Try again later."},"RuntimePhpCopyInvalid":{"content":{"application/json":{"examples":{"confirm":{"summary":"A target is production","value":{"code":"confirm","message":"Copying PHP settings into production changes how it runs. Confirm to continue.","reason":"confirm"}},"copy_target_invalid":{"summary":"A target is not another environment of this site","value":{"code":"copy_target_invalid","message":"PHP settings can only be copied to another environment of this site.","reason":"copy_target_invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/RuntimePhpInvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The copy is refused whole and nothing is applied. `invalid` names the field in `errors` (a list);\n`copy_target_invalid` means a target is not another environment of this site; `confirm` means a target is\nproduction and `confirm_production` is not true; `feature_off` refuses `ini` while a custom php.ini is not on\nfor your company, and `apply` `tonight` while queuing for the window is switched off.\n"},"RuntimePhpIniInvalid":{"content":{"application/json":{"examples":{"ini_invalid":{"summary":"The php.ini sets a directive the platform keeps fixed","value":{"code":"ini_invalid","diagnostics":[{"code":"locked","column":1,"end_column":16,"line":1,"message":"open_basedir: The platform sets the paths PHP serves.","severity":"error"}],"errors":[],"message":"open_basedir: The platform sets the paths PHP serves.","reason":"ini_invalid"}}},"schema":{"$ref":"#/components/schemas/RuntimePhpInvalidRefusal"}}},"description":"A field is missing or wrong (`invalid`), or the php.ini has an error, so nothing ran (`ini_invalid`, with its\n`diagnostics`).\n"},"RuntimePhpSettingsConflict":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"stale":{"summary":"The settings changed since your read","value":{"code":"stale","message":"This site changed in the meantime. Reload.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The change cannot be made now. `reason` says why: `stale` (the settings changed since your read), `busy`,\n`change_pending`, `runtime_locked`, `snapshot_running`, `deleted`, `provisioning`, `removed`, `conflict` or\n`managed_elsewhere`.\n"},"RuntimePhpSettingsInvalid":{"content":{"application/json":{"examples":{"invalid":{"summary":"A memory limit outside the site's bounds","value":{"code":"invalid","errors":{"memory_limit_bytes":["memory_limit must be between 128 MiB and 2048 MiB for this site","in steps of 64 MiB"]},"field":"memory_limit_bytes","message":"memory_limit must be between 128 MiB and 2048 MiB for this site, in steps of 64 MiB","reason":"invalid"}},"not_available":{"summary":"A site whose settings are not managed here","value":{"code":"not_available","message":"PHP settings cannot be changed on this site yet. Contact support.","reason":"not_available"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"A field is missing, wrong or outside the site's bounds (`invalid`); the settings of this site are not managed\nhere, such as a site with a custom size (`not_available`); or `apply` `tonight` while queuing for the window is\nswitched off (`feature_off`).\n"},"RuntimePhpSettingsLifecycle":{"content":{"application/json":{"example":{"code":"provisioning","message":"This site is still being created","reason":"provisioning"},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The site is deleted and waiting to be purged (`deleted`), still being created (`provisioning`) or removed (`removed`)."},"RuntimePhpVersionInvalid":{"content":{"application/json":{"examples":{"ack_required":{"summary":"A version past its end of life","value":{"code":"ack_required","detail":{"eol":"PHP 8.1 no longer receives security fixes from the PHP project or from Corefinity. Only use it while you upgrade your code."},"message":"Confirm what this change does before it starts.","reason":"ack_required","required":["eol"]}},"unknown_version":{"summary":"A version the site may not move to","value":{"code":"invalid","errors":{"to":["Unknown version"]},"field":"to","message":"Unknown version","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"A field is missing or wrong (`invalid`); the version needs an acknowledgement (`ack_required`, with what to\nsend in `required` and a sentence for each in `detail`); a line of the custom php.ini is not accepted by the\nnew version (`ini_invalid`, with `diagnostics`); the version is below the one the application's own\nrequirements ask for (`app_php_floor`); `apply` `tonight` while queuing for the window is switched off\n(`feature_off`); the version is not one the site may move to (`invalid` on `to`); or the site cannot change\nversion at the moment (`temporarily_unavailable`, `busy`, `not_available` or `removed`: the message says why).\n"},"RuntimeUpstreamUnavailable":{"content":{"application/json":{"examples":{"read":{"summary":"A read of what PHP runs with that could not be taken","value":{"code":"upstream_unavailable","message":"PHP's configuration could not be read from the pod. Try again in a moment.","reason":"upstream_unavailable"}},"test":{"summary":"A test that did not run to the end","value":{"code":"upstream_unavailable","message":"The test did not run to the end on the site. Try again in a moment.","reason":"upstream_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"PHP's answer could not be read from the site (`upstream_unavailable`). Try again in a moment."},"RuntimeVersionConflict":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The change cannot be made now. `reason` says why, such as `busy` (another change to the site is running),\n`stale` (the site's version changed in the meantime: read it again), `change_pending`, `snapshot_running`,\n`restore_running`, `image_not_offered` (the version is not available at the moment: nothing was changed),\n`cluster_paused`, `removed`, `conflict` or `managed_elsewhere`. A site that cannot be changed from the Control\nPanel at all answers a `message` with no `reason`.\n"},"ScopeRequired":{"content":{"application/json":{"examples":{"destructive_scope_required":{"summary":"The token lacks the destructive scope","value":{"code":"scope_required","message":"This access token does not have the destructive scope this needs. Use a token with the destructive scope.","reason":"scope_required","scope":"destructive"}},"exec_scope_required":{"summary":"The token lacks the exec scope","value":{"code":"scope_required","message":"This access token does not have the exec scope this needs. Use a token with the exec scope.","reason":"scope_required","scope":"exec"}},"read_scope_required":{"summary":"The token lacks the read scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}},"write_scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}}},"schema":{"$ref":"#/components/schemas/ScopeRequiredRefusal"}}},"description":"The token lacks the scope this endpoint needs. `scope` names it."},"SiteAccessConflict":{"content":{"application/json":{"examples":{"busy":{"summary":"Another change is running","value":{"code":"busy","message":"Another change to this site is in progress. Wait for it to finish.","reason":"busy"}},"in_use":{"summary":"A company key","value":{"code":"in_use","message":"Company keys are removed from the company settings page","reason":"in_use"}},"managed_elsewhere":{"summary":"Another control panel manages the site","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"not_saved":{"summary":"The change could not be saved","value":{"message":"The change was not saved"}},"ssh_key_duplicate":{"summary":"A key the environment already holds, added to the built-in user","value":{"code":"ssh_key_duplicate","field":"public_key","message":"That key is already added here.","reason":"ssh_key_duplicate"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The change was refused because of the site's state. `reason` says why: `busy` (another change to this site is\nrunning), `in_use` (the user or key is still being removed, or the key is a company, website or personal key\nthat is removed where it was added), `not_imported` (the site's keys are not managed here yet), `removed` (the\nsite has been removed), `conflict` (the site changed while the change was being saved) or `managed_elsewhere`\n(another control panel manages the site). A change that could not be saved answers a message only, and a\nrefusal after the change was recorded also carries the failed `operation`. A key of the built-in `web` user,\nwhile SSH keys are on, is refused as the SSH keys API refuses it: `ssh_key_duplicate` or\n`ssh_managed_on_another_environment`.\n"},"SiteAccessKeyTooManyRequests":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"The request budget is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}},"ssh_throttled":{"summary":"Too many key changes in a minute","value":{"code":"ssh_throttled","field":null,"message":"Too many SSH key changes — try again in a minute.","reason":"ssh_throttled"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests (`rate_limited`): wait for the number of seconds in `Retry-After`, which\n`retry_after_seconds` repeats. A key of the built-in `web` user, while SSH keys are on, also counts against\nthe limit on key changes, 30 a minute for you and 120 a minute for your company (`ssh_throttled`, with no\nwait given: try again in a minute).\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"SiteAccessNotReady":{"content":{"application/json":{"examples":{"not_ready":{"summary":"The platform is not ready (the failed operation is left out here)","value":{"message":"The platform deploy key is not configured. Contact support."}}},"schema":{"properties":{"message":{"type":"string"},"operation":{"allOf":[{"$ref":"#/components/schemas/Operation"}],"description":"The failed change."}},"required":["message"],"type":"object"}}},"description":"The platform is not ready to apply changes to users and keys. The change was recorded and failed, and the\nfailed `operation` is in the answer. There is no `reason` or `code`. Contact support.\n"},"SiteAccessUserInvalid":{"content":{"application/json":{"examples":{"built_in":{"summary":"The built-in user","value":{"code":"invalid","message":"This user cannot be changed","reason":"invalid"}},"built_in_password":{"summary":"A password for the built-in user","value":{"code":"invalid","message":"Passwords can be set on named users only","reason":"invalid"}},"folder":{"summary":"A folder outside htdocs and shared","value":{"code":"invalid","errors":{"root_path":["The folder must be inside htdocs or shared"]},"field":"root_path","message":"The folder must be inside htdocs or shared","reason":"invalid"}},"folder_for_ssh":{"summary":"A folder for an SSH user","value":{"code":"invalid","errors":{"root_path":["Only SFTP users have a folder. SSH users reach the whole site."]},"field":"root_path","message":"Only SFTP users have a folder. SSH users reach the whole site.","reason":"invalid"}},"invalid":{"summary":"A type that is not one","value":{"code":"invalid","errors":{"type":["The selected type is invalid."]},"field":"type","message":"The selected type is invalid.","reason":"invalid"}},"password":{"summary":"A password that is too short","value":{"code":"invalid","errors":{"password_value":["Choose a longer password that is not the username or the domain"]},"field":"password_value","message":"Choose a longer password that is not the username or the domain","reason":"invalid"}},"person_login":{"summary":"A new user with a person's own SSH username","value":{"code":"ssh_person_managed_elsewhere","message":"That username belongs to a person's own SSH login. Choose another name.","reason":"ssh_person_managed_elsewhere"}},"person_login_change":{"summary":"A change to a user that is a person's own SSH username","value":{"code":"ssh_person_managed_elsewhere","field":null,"message":"That username belongs to a person and is managed in their profile.","reason":"ssh_person_managed_elsewhere"}},"username_invalid":{"summary":"A username that is not one","value":{"code":"invalid","errors":{"username":["Usernames are 3 to 31 lower-case letters, digits or dashes, starting with a letter"]},"field":"username","message":"Usernames are 3 to 31 lower-case letters, digits or dashes, starting with a letter","reason":"invalid"}},"username_taken":{"summary":"A username already used","value":{"code":"invalid","errors":{"username":["This username is already used on this site"]},"field":"username","message":"This username is already used on this site","reason":"invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"A field is missing or wrong, or the user cannot be made or changed as asked (`invalid`; `field` names the\nfield when the refusal is about one). A username that is a person's own SSH username is refused with the\nreason `ssh_person_managed_elsewhere`.\n"},"SiteAccessWriteForbidden":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"exec_scope_required":{"summary":"A generated password needs the exec scope","value":{"code":"scope_required","message":"This access token does not have the exec scope this needs. Use a token with the exec scope.","reason":"scope_required","scope":"exec"}},"restricted":{"summary":"A key with restrictions","value":{"code":"restricted","message":"Restricted keys are changed by staff","reason":"restricted"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the scope (`scope_required`, with the `scope` to use: `write`, or `exec` for a generated\npassword), your company requires two-factor authentication and you have not set it up, your account has\nno company that can use Managed Clusters (`company_not_enabled`), or the key carries restrictions that only Corefinity changes (`restricted`).\n"},"SiteCommandUnavailable":{"content":{"application/json":{"examples":{"connect_failed":{"summary":"The cluster could not be reached","value":{"code":"connect_failed","message":"The cluster could not be reached","reason":"connect_failed"}},"files_unreadable":{"summary":"The site's files could not be read","value":{"code":"temporarily_unavailable","message":"The site's files could not be read from the pod. Try again in a moment.","reason":"temporarily_unavailable"}},"not_configured":{"summary":"The site's cluster cannot be reached yet","value":{"code":"connect_failed","message":"The site's cluster is not configured","reason":"connect_failed"}},"switched_off":{"summary":"Commands on sites are switched off","value":{"code":"switched_off","message":"Site commands are switched off at the moment","reason":"switched_off"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The request runs a command on the site, and Corefinity has switched commands on sites off for the moment\n(`switched_off`), the site's cluster could not be reached (`connect_failed`), or the site's files could not be\nread (`temporarily_unavailable`). Try again later.\n"},"SiteCreatePlatformUnreadable":{"content":{"application/json":{"example":{"message":"The platform could not be checked just now. Try again in a minute."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The platform could not be read to check the new site, or to prepare it, so nothing was created. Try again in a minute. The body carries a `message` and no `reason`."},"SiteCreateVersionsUnavailable":{"content":{"application/json":{"examples":{"catalogue_unavailable":{"summary":"The list of application versions cannot be read","value":{"code":"catalogue_unavailable","message":"Application versions are unavailable right now. Try again in a few minutes.","reason":"catalogue_unavailable"}},"commerce_check_unavailable":{"summary":"The Marketplace keys could not be checked","value":{"code":"commerce_check_unavailable","message":"We could not check your Magento Marketplace keys. Try again in a few minutes.","reason":"commerce_check_unavailable"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The create could not be judged, so nothing was created; try again in a few minutes. `catalogue_unavailable`:\nthe list of application versions cannot be read. `commerce_check_unavailable`: an Adobe Commerce create,\nwhose Marketplace keys could not be checked with the Magento repository.\n"},"SiteDeploymentArgumentRefused":{"content":{"application/json":{"examples":{"name_format":{"$ref":"#/components/examples/SiteDeploymentVariableNameFormatExample"},"unknown":{"summary":"A parameter the endpoint does not take","value":{"code":"invalid","errors":{"foo":["The foo argument is not part of this request."]},"field":"foo","message":"Some arguments are not valid.","reason":"invalid"}}},"schema":{"$ref":"#/components/schemas/InvalidRefusal"}}},"description":"A field or query parameter this endpoint does not take, or a name that is not in the expected format (`invalid`, with the `field`)."},"SiteDeploymentConnectionNeedsReauth":{"content":{"application/json":{"examples":{"needs_reauth":{"value":{"code":"needs_reauth","message":"The GitLab connection needs re-authorising","reason":"needs_reauth"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The git provider no longer accepts the connection (`needs_reauth`). Reconnect the account in the Control Panel."},"SiteDeploymentConnectionNotFound":{"content":{"application/json":{"examples":{"not_found":{"value":{"message":"Not found."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/FeatureOffRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The site does not exist or is one you cannot deploy, `connection` is not a connection you may use on this\nsite, or deployments are not on for your company (`feature_off`).\n"},"SiteDeploymentForbidden":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"Your role lacks the permission","value":{"code":"forbidden","message":"You need the Create Deployments permission to do this. An owner of your company can grant it in Roles.","permission":"createDeployments","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"token_cannot_deploy":{"summary":"Deploying, stopping, retrying or rolling back with a token that lacks the deploy ability","value":{"code":"scope_required","message":"This access token cannot deploy.","reason":"scope_required","scope":"deploy"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}},"waiting_not_yours":{"summary":"A waiting deployment you may not start","value":{"message":"You are not allowed to start this deployment."}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope (`scope_required`; to deploy, stop, retry or roll back it also needs the\n`deploy` ability, and `scope` names which is missing), your company requires two-factor authentication and you\nhave not set it up, or your role lacks the permission the action needs (`forbidden`, with the `permission`):\nCreate Deployments to deploy, and Deploy Deployments as well to start a deployment that waits. A waiting\ndeployment you may not start answers a message only.\n"},"SiteDeploymentPipelineConflict":{"content":{"application/json":{"examples":{"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}},"pipeline_classic":{"summary":"Not a three-stage pipeline yet","value":{"code":"pipeline_classic","message":"Corefinity still runs this pipeline in its classic form, so it cannot be edited yet.","reason":"pipeline_classic"}},"pipeline_locked":{"summary":"Corefinity has locked the pipeline","value":{"code":"pipeline_locked","message":"Corefinity has locked this pipeline: Held while a migration is checked.","reason":"pipeline_locked"}},"stale":{"summary":"The pipeline changed since you read it","value":{"code":"stale","message":"This pipeline changed since you opened it. Review the latest version, then save again.","reason":"stale"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The pipeline changed since the `revision` you sent, or no revision was sent (`stale`): read it again. A reset\nto the template also answers the `revision` the pipeline is at now. Or Corefinity has locked the pipeline\n(`pipeline_locked`), it is not a three-stage pipeline yet or the version cannot be restored\n(`pipeline_classic`), a carried-over pipeline still waits for its review (`pipeline_review_pending`, on a\nreset), or the site is managed by another control panel (`managed_elsewhere`).\n"},"SiteDeploymentPipelineRefused":{"content":{"application/json":{"examples":{"copy_confirm":{"summary":"A copy onto production, not confirmed","value":{"code":"confirm","errors":{"confirm_production":["Copying into production changes how it deploys. Confirm to continue."]},"message":"Copying into production changes how it deploys. Confirm to continue.","reason":"confirm"}},"line_credentials":{"summary":"A line that holds a credential","value":{"code":"line_credentials","errors":{"lines.0":["This line holds a credential. Move this value into a variable, then save again."]},"message":"This line holds a credential. Move this value into a variable, then save again.","reason":"line_credentials"}},"maintenance_policy_unavailable":{"summary":"A maintenance setting the platform does not offer","value":{"code":"maintenance_policy_unavailable","errors":{"maintenance_policy":["Choose Always or Off: this platform has no pending-upgrade check."]},"message":"Choose Always or Off: this platform has no pending-upgrade check.","reason":"maintenance_policy_unavailable"}},"reset_confirm":{"summary":"A reset of production, not confirmed","value":{"code":"confirm","errors":{"confirm_production":["Confirm the production environment to reset it to its template."]},"message":"Confirm the production environment to reset it to its template.","reason":"confirm"}},"reset_stages":{"summary":"A reset that names something that is not a stage","value":{"code":"invalid","errors":{"stages":["Choose the stages to change."]},"field":"stages","message":"Choose the stages to change.","reason":"invalid"}},"setting":{"summary":"A setting that is not a value it takes","value":{"code":"invalid","errors":{"tunnels":["Choose when the build may reach this environment's services."]},"field":"tunnels","message":"Choose when the build may reach this environment's services.","reason":"invalid"}},"timeout_out_of_range":{"summary":"A timeout outside its bounds","value":{"code":"timeout_out_of_range","errors":{"timeouts.build":["Choose a timeout between 60 and 3600 seconds."]},"message":"Choose a timeout between 60 and 3600 seconds.","reason":"timeout_out_of_range"}},"timeout_unknown":{"summary":"A timeout the pipeline does not have","value":{"code":"invalid","errors":{"timeouts.deploy":["That is not one of the pipeline's timeouts."]},"field":"timeouts.deploy","message":"That is not one of the pipeline's timeouts.","reason":"invalid"}},"version_unavailable":{"summary":"A template version that cannot be held here","value":{"code":"version_unavailable","errors":{"version":["This version is not available here."]},"message":"This version is not available here.","reason":"version_unavailable"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The request was refused and nothing was saved.\n\n- `invalid`: a field is missing, of the wrong type or not a value it takes. `field` names it.\n- `confirm`: a production environment, and `confirm_production` is not true.\n- `line_credentials`: a line holds a credential (move it into a variable); `line_own_shell`: a line such as a\n  lone `cd`, which does nothing for the next line.\n- `too_many_lines`, `line_too_long`: a stage holds more lines, or a line more bytes, than it can.\n- `preset_unavailable`, `node_too_old`: a build preset, or a Node.js version, that cannot be used here.\n- `maintenance_policy_unavailable`, `wrong_platform`, `timeout_out_of_range`: a setting the site's platform\n  does not offer, or a timeout outside its bounds.\n- `version_unavailable`, `not_reached`: on a reset, a template version that cannot be held here, or a\n  pipeline that does not follow a template.\n- `too_many_variables`, `variable_reserved`, `variable_tool_credential`, `variable_invalid`: on a copy of\n  `variables`, a variable this environment cannot take. Nothing of the copy is kept.\n\nEvery reason but `invalid` names its field in `errors` only.\n"},"SiteDeploymentPipelineWriteForbidden":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"exec_scope_required":{"summary":"A change that brings a command needs the exec scope","value":{"code":"scope_required","message":"This access token does not have the exec scope this needs. Use a token with the exec scope.","reason":"scope_required","scope":"exec"}},"permission":{"summary":"The role lacks Edit Environment Deployment Pipeline","value":{"code":"forbidden","message":"You need the Edit Environment Deployment Pipeline permission to do this. An owner of your company can grant it in Roles.","permission":"editEnvironmentDeploymentPipeline","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the scope (`scope_required`, with the `scope` to use: `write`, or `exec` when the change\nbrings a command the pipeline does not run now), your company requires two-factor authentication and you have\nnot set it up, or your role lacks the Edit Environment Deployment Pipeline permission (`forbidden`, with\n`permission`).\n"},"SiteDeploymentSecretConflict":{"content":{"application/json":{"examples":{"exists":{"summary":"The registry is already saved","value":{"code":"exists","id":318,"message":"A registry for this host is already saved. Edit it instead.","reason":"exists"}},"managed_elsewhere":{"summary":"The site is managed by another control panel","value":{"code":"managed_elsewhere","message":"This site is managed by another control panel","reason":"managed_elsewhere"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The environment already has a credential for this registry and scope (`exists`, with the saved one's `id`):\nchange that one instead. Or the site is managed by another control panel (`managed_elsewhere`).\n"},"SiteDeploymentSecretRefused":{"content":{"application/json":{"examples":{"auth_type":{"summary":"A Composer credential without its sign-in type","value":{"code":"secret_invalid","errors":{"auth_type":["Choose how the registry signs in: http-basic, bearer, github-oauth or gitlab-token."]},"message":"Choose how the registry signs in: http-basic, bearer, github-oauth or gitlab-token.","reason":"secret_invalid"}},"kind":{"summary":"A kind that is not offered","value":{"code":"invalid","errors":{"kind":["The kind argument must be one of: \"npm\", \"composer\"."]},"field":"kind","message":"Some arguments are not valid.","reason":"invalid"}},"label":{"summary":"A label that is empty or longer than 255 characters","value":{"code":"secret_invalid","errors":{"label":["Enter a name for this registry (up to 255 characters)."]},"message":"Enter a name for this registry (up to 255 characters).","reason":"secret_invalid"}},"nothing":{"summary":"A change that names nothing to change","value":{"code":"invalid","errors":{"secret_id":["Send what to change, or verify: true."]},"field":"secret_id","message":"Send what to change, or verify: true.","reason":"invalid"}},"npm_url":{"summary":"An npm registry that is not an HTTPS URL","value":{"code":"secret_invalid","errors":{"registry":["Enter the registry's HTTPS URL (https://...). npm registries are addressed by URL."]},"message":"Enter the registry's HTTPS URL (https://...). npm registries are addressed by URL.","reason":"secret_invalid"}},"private":{"summary":"A registry on a private address","value":{"code":"secret_invalid","errors":{"registry":["This registry's address is not public. Builds reach only public registries."]},"message":"This registry's address is not public. Builds reach only public registries.","reason":"secret_invalid"}},"scope_length":{"summary":"A scope longer than 214 characters","value":{"code":"invalid","errors":{"scope":["The scope argument must be at most 214 characters."]},"field":"scope","message":"Some arguments are not valid.","reason":"invalid"}},"token":{"summary":"A token that is empty, longer than 4,096 characters or holds a control character","value":{"code":"secret_invalid","errors":{"secret":["Enter the token. It may not contain line breaks or control characters."]},"message":"Enter the token. It may not contain line breaks or control characters.","reason":"secret_invalid"}},"too_many":{"summary":"The environment is full","value":{"code":"secret_invalid","errors":{"secret":["This environment already has the most registry secrets it can hold."]},"message":"This environment already has the most registry secrets it can hold.","reason":"secret_invalid"}},"unknown":{"summary":"A field the endpoint does not take","value":{"code":"invalid","errors":{"secret":["The secret argument is not part of this request."]},"field":"secret","message":"Some arguments are not valid.","reason":"invalid"}},"username":{"summary":"An http-basic credential without a username","value":{"code":"secret_invalid","errors":{"username":["Enter the username for http-basic sign-in."]},"message":"Enter the username for http-basic sign-in.","reason":"secret_invalid"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/InvalidRefusal"},{"$ref":"#/components/schemas/NamedFieldRefusal"}]}}},"description":"The request was refused and nothing was saved. `errors` names the field.\n\n- `secret_invalid`: a value the rules refuse (the label, the registry, the scope, the sign-in type, the\n  username for `http-basic`, the token), a registry whose address is not public or does not resolve, an\n  environment that holds as many credentials as it can, or Composer credentials that would be too large\n  together.\n- `invalid`: a field of the wrong type or one this endpoint does not take (the token is `token`), a `scope`\n  longer than 214 characters, or a change that names nothing to change and no `verify` true (on `secret_id`).\n"},"SshCompanyReadForbidden":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Your role may not read company keys","value":{"code":"forbidden","field":null,"message":"You need the View Company SSH Keys permission to do this. An owner of your company can grant it in Roles.","permission":"viewCompanySSHKeys","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the read scope this needs. Use a token with the read scope.","reason":"scope_required","scope":"read"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"}]}}},"description":"The token lacks the `read` scope (`scope_required`), or your role lacks the View Company SSH Keys permission\n(`forbidden`; `permission` names it, and `field` is null as on every SSH refusal).\n"},"SshInvalidQuery":{"content":{"application/json":{"examples":{"cursor_not_valid":{"summary":"A value that is not a cursor of this list","value":{"code":"invalid_arguments","errors":{"cursor":["That page cursor is not valid."]},"field":"cursor","message":"That page cursor is not valid.","reason":"invalid_arguments"}},"cursor_too_long":{"summary":"More than 200 characters","value":{"code":"invalid_arguments","errors":{"cursor":["cursor is the next_cursor of the previous page."]},"field":"cursor","message":"cursor is the next_cursor of the previous page.","reason":"invalid_arguments"}},"environment_id":{"summary":"A Legacy list filtered by something that is not an id","value":{"code":"invalid_arguments","errors":{"environment_id":["environment_id is an environment id."]},"field":"environment_id","message":"environment_id is an environment id.","reason":"invalid_arguments"}}},"schema":{"$ref":"#/components/schemas/SshRefusal"}}},"description":"A query parameter is wrong (`invalid_arguments`); `field` names it."},"SshNotFound":{"content":{"application/json":{"examples":{"feature_off":{"summary":"SSH keys are not on","value":{"code":"feature_off","message":"Not found.","reason":"feature_off"}},"keys_not_switched_on":{"summary":"A key change while keys are not switched on yet","value":{"code":"feature_off","field":null,"message":"SSH keys are not switched on yet.","reason":"feature_off"}},"not_found":{"summary":"Not found, or not yours to reach","value":{"code":"not_found","field":null,"message":"Not found.","reason":"not_found"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/NotFoundRefusal"},{"$ref":"#/components/schemas/FeatureOffRefusal"},{"$ref":"#/components/schemas/SshRefusal"}]}}},"description":"The id does not exist or is something you cannot reach (`not_found`; both answer the same body), or SSH keys\nare not on for it (`feature_off`, which on a key change may add `field: null`).\n"},"SshTooManyWrites":{"content":{"application/json":{"examples":{"ssh_throttled":{"summary":"Too many key changes in a minute","value":{"code":"ssh_throttled","field":null,"message":"Too many SSH key changes — try again in a minute.","reason":"ssh_throttled"}},"too_many_attempts":{"summary":"The request budget is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 42 seconds.","reason":"rate_limited","retry_after_seconds":42}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/SshRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"Too many requests (`rate_limited`): the API's general limit, or the limit on key changes, 30 a minute for you\nand 120 a minute for your company across the Control Panel, this API and MCP. Wait for the number of seconds\nin `Retry-After`, which `retry_after_seconds` repeats. A change that meets the key limit a moment later, while\nit is being saved, answers `ssh_throttled` with no wait: try again in a minute.\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"SshWriteForbidden":{"content":{"application/json":{"examples":{"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"forbidden":{"summary":"Your role may not add company keys","value":{"code":"forbidden","field":null,"message":"You need the Create Company SSH Keys permission to do this. An owner of your company can grant it in Roles.","permission":"createCompanySSHKeys","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/PermissionRefusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you\nhave not set it up, or the request is about a company key and your role lacks the permission for it\n(`forbidden`; `permission` names it, and `field` is null as on every SSH refusal).\n"},"SwitchedOff":{"content":{"application/json":{"example":{"code":"switched_off","message":"Deleting is switched off at the moment","reason":"switched_off","switch":"delete"},"schema":{"$ref":"#/components/schemas/SwitchedOffRefusal"}}},"description":"Corefinity has switched this action off for the moment. Try again later."},"TooManyRequests":{"content":{"application/json":{"example":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which\n`retry_after_seconds` repeats.\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"}}},"TooManyRequestsOrOwnBudget":{"content":{"application/json":{"examples":{"own_budget":{"summary":"The budget the endpoint names is spent","value":{"code":"rate_limited","message":"Too many attempts on this environment. Try again shortly.","reason":"rate_limited","retry_after_seconds":60}},"rate_limited":{"summary":"The endpoint's request limit is spent","value":{"code":"rate_limited","message":"Too many requests. Try again in 60 seconds.","reason":"rate_limited","retry_after_seconds":60}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"Too many requests (`rate_limited`): the endpoint's request limit is spent, or a budget of its own that the\nendpoint names, which the Control Panel and AI assistants spend too. Wait for the number of seconds in\n`Retry-After`, which `retry_after_seconds` repeats.\n","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"},"X-RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"}}},"Unauthenticated":{"content":{"application/json":{"example":{"message":"Unauthenticated."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"No token, or a token that is not valid."},"UpgradeClusterWriteForbidden":{"content":{"application/json":{"examples":{"billing_forbidden":{"summary":"You may not pay for a change","value":{"code":"billing_forbidden","message":"Billing is available to your company's owner and billing contacts.","reason":"billing_forbidden"}},"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"},{"$ref":"#/components/schemas/Message"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and\nyou have not set it up (`two_factor_required`), or you may not pay\nfor a change (`billing_forbidden`: paying is for the company's owner and billing contacts).\n"},"UpgradeRegionNotReady":{"content":{"application/json":{"examples":{"temporarily_unavailable":{"summary":"The region is not ready","value":{"code":"temporarily_unavailable","message":"This region is not ready","reason":"temporarily_unavailable"}},"tier_cluster_missing":{"summary":"The region has no servers of that type yet","value":{"code":"tier_cluster_missing","message":"The platform has no compute cluster for this here yet. Contact support.","reason":"tier_cluster_missing"}},"tier_cluster_missing_in_a_corecluster":{"summary":"A site of the CoreCluster cannot move","value":{"code":"tier_cluster_missing","message":"journal.harbourandfinch.example.com: The platform has no compute cluster for this here yet. Contact support.","reason":"tier_cluster_missing","refused":[{"message":"The platform has no compute cluster for this here yet. Contact support.","reason":"tier_cluster_missing","site":{"domain":"journal.harbourandfinch.example.com","id":1051},"status":503}]}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"The region the site or CoreCluster runs in cannot take the move at the moment: it is not ready\n(`temporarily_unavailable`), or it has no servers of the other type yet (`tier_cluster_missing`). Nothing was\nchanged. Try again later, or open a ticket. For a CoreCluster the sentence starts with the site's domain and\n`refused` lists each site that cannot move.\n"},"UpgradeWriteForbidden":{"content":{"application/json":{"examples":{"billing_forbidden":{"summary":"You may not pay for a change","value":{"code":"billing_forbidden","message":"Billing is available to your company's owner and billing contacts.","reason":"billing_forbidden"}},"company_unavailable":{"summary":"Your account belongs to no company, or to a deleted one","value":{"code":"company_unavailable","message":"Your company is unavailable.","reason":"company_unavailable"}},"managing_agency":{"summary":"You reach the site only as its managing agency","value":{"code":"forbidden","message":"Billing for this site is Harbour & Finch's.","reason":"forbidden"}},"scope_required":{"summary":"The token lacks the write scope","value":{"code":"scope_required","message":"This access token does not have the write scope this needs. Use a token with the write scope.","reason":"scope_required","scope":"write"}},"two_factor":{"summary":"Two-factor authentication is required and not set up","value":{"code":"two_factor_required","message":"Two-factor enrolment is required before using this.","reason":"two_factor_required"}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/ScopeRequiredRefusal"},{"$ref":"#/components/schemas/Refusal"}]}}},"description":"The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and\nyou have not set it up (`two_factor_required`), you may not pay for a change (`billing_forbidden`: paying is\nfor the paying company's owner and billing contacts), or you reach the site only as its managing agency\n(`forbidden`).\n"},"UpstreamFailed":{"content":{"application/json":{"example":{"message":"The platform could not be reached. Try again in a minute."},"schema":{"$ref":"#/components/schemas/Message"}}},"description":"The platform could not be reached, or did not save the change. Try again in a minute."},"UrlChangeConflict":{"content":{"application/json":{"examples":{"maintenance":{"summary":"The maintenance page is on","value":{"code":"maintenance","message":"Switch the maintenance page off before changing the site's hosts","reason":"maintenance"}},"preview_only":{"summary":"No domain attached yet","value":{"code":"preview_only","message":"Take the site live first","reason":"preview_only"}}},"schema":{"$ref":"#/components/schemas/Refusal"}}},"description":"`preview_only` (no domain attached yet), `busy` or `restore_running` (another change is running),\n`maintenance` (the maintenance page is on), `not_running`, `not_available`, `not_connected` (with `point_dns`\nand no Cloudflare zone), `store_hosts`, `deleted`, `removed`, `provisioning` or `managed_elsewhere`.\n"}},"schemas":{"AccountSecurityChoice":{"properties":{"key":{"$ref":"#/components/schemas/AccountSecurityChoiceKey"},"label":{"description":"The length in words, such as `16 hours`.","type":"string"},"minutes":{"type":"integer"}},"required":["key","minutes","label"],"type":"object"},"AccountSecurityChoiceKey":{"description":"A length of time, as its key.","enum":["8h","16h","1d","3d","7d"],"type":"string"},"AccountSecuritySignInSettings":{"properties":{"choices":{"description":"The values you can choose, shortest first.","items":{"$ref":"#/components/schemas/AccountSecurityChoice"},"type":"array"},"session_limit":{"allOf":[{"$ref":"#/components/schemas/AccountSecurityChoice"},{"properties":{"default":{"description":"Whether you have never chosen a value, so the default applies.","type":"boolean"}},"required":["default"],"type":"object"}],"description":"How long you stay signed in, counted from the moment you sign in."},"staff_cap":{"description":"Always `false` for customers and agencies.","type":"boolean"},"two_factor_trust":{"allOf":[{"$ref":"#/components/schemas/AccountSecurityChoice"},{"properties":{"applies":{"description":"Whether you have two-factor authentication on. Without it no browser can be trusted.","type":"boolean"},"default":{"description":"Whether you have never chosen a value, so the default applies.","type":"boolean"}},"required":["default","applies"],"type":"object"}],"description":"How long a trusted browser skips your two-factor code. Never longer than `session_limit`."}},"required":["session_limit","two_factor_trust","choices","staff_cap"],"type":"object"},"AccountSecurityTrustedDevice":{"additionalProperties":false,"properties":{"created_at":{"description":"When the browser was trusted. The times of a trusted browser carry their offset, such as `2026-11-09T10:15:00+00:00`.","format":"date-time","type":["string","null"]},"current":{"description":"Always `false` over the API. A token is not a browser.","type":"boolean"},"id":{"description":"26 letters and digits, not a number.","type":"string"},"label":{"description":"The browser and its system, such as `Chrome on macOS`.","type":"string"},"last_used_at":{"description":"When the browser last skipped the code.","format":"date-time","type":["string","null"]},"last_used_ip":{"description":"The address the browser last signed in from.","type":["string","null"]},"trusted_until":{"description":"When the trust runs out under your two-factor trust as it is now.","format":"date-time","type":"string"}},"required":["id","label","created_at","last_used_at","last_used_ip","trusted_until","current"],"type":"object"},"ActivityItem":{"additionalProperties":true,"properties":{"actor":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"at":{"type":"string"},"cluster":{"oneOf":[{"$ref":"#/components/schemas/ClusterRef"},{"type":"null"}]},"environment":{"oneOf":[{"$ref":"#/components/schemas/EnvironmentRef"},{"type":"null"}]},"href":{"description":"A path in the Control Panel.","type":["string","null"]},"id":{"description":"The kind, a colon and a number, such as `operation:77120`.","type":"string"},"kind":{"enum":["operation","command","deployment","restore","snapshot","terminal","pagespeed","audit","copy"],"type":"string"},"origin":{"enum":["mcp","panel",null],"type":["string","null"]},"ref":{"description":"What the item is about, by `type` and `id`.","type":["object","null"]},"scope":{"type":["string","null"]},"site":{"oneOf":[{"$ref":"#/components/schemas/SiteRef"},{"type":"null"}]},"status":{"type":["string","null"]},"status_label":{"type":["string","null"]},"summary":{"type":["string","null"]},"title":{"type":"string"},"unfinished":{"type":"boolean"}},"required":["id","kind","at","title","status"],"type":"object"},"ActivityPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ActivityItem"},"type":"array"},"next_before":{"description":"Send as `before` for the next page. Null on the last page.","type":["integer","null"]},"next_before_id":{"description":"Send as `before_id` for the next page. Null on the last page.","type":["string","null"]}},"required":["items","next_before","next_before_id"],"type":"object"},"AgencyLinksAgencies":{"additionalProperties":false,"properties":{"agencies":{"description":"By name.","items":{"additionalProperties":false,"properties":{"deploys_through":{"description":"How many of your environments deploy through one of the agency's deployment connections.","type":"integer"},"id":{"minimum":1,"type":"integer"},"manages_sites":{"description":"How many of your sites the agency manages.","type":"integer"},"name":{"description":"The agency's name. `Removed agency` when the agency has been deleted; its link can still be detached.","type":"string"},"type":{"enum":["agency","partner"],"type":"string"}},"required":["id","name","type","manages_sites","deploys_through"],"type":"object"},"type":"array"},"can_detach":{"description":"Whether you may detach an agency. Owners only, and never in an archived company.","type":"boolean"},"company_id":{"description":"Your own company.","minimum":1,"type":"integer"},"repository_gaps":{"description":"Your environments that lost their repository when an agency was detached and still need a new deployment connection, oldest first.","items":{"additionalProperties":false,"properties":{"agency_id":{"minimum":1,"type":"integer"},"agency_name":{"type":"string"},"detached_at":{"description":"With its offset, such as `2026-11-03T09:16:40+00:00`.","format":"date-time","type":"string"},"environment_id":{"minimum":1,"type":"integer"},"environment_name":{"type":"string"},"website_id":{"minimum":1,"type":"integer"}},"required":["environment_id","environment_name","website_id","agency_id","agency_name","detached_at"],"type":"object"},"type":"array"}},"required":["company_id","agencies","repository_gaps","can_detach"],"type":"object"},"AgencyLinksAgencyPreview":{"additionalProperties":false,"properties":{"agency_id":{"minimum":1,"type":"integer"},"effects":{"$ref":"#/components/schemas/AgencyLinksEffects"}},"required":["agency_id","effects"],"type":"object"},"AgencyLinksClientPreview":{"additionalProperties":false,"properties":{"client_id":{"minimum":1,"type":"integer"},"effects":{"$ref":"#/components/schemas/AgencyLinksEffects"}},"required":["client_id","effects"],"type":"object"},"AgencyLinksClients":{"additionalProperties":false,"properties":{"can_detach":{"description":"Whether you may detach a client. Owners only, and never in an archived company.","type":"boolean"},"clients":{"description":"By name. A client that has been deleted is named `Removed company`.","items":{"$ref":"#/components/schemas/Named"},"type":"array"},"company_id":{"description":"Your own company.","minimum":1,"type":"integer"}},"required":["company_id","clients","can_detach"],"type":"object"},"AgencyLinksConfirmRefusal":{"allOf":[{"$ref":"#/components/schemas/ConfirmMismatchRefusal"},{"properties":{"effects":{"$ref":"#/components/schemas/AgencyLinksEffects"}},"required":["effects","errors"],"type":"object"}],"description":"The shared `ConfirmMismatchRefusal` with `effects` added, what the detach would end. `errors` is always sent."},"AgencyLinksDetached":{"additionalProperties":false,"properties":{"detached":{"additionalProperties":false,"description":"The link that was removed.","properties":{"agency_id":{"minimum":1,"type":"integer"},"client_id":{"minimum":1,"type":"integer"}},"required":["agency_id","client_id"],"type":"object"},"effects":{"$ref":"#/components/schemas/AgencyLinksEffects"}},"required":["detached","effects"],"type":"object"},"AgencyLinksEffects":{"additionalProperties":false,"description":"What detaching a link ends. A client reads the names of its own sites and environments; an agency reads\ncounts only.\n","properties":{"firewall":{"additionalProperties":false,"properties":{"stay_for_review":{"description":"Allowances the agency's people added that belong to the client. They stay; review them.","type":"integer"},"stop_applying":{"description":"The agency's own firewall allowances that stop applying to the client's sites.","type":"integer"}},"required":["stop_applying","stay_for_review"],"type":"object"},"managed_sites":{"additionalProperties":false,"description":"The client's sites the agency manages. They go back to the client.","properties":{"count":{"type":"integer"},"names":{"description":"Their names. Only for the client.","items":{"type":"string"},"type":"array"}},"required":["count"],"type":"object"},"repositories":{"additionalProperties":false,"description":"The client's environments that deploy through one of the agency's deployment connections. Each needs a new connection before its next deployment.","properties":{"count":{"type":"integer"},"environments":{"description":"The environments, by name. Only for the client.","items":{"$ref":"#/components/schemas/Named"},"type":"array"},"other_environments":{"description":"Environments that are counted but not named. Only for the client.","type":"integer"}},"required":["count"],"type":"object"},"side":{"description":"Who is asking, the `client` or the `agency`.","enum":["client","agency"],"type":"string"},"ssh_keys":{"additionalProperties":false,"description":"SSH keys the agency's people added, which are removed.","properties":{"count":{"type":"integer"}},"required":["count"],"type":"object"},"summary":{"description":"The same effects as sentences.","items":{"type":"string"},"type":"array"},"ticket_subscriptions":{"additionalProperties":false,"description":"Subscriptions of the agency's people to the client's tickets, which end.","properties":{"count":{"type":"integer"}},"required":["count"],"type":"object"}},"required":["side","managed_sites","repositories","ssh_keys","firewall","ticket_subscriptions","summary"],"type":"object"},"AgencyPage":{"allOf":[{"$ref":"#/components/schemas/AgencyPageFields"},{"properties":{"id":{"minimum":1,"type":"integer"},"published":{"description":"Whether the page is in the partner directory.","type":"boolean"},"status":{"description":"`live`, or what the page is waiting for: `pending_create` (a first request), `pending_change`,\n`pending_delete`. `inactive` and `deleted` pages are not shown in the directory.\n","enum":["live","pending_create","pending_change","pending_delete","inactive","deleted","unknown"],"type":"string"}},"required":["id","status","published"],"type":"object"}]},"AgencyPageChangeRequest":{"allOf":[{"$ref":"#/components/schemas/AgencyPageFields"},{"properties":{"created_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"page_id":{"description":"The `id` of the page the request is about.","minimum":1,"type":["integer","null"]},"status":{"enum":["pending","approved","rejected","processing","unknown"],"type":"string"},"type":{"description":"Whether the request creates the page, edits it or deletes it.","enum":["create","edit","delete","unknown"],"type":"string"},"updated_at":{"format":"date-time","type":["string","null"]}},"required":["id","page_id","type","status","created_at","updated_at"],"type":"object"}]},"AgencyPageChangeRequestAnswer":{"properties":{"data":{"$ref":"#/components/schemas/AgencyPageChangeRequest"}},"required":["data"],"type":"object"},"AgencyPageChangeRequestBody":{"description":"The fields to request. At least one; every one but `slug` for a first page.","minProperties":1,"properties":{"address":{"maxLength":255,"type":"string"},"content":{"maxLength":65535,"type":"string"},"email_address":{"description":"An address whose domain can receive email; the domain is looked up, so the placeholder address in the example is refused `422` on this field.","maxLength":255,"type":"string"},"listing_description":{"maxLength":65535,"type":"string"},"name":{"maxLength":255,"type":"string"},"phone_number":{"description":"A UK phone number, such as `01632 960 123`.","maxLength":255,"type":"string"},"services":{"description":"The services your agency offers, as names. It replaces the whole list.","items":{"maxLength":255,"type":"string"},"maxItems":30,"minItems":1,"type":"array"},"slug":{"description":"Lower-case letters, digits and hyphens. Not accepted on a first request.","maxLength":255,"pattern":"^[a-z0-9-]+$","type":["string","null"]},"subheading":{"maxLength":255,"type":"string"},"website_url":{"description":"A full address, starting `https://` or `http://`.","maxLength":255,"type":"string"}},"type":"object"},"AgencyPageChangeRequestPageAnswer":{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"items":{"items":{"$ref":"#/components/schemas/AgencyPageChangeRequest"},"type":"array"}},"required":["items"],"type":"object"}]}},"required":["data"],"type":"object"},"AgencyPageFields":{"description":"The fields of an agency page, as the page and each of its change requests carry them.","properties":{"address":{"type":["string","null"]},"content":{"description":"The page's main text.","type":["string","null"]},"email_address":{"type":["string","null"]},"listing_description":{"description":"The short text shown beside your agency in the directory's list.","type":["string","null"]},"name":{"type":["string","null"]},"phone_number":{"type":["string","null"]},"services":{"description":"The services your agency offers, as names.","items":{"type":"string"},"type":"array"},"slug":{"description":"The last part of the page's address in the partner directory.","type":["string","null"]},"subheading":{"type":["string","null"]},"website_url":{"type":["string","null"]}},"required":["name","slug","listing_description","subheading","content","website_url","email_address","phone_number","address","services"],"type":"object"},"AgencyPageStateAnswer":{"properties":{"data":{"properties":{"change_request":{"description":"The request that is waiting for approval.","oneOf":[{"$ref":"#/components/schemas/AgencyPageChangeRequest"},{"type":"null"}]},"page":{"oneOf":[{"$ref":"#/components/schemas/AgencyPage"},{"type":"null"}]}},"required":["page","change_request"],"type":"object"}},"required":["data"],"type":"object"},"AgencyReferral":{"additionalProperties":false,"description":"A lead your agency referred to Corefinity.","properties":{"company_name":{"type":"string"},"contact_lead":{"description":"Whether Corefinity may contact the lead directly.","type":"boolean"},"created_at":{"format":"date-time","type":["string","null"]},"current_cost":{"description":"What the lead pays for hosting today.","type":["number","null"]},"current_provider":{"description":"Who hosts the lead today.","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"main_contact_email":{"type":["string","null"]},"main_contact_mobile":{"description":"The mobile number in international form, such as `+447700900123`.","type":["string","null"]},"main_contact_mobile_country":{"description":"The two-letter country code the number was read with.","type":["string","null"]},"main_contact_name":{"type":["string","null"]},"notes":{"description":"Your notes. When Corefinity may contact the lead and the contact's mobile or email is missing, a line saying so is added.","type":["string","null"]},"preferred_contact_method":{"enum":["email","phone",null],"type":["string","null"]},"website_url":{"description":"The lead's website, as it was typed. The scheme is optional.","type":"string"}},"required":["id","company_name","website_url","main_contact_name","main_contact_email","main_contact_mobile","main_contact_mobile_country","current_provider","current_cost","contact_lead","preferred_contact_method","notes","created_at"],"type":"object"},"AgencyReferralAnswer":{"properties":{"data":{"$ref":"#/components/schemas/AgencyReferral"}},"required":["data"],"type":"object"},"AgencyReferralPageAnswer":{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"items":{"items":{"$ref":"#/components/schemas/AgencyReferral"},"type":"array"}},"required":["items"],"type":"object"}]}},"required":["data"],"type":"object"},"AgencyReferralRequest":{"properties":{"company_name":{"maxLength":255,"type":"string"},"contact_lead":{"description":"Whether Corefinity may contact the lead directly. `false` when left out.","type":"boolean"},"current_cost":{"maximum":99999999,"minimum":0,"type":["number","null"]},"current_provider":{"maxLength":255,"type":["string","null"]},"main_contact_email":{"description":"An address whose domain can receive email; the domain is looked up, so the placeholder address in the example is refused `422` on this field.","maxLength":255,"type":["string","null"]},"main_contact_mobile":{"description":"A mobile number. It is checked against `main_contact_mobile_country` and saved in international form.","maxLength":32,"type":["string","null"]},"main_contact_mobile_country":{"description":"The two-letter country code of the mobile number, such as `GB`. A UK number needs none.","maxLength":2,"minLength":2,"type":["string","null"]},"main_contact_name":{"maxLength":255,"type":["string","null"]},"notes":{"maxLength":65535,"type":["string","null"]},"preferred_contact_method":{"enum":["email","phone",null],"type":["string","null"]},"website_url":{"description":"A host name, with or without `http://` or `https://`, and with a path if you like.","maxLength":255,"type":"string"}},"required":["company_name","website_url"],"type":"object"},"AppVersionAttentionList":{"properties":{"sites":{"items":{"additionalProperties":true,"properties":{"company":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"days_left":{"type":["integer","null"]},"display_version":{"type":["string","null"]},"domain":{"type":"string"},"edition":{"type":["string","null"]},"eol_stage":{"$ref":"#/components/schemas/AppVersionEolStage"},"line":{"type":["string","null"]},"platform":{"type":"string"},"security_until":{"type":["string","null"]},"site_id":{"minimum":1,"type":"integer"},"status":{"type":"string"}},"required":["site_id","domain","platform","display_version","status","eol_stage","company"],"type":"object"},"type":"array"}},"required":["sites"],"type":"object"},"AppVersionCatalogue":{"properties":{"catalogue_version":{"type":"string"},"platforms":{"items":{"$ref":"#/components/schemas/AppVersionPlatform"},"type":"array"}},"required":["catalogue_version","platforms"],"type":"object"},"AppVersionEolStage":{"description":"How close the line is to its end.","enum":["none","soon_90","soon_30","ended"],"type":"string"},"AppVersionLine":{"additionalProperties":true,"description":"One line of an application, such as WordPress 7.1, that a site can be created with.","properties":{"acknowledge":{"description":"What `acknowledge` must carry to create a site on this line, such as `eol`.","items":{"type":"string"},"type":"array"},"days_left":{"type":["integer","null"]},"default":{"type":"boolean"},"edition":{"type":["string","null"]},"empty":{"$ref":"#/components/schemas/Availability"},"eol_since":{"type":["string","null"]},"eol_stage":{"$ref":"#/components/schemas/AppVersionEolStage"},"fresh":{"$ref":"#/components/schemas/Availability"},"held_reason":{"type":["string","null"]},"installs":{"description":"The version a fresh install gets.","type":["string","null"]},"key":{"description":"The value to send as `app_version` when you create a site.","type":"string"},"label":{"type":"string"},"mariadb":{"description":"The MariaDB versions a site on this line can run.","properties":{"default":{"type":["string","null"]},"pending":{"description":"Versions that are on their way and cannot be chosen yet.","items":{},"type":"array"},"versions":{"items":{"type":"string"},"type":"array"}},"required":["versions","default"],"type":"object"},"notes":{"items":{},"type":"array"},"patches":{"description":"How many security patches a fresh install includes, and through which month.","type":["object","null"]},"php":{"description":"The PHP versions a site on this line can run.","properties":{"default":{"type":["string","null"]},"pending":{"description":"Versions that are on their way and cannot be chosen yet.","items":{},"type":"array"},"versions":{"items":{"type":"string"},"type":"array"}},"required":["versions","default"],"type":"object"},"search":{"description":"The search engine the line needs, when it needs one.","type":["object","null"]},"security_until":{"description":"The date security fixes end, when known.","type":["string","null"]},"services":{"type":["object","null"]},"status":{"description":"Such as `active`, `security` or `eol`.","type":"string"},"tag":{"description":"Such as `latest` or `recommended`.","type":["string","null"]}},"required":["key","edition","label","default","installs","status","eol_stage","fresh","empty"],"type":"object"},"AppVersionOfSite":{"additionalProperties":true,"description":"The line and version one site runs.","properties":{"built_for_only":{"type":"boolean"},"content":{"type":["string","null"]},"created_for":{"description":"The version the site was created with.","type":["string","null"]},"days_left":{"type":["integer","null"]},"detected":{"description":"The version last read from the site itself, with when and from where.","type":["object","null"]},"differs":{"type":"boolean"},"display_version":{"description":"The version the Control Panel shows.","type":["string","null"]},"edition":{"type":["string","null"]},"edition_label":{"type":["string","null"]},"eol_since":{"type":["string","null"]},"eol_stage":{"$ref":"#/components/schemas/AppVersionEolStage"},"installed_version":{"type":["string","null"]},"line":{"type":["string","null"]},"line_label":{"type":["string","null"]},"next":{"description":"The lines to move to when this one is ending.","items":{},"type":"array"},"next_line":{"type":["object","null"]},"platform":{"type":"string"},"recognition":{"description":"How the version was recognised, such as `line`.","type":"string"},"security_until":{"type":["string","null"]},"status":{"type":["string","null"]}},"required":["platform","edition","line","display_version","status","eol_stage","recognition","content","next"],"type":"object"},"AppVersionPlatform":{"additionalProperties":true,"properties":{"available":{"type":"boolean"},"default_version":{"type":["string","null"]},"editions":{"items":{"properties":{"available":{"type":"boolean"},"default":{"type":"boolean"},"default_version":{"type":["string","null"]},"edition":{"type":"string"},"label":{"type":"string"},"reason":{"description":"Why not, in plain words. Null when available.","type":["string","null"]}},"required":["edition","label"],"type":"object"},"type":"array"},"family":{"type":"string"},"label":{"type":"string"},"platform":{"type":"string"},"reason":{"description":"Why not, in plain words. Null when available.","type":["string","null"]},"versions":{"items":{"$ref":"#/components/schemas/AppVersionLine"},"type":"array"},"warning":{"type":["string","null"]}},"required":["platform","label","available","reason","editions","versions","default_version"],"type":"object"},"ApplyChoice":{"default":"now","description":"When a change that needs a maintenance window is applied. `now` applies it at once. `tonight` queues it for the\nsite's next window. `window` means the same as `tonight`. An endpoint that takes `window` only while\nmaintenance windows are on for your company says so, and refuses it `422` on `apply` otherwise.\n","enum":["now","tonight","window"],"type":"string"},"ApplyState":{"additionalProperties":true,"description":"Whether a saved set of rules is live on the site.","properties":{"applied_at":{"type":["string","null"]},"detail":{"description":"Sent only by the sets that have more to say, such as HTTP authentication."},"error":{"type":["string","null"]},"operation":{"description":"The change that is applying the set, while one is running.","oneOf":[{"$ref":"#/components/schemas/OperationSummary"},{"type":"null"}]},"state":{"description":"Such as `applied` or `applying`.","type":"string"},"state_label":{"type":"string"}},"required":["state","state_label","applied_at","operation","error"],"type":"object"},"AttachDomainCheck":{"properties":{"advice":{"oneOf":[{"$ref":"#/components/schemas/DomainAdvice"},{"type":"null"}]},"blockers":{"description":"What refuses the attach whatever DNS says, with the reason and message the attach would answer.","items":{"properties":{"message":{"type":"string"},"reason":{"type":"string"}},"required":["reason","message"],"type":"object"},"type":"array"},"canonical":{"type":"string"},"dns_plan":{"oneOf":[{"$ref":"#/components/schemas/DnsPlan"},{"type":"null"}]},"hosts":{"items":{"$ref":"#/components/schemas/DomainHostCheck"},"type":"array"},"ok":{"description":"True when every hostname is ready.","type":"boolean"},"platform_url":{"description":"The environment's own address on the platform.","type":["string","null"]},"primary_url":{"description":"The address the attach would produce.","type":"string"},"proxied_unconfirmed":{"description":"Each hostname behind Cloudflare that the check cannot look behind. Empty when there is none.","items":{"$ref":"#/components/schemas/AttachDomainProxiedHost"},"type":"array"},"ran_at":{"format":"date-time","type":"string"},"role":{"description":"The environment's role, such as `production` or `staging`.","type":"string"},"www":{"enum":["www","bare"],"type":"string"}},"required":["hosts","ok","canonical","www","dns_plan","advice","ran_at","proxied_unconfirmed","role","platform_url","primary_url","blockers"],"type":"object"},"AttachDomainCheckRequest":{"properties":{"canonical":{"description":"The hostname the site answers on. One of `hosts`.","type":"string"},"default_store":{"anyOf":[{"$ref":"#/components/schemas/MagentoStoreChoice"},{"type":"null"}],"description":"The Magento store shown on the primary; omitted or null uses Magento's default."},"hosts":{"description":"Every hostname to attach, each once. On production they must include the site's domain or its `www` form;\non another environment they must not.\n","items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"serve":{"additionalProperties":{"enum":["redirect","storefront"],"type":"string"},"description":"For each extra domain on Shopware or Magento 2, redirect or storefront. Each Magento storefront needs an entry in stores.","type":"object"},"stores":{"$ref":"#/components/schemas/DomainMagentoAttachStores"},"www":{"description":"Must match `canonical`. Left out, it follows `canonical`.","enum":["www","bare"],"type":"string"}},"required":["hosts","canonical"],"type":"object"},"AttachDomainProxiedHost":{"properties":{"challenge_path":{"description":"Whether the certificate check gets through Cloudflare. `note` says what to change when it does not. `ok`\nis null when the check could not tell.\n","properties":{"code":{"type":"string"},"note":{"type":["string","null"]},"ok":{"type":["boolean","null"]},"status":{"type":["integer","null"]}},"type":"object"},"confirmable":{"description":"True when the certificate check gets through and the TXT record is found.","type":"boolean"},"host":{"type":"string"},"verification":{"description":"The TXT record that proves the hostname is yours.","properties":{"found":{"type":"boolean"},"name":{"type":"string"},"state":{"type":"string"},"value":{"type":["string","null"]}},"type":"object"}},"required":["host","confirmable","challenge_path","verification"],"type":"object"},"AttachDomainRequest":{"properties":{"canonical":{"type":"string"},"confirm_domain":{"description":"On production, the site's domain. On another environment, the `canonical` you are attaching. Typed exactly.","type":"string"},"confirm_replacements":{"default":false,"description":"True to let `point_dns` replace DNS records that already exist.","type":"boolean"},"default_store":{"anyOf":[{"$ref":"#/components/schemas/MagentoStoreChoice"},{"type":"null"}],"description":"The Magento store shown on the primary; omitted or null uses Magento's default."},"hosts":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"pending_dns":{"default":false,"description":"True to attach before DNS points at the platform. Each hostname that does not point here yet needs the TXT\nrecord that proves it is yours; the refusal names the record and its value.\n","type":"boolean"},"point_dns":{"default":false,"description":"True to point DNS through your connected Cloudflare account. Cannot be sent with `pending_dns`.","type":"boolean"},"proxied_records_checked":{"default":false,"description":"True once you have checked in Cloudflare that the record of each hostname in the check's\n`proxied_unconfirmed` points at its `expected_ip`.\n","type":"boolean"},"serve":{"additionalProperties":{"enum":["redirect","storefront"],"type":"string"},"description":"For each extra domain on Shopware or Magento 2, redirect or storefront. Each Magento storefront needs an entry in stores.","type":"object"},"stores":{"$ref":"#/components/schemas/DomainMagentoAttachStores"},"www":{"enum":["www","bare"],"type":"string"}},"required":["hosts","canonical","confirm_domain"],"type":"object"},"AttentionAcknowledged":{"properties":{"acknowledged":{"$ref":"#/components/schemas/AttentionAcknowledgement"},"overview_patch":{"$ref":"#/components/schemas/AttentionOverviewPatch"}},"required":["acknowledged","overview_patch"],"type":"object"},"AttentionAcknowledgement":{"properties":{"at":{"format":"date-time","type":"string"},"by":{"description":"Who acknowledged the item. Null when that person's account no longer exists.","oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"since_at":{"description":"Since when the item had been open when it was acknowledged.","format":"date-time","type":["string","null"]}},"required":["by","at","since_at"],"type":"object"},"AttentionItem":{"additionalProperties":true,"properties":{"acknowledgeable":{"type":"boolean"},"acknowledged":{"oneOf":[{"$ref":"#/components/schemas/AttentionAcknowledgement"},{"type":"null"}]},"action":{"type":["object","null"]},"cluster":{"oneOf":[{"$ref":"#/components/schemas/ClusterRef"},{"type":"null"}]},"detail":{"type":["string","null"]},"environment":{"oneOf":[{"$ref":"#/components/schemas/EnvironmentRef"},{"type":"null"}]},"href":{"description":"A path in the Control Panel.","type":["string","null"]},"id":{"description":"The stable item id, such as `site_down:1051`.","type":"string"},"kind":{"type":"string"},"scope":{"type":["string","null"]},"severity":{"type":"string"},"since":{"format":"date-time","type":["string","null"]},"site":{"oneOf":[{"$ref":"#/components/schemas/SiteRef"},{"type":"null"}]},"subject":{"type":["object","null"]},"title":{"type":"string"}},"required":["id","severity","kind","title","acknowledgeable","acknowledged"],"type":"object"},"AttentionList":{"additionalProperties":true,"properties":{"attention":{"items":{"$ref":"#/components/schemas/AttentionItem"},"type":"array"},"attention_acknowledged":{"items":{"$ref":"#/components/schemas/AttentionItem"},"type":"array"},"attention_acknowledged_total":{"type":"integer"},"attention_total":{"type":"integer"},"generated_at":{"format":"date-time","type":"string"}},"required":["attention","attention_total","attention_acknowledged","attention_acknowledged_total","generated_at"],"type":"object"},"AttentionOverviewPatch":{"allOf":[{"$ref":"#/components/schemas/AttentionList"},{"properties":{"sites_attention":{"additionalProperties":{"type":"integer"},"description":"How many items need attention for each site, keyed by site row id.","type":"object"}},"required":["sites_attention"],"type":"object"}],"description":"The parts of the overview an acknowledgement changed."},"AttentionUnacknowledged":{"properties":{"overview_patch":{"$ref":"#/components/schemas/AttentionOverviewPatch"}},"required":["overview_patch"],"type":"object"},"AutoUpgradePurchase":{"description":"One automatic upgrade made this month.","properties":{"at":{"format":"date-time","type":["string","null"]},"cluster_id":{"minimum":1,"type":["integer","null"]},"kind":{"description":"What was bought, such as `cluster_addons`, `cluster_package` or `target_disk`.","type":"string"},"monthly_delta":{"$ref":"#/components/schemas/Money"},"operation_id":{"description":"The operation that made the upgrade, to follow with `GET /corestack/operations/{operation}`.","minimum":1,"type":["integer","null"]},"state":{"description":"`pending` while the upgrade is being made, `bought` once it is.","enum":["pending","bought"],"type":"string"},"summary":{"description":"What was bought, in a sentence.","type":"string"}},"required":["at","kind","summary","monthly_delta","cluster_id","operation_id","state"],"type":"object"},"AutoUpgrades":{"properties":{"active":{"description":"Whether they are on and can buy now.","type":"boolean"},"available":{"description":"Whether automatic upgrades can be turned on now.","type":"boolean"},"can_change":{"description":"Whether you may turn them on or raise the limit.","type":"boolean"},"can_turn_off":{"description":"Whether you may turn them off.","type":"boolean"},"company_id":{"minimum":1,"type":"integer"},"consented_at":{"description":"When they were turned on, or the limit last raised. `null` while they are off.","format":"date-time","type":["string","null"]},"currency":{"description":"The company's billing currency.","type":"string"},"enabled":{"description":"Whether they are on.","type":"boolean"},"max_monthly_limit":{"$ref":"#/components/schemas/Money","description":"The highest limit that can be set now."},"max_purchases_per_month":{"description":"The most automatic upgrades that can be made in a month.","type":"integer"},"month":{"description":"The calendar month (UTC) the limit counts in, as `YYYY-MM`.","type":"string"},"monthly_limit":{"description":"The limit on what new upgrades may add each month. `null` until a limit is set.","oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"purchases_this_month":{"description":"How many automatic upgrades were made this month.","type":"integer"},"recent":{"description":"This month's automatic upgrades, newest first, 20 at most.","items":{"$ref":"#/components/schemas/AutoUpgradePurchase"},"type":"array"},"remaining_this_month":{"description":"What is left of the limit this month. `null` while they cannot buy.","oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"spent_this_month":{"$ref":"#/components/schemas/Money","description":"What this month's new upgrades have added."},"unavailable_reason":{"description":"Why they cannot be turned on, in a sentence. `null` when they can.","type":["string","null"]}},"required":["company_id","available","unavailable_reason","enabled","active","monthly_limit","spent_this_month","remaining_this_month","max_monthly_limit","purchases_this_month","max_purchases_per_month","month","currency","consented_at","can_change","can_turn_off","recent"],"type":"object"},"AutoUpgradesRequest":{"additionalProperties":false,"properties":{"confirm_spend":{"description":"Needed to turn automatic upgrades on or to raise the limit. `true` says the person agreed to this: \"I\nagree that automatic upgrades may be bought and added to our monthly bill without asking each time:\nCoreCluster add-ons (more cores, RAM or disk) or the next package when a new site or environment would\nnot fit, and a larger size for a non-production environment that is too small for a copy into it. Each\nupgrade stays on the monthly bill until it is changed back. The limit caps what new automatic upgrades\ncan add to the bill in one calendar month (UTC), and it starts again on the 1st. A new site or\nenvironment created by anyone who can create them in our CoreClusters, including Corefinity staff\nworking for us, can lead to an upgrade.\"\n","type":"boolean"},"enabled":{"description":"Whether automatic upgrades are on.","type":"boolean"},"monthly_limit":{"anyOf":[{"minimum":1,"type":"number"},{"pattern":"^\\d{1,8}(\\.\\d{1,2})?$","type":"string"}],"description":"The most that new automatic upgrades may add to the bill in one calendar month (UTC), in the company's\nbilling currency: from 1 up to the setting's `max_monthly_limit`, two decimal places at most, as a number\nor as text. Needed when `enabled` is `true`.\n"}},"required":["enabled"],"type":"object"},"Availability":{"additionalProperties":true,"description":"Whether something can be done now and, when it cannot, why not.","properties":{"available":{"type":"boolean"},"reason":{"type":["string","null"]}},"required":["available","reason"],"type":"object"},"BillingAccount":{"properties":{"address":{"oneOf":[{"properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"type":["string","null"]},"postcode":{"type":"string"}},"required":["line1","line2","city","postcode","country"],"type":"object"},{"type":"null"}]},"auto_charge":{"description":"Whether invoices are collected automatically.","type":"boolean"},"backup_method":{"oneOf":[{"$ref":"#/components/schemas/BillingPaymentMethod"},{"type":"null"}]},"balance":{"$ref":"#/components/schemas/BillingBalance"},"billing_contacts":{"description":"With `with=details`, the company's owners and then its billing contacts. Otherwise `null`.","oneOf":[{"items":{"properties":{"email":{"type":"string"},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"role":{"enum":["owner","billing"],"type":"string"}},"required":["id","name","email","role"],"type":"object"},"type":"array"},{"type":"null"}]},"billing_email":{"type":["string","null"]},"billing_name":{"type":["string","null"]},"company":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"contracts":{"items":{"$ref":"#/components/schemas/BillingContractLine"},"type":"array"},"countries":{"description":"With `with=details`, the countries the billing address may be in. Otherwise `null`.","oneOf":[{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["code","name"],"type":"object"},"type":"array"},{"type":"null"}]},"currency":{"type":"string"},"currency_locked":{"description":"Whether the currency is fixed. It is, from the account's first invoice.","type":"boolean"},"default_method":{"description":"The card that is charged first, or `null`.","oneOf":[{"$ref":"#/components/schemas/BillingPaymentMethod"},{"type":"null"}]},"demos":{"description":"The demos billed to this account. A demo bills nothing until it is kept.","items":{"properties":{"ends_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"kept_at":{"format":"date-time","type":["string","null"]},"state":{"type":"string"}},"required":["id","state","ends_at","kept_at"],"type":"object"},"type":"array"},"id":{"minimum":1,"type":"integer"},"is_default":{"type":"boolean"},"mandate":{"oneOf":[{"$ref":"#/components/schemas/BillingMandate"},{"type":"null"}]},"monthly_total":{"$ref":"#/components/schemas/Money","description":"What every open contract line costs a month in all."},"name":{"type":"string"},"next_invoice":{"description":"The next invoice, or `null` when none is due.","oneOf":[{"properties":{"estimate":{"$ref":"#/components/schemas/Money"},"issues_at":{"format":"date-time","type":"string"},"period_end":{"format":"date-time","type":"string"},"trial":{"description":"Whether the account is in its free trial.","type":"boolean"}},"required":["period_end","issues_at","estimate","trial"],"type":"object"},{"type":"null"}]},"po_reference":{"description":"The purchase order reference written on invoices.","type":["string","null"]},"rights":{"$ref":"#/components/schemas/BillingRights"},"trial":{"description":"The account's free trial, or `null`.","oneOf":[{"properties":{"days_left":{"type":"integer"},"ends_at":{"format":"date-time","type":"string"}},"required":["ends_at","days_left"],"type":"object"},{"type":"null"}]},"vat":{"$ref":"#/components/schemas/BillingVat"},"vat_number":{"type":["string","null"]},"version":{"description":"The version of the billing details. Send it back when you save the VAT number.","type":"integer"}},"required":["id","company","name","is_default","currency","currency_locked","billing_name","billing_email","address","vat_number","vat","po_reference","billing_contacts","countries","balance","default_method","backup_method","mandate","auto_charge","trial","contracts","demos","monthly_total","next_invoice","rights","version"],"type":"object"},"BillingActivity":{"description":"One line of the latest billing activity. `usage_mtd` is a contract's running figure for this month (`product`,\n`contract_id`, `through`); every other kind is something that happened (`at`, `description`, `invoice`). Not\nthe shared `ActivityItem`, which is a change made to a site or a CoreCluster.\n","properties":{"amount":{"$ref":"#/components/schemas/Money"},"at":{"format":"date-time","type":"string"},"contract_id":{"minimum":1,"type":"integer"},"currency":{"type":"string"},"description":{"type":"string"},"invoice":{"oneOf":[{"$ref":"#/components/schemas/BillingInvoiceRef"},{"type":"null"}]},"kind":{"enum":["usage_mtd","invoice","payment","refund","credit_applied","credit_grant","adjustment"],"type":"string"},"product":{"type":"string"},"through":{"description":"The last hour the running figure counts.","format":"date-time","type":["string","null"]}},"required":["kind","amount"],"type":"object"},"BillingBalance":{"properties":{"accrued_this_period":{"$ref":"#/components/schemas/Money","description":"What has accrued this month so far."},"balance":{"$ref":"#/components/schemas/Money","description":"What has accrued and is not invoiced yet, plus what is outstanding on open invoices."},"credits_available":{"$ref":"#/components/schemas/Money"},"currency":{"type":"string"},"last_accrual_at":{"description":"The last hour that was accrued.","format":"date-time","type":["string","null"]},"lines":{"items":{"$ref":"#/components/schemas/BillingBalanceLine"},"type":"array"},"next_invoice_at":{"format":"date-time","type":"string"},"outstanding":{"$ref":"#/components/schemas/Money","description":"What is due on open invoices."},"period":{"$ref":"#/components/schemas/BillingPeriod","description":"This month (UTC)."},"recent_activity":{"items":{"$ref":"#/components/schemas/BillingActivity"},"type":"array"}},"required":["currency","balance","accrued_this_period","outstanding","period","credits_available","lines","last_accrual_at","next_invoice_at","recent_activity"],"type":"object"},"BillingBalanceLine":{"properties":{"accrued":{"$ref":"#/components/schemas/Money","description":"What the line has accrued this month."},"contract_line":{"$ref":"#/components/schemas/BillingContractLineRef"},"hourly":{"$ref":"#/components/schemas/Money","description":"The line's price for one hour, with six decimal places."},"hours":{"type":"integer"},"monthly":{"$ref":"#/components/schemas/Money"}},"required":["contract_line","accrued","hours","hourly","monthly"],"type":"object"},"BillingCatalogue":{"properties":{"addons":{"items":{"properties":{"key":{"type":"string"},"label":{"type":"string"},"max":{"type":"integer"},"monthly":{"$ref":"#/components/schemas/Money","description":"The monthly price of one unit on Standard servers."},"step":{"type":"integer"},"unit":{"type":"string"},"unit_prices":{"additionalProperties":{"additionalProperties":{"type":"string"},"type":"object"},"description":"The monthly price of one unit with six decimal places, by product line and then by server type\n(`general` is Standard, `optimised` is Performance). A line's price is the unit price times the\nquantity, rounded half to even to pennies.\n","type":"object"}},"required":["key","label","unit","monthly","max","step","unit_prices"],"type":"object"},"type":"array"},"compute_optimised":{"description":"Whether Performance servers are offered in the region.","properties":{"available":{"type":"boolean"},"label":{"type":"string"},"product_lines":{"additionalProperties":{"$ref":"#/components/schemas/Availability"},"description":"The same answer for each product line, by its key.","type":"object"},"reason":{"type":["string","null"]}},"required":["available","label","reason","product_lines"],"type":"object"},"currency":{"type":"string"},"hidden":{"description":"With `platform`, the packages that cannot run it, each with why.","items":{"properties":{"code":{"type":"string"},"copy":{"description":"Why, in a sentence.","type":"string"},"reason":{"type":"string"}},"required":["code","reason","copy"],"type":"object"},"type":"array"},"modifiers":{"description":"What changes a price, as a percentage, such as the Performance server type or a region.","items":{"properties":{"applies_to":{"items":{"type":"string"},"type":"array"},"key":{"type":"string"},"label":{"type":"string"},"scope":{"type":"string"},"value_percent":{"type":"string"}},"required":["key","label","scope","value_percent","applies_to"],"type":"object"},"type":"array"},"packages":{"items":{"$ref":"#/components/schemas/BillingCataloguePackage"},"type":"array"},"platform":{"type":["string","null"]},"region":{"type":"string"},"uat_sizes":{"description":"The staging environment sizes.","items":{"properties":{"cores":{"type":"number"},"disk_gb":{"type":"number"},"key":{"type":"string"},"label":{"type":"string"},"memory_gib":{"type":"number"},"monthly":{"$ref":"#/components/schemas/Money"}},"required":["key","label","monthly","cores","memory_gib","disk_gb"],"type":"object"},"type":"array"},"vat":{"description":"The VAT that applies to the billing account. Prices exclude it. All three are `null` when you may not\nread the account: you are not the company's owner, a billing contact or its primary user, or `account`\nnames an account that is not your company's.\n","properties":{"country":{"description":"The country VAT is judged for, as a two-letter code.","type":["string","null"]},"kind":{"description":"How VAT applies, such as `standard`, `reverse_charge` or `outside_scope`.","type":["string","null"]},"rate_percent":{"type":["number","null"]}},"required":["country","kind","rate_percent"],"type":"object"}},"required":["currency","region","platform","packages","hidden","compute_optimised","addons","uat_sizes","modifiers","vat"],"type":"object"},"BillingCataloguePackage":{"properties":{"code":{"description":"The package's code, such as `CC8`.","type":"string"},"cores":{"type":"number"},"disk_gb":{"type":"number"},"included_uat":{"description":"The staging environments a CoreStack package includes at no charge, or `null` when it includes none.","properties":{"count":{"description":"How many are included.","type":"integer"},"size":{"description":"The size of the included staging environment, as the catalogue's staging sizes name it.","type":"string"},"steps_up_from":{"description":"With `platform=shopware`, the size the package includes for other platforms, when Shopware gets a larger one.","type":"string"}},"required":["size","count"],"type":["object","null"]},"key":{"description":"The same code in lower case, as the package and upgrade routes name it.","type":"string"},"log_quota_gb":{"type":["number","null"]},"log_retention_days":{"type":["integer","null"]},"memory_gib":{"type":"number"},"money_back_days":{"description":"The package's money-back guarantee, in days. `0` when it has none.","type":"integer"},"monthly":{"$ref":"#/components/schemas/Money","description":"The monthly price on Standard servers."},"monthly_optimised":{"description":"The monthly price on Performance servers, or `null` where they are not offered.","oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"name":{"type":"string"},"platforms_allowed":{"description":"The platforms the package can run. `null` when it runs every one.","oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"product_line":{"enum":["cs","cc"],"type":"string"},"tiers":{"description":"The site sizes a CoreCluster package takes. `null` for a CoreStack package.","oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"trial_days":{"description":"The package's free trial, in days. `0` when it has none.","type":"integer"}},"required":["code","key","product_line","name","monthly","monthly_optimised","cores","memory_gib","disk_gb","trial_days","money_back_days"],"type":"object"},"BillingContractLine":{"description":"One line the account is billed for.","properties":{"contract":{"properties":{"billing_model":{"description":"`metered`: billed by the hour.","type":"string"},"billing_period":{"enum":["monthly","annual"],"type":"string"},"billing_starts":{"description":"`on_delivery` while the site or CoreCluster is still being created: nothing is billed and the free trial has not started.","enum":["started","on_delivery"],"type":"string"},"billing_starts_at":{"description":"The first hour the contract bills from. `null` while `on_delivery`, and for an older contract, whose `starts_on` is its first day.","format":"date-time","type":["string","null"]},"billing_starts_note":{"description":"While `on_delivery`, the sentence the Control Panel shows. Otherwise `null`.","type":["string","null"]},"first_billed_at":{"description":"The first hour the contract was charged for.","format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"money_back":{"description":"The money-back guarantee the contract was opened with, or `null` when it has none.","oneOf":[{"properties":{"days":{"type":"integer"},"state":{"description":"`available` until `until` has passed, then `expired`; `claimed` while a claim on the\nguarantee is open and `refunded` once it has been paid back.\n","enum":["available","expired","claimed","refunded"],"type":"string"},"until":{"format":"date-time","type":["string","null"]}},"required":["days","until","state"],"type":"object"},{"type":"null"}]},"reference":{"type":"string"},"starts_on":{"format":"date","type":["string","null"]},"status":{"enum":["draft","active","expired","cancelled"],"type":"string"},"trial_ends_at":{"format":"date-time","type":["string","null"]}},"required":["id","reference","billing_model","status","starts_on","trial_ends_at","billing_period","first_billed_at","money_back","billing_starts","billing_starts_at","billing_starts_note"],"type":"object"},"hourly":{"$ref":"#/components/schemas/Money","description":"The price for one hour, with six decimal places."},"id":{"minimum":1,"type":"integer"},"kind":{"enum":["package","addon","uat"],"type":"string"},"label":{"type":"string"},"modifiers":{"description":"What changes the line's price, such as the Performance server type or the region.","items":{"properties":{"key":{"type":"string"},"label":{"type":"string"},"value_percent":{"type":"string"}},"required":["key","label","value_percent"],"type":"object"},"type":"array"},"monthly":{"$ref":"#/components/schemas/Money"},"product":{"properties":{"line":{"description":"`cs` CoreStack, `cc` CoreCluster, `cse` CoreStack Enterprise.","enum":["cs","cc","cse"],"type":"string"},"region":{"type":["string","null"]},"server_type":{"enum":["Standard","Performance"],"type":"string"}},"required":["line","region","server_type"],"type":"object"},"quantity":{"type":"integer"},"since":{"format":"date-time","type":["string","null"]},"subject":{"description":"What the line is for.","properties":{"href":{"description":"Its page in the Control Panel, as a path.","type":"string"},"ref":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":{"enum":["site","cluster"],"type":"string"}},"required":["type","ref","href"],"type":"object"},"unit":{"description":"What one of `quantity` is, for an add-on (`core` or `GB`).","type":["string","null"]},"until":{"description":"When the line ends, for one that a change has replaced. `null` while it runs on.","format":"date-time","type":["string","null"]}},"required":["id","kind","label","contract","subject","quantity","unit","monthly","hourly","modifiers","since","until","product"],"type":"object"},"BillingContractLineRef":{"description":"A line of a contract, by name.","properties":{"id":{"minimum":1,"type":"integer"},"kind":{"description":"`package`, an `addon` (extra cores, memory, disk, log storage, a dedicated IP address) or `uat`, a staging environment.","enum":["package","addon","uat"],"type":"string"},"label":{"type":"string"}},"required":["id","kind","label"],"type":"object"},"BillingCredit":{"properties":{"amount":{"$ref":"#/components/schemas/Money"},"applications":{"description":"The invoices the credit was applied to.","items":{"properties":{"amount":{"$ref":"#/components/schemas/Money"},"at":{"format":"date-time","type":["string","null"]},"invoice":{"$ref":"#/components/schemas/BillingInvoiceRef"}},"required":["invoice","amount","at"],"type":"object"},"type":"array"},"expires_at":{"format":"date-time","type":["string","null"]},"granted_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"public_note":{"description":"What the credit is for.","type":"string"},"remaining":{"$ref":"#/components/schemas/Money"},"state":{"enum":["available","applied","expired","void"],"type":"string"}},"required":["id","amount","remaining","public_note","granted_at","expires_at","state","applications"],"type":"object"},"BillingInvoice":{"properties":{"account":{"properties":{"company":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"id":{"minimum":1,"type":"integer"}},"required":["id","company"],"type":"object"},"amount_due":{"$ref":"#/components/schemas/Money"},"credit_notes":{"items":{"properties":{"amount":{"$ref":"#/components/schemas/Money"},"kind":{"description":"What the credit note is for, such as `applied_credit` or `refund`.","type":"string"},"number":{"description":"The credit note's number, as `GET /corestack/billing/invoices/{invoice}/credit-notes/{number}/pdf` takes it.","type":"string"},"pdf_href":{"description":"The credit note's PDF for a browser that is signed in to the Control Panel, as a path; `null` until\nthe PDF exists. With a token, download it from\n`GET /corestack/billing/invoices/{invoice}/credit-notes/{number}/pdf`.\n","type":["string","null"]}},"required":["number","kind","amount","pdf_href"],"type":"object"},"type":"array"},"credit_tax_amount":{"$ref":"#/components/schemas/Money","description":"The VAT on the credits applied."},"credits":{"description":"The credits applied to the invoice.","items":{"properties":{"amount":{"$ref":"#/components/schemas/Money"},"credit":{"properties":{"id":{"minimum":1,"type":"integer"},"public_note":{"type":"string"}},"required":["id","public_note"],"type":"object"}},"required":["credit","amount"],"type":"object"},"type":"array"},"credits_applied":{"$ref":"#/components/schemas/Money"},"currency":{"type":"string"},"due_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"issued_at":{"format":"date-time","type":["string","null"]},"lines":{"description":"The invoice's lines. In a list they are filled only with `with=lines`.","items":{"properties":{"amount":{"$ref":"#/components/schemas/Money"},"contract_line":{"oneOf":[{"$ref":"#/components/schemas/BillingContractLineRef"},{"type":"null"}]},"description":{"type":"string"},"id":{"minimum":1,"type":"integer"},"period":{"oneOf":[{"$ref":"#/components/schemas/BillingPeriod"},{"type":"null"}]},"quantity":{"description":"The quantity, a number as text.","type":"string"},"unit":{"type":["string","null"]},"unit_price":{"$ref":"#/components/schemas/Money","description":"The price of one unit, with six decimal places."}},"required":["id","contract_line","description","quantity","unit","unit_price","amount","period"],"type":"object"},"type":"array"},"next_collection_at":{"description":"When the next automatic collection is booked, for an invoice that is `open` or `unpaid`. `null` when none is.","format":"date-time","type":["string","null"]},"number":{"type":"string"},"paid_at":{"format":"date-time","type":["string","null"]},"payment_terms_days":{"type":"integer"},"payments":{"items":{"properties":{"attempt":{"$ref":"#/components/schemas/BillingPaymentAttempt"}},"required":["attempt"],"type":"object"},"type":"array"},"pdf":{"properties":{"available":{"description":"Whether the invoice's PDF can be downloaded.","type":"boolean"}},"required":["available"],"type":"object"},"period":{"oneOf":[{"$ref":"#/components/schemas/BillingPeriod"},{"type":"null"}]},"status":{"enum":["open","collecting","paid","unpaid","void","refunded","written_off"],"type":"string"},"status_label":{"description":"The status as the Control Panel writes it.","type":"string"},"subtotal":{"$ref":"#/components/schemas/Money"},"tax":{"properties":{"amount":{"$ref":"#/components/schemas/Money"},"kind":{"enum":["standard","reverse_charge","zero","outside_scope"],"type":"string"},"note":{"description":"The basis in a sentence, when VAT is not charged at the standard rate.","type":["string","null"]},"rate_percent":{"type":"number"}},"required":["kind","rate_percent","amount","note"],"type":"object"},"total":{"$ref":"#/components/schemas/Money"}},"required":["id","number","status","status_label","period","issued_at","due_at","paid_at","next_collection_at","payment_terms_days","currency","subtotal","tax","total","credits_applied","credit_tax_amount","amount_due","lines","credits","payments","credit_notes","pdf","account"],"type":"object"},"BillingInvoicePage":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"items":{"items":{"$ref":"#/components/schemas/BillingInvoice"},"type":"array"},"total":{"description":"How many invoices the filters choose, whatever the page.","type":"integer"}},"required":["items","total"],"type":"object"}]},"BillingInvoicePdfLink":{"properties":{"download_url":{"description":"The same link on this API, as a path. `GET` it with the access token that asked for it.","type":"string"},"expires_at":{"format":"date-time","type":"string"},"url":{"description":"The link for a browser that is signed in to the Control Panel, as a path.","type":"string"}},"required":["url","expires_at","download_url"],"type":"object"},"BillingInvoiceRef":{"properties":{"id":{"minimum":1,"type":"integer"},"number":{"type":"string"}},"required":["id","number"],"type":"object"},"BillingLedgerEntry":{"properties":{"amount":{"$ref":"#/components/schemas/Money","description":"The entry's amount, with six decimal places."},"contract_line":{"oneOf":[{"$ref":"#/components/schemas/BillingContractLineRef"},{"type":"null"}]},"credit":{"oneOf":[{"properties":{"id":{"minimum":1,"type":"integer"}},"required":["id"],"type":"object"},{"type":"null"}]},"description":{"type":"string"},"id":{"minimum":1,"type":"integer"},"invoice":{"oneOf":[{"$ref":"#/components/schemas/BillingInvoiceRef"},{"type":"null"}]},"occurred_at":{"format":"date-time","type":["string","null"]},"period":{"oneOf":[{"$ref":"#/components/schemas/BillingPeriod"},{"type":"null"}]},"type":{"enum":["accrual","credit_applied","invoice","payment","refund","adjustment","write_off"],"type":"string"}},"required":["id","type","amount","occurred_at","period","contract_line","invoice","credit","description"],"type":"object"},"BillingLedgerPage":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"items":{"items":{"$ref":"#/components/schemas/BillingLedgerEntry"},"type":"array"}},"required":["items"],"type":"object"}]},"BillingMandate":{"description":"A Direct Debit mandate.","properties":{"bank_name":{"type":["string","null"]},"created_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"last4":{"description":"The last digits of the bank account.","type":["string","null"]},"next_possible_charge_date":{"format":"date","type":["string","null"]},"provider":{"type":"string"},"reference":{"type":"string"},"scheme":{"description":"The Direct Debit scheme, such as `bacs`.","type":"string"},"state":{"type":"string"}},"required":["id","provider","scheme","state","bank_name","last4","reference","next_possible_charge_date","created_at"],"type":"object"},"BillingPaymentAttempt":{"description":"One attempt to collect an invoice.","properties":{"action_url":{"description":"With `action_required`, where the cardholder confirms the payment.","type":["string","null"]},"amount":{"$ref":"#/components/schemas/Money"},"attempt_no":{"type":"integer"},"failure":{"oneOf":[{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},{"type":"null"}]},"id":{"minimum":1,"type":"integer"},"mandate":{"oneOf":[{"$ref":"#/components/schemas/BillingMandate"},{"type":"null"}]},"method":{"oneOf":[{"$ref":"#/components/schemas/BillingPaymentMethod"},{"type":"null"}]},"provider":{"description":"How the payment was made. `bank_transfer` is a transfer Corefinity recorded.","type":"string"},"refunded":{"description":"What was refunded of it, or `null`.","oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"scheduled_for":{"format":"date-time","type":["string","null"]},"settled_at":{"format":"date-time","type":["string","null"]},"started_at":{"format":"date-time","type":["string","null"]},"state":{"enum":["pending","action_required","collecting","succeeded","failed","cancelled","refunded","partially_refunded","reversed"],"type":"string"}},"required":["id","provider","state","amount","refunded","method","mandate","attempt_no","scheduled_for","started_at","settled_at","failure"],"type":"object"},"BillingPaymentMethod":{"description":"A card on the account.","properties":{"added_at":{"format":"date-time","type":["string","null"]},"brand":{"type":"string"},"exp_month":{"type":["integer","null"]},"exp_year":{"type":["integer","null"]},"id":{"minimum":1,"type":"integer"},"kind":{"enum":["card","wallet","link"],"type":"string"},"label":{"type":["string","null"]},"last4":{"description":"The last four digits. Empty when there are none.","type":"string"},"provider":{"description":"The payment provider that holds the card.","type":"string"},"role":{"description":"`primary` is charged first, `backup` when the primary fails.","enum":["primary","backup",null],"type":["string","null"]},"state":{"enum":["active","expiring","expired","detached"],"type":"string"},"wallet":{"enum":["apple_pay","google_pay",null],"type":["string","null"]}},"required":["id","provider","kind","role","brand","last4","exp_month","exp_year","wallet","label","state","added_at"],"type":"object"},"BillingPaymentMethods":{"properties":{"cards":{"properties":{"can_add":{"type":"boolean"},"max":{"description":"The most cards an account can hold.","type":"integer"}},"required":["max","can_add"],"type":"object"},"default":{"description":"What is charged first.","enum":["card","mandate",null],"type":["string","null"]},"mandate":{"oneOf":[{"$ref":"#/components/schemas/BillingMandate"},{"type":"null"}]},"methods":{"items":{"allOf":[{"$ref":"#/components/schemas/BillingPaymentMethod"},{"properties":{"blocked":{"description":"Why each change to the card would be refused in the Control Panel now, or `null` when it\nwould be taken: making it the primary card, making it the backup, and removing it.\n","properties":{"backup":{"type":["string","null"]},"primary":{"type":["string","null"]},"remove":{"type":["string","null"]}},"required":["primary","backup","remove"],"type":"object"}},"required":["blocked"],"type":"object"}]},"type":"array"},"rights":{"$ref":"#/components/schemas/BillingRights"}},"required":["methods","mandate","default","rights","cards"],"type":"object"},"BillingPeriod":{"properties":{"end":{"format":"date-time","type":["string","null"]},"start":{"format":"date-time","type":"string"}},"required":["start","end"],"type":"object"},"BillingQuote":{"properties":{"applies":{"description":"`none` when the changes alter nothing.","enum":["now","none"],"type":"string"},"currency":{"type":"string"},"effective_from":{"description":"The hour the new price would start from.","format":"date-time","type":"string"},"expires_at":{"description":"Until when the quote's `id` is taken as `quote_id`.","format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"lines":{"items":{"properties":{"after":{"$ref":"#/components/schemas/Money"},"before":{"description":"The monthly price now, or `null` for something new.","oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"delta":{"$ref":"#/components/schemas/Money"},"key":{"description":"What the line is, such as `package`, `addons` or `uat`.","type":"string"},"label":{"type":"string"}},"required":["key","label","before","after","delta"],"type":"object"},"type":"array"},"monthly_after":{"$ref":"#/components/schemas/Money"},"monthly_before":{"$ref":"#/components/schemas/Money"},"monthly_delta":{"$ref":"#/components/schemas/Money"},"prorata":{"description":"What the change adds for the rest of this month, from the hour it would start.","properties":{"amount":{"$ref":"#/components/schemas/Money"},"from":{"format":"date-time","type":"string"},"hours":{"type":"integer"},"to":{"format":"date-time","type":"string"}},"required":["from","to","hours","amount"],"type":"object"},"tax":{"description":"The VAT on the monthly difference.","properties":{"amount":{"$ref":"#/components/schemas/Money"},"kind":{"type":"string"},"note":{"type":["string","null"]},"rate_percent":{"type":"number"}},"required":["kind","rate_percent","note","amount"],"type":"object"},"trial":{"description":"While the contract is in its free trial, when the trial ends and what is charged now. Otherwise `null`.","oneOf":[{"properties":{"charged_now":{"$ref":"#/components/schemas/Money"},"ends_at":{"format":"date-time","type":"string"}},"required":["ends_at","charged_now"],"type":"object"},{"type":"null"}]}},"required":["currency","lines","monthly_before","monthly_after","monthly_delta","prorata","tax","trial","applies","effective_from","expires_at","id"],"type":"object"},"BillingQuoteChange":{"description":"One change to price. What else it needs depends on `type`: `package` needs `subject` and `package`; `addons`\nneeds `subject`, `cores`, `memory_gb`, `disk_gb` and `log_storage_gb` (the totals after the change, not the\ndifference); `uat_size` needs an environment `subject` and `uat_size`; `compute_family` needs `subject` and\n`family`; `new_site` and `new_cluster` need `package`, `family` and `region`.\n","properties":{"addons":{"description":"For `new_site` and `new_cluster`, the add-ons to price with it.","properties":{"cores":{"maximum":512,"minimum":0,"type":"integer"},"disk_gb":{"description":"Extra disk in GB, 102400 (100 TB) at most.","maximum":102400,"minimum":0,"type":"integer"},"memory_gb":{"maximum":4096,"minimum":0,"type":"integer"}},"type":"object"},"cores":{"maximum":512,"minimum":0,"type":"integer"},"disk_gb":{"description":"Extra disk in GB, 102400 (100 TB) at most.","maximum":102400,"minimum":0,"type":"integer"},"environments":{"description":"For `new_site`, the staging environments to price with it.","items":{"properties":{"uat_size":{"maxLength":16,"type":"string"}},"required":["uat_size"],"type":"object"},"maxItems":10,"type":"array"},"family":{"description":"The server type. `general` is Standard and `optimised` is Performance.","enum":["general","optimised"],"type":"string"},"log_storage_gb":{"maximum":65536,"minimum":0,"type":"integer"},"memory_gb":{"maximum":4096,"minimum":0,"type":"integer"},"package":{"description":"A package code, such as `CC12`.","maxLength":16,"type":"string"},"region":{"maxLength":16,"type":"string"},"subject":{"description":"What is changed. A `package`, `addons` or `compute_family` change is for a site or a CoreCluster; a `uat_size` change is for an environment.","properties":{"id":{"minimum":1,"type":"integer"},"type":{"enum":["site","cluster","environment"],"type":"string"}},"required":["type","id"],"type":"object"},"type":{"enum":["package","addons","uat_size","compute_family","new_site","new_cluster"],"type":"string"},"uat_size":{"description":"A staging environment size, such as `small`.","maxLength":16,"type":"string"}},"required":["type"],"type":"object"},"BillingQuoteRequest":{"properties":{"account":{"description":"The billing account to price against, by its `id`. Left out, your company's default one. `account_id` is taken as the same field.","minimum":1,"type":"integer"},"changes":{"items":{"$ref":"#/components/schemas/BillingQuoteChange"},"maxItems":10,"minItems":1,"type":"array"}},"required":["changes"],"type":"object"},"BillingRights":{"description":"What you may do with the account.","properties":{"can_edit":{"type":"boolean"},"can_pay":{"description":"Whether you may pay an invoice. Paying is done in the Control Panel.","type":"boolean"},"can_view":{"type":"boolean"},"reason":{"description":"`billing_forbidden` when you may not read the account, else `null`.","type":["string","null"]}},"required":["can_view","can_edit","can_pay","reason"],"type":"object"},"BillingStanding":{"properties":{"cases":{"description":"The unpaid invoices being followed up, the one due first at the top.","items":{"$ref":"#/components/schemas/BillingStandingCase"},"type":"array"},"paused_until":{"description":"When Corefinity has paused the follow-up for your company, until when.","format":"date-time","type":["string","null"]},"restore":{"$ref":"#/components/schemas/BillingStandingRestore"},"state":{"description":"The most advanced fact of the account. `good`: nothing is overdue. `overdue`: an invoice is past its\ndue date. `final_notice`: a final notice has been sent. `suspended`: services are suspended.\n`retrieval`: services have ended and their data is still kept.\n","enum":["good","overdue","final_notice","suspended","retrieval"],"type":"string"},"suspended_services":{"items":{"$ref":"#/components/schemas/BillingStandingService"},"type":"array"}},"required":["state","cases","paused_until","suspended_services","restore"],"type":"object"},"BillingStandingCase":{"description":"One unpaid invoice that is being followed up. Every date is UTC.","properties":{"currency":{"type":"string"},"delete_on":{"description":"When the data is deleted. The same moment as `retrieval_until`.","format":"date-time","type":["string","null"]},"disputed":{"description":"Whether the invoice has an open dispute.","type":"boolean"},"due_at":{"format":"date-time","type":["string","null"]},"final_notice_at":{"description":"When the final notice was sent.","format":"date-time","type":["string","null"]},"invoice_id":{"minimum":1,"type":"integer"},"number":{"description":"The invoice number.","type":"string"},"outstanding":{"description":"What is left to pay on the invoice, in `currency`.","type":"number"},"overdue_days":{"description":"Whole days since the invoice was due.","type":"integer"},"retrieval_until":{"description":"Until when the data of ended services is kept.","format":"date-time","type":["string","null"]},"stage":{"description":"How far the follow-up has gone. `final_notice`: a final notice has been sent. `suspended`: the\nservices are suspended. `terminated`: the services have ended and their data is kept until\n`retrieval_until`. `settled_in_retrieval`: the invoice was settled after the services ended.\n`deleting`: the data is being deleted.\n","enum":["final_notice","suspended","terminated","settled_in_retrieval","deleting"],"type":"string"},"suspend_on":{"description":"When the services are suspended if the invoice is still unpaid.","format":"date-time","type":["string","null"]},"suspended_at":{"format":"date-time","type":["string","null"]},"terminate_on":{"description":"When the services end if the invoice is still unpaid.","format":"date-time","type":["string","null"]},"terminated_at":{"format":"date-time","type":["string","null"]}},"required":["invoice_id","number","outstanding","currency","due_at","overdue_days","stage","final_notice_at","suspend_on","suspended_at","terminate_on","terminated_at","retrieval_until","delete_on","disputed"],"type":"object"},"BillingStandingRestore":{"description":"What brings suspended services back. `how` is `none` when nothing is suspended or the data is being deleted,\n`pay_invoices` while paying the invoices brings them back by itself, and `staff_reinstatement` once the\nservices have ended and Corefinity has to reinstate them. The other fields depend on `how`.\n","properties":{"automatic":{"description":"Whether the services come back without anyone at Corefinity acting.","type":"boolean"},"contact":{"description":"With `staff_reinstatement`, how to ask for it.","type":"string"},"how":{"enum":["none","pay_invoices","staff_reinstatement"],"type":"string"},"invoice_ids":{"description":"With `pay_invoices`, the invoices to pay.","items":{"type":"integer"},"type":"array"},"pay_urls":{"description":"With `pay_invoices`, the page of each invoice in the Control Panel, as a path.","items":{"type":"string"},"type":"array"},"promise":{"description":"With `pay_invoices`, how soon the services are back once the payment has cleared.","type":"string"},"retrieval_until":{"description":"With `staff_reinstatement`, until when the data is kept.","format":"date-time","type":["string","null"]},"settled":{"description":"With `staff_reinstatement`, whether the invoice has been paid.","type":"boolean"}},"required":["how"],"type":"object"},"BillingStandingService":{"description":"A site or CoreCluster that is suspended for an unpaid invoice.","properties":{"id":{"minimum":1,"type":"integer"},"name":{"description":"The site's domain or the CoreCluster's name. Empty when it is no longer your company's.","type":"string"},"phase":{"enum":["suspended","retrieval"],"type":"string"},"since":{"format":"date-time","type":["string","null"]},"type":{"enum":["site","cluster"],"type":"string"}},"required":["type","id","name","since","phase"],"type":"object"},"BillingUsage":{"description":"What a month cost. Not the shared `Usage`, which is the CPU, memory and disk a site uses over time.","properties":{"credits_applied":{"items":{"properties":{"amount":{"$ref":"#/components/schemas/Money","description":"The credit applied, as a negative amount."},"credit":{"properties":{"id":{"minimum":1,"type":"integer"},"public_note":{"type":"string"}},"required":["id","public_note"],"type":"object"},"invoice":{"$ref":"#/components/schemas/BillingInvoiceRef"}},"required":["credit","amount","invoice"],"type":"object"},"type":"array"},"currency":{"type":"string"},"days":{"items":{"properties":{"amount":{"$ref":"#/components/schemas/Money"},"day":{"format":"date","type":"string"}},"required":["day","amount"],"type":"object"},"type":"array"},"lines":{"items":{"properties":{"amount":{"$ref":"#/components/schemas/Money"},"contract_line":{"$ref":"#/components/schemas/BillingContractLineRef"},"days":{"items":{"properties":{"amount":{"$ref":"#/components/schemas/Money"},"day":{"format":"date","type":"string"},"hours":{"type":"integer"}},"required":["day","amount","hours"],"type":"object"},"type":"array"},"hours":{"type":"integer"}},"required":["contract_line","amount","hours","days"],"type":"object"},"type":"array"},"month":{"description":"The month, as `YYYY-MM`.","type":"string"},"total":{"$ref":"#/components/schemas/Money"}},"required":["month","currency","total","days","lines","credits_applied"],"type":"object"},"BillingVat":{"description":"The VAT basis of the account.","properties":{"buyer":{"description":"Whether Corefinity has recorded the buyer as a business or a consumer, when it has.","type":["string","null"]},"check":{"description":"An open check of the account's VAT by Corefinity, or `null`.","oneOf":[{"properties":{"open":{"type":"boolean"},"reason":{"type":"string"},"since":{"format":"date-time","type":["string","null"]}},"required":["open","since","reason"],"type":"object"},{"type":"null"}]},"country":{"description":"The country VAT is judged for, as a two-letter code.","type":"string"},"kind":{"description":"How VAT applies, such as `standard`, `reverse_charge` or `outside_scope`.","type":"string"},"label":{"description":"The basis in words, as invoices carry it.","type":"string"},"rate_percent":{"type":"number"},"validation":{"properties":{"state":{"description":"The state of the VAT number. `none`: there is no number. `pending`: it is being checked. `valid`\nand `invalid`: the outcome. `unverified`: it could not be checked. `not_applicable`: numbers of\nthat country are not checked.\n","enum":["valid","unverified","invalid","none","not_applicable","pending"],"type":"string"},"validated_at":{"format":"date-time","type":["string","null"]}},"required":["state","validated_at"],"type":"object"}},"required":["country","buyer","kind","rate_percent","label","validation","check"],"type":"object"},"BillingVatNumberRequest":{"properties":{"vat_number":{"description":"The VAT number; `null` clears it. Spaces, dots and hyphens are taken out and letters are made upper case\nbefore it is judged, so the 255 characters are only what the field takes as sent. What is left may hold\nletters, digits, `+` and `*`. For an account in a European Union country, a number that starts with\nneither a European Union country's prefix nor `GB` is given the account's (`EL` for Greece): `123456789`\non a German account is saved as `DE123456789`; one that already starts with such a prefix is saved as\nsent. The number as it is saved, prefix included, is at most 20 characters. On a United Kingdom account it\nmust have the United Kingdom's shape: `GB` and nine or twelve digits, or `GBGD` or `GBHA` and three digits.\n","maxLength":255,"type":["string","null"]},"version":{"description":"The account's `version` as you last read it.","minimum":0,"type":"integer"}},"required":["version"],"type":"object"},"CapacityBlock":{"additionalProperties":true,"properties":{"dimension":{"type":"string"},"message":{"type":"string"},"reason":{"description":"A stable code, such as `no_platform_cluster`, `package_restricted` or `compute_blocked`.","type":"string"}},"required":["reason","message"],"type":"object"},"CapacityCheck":{"additionalProperties":true,"properties":{"added":{"description":"What the site and its environments would add.","properties":{"cpu_millicores":{"type":"integer"},"disk_bytes":{"type":"integer"},"environments":{"type":"integer"},"memory_bytes":{"type":"integer"},"sites":{"type":"integer"}},"required":["cpu_millicores","memory_bytes","disk_bytes","sites","environments"],"type":"object"},"blocking":{"description":"Why the create would be refused. Empty when it would not.","items":{"$ref":"#/components/schemas/CapacityBlock"},"type":"array"},"cluster":{"description":"Where the site would be placed. Null when the region is not set up.","oneOf":[{"$ref":"#/components/schemas/ClusterRef"},{"type":"null"}]},"current":{"type":["object","null"]},"evaluated_at":{"format":"date-time","type":"string"},"node_pending":{"description":"Set when the create would wait for capacity to be added instead of starting at once.","type":["string","null"]},"ok":{"type":"boolean"},"package":{"properties":{"key":{"type":"string"},"name":{"type":"string"}},"required":["key","name"],"type":"object"},"projected":{"type":["object","null"]},"rows":{"description":"Each row the create would make, the production row first.","items":{"additionalProperties":true,"properties":{"node_pending":{"type":["string","null"]},"role":{"enum":["production","staging"],"type":"string"},"tier":{"type":["string","null"]},"uat_size":{"type":["string","null"]}},"required":["role","uat_size","tier","node_pending"],"type":"object"},"type":"array"},"storage_pending":{"type":"boolean"},"warnings":{"description":"Sentences to know about, such as a create that would wait for capacity to be added. They never make `ok` false.","items":{"type":"string"},"type":"array"}},"required":["cluster","package","added","blocking","warnings","ok","evaluated_at","node_pending","rows"],"type":"object"},"CapacityCheckRequest":{"additionalProperties":false,"description":"No other field is accepted. A field that is not listed here is refused `422`.","properties":{"company":{"description":"Your own company. Any other company is refused `422` on `company`.","type":["integer","string"]},"compute_family":{"default":"general","description":"The server type. One is accepted only while it is offered to your company and in the region.","enum":["general","optimised"],"type":"string"},"environments":{"description":"One entry for each staging environment to create with the site.","items":{"properties":{"uat_size":{"description":"A staging size key, such as `xsmall`.","type":"string"}},"required":["uat_size"],"type":"object"},"type":"array"},"package":{"description":"The key of an active CoreStack package, such as `cs4`.","type":"string"},"region":{"description":"A region key of two to four lower-case letters, such as `uk`.","pattern":"^[a-z]{2,4}$","type":"string"}},"required":["region","package"],"type":"object"},"ClonePreview":{"properties":{"anonymise":{"$ref":"#/components/schemas/Availability","description":"Present for a Shopware source only. Whether an anonymised copy can be made, and why not."},"blockers":{"description":"What stops the copy now. Each has a `reason` and a `message`.","items":{"$ref":"#/components/schemas/ClonePreviewNote"},"type":"array"},"can_proceed":{"description":"Whether a copy sent now would be taken, started or queued.","type":"boolean"},"crypt_match":{"description":"For Magento 2, whether both environments use the same encryption key. Null when not established.","type":["boolean","null"]},"estimated_seconds":{"description":"How long the data is expected to take to copy. Null when the size is not known.","type":["integer","null"]},"estimated_switch_seconds":{"description":"How long the target is expected to be switched over for.","type":["integer","null"]},"expected_switch":{"description":"What the switch-over involves. Null when no target was named.","oneOf":[{"properties":{"compute":{"description":"Where the environment runs. Both fields are always null in this API.","properties":{"from":{"type":"null"},"to":{"type":"null"}},"required":["from","to"],"type":"object"},"crosses_tier":{"description":"Whether the two environments run on different tiers of the platform.","type":"boolean"},"note":{"description":"What to expect of the switch-over, in plain words, when there is something to say.","type":["string","null"]},"storage":{"description":"Where the data sits. Both fields are always null in this API.","properties":{"from":{"type":"null"},"to":{"type":"null"}},"required":["from","to"],"type":"object"}},"required":["crosses_tier","storage","compute","note"],"type":"object"},{"type":"null"}]},"expires_at":{"description":"When the token stops being accepted.","format":"date-time","type":"string"},"fixups":{"description":"What is adjusted on the target after the copy, in plain words.","items":{"type":"string"},"type":"array"},"preview_token":{"description":"Quote this in `cloneSite` within 15 minutes.","type":"string"},"queues":{"description":"Whether a copy sent now would wait its turn (202) instead of starting.","type":"boolean"},"safety_snapshot":{"description":"Whether a safety copy of the target can be kept first.","type":"boolean"},"scope":{"$ref":"#/components/schemas/CloneScope"},"sizes":{"description":"What would be copied, as last measured. Every figure is null until the environment has been measured.","properties":{"basis":{"description":"What was measured, such as `volume` for the space used on the environment's disk.","type":["string","null"]},"copied_bytes":{"type":["integer","null"]},"db_bytes":{"type":["integer","null"]},"files_bytes":{"type":["integer","null"]},"measured_at":{"description":"When the figures were measured.","format":"date-time","type":["string","null"]},"scratch_bytes":{"type":["integer","null"]},"used_bytes":{"type":["integer","null"]}},"required":["used_bytes","files_bytes","db_bytes","copied_bytes","scratch_bytes","measured_at","basis"],"type":"object"},"source":{"allOf":[{"$ref":"#/components/schemas/EnvironmentRef"},{"properties":{"platform":{"description":"The application, such as `wordpress` or `magento2`.","type":"string"},"tier":{"description":"The environment's size.","type":["string","null"]}},"required":["platform","tier"],"type":"object"}]},"steps":{"description":"The steps the copy goes through, in order.","items":{"$ref":"#/components/schemas/CopyItem"},"type":"array"},"target":{"description":"The environment the copy goes onto. Null when no target was named.","oneOf":[{"allOf":[{"$ref":"#/components/schemas/EnvironmentRef"},{"properties":{"tier":{"type":["string","null"]}},"type":"object"}]},{"type":"null"}]},"target_disk":{"description":"The target's disk. Null when no target was named.","oneOf":[{"properties":{"free_bytes":{"type":["integer","null"]},"size_bytes":{"type":["integer","null"]},"used_bytes":{"type":["integer","null"]}},"required":["size_bytes","used_bytes","free_bytes"],"type":"object"},{"type":"null"}]},"target_growth":{"description":"When the target is too small for the data and a larger size fixes it, that size, what it adds each month\nand whether it is bought automatically. Null otherwise.\n","oneOf":[{"$ref":"#/components/schemas/CloneTargetGrowth"},{"type":"null"}]},"waits":{"description":"What a copy sent now would wait for before it starts by itself.","items":{"$ref":"#/components/schemas/ClonePreviewNote"},"type":"array"}},"required":["source","target","scope","sizes","target_disk","estimated_seconds","estimated_switch_seconds","expected_switch","crypt_match","steps","fixups","safety_snapshot","blockers","can_proceed","preview_token","expires_at"],"type":"object"},"ClonePreviewNote":{"additionalProperties":true,"description":"Something that blocks a copy, or that it would wait for.","properties":{"message":{"type":"string"},"reason":{"type":"string"}},"required":["reason","message"],"type":"object"},"CloneQueued":{"properties":{"message":{"description":"What the copy waits for.","type":"string"},"queued":{"$ref":"#/components/schemas/CopyQueueEntry"},"reason":{"const":"queued","type":"string"},"target":{"$ref":"#/components/schemas/EnvironmentRef"}},"required":["message","reason","queued","target"],"type":"object"},"CloneRequest":{"additionalProperties":false,"properties":{"anonymise":{"description":"Make an anonymised copy. Shopware only, from the live database, never onto production. A value that is\nnot true or false, and an anonymised copy that cannot be made, are refused `invalid`.\n","type":"boolean"},"confirm_name":{"description":"For an environment, its name, typed exactly: checked whenever it is sent, and required when the copy\nreplaces the whole environment. For production, the website's domain, always required.\n","type":"string"},"copy_nginx_rules":{"description":"Also copy the source's Nginx rules, once the copy has completed.","type":"boolean"},"copy_node_runtime":{"description":"Also copy the source's Node.js version and global packages.","type":"boolean"},"copy_php_runtime":{"description":"Also copy the source's PHP settings, once the copy has completed.","type":"boolean"},"node_acknowledge":{"description":"With `copy_node_runtime`, what you acknowledge about the Node.js version being copied. Only `eol`, for a version past its end of life, and at most once.","items":{"enum":["eol"],"type":"string"},"maxItems":1,"type":"array"},"preview_token":{"description":"The `preview_token` of `previewSiteClone`, asked with the same target, scope and snapshot within the last 15 minutes.","type":"string"},"safety_first":{"default":true,"description":"Keep a safety copy of the target before it is replaced. Always on for a copy onto production.","type":"boolean"},"scope":{"allOf":[{"$ref":"#/components/schemas/CloneScope"}],"default":"files_db"},"snapshot_id":{"description":"Copy from this ready snapshot of the source instead of the live environment.","minimum":1,"type":"integer"},"target":{"properties":{"environment_id":{"description":"For `environment`, the site row id of the environment to copy onto. It cannot be production or the source itself.","minimum":1,"type":"integer"},"type":{"description":"`environment` copies onto `environment_id`. `production` copies onto the website's production (push to live).","enum":["environment","production"],"type":"string"}},"required":["type"],"type":"object"}},"required":["target","preview_token"],"type":"object"},"CloneScope":{"description":"What a copy takes: files and database, the database only, or files only.","enum":["files_db","db","files"],"type":"string"},"CloneStarted":{"properties":{"operation":{"$ref":"#/components/schemas/Operation"},"target":{"$ref":"#/components/schemas/EnvironmentRef"}},"required":["operation","target"],"type":"object"},"CloneTargetGrowth":{"description":"The larger size that makes a target big enough for the data.","properties":{"automatic":{"description":"Whether the copy buys the size itself, because your company has automatic upgrades on.","type":"boolean"},"currency":{"description":"The currency of `monthly_delta`, as an ISO 4217 code.","type":["string","null"]},"disk_bytes":{"description":"The disk that size brings.","type":"integer"},"label":{"description":"The size as the Control Panel names it.","type":"string"},"message":{"description":"The same in plain words.","type":"string"},"monthly_delta":{"description":"What the size adds each month, as a decimal string. Null when no price was worked out.","type":["string","null"]},"needed_bytes":{"description":"The room the copy needs.","type":"integer"},"size":{"description":"The staging size to move to, such as `medium`.","type":"string"}},"required":["size","label","disk_bytes","needed_bytes","automatic","message","monthly_delta","currency"],"type":"object"},"CloudflareConnectRequest":{"properties":{"token":{"description":"A Cloudflare API token. Printable characters without spaces.","maxLength":128,"minLength":40,"pattern":"^[\\x21-\\x7E]+$","type":"string"}},"required":["token"],"type":"object"},"CloudflareConnection":{"description":"A company's Cloudflare connection. The token is never part of it.","properties":{"can_change":{"type":"boolean"},"company":{"$ref":"#/components/schemas/Named"},"connect":{"description":"A link to Cloudflare's token form and the steps to follow.","properties":{"instructions":{"items":{"type":"string"},"type":"array"},"url":{"type":"string"}},"required":["url","instructions"],"type":"object"},"connected_by":{"description":"Who connected it. Null when it is not known. Corefinity staff read as `Corefinity support` with a null `id`.","oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"last_error":{"type":["string","null"]},"method":{"type":["string","null"]},"scopes":{"description":"The permissions the token needs (`required`) and those it lacks (`missing`).","properties":{"missing":{"items":{"type":"string"},"type":"array"},"required":{"items":{"type":"string"},"type":"array"}},"required":["required","missing"],"type":"object"},"status":{"enum":["not_connected","verifying","connected","invalid","needs_reauth"],"type":"string"},"status_label":{"type":"string"},"token_id":{"type":["string","null"]},"token_last4":{"description":"The last four characters of the token.","type":["string","null"]},"unmapped_sites":{"description":"Sites whose domain is in none of the zones, each with `id` and `domain`.","items":{"type":"object"},"type":["array","null"]},"verified_at":{"format":"date-time","type":["string","null"]},"zones":{"items":{"$ref":"#/components/schemas/CloudflareZone"},"type":"array"}},"required":["company","status","status_label","method","token_id","token_last4","scopes","verified_at","connected_by","last_error","zones","unmapped_sites","connect","can_change"],"type":"object"},"CloudflarePurgeCommand":{"description":"The purge as a command. Read it again with `GET /corestack/commands/{command}`.","properties":{"blocked_until_verified":{"type":["boolean","null"]},"duration_ms":{"type":["integer","null"]},"error":{"type":["string","null"]},"exit_code":{"type":["integer","null"]},"finished_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"input":{"additionalProperties":true,"description":"What was asked for: `everything`, or the `urls`.","properties":{"everything":{"type":"boolean"},"urls":{"items":{"type":"string"},"type":"array"}},"type":"object"},"kind":{"const":"cloudflare_purge","type":"string"},"label":{"type":"string"},"operation_id":{"type":["integer","null"]},"output_excerpt":{"type":["string","null"]},"queued_at":{"format":"date-time","type":["string","null"]},"requested_by":{"description":"Who asked for the purge. Null when that person's account no longer exists.","oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"result":{"description":"What the purge did, once it has finished."},"site":{"description":"The site.","properties":{"domain":{"type":"string"},"id":{"minimum":1,"type":"integer"}},"required":["id","domain"],"type":"object"},"started_at":{"format":"date-time","type":["string","null"]},"status":{"enum":["queued","running","succeeded","failed","timed_out","lost"],"type":"string"},"status_label":{"type":"string"}},"required":["id","kind","label","site","status","status_label"],"type":"object"},"CloudflarePurgeRequest":{"description":"Send `everything` or `urls`, never both.","oneOf":[{"required":["everything"]},{"required":["urls"]}],"properties":{"everything":{"const":true,"type":"boolean"},"urls":{"description":"Addresses starting `http://` or `https://` on one of the site's own domains.","items":{"format":"uri","type":"string"},"maxItems":30,"minItems":1,"type":"array"},"varnish_first":{"description":"Whether to purge the site's Varnish cache first, when Varnish is on. Left out, it does.","type":"boolean"}},"type":"object"},"CloudflareSslRequest":{"properties":{"value":{"enum":["full","strict"],"type":"string"}},"required":["value"],"type":"object"},"CloudflareSslRule":{"additionalProperties":true,"description":"One SSL rule: the SSL mode Cloudflare uses for the named domains of the site.","properties":{"hosts":{"description":"The domains the rule names, sorted.","items":{"type":"string"},"type":"array"},"id":{"description":"The `{rule}` a removal takes.","minimum":1,"type":"integer"},"removed_at":{"format":"date-time","type":["string","null"]},"set_at":{"format":"date-time","type":["string","null"]},"site_id":{"description":"The site row the rule was set for.","type":["integer","null"]},"ssl":{"description":"`full` is Full, `strict` is Full (strict).","enum":["full","strict"],"type":"string"},"state":{"description":"`setting` while it is being written, `active` once Cloudflare has it, `removed`, `failed` when it could not be written, and `kept` when it was changed in Cloudflare afterwards and so was left there.","enum":["setting","active","removed","kept","failed"],"type":"string"},"state_reason":{"description":"Why the rule is in its state, when there is something to say.","type":["string","null"]},"zone":{"description":"The Cloudflare zone the rule is in.","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"}},"required":["id","zone","site_id","hosts","ssl","state","state_reason","set_at","removed_at"],"type":"object"},"CloudflareSslRuleList":{"additionalProperties":true,"properties":{"access":{"description":"Sent only with `check`: for each zone, whether the stored token may change Configuration Rules.","items":{"properties":{"access":{"description":"Only `ok` allows a rule to be set.","enum":["ok","missing","unknown"],"type":"string"},"zone":{"type":"string"}},"required":["zone","access"],"type":"object"},"type":"array"},"domains":{"description":"The site's domains, each with the connected zone it is in. A rule can name the ones that have a zone.","items":{"properties":{"host":{"type":"string"},"zone":{"description":"The name of the zone. Null when the domain is in no connected zone.","type":["string","null"]}},"required":["host","zone"],"type":"object"},"type":"array"},"rules":{"description":"Newest first: every rule that may still be at Cloudflare, and the last 100 removed or failed ones.","items":{"$ref":"#/components/schemas/CloudflareSslRule"},"type":"array"},"zone":{"description":"The Cloudflare zone the site is mapped to. Null when it has none.","oneOf":[{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},{"type":"null"}]}},"required":["zone","domains","rules"],"type":"object"},"CloudflareSslRuleRefusal":{"additionalProperties":true,"description":"A refusal that may carry the rule as it stands.","properties":{"code":{"description":"The same value as `reason`.","type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"rule":{"$ref":"#/components/schemas/CloudflareSslRule"}},"required":["message","reason","code"],"type":"object"},"CloudflareSslRuleResult":{"properties":{"rule":{"$ref":"#/components/schemas/CloudflareSslRule"}},"required":["rule"],"type":"object"},"CloudflareSslRuleSet":{"properties":{"hosts":{"description":"Domains of this site, all in one connected Cloudflare zone of your company. Together they must fit one\nrule: the lengths of the names added up, plus three for each name, come to at most 4,080 characters. A\nlonger list is refused `invalid` on `hosts`; set the names in two rules.\n","items":{"maxLength":253,"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"ssl":{"description":"`full` for Full, `strict` for Full (strict).","enum":["full","strict"],"type":"string"}},"required":["hosts","ssl"],"type":"object"},"CloudflareZone":{"description":"One Cloudflare zone of a company's connection.","properties":{"dns01":{"type":["object","null"]},"id":{"description":"Cloudflare's id for the zone. Send it as `zone_id`.","type":"string"},"name":{"type":"string"},"permissions":{"description":"What the token may do in the zone.","properties":{"cache_purge":{"type":"boolean"},"dns_edit":{"type":"boolean"},"zone_settings":{"type":"boolean"}},"required":["dns_edit","cache_purge","zone_settings"],"type":"object"},"plan":{"type":["string","null"]},"refreshed_at":{"format":"date-time","type":["string","null"]},"sites":{"description":"The sites mapped to the zone.","items":{"properties":{"mapping":{"description":"Whether the Control Panel matched the zone to the site or you chose it.","enum":["auto","manual"],"type":"string"},"site":{"properties":{"domain":{"type":"string"},"id":{"minimum":1,"type":"integer"}},"required":["id","domain"],"type":"object"}},"required":["site","mapping"],"type":"object"},"type":"array"},"ssl_mode":{"type":["string","null"]},"ssl_ok":{"type":["boolean","null"]},"ssl_recommended":{"type":["string","null"]},"status":{"type":["string","null"]}},"required":["id","name","status","plan","ssl_mode","ssl_recommended","ssl_ok","permissions","sites","refreshed_at","dns01"],"type":"object"},"CloudflareZoneRequest":{"properties":{"mode":{"enum":["auto","manual","off"],"type":"string"},"zone_id":{"description":"Required when `mode` is `manual`. The `id` of one of the connection's zones.","maxLength":64,"type":["string","null"]}},"required":["mode"],"type":"object"},"Cluster":{"additionalProperties":true,"description":"A CoreCluster. Every answer that carries a CoreCluster carries this object. Other fields may be present; the\nones named in `required` are always sent.\n","properties":{"actions":{"additionalProperties":true,"description":"What can be done with the CoreCluster now.","properties":{"create_environment":{"$ref":"#/components/schemas/Availability"},"create_site":{"$ref":"#/components/schemas/Availability","description":"May add `grows`, true when the CoreCluster is full and would grow first under automatic upgrades."},"delete":{"$ref":"#/components/schemas/Availability"},"upgrade_package":{"$ref":"#/components/schemas/Availability","description":"Adds `downgrade`, true when a smaller package can be chosen."}},"required":["create_site","create_environment","upgrade_package","delete"],"type":"object"},"allowance":{"additionalProperties":true,"description":"What the package allows.","properties":{"cpu_millicores":{"type":["integer","null"]},"disk_bytes":{"type":["integer","null"]},"memory_bytes":{"type":["integer","null"]}},"type":"object"},"billing":{"description":"Sent only by `GET /corestack/clusters/{cluster}`, while billing is on for your company.","properties":{"account_id":{"description":"The billing account the CoreCluster is charged to. Null when nothing charges it yet, or you cannot see the account.","minimum":1,"type":["integer","null"]}},"required":["account_id"],"type":"object"},"capacity":{"$ref":"#/components/schemas/ClusterCapacity"},"created_at":{"format":"date-time","type":["string","null"]},"created_by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"environments":{"description":"How many environments besides production the CoreCluster has.","type":"integer"},"id":{"description":"The `{cluster}` of every `/corestack/clusters/{cluster}` endpoint.","minimum":1,"type":"integer"},"kind":{"description":"`customer` for a CoreCluster of your own.","enum":["customer","platform"],"type":"string"},"label":{"type":"string"},"location":{"additionalProperties":true,"properties":{"arch":{"enum":["arm64","amd64"],"type":"string"},"label":{"description":"Where the CoreCluster runs.","type":"string"}},"type":"object"},"logs":{"description":"How much log storage the CoreCluster uses. Null when its logs are not collected.","type":["object","null"]},"name":{"type":"string"},"operation":{"description":"The change running on the CoreCluster now, or the one that left it `failed`. Null otherwise.","oneOf":[{"$ref":"#/components/schemas/OperationSummary"},{"type":"null"}]},"package":{"additionalProperties":true,"description":"The CoreCluster's package. Null when it has none, and while packages are off for your company.","properties":{"cores":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"}},"type":["object","null"]},"pending_changes":{"additionalProperties":true,"description":"The changes waiting for the next maintenance window of the CoreCluster's sites.","properties":{"count":{"type":"integer"},"window_starts_at":{"format":"date-time","type":["string","null"]}},"type":"object"},"ready_at":{"format":"date-time","type":["string","null"]},"region":{"properties":{"key":{"description":"The region key, as a create takes it.","type":"string"},"label":{"type":"string"},"place":{"type":"string"}},"required":["key","label","place"],"type":"object"},"reserved":{"additionalProperties":true,"description":"What the sizes of the CoreCluster's sites add up to.","properties":{"cpu_limit_millicores":{"type":"integer"},"cpu_request_millicores":{"type":"integer"},"disk_bytes":{"type":"integer"},"memory_limit_bytes":{"type":"integer"},"memory_request_bytes":{"type":"integer"}},"type":"object"},"sites":{"additionalProperties":true,"description":"How many sites the CoreCluster has, and how they are doing.","properties":{"applying":{"type":"integer"},"degraded":{"type":"integer"},"down":{"type":"integer"},"environments":{"description":"Environments besides production.","type":"integer"},"healthy":{"type":"integer"},"live":{"description":"Sites with a domain attached.","type":"integer"},"preview":{"description":"Sites with no domain attached yet.","type":"integer"},"total":{"type":"integer"},"unknown":{"type":"integer"}},"required":["total","live","preview","environments","healthy","degraded","down","applying","unknown"],"type":"object"},"slug":{"description":"Made from the name when the CoreCluster is created. It never changes.","type":"string"},"snapshots":{"additionalProperties":true,"description":"The short form of the CoreCluster's snapshot settings and storage.","properties":{"frequency":{"type":"string"},"over_quota":{"type":"boolean"},"pruned_recently":{"type":"boolean"},"quota_bytes":{"type":["integer","null"]},"retention_days":{"type":["integer","null"]},"usage_bytes":{"type":["integer","null"]}},"type":"object"},"ssh_host":{"description":"The address the CoreCluster's sites are reached on over SSH.","type":"string"},"state":{"enum":["creating","ready","degraded","migrating","deleting","failed"],"type":"string"},"state_label":{"type":"string"},"state_reason":{"description":"Why the CoreCluster is `degraded`, `migrating` or `failed`, in plain words.","type":["string","null"]},"synced":{"additionalProperties":true,"description":"When the list of sites, the usage and the live status were last read.","properties":{"inventory_at":{"format":"date-time","type":["string","null"]},"live_at":{"format":"date-time","type":["string","null"]},"usage_at":{"format":"date-time","type":["string","null"]}},"type":"object"},"usage":{"additionalProperties":true,"description":"What the sites use now. A figure is null where nothing was measured.","properties":{"cpu_millicores":{"type":["number","null"]},"disk_used_bytes":{"type":["number","null"]},"memory_bytes":{"type":["number","null"]},"observed_at":{"format":"date-time","type":["string","null"]},"source":{"type":["string","null"]}},"type":"object"}},"required":["id","name","slug","kind","label","location","allowance","reserved","usage","sites","snapshots","synced","capacity","state","state_label","state_reason","region","package","ssh_host","environments","created_by","created_at","ready_at","operation","actions","pending_changes","logs"],"type":"object"},"ClusterAnswer":{"properties":{"cluster":{"$ref":"#/components/schemas/Cluster"},"sites":{"items":{"$ref":"#/components/schemas/ClusterSite"},"type":"array"}},"required":["cluster","sites"],"type":"object"},"ClusterCapacity":{"additionalProperties":true,"description":"How much of the package the CoreCluster's sites use.","properties":{"basis":{"description":"What the usage figures are: measured (`p95`), estimated from the sizes of the sites (`estimate`), or both (`mixed`).","enum":["p95","mixed","estimate"],"type":"string"},"cpu":{"allOf":[{"$ref":"#/components/schemas/ClusterCapacityMeter"},{"properties":{"capacity_millicores":{"type":"integer"},"used_p95_millicores":{"type":["number","null"]}},"type":"object"}]},"evaluated_at":{"format":"date-time","type":["string","null"]},"level":{"description":"The worst level of the meters.","enum":["ok","warning","blocked"],"type":"string"},"memory":{"allOf":[{"$ref":"#/components/schemas/ClusterCapacityMeter"},{"properties":{"capacity_bytes":{"type":"integer"},"used_p95_bytes":{"type":["number","null"]}},"type":"object"}]},"package":{"additionalProperties":true,"description":"The package the figures are measured against. Null for a CoreCluster with no package.","properties":{"cores":{"type":"integer"},"key":{"type":"string"},"memory_bytes":{"type":"integer"},"name":{"type":"string"}},"type":["object","null"]},"sites":{"properties":{"count":{"type":"integer"},"environments":{"type":"integer"}},"required":["count","environments"],"type":"object"},"storage":{"allOf":[{"$ref":"#/components/schemas/ClusterCapacityMeter"},{"properties":{"capacity_bytes":{"type":"integer"},"provisioned_bytes":{"type":["number","null"]}},"type":"object"}]}},"required":["package","cpu","memory","sites","storage","level","basis","evaluated_at"],"type":"object"},"ClusterCapacityCheck":{"additionalProperties":true,"properties":{"added":{"description":"What the proposed sites and environments would add.","properties":{"cpu_millicores":{"type":"integer"},"disk_bytes":{"type":"integer"},"environments":{"type":"integer"},"memory_bytes":{"type":"integer"},"sites":{"type":"integer"}},"required":["cpu_millicores","memory_bytes","disk_bytes","sites","environments"],"type":"object"},"blocking":{"description":"Why the proposal would be refused now. Empty when it would not.","items":{"additionalProperties":true,"properties":{"dimension":{"description":"The meter that would be over, for `capacity_blocked`.","type":"string"},"message":{"type":"string"},"reason":{"description":"A stable code, such as `capacity_blocked`, `package_restricted`, `cluster_not_ready` or `region_unavailable`.","type":"string"}},"required":["reason","message"],"type":"object"},"type":"array"},"cluster":{"description":"The CoreCluster that was checked. Null for a check before the CoreCluster exists.","oneOf":[{"$ref":"#/components/schemas/ClusterRef"},{"type":"null"}]},"current":{"allOf":[{"$ref":"#/components/schemas/ClusterCapacity"}],"description":"The capacity as it is now."},"evaluated_at":{"format":"date-time","type":"string"},"grows":{"description":"Sent, as true, only when the proposal needs more room than the package has and your company has automatic\nupgrades on, so the CoreCluster would grow first. `warnings` says so.\n","type":"boolean"},"ok":{"description":"True when `blocking` is empty.","type":"boolean"},"package":{"description":"The package the proposal was measured against.","properties":{"key":{"type":"string"},"name":{"type":"string"}},"type":["object","null"]},"projected":{"allOf":[{"$ref":"#/components/schemas/ClusterCapacity"}],"description":"The capacity with the proposal."},"warnings":{"description":"Sentences about a meter the proposal would leave nearly full.","items":{"type":"string"},"type":"array"}},"required":["cluster","package","current","projected","added","blocking","warnings","ok","evaluated_at"],"type":"object"},"ClusterCapacityMeter":{"additionalProperties":true,"description":"One meter. The figures are in the unit its field names say; `percent` is what is used of the capacity.","properties":{"level":{"description":"`ok` under 75 per cent, `warning` from 75 and `blocked` from 90.","enum":["ok","warning","blocked"],"type":"string"},"percent":{"type":"integer"}},"required":["percent","level"],"type":"object"},"ClusterCapacityRequest":{"additionalProperties":false,"description":"No other field is accepted. `sites` and `environments` hold at most 50 rows between them.","properties":{"environments":{"description":"Environments to add.","items":{"$ref":"#/components/schemas/ClusterCapacityRow"},"maxItems":50,"type":"array"},"package":{"description":"The key of another package to measure against. Leave it out to use the CoreCluster's own.","type":["string","null"]},"remove":{"description":"The site row ids of sites and environments of the CoreCluster to take away first, as numbers. At most 50.","items":{"minimum":1,"type":"integer"},"maxItems":50,"type":"array"},"sites":{"description":"Sites to add.","items":{"$ref":"#/components/schemas/ClusterCapacityRow"},"maxItems":50,"type":"array"}},"type":"object"},"ClusterCapacityRow":{"additionalProperties":false,"properties":{"platform":{"description":"A platform, such as `wordpress`, `laravel` or `magento2`.","type":"string"},"tier":{"description":"A size the platform has, such as `S`, `M` or `L`.","type":"string"}},"required":["platform","tier"],"type":"object"},"ClusterCreateRequest":{"additionalProperties":false,"description":"No other field is accepted. A field that is not listed here is refused `422`, naming it.","properties":{"compute_family":{"default":"general","description":"The server type. `optimised` is accepted only while it is offered to your company.","enum":["general","optimised"],"type":"string"},"name":{"description":"The CoreCluster's name: letters, digits, spaces and `. & ' ( ) -`, starting with a letter or a digit. No\nother CoreCluster of your company may have it.\n","maxLength":100,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9 .&'()-]{0,99}$","type":"string"},"package":{"description":"The key of a CoreCluster package, such as `xsmall`. `GET /corestack/packages` lists them.","type":"string"},"region":{"description":"A region that is open for the package. `GET /corestack/regions` lists them.","enum":["uk","us","nl","aus"],"type":"string"},"sites":{"description":"The first sites to create with the CoreCluster. Add the rest once it is ready.","items":{"$ref":"#/components/schemas/ClusterFirstSite"},"maxItems":10,"type":"array"}},"required":["region","package","name"],"type":"object"},"ClusterCreated":{"properties":{"cluster":{"$ref":"#/components/schemas/Cluster"},"operation":{"$ref":"#/components/schemas/Operation"},"sites":{"description":"Each first site with the operation that creates it. Empty when the request listed none.","items":{"properties":{"operation":{"$ref":"#/components/schemas/Operation"},"site":{"$ref":"#/components/schemas/SiteDetail"}},"required":["site","operation"],"type":"object"},"type":"array"}},"required":["cluster","operation","sites"],"type":"object"},"ClusterDeleteRequest":{"additionalProperties":false,"description":"No other field is accepted. A field that is not listed here is refused `422`, naming it.","properties":{"allow_non_empty":{"default":false,"description":"True to delete everything that is still on the CoreCluster with it.","type":"boolean"},"confirm_name":{"description":"The CoreCluster's name, exactly.","type":"string"}},"required":["confirm_name"],"type":"object"},"ClusterDeletion":{"properties":{"cluster":{"additionalProperties":true,"properties":{"id":{"minimum":1,"type":"integer"},"name":{"description":"The name `confirm_name` must match.","type":"string"},"ssh_host":{"type":["string","null"]}},"required":["id","name","ssh_host"],"type":"object"},"empty":{"description":"True when there is no site, environment, deleted site in its grace period or snapshot.","type":"boolean"},"kept_snapshots":{"allOf":[{"$ref":"#/components/schemas/ClusterDeletionCount"}],"description":"Snapshots the deletion leaves until their retention ends."},"removed_sites_snapshots":{"allOf":[{"$ref":"#/components/schemas/ClusterDeletionCount"}],"description":"Snapshots of sites that were removed earlier, which the deletion deletes too."},"sites":{"description":"Up to 1,000 sites, the ones that are not deleted first, then by domain.","items":{"properties":{"deleted_at":{"format":"date-time","type":["string","null"]},"domain":{"type":"string"},"environments":{"description":"Up to 50 of the site's environments.","items":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"environments_more":{"description":"How many more environments the site has than are listed.","type":"integer"},"id":{"minimum":1,"type":"integer"},"snapshots":{"$ref":"#/components/schemas/ClusterDeletionCount"},"state":{"enum":["live","deleted"],"type":"string"}},"required":["id","domain","state","deleted_at","environments","environments_more","snapshots"],"type":"object"},"type":"array"},"sites_more":{"description":"How many more sites there are than are listed.","type":"integer"},"totals":{"$ref":"#/components/schemas/ClusterDeletionTotals"}},"required":["cluster","totals","sites","sites_more","removed_sites_snapshots","kept_snapshots","empty"],"type":"object"},"ClusterDeletionCount":{"properties":{"bytes":{"type":"integer"},"count":{"type":"integer"}},"required":["count","bytes"],"type":"object"},"ClusterDeletionTotals":{"properties":{"deleted_sites":{"description":"Sites you deleted that are still in their grace period.","type":"integer"},"domains":{"type":"integer"},"environments":{"type":"integer"},"mail_domains":{"type":"integer"},"sites":{"type":"integer"},"snapshot_bytes":{"type":"integer"},"snapshots":{"type":"integer"}},"required":["sites","environments","deleted_sites","domains","mail_domains","snapshots","snapshot_bytes"],"type":"object"},"ClusterFirstSite":{"additionalProperties":false,"description":"A first site, as the create of a site in a CoreCluster takes one. A field that is not listed here is refused\n`422`, named by its row, such as `sites.0.http_auth`. Where a site's create offers your company further\nchoices, a row takes them as `POST /corestack/clusters/{cluster}/sites` does.\n","properties":{"content":{"description":"`empty` for a site with no application installed, `fresh` for a fresh install.","enum":["empty","fresh"],"type":"string"},"domain":{"description":"The site's public domain, without `www.`. Each domain may appear once in the request.","maxLength":253,"minLength":4,"type":"string"},"fresh":{"description":"The settings of a fresh install. Read only when `content` is `fresh`.","oneOf":[{"$ref":"#/components/schemas/ClusterFirstSiteFresh"},{"type":"null"}]},"mariadb_version":{"description":"A MariaDB version the platform offers. Left out, the platform's default.","type":"string"},"node_acknowledge":{"description":"`[\"eol\"]` to accept a Node.js version past its end of life, which is refused `ack_required` without it.","items":{"enum":["eol"],"type":"string"},"maxItems":1,"type":"array"},"node_major":{"description":"The Node.js major version for the site, as a number such as `22`, from the ones offered for the platform.\nLeft out, the default. Where a new site cannot choose one yet, it is refused `runtime_not_adopted`.\n","maximum":99,"minimum":1,"type":["integer","null"]},"php_version":{"description":"A PHP version the platform offers, such as `8.3`. Left out, the platform's default.","type":"string"},"platform":{"description":"A platform the package offers, such as `wordpress`, `laravel` or `magento2`.","type":"string"},"tier":{"description":"The size of the site, such as `S`, `M` or `L`. It must be one the platform has and the package offers.","type":"string"},"varnish":{"additionalProperties":false,"description":"Magento 2 only. Whether the site starts with Varnish. Left out, the platform decides.","properties":{"enabled":{"type":"boolean"},"version":{"description":"A Varnish version the platform offers, such as `7.7`. Only with `enabled` true.","type":["string","null"]}},"required":["enabled"],"type":["object","null"]}},"required":["domain","platform","content","tier"],"type":"object"},"ClusterFirstSiteFresh":{"additionalProperties":false,"description":"The settings of a fresh install. All are optional: left out, the sign-in is made for you and the title is the\ndomain. No other field is accepted.\n","properties":{"admin_email":{"description":"The address of the site's first administrator. Left out, your own.","format":"email","maxLength":190,"type":"string"},"admin_username":{"description":"3 to 32 characters, a lower-case letter first, then lower-case letters, digits or `_`. `admin` is refused.","pattern":"^[a-z][a-z0-9_]{2,31}$","type":"string"},"locale":{"description":"A locale the platform installs, such as `en_GB` or `en_US`.","type":"string"},"site_title":{"description":"At most 100 characters, with no control characters. A blank title is read as left out.","maxLength":100,"type":"string"}},"type":"object"},"ClusterList":{"properties":{"can_create":{"allOf":[{"$ref":"#/components/schemas/Availability"}],"description":"Whether you can create another CoreCluster now."},"clusters":{"items":{"$ref":"#/components/schemas/Cluster"},"type":"array"},"generated_at":{"description":"Sent with an offset, as `2026-11-14T10:00:00+00:00`.","format":"date-time","type":"string"}},"required":["clusters","can_create","generated_at"],"type":"object"},"ClusterLogsContext":{"properties":{"after":{"description":"The later lines, oldest first.","items":{"$ref":"#/components/schemas/ClusterLogsLine"},"type":"array"},"before":{"description":"The earlier lines, oldest first.","items":{"$ref":"#/components/schemas/ClusterLogsLine"},"type":"array"},"line":{"$ref":"#/components/schemas/ClusterLogsLine"}},"required":["line","before","after"],"type":"object"},"ClusterLogsExportRequest":{"allOf":[{"$ref":"#/components/schemas/ClusterLogsReadChoice"},{"$ref":"#/components/schemas/LogsExportFormat"}],"description":"An export of a CoreCluster's logs."},"ClusterLogsLine":{"allOf":[{"$ref":"#/components/schemas/LogsLine"},{"properties":{"site":{"description":"The site the line came from. Null for a query with a pipe, or when the site cannot be told.","oneOf":[{"$ref":"#/components/schemas/ClusterLogsLineSite"},{"type":"null"}]}},"required":["site"],"type":"object"}],"description":"One log line of a CoreCluster read, with the site it came from."},"ClusterLogsLineSite":{"properties":{"environment":{"type":"string"},"id":{"minimum":1,"type":"integer"},"label":{"type":"string"}},"required":["id","label","environment"],"type":"object"},"ClusterLogsQueryRequest":{"allOf":[{"$ref":"#/components/schemas/ClusterLogsReadChoice"},{"$ref":"#/components/schemas/LogsPaging"}],"description":"A search of a CoreCluster's logs. Every field is optional."},"ClusterLogsQueryResult":{"allOf":[{"$ref":"#/components/schemas/LogsQueryResult"},{"properties":{"lines":{"items":{"$ref":"#/components/schemas/ClusterLogsLine"},"type":"array"}},"type":"object"}],"description":"A page of a search of a CoreCluster's logs."},"ClusterLogsReadChoice":{"description":"Which lines of a CoreCluster to read, and over what time.","properties":{"environment":{"default":"production","description":"`production` reads each site's production environment. `all` reads every environment.","enum":["production","all",null],"type":["string","null"]},"filters":{"description":"Filters applied beside the query.","oneOf":[{"$ref":"#/components/schemas/LogsFilters"},{"type":"null"}]},"from":{"description":"The start of the time range, as a date and time. It must be inside the time your logs are kept for.","type":["string","null"]},"query":{"description":"A LogsQL query, sent as written. Every line when left out. Up to 4 KB.","maxLength":4096,"type":["string","null"]},"range":{"description":"How far back from now to read. One hour when neither `range` nor `from` is sent. Ignored when `from` is sent.","oneOf":[{"$ref":"#/components/schemas/LogsRange"},{"type":"null"}]},"sites":{"description":"The sites of this CoreCluster to read, by site row id. At most 200. Every site you can see when left out.\nA site that is not on this CoreCluster, or that you cannot see, answers `404`.\n","items":{"minimum":1,"type":"integer"},"maxItems":200,"type":["array","null"],"uniqueItems":true},"source":{"$ref":"#/components/schemas/LogsSource"},"to":{"description":"The end of the time range, as a date and time. Now when left out.","type":["string","null"]}},"type":"object"},"ClusterLogsSavedQueryRequest":{"allOf":[{"$ref":"#/components/schemas/LogsSavedQueryFields"},{"properties":{"cluster_id":{"description":"The `{cluster}` of the request, to keep the query for this CoreCluster. Left out or null, the query is kept for everywhere.","minimum":1,"type":["integer","null"]}},"type":"object"}],"description":"A query to save from a CoreCluster."},"ClusterLogsStreams":{"allOf":[{"$ref":"#/components/schemas/LogsStreams"},{"properties":{"sites":{"description":"Each site of the CoreCluster that you can see.","items":{"properties":{"available":{"description":"True when the site's logs are in the read.","type":"boolean"},"environment":{"type":"string"},"id":{"description":"The site row id, as `sites` takes it.","minimum":1,"type":"integer"},"label":{"type":"string"}},"required":["id","label","environment","available"],"type":"object"},"type":"array"}},"required":["sites"],"type":"object"}],"description":"What a read of a CoreCluster's logs can ask for."},"ClusterMaintenanceWindow":{"additionalProperties":true,"description":"A CoreCluster's default maintenance window.","properties":{"cluster":{"$ref":"#/components/schemas/ClusterRef"},"edit_refusal":{"$ref":"#/components/schemas/MaintenanceWindowEditRefusal"},"editable":{"type":"boolean"},"effective":{"$ref":"#/components/schemas/MaintenanceWindowEffective"},"inherited":{"$ref":"#/components/schemas/MaintenanceWindowInherited"},"overrides":{"description":"The sites of the CoreCluster that have a window of their own.","properties":{"count":{"type":"integer"},"sites":{"items":{"properties":{"domain":{"type":"string"},"id":{"minimum":1,"type":"integer"},"start_hour":{"maximum":23,"minimum":0,"type":"integer"}},"required":["id","domain","start_hour"],"type":"object"},"type":"array"}},"required":["count","sites"],"type":"object"},"own":{"$ref":"#/components/schemas/MaintenanceWindowOwn"},"restamped":{"description":"Sent after a change: how many queued changes moved to the new window.","type":"integer"}},"required":["cluster","effective","own","inherited","overrides","editable"],"type":"object"},"ClusterNotEmptyRefusal":{"description":"Something is still on the CoreCluster and `allow_non_empty` was not true.","properties":{"code":{"const":"cluster_not_empty","type":"string"},"details":{"properties":{"preflight":{"description":"The name of the MCP tool that lists what is on the CoreCluster. On this API, read `GET /corestack/clusters/{cluster}/deletion`.","type":"string"},"totals":{"$ref":"#/components/schemas/ClusterDeletionTotals"}},"required":["totals","preflight"],"type":"object"},"message":{"type":"string"},"reason":{"const":"cluster_not_empty","type":"string"}},"required":["message","reason","code","details"],"type":"object"},"ClusterPackageCapacityRequest":{"additionalProperties":false,"description":"No other field is accepted. `sites` and `environments` hold at most 50 rows between them.","properties":{"environments":{"items":{"$ref":"#/components/schemas/ClusterCapacityRow"},"maxItems":50,"type":"array"},"package":{"description":"The key of a CoreCluster package, such as `xsmall`.","type":"string"},"region":{"enum":["uk","us","nl","aus"],"type":"string"},"remove":{"description":"Always empty or left out. There is nothing to take away before the CoreCluster exists.","maxItems":0,"type":"array"},"sites":{"items":{"$ref":"#/components/schemas/ClusterCapacityRow"},"maxItems":50,"type":"array"}},"required":["package","region"],"type":"object"},"ClusterProgress":{"additionalProperties":true,"properties":{"cluster":{"$ref":"#/components/schemas/Cluster"},"copy":{"description":"A sentence about how long the create usually takes, when there is one.","type":["string","null"]},"elapsed_seconds":{"type":["integer","null"]},"eta_seconds":{"description":"Roughly how long is left. Null when there is no estimate.","type":["integer","null"]},"failed":{"additionalProperties":true,"description":"Set when the create has failed. Null otherwise.","examples":[{"can_retry":false,"error":"The cluster's SSH gateway is not ready. Contact support.","stage":"gateway_ready"}],"properties":{"can_retry":{"description":"Always false. Delete the CoreCluster and create it again, or contact support.","type":"boolean"},"error":{"type":"string"},"stage":{"description":"The key of the stage the create failed on.","type":"string"}},"required":["stage","error","can_retry"],"type":["object","null"]},"operation":{"$ref":"#/components/schemas/Operation"},"order":{"description":"The order that created the CoreCluster, when one did. Null otherwise.","type":["object","null"]},"retrying":{"additionalProperties":true,"description":"Set while a step that failed is being tried again automatically. Null otherwise.","examples":[{"attempt":2,"attempts":null,"message":"Setting up your cluster is taking longer than usual. We are trying again automatically.","next_attempt_at":"2026-11-14T10:29:48+00:00","since":"2026-11-14T10:14:02+00:00","stage":"requested"}],"properties":{"attempt":{"minimum":1,"type":"integer"},"attempts":{"description":"How many attempts the step gets. Null when it is tried until the create's own time limit.","type":["integer","null"]},"message":{"type":"string"},"next_attempt_at":{"format":"date-time","type":["string","null"]},"since":{"format":"date-time","type":["string","null"]},"stage":{"description":"The key of the stage being tried again.","type":"string"}},"required":["stage","attempt","attempts","since","next_attempt_at","message"],"type":["object","null"]},"sites":{"description":"The first sites, each with its own operation and progress.","items":{"properties":{"lifecycle":{"type":"string"},"operation":{"$ref":"#/components/schemas/Operation"},"progress":{"description":"The site's own create progress. Null until the site's create has been picked up.","oneOf":[{"$ref":"#/components/schemas/SiteProvisioningProgress"},{"type":"null"}]},"site":{"properties":{"content":{"type":"string"},"domain":{"type":"string"},"id":{"minimum":1,"type":"integer"},"platform":{"type":"string"}},"required":["id","domain","platform","content"],"type":"object"}},"required":["site","lifecycle","operation","progress"],"type":"object"},"type":"array"},"stages":{"description":"The stages of the create, in order. A CoreCluster with no first sites skips the site stages.","items":{"$ref":"#/components/schemas/ProgressStage"},"type":"array"}},"required":["cluster","operation","stages","elapsed_seconds","eta_seconds","sites","retrying","failed"],"type":"object"},"ClusterRef":{"additionalProperties":true,"description":"A cluster by its id and name. A standalone CoreStack site reads `CoreStack` as the name.","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"ClusterSite":{"allOf":[{"$ref":"#/components/schemas/SiteSummary"},{"properties":{"environment_count":{"description":"How many environments the site has besides production.","type":"integer"},"environments":{"description":"Every row of the site, the production row first.","items":{"$ref":"#/components/schemas/EnvironmentRef"},"type":"array"}},"required":["environments","environment_count"],"type":"object"}],"description":"One site of the CoreCluster, as its production row, with its environments."},"ClusterUsage":{"allOf":[{"$ref":"#/components/schemas/Usage"},{"properties":{"allowance":{"description":"What the package allows.","properties":{"cpu_millicores":{"type":["integer","null"]},"disk_bytes":{"type":["integer","null"]},"memory_bytes":{"type":["integer","null"]}},"type":"object"},"coverage":{"description":"One point for each step: the time in epoch milliseconds, how many sites reported, and how many sites there are.","items":{"items":{"type":["number","null"]},"type":"array"},"type":"array"}},"required":["coverage","allowance"],"type":"object"}],"description":"The shared `Usage`, summed over the CoreCluster's sites, with `coverage` and `allowance` added."},"Command":{"additionalProperties":true,"description":"One run of a platform tool or another command on a site.","properties":{"blocked_until_verified":{"type":"boolean"},"duration_ms":{"type":["integer","null"]},"error":{"type":["string","null"]},"exit_code":{"type":["integer","null"]},"finished_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"input":{"description":"The inputs the run was given. Never a secret."},"kind":{"description":"The key of what ran, such as `flush_cache`.","type":"string"},"label":{"type":"string"},"operation_id":{"type":["integer","null"]},"output_excerpt":{"type":["string","null"]},"queued_at":{"format":"date-time","type":["string","null"]},"requested_by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"result":{"description":"What the run answered, by tool."},"site":{"$ref":"#/components/schemas/SiteRef"},"started_at":{"format":"date-time","type":["string","null"]},"status":{"$ref":"#/components/schemas/CommandStatus"},"status_label":{"type":"string"}},"required":["id","kind","label","site","status","status_label","result","error","queued_at","started_at","finished_at"],"type":"object"},"CommandStatus":{"description":"`succeeded`, `failed`, `timed_out` and `lost` are final.","enum":["queued","running","succeeded","failed","timed_out","lost"],"type":"string"},"Company":{"additionalProperties":false,"description":"A company. Ids are sent as strings.","properties":{"address":{"type":["string","null"]},"country":{"description":"The company's country, as it is stored on the company.","type":["string","null"]},"id":{"description":"The company's id, as a string of digits.","type":"string"},"name":{"type":"string"},"phone":{"type":["string","null"]}},"required":["id","name","phone","address","country"],"type":"object"},"CompanyDeploySecret":{"description":"One saved registry credential of a company. Never its token or its username.","properties":{"auth_type":{"enum":["http-basic","bearer","github-oauth","gitlab-token",null],"type":["string","null"]},"id":{"type":"integer"},"kind":{"enum":["npm","composer"],"type":"string"},"label":{"type":"string"},"last4":{"description":"The last four characters of the token. Null for a token shorter than 12 characters.","type":["string","null"]},"last_used_at":{"type":["string","null"]},"registry":{"description":"An npm registry's HTTPS URL, with one trailing slash; a Composer registry's host. Both in lower case.","type":"string"},"scope":{"description":"The npm scope the credential is for. An empty string for the default registry and for Composer.","type":"string"},"shared_with_managed":{"type":"boolean"},"used_by":{"properties":{"environments":{"type":"integer"},"overridden_on":{"description":"Environments that have a credential of their own for this registry.","type":"integer"}},"required":["environments","overridden_on"],"type":"object"},"verified_at":{"type":["string","null"]}},"required":["id","kind","label","registry","scope","auth_type","last4","verified_at","last_used_at","shared_with_managed","used_by"],"type":"object"},"CompanyDeploySecretCreateRequest":{"additionalProperties":false,"allOf":[{"if":{"properties":{"kind":{"const":"composer"}},"required":["kind"]},"then":{"required":["auth_type"]}},{"if":{"properties":{"auth_type":{"const":"http-basic"},"kind":{"const":"composer"}},"required":["kind","auth_type"]},"then":{"required":["username"]}}],"properties":{"auth_type":{"description":"For Composer, how the registry signs in. Required when `kind` is `composer`.","enum":["http-basic","bearer","github-oauth","gitlab-token"],"type":"string"},"kind":{"enum":["npm","composer"],"type":"string"},"label":{"maxLength":255,"minLength":1,"type":"string"},"registry":{"description":"For npm, the registry's HTTPS URL. For Composer, its host name, with a port if it needs one.","maxLength":255,"type":"string"},"scope":{"description":"For npm only, the scope the credential is for, such as `@example`: `@`, then letters, digits, dots,\nhyphens and underscores, starting with a letter or digit. Leave out for the default registry.\n","maxLength":214,"type":"string"},"shared_with_managed":{"description":"For an agency only, also give the credential to the sites it manages for its clients.","type":"boolean"},"token":{"description":"The token or password, kept exactly as sent. No line breaks or control characters; an npm token may not contain `${`.","maxLength":4096,"minLength":1,"type":"string","writeOnly":true},"username":{"description":"For Composer with `http-basic`, the username, which is then required. No line breaks or control characters.","maxLength":255,"minLength":1,"type":"string"},"verify":{"description":"Ask the registry once, after the save, whether it accepts the credential.","type":"boolean"}},"required":["kind","label","registry","token"],"type":"object"},"CompanyDeploySecretList":{"properties":{"can_share":{"type":"boolean"},"data":{"items":{"$ref":"#/components/schemas/CompanyDeploySecret"},"type":"array"},"verification":{"description":"What the registry answered. Present only when the request sent `verify` true.","properties":{"id":{"type":"integer"},"message":{"type":"string"},"verified":{"type":"boolean"},"verified_at":{"type":["string","null"]}},"required":["id","verified","verified_at","message"],"type":"object"}},"required":["data","can_share"],"type":"object"},"CompanyDeploySecretUpdateRequest":{"additionalProperties":false,"description":"Any of the fields of a new credential but `kind`, or `verify` true on its own. At least one. The credential\nis checked as a whole after the change, so a Composer credential changed to `http-basic` needs a `username`\nunless it already holds one.\n","minProperties":1,"properties":{"auth_type":{"enum":["http-basic","bearer","github-oauth","gitlab-token"],"type":"string"},"label":{"maxLength":255,"minLength":1,"type":"string"},"registry":{"maxLength":255,"type":"string"},"scope":{"maxLength":214,"type":"string"},"shared_with_managed":{"description":"For an agency only, also give the credential to the sites it manages for its clients.","type":"boolean"},"token":{"maxLength":4096,"minLength":1,"type":"string","writeOnly":true},"username":{"maxLength":255,"minLength":1,"type":"string"},"verify":{"description":"Ask the registry whether it accepts the credential, after any change in the same request.","type":"boolean"}},"type":"object"},"CompanyDeployVariable":{"description":"One company deployment variable. Never its value.","properties":{"masked":{"description":"The mask shown in place of the value. A value of 16 characters or more also shows its last four.","type":"string"},"name":{"type":"string"},"shared_with_managed":{"description":"Whether an agency shares the variable with the sites it manages for its clients.","type":"boolean"},"tool_credential":{"description":"A sentence saying the build tool named never reads this variable, when the name is one a build tool reads its own credentials from. Null otherwise.","type":["string","null"]},"updated_at":{"type":["string","null"]},"updated_by":{"description":"The name of the person who last changed it.","type":["string","null"]},"used_by":{"properties":{"environments":{"description":"Environments the variable reaches.","type":"integer"},"not_set_on":{"description":"Environments whose commands read the variable and do not receive it.","type":"integer"},"overridden_on":{"description":"Environments that have a variable of their own with this name.","type":"integer"}},"required":["environments","overridden_on","not_set_on"],"type":"object"}},"required":["name","masked","shared_with_managed","updated_at","updated_by","used_by","tool_credential"],"type":"object"},"CompanyDeployVariableList":{"properties":{"can_share":{"description":"Whether the company can share variables with sites it manages. True for an agency.","type":"boolean"},"data":{"items":{"$ref":"#/components/schemas/CompanyDeployVariable"},"type":"array"}},"required":["data","can_share"],"type":"object"},"CompanyDeployVariableSetRequest":{"additionalProperties":false,"properties":{"shared_with_managed":{"description":"For an agency only, also give the variable to the sites it manages for its clients.","type":"boolean"},"value":{"description":"The value, kept exactly as sent. Leave out to change only `shared_with_managed`.","maxLength":2048,"type":"string"}},"type":"object"},"CompanyList":{"properties":{"companies":{"items":{"$ref":"#/components/schemas/Company"},"type":"array"}},"required":["companies"],"type":"object"},"CompanyMaintenanceWindow":{"additionalProperties":true,"description":"Your company's default maintenance window.","properties":{"company":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"edit_refusal":{"$ref":"#/components/schemas/MaintenanceWindowEditRefusal"},"editable":{"type":"boolean"},"effective":{"$ref":"#/components/schemas/MaintenanceWindowEffective"},"inherited":{"$ref":"#/components/schemas/MaintenanceWindowInherited"},"own":{"$ref":"#/components/schemas/MaintenanceWindowOwn"},"reach":{"description":"How many sites and CoreClusters the default reaches.","properties":{"clusters":{"type":"integer"},"sites":{"type":"integer"}},"required":["sites","clusters"],"type":"object"},"restamped":{"description":"Sent after a change: how many queued changes moved to the new window.","type":"integer"}},"required":["company","effective","own","inherited","reach","editable"],"type":"object"},"CompanyOrder":{"properties":{"continue_href":{"description":"For your own order in progress, where to carry on.","type":["string","null"]},"created_at":{"format":"date-time","type":["string","null"]},"ended_at":{"description":"When the order completed, failed, was cancelled or expired.","format":"date-time","type":["string","null"]},"id":{"description":"The order number.","minimum":1,"type":"integer"},"label":{"enum":["in_progress","building","completed","failed","cancelled","expired"],"type":"string"},"line":{"enum":["cs","cc",null],"type":["string","null"]},"line_label":{"type":["string","null"]},"mine":{"description":"Whether you placed it. Only the person who placed an order can continue it.","type":"boolean"},"name":{"description":"The site's domain or the CoreCluster's name.","type":["string","null"]},"package":{"type":["string","null"]},"phase":{"description":"For an order being built, how far it is.","enum":["requesting","retrying","no_room",null],"type":["string","null"]},"placed_at":{"description":"When the order was placed. `null` for one that was not.","format":"date-time","type":["string","null"]},"placed_by":{"oneOf":[{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},{"type":"null"}]},"platform":{"description":"The platform of a CoreStack site, by its name.","type":["string","null"]},"reason":{"description":"Where the order stands, in a sentence.","type":"string"},"region":{"oneOf":[{"properties":{"key":{"type":"string"},"label":{"type":["string","null"]}},"required":["key","label"],"type":"object"},{"type":"null"}]},"restart_href":{"description":"For an order that was cancelled, expired or failed, the order page with the same choices made.","type":["string","null"]},"status_href":{"description":"The order's status page, as a path.","type":"string"},"step":{"description":"For an order in progress, the step it stopped at.","enum":["package","upgrades","account","verify","billing","review",null],"type":["string","null"]},"step_label":{"type":["string","null"]},"target":{"description":"For a completed order, the site or CoreCluster it made, with its page in the Control Panel.","oneOf":[{"properties":{"href":{"type":"string"},"kind":{"enum":["site","cluster"],"type":"string"},"name":{"type":"string"}},"required":["kind","name","href"],"type":"object"},{"type":"null"}]},"trial_ends_at":{"format":"date-time","type":["string","null"]},"vat":{"properties":{"check_open":{"description":"Whether Corefinity still has to check the order's VAT.","type":"boolean"},"kind":{"type":["string","null"]},"status":{"type":["string","null"]}},"required":["kind","status","check_open"],"type":"object"}},"required":["id","line","line_label","package","platform","name","region","created_at","placed_at","ended_at","placed_by","mine","label","reason","step","step_label","phase","trial_ends_at","target","status_href","continue_href","restart_href","vat"],"type":"object"},"CompanyOrderPage":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"company":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"counts":{"description":"How many orders are in each state, after `kind`, `user_id` and `search`.","properties":{"all":{"type":"integer"},"completed":{"type":"integer"},"ended":{"type":"integer"},"failed":{"type":"integer"},"open":{"type":"integer"}},"required":["all","open","completed","failed","ended"],"type":"object"},"data":{"items":{"$ref":"#/components/schemas/CompanyOrder"},"type":"array"},"placers":{"description":"The people who placed one of the orders.","items":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"start_href":{"description":"Where a new order starts, as a path.","type":"string"},"total":{"description":"How many orders there are, whatever the filters.","type":"integer"}},"required":["company","data","counts","total","placers","start_href"],"type":"object"}]},"ConfirmMismatchRefusal":{"additionalProperties":true,"description":"A typed confirmation that does not match what it confirms. `field` names the confirmation.","properties":{"code":{"const":"confirm_mismatch","type":"string"},"errors":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"field":{"type":"string"},"message":{"type":"string"},"reason":{"const":"confirm_mismatch","type":"string"}},"required":["message","reason","code","field"],"type":"object"},"CopyItem":{"description":"One line of a list, with a stable key.","properties":{"key":{"description":"A stable key for the line.","type":"string"},"label":{"description":"The line in plain words.","type":"string"}},"required":["key","label"],"type":"object"},"CopyQueueEntry":{"description":"A copy that waits its turn, as the Control Panel, this API and an MCP client all show it.","properties":{"ahead":{"description":"How many copies on the same website are in front of this one. Null once it is no longer in the queue.","type":["integer","null"]},"deadline_at":{"description":"When the copy stops waiting. Six hours after it was queued, by default.","format":"date-time","type":["string","null"]},"ended_at":{"description":"When it started, was cancelled, was refused or expired.","format":"date-time","type":["string","null"]},"id":{"description":"The id `getQueuedCopy` and `cancelQueuedCopy` take.","minimum":1,"type":"integer"},"message":{"description":"The same in plain words. Null once it has started.","type":["string","null"]},"operation_id":{"description":"The copy's operation once it has started, for `getOperation`.","minimum":1,"type":["integer","null"]},"queued_at":{"description":"When the copy was queued.","format":"date-time","type":["string","null"]},"reason":{"description":"A stable code for why it waits or why it ended, such as `target_busy`, `clone_in_progress`, `busy`,\n`snapshot_slot`, `cancelled`, `access_ended` or `two_factor_required`. Null once it has started.\n","type":["string","null"]},"source":{"description":"The environment the copy comes from. Null when you may not see that environment (a copy from another\nwebsite), where `message` calls it \"the environment it copies from\", and when it no longer exists.\n","oneOf":[{"$ref":"#/components/schemas/CopyQueueEnvironment"},{"type":"null"}]},"state":{"description":"`waiting` or `starting` while it is in the queue; `started` once the copy runs (follow `operation_id`);\n`refused` when a rule failed as it started, or the access that queued it has ended; `expired` when it could\nnot start before `deadline_at`; `cancelled`.\n","enum":["waiting","starting","started","refused","expired","cancelled"],"type":"string"},"target":{"$ref":"#/components/schemas/CopyQueueEnvironment"}},"required":["id","state","reason","message","ahead","source","target","operation_id","queued_at","deadline_at","ended_at"],"type":"object"},"CopyQueueEnvironment":{"description":"An environment of a queued copy. Unlike the shared `Named`, `name` is null once the environment is gone.","properties":{"id":{"description":"The environment's site row id, the `{site}` of `/corestack/sites/{site}`.","minimum":1,"type":"integer"},"name":{"description":"The environment's name. Null for a target that no longer exists.","type":["string","null"]}},"required":["id","name"],"type":"object"},"CopyQueueResult":{"properties":{"queued":{"$ref":"#/components/schemas/CopyQueueEntry"}},"required":["queued"],"type":"object"},"CredentialsDatabaseLogin":{"description":"The login a site's application uses for its own database.","properties":{"host":{"description":"The database's address as the site itself reaches it. It is not reachable from outside the site.","type":"string"},"name":{"description":"The database's name.","type":"string"},"password":{"description":"The password, in plain text.","type":"string"},"port":{"type":"integer"},"revealed_at":{"format":"date-time","type":"string"},"username":{"type":"string"}},"required":["host","port","name","username","password","revealed_at"],"type":"object"},"CronBuiltin":{"description":"The task the platform needs for itself. You can switch it off and on, but not edit or remove it.","properties":{"active":{"description":"True when both this switch and the site's `enabled` are on, so the task runs.","type":"boolean"},"command":{"type":"string"},"enabled":{"description":"The task's own switch.","type":"boolean"},"label":{"type":"string"},"last_run":{"oneOf":[{"$ref":"#/components/schemas/CronRun"},{"type":"null"}]},"locked":{"description":"Always true. The task cannot be edited or removed.","type":"boolean"},"note":{"type":["string","null"]},"schedule":{"type":"string"},"timeout":{"description":"The longest a run may take, in seconds.","type":["integer","null"]},"toggleable":{"description":"Always true. The task has a switch of its own, `builtin_enabled` on a save.","type":"boolean"}},"required":["label","schedule","command","locked","toggleable","enabled","active","note","timeout","last_run"],"type":"object"},"CronEntry":{"description":"One scheduled task.","properties":{"command":{"type":"string"},"enabled":{"type":"boolean"},"id":{"minimum":1,"type":"integer"},"label":{"type":"string"},"last_run":{"oneOf":[{"$ref":"#/components/schemas/CronRun"},{"type":"null"}]},"next_run_at":{"description":"Null while the task or the site's switch is off.","format":"date-time","type":["string","null"]},"no_overlap":{"description":"True skips a run while the previous one is still going.","type":"boolean"},"position":{"description":"The task's place in the set, starting at 1.","type":"integer"},"schedule":{"description":"Five cron fields.","type":"string"},"schedule_label":{"description":"The schedule in words.","type":"string"},"timeout":{"description":"The longest a run may take, in seconds.","type":"integer"}},"required":["id","position","label","schedule","schedule_label","command","enabled","no_overlap","timeout","next_run_at","last_run"],"type":"object"},"CronEntryInput":{"description":"A task as a save sends it.","properties":{"command":{"description":"The command to run. A command that could harm the site or reach outside it, or that has a password or key\nwritten in it, is refused.\n","maxLength":500,"type":"string"},"enabled":{"default":true,"type":"boolean"},"id":{"description":"The id of a task to keep. Leave it out to add a task.","minimum":1,"type":"integer"},"label":{"description":"One line of plain text, not blank, unique within the site whatever its letters' case.","maxLength":60,"minLength":1,"type":"string"},"no_overlap":{"default":true,"type":"boolean"},"schedule":{"description":"Five cron fields (minute, hour, day of month, month, day of week).","examples":["*/15 * * * *"],"type":"string"},"timeout":{"default":3600,"enum":[900,3600,21600],"type":"integer"}},"required":["label","schedule","command"],"type":"object"},"CronLimits":{"properties":{"command_max":{"description":"The most characters in a command.","type":"integer"},"entries_max":{"description":"The most tasks a site can have, not counting the built-in task.","type":"integer"},"label_max":{"description":"The most characters in a label.","type":"integer"},"min_interval_seconds":{"type":"integer"},"timeouts":{"description":"The values `timeout` accepts, in seconds.","items":{"type":"integer"},"type":"array"}},"required":["entries_max","command_max","label_max","min_interval_seconds","timeouts"],"type":"object"},"CronPreset":{"properties":{"key":{"type":"string"},"label":{"type":"string"},"schedule":{"type":"string"}},"required":["key","label","schedule"],"type":"object"},"CronRemovalRefusal":{"description":"Tasks were left out of a save without their labels in `confirm_labels`.","properties":{"code":{"const":"confirm_mismatch","type":"string"},"field":{"const":"confirm_labels","type":"string"},"labels":{"description":"Every label to send in `confirm_labels`.","items":{"type":"string"},"type":"array"},"message":{"type":"string"},"reason":{"const":"confirm_mismatch","type":"string"}},"required":["message","reason","code","field","labels"],"type":"object"},"CronRun":{"description":"The last finished run of a task.","properties":{"at":{"description":"When the run ended, in UTC.","format":"date-time","type":"string"},"duration_s":{"type":["integer","null"]},"exit_code":{"type":"integer"},"status":{"enum":["ok","failed","timed_out","skipped"],"type":"string"}},"required":["at","status","exit_code","duration_s"],"type":"object"},"CronSaveResult":{"properties":{"crons":{"$ref":"#/components/schemas/CronSet"},"operation":{"description":"The operation applying the change, or null when nothing that runs changed.","oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"warnings":{"description":"One line for each task kept unchanged with a password or key written in its command. Left out when there\nis none.\n","items":{"type":"string"},"type":"array"}},"required":["crons","operation"],"type":"object"},"CronSet":{"description":"A site's scheduled tasks.","properties":{"apply":{"$ref":"#/components/schemas/ApplyState"},"builtin":{"$ref":"#/components/schemas/CronBuiltin"},"enabled":{"description":"Whether scheduled tasks run on this site at all.","type":"boolean"},"enabled_default":{"description":"What `enabled` starts as for this kind of site.","type":"boolean"},"entries":{"items":{"$ref":"#/components/schemas/CronEntry"},"type":"array"},"limits":{"$ref":"#/components/schemas/CronLimits"},"presets":{"description":"Schedules the Control Panel offers when you add a task.","items":{"$ref":"#/components/schemas/CronPreset"},"type":"array"},"runs":{"description":"The last finished run of each task, keyed `builtin` for the built-in task and `c<id>` for a task. An empty\nobject before the first run; null when the runs cannot be read at the moment.\n","oneOf":[{"additionalProperties":{"$ref":"#/components/schemas/CronRun"},"type":"object"},{"type":"null"}]},"timezone":{"description":"The time zone every schedule is read in.","examples":["Europe/London"],"type":"string"},"version":{"description":"Send this back with a save. It changes whenever the set changes.","minimum":0,"type":"integer"}},"required":["version","enabled","enabled_default","timezone","builtin","entries","presets","runs","apply","limits"],"type":"object"},"CronSetUpdate":{"properties":{"builtin_enabled":{"description":"The built-in task's switch. Leave it out, or send null, to keep it as it is.","type":["boolean","null"]},"confirm_labels":{"description":"The exact label of each task the save removes. Asked for only while removal confirmation is on for the\nAPI; otherwise it is accepted and ignored. It is checked either way: more than 49 labels, or one longer\nthan 60 characters, is refused `invalid`.\n","items":{"maxLength":60,"type":"string"},"maxItems":49,"type":"array"},"enabled":{"description":"Whether scheduled tasks run on this site at all.","type":"boolean"},"entries":{"description":"Every task the site should have after the save, in order.","items":{"$ref":"#/components/schemas/CronEntryInput"},"maxItems":49,"type":"array"},"version":{"description":"The `version` you read.","minimum":0,"type":"integer"}},"required":["version","enabled","entries"],"type":"object"},"CronValidateRequest":{"anyOf":[{"required":["schedule"]},{"required":["command"]}],"description":"Send a `schedule`, a `command` or both.","properties":{"command":{"description":"Checked against the same rules as a saved command, including its 500 character limit.","maxLength":20000,"type":["string","null"]},"schedule":{"maxLength":200,"type":["string","null"]}},"type":"object"},"CronValidateResult":{"properties":{"errors":{"additionalProperties":{"type":"string"},"description":"What was refused, keyed by the schedule field (`minute`, `hour` and so on) or `command`. An empty object\nwhen nothing was.\n","type":"object"},"human":{"description":"The schedule in words. Null when no valid schedule was sent.","type":["string","null"]},"next_runs":{"description":"The next three runs.","items":{"format":"date-time","type":"string"},"type":"array"},"normalised":{"description":"The schedule as it would be saved.","type":["string","null"]},"valid":{"type":"boolean"},"warnings":{"items":{"type":"string"},"type":"array"}},"required":["valid","human","normalised","next_runs","errors","warnings"],"type":"object"},"CursorPage":{"description":"The paging field of a cursor-paged list. The list itself sits beside it under a key each endpoint names, such\nas `items` or `sites`.\n","properties":{"next_cursor":{"description":"Send as `cursor` to read the next page. Null on the last page.","type":["string","null"]}},"required":["next_cursor"],"type":"object"},"DatabaseConnection":{"description":"How the site itself, and a client through an SSH tunnel, reach the database. Never a username or a password.","properties":{"database":{"description":"The database's name.","type":"string"},"engine":{"type":"string"},"host":{"description":"The database's address as the site itself reaches it. It is not reachable from outside the site.","type":"string"},"port":{"type":"integer"},"ssh_tunnel":{"description":"A command that opens an SSH tunnel to the database from your own computer. Null when the site has no SSH address yet.","type":["string","null"]},"version":{"description":"The major and minor version, such as `11.4`.","type":["string","null"]}},"required":["engine","version","host","port","database","ssh_tunnel"],"type":"object"},"DatabaseExternalAccess":{"properties":{"address":{"description":"The fixed public address behind `host`.","type":["string","null"]},"available":{"description":"Whether external access can be turned on for this environment.","type":"boolean"},"database":{"type":"string"},"enabled_at":{"format":"date-time","type":["string","null"]},"enabled_by":{"type":["string","null"]},"host":{"description":"The host name an outside system connects to. Null until access has been on.","type":["string","null"]},"moved_at":{"description":"When the environment last moved to another address, if it has. Like `enabled_at` and `added_at`, it carries a `+00:00` offset rather than `Z`.","format":"date-time","type":["string","null"]},"operation":{"description":"The change to external access that is running, or the last one when it failed. Null otherwise.","oneOf":[{"properties":{"action":{"type":"string"},"id":{"minimum":1,"type":"integer"},"status":{"$ref":"#/components/schemas/OperationStatus"},"step":{"type":["string","null"]},"steps":{"items":{"type":"string"},"type":"array"}},"required":["id","action","status","step","steps"],"type":"object"},{"type":"null"}]},"port":{"type":"integer"},"price":{"description":"What access costs on this environment. Null when it is charged on no running contract.","oneOf":[{"properties":{"amount":{"description":"The charge for each period, as a decimal string.","type":"string"},"billed_on":{"description":"The contract the add-on is charged on.","enum":["corestack","corecluster"],"type":"string"},"currency":{"type":"string"},"label":{"description":"The name of the add-on on your contract.","type":"string"},"period":{"type":"string"}},"required":["amount","currency","period","label","billed_on"],"type":"object"},{"type":"null"}]},"sanitised":{"description":"True when this environment's data is an anonymised copy.","type":"boolean"},"sources":{"description":"The allowed addresses, in address order.","items":{"$ref":"#/components/schemas/DatabaseSource"},"type":"array"},"sources_cap":{"type":"integer"},"status":{"description":"`tonight`: a first turn-on is queued for the maintenance window on `window_date`.","enum":["off","tonight","turning_on","on","turning_off","failed"],"type":"string"},"tls":{"description":"`optional`: a connection may be encrypted, and a user with `require_tls` must be.","type":"string"},"window_date":{"description":"The date of the maintenance window a first turn-on is queued for, as `YYYY-MM-DD`. Null otherwise.","type":["string","null"]}},"required":["status","available","host","port","database","address","tls","price","sources","sources_cap","enabled_at","enabled_by","operation","window_date","sanitised","moved_at"],"type":"object"},"DatabaseExternalDisable":{"properties":{"confirm_environment":{"description":"The environment's name, such as `Production`, in any letter case.","type":"string"}},"required":["confirm_environment"],"type":"object"},"DatabaseExternalEnable":{"properties":{"confirm_cost":{"const":true,"description":"True once you have agreed to the monthly charge.","type":"boolean"},"sources":{"items":{"$ref":"#/components/schemas/DatabaseSourceInput"},"maxItems":10,"minItems":1,"type":"array"}},"required":["sources","confirm_cost"],"type":"object"},"DatabaseExternalQueued":{"properties":{"external":{"$ref":"#/components/schemas/DatabaseExternalAccess"},"operation":{"type":"null"}},"required":["operation","external"],"type":"object"},"DatabaseExternalSources":{"properties":{"sources":{"description":"The whole list, every address to keep included.","items":{"$ref":"#/components/schemas/DatabaseSourceInput"},"maxItems":10,"minItems":1,"type":"array"}},"required":["sources"],"type":"object"},"DatabasePasswordChoice":{"properties":{"mode":{"description":"`generate`: a 24-character password, revealed once. `set`: your own, in `value`.","enum":["generate","set"],"type":"string"},"value":{"description":"Your own password, with `mode: set`. 12 to 64 printable characters, without spaces, quotes, backticks or backslashes.","maxLength":64,"minLength":12,"type":"string"}},"required":["mode"],"type":"object"},"DatabasePasswordRotate":{"properties":{"password":{"$ref":"#/components/schemas/DatabasePasswordChoice"}},"required":["password"],"type":"object"},"DatabaseRevealedPassword":{"properties":{"password":{"description":"The password, in plain text.","type":"string"},"username":{"type":"string"}},"required":["username","password"],"type":"object"},"DatabaseSource":{"properties":{"added_at":{"format":"date-time","type":["string","null"]},"added_by":{"description":"The name of the person who added it.","type":["string","null"]},"cidr":{"description":"The address or block, always written with its prefix length.","type":"string"},"label":{"type":["string","null"]},"pending":{"description":"True while the address is being added.","type":"boolean"}},"required":["cidr","label","added_by","added_at","pending"],"type":"object"},"DatabaseSourceInput":{"properties":{"cidr":{"description":"A public IPv4 address, or a block from `/32` to `/28` written from its first address. Private, shared,\nloopback, link-local, multicast, reserved and documentation ranges are refused.\n","type":"string"},"label":{"maxLength":64,"type":["string","null"]}},"required":["cidr"],"type":"object"},"DatabaseSourcesSaved":{"properties":{"operation":{"type":"null"},"sources":{"items":{"$ref":"#/components/schemas/DatabaseSource"},"type":"array"}},"required":["operation","sources"],"type":"object"},"DatabaseTab":{"properties":{"can":{"description":"What you may do on this environment.","properties":{"edit_sources":{"type":"boolean"},"enable_external":{"description":"Whether you may turn external access on or off, which needs the right to change the site's billing.","type":"boolean"},"manage_users":{"type":"boolean"},"reveal_application":{"type":"boolean"}},"required":["reveal_application","manage_users","enable_external","edit_sources"],"type":"object"},"connection":{"$ref":"#/components/schemas/DatabaseConnection"},"counts":{"properties":{"external":{"description":"How many of them are external.","type":"integer"},"external_cap":{"type":"integer"},"users":{"description":"The users you added.","type":"integer"},"users_cap":{"description":"The most users one environment can hold.","type":"integer"}},"required":["users","users_cap","external","external_cap"],"type":"object"},"external":{"description":"External access. Null while external access is not on for your company.","oneOf":[{"$ref":"#/components/schemas/DatabaseExternalAccess"},{"type":"null"}]},"users":{"description":"The site's own `application` login first, then the users you added.","items":{"$ref":"#/components/schemas/DatabaseUser"},"type":"array"},"viewer_ip":{"description":"The IPv4 address your request came from, or null when it is not IPv4.","type":["string","null"]}},"required":["connection","users","counts","external","can","viewer_ip"],"type":"object"},"DatabaseUser":{"properties":{"actions":{"description":"What you may do with the user now: `reveal` on the `application` login, `edit`, `rotate` and `delete` on a user you added.","items":{"type":"string"},"type":"array"},"added_at":{"format":"date-time","type":["string","null"]},"added_by":{"description":"The name of the person who added the user.","type":["string","null"]},"connects_from":{"enum":["site","internal","external"],"type":"string"},"database":{"type":"string"},"id":{"description":"Absent on the `application` login. Null on a user that is still being added (`pending.action` is `add`), until its operation completes.","minimum":1,"type":["integer","null"]},"kind":{"description":"`protected` is the site's own `application` login, which is never changed from here.","enum":["protected","internal","external"],"type":"string"},"max_statement_time":{"description":"The longest statement, in seconds. Null for no limit. External users only.","type":["integer","null"]},"max_user_connections":{"description":"The most connections at once. Null for no limit. External users only.","type":["integer","null"]},"password_origin":{"description":"`generated`, or a password you set yourself.","type":"string"},"pending":{"description":"The change running on this user, or null.","oneOf":[{"properties":{"action":{"type":"string"},"operation_id":{"minimum":1,"type":"integer"}},"required":["operation_id","action"],"type":"object"},{"type":"null"}]},"require_tls":{"type":"boolean"},"reveal_pending":{"description":"True while a generated password is waiting for you to reveal it.","type":"boolean"},"scope":{"enum":["application","read_only","read_write"],"type":"string"},"username":{"type":"string"}},"required":["username","kind","scope","database","connects_from","actions"],"type":"object"},"DatabaseUserCreate":{"properties":{"confirm_read_write":{"const":"read-write","description":"Sent with `scope: read_write`.","type":"string"},"kind":{"description":"`internal` connects from inside the site only. `external` connects through external access only, which must be on.","enum":["internal","external"],"type":"string"},"max_statement_time":{"description":"The longest statement, in seconds, from 1 to 86400. Null or absent for no limit. External users only.","maximum":86400,"minimum":1,"type":["integer","null"]},"max_user_connections":{"description":"The most connections at once, from 1 to 1000. Null or absent for no limit. External users only.","maximum":1000,"minimum":1,"type":["integer","null"]},"password":{"$ref":"#/components/schemas/DatabasePasswordChoice"},"require_tls":{"description":"Refuse connections that are not encrypted. External users only.","type":"boolean"},"scope":{"description":"`read_only`: `SELECT` and `SHOW VIEW`. `read_write`: also changing and deleting data.","enum":["read_only","read_write"],"type":"string"},"username":{"description":"3 to 32 lower-case letters, digits and underscores, starting with a letter. Some names are kept for the platform.","maxLength":32,"minLength":3,"pattern":"^[a-z][a-z0-9_]*$","type":"string"}},"required":["kind","username","scope","password"],"type":"object"},"DatabaseUserUpdate":{"properties":{"confirm_read_write":{"const":"read-write","description":"Sent with `scope: read_write`.","type":"string"},"max_statement_time":{"description":"In seconds, from 1 to 86400. Null clears the limit. External users only.","maximum":86400,"minimum":1,"type":["integer","null"]},"max_user_connections":{"description":"From 1 to 1000. Null clears the limit. External users only.","maximum":1000,"minimum":1,"type":["integer","null"]},"require_tls":{"description":"External users only.","type":"boolean"},"scope":{"enum":["read_only","read_write"],"type":"string"}},"type":"object"},"Demo":{"properties":{"days_left":{"description":"Whole days until the demo ends. `null` unless the demo is `active`.","type":["integer","null"]},"ends_at":{"format":"date-time","type":["string","null"]},"grace_ends_at":{"description":"Until when an ended demo can still be kept.","format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"keep":{"additionalProperties":false,"properties":{"allowed":{"description":"Whether you could keep it now.","type":"boolean"},"refusal":{"description":"Why you cannot keep it now, as Keep would refuse it. `null` when you can, while it is `building`, and once it is kept or closed.","oneOf":[{"additionalProperties":true,"properties":{"keep_url":{"format":"uri","type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["message","reason"],"type":"object"},{"type":"null"}]},"url":{"description":"The Keep page in the Control Panel.","format":"uri","type":"string"}},"required":["allowed","refusal","url"],"type":"object"},"kept_at":{"format":"date-time","type":["string","null"]},"package":{"description":"The package the demo is on, such as `CS4`.","type":["string","null"]},"price_after":{"description":"What it costs a month once kept as it is. `null` when it cannot be priced.","oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"product_line":{"description":"`CS` for a CoreStack site, `CC` for a CoreCluster.","type":["string","null"]},"region":{"description":"The region's code, such as `uk`.","type":["string","null"]},"starts_at":{"format":"date-time","type":["string","null"]},"state":{"description":"`building` while it is set up, `active` while it runs, `ended` once its time is up and it waits in its\ngrace period, `kept`, or `closed`.\n","enum":["building","active","ended","kept","closed"],"type":"string"},"target":{"additionalProperties":false,"description":"What the demo is of.","properties":{"id":{"description":"The site row's id or the CoreCluster's id.","minimum":1,"type":["integer","null"]},"name":{"description":"The site's domain or the cluster's name.","type":["string","null"]},"type":{"enum":["site","cluster",null],"type":["string","null"]}},"required":["type","id","name"],"type":"object"},"upgrade":{"additionalProperties":false,"properties":{"next":{"description":"The changes of a Keep that still wait to be applied, as a short token. `null` when nothing waits.","type":["string","null"]}},"required":["next"],"type":"object"}},"required":["id","state","product_line","package","region","starts_at","ends_at","days_left","grace_ends_at","kept_at","target","price_after","keep","upgrade"],"type":"object"},"DemoDetail":{"allOf":[{"$ref":"#/components/schemas/Demo"},{"properties":{"progress":{"$ref":"#/components/schemas/DemoProgress"},"upgrade_options":{"description":"The packages the demo can be kept on, from its own upwards, each with its monthly price. Empty once the demo is kept or can no longer be kept.","items":{"additionalProperties":false,"properties":{"monthly":{"oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"package":{"type":"string"}},"required":["package","monthly"],"type":"object"},"type":"array"}},"required":["upgrade_options","progress"],"type":"object"}]},"DemoKeepAnswer":{"additionalProperties":false,"properties":{"demo":{"$ref":"#/components/schemas/Demo"},"kept":{"additionalProperties":false,"properties":{"already":{"description":"Whether the demo was kept before this request.","type":"boolean"},"billed_from":{"description":"When billing starts, the next full hour after the Keep. `null` when the demo was kept already.","format":"date-time","type":["string","null"]},"kept_at":{"format":"date-time","type":"string"},"restored":{"description":"Whether the Keep brought back a site that had been paused when its demo ended.","type":"boolean"},"staging":{"description":"Whether a restored site's staging environment is being made again.","enum":["none","started","refused"],"type":"string"}},"required":["kept_at","billed_from","already","restored","staging"],"type":"object"},"progress":{"$ref":"#/components/schemas/DemoProgress"},"upgrade":{"additionalProperties":true,"description":"The first change the Keep asked for.","properties":{"family_change":{"description":"Only when a CoreCluster's server type change started. It has no operation of its own.","properties":{"family":{"enum":["general","optimised"],"type":"string"},"items":{"description":"The ids of the queued moves, one for each site of the cluster.","items":{"type":"integer"},"type":"array"}},"required":["family","items"],"type":"object"},"message":{"description":"Why the change was refused.","type":["string","null"]},"next":{"description":"The changes still waiting, as a short token.","type":["string","null"]},"operation_id":{"description":"The operation that applies the change. Follow it with `GET /corestack/operations/{operation}`.","minimum":1,"type":["integer","null"]},"reason":{"description":"The refusal's code, or why the change is queued. Absent when no change was asked.","type":["string","null"]},"state":{"description":"`none` when no change was asked, `started` (the answer is `202`), `queued` when it waits because the\nsite or cluster is busy, `refused` when it could not be applied; the demo is kept either way.\n","enum":["none","started","queued","refused"],"type":"string"}},"required":["state","operation_id","message","next"],"type":"object"}},"required":["demo","kept","upgrade","progress"],"type":"object"},"DemoKeepRefusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"},{"properties":{"keep_url":{"description":"The Keep page in the Control Panel, where you finish the missing step.","format":"uri","type":"string"}},"type":"object"}]},"DemoKeepRequest":{"properties":{"accept_privacy":{"description":"Whether you accept Corefinity's privacy notice. Needed the first time your company keeps anything.","type":"boolean"},"addons":{"additionalProperties":false,"description":"Add-on units to keep it with, each a whole number that is the total wanted. A unit you leave out stays as\nit is. The totals are checked before anything is kept: one outside its range, or a disk total that is\nnot a multiple of 10, refuses the Keep (`addon_bounds`).\n","properties":{"cores":{"description":"Extra cores, 0 to 16.","maximum":16,"minimum":0,"type":"integer"},"disk_gb":{"description":"Extra disk in GB, 0 to 102400 in steps of 10.","maximum":102400,"minimum":0,"multipleOf":10,"type":"integer"},"log_storage_gb":{"description":"Extra log storage in GB, 0 to 1000.","maximum":1000,"minimum":0,"type":"integer"},"memory_gb":{"description":"Extra memory in GB, 0 to 64.","maximum":64,"minimum":0,"type":"integer"}},"type":["object","null"]},"confirm_billing_country":{"description":"Your billing country as a two-letter code, to confirm a country the demo set for you.","maxLength":2,"minLength":2,"type":"string"},"confirm_keep":{"description":"The site's domain, or the word `cluster` for a CoreCluster demo. Upper or lower case.","maxLength":253,"type":"string"},"family":{"description":"The server type to keep it on.","enum":["general","optimised",null],"type":["string","null"]},"package":{"description":"A bigger package to keep it on, such as `CS8`. One of the demo's `upgrade_options`.","pattern":"^([cC][sS]|[cC][cC])[0-9]{1,3}$","type":["string","null"]}},"required":["confirm_keep"],"type":"object"},"DemoProgress":{"additionalProperties":false,"description":"Where each change a Keep asked for stands. They are applied one at a time, in the order listed. It is not the\nshared `ProgressStage`: a change has a `plan` and a `kind` in place of a `key` and a `label`, and the times\nof its start and its end.\n","properties":{"changes":{"items":{"additionalProperties":false,"properties":{"ended_at":{"format":"date-time","type":["string","null"]},"kind":{"description":"A package, a server type, or add-on units.","enum":["package","family","addons"],"type":"string"},"operation_id":{"description":"The operation that applies the change, once it has started. Follow it with `GET /corestack/operations/{operation}`. A CoreCluster's server type change has none.","minimum":1,"type":["integer","null"]},"plan":{"description":"The change as a short token, such as `cs8` or `cores2`.","type":"string"},"started_at":{"format":"date-time","type":["string","null"]},"state":{"enum":["waiting","applying","done","failed","started"],"type":"string"}},"required":["plan","kind","state","operation_id","started_at","ended_at"],"type":"object"},"type":"array"},"next":{"description":"The changes still waiting, as a short token such as `cores2`. `null` when nothing waits.","type":["string","null"]},"state":{"description":"`none` when the Keep asked for no change, `applying` while any change waits or runs, `done` when every\none landed, `failed` when one did not (the kept price stands), `started` when a change started and\nthere is nothing to follow it by.\n","enum":["none","applying","done","failed","started"],"type":"string"}},"required":["state","next","changes"],"type":"object"},"DeployTemplate":{"additionalProperties":true,"properties":{"can":{"properties":{"edit":{"description":"Whether you may save this template.","type":"boolean"},"edit_reason":{"description":"Why not, when you may not.","type":["string","null"]}},"required":["edit","edit_reason"],"type":"object"},"chain_note":{"description":"A sentence about the chains the template sits in, when there is more than one.","type":["string","null"]},"company":{"$ref":"#/components/schemas/Named"},"compare":{"description":"Present with `compare_to`. Each stage that differs between the two revisions, with its entry before and after.","properties":{"revision":{"description":"The revision compared with.","type":"integer"},"stages":{"additionalProperties":{"additionalProperties":{"properties":{"after":{"oneOf":[{"$ref":"#/components/schemas/DeployTemplateStageEntry"},{"type":"null"}]},"before":{"oneOf":[{"$ref":"#/components/schemas/DeployTemplateStageEntry"},{"type":"null"}]}},"type":"object"},"type":"object"},"description":"By configuration, then by stage. An empty list when the two revisions hold the same content.","maxItems":0,"type":["object","array"]}},"required":["revision","stages"],"type":"object"},"configs":{"description":"What the company's template sets, for production environments and for the others.","properties":{"production":{"$ref":"#/components/schemas/DeployTemplateConfig"},"uat":{"$ref":"#/components/schemas/DeployTemplateConfig"}},"required":["production","uat"],"type":"object"},"locked":{"description":"Set while Corefinity has locked the template, so it cannot be edited. Null when it can.","properties":{"reason":{"description":"Why, in Corefinity's words.","type":"string"}},"required":["reason"],"type":["object","null"]},"platform":{"type":"string"},"presets":{"properties":{"offered":{"description":"The build presets this platform offers.","items":{"additionalProperties":true,"properties":{"key":{"type":"string"},"kind":{"enum":["platform","frontend"],"type":"string"},"label":{"type":"string"},"node_floor":{"description":"The lowest Node.js major version the preset needs.","type":["integer","null"]},"node_floor_when":{"description":"The lowest Node.js major version an option of the preset needs, by option.","type":["object","null"]}},"required":["key","kind","label"],"type":"object"},"type":"array"}},"required":["offered"],"type":"object"},"revision":{"description":"Send this with a save or a restore.","type":"integer"},"template_id":{"type":["integer","null"]},"upstreams":{"description":"What each stage inherits and what is in effect, once for each chain the template sits in: `none` for the\ncompany's own environments, and one for each agency that manages some of them.\n","items":{"$ref":"#/components/schemas/DeployTemplateUpstream"},"type":"array"}},"required":["template_id","company","platform","revision","configs","upstreams","locked","presets","can"],"type":"object"},"DeployTemplateConfig":{"properties":{"build":{"$ref":"#/components/schemas/DeployTemplateStageEntry"},"database":{"$ref":"#/components/schemas/DeployTemplateStageEntry"},"post_deploy":{"$ref":"#/components/schemas/DeployTemplateStageEntry"},"settings":{"$ref":"#/components/schemas/DeployTemplateStageEntry"}},"required":["build","database","post_deploy","settings"],"type":"object"},"DeployTemplateConfirmation":{"properties":{"confirm_count":{"description":"The dry run's `reach.production_count`.","minimum":0,"type":"integer"},"confirm_production":{"description":"True to confirm a change that reaches production environments.","type":"boolean"},"confirm_targets":{"description":"The `site_id` of every production environment in the dry run's `reach.production`.","items":{"minimum":1,"type":"integer"},"type":"array"},"dry_run":{"description":"Answer the reach and write nothing.","type":"boolean"},"keep_on":{"description":"The `site_id`s of environments that keep their own stage. Every environment the reach lists under `cannot_take` must be named.","items":{"minimum":1,"type":"integer"},"type":"array"}},"type":"object"},"DeployTemplateHooks":{"additionalProperties":{"$ref":"#/components/schemas/DeployTemplateLines"},"description":"Build only, with `mode` `preset`: each hook's own commands under the hook's name, given once, here or inside\n`preset`. An empty list in place of the object sets no hook.\n","maxItems":0,"type":["object","array"]},"DeployTemplateLines":{"description":"Commands to save: a list with one line in each entry, or one string with a line break between lines. Lines are\ntaken as sent. At most 200 commands, where a line that starts with `#` is a comment and is not counted, nor is\nan empty line; and at most 8,192 bytes a line, counting the spaces it starts with but not those at its end.\nMore commands are refused `too_many_lines`, a longer line `line_too_long`. The patterns below count\ncharacters, so a line holding characters of more than one byte is refused sooner than they show.\n","oneOf":[{"contains":{"description":"A command, which is a line that is neither empty nor a comment.","pattern":"^[ \\t\\x00\\x0B]*[^# \\t\\x00\\x0B\\r\\n]","type":"string"},"items":{"description":"One line.","pattern":"^(?:[^\\r\\n]{0,8191}[^ \\t\\x00\\x0B\\r\\n])?[ \\t\\x00\\x0B]*$","type":"string"},"maxContains":200,"minContains":0,"type":"array"},{"not":{"anyOf":[{"description":"More than 200 commands.","pattern":"^(?:[\\r\\n \\t\\x00\\x0B]*(?:#[^\\r\\n]*[\\r\\n][\\r\\n \\t\\x00\\x0B]*)*[^# \\t\\x00\\x0B\\r\\n][^\\r\\n]*[\\r\\n]){200}[\\r\\n \\t\\x00\\x0B]*(?:#[^\\r\\n]*[\\r\\n][\\r\\n \\t\\x00\\x0B]*)*[^# \\t\\x00\\x0B\\r\\n]"},{"description":"A line of more than 8,192 characters before the spaces at its end.","pattern":"(?:^|[\\r\\n])[^\\r\\n]{8192}[^\\r\\n]*[^ \\t\\x00\\x0B\\r\\n]"}]},"type":"string"}]},"DeployTemplateReach":{"additionalProperties":true,"description":"The environments a change would be, or was, written to.","properties":{"cannot_take":{"description":"Environments that cannot take the change as it is. Name each in `keep_on` to leave it on its own stage.","items":{"additionalProperties":true,"type":"object"},"type":"array"},"confirm":{"properties":{"count":{"type":"integer"},"required":{"description":"Whether the save needs the production confirmation.","type":"boolean"}},"required":["required","count"],"type":"object"},"digest":{"description":"A fingerprint of this reach.","type":"string"},"environments":{"type":"integer"},"in_flight":{"description":"Environments with a deployment running, which take the change afterwards.","items":{"additionalProperties":true,"type":"object"},"type":"array"},"list_max":{"description":"The most environments each list names.","type":"integer"},"not_reached":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"production":{"description":"The production environments reached. Send their `site_id`s as `confirm_targets`.","items":{"$ref":"#/components/schemas/DeployTemplateReachRow"},"type":"array"},"production_count":{"description":"The number to send as `confirm_count`.","type":"integer"},"tunnels":{"additionalProperties":true,"type":"object"},"uat":{"items":{"$ref":"#/components/schemas/DeployTemplateReachRow"},"type":"array"},"uat_count":{"type":"integer"},"unchanged":{"description":"Environments that follow the stage and already hold this content.","type":"integer"}},"required":["environments","production_count","uat_count","unchanged","production","uat","in_flight","cannot_take","not_reached","confirm","digest"],"type":"object"},"DeployTemplateReachRow":{"additionalProperties":true,"properties":{"binding_id":{"description":"The id of the environment's pipeline, the `{binding}` of the site pipeline endpoints.","type":"integer"},"environment":{"additionalProperties":true,"properties":{"name":{"type":"string"},"slug":{"type":"string"}},"type":"object"},"site":{"additionalProperties":true,"properties":{"domain":{"type":"string"},"id":{"type":"integer"}},"type":"object"},"site_id":{"type":"integer"},"stages":{"items":{"type":"string"},"type":"array"}},"required":["site_id"],"type":"object"},"DeployTemplateResetAnswer":{"properties":{"dry_run":{"type":"boolean"},"production_count":{"description":"The number to send as `confirm_count`.","type":"integer"},"refused":{"description":"Targets that cannot be reset, each with why. A dry run lists them; a reset that names one is refused `template_refused_on`.","items":{"additionalProperties":true,"properties":{"production":{"type":"boolean"},"reason":{"description":"Such as `not_reached`, `pipeline_classic`, `pipeline_review_pending` or `pipeline_locked`.","type":"string"},"site_id":{"minimum":1,"type":"integer"}},"required":["site_id","reason","production"],"type":"object"},"type":"array"},"targets":{"items":{"additionalProperties":true,"properties":{"production":{"type":"boolean"},"site_id":{"type":"integer"},"stages":{"items":{"type":"string"},"type":"array"}},"required":["site_id","stages","production"],"type":"object"},"type":"array"},"written":{"oneOf":[{"$ref":"#/components/schemas/DeployTemplateWritten"},{"type":"null"}]}},"required":["dry_run","targets","refused","production_count","written"],"type":"object"},"DeployTemplateResetRequest":{"additionalProperties":false,"properties":{"confirm_count":{"description":"The dry run's `production_count`.","minimum":0,"type":"integer"},"confirm_production":{"type":"boolean"},"dry_run":{"description":"Answer what would change for each target and write nothing.","type":"boolean"},"targets":{"items":{"additionalProperties":false,"properties":{"site_id":{"minimum":1,"type":"integer"},"stages":{"description":"The stages to reset, or `[\"all\"]`.","items":{"enum":["build","database","post_deploy","settings","all"],"type":"string"},"maxItems":4,"minItems":1,"type":"array"}},"required":["site_id","stages"],"type":"object"},"maxItems":200,"minItems":1,"type":"array"}},"required":["targets"],"type":"object"},"DeployTemplateRestoreRequest":{"allOf":[{"$ref":"#/components/schemas/DeployTemplateConfirmation"},{"oneOf":[{"required":["version_id"]},{"required":["version"]}],"properties":{"revision":{"description":"The template revision you read.","minimum":0,"type":"integer"},"version":{"description":"Instead of `version_id`, `corefinity` puts every stage back to Corefinity's default.","enum":["corefinity"],"type":"string"},"version_id":{"description":"The revision to restore, as the versions list answers it.","minimum":1,"type":"integer"}},"required":["revision"],"type":"object"}]},"DeployTemplateSaved":{"allOf":[{"$ref":"#/components/schemas/DeployTemplate"},{"properties":{"dry_run":{"type":"boolean"},"reach":{"description":"The environments the change reaches. Null when the request changes nothing in the template: a dry run\nthen answers `reach` and `written` null, and a save answers `reach` null and `written` with zeros,\nleaving the revision as it was.\n","oneOf":[{"$ref":"#/components/schemas/DeployTemplateReach"},{"type":"null"}]},"written":{"description":"What was written. Null for a dry run.","oneOf":[{"$ref":"#/components/schemas/DeployTemplateWritten"},{"type":"null"}]}},"required":["dry_run","reach","written"],"type":"object"}]},"DeployTemplateStageEntry":{"description":"What the template sets for one stage.","properties":{"mode":{"description":"`inherit` takes the stage from the level above; `replace` sets it to `value`.","enum":["inherit","replace"],"type":"string"},"value":{"$ref":"#/components/schemas/DeployTemplateStageValue"}},"required":["mode"],"type":"object"},"DeployTemplateStageRequest":{"allOf":[{"$ref":"#/components/schemas/DeployTemplateConfirmation"},{"properties":{"also_uat":{"description":"For the production configuration only, make the same change to UAT.","type":"boolean"},"copy_from_config":{"description":"With the stage `all`, copy every stage from the other configuration: the one that is not `{config}`.\nNot with `mode`, `value` or `also_uat`, and refused with any other stage.\n","enum":["production","uat"],"type":"string"},"mode":{"description":"`inherit` hands the stage back to the level above and takes no `value`; `replace` sets it to `value`,\nwhich it needs. Required for every stage but `all`.\n","enum":["inherit","replace"],"type":"string"},"revision":{"description":"The template revision you read.","minimum":0,"type":"integer"},"value":{"allOf":[{"$ref":"#/components/schemas/DeployTemplateStageValue"},{"minProperties":1,"properties":{"hooks":{"$ref":"#/components/schemas/DeployTemplateHooks"},"lines":{"$ref":"#/components/schemas/DeployTemplateLines"},"preset":{"properties":{"hooks":{"$ref":"#/components/schemas/DeployTemplateHooks"}},"type":"object"},"timeouts":{"additionalProperties":false,"description":"Settings only. Whole seconds for `build`, `build_line`, `database_line` and `post_line`, 60 to\n3600 each, or null for the default. Any other key is refused `invalid`, and a number outside\nthe bounds `timeout_out_of_range`. An empty list sets none.\n","maxItems":0,"properties":{"build":{"maximum":3600,"minimum":60,"type":["integer","null"]},"build_line":{"maximum":3600,"minimum":60,"type":["integer","null"]},"database_line":{"maximum":3600,"minimum":60,"type":["integer","null"]},"post_line":{"maximum":3600,"minimum":60,"type":["integer","null"]}},"type":["object","array"]}},"type":"object"}]}},"required":["revision"],"type":"object"}]},"DeployTemplateStageValue":{"additionalProperties":true,"description":"A stage's content, in the shape the site pipeline's stage and settings endpoints take. The database and\nafter-deploy stages hold `lines`; the build stage holds `mode` with a `preset` or its own `lines`; the\nsettings stage holds the pipeline's settings, each one optional.\n","properties":{"hooks":{"additionalProperties":true,"description":"Build only. Your own lines for each hook of a preset build, when they are not inside `preset`. An empty list when there are none.","type":["object","array"]},"keep_node_modules":{"type":"boolean"},"lines":{"description":"The stage's commands, one a line, as a list or as one string.","oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}]},"maintenance_policy":{"description":"Settings only, as each of the settings below.","enum":["when_needed","always","off"],"type":"string"},"mode":{"description":"Build only.","enum":["preset","custom"],"type":"string"},"pause_crons":{"enum":["auto","off",null],"type":["string","null"]},"platform_step_at":{"description":"Database only. How many of the lines run before the platform's own database step.","minimum":0,"type":["integer","null"]},"preset":{"additionalProperties":true,"description":"Build only, with `mode` `preset`: `platform`, `frontend` (a preset or a list of them), their `options` and optional `hooks`.","type":"object"},"repository_contents":{"description":"On a WordPress template, what a repository connected from now on holds. It never changes a repository\nalready connected. While site content repositories are paused, a save of `site_content` is refused\n`feature_off`: a 422, not the 404 a switched-off endpoint answers.\n","enum":["whole_site","site_content"],"type":"string"},"repository_target_path":{"description":"Where in the site that content goes. Null is `wp-content`, or `web/app` on Bedrock.","type":["string","null"]},"run_migrations":{"description":"Laravel only.","type":["boolean","null"]},"timeouts":{"additionalProperties":{"type":["integer","null"]},"description":"Whole seconds for a stage or line key (`build`, `build_line`, `database_line`, `post_line`), or null. A save takes 60 to 3600 for each and no other key. An empty list when none is set.","type":["object","array"]},"tunnels":{"enum":["auto","on","off"],"type":"string"}},"type":"object"},"DeployTemplateSummary":{"properties":{"locked":{"description":"Set while Corefinity has locked the template, so it cannot be edited. Null when it can.","properties":{"reason":{"description":"Why, in Corefinity's words.","type":"string"}},"required":["reason"],"type":["object","null"]},"platform":{"type":"string"},"reach":{"description":"The environments the template reaches.","properties":{"environments":{"type":"integer"},"follows_every_stage":{"type":"integer"},"overrides_some":{"type":"integer"},"production":{"type":"integer"}},"required":["environments","production","follows_every_stage","overrides_some"],"type":"object"},"revision":{"description":"The template's revision. 0 until it is first saved.","type":"integer"},"saved_at":{"type":["string","null"]},"saved_by":{"description":"The name of the person who last saved it.","type":["string","null"]},"state":{"description":"`customised` when the company has set stages of its own; `default` when it follows what it inherits for every stage.","type":"string"},"template_id":{"description":"Null until the company saves a template of its own for this platform.","type":["integer","null"]}},"required":["platform","template_id","state","revision","saved_at","saved_by","locked","reach"],"type":"object"},"DeployTemplateUpstream":{"properties":{"agency":{"oneOf":[{"$ref":"#/components/schemas/Named"},{"type":"null"}]},"chain":{"description":"The levels a stage is inherited through, from Corefinity's default down to this company.","items":{"properties":{"company":{"oneOf":[{"$ref":"#/components/schemas/Named"},{"type":"null"}]},"level":{"description":"Such as `corefinity`, `agency` or `owner`.","type":"string"},"revision":{"type":"integer"},"template_id":{"type":["integer","null"]}},"required":["level","company","template_id","revision"],"type":"object"},"type":"array"},"environments":{"properties":{"production":{"type":"integer"},"total":{"type":"integer"}},"required":["total","production"],"type":"object"},"stages":{"additionalProperties":{"additionalProperties":{"additionalProperties":true,"properties":{"differs_from_none":{"type":"boolean"},"effective":{"$ref":"#/components/schemas/DeployTemplateStageValue"},"inherited":{"additionalProperties":true,"properties":{"company":{"oneOf":[{"$ref":"#/components/schemas/Named"},{"type":"null"}]},"level":{"type":"string"},"revision":{"type":"integer"},"value":{"$ref":"#/components/schemas/DeployTemplateStageValue"}},"type":"object"}},"required":["inherited","effective"],"type":"object"},"type":"object"},"description":"By configuration (`production`, `uat`), then by stage: `inherited` (the level, company and revision the\nstage comes from, with its `value`), `effective` (the content in effect) and `differs_from_none`.\n","type":"object"},"upstream":{"description":"`none`, or `agency:` and the id of the agency whose template sits above this one.","type":"string"}},"required":["upstream","agency","chain","environments","stages"],"type":"object"},"DeployTemplateUsagePage":{"description":"A page of environments. As in the versions list, `next_cursor` is a number, not the string of the shared `CursorPage`.","properties":{"data":{"items":{"additionalProperties":true,"properties":{"binding_id":{"description":"The id of the environment's pipeline, the `{binding}` of the site pipeline endpoints.","type":"integer"},"changed_since_deploy":{"description":"The stages that changed since the environment last deployed.","items":{"type":"string"},"type":"array"},"environment":{"additionalProperties":true,"properties":{"name":{"type":"string"},"slug":{"type":"string"}},"type":"object"},"last_deployment":{"type":["object","null"]},"role":{"enum":["production","uat"],"type":"string"},"site":{"additionalProperties":true,"properties":{"domain":{"type":"string"},"id":{"type":"integer"},"kind":{"type":"string"},"owner":{"description":"The company that owns the site, when it is not this one.","type":["object","null"]}},"type":"object"},"site_id":{"type":"integer"},"stages":{"additionalProperties":{"additionalProperties":true,"properties":{"level":{"type":["string","null"]},"revision":{"type":["integer","null"]},"state":{"type":"string"}},"type":"object"},"description":"By stage, whether it follows the template (`state`), and the revision and level it follows.","type":"object"},"states":{"items":{"type":"string"},"type":"array"}},"required":["site_id","binding_id","site","environment","role","stages","states"],"type":"object"},"type":"array"},"next_cursor":{"type":["integer","null"]},"summary":{"additionalProperties":{"type":"integer"},"description":"Counts across every environment the template reaches, whatever the filters.","required":["environments","production","follows_every_stage","overrides_some"],"type":"object"}},"required":["summary","data","next_cursor"],"type":"object"},"DeployTemplateVersionPage":{"description":"A page of versions. It differs from the shared `CursorPage` in one way: `next_cursor` is a number, the place\nthe next page starts at. With `level` `corefinity` each version is Corefinity's own: `version`, `version_ref`\n(`corefinity_version`), `applied_at` and `changed`, and `template_id` is null.\n","properties":{"next_cursor":{"type":["integer","null"]},"template_id":{"type":["integer","null"]},"versions":{"items":{"additionalProperties":true,"properties":{"applied_at":{"description":"With `level` `corefinity`, when that version came into use, in UTC.","format":"date-time","type":["string","null"]},"at":{"type":"string"},"by":{"description":"The name of the person who saved it.","type":["string","null"]},"changed":{"description":"The stages this version changed.","items":{"properties":{"config":{"type":"string"},"stage":{"type":"string"}},"type":"object"},"type":"array"},"reach":{"additionalProperties":true,"description":"How many environments the version was written to.","type":["object","null"]},"restored_from":{"description":"The revision this one restored, when it is a restore.","type":["integer","object","null"]},"revision":{"type":"integer"},"sets":{"description":"The stages the template set after this version.","items":{"properties":{"config":{"type":"string"},"stage":{"type":"string"}},"type":"object"},"type":"array"},"source":{"description":"Who made the version, such as `person`.","type":"string"},"version":{"description":"With `level` `corefinity`, the number of Corefinity's version.","minimum":1,"type":"integer"},"version_ref":{"additionalProperties":true,"properties":{"corefinity_version":{"type":"integer"},"revision":{"type":"integer"},"template_id":{"type":["integer","null"]}},"type":"object"}},"required":["changed"],"type":"object"},"type":"array"}},"required":["template_id","versions","next_cursor"],"type":"object"},"DeployTemplateWritten":{"additionalProperties":true,"properties":{"environments":{"description":"Environments the change was written to.","type":"integer"},"kept":{"description":"Environments left on their own stage.","type":"integer"},"revisions":{"description":"New pipeline revisions made.","type":"integer"},"tunnel_access_started":{"items":{},"type":"array"}},"required":["environments","revisions","kept"],"type":"object"},"DeploymentConnection":{"additionalProperties":false,"description":"A git provider account a company deploys from.","properties":{"base_url":{"description":"The address of a self-hosted GitLab. Null for every other provider.","type":["string","null"]},"can_remove":{"description":"True when you may remove the connection and no environment deploys through it.","type":"boolean"},"connected_at":{"description":"When the connection was added, in UTC with a `+00:00` offset.","format":"date-time","type":["string","null"]},"environments":{"description":"The environments that deploy through the connection and that you can see.","items":{"$ref":"#/components/schemas/DeploymentConnectionEnvironment"},"type":"array"},"id":{"minimum":1,"type":"integer"},"needs_reauth_since":{"description":"Since when the connection has needed re-authorising, in the same form. Null while it is connected.","format":"date-time","type":["string","null"]},"organisation_access_url":{"description":"On a GitHub connection, GitHub's page where an organisation gives access to its repositories. Null for\nevery other provider.\n","type":["string","null"]},"other_environments":{"description":"How many more environments deploy through the connection that are not shown to you.","minimum":0,"type":"integer"},"provider":{"$ref":"#/components/schemas/DeploymentConnectionProvider"},"provider_label":{"description":"The provider's name, such as `GitLab` or `GitLab (self-hosted)`.","type":"string"},"reconnect_note":{"description":"What reconnecting this connection takes, in plain words.","type":"string"},"reconnect_url":{"description":"A page that reconnects the account. Open it in a browser signed in to the Control Panel, then sign in to\nthe provider as `username`. Null for a self-hosted GitLab, which takes a new access token in the Control\nPanel instead.\n","type":["string","null"]},"status":{"description":"`needs_reauthorisation` means the provider no longer accepts the connection, so deployments through it\nfail until it is reconnected.\n","enum":["connected","needs_reauthorisation"],"type":"string"},"username":{"description":"The account's username at the provider.","type":"string"}},"required":["id","provider","provider_label","username","base_url","connected_at","status","needs_reauth_since","reconnect_url","reconnect_note","organisation_access_url","environments","other_environments","can_remove"],"type":"object"},"DeploymentConnectionEnvironment":{"additionalProperties":false,"description":"An environment that deploys through a connection.","properties":{"environment_id":{"description":"The environment's id.","minimum":1,"type":"integer"},"name":{"description":"The environment's name.","type":"string"},"site_id":{"description":"The site row id, when the environment is a CoreStack or CoreCluster site. Otherwise null.","type":["integer","null"]},"website":{"description":"The website's name. Empty when the website cannot be read.","type":"string"},"website_id":{"minimum":1,"type":"integer"}},"required":["environment_id","name","website_id","website","site_id"],"type":"object"},"DeploymentConnectionInUseRefusal":{"properties":{"code":{"const":"connection_in_use","type":"string"},"environments":{"items":{"$ref":"#/components/schemas/DeploymentConnectionEnvironment"},"type":"array"},"message":{"type":"string"},"other_environments":{"minimum":0,"type":"integer"},"reason":{"const":"connection_in_use","type":"string"}},"required":["message","reason","code","environments","other_environments"],"type":"object"},"DeploymentConnectionList":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"connections":{"items":{"$ref":"#/components/schemas/DeploymentConnection"},"type":"array"}},"required":["connections"],"type":"object"}],"unevaluatedProperties":false},"DeploymentConnectionProvider":{"description":"The git provider.","enum":["github","gitlab","bitbucket","gitlab_self_hosted"],"type":"string"},"DeploymentConnectionRemovalRequest":{"properties":{"confirm_connection":{"description":"The id of the connection being removed, as a number or a string of digits.","oneOf":[{"type":"integer"},{"pattern":"^\\s*[0-9]+\\s*$","type":"string"}]}},"required":["confirm_connection"],"type":"object"},"DeploymentConnectionRemoved":{"additionalProperties":false,"properties":{"removed":{"additionalProperties":false,"properties":{"id":{"minimum":1,"type":"integer"},"provider":{"$ref":"#/components/schemas/DeploymentConnectionProvider"},"username":{"type":"string"}},"required":["id","provider","username"],"type":"object"}},"required":["removed"],"type":"object"},"DetailReason":{"description":"A more specific reason, sent only where `reason` keeps the word the API has always answered and a more specific\none is known. Read `detail_reason` when it is present, else `reason`.\n","type":"string"},"DnsPlan":{"description":"The DNS records the Control Panel would write in your connected Cloudflare account.","properties":{"actions":{"items":{"$ref":"#/components/schemas/DnsPlanAction"},"type":"array"},"can_apply":{"type":"boolean"},"requires_confirmation":{"description":"True when existing records would be replaced.","type":"boolean"},"zone":{"description":"The zone the records are in, with `id` and `name`.","type":["object","null"]}},"required":["actions","requires_confirmation","zone","can_apply"],"type":"object"},"DnsPlanAction":{"properties":{"action":{"enum":["create","replace","keep","manual"],"type":"string"},"existing":{"description":"The records a `replace` would replace.","items":{"type":"object"},"type":["array","null"]},"host":{"type":"string"},"reason":{"description":"For a `manual` action, why the record is yours to create and what it must be. Null otherwise.","type":["string","null"]},"record":{"additionalProperties":true,"description":"The record to write or keep. Null for a `manual` action, which the Control Panel cannot write.","properties":{"content":{"description":"The address the record points at.","type":"string"},"name":{"type":"string"},"proxied":{"description":"Whether Cloudflare proxies the hostname.","type":"boolean"},"type":{"description":"The record type, such as `A`.","type":"string"}},"required":["type","name","content","proxied"],"type":["object","null"]}},"required":["host","action","record","existing","reason"],"type":"object"},"DnsPointRequest":{"properties":{"confirm_replacements":{"default":false,"description":"True to replace DNS records that already exist.","type":"boolean"},"hosts":{"description":"Domains the site already has.","items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["hosts"],"type":"object"},"DnsPointResult":{"properties":{"applied":{"description":"The records that were written or kept.","items":{"$ref":"#/components/schemas/DnsPlanAction"},"type":"array"},"hosts":{"items":{"$ref":"#/components/schemas/DomainHostCheck"},"type":"array"}},"required":["applied","hosts"],"type":"object"},"DnsWriteRefusal":{"description":"A DNS write that was refused before anything was sent to Cloudflare.","properties":{"code":{"type":"string"},"dns_plan":{"$ref":"#/components/schemas/DnsPlan"},"errors":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"message":{"type":"string"},"reason":{"enum":["preview_only","confirm_replacements","too_many"],"type":"string"}},"required":["message","reason","code"],"type":"object"},"DomainAdvice":{"description":"Advice about the Cloudflare zone's SSL mode and the certificate check.","properties":{"challenge_path":{"properties":{"note":{"type":["string","null"]},"ok":{"type":["boolean","null"]}},"type":["object","null"]},"ssl_mode":{"properties":{"current":{"type":["string","null"]},"fixable":{"type":["boolean","null"]},"note":{"type":["string","null"]},"ok":{"type":["boolean","null"]},"recommended":{"type":["string","null"]}},"type":["object","null"]}},"type":"object"},"DomainHost":{"description":"One hostname of a site with its role, certificate and DNS state.","properties":{"cloudflare_zone":{"description":"The connected Cloudflare zone the hostname is in, with its `id` and `name`. `proxied` and `record_id` are\nsent as null.\n","type":["object","null"]},"dns_answers":{"items":{"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":["array","null"]},"dns_checked_at":{"format":"date-time","type":["string","null"]},"dns_detail":{"type":["string","null"]},"dns_state":{"enum":["points_here","proxied_here","elsewhere","unresolved","unknown"],"type":"string"},"dns_state_since":{"type":["string","null"]},"expected_ip":{"description":"The address the hostname must point at.","type":["string","null"]},"host":{"type":"string"},"noindex":{"description":"True when search engines are asked not to index this hostname. Not sent in the answer of `POST …/domains/point-dns`.","type":"boolean"},"redirects_to":{"description":"The hostname this one redirects to. Null when it serves the site itself.","type":["string","null"]},"role":{"enum":["primary","alias","preview","legacy","store"],"type":"string"},"serve":{"description":"Sent for extra domains on Shopware, and on Magento 2 while Magento store domains are available.","enum":["redirect","storefront"],"type":"string"},"store":{"description":"A Magento storefront alias's store choice, or the selected choice on the primary. An unmapped alias shows the default store.","properties":{"code":{"type":["string","null"]},"name":{"type":["string","null"]},"previous":{"anyOf":[{"$ref":"#/components/schemas/MagentoStoreChoice"},{"type":"null"}],"description":"While pending, the store losing this host; null for a new storefront. Omitted otherwise."},"state":{"enum":["mapped","pending","unmapped"],"type":"string"},"type":{"enum":["website","store",null],"type":["string","null"]}},"required":["code","type","name","state"],"type":"object"},"tls":{"description":"The certificate for the hostname.","properties":{"checked_at":{"format":"date-time","type":["string","null"]},"issuer":{"type":["string","null"]},"not_after":{"type":["string","null"]},"reason":{"type":["string","null"]},"state":{"enum":["ready","pending","failed","none"],"type":"string"}},"type":["object","null"]}},"required":["host","role","redirects_to","tls","dns_state","dns_detail","dns_state_since","dns_checked_at","dns_answers","cloudflare_zone","expected_ip"],"type":"object"},"DomainHostCheck":{"allOf":[{"$ref":"#/components/schemas/DomainHost"},{"properties":{"ok":{"description":"True when the hostname is ready.","type":"boolean"},"problems":{"description":"What to fix, in plain words. Empty when `ok` is true.","items":{"type":"string"},"type":"array"}},"required":["ok","problems"],"type":"object"}],"description":"A hostname as a check found it."},"DomainMagentoAttachStores":{"additionalProperties":{"additionalProperties":false,"properties":{"base_url":{"type":"boolean"},"code":{"maxLength":32,"minLength":1,"type":"string"},"type":{"enum":["website","store"],"type":"string"}},"required":["code","type"],"type":"object"},"description":"Magento 2 only. Every key is a hostname in hosts with serve set to storefront; every such hostname needs an entry. One base_url address can be chosen per website or store view.","type":"object"},"DomainsCheckRequest":{"properties":{"hosts":{"items":{"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["hosts"],"type":"object"},"DomainsCheckResult":{"properties":{"advice":{"oneOf":[{"$ref":"#/components/schemas/DomainAdvice"},{"type":"null"}]},"dns_plan":{"oneOf":[{"$ref":"#/components/schemas/DnsPlan"},{"type":"null"}]},"hosts":{"items":{"$ref":"#/components/schemas/DomainHostCheck"},"type":"array"},"ok":{"description":"True when every hostname points at the platform.","type":"boolean"},"ran_at":{"format":"date-time","type":"string"}},"required":["hosts","ok","dns_plan","advice","ran_at"],"type":"object"},"DomainsSet":{"description":"A site's domains with their DNS and certificate state.","properties":{"advice":{"oneOf":[{"$ref":"#/components/schemas/DomainAdvice"},{"type":"null"}]},"apply":{"$ref":"#/components/schemas/ApplyState"},"canonical_url":{"type":["string","null"]},"cloudflare":{"description":"Whether your company's Cloudflare is connected, and the zone the main domain is in.","properties":{"connected":{"type":"boolean"},"zone":{"type":["object","null"]}},"type":["object","null"]},"hosts":{"items":{"$ref":"#/components/schemas/DomainHost"},"type":"array"},"ingress_ip":{"description":"The address the site's domains must point at.","type":["string","null"]},"limits":{"properties":{"hosts_max":{"description":"The most hostnames a site can have, the main domain included.","type":"integer"}},"required":["hosts_max"],"type":"object"},"locked_reason":{"description":"Why the domains cannot be changed. Null when they can.","type":["string","null"]},"mode":{"description":"`production` once a domain is attached, `staging` before.","enum":["production","staging"],"type":"string"},"noindex":{"description":"True when search engines are asked not to index the site.","type":"boolean"},"noindex_source":{"enum":["role","flags","none"],"type":"string"},"primary":{"description":"The main domain. Null until a domain is attached.","type":["string","null"]},"url_change":{"properties":{"can_change":{"description":"Whether the main domain can be changed now, and why not.","properties":{"available":{"type":"boolean"},"reason":{"type":["string","null"]}},"type":"object"},"in_flight":{"description":"The main domain change that is running, if one is.","oneOf":[{"$ref":"#/components/schemas/OperationSummary"},{"type":"null"}]}},"required":["in_flight","can_change"],"type":"object"},"version":{"description":"Send this with a save. It changes whenever the domains change.","minimum":0,"type":"integer"},"www":{"description":"Whether the main domain is its `www` or its `bare` form.","type":["string","null"]}},"required":["version","mode","primary","www","canonical_url","hosts","noindex","noindex_source","apply","ingress_ip","cloudflare","advice","url_change","limits","locked_reason"],"type":"object"},"DomainsUpdateRequest":{"properties":{"aliases":{"description":"The complete list of extra domains to keep, each once and never the main domain. A plain hostname redirects\nto the primary; the object form chooses a redirect or a storefront. A site has at most 10 hostnames in total.\n","items":{"anyOf":[{"type":"string"},{"additionalProperties":false,"properties":{"base_url":{"description":"Choose this address for the store's base URLs, at most one address per website or store view.","type":"boolean"},"host":{"type":"string"},"serve":{"description":"Defaults to redirect. A Shopware storefront serves its sales channel; a Magento 2 storefront uses `store`.","enum":["redirect","storefront"],"type":"string"},"store":{"anyOf":[{"$ref":"#/components/schemas/MagentoStoreChoice"},{"type":"null"}],"description":"Magento 2 storefront aliases only. Required for a new storefront alias; omitted on an existing\nstorefront alias, its mapping is kept. Null shows the default store. A redirect cannot carry a store choice.\n"}},"required":["host"],"type":"object"}]},"maxItems":9,"type":"array"},"noindex":{"description":"True to ask search engines not to index the site.","type":"boolean"},"point_base_urls":{"description":"Magento 2 only. Optional hosts whose stores' base URLs are moved here, even from another host. Each must be\nthe primary address or a storefront alias with a Magento store, with at most one address per website or store view.\n","items":{"maxLength":253,"minLength":1,"type":"string"},"maxItems":10,"type":"array","uniqueItems":true},"version":{"description":"The `version` you last read.","minimum":0,"type":"integer"}},"required":["version","aliases","noindex"],"type":"object"},"DomainsUpdateResult":{"properties":{"domains":{"$ref":"#/components/schemas/DomainsSet"},"operation":{"description":"The change to follow. Null when nothing differs.","oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]}},"required":["domains","operation"],"type":"object"},"EmailChangeStarted":{"properties":{"email":{"$ref":"#/components/schemas/EmailSettings"},"operation":{"$ref":"#/components/schemas/Operation"}},"required":["email","operation"],"type":"object"},"EmailCloudflare":{"description":"Whether the DNS endpoint can write this domain's records.","properties":{"can_write_records":{"type":"boolean"},"connected":{"description":"Whether your company has a connected Cloudflare account.","type":"boolean"},"written_at":{"description":"When the records were last written in full.","format":"date-time","type":["string","null"]},"zone":{"description":"The Cloudflare zone the domain is in, or null when it is in none of the connected account's.","oneOf":[{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},{"type":"null"}]}},"required":["connected","zone","can_write_records","written_at"],"type":"object"},"EmailCommand":{"description":"One test send.","properties":{"blocked_until_verified":{"type":"boolean"},"duration_ms":{"type":["integer","null"]},"error":{"type":["string","null"]},"exit_code":{"type":["integer","null"]},"finished_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"input":{"additionalProperties":true,"description":"What was asked for, `to` and `domain`.","type":"object"},"kind":{"const":"email_test","type":"string"},"label":{"type":"string"},"operation_id":{"minimum":1,"type":["integer","null"]},"output_excerpt":{"type":["string","null"]},"queued_at":{"format":"date-time","type":["string","null"]},"requested_by":{"description":"Who asked for the test. Null when that person's account has since been deleted.","oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"result":{"description":"The outcome, once the send has finished.","oneOf":[{"properties":{"message":{"type":"string"},"sent":{"type":"boolean"}},"required":["sent","message"],"type":"object"},{"type":"null"}]},"site":{"$ref":"#/components/schemas/SiteRef"},"started_at":{"format":"date-time","type":["string","null"]},"status":{"description":"`queued` and `running`: the send has not ended, read again. Every other value is final: `succeeded`,\n`failed`, `timed_out` (the site did not answer in time) and `lost` (the connection to the site ended\nbefore the send reported back). Only `succeeded` means the email was handed over.\n","enum":["queued","running","succeeded","failed","timed_out","lost"],"type":"string"},"status_label":{"type":"string"}},"required":["id","kind","label","site","status","status_label","operation_id","blocked_until_verified","input","result","output_excerpt","exit_code","error","requested_by","queued_at","started_at","finished_at","duration_ms"],"type":"object"},"EmailCommandAnswer":{"properties":{"command":{"$ref":"#/components/schemas/EmailCommand"}},"required":["command"],"type":"object"},"EmailDnsRecord":{"description":"One DNS record a sending domain needs.","properties":{"cloudflare":{"description":"The record as written in Cloudflare by the DNS endpoint. Null when it was not.","oneOf":[{"additionalProperties":true,"properties":{"record_id":{"type":"string"},"written_at":{"format":"date-time","type":["string","null"]}},"type":"object"},{"type":"null"}]},"found":{"description":"What was found in DNS when it differs from `value`.","type":["string","null"]},"name":{"type":"string"},"priority":{"description":"MX records only.","type":["integer","null"]},"purpose":{"description":"What the record is for, such as `spf`, `dkim`, `mx`, `tracking` or `dmarc`.","type":"string"},"required":{"description":"False for the records sending works without (`mx`, `dmarc`).","type":"boolean"},"state":{"enum":["valid","unchecked","mismatch","missing"],"type":"string"},"type":{"description":"The record type, such as `TXT`, `CNAME` or `MX`.","type":"string"},"value":{"type":"string"}},"required":["type","name","value","priority","purpose","required","state","found","cloudflare"],"type":"object"},"EmailDnsRequest":{"properties":{"domain":{"description":"A sending domain of the site, by its name or its `id`. Left out, the default.","type":["string","integer"]},"mx":{"description":"True to write the optional MX records too.","type":"boolean"}},"type":"object"},"EmailDnsWritten":{"properties":{"email":{"$ref":"#/components/schemas/EmailSettings"},"written":{"description":"How many records were written.","type":"integer"}},"required":["email","written"],"type":"object"},"EmailDomainAdd":{"properties":{"domain":{"description":"The whole sending domain, under `from_domain` and not `from_domain` itself, in place of `prefix`.","maxLength":253,"type":"string"},"from_domain":{"description":"The domain the mail comes from, one of the site's domains or under one of them. At most 240 characters.","maxLength":240,"minLength":1,"type":"string"},"prefix":{"default":"mg","description":"What goes in front of `from_domain` to make the sending domain: one DNS label of letters, digits and\nhyphens, 1 to 63 characters, that neither starts nor ends with a hyphen. By default `mg`. Not read when\n`domain` is sent. The sending domain it makes may be at most 253 characters.\n","maxLength":63,"minLength":1,"pattern":"^[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?$","type":"string"}},"required":["from_domain"],"type":"object"},"EmailDomainChoice":{"properties":{"domain":{"description":"A sending domain of the site, by its name or its `id`. Left out, the default.","type":["string","integer"]}},"type":"object"},"EmailDomainRow":{"description":"One sending domain of the site.","properties":{"active":{"description":"Whether the site sends through this domain now.","type":"boolean"},"added_at":{"format":"date-time","type":["string","null"]},"added_by":{"type":["string","null"]},"can_make_default":{"type":"boolean"},"can_remove":{"type":"boolean"},"can_rotate":{"type":"boolean"},"can_test":{"type":"boolean"},"cloudflare":{"$ref":"#/components/schemas/EmailCloudflare"},"error":{"type":["string","null"]},"from_domain":{"description":"The domain of the sender addresses that go through it.","type":"string"},"id":{"minimum":1,"type":"integer"},"is_default":{"type":"boolean"},"last_checked_at":{"format":"date-time","type":["string","null"]},"last_test":{"description":"The last test email sent through this domain, or null.","oneOf":[{"properties":{"at":{"description":"When the test ended, or was asked for while it runs.","format":"date-time","type":["string","null"]},"message":{"description":"What happened, in a sentence.","type":["string","null"]},"sent":{"description":"Whether the site handed the email over. Null while the test runs.","type":["boolean","null"]},"to":{"type":["string","null"]}},"required":["at","to","sent","message"],"type":"object"},{"type":"null"}]},"make_default_reason":{"type":["string","null"]},"operation_id":{"description":"The operation that set the domain up.","minimum":1,"type":["integer","null"]},"records":{"items":{"$ref":"#/components/schemas/EmailDnsRecord"},"type":"array"},"remove_reason":{"type":["string","null"]},"sender":{"$ref":"#/components/schemas/EmailSender"},"sending_domain":{"description":"The domain email is sent through, such as `mg.harbourandfinch.example.com`.","type":"string"},"state":{"$ref":"#/components/schemas/EmailState"},"state_label":{"type":"string"},"test_reason":{"description":"Why a test cannot be sent, when it cannot.","type":["string","null"]},"verified_at":{"format":"date-time","type":["string","null"]}},"required":["id","sending_domain","from_domain","is_default","state","state_label","active","sender","records","verified_at","last_checked_at","added_at","added_by","cloudflare","error","operation_id","last_test","can_test","test_reason","can_rotate","can_make_default","make_default_reason","can_remove","remove_reason"],"type":"object"},"EmailSender":{"properties":{"address":{"description":"The address the site's email comes from.","type":"string"},"name":{"description":"The name shown beside it.","type":["string","null"]}},"required":["address","name"],"type":"object"},"EmailSetUp":{"properties":{"domain":{"description":"The sending domain, equal to or under the site's domain or one of its other live domains. Left out, `mg.` followed by the site's domain.","maxLength":253,"minLength":4,"type":"string"},"sender":{"properties":{"address":{"description":"An address at the site's domain, one of its other live domains, or the sending domain. Without spaces, quotes or angle brackets.","format":"email","maxLength":254,"type":"string"},"name":{"description":"Without quotes, angle brackets, backslashes or control characters.","maxLength":80,"type":["string","null"]}},"required":["address"],"type":"object"}},"required":["sender"],"type":"object"},"EmailSettings":{"description":"A site's email settings. The top-level fields describe the default sending domain.","properties":{"add":{"description":"Whether another sending domain can be added.","properties":{"allowed":{"type":"boolean"},"count":{"type":"integer"},"default_prefix":{"type":"string"},"max":{"type":"integer"},"reason":{"type":["string","null"]}},"required":["allowed","reason","max","count","default_prefix"],"type":"object"},"cloudflare":{"oneOf":[{"$ref":"#/components/schemas/EmailCloudflare"},{"type":"null"}]},"default_domain":{"description":"The sending domain a set-up creates when it names none.","type":"string"},"domains":{"description":"Every sending domain of the site, the default first.","items":{"$ref":"#/components/schemas/EmailDomainRow"},"type":"array"},"error":{"description":"What went wrong with the last set-up or DNS write, in plain words.","type":["string","null"]},"last_checked_at":{"format":"date-time","type":["string","null"]},"mailpit":{"description":"Where the email of a site that is not live is caught. Null on a live site.","oneOf":[{"properties":{"catches":{"description":"`all`: every email the site sends. `php_mail`: only email sent with PHP mail, on a WordPress site whose platform plugins are off.","enum":["all","php_mail"],"type":"string"},"note":{"description":"A sentence to show while only PHP mail is caught. Null otherwise.","type":["string","null"]},"role_held":{"description":"On a staging or development environment, the sentence a set-up is refused with. Null on a production environment.","type":["string","null"]},"url":{"description":"The address of the inbox the email is caught in.","type":"string"}},"required":["url","catches","note","role_held"],"type":"object"},{"type":"null"}]},"operation":{"description":"The email change that is running, or null.","oneOf":[{"$ref":"#/components/schemas/OperationSummary"},{"type":"null"}]},"records":{"items":{"$ref":"#/components/schemas/EmailDnsRecord"},"type":"array"},"sender":{"oneOf":[{"$ref":"#/components/schemas/EmailSender"},{"type":"null"}]},"sending_domain":{"description":"The default sending domain, or null when none is set up.","type":["string","null"]},"state":{"$ref":"#/components/schemas/EmailState"},"state_label":{"type":"string"},"store_mapping":{"description":"On a live Magento 2 site with a sending domain, its stores' sender addresses and the sending domain each\ngoes through, as last read on the site. Null otherwise, and until the first read has answered.\n","oneOf":[{"properties":{"checked_at":{"description":"When the stores were last read on the site.","format":"date-time","type":"string"},"more":{"description":"How many store views were left out of `stores`.","type":"integer"},"stores":{"description":"The active store views, 50 at most.","items":{"properties":{"addresses":{"description":"The store view's sender addresses.","items":{"properties":{"address":{"type":"string"},"from_domain":{"type":"string"},"through":{"description":"The sending domain its email goes out through.","type":["string","null"]},"via":{"description":"`own`: a sending domain of its own. `default`: the default sending domain. `pending`: its own sending domain, once the site sends through it.","enum":["own","default","pending"],"type":"string"},"warn":{"description":"`capitals`: the address's domain has capital letters. `no_domain`: no sending domain is set up for it.","enum":["capitals","no_domain",null],"type":["string","null"]}},"required":["address","from_domain","through","via","warn"],"type":"object"},"type":"array"},"code":{"type":"string"},"store":{"type":"string"},"view":{"type":"string"},"website":{"type":"string"}},"required":["code","store","view","website","addresses"],"type":"object"},"type":"array"},"unmatched":{"description":"The sender domains no sending domain is set up for.","items":{"type":"string"},"type":"array"}},"required":["checked_at","stores","more","unmatched"],"type":"object"},{"type":"null"}]},"test":{"properties":{"last_sent_at":{"format":"date-time","type":["string","null"]},"last_to":{"type":["string","null"]},"remaining_today":{"description":"How many test emails can still be sent today.","type":"integer"}},"required":["last_sent_at","last_to","remaining_today"],"type":"object"},"verified_at":{"format":"date-time","type":["string","null"]}},"required":["state","state_label","sending_domain","default_domain","sender","records","verified_at","last_checked_at","cloudflare","mailpit","operation","test","error","domains","add","store_mapping"],"type":"object"},"EmailState":{"description":"`pending_dns`: the domain exists and waits for its DNS records. `preview`: the site is not live, and its email is caught rather than sent.","enum":["preview","not_set_up","creating","pending_dns","verified","failed","removing"],"type":"string"},"EmailTestRequest":{"properties":{"domain":{"description":"The sending domain to send through, by its name or its `id`. Left out, the default.","type":["string","integer"]},"to":{"description":"The address to send the test to. At most 254 characters, without quotes or angle brackets.","format":"email","maxLength":254,"type":"string"}},"required":["to"],"type":"object"},"EnterpriseCopy":{"properties":{"copied":{"description":"What the run copied. Null until it has ended.","oneOf":[{"properties":{"at":{"format":"date-time","type":["string","null"]},"dangling_links":{"description":"Links among the copied files that point at nothing.","type":"integer"},"db_bytes":{"type":["integer","null"]},"duration_seconds":{"type":["integer","null"]},"files_bytes":{"type":["integer","null"]},"neutralised_at":{"description":"When live settings in the copied data, such as payments and outgoing email, were switched off.","format":"date-time","type":["string","null"]},"unreadable_files":{"description":"Files the copy could not read.","type":"integer"}},"required":["at","files_bytes","db_bytes","duration_seconds","neutralised_at","dangling_links","unreadable_files"],"type":"object"},{"type":"null"}]},"copied_at":{"description":"When the copy's run last ended. A copy's times are sent in UTC with a `+00:00` offset, not `Z`.","format":"date-time","type":["string","null"]},"copy_of":{"description":"The copy this one followed, when it was made by a re-sync.","minimum":1,"type":["integer","null"]},"created_at":{"description":"When the copy was started.","format":"date-time","type":["string","null"]},"database_bytes":{"description":"The size of the environment's database, measured when the copy started.","type":["integer","null"]},"error":{"description":"For a failed copy, what happened and what to do next.","type":["string","null"]},"failure_reason":{"description":"For a failed copy, the stable code of why.","type":["string","null"]},"files_bytes":{"description":"The size of the environment's files, measured when the copy started.","type":["integer","null"]},"finishable":{"description":"Whether the copy itself is ready to be finished. The site's own checks are made when you finish it.","type":"boolean"},"finished_at":{"description":"When the copy was finished.","format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"operation":{"description":"The copy's run, as an operation of the site.","oneOf":[{"properties":{"id":{"minimum":1,"type":"integer"},"status":{"$ref":"#/components/schemas/OperationStatus"},"step":{"type":["string","null"]}},"required":["id","status","step"],"type":"object"},{"type":"null"}]},"phase":{"description":"`presync` until the copy ends, then `done` (finished, or followed by a newer copy) or `failed`.","type":"string"},"source_environment_id":{"minimum":1,"type":"integer"},"state":{"description":"`running` while the copy runs, `waiting` once its run has ended, `failed` when it failed.","type":"string"},"step":{"description":"Where the copy is: `guard`, `transfer`, `fixups` and `check` while it runs, `copied` once its run has\nended, `superseded` when a re-sync followed it, `finished` when it was finished.\n","type":["string","null"]},"superseded_by":{"description":"The copy a re-sync made after this one.","minimum":1,"type":["integer","null"]},"target_cluster_id":{"minimum":1,"type":"integer"},"target_site_id":{"minimum":1,"type":"integer"},"unactivated_at":{"description":"When the site was last checked to be a copy and not a live site.","format":"date-time","type":["string","null"]}},"required":["id","source_environment_id","target_site_id","target_cluster_id","phase","state","step","finishable","error","failure_reason","copy_of","superseded_by","operation","files_bytes","database_bytes","copied_at","copied","unactivated_at","finished_at","created_at"],"type":"object"},"EnterpriseCopyBlocker":{"description":"One reason the copy cannot start now.","properties":{"message":{"type":"string"},"reason":{"description":"The stable code a start refuses with.","type":"string"}},"required":["reason","message"],"type":"object"},"EnterpriseCopyPreview":{"properties":{"blockers":{"description":"Every reason the copy cannot start now, in the order a start checks them.","items":{"$ref":"#/components/schemas/EnterpriseCopyBlocker"},"type":"array"},"can_copy":{"description":"True when `blockers` is empty.","type":"boolean"},"confirm":{"description":"The value to send as `confirm_target_site`.","type":"string"},"copy_of":{"description":"Always null on a preview.","type":["integer","null"]},"source":{"description":"The environment, as this preview read it.","properties":{"environment_id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"platform":{"description":"The application the environment runs, such as `magento2`. Null when it could not be read.","type":["string","null"]},"sizes":{"properties":{"db_bytes":{"type":["integer","null"]},"files_bytes":{"type":["integer","null"]}},"required":["files_bytes","db_bytes"],"type":"object"},"versions":{"properties":{"mariadb":{"type":["string","null"]},"php":{"type":["string","null"]}},"required":["mariadb","php"],"type":"object"},"website_id":{"minimum":1,"type":"integer"}},"required":["environment_id","name","website_id","platform","versions","sizes"],"type":"object"},"target":{"description":"The site the copy would replace.","properties":{"cluster_id":{"minimum":1,"type":"integer"},"domain":{"type":"string"},"mariadb_version":{"type":["string","null"]},"name":{"description":"The site's name, which `confirm_target_site` must equal.","type":"string"},"platform":{"type":"string"},"site_id":{"minimum":1,"type":"integer"}},"required":["site_id","name","domain","cluster_id","platform","mariadb_version"],"type":"object"},"warnings":{"description":"What to know before copying. None of these stops the copy.","items":{"type":"string"},"type":"array"}},"required":["source","target","can_copy","blockers","warnings","confirm","copy_of"],"type":"object"},"EnterpriseCopyResync":{"properties":{"confirm_target_site":{"description":"The name of the copy's site, as the preview answers it in `confirm`.","type":"string"}},"required":["confirm_target_site"],"type":"object"},"EnterpriseCopyStart":{"properties":{"confirm_target_site":{"description":"The site's name, as the preview answers it in `confirm`.","type":"string"},"enterprise_env_id":{"description":"The CoreStack Enterprise environment to copy from.","maximum":2147483647,"minimum":1,"type":"integer"},"target_site_id":{"description":"The CoreCluster site to copy into. Everything it holds is replaced.","maximum":2147483647,"minimum":1,"type":"integer"}},"required":["enterprise_env_id","target_site_id","confirm_target_site"],"type":"object"},"EnterpriseCopyStarted":{"properties":{"copy":{"$ref":"#/components/schemas/EnterpriseCopy"},"poll":{"description":"The path to read the copy at.","type":"string"}},"required":["copy","poll"],"type":"object"},"EnterpriseDeployment":{"description":"A deployment of a CoreStack Enterprise environment. Ids are strings here, except `attempt_id`.\n","properties":{"artifact_pruned_at":{"description":"When the deployment's release archive was removed. A deployment with one cannot be retried or rolled back to. Null while the archive is kept.","type":["string","null"]},"attempt_id":{"description":"The run the deployment is on now. A retry starts a new run with a new id. Null while the deployment has no run.","type":["integer","null"]},"environment_deployment_pipeline_id":{"description":"The pipeline the deployment runs on, as the pipelines list names it.","type":"string"},"environment_id":{"type":"string"},"error":{"description":"Why a failed deployment failed, as the last line of the step that stopped it. Null unless it failed.","type":["string","null"]},"git_author":{"description":"The commit's author, when the push gave one.","oneOf":[{"properties":{"avatar_url":{"type":["string","null"]},"name":{"type":"string"}},"required":["name","avatar_url"],"type":"object"},{"type":"null"}]},"git_commit":{"description":"The commit deployed. Null for an uploaded archive.","type":["string","null"]},"git_commit_url":{"description":"The commit's page at the git provider, when the push that started the deployment gave it.","type":["string","null"]},"git_merge_request":{"description":"The merge request or pull request of the commit, when the push gave one.","oneOf":[{"properties":{"kind":{"enum":["merge_request","pull_request"],"type":"string"},"ref":{"description":"Such as `!12` for a merge request or `#12` for a pull request.","type":"string"},"url":{"type":["string","null"]}},"required":["ref","kind","url"],"type":"object"},{"type":"null"}]},"hash":{"description":"The deployment's own identifier.","type":["string","null"]},"id":{"type":"string"},"name":{"type":["string","null"]},"notes":{"type":["string","null"]},"status":{"description":"The status as a number in a string: `1` Scheduled, `2` Running, `3` Failed, `4` Succeeded, `5` Cancelled,\n`6` Pending (waiting to be deployed by hand), `7` Queued.\n","enum":["1","2","3","4","5","6","7"],"type":"string"},"status_description":{"description":"The name of the status.","enum":["Scheduled","Running","Failed","Succeeded","Cancelled","Pending","Queued",null],"type":["string","null"]}},"required":["id","environment_id","environment_deployment_pipeline_id","name","hash","git_commit","notes","status","status_description","attempt_id","error","artifact_pruned_at","git_commit_url","git_author","git_merge_request"],"type":"object"},"EnterpriseDeploymentAnswer":{"properties":{"deployment":{"$ref":"#/components/schemas/EnterpriseDeployment"}},"required":["deployment"],"type":"object"},"EnterpriseDeploymentArchiveRequest":{"description":"A deployment of an uploaded release archive, sent as `multipart/form-data`.","properties":{"artifact":{"description":"The release archive, a `.tar`, `.tar.gz`, `.tar.xz`, `.tar.zst` or `.zip` of at most 4,000,000 kilobytes. Its contents are checked before anything is deployed.","format":"binary","type":"string"},"name":{"maxLength":255,"type":["string","null"]},"notes":{"maxLength":10000,"type":["string","null"]},"pipeline_id":{"description":"The `id` of one of the environment's pipelines, as the pipelines list names it.","type":"integer"}},"required":["artifact","pipeline_id"],"type":"object"},"EnterpriseDeploymentCommandAnswer":{"properties":{"deployment":{"$ref":"#/components/schemas/EnterpriseDeployment"},"replayed":{"description":"True when this answer repeats the outcome of an earlier request with the same `Idempotency-Key`.","type":"boolean"}},"required":["deployment","replayed"],"type":"object"},"EnterpriseDeploymentCommandRequest":{"properties":{"expected_action_id":{"description":"The `attempt_id` you read. If the deployment has moved on since, the answer is `409` `stale` and nothing happens. Left out, the deployment's current run is used.","minimum":1,"type":["integer","null"]}},"type":"object"},"EnterpriseDeploymentDetail":{"properties":{"deployment":{"$ref":"#/components/schemas/EnterpriseDeployment"},"retry_warning":{"description":"The warning a retry would ask you to confirm with `confirm_older`. Null when a retry would not ask.","type":["string","null"]},"view":{"$ref":"#/components/schemas/EnterpriseDeploymentView"}},"required":["deployment","view","retry_warning"],"type":"object"},"EnterpriseDeploymentGitRequest":{"description":"A deployment of a commit.","properties":{"git":{"const":true,"description":"True to deploy a commit. Without it the request is an archive upload.","type":"boolean"},"git_commit":{"description":"The full commit id, 40 or 64 hexadecimal characters. A short id or a branch name is refused.","pattern":"^(?:[a-fA-F0-9]{40}|[a-fA-F0-9]{64})$","type":"string"},"git_repository":{"description":"The id of one of the environment's repositories. The deployment runs on that repository's pipeline.","type":"integer"},"name":{"description":"A name for the deployment. The commit id when left out.","maxLength":255,"type":["string","null"]},"notes":{"maxLength":10000,"type":["string","null"]}},"required":["git","git_commit","git_repository"],"type":"object"},"EnterpriseDeploymentList":{"properties":{"deployments":{"items":{"$ref":"#/components/schemas/EnterpriseDeployment"},"type":"array"},"next_cursor":{"description":"Present only when the list is paged, which is why this list does not compose the shared `CursorPage`. Send it as `cursor` to read the next page. Null on the last page.","type":["string","null"]}},"required":["deployments"],"type":"object"},"EnterpriseDeploymentRetryRequest":{"properties":{"confirm_older":{"description":"True to retry a deployment that is not the environment's newest.","type":"boolean"},"expected_action_id":{"description":"The `attempt_id` you read. If the deployment has moved on since, the answer is `409` `stale` and nothing happens.","minimum":1,"type":["integer","null"]},"from":{"default":"start","description":"`start` runs the whole pipeline again. `failed_step` carries on from the step that failed, where the\ndeployment's `view.actions` lists `retry_from_step`. A key used for one is a different request for the\nother.\n","enum":["start","failed_step"],"type":"string"}},"type":"object"},"EnterpriseDeploymentRunRequest":{"properties":{"expected_action_id":{"description":"The `attempt_id` you read. If the deployment has moved on since, the answer is `409` `stale` and nothing happens.","minimum":1,"type":["integer","null"]},"pipeline_id":{"description":"Start the deployment on this pipeline of the environment instead of its own.","minimum":1,"type":"integer"}},"type":"object"},"EnterpriseDeploymentSettings":{"properties":{"deployment_source":{"description":"Where deployments come from.","enum":["manual","sftp","git",null],"type":["string","null"]},"deployment_sources":{"description":"The sources the environment may be set to. `sftp` is listed only for an environment that still uses it.","items":{"enum":["manual","sftp","git"],"type":"string"},"type":"array"},"enterprise_env_id":{"description":"The environment's id.","type":"integer"},"git_deploys":{"description":"`automatic` deploys every push on its own. `manual` leaves each push waiting to be deployed. Null unless\nthe pipeline is on and the source is `git`.\n","enum":["manual","automatic",null],"type":["string","null"]},"pipeline_enabled":{"description":"Whether the deployment pipeline is on.","type":"boolean"},"pipelines":{"items":{"properties":{"build_switches_editable":{"description":"Whether you may change the pipeline's build switches.","type":"boolean"},"folders_editable":{"description":"Whether you may change the pipeline's folders.","type":"boolean"},"isolate_build_var":{"description":"Whether a build keeps its own `var` folder. Null on a pipeline it does not apply to.","type":["boolean","null"]},"name":{"type":"string"},"notes":{"description":"What to know about the build switches as they are set. Empty when nothing.","items":{"type":"string"},"type":"array"},"pause_crons_during_build":{"description":"Whether scheduled tasks pause while a build runs. Null on a pipeline it does not apply to.","type":["boolean","null"]},"pipeline_id":{"type":"integer"},"root_directory":{"description":"The pipeline's web folder.","type":"string"},"root_storage":{"description":"The pipeline's storage folder.","type":"string"}},"required":["pipeline_id","name","root_directory","root_storage","folders_editable","pause_crons_during_build","isolate_build_var","build_switches_editable","notes"],"type":"object"},"type":"array"},"repositories":{"description":"How many repositories the environment has.","type":"integer"}},"required":["enterprise_env_id","pipeline_enabled","deployment_source","deployment_sources","git_deploys","repositories","pipelines"],"type":"object"},"EnterpriseDeploymentSettingsAnswer":{"properties":{"deployment_settings":{"$ref":"#/components/schemas/EnterpriseDeploymentSettings"}},"required":["deployment_settings"],"type":"object"},"EnterpriseDeploymentSettingsRequest":{"description":"Send only what changes, and at least one setting.","properties":{"confirm_remove_repositories":{"description":"True to move an environment that has repositories off git, which removes them and their webhooks.","type":"boolean"},"deployment_source":{"description":"`manual` or `git`. `sftp` is accepted only for an environment that already uses it.","enum":["manual","git","sftp"],"type":"string"},"git_deploys":{"description":"Whether a push deploys on its own. Applies only while the pipeline is on and the source is `git`.","enum":["manual","automatic"],"type":"string"},"isolate_build_var":{"description":"Whether a build keeps its own `var` folder. Only on a pipeline it applies to.","type":"boolean"},"pause_crons_during_build":{"description":"Whether scheduled tasks pause while a build runs. Only on a pipeline it applies to.","type":"boolean"},"pipeline_enabled":{"description":"Turn the deployment pipeline on or off.","type":"boolean"},"pipeline_id":{"description":"The pipeline whose folders or build switches change. Goes with at least one of them.","minimum":1,"type":"integer"},"root_directory":{"description":"The pipeline's web folder: an absolute path that starts and ends with a slash, of letters, digits, `.`,\n`_`, `-` and `/`, with no `..` part, at most 255 characters, under `/var/www/`, `/var/www_m2/`,\n`/var/www_vsf/` or `/var/www_blog/`, and never one of those itself.\n","maxLength":255,"pattern":"^/[A-Za-z0-9._/-]*/$","type":"string"},"root_storage":{"description":"The pipeline's storage folder, held to the same rule as `root_directory`.","maxLength":255,"pattern":"^/[A-Za-z0-9._/-]*/$","type":"string"}},"type":"object"},"EnterpriseDeploymentView":{"description":"What the deployment's page in the Control Panel shows you.","properties":{"actions":{"description":"The other actions you may take.","items":{"enum":["rollback","retry_from_step","cancel_scheduled","download_log"],"type":"string"},"type":"array"},"blocked_by":{"description":"The id of the deployment this one waits behind, with `queued_mode` `blocked`. A number here.","type":["integer","null"],"x-unverified":true},"crons_paused":{"description":"What the page says when scheduled tasks and queues stay paused after a failed or stopped deployment. Null when there is nothing to say.","properties":{"message":{"type":"string"},"state":{"enum":["database_failed","revert_unfinished"],"type":"string"}},"required":["state","message"],"type":["object","null"]},"is_stopping":{"type":"boolean"},"maintenance_lift":{"description":"What the page says about maintenance mode a failed deployment switched on. Null when there is nothing to say.","properties":{"message":{"type":"string"},"state":{"enum":["switching_off","switched_off","not_switched_off"],"type":"string"}},"required":["state","message"],"type":["object","null"]},"primary_action":{"description":"The action the page offers first.","properties":{"action":{"description":"Such as `run`, `stop`, `cancel` or `retry`. `stop` is the cancel endpoint here.","type":["string","null"]},"disabled_reason":{"type":["string","null"]},"enabled":{"type":"boolean"}},"required":["action","enabled","disabled_reason"],"type":"object"},"queued_mode":{"description":"Why a queued deployment waits: `manual` (for a person to deploy it), `blocked` (behind another deployment),\n`awaiting_previous` (behind its own earlier attempt), `paused` (deployments are paused for the moment) or\n`dispatched` (it is about to start). Null when it is not queued.\n","enum":["manual","blocked","awaiting_previous","paused","dispatched",null],"type":["string","null"],"x-unverified":true},"refused_actions":{"description":"The actions the deployment calls for that your role may not take, each with the reason.","items":{"properties":{"action":{"type":"string"},"disabled_reason":{"type":"string"}},"required":["action","disabled_reason"],"type":"object"},"type":"array"},"state":{"description":"The page's state.","enum":["succeeded","running","failed","queued","skipped","cancelled","scheduled_legacy"],"type":"string"},"stop_termination":{"description":"Set when a stopped deployment's work could not be confirmed as ended. Null otherwise.","properties":{"checked_at":{"format":"date-time","type":"string"},"state":{"const":"not_terminated","type":"string"}},"required":["state","checked_at"],"type":["object","null"],"x-unverified":true},"superseded_by":{"description":"The id of the deployment that replaced this one, if any. A number here.","type":["integer","null"],"x-unverified":true}},"required":["state","queued_mode","blocked_by","superseded_by","is_stopping","primary_action","actions","refused_actions","maintenance_lift","crons_paused","stop_termination"],"type":"object"},"EnterprisePipeline":{"description":"One deployment pipeline of an environment.","properties":{"classic":{"description":"What a classic pipeline runs, in order. Null for a pipeline that runs in three stages.","oneOf":[{"$ref":"#/components/schemas/EnterprisePipelineClassic"},{"type":"null"}]},"custom_commands":{"description":"The pipeline's own build commands, one a line, with credentials redacted.","type":["string","null"]},"deployment_pipeline":{"additionalProperties":true,"description":"The shared pipeline this one is based on.","properties":{"id":{"type":"string"},"name":{"type":"string"},"platforms":{"description":"The platforms the shared pipeline is for.","items":{"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"}},"required":["id","slug","name"],"type":"object"},"type":"array"},"slug":{"type":"string"}},"required":["id","slug","name"],"type":"object"},"id":{"description":"The id a deployment, a repository and the deployment settings name this pipeline by.","type":"string"},"notes":{"type":["string","null"]},"pipeline_id":{"description":"The id of the shared pipeline this one is based on.","type":"string"},"post_hook_commands":{"description":"The pipeline's own post build commands, one a line, with credentials redacted.","type":["string","null"]},"root_directory":{"description":"The web folder the pipeline deploys to.","type":["string","null"]},"root_storage":{"description":"The storage folder the pipeline uses.","type":["string","null"]},"stage_model":{"description":"`three_stage` for a pipeline that runs in build, database and after-deploy stages. Null for a classic pipeline.","enum":["three_stage",null],"type":["string","null"]},"tag":{"type":["string","null"]},"use_custom_commands":{"description":"True when the pipeline runs its own build commands instead of the shared ones.","type":"boolean"},"use_custom_post_hook_commands":{"type":"boolean"}},"required":["id","notes","tag","root_directory","root_storage","use_custom_commands","custom_commands","use_custom_post_hook_commands","post_hook_commands","pipeline_id","stage_model","classic"],"type":"object"},"EnterprisePipelineClassic":{"properties":{"pipeline_version":{"description":"The environment's deployment pipeline version.","type":"integer"},"runs":{"description":"False when the pipeline runs nothing yet.","type":"boolean"},"sections":{"items":{"properties":{"key":{"description":"Such as `build` or `post_build`.","type":"string"},"label":{"type":"string"},"lines":{"items":{"properties":{"command":{"description":"The command, with credentials redacted.","type":"string"},"comments":{"items":{"type":"string"},"type":"array"},"label":{"type":"string"}},"required":["label","command","comments"],"type":"object"},"type":"array"},"source":{"description":"Whose commands these are. `custom` is the pipeline's own, `shared` the shared pipeline's, `platform` the platform's.","enum":["custom","shared","platform"],"type":"string"}},"required":["key","label","source","lines"],"type":"object"},"type":"array"}},"required":["pipeline_version","runs","sections"],"type":"object"},"EnterprisePipelineList":{"properties":{"environment_deployment_pipelines":{"items":{"$ref":"#/components/schemas/EnterprisePipeline"},"type":"array"}},"required":["environment_deployment_pipelines"],"type":"object"},"EnterpriseRepository":{"description":"A git repository an environment deploys from.","properties":{"branch":{"description":"The branch deployed. Null when `connection_hidden` is true.","type":["string","null"]},"connection_hidden":{"description":"True when the repository was set up with a git account you cannot use. You cannot change such a repository.","type":"boolean"},"connection_owner":{"description":"The agency that set the repository up, when it is hidden and you belong to the company that agency manages. Null otherwise.","type":["string","null"]},"environment_deployment_pipeline_id":{"description":"The pipeline the repository deploys with.","type":["string","null"]},"id":{"type":"string"},"provider":{"description":"The git provider, such as `github`. Null when `connection_hidden` is true.","type":["string","null"]},"repo":{"description":"The repository's path at the provider. Null when `connection_hidden` is true.","type":["string","null"]}},"required":["id","environment_deployment_pipeline_id","provider","repo","branch","connection_hidden","connection_owner"],"type":"object"},"EnterpriseRepositoryAnswer":{"properties":{"environment_repository":{"$ref":"#/components/schemas/EnterpriseRepository"}},"required":["environment_repository"],"type":"object"},"EnterpriseRepositoryConnectionList":{"properties":{"connections":{"items":{"properties":{"company":{"description":"The company the account belongs to.","type":"string"},"id":{"type":"string"},"provider":{"description":"The git provider, such as `github`, `gitlab`, `bitbucket` or `gitlab_self_hosted`.","type":"string"},"username":{"description":"The account's name at the provider.","type":"string"}},"required":["id","provider","username","company"],"type":"object"},"type":"array"}},"required":["connections"],"type":"object"},"EnterpriseRepositoryList":{"properties":{"can_manage":{"$ref":"#/components/schemas/Availability","description":"Whether your role may remove a repository."},"can_set":{"$ref":"#/components/schemas/Availability","description":"Whether your role may add or change a repository."},"environment_repositories":{"items":{"$ref":"#/components/schemas/EnterpriseRepository"},"type":"array"}},"required":["environment_repositories","can_manage","can_set"],"type":"object"},"EnterpriseRepositoryRequest":{"properties":{"branch":{"description":"The branch to deploy. No spaces, no `..`, and no `-` at the start.","maxLength":255,"minLength":1,"pattern":"^(?!-)(?!.*\\.\\.)\\S+$","type":"string"},"connection_id":{"description":"The `id` of a git account `GET /environments/{environment}/repositories/connections` lists. The repository's provider is the account's.","type":"integer"},"pipeline_id":{"description":"The `id` of the environment's pipeline the repository deploys with. A missing or wrong value is reported on `environment_deployment_pipeline_id`.","type":"integer"},"repo":{"description":"The repository's path at the provider, such as `northwind-digital/harbourandfinch-trade`: parts of\nletters, digits, `.`, `_` and `-` separated by `/`, none of them `.` or `..`, at most 255 characters.\nExactly `owner/name` for a GitHub or Bitbucket account; two or more parts for a GitLab account.\n","maxLength":255,"pattern":"^[A-Za-z0-9._-]+(/[A-Za-z0-9._-]+)+$","type":"string"},"root_directory":{"description":"The folder of the repository that is deployed, such as `/web` or `apps/site`; `/` for the whole\nrepository. Letters, digits, `_`, `.`, `-` and `/` only, with no `..` part, at most 255 characters.\n","maxLength":255,"minLength":1,"pattern":"^[A-Za-z0-9_./-]+$","type":"string"}},"required":["connection_id","pipeline_id","repo","branch","root_directory"],"type":"object"},"EnterpriseVariable":{"description":"One variable of an environment. Never its value.","properties":{"masked":{"description":"The mask shown in place of the value. A value of 16 characters or more also shows its last four.","type":"string"},"name":{"description":"The name, without the `CF_` prefix builds see it with.","type":"string"},"replaces_platform":{"description":"Whether the name is one CoreStack sets itself, so this value replaces the platform's.","type":"boolean"},"tool_credential":{"description":"A sentence saying the build tool named never reads this variable, when the name is one a build tool reads\nits own credentials from and no stage reads it. Null otherwise.\n","type":["string","null"]},"updated_at":{"description":"When the variable last changed, in UTC.","format":"date-time","type":["string","null"]},"used_in":{"description":"The deployment stages whose commands read the variable.","items":{"enum":["build","database","post_deploy"],"type":"string"},"type":"array"}},"required":["name","masked","replaces_platform","used_in","tool_credential","updated_at"],"type":"object"},"EnterpriseVariableList":{"properties":{"count":{"description":"How many variables the environment has.","minimum":0,"type":"integer"},"limit":{"description":"How many it can hold.","minimum":0,"type":"integer"},"variables":{"items":{"$ref":"#/components/schemas/EnterpriseVariable"},"type":"array"}},"required":["variables","count","limit"],"type":"object"},"EnterpriseVariableRevealed":{"properties":{"name":{"type":"string"},"value":{"description":"The stored value. An empty string for a cleared variable.","type":"string"}},"required":["name","value"],"type":"object"},"EnterpriseVariableSaved":{"properties":{"variable":{"properties":{"masked":{"description":"The mask shown in place of the value. A value of 16 characters or more also shows its last four.","type":"string"},"name":{"type":"string"},"updated_at":{"description":"When the variable last changed, in UTC.","format":"date-time","type":["string","null"]}},"required":["name","masked","updated_at"],"type":"object"}},"required":["variable"],"type":"object"},"EnterpriseVariableSetRequest":{"additionalProperties":false,"properties":{"rename_to":{"description":"A new name for the variable, which keeps its value unless `value` changes it in the same request: letters,\ndigits and underscores, starting with a letter or underscore, at most 64 characters, and not starting\nwith `CF_` in any case. Null, or the name it already has, renames nothing.\n","maxLength":64,"pattern":"^[A-Za-z_][A-Za-z0-9_]*$","type":["string","null"]},"value":{"description":"Leave out to keep the stored value. An empty string or null clears it. Any other string sets it, exactly\nas sent: at most 2,048 characters, with no line breaks, control or invisible formatting characters.\n","maxLength":2048,"type":["string","null"]}},"type":"object"},"EnvironmentAdminLoginReset":{"properties":{"command":{"$ref":"#/components/schemas/Command"},"secret":{"description":"The new login, once. Only when the run has finished.","properties":{"password":{"type":"string"},"revealed_at":{"format":"date-time","type":"string"},"url":{"description":"The address to sign in at.","type":["string","null"]},"username":{"type":"string"}},"required":["username","password"],"type":"object"}},"required":["command"],"type":"object"},"EnvironmentAdminLoginResetRequest":{"properties":{"confirm":{"const":true,"description":"Always `true`: the reset replaces the password. Left out or false, the request is refused `422` on `confirm`.","type":"boolean"},"username":{"description":"The administrator to reset. Left out, the one the site's current database was created with. On a WordPress or Magento 2 site, up to 60 letters, digits, `_`, `.`, `@`, `+` or `-`, never starting with `+` or `-`. On a Shopware site, up to 32 of the same characters, never starting with `@`, `+` or `-`. Anything else is refused `422` on `username`.","maxLength":60,"minLength":1,"pattern":"^[A-Za-z0-9_.@][A-Za-z0-9_.@+-]{0,59}$","type":["string","null"]}},"required":["confirm"],"type":"object"},"EnvironmentCreate":{"additionalProperties":false,"description":"A field that is not listed here is refused `422` on that field.","not":{"required":["tier","uat_size"]},"properties":{"mariadb_version":{"description":"The site's own version when left out.","type":"string"},"name":{"$ref":"#/components/schemas/EnvironmentName"},"node_acknowledge":{"description":"Send `[\"eol\"]` to accept a Node.js major that is past its end of life.","items":{"enum":["eol"],"type":"string"},"maxItems":1,"type":"array"},"node_major":{"description":"The Node.js major to run, while Node.js is on for your company.","maximum":99,"minimum":1,"type":"integer"},"php_version":{"description":"The site's own version when left out.","type":"string"},"slug":{"description":"The short name used in the environment's address: 2 to 16 lower-case letters, digits or dashes, starting with a letter. Made from `name` when left out.","pattern":"^[a-z][a-z0-9-]{1,15}$","type":"string"},"source":{"$ref":"#/components/schemas/EnvironmentCreateSource"},"start_from_template":{"default":false,"description":"True to start from your company's deployment template, while templates are on.","type":"boolean"},"tier":{"description":"The tier, for a site in a CoreCluster. The site's own tier when left out. Refused on a CoreStack site, which takes `uat_size`; never sent beside `uat_size`.","type":"string"},"uat_size":{"description":"The staging size, for a CoreStack site: a `key` of the staging sizes. Refused on a site in a CoreCluster.","type":"string"}},"required":["name","source"],"type":"object"},"EnvironmentCreateSource":{"description":"Where the environment's data comes from, chosen by `type`. Each kind takes its own fields only; a field of another kind is refused `422` on that field.","oneOf":[{"$ref":"#/components/schemas/EnvironmentCreateSourceEmpty"},{"$ref":"#/components/schemas/EnvironmentCreateSourceClone"},{"$ref":"#/components/schemas/EnvironmentCreateSourceBranch"}]},"EnvironmentCreateSourceBranch":{"additionalProperties":false,"description":"An environment that deploys a branch of the site's connected repository. For WordPress sites only; any other platform is refused `422` on `source.type`, as is any site while copying or deployments are switched off for your company. A site with no repository connected is refused `409`.","properties":{"auto_deploy":{"description":"Whether a push to the branch deploys. Left out, the environment follows the production row's setting.","type":"boolean"},"branch":{"description":"The name of a branch that exists in the site's connected repository. A commit id is not a branch.","minLength":1,"type":"string"},"data_from_environment_id":{"description":"The site row to copy files and database from. Left out, the environment starts without data.","minimum":1,"type":["integer","null"]},"type":{"const":"branch","type":"string"}},"required":["type","branch"],"type":"object"},"EnvironmentCreateSourceClone":{"additionalProperties":false,"description":"A copy of another environment of the site. Refused `422` on `source.type` while copying is switched off for your company.","properties":{"anonymise":{"default":false,"description":"Whether personal data is anonymised in the copy. For a Shopware site only, where the database is copied (`scope` `files_db` or `db`) from the live environment and not from a snapshot; anything else is refused `422` on `source.anonymise`.","type":"boolean"},"environment_id":{"description":"The site row to copy from, one of this site that you may change. Left out, or a row that is not one of them, the request answers `404`. A row that is not ready is refused `409` `source_busy`.","minimum":1,"type":"integer"},"scope":{"default":"files_db","description":"What to copy. A Magento 2 site takes `files_db` only; `db` or `files` is refused `422` `magento_crypt_mismatch` on `source.scope`.","enum":["files_db","db","files"],"type":"string"},"snapshot_id":{"description":"A ready snapshot of that row to copy instead of the live environment. Any other id answers `404`.","minimum":1,"type":["integer","null"]},"type":{"const":"clone","type":"string"}},"required":["type","environment_id"],"type":"object"},"EnvironmentCreateSourceEmpty":{"additionalProperties":false,"description":"An environment that starts without data.","properties":{"type":{"const":"empty","type":"string"}},"required":["type"],"type":"object"},"EnvironmentCreated":{"properties":{"credentials":{"oneOf":[{"$ref":"#/components/schemas/EnvironmentCredentials"},{"type":"null"}]},"environment":{"$ref":"#/components/schemas/SiteDetail"},"operation":{"$ref":"#/components/schemas/Operation"}},"required":["environment","operation","credentials"],"type":"object"},"EnvironmentCredentials":{"description":"The generated HTTP authentication login of the new environment.","properties":{"password":{"description":"Null for a token without the `exec` scope.","type":["string","null"]},"password_withheld":{"description":"Only for a token without the `exec` scope: why the password is null.","properties":{"message":{"type":"string"},"scope":{"description":"The scope that shows the password: `exec`.","type":"string"}},"required":["scope","message"],"type":"object"},"revealed_at":{"format":"date-time","type":"string"},"rule_id":{"description":"The HTTP authentication rule that protects the environment.","minimum":1,"type":"integer"},"user_id":{"description":"The login's id among the site's HTTP authentication users.","minimum":1,"type":"integer"},"username":{"type":"string"}},"required":["rule_id","user_id","username","password","revealed_at"],"type":"object"},"EnvironmentGroup":{"properties":{"branches":{"$ref":"#/components/schemas/Availability"},"can_create":{"$ref":"#/components/schemas/Availability"},"clone":{"$ref":"#/components/schemas/Availability"},"environments":{"description":"The production row first, then every environment.","items":{"$ref":"#/components/schemas/EnvironmentSummary"},"type":"array"},"limits":{"properties":{"name_max":{"type":"integer"},"slug_max":{"type":"integer"}},"required":["name_max","slug_max"],"type":"object"},"production":{"description":"The production row. Null for a site that has staging environments only.","oneOf":[{"$ref":"#/components/schemas/EnvironmentRef"},{"type":"null"}]},"queued_copies":{"description":"Copies waiting their turn onto the site's rows, each as `getQueuedCopy` answers it.","items":{"$ref":"#/components/schemas/CopyQueueEntry"},"type":"array"},"site":{"properties":{"cluster":{"oneOf":[{"$ref":"#/components/schemas/ClusterRef"},{"type":"null"}]},"domain":{"type":"string"},"id":{"minimum":1,"type":"integer"},"lifecycle":{"description":"Where the site is in its life, such as `active` or `deleted`.","type":"string"},"platform":{"properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"],"type":"object"}},"required":["id","domain","platform","cluster","lifecycle"],"type":"object"},"sizing":{"description":"How a new environment is sized. A site in a CoreCluster is sized by `tier`, and every other field is null. A CoreStack site is sized by `uat_size`, with the sizes on offer.","properties":{"by":{"enum":["tier","uat_size"],"type":"string"},"default":{"description":"The `key` of the size to start on: the included size, or the next one up the platform takes. Null when sized by tier.","type":["string","null"]},"included":{"description":"The staging environment the site's package includes. Null when sized by tier, or when the package includes none.","oneOf":[{"properties":{"free":{"description":"True while a new environment would take the included place.","type":"boolean"},"size":{"description":"The `key` of the included size.","type":"string"}},"required":["size","free"],"type":"object"},{"type":"null"}]},"pricing":{"description":"What to price a size with. Null when sized by tier, and while nothing is charged for the environment.","oneOf":[{"properties":{"currency":{"description":"The currency code, such as `GBP`.","type":"string"},"region":{"description":"The region code, such as `uk`.","type":"string"}},"required":["currency","region"],"type":"object"},{"type":"null"}]},"refused":{"description":"Only on a Shopware site sized by `uat_size`: the sizes Shopware does not take, each with why.","items":{"properties":{"key":{"type":"string"},"reason":{"type":"string"}},"required":["key","reason"],"type":"object"},"type":"array"},"search_offered":{"description":"Only on a Shopware site sized by `uat_size`: the `key` of each size that can run search.","items":{"type":"string"},"type":"array"},"sizes":{"description":"The staging sizes the request accepts for this site's platform, smallest first. Null when sized by tier.","items":{"properties":{"cores":{"type":"number"},"disk_gb":{"type":"number"},"key":{"description":"The value to send as `uat_size`.","type":"string"},"label":{"type":"string"},"memory_gib":{"type":"number"}},"required":["key","label","cores","memory_gib","disk_gb"],"type":"object"},"type":["array","null"]}},"required":["by","default","sizes","included","pricing"],"type":"object"},"sources":{"description":"What a new environment can be copied from.","items":{"properties":{"can_clone":{"$ref":"#/components/schemas/Availability"},"environment":{"$ref":"#/components/schemas/EnvironmentRef"}},"required":["environment","can_clone"],"type":"object"},"type":"array"}},"required":["site","production","environments","can_create","sources","branches","clone","queued_copies","limits","sizing"],"type":"object"},"EnvironmentName":{"description":"A label of 1 to 40 characters without `<`, `>` or control characters. Spaces, tabs and line breaks around it are taken off first and do not count.","pattern":"^[ \\t\\n\\r\\x00\\x0B]*[^<>\\x00-\\x20\\x7F]([^<>\\x00-\\x1F\\x7F]{0,38}[^<>\\x00-\\x20\\x7F])?[ \\t\\n\\r\\x00\\x0B]*$","type":"string"},"EnvironmentPreviewCredentials":{"properties":{"password":{"type":"string"},"revealed_at":{"format":"date-time","type":"string"},"url":{"description":"The environment's platform address.","type":["string","null"]},"username":{"type":"string"}},"required":["url","username","password","revealed_at"],"type":"object"},"EnvironmentRef":{"additionalProperties":true,"description":"One environment of a website, addressed by its site row.","properties":{"env_id":{"description":"The environment's platform identifier.","type":"string"},"hostname":{"description":"The environment's own address on the platform.","type":"string"},"id":{"description":"The site row id, the `{site}` every `/corestack/sites/{site}` endpoint takes.","type":"integer"},"name":{"type":"string"},"role":{"description":"The environment's role, such as `production` or `staging`.","type":"string"},"role_label":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug","role","role_label","hostname","env_id"],"type":"object"},"EnvironmentRegistrySecret":{"description":"One saved registry credential. Never its token or its username.","properties":{"auth_type":{"$ref":"#/components/schemas/EnvironmentRegistrySecretAuthType"},"id":{"minimum":1,"type":"integer"},"kind":{"const":"composer","description":"Always `composer` on these endpoints.","type":"string"},"label":{"description":"The name you gave the credential.","type":"string"},"last4":{"description":"The last four characters of the token. Null for a token shorter than 12 characters.","type":["string","null"]},"last_used_at":{"description":"When a build last received the credential, in UTC.","format":"date-time","type":["string","null"]},"registry":{"description":"The registry's host, in lower case, with its port when that is not 443.","type":"string"},"scope":{"description":"Always an empty string for a Composer registry.","type":"string"},"verified_at":{"description":"When the registry last accepted the credential, in UTC. Null when it has not been checked since it last changed.","format":"date-time","type":["string","null"]}},"required":["id","kind","label","registry","scope","auth_type","last4","verified_at","last_used_at"],"type":"object"},"EnvironmentRegistrySecretAnswer":{"properties":{"data":{"$ref":"#/components/schemas/EnvironmentRegistrySecret"}},"required":["data"],"type":"object"},"EnvironmentRegistrySecretAuthType":{"description":"How the registry signs in.","enum":["http-basic","bearer","github-oauth","gitlab-token"],"type":"string"},"EnvironmentRegistrySecretCreateRequest":{"allOf":[{"if":{"properties":{"auth_type":{"const":"http-basic"}},"required":["auth_type"]},"then":{"properties":{"username":{"minLength":1}},"required":["username"]}}],"description":"The fields of a new credential. `username` is required when `auth_type` is `http-basic`. A field that is not one of these five is ignored.","properties":{"auth_type":{"$ref":"#/components/schemas/EnvironmentRegistrySecretAuthType"},"label":{"description":"A name for the credential, on one line. Spaces around it are removed, and it cannot be blank.","maxLength":255,"minLength":1,"type":"string"},"registry":{"description":"The registry's host name, with a port if it needs one. No scheme, path or spaces.","maxLength":255,"type":"string"},"secret":{"description":"The token or password, kept exactly as sent. No line breaks or control characters.","maxLength":4096,"minLength":1,"type":"string","writeOnly":true},"username":{"description":"The username, with no line breaks or control characters. Required and not blank for `http-basic`, and not kept for any other sign-in type.","maxLength":255,"type":"string"}},"required":["label","registry","auth_type","secret"],"type":"object"},"EnvironmentRegistrySecretUpdateRequest":{"description":"Any of the fields of a new credential, each under the rules of a new one. At least one; a field that is not\none of these five is ignored, and a body with none of them is refused. Changing `auth_type` to `http-basic`\nneeds a `username`, in the request or already saved.\n","minProperties":1,"properties":{"auth_type":{"$ref":"#/components/schemas/EnvironmentRegistrySecretAuthType"},"label":{"maxLength":255,"minLength":1,"type":"string"},"registry":{"maxLength":255,"type":"string"},"secret":{"maxLength":4096,"minLength":1,"type":"string","writeOnly":true},"username":{"maxLength":255,"type":"string"}},"type":"object"},"EnvironmentRegistrySecretVerified":{"properties":{"data":{"$ref":"#/components/schemas/EnvironmentRegistrySecret"},"message":{"description":"What the registry answered, in plain words.","type":"string"},"verified":{"description":"Whether the registry accepted the credential.","type":"boolean"}},"required":["data","verified","message"],"type":"object"},"EnvironmentResized":{"description":"What a priced change to a site row answers; a size change of a site answers the same.","properties":{"item":{"oneOf":[{"$ref":"#/components/schemas/PendingChangeItem"},{"type":"null"}]},"operation":{"oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"pending":{"$ref":"#/components/schemas/PendingChanges"},"queued":{"description":"True when the resize waits for the maintenance window.","type":"boolean"},"quote":{"description":"The price the resize was accepted at. Null when the site has no billing contract.","oneOf":[{"$ref":"#/components/schemas/BillingQuote"},{"type":"null"}]},"site":{"$ref":"#/components/schemas/SiteDetail"},"window":{"description":"Only for a queued resize while maintenance windows are on: the window it waits for.","oneOf":[{"$ref":"#/components/schemas/QueuedWindow"},{"type":"null"}]}},"required":["site","operation","queued","item","quote","pending"],"type":"object"},"EnvironmentSettingsSaved":{"properties":{"operation":{"oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"site":{"$ref":"#/components/schemas/SiteDetail"}},"required":["site","operation"],"type":"object"},"EnvironmentStagingSizes":{"properties":{"included":{"additionalProperties":{"properties":{"count":{"type":"integer"},"size":{"type":"string"}},"required":["size","count"],"type":"object"},"description":"What each package includes, by package key: the size and how many environments of it.","type":"object"},"refused":{"description":"Only for `platform=shopware`: the sizes that platform does not take, each with why.","items":{"properties":{"key":{"type":"string"},"reason":{"type":"string"}},"required":["key","reason"],"type":"object"},"type":"array"},"sizes":{"items":{"properties":{"cores":{"type":"number"},"disk_gb":{"type":"number"},"key":{"description":"The value to send as `uat_size`.","type":"string"},"label":{"type":"string"},"memory_gib":{"type":"number"},"requests":{"description":"What a staging environment of this size is guaranteed.","properties":{"cpu_millicores":{"type":"integer"},"memory_bytes":{"type":"integer"}},"required":["cpu_millicores","memory_bytes"],"type":"object"},"sort":{"description":"The size's place in the list, smallest first.","type":"integer"}},"required":["key","label","cores","memory_gib","disk_gb","requests","sort"],"type":"object"},"type":"array"}},"required":["sizes","included"],"type":"object"},"EnvironmentStartsWith":{"properties":{"firewall":{"description":"The addresses and presets that reach the new environment. Null while this is not available for the site.","oneOf":[{"$ref":"#/components/schemas/EnvironmentStartsWithFirewall"},{"type":"null"}]},"http_auth":{"properties":{"enabled":{"description":"Always true. A new environment is protected by HTTP authentication from the start.","type":"boolean"}},"required":["enabled"],"type":"object"},"ssh":{"description":"The keys the new environment gets. Null while this is not available for the site.","oneOf":[{"$ref":"#/components/schemas/EnvironmentStartsWithSsh"},{"type":"null"}]}},"required":["firewall","ssh","http_auth"],"type":"object"},"EnvironmentStartsWithFirewall":{"properties":{"closed_to_others":{"description":"True when SSH is closed to every address that is not on the list.","type":"boolean"},"inherited":{"description":"How many addresses the environment inherits: the website's own and those of its company, the company's\nagencies and their users. Only addresses that apply now are counted.\n","type":"integer"},"items":{"description":"One line per address, the nearest level first.","items":{"properties":{"cidr":{"description":"The address or range, in CIDR form.","type":"string"},"layer":{"$ref":"#/components/schemas/EnvironmentStartsWithLayer"},"owner":{"$ref":"#/components/schemas/EnvironmentStartsWithOwner"},"scope":{"description":"What the address may reach.","enum":["both","ssh","web"],"type":"string"}},"required":["cidr","scope","layer","owner"],"type":"object"},"type":"array"},"presets":{"description":"The presets that reach every environment of the website.","items":{"properties":{"layer":{"$ref":"#/components/schemas/EnvironmentStartsWithLayer"},"name":{"type":"string"},"owner":{"$ref":"#/components/schemas/EnvironmentStartsWithOwner"},"ranges":{"description":"How many ranges the preset holds.","type":"integer"},"slug":{"type":"string"}},"required":["name","slug","ranges","layer","owner"],"type":"object"},"type":"array"},"stage":{"description":"The stage of the firewall the environment joins. Only `enforce` closes anything.","enum":["dark","prepare","enforce","paused","deferred"],"type":"string"}},"required":["inherited","items","presets","stage","closed_to_others"],"type":"object"},"EnvironmentStartsWithLayer":{"description":"The level the line comes from.","enum":["website","company","agency","user"],"type":"string"},"EnvironmentStartsWithOwner":{"description":"Who holds the address, preset or key.","properties":{"id":{"description":"The owner's id of that type. A website's is the id the websites list answers, not a site row id.","minimum":1,"type":["integer","null"]},"name":{"type":["string","null"]},"type":{"description":"Such as `website`, `company` or `user`.","type":["string","null"]}},"required":["type","id","name"],"type":"object"},"EnvironmentStartsWithSsh":{"properties":{"items":{"description":"One line per key, the nearest level first. A key granted at two levels is listed once.","items":{"properties":{"layer":{"$ref":"#/components/schemas/EnvironmentStartsWithLayer"},"name":{"type":"string"},"owner":{"$ref":"#/components/schemas/EnvironmentStartsWithOwner"}},"required":["name","layer","owner"],"type":"object"},"type":"array"},"keys":{"description":"How many SSH keys the environment gets.","type":"integer"}},"required":["keys","items"],"type":"object"},"EnvironmentSummary":{"allOf":[{"$ref":"#/components/schemas/EnvironmentRef"},{"properties":{"anonymised_at":{"description":"Only while restores into any environment are on: when the row's data was anonymised.","format":"date-time","type":["string","null"]},"anonymised_rows":{"description":"Only while restores into any environment are on: how many rows were anonymised.","type":["integer","null"]},"app_version":{"description":"The row's application version. Only while application versions are on for your company.","type":["object","null"]},"auto_deploy":{"type":"boolean"},"branch":{"description":"The branch a Git environment deploys.","type":["string","null"]},"create_failed":{"description":"True when the environment could not be created.","type":"boolean"},"created_at":{"format":"date-time","type":["string","null"]},"created_by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"deploy_mode":{"description":"How the environment is deployed, such as `manual` or `git`.","type":["string","null"]},"final_restorable_until":{"description":"Only where it applies: until when the final snapshot stays restorable.","type":["string","null"]},"final_snapshot_note":{"description":"Only where it applies: what deleting this environment means for its final snapshot.","type":"string"},"health":{"description":"Such as `healthy`, `applying` or `unknown`.","type":"string"},"http_auth":{"properties":{"enabled":{"type":"boolean"},"users":{"type":"integer"}},"required":["enabled","users"],"type":"object"},"lifecycle":{"description":"Where the row is in its life, such as `active`, `provisioning` or `deleted`.","type":"string"},"mode":{"description":"`production` once the environment serves its own domain, else `staging`.","type":"string"},"mode_label":{"type":"string"},"operation":{"oneOf":[{"$ref":"#/components/schemas/OperationSummary"},{"type":"null"}]},"platform_url":{"type":["string","null"]},"primary_url":{"type":["string","null"]},"restore":{"description":"The restore that is running. Null when none is.","oneOf":[{"properties":{"id":{"description":"The id `getRestore` takes.","minimum":1,"type":"integer"},"mode":{"type":"string"},"mode_label":{"type":"string"},"status":{"type":"string"},"status_label":{"type":"string"}},"required":["id","mode","mode_label","status","status_label"],"type":"object"},{"type":"null"}]},"restored":{"description":"Only while restores into any environment are on: the restore the row's data came from. Null when it came from none.","oneOf":[{"properties":{"at":{"format":"date-time","type":["string","null"]},"by":{"description":"Who restored it.","oneOf":[{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},{"type":"null"}]},"restore_id":{"description":"The id `getRestore` takes.","minimum":1,"type":"integer"},"snapshot":{"description":"The snapshot that was restored, with the website and environment it was taken from where you may see them.","oneOf":[{"properties":{"environment":{"oneOf":[{"$ref":"#/components/schemas/Named"},{"type":"null"}]},"taken_at":{"format":"date-time","type":["string","null"]},"website":{"oneOf":[{"$ref":"#/components/schemas/Named"},{"type":"null"}]}},"required":["taken_at","website","environment"],"type":"object"},{"type":"null"}]},"undone_at":{"description":"When the restore was undone. Null when it was not.","format":"date-time","type":["string","null"]}},"required":["restore_id","at","by","snapshot","undone_at"],"type":"object"},{"type":"null"}]},"sanitise_level":{"description":"Only while restores into any environment are on: how the row's data was anonymised.","type":["string","null"]},"scheduled_snapshots":{"type":"boolean"},"source":{"description":"What the environment was copied from. Null for one that started empty.","oneOf":[{"properties":{"at":{"format":"date-time","type":["string","null"]},"environment":{"$ref":"#/components/schemas/EnvironmentRef"},"snapshot_id":{"description":"The snapshot it was copied from. Null for a copy of the live environment.","minimum":1,"type":["integer","null"]}},"required":["environment","snapshot_id","at"],"type":"object"},{"type":"null"}]},"tier":{"type":["string","null"]},"usage_p95":{"properties":{"basis":{"type":"string"},"cpu_millicores":{"type":["integer","null"]},"memory_bytes":{"type":["integer","null"]}},"required":["cpu_millicores","memory_bytes","basis"],"type":"object"}},"required":["lifecycle","create_failed","health","mode","mode_label","primary_url","platform_url","tier","deploy_mode","branch","http_auth","scheduled_snapshots","auto_deploy","source","operation","restore","usage_p95","created_at","created_by"],"type":"object"}],"description":"One environment of the list."},"EnvironmentUpdate":{"description":"One kind of change in one request. Each variant takes its own fields only; a field of another is refused `422` on that field.","oneOf":[{"$ref":"#/components/schemas/EnvironmentUpdateSettings"},{"$ref":"#/components/schemas/EnvironmentUpdateResize"}]},"EnvironmentUpdateResize":{"additionalProperties":false,"description":"A resize of a CoreStack site's staging environment, chosen by sending `uat_size`. It is sent on its own, with `apply` and `quote_id` at most; any other field is refused `422` on that field, and `apply` or `quote_id` without `uat_size` is refused as a field that is not a setting. A resize changes what you pay, so it needs a person who may manage billing for the site (`403` otherwise), and it is answered `404` `feature_off` while billing is not on for your company. It is refused `409` with `change_pending` (a resize already waits for the window), `stale` (the price moved since the quote), `included_size` (the included staging environment cannot be made smaller), `no_payment_method` or `contract_missing`, and `422` `feature_off` on `uat_size` or `apply` while staging sizes, or changes for the window, are switched off.","properties":{"apply":{"$ref":"#/components/schemas/ApplyChoice"},"quote_id":{"description":"The `id` of a quote. The resize is refused `stale` when the price has moved since.","format":"uuid","type":["string","null"]},"uat_size":{"description":"The `key` of a staging size.","maxLength":16,"type":"string"}},"required":["uat_size"],"type":"object"},"EnvironmentUpdateSettings":{"additionalProperties":false,"description":"A change of settings. Send at least one setting; a field that is not listed here is refused `422` on that field.","minProperties":1,"properties":{"auto_deploy":{"description":"For an environment that deploys from Git. Changing it needs the Manage Deployment Source permission, and switching it on Create Deployments as well.","type":"boolean"},"http_auth_enabled":{"description":"Switches HTTP authentication for the whole environment. Refused beside a new `name`, which is sent on its own; the name the environment already has may stay in the request.","type":"boolean"},"name":{"$ref":"#/components/schemas/EnvironmentName","description":"A new label of 1 to 40 characters without `<`, `>` or control characters. Spaces, tabs and line breaks around it are taken off first and do not count. No other environment of the site may show it, whatever the capitals. The address, slug and SSH host never change. The name the environment already has changes nothing when it is sent back as it is, and is then taken even if it was given before these rules."},"scheduled_snapshots":{"description":"Refused when snapshots are not on for the site's cluster.","type":"boolean"}},"type":"object"},"ErrorPageCheck":{"additionalProperties":false,"properties":{"message":{"description":"The message for the `{{message}}` tag, in place of the saved one. One line of plain text, at most 300 characters. Left out or null, the default message is used.","maxLength":300,"pattern":"^[^\\x00-\\x1F\\x7F]*$","type":["string","null"]},"page":{"enum":["maintenance","404","500","502","503","504"],"type":"string"},"sample":{"additionalProperties":false,"description":"Values to show in place of the samples, for these four only. The other tags (`status_code`, `status_text`, `message`, `site_name`, `retry_after`) cannot be set here, and any other key is refused `invalid`.","properties":{"host":{"description":"The value of the `{{host}}` tag.","type":["string","null"]},"request_id":{"description":"The value of the `{{request_id}}` tag.","type":["string","null"]},"support_email":{"description":"An unsaved support email for the `{{support_email}}` tag, checked as a save checks it. Null shows none.","maxLength":254,"type":["string","null"]},"time_utc":{"description":"The value of the `{{time_utc}}` tag.","type":["string","null"]}},"type":"object"},"source":{"description":"The page's HTML, at most 64 KiB (65,536 bytes; a longer one answers 413 `too_large`). Left out or null, the platform's page is used.","maxLength":65536,"type":["string","null"]}},"required":["page"],"type":"object"},"ErrorPageCheckResult":{"properties":{"bytes":{"description":"The size of the page as it would be saved.","type":"integer"},"diagnostics":{"items":{"$ref":"#/components/schemas/ErrorPageDiagnostic"},"type":"array"},"samples":{"additionalProperties":{"type":"string"},"description":"The value used for each tag.","type":"object"}},"required":["diagnostics","bytes","samples"],"type":"object"},"ErrorPageDiagnostic":{"additionalProperties":true,"properties":{"code":{"type":"string"},"column":{"type":["integer","null"]},"line":{"type":["integer","null"]},"message":{"type":"string"},"page":{"type":"string"},"severity":{"description":"`error` stops a save; `warning` does not.","type":"string"}},"required":["severity","code","message"],"type":"object"},"ErrorPagePreview":{"allOf":[{"$ref":"#/components/schemas/ErrorPageCheckResult"},{"properties":{"html":{"description":"The page as visitors would get it.","type":"string"}},"required":["html"],"type":"object"}]},"ErrorPageRevision":{"additionalProperties":true,"properties":{"author":{"description":"The person's name, or Corefinity.","type":["string","null"]},"created_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"live":{"description":"Whether the site serves this revision now.","type":"boolean"},"note":{"type":["string","null"]},"number":{"type":"integer"},"origin":{"description":"How the revision came about.","enum":["save","revert","reset","copy","birth","clone","move","restore"],"type":"string"},"source_revision_id":{"description":"For a revert, the revision that was put back.","type":["integer","null"]},"status":{"enum":["pending","applying","applied","applied_unverified","rejected","unknown"],"type":"string"},"summary":{"description":"What changed, in a few words.","type":"string"}},"required":["id","number","origin","author","created_at","note","summary","live","status","source_revision_id"],"type":"object"},"ErrorPageRevisionDetail":{"properties":{"config":{"$ref":"#/components/schemas/ErrorPagesConfig"},"pages":{"additionalProperties":{"properties":{"after":{"type":["string","null"]},"before":{"type":["string","null"]},"changed":{"type":"boolean"},"diff":{"description":"A unified diff. Null when the page did not change.","type":["string","null"]}},"required":["before","after","changed","diff"],"type":"object"},"description":"For each page, its HTML before and after this revision.","type":"object"},"revision":{"$ref":"#/components/schemas/ErrorPageRevision"}},"required":["revision","config","pages"],"type":"object"},"ErrorPageRevisionPage":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"revisions":{"items":{"$ref":"#/components/schemas/ErrorPageRevision"},"type":"array"}},"required":["revisions"],"type":"object"}]},"ErrorPageRevisionRef":{"properties":{"id":{"minimum":1,"type":"integer"},"number":{"type":"integer"},"status":{"enum":["pending","applying","applied","applied_unverified","rejected","unknown"],"type":"string"}},"required":["id","number","status"],"type":"object"},"ErrorPageSource":{"additionalProperties":false,"properties":{"message":{"description":"One line of plain text the page shows through the `{{message}}` tag, at most 300 characters. Null shows the default message.","maxLength":300,"pattern":"^[^\\x00-\\x1F\\x7F]*$","type":["string","null"]},"source":{"description":"Your own HTML for the page, at most 64 KiB (65,536 bytes), and all pages at most 256 KiB together. Null shows the platform's page.","maxLength":65536,"type":["string","null"]}},"type":"object"},"ErrorPages":{"additionalProperties":true,"properties":{"applied_revision_id":{"description":"The revision the site serves now.","type":["integer","null"]},"available":{"description":"Whether the site can use error pages yet.","type":"boolean"},"can_change":{"description":"Whether you may change the pages now.","type":"boolean"},"config":{"$ref":"#/components/schemas/ErrorPagesConfig"},"limits":{"properties":{"page_bytes":{"description":"The largest one page may be.","type":"integer"},"row_bytes":{"description":"The largest all pages may be together.","type":"integer"}},"required":["page_bytes","row_bytes"],"type":"object"},"locked":{"description":"Set while Corefinity has locked the site's error pages: you can read, preview and test them, and changes are refused. Null otherwise.","oneOf":[{"additionalProperties":true,"properties":{"at":{"format":"date-time","type":"string"},"by":{"type":"string"}},"required":["at","by"],"type":"object"},{"type":"null"}]},"operation":{"description":"The latest change. Null when there has been none.","oneOf":[{"$ref":"#/components/schemas/ErrorPagesOperation"},{"type":"null"}]},"pages":{"description":"Each page at a glance.","items":{"properties":{"bytes":{"type":"integer"},"changed":{"description":"The last revision that changed the page. Null when none has.","oneOf":[{"additionalProperties":true,"properties":{"at":{"format":"date-time","type":["string","null"]},"by":{"type":["string","null"]},"revision":{"type":"integer"}},"type":"object"},{"type":"null"}]},"id":{"enum":["maintenance","404","500","502","503","504"],"type":"string"},"state":{"description":"The platform's page, your own, or the application's own answer.","enum":["platform","custom","app"],"type":"string"},"warnings":{"type":"integer"}},"required":["id","state","bytes","warnings","changed"],"type":"object"},"type":"array"},"revision":{"description":"The saved revision. Null while the site is on the platform defaults.","oneOf":[{"properties":{"author":{"type":["string","null"]},"created_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"note":{"type":["string","null"]},"number":{"type":"integer"},"origin":{"type":"string"}},"required":["id","number","origin","author","created_at","note"],"type":"object"},{"type":"null"}]},"site_id":{"minimum":1,"type":"integer"},"site_name":{"description":"What the `{{site_name}}` tag shows.","type":"string"},"tags":{"description":"The tags a page may use.","items":{"additionalProperties":true,"properties":{"description":{"type":"string"},"scope":{"type":"string"},"tag":{"type":"string"}},"required":["tag","description"],"type":"object"},"type":"array"},"unavailable_reason":{"description":"Why not, when `available` is false, such as `runtime` while the site waits for a platform update.","type":["string","null"]},"version":{"description":"Send it back with every change.","type":"integer"}},"required":["site_id","site_name","available","unavailable_reason","version","locked","can_change","config","revision","applied_revision_id","pages","operation","limits","tags"],"type":"object"},"ErrorPagesConfig":{"description":"A site's error pages configuration.","properties":{"codes":{"additionalProperties":false,"description":"For each status code, whether a visitor gets an error page (`page`) or the application's own answer (`app`).","properties":{"404":{"enum":["page","app"],"type":"string"},"500":{"enum":["page","app"],"type":"string"},"502":{"enum":["page","app"],"type":"string"},"503":{"enum":["page","app"],"type":"string"},"504":{"enum":["page","app"],"type":"string"}},"required":["404","500","502","503","504"],"type":"object"},"pages":{"additionalProperties":false,"description":"The maintenance page and the page of each code.","properties":{"404":{"$ref":"#/components/schemas/ErrorPageSource"},"500":{"$ref":"#/components/schemas/ErrorPageSource"},"502":{"$ref":"#/components/schemas/ErrorPageSource"},"503":{"$ref":"#/components/schemas/ErrorPageSource"},"504":{"$ref":"#/components/schemas/ErrorPageSource"},"maintenance":{"$ref":"#/components/schemas/ErrorPageSource"}},"required":["maintenance","404","500","502","503","504"],"type":"object"},"support_email":{"description":"Shown where a page uses the `{{support_email}}` tag.","maxLength":254,"type":["string","null"]}},"required":["codes","pages","support_email"],"type":"object"},"ErrorPagesConfigInput":{"additionalProperties":false,"description":"The configuration to save. A code, page or the support email left out goes back to its default.","properties":{"codes":{"additionalProperties":false,"properties":{"404":{"enum":["page","app"],"type":"string"},"500":{"enum":["page","app"],"type":"string"},"502":{"enum":["page","app"],"type":"string"},"503":{"enum":["page","app"],"type":"string"},"504":{"enum":["page","app"],"type":"string"}},"type":"object"},"pages":{"additionalProperties":false,"properties":{"404":{"$ref":"#/components/schemas/ErrorPageSource"},"500":{"$ref":"#/components/schemas/ErrorPageSource"},"502":{"$ref":"#/components/schemas/ErrorPageSource"},"503":{"$ref":"#/components/schemas/ErrorPageSource"},"504":{"$ref":"#/components/schemas/ErrorPageSource"},"maintenance":{"$ref":"#/components/schemas/ErrorPageSource"}},"type":"object"},"support_email":{"description":"An email address, with no spaces, quotes, `<`, `>` or `&` in it. Null or left out shows none.","maxLength":254,"type":["string","null"]}},"type":"object"},"ErrorPagesCopy":{"additionalProperties":false,"properties":{"confirm_production":{"description":"Must be true to copy onto a production environment.","type":"boolean"},"note":{"description":"Why, shown in the history. Only its first 200 characters are kept.","type":["string","null"]},"to_site_id":{"description":"The id of the environment to copy onto.","minimum":1,"type":"integer"},"version":{"description":"The `version` from the last read of the environment copied onto.","minimum":0,"type":"integer"}},"required":["to_site_id","version"],"type":"object"},"ErrorPagesLiveTest":{"additionalProperties":true,"properties":{"body_head":{"description":"The start of the body, at most 2 KiB.","type":["string","null"]},"bytes":{"type":["integer","null"]},"checked_at":{"format":"date-time","type":"string"},"error":{"type":["string","null"]},"headers":{"additionalProperties":{"type":["string","null"]},"type":"object"},"kind":{"const":"live","type":"string"},"message":{"type":["string","null"]},"refused":{"description":"Set when nothing was sent, with why in `message`: `not_your_site` when the site's address does not point at the site. Null otherwise.","type":["string","null"]},"status":{"description":"The status the site answered. Null when it did not answer or nothing was sent.","type":["integer","null"]},"truncated":{"type":"boolean"},"url":{"type":"string"},"who":{"description":"Who drew the answer: the application, the platform's page, your page, the maintenance page, Cloudflare, or `unknown` when there was no answer.","enum":["app","platform","custom","maintenance","cloudflare","unknown",null],"type":["string","null"]}},"required":["kind","url","status","who","headers","refused","message","checked_at"],"type":"object"},"ErrorPagesOperation":{"additionalProperties":true,"description":"A change to a site's error pages. Not the shared `Operation`; it carries `outcome` and `can_retry`, and its own four steps.","properties":{"can_retry":{"description":"Whether the change can be applied again.","type":"boolean"},"completed_at":{"format":"date-time","type":["string","null"]},"created_at":{"format":"date-time","type":["string","null"]},"error":{"description":"Why the change failed, in plain words.","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"outcome":{"description":"How the change ended. Null while it runs.","enum":["applied","applied_unverified","rejected","unknown",null],"type":["string","null"]},"status":{"$ref":"#/components/schemas/OperationStatus"},"steps":{"items":{"properties":{"at":{"format":"date-time","type":["string","null"]},"detail":{"type":["string","null"]},"key":{"enum":["check","commit","apply","verify"],"type":"string"},"label":{"type":"string"},"state":{"type":"string"}},"required":["key","label","state","at","detail"],"type":"object"},"type":"array"}},"required":["id","status","outcome","steps","error","can_retry","created_at","completed_at"],"type":"object"},"ErrorPagesRenderTest":{"additionalProperties":true,"properties":{"checked_at":{"format":"date-time","type":"string"},"kind":{"const":"render","type":"string"},"maintenance_on":{"type":"boolean"},"operation_id":{"description":"The id of the preparation, to read with the general operation endpoint (`GET /corestack/operations/{operation}`); the error pages operation endpoint does not answer it. Null when nothing is being prepared.","type":["integer","null"]},"pages":{"items":{"additionalProperties":true,"properties":{"error":{"type":["string","null"]},"generation":{"type":["string","null"]},"html":{"type":["string","null"]},"id":{"type":"string"},"ok":{"type":"boolean"},"revision":{"description":"The revision the site serves for the page; 0 for the platform's page.","type":["integer","null"]},"state":{"type":"string"}},"required":["id","state","ok"],"type":"object"},"type":"array"},"preparing":{"description":"True while the site is being prepared for the check: try again once the operation `operation_id` names has finished.","type":"boolean"}},"required":["kind","pages","checked_at"],"type":"object"},"ErrorPagesReset":{"additionalProperties":false,"properties":{"note":{"description":"Why, shown in the history. Only its first 200 characters are kept.","type":["string","null"]},"version":{"description":"The `version` from the last read.","minimum":0,"type":"integer"}},"required":["version"],"type":"object"},"ErrorPagesRetry":{"additionalProperties":false,"properties":{"version":{"description":"The `version` from the last read.","minimum":0,"type":"integer"}},"required":["version"],"type":"object"},"ErrorPagesRevert":{"additionalProperties":false,"properties":{"note":{"description":"Why, shown in the history. Only its first 200 characters are kept.","type":["string","null"]},"revision_id":{"description":"The id of the revision to put back.","minimum":1,"type":"integer"},"version":{"description":"The `version` from the last read.","minimum":0,"type":"integer"}},"required":["revision_id","version"],"type":"object"},"ErrorPagesSaveResult":{"properties":{"operation":{"description":"The change to follow. Null when nothing was started.","oneOf":[{"$ref":"#/components/schemas/ErrorPagesOperation"},{"type":"null"}]},"revision":{"description":"The new revision. Null when nothing changed.","oneOf":[{"$ref":"#/components/schemas/ErrorPageRevisionRef"},{"type":"null"}]},"warnings":{"description":"What was removed from a page, and other warnings.","items":{"$ref":"#/components/schemas/ErrorPageDiagnostic"},"type":"array"}},"required":["operation","revision"],"type":"object"},"ErrorPagesTest":{"additionalProperties":false,"properties":{"kind":{"enum":["live","render"],"type":"string"},"path":{"default":"/","description":"For `live`: the path to ask for, with its query string if any. It starts with a single `/` and has no spaces, control characters or `#` fragment.","maxLength":512,"pattern":"^/(?!/)[^\\x00-\\x20\\x7F#]*$","type":"string"}},"required":["kind"],"type":"object"},"ErrorPagesUpdate":{"additionalProperties":false,"properties":{"config":{"$ref":"#/components/schemas/ErrorPagesConfigInput"},"note":{"description":"Why, shown in the history. Only its first 200 characters are kept.","type":["string","null"]},"version":{"description":"The `version` from the last read.","minimum":0,"type":"integer"}},"required":["version","config"],"type":"object"},"FeatureOffRefusal":{"description":"The feature is not on for your company.","properties":{"code":{"const":"feature_off","type":"string"},"message":{"const":"Not found.","type":"string"},"reason":{"const":"feature_off","type":"string"}},"required":["message","reason","code"],"type":"object"},"FeedbackAttachments":{"description":"Up to 3 files: PNG, JPEG or WebP images up to 2 MiB each, plain UTF-8 text up to 256 KiB each, 5 MiB\ntogether.\n","items":{"additionalProperties":false,"properties":{"data":{"description":"The file, as base64.","minLength":1,"type":"string"},"mime_type":{"enum":["image/png","image/jpeg","image/webp","text/plain"],"type":"string"},"name":{"maxLength":255,"minLength":1,"type":"string"}},"required":["name","mime_type","data"],"type":"object"},"maxItems":3,"type":"array"},"FeedbackBugReport":{"additionalProperties":false,"properties":{"attachments":{"$ref":"#/components/schemas/FeedbackAttachments"},"cluster_id":{"$ref":"#/components/schemas/FeedbackClusterId"},"description":{"$ref":"#/components/schemas/FeedbackDescription"},"environment_id":{"$ref":"#/components/schemas/FeedbackEnvironmentId"},"expected":{"description":"What you expected.","maxLength":2000,"type":"string"},"severity":{"description":"How bad it is.","enum":["blocking","major","minor","cosmetic"],"type":"string"},"site_id":{"$ref":"#/components/schemas/FeedbackSiteId"},"steps":{"description":"The steps that show it.","maxLength":5000,"type":"string"},"title":{"$ref":"#/components/schemas/FeedbackTitle"},"type":{"const":"bug_report","type":"string"}},"required":["type","title","description","severity"],"title":"Bug report","type":"object"},"FeedbackClusterId":{"description":"The CoreCluster the feedback is about.","minimum":1,"type":"integer"},"FeedbackDescription":{"description":"What you want to say.","maxLength":10000,"minLength":1,"type":"string"},"FeedbackEnvironmentId":{"description":"The environment the feedback is about, by its site row id.","minimum":1,"type":"integer"},"FeedbackFeatureRequest":{"additionalProperties":false,"properties":{"attachments":{"$ref":"#/components/schemas/FeedbackAttachments"},"cluster_id":{"$ref":"#/components/schemas/FeedbackClusterId"},"description":{"$ref":"#/components/schemas/FeedbackDescription"},"environment_id":{"$ref":"#/components/schemas/FeedbackEnvironmentId"},"importance":{"description":"How important it is.","enum":["nice_to_have","important","essential"],"type":"string"},"site_id":{"$ref":"#/components/schemas/FeedbackSiteId"},"title":{"$ref":"#/components/schemas/FeedbackTitle"},"type":{"const":"feature_request","type":"string"},"why":{"description":"Why it matters.","maxLength":2000,"type":"string"}},"required":["type","title","description"],"title":"Feature request","type":"object"},"FeedbackGeneral":{"additionalProperties":false,"properties":{"attachments":{"$ref":"#/components/schemas/FeedbackAttachments"},"cluster_id":{"$ref":"#/components/schemas/FeedbackClusterId"},"description":{"$ref":"#/components/schemas/FeedbackDescription"},"environment_id":{"$ref":"#/components/schemas/FeedbackEnvironmentId"},"site_id":{"$ref":"#/components/schemas/FeedbackSiteId"},"title":{"description":"Accepted and not used. The summary is the first line of `description`, cut at 80 characters.","type":"string"},"type":{"const":"general_feedback","type":"string"}},"required":["type","description"],"title":"General feedback","type":"object"},"FeedbackPlatformRequest":{"additionalProperties":false,"anyOf":[{"required":["platform"]},{"required":["request"]}],"description":"A request for a platform (`platform`), or for a PHP extension or tool (`request`): one of the two is\nrequired. When `request` is sent, `platform` and `platform_other` are not used.\n","if":{"not":{"required":["request"]},"properties":{"platform":{"const":"other"}},"required":["platform"]},"properties":{"attachments":{"$ref":"#/components/schemas/FeedbackAttachments"},"cluster_id":{"$ref":"#/components/schemas/FeedbackClusterId"},"description":{"$ref":"#/components/schemas/FeedbackDescription"},"environment_id":{"$ref":"#/components/schemas/FeedbackEnvironmentId"},"platform":{"description":"The platform or application you need. Required unless `request` is sent.","enum":["shopware","akeneo","drupal","craft_cms","symfony","sylius","prestashop","orocommerce","nodejs_app","python_app","other"],"type":"string"},"platform_other":{"description":"The name of the platform. Required when `platform` is `other`.","maxLength":100,"minLength":1,"type":"string"},"platform_version":{"description":"The version you need.","maxLength":50,"type":"string"},"request":{"additionalProperties":false,"description":"A PHP extension or tool, in place of `platform`.","properties":{"kind":{"enum":["php_extension","php_tool"],"type":"string"},"name":{"pattern":"^[a-z0-9][a-z0-9_.-]{0,63}$","type":"string"},"php_version":{"description":"A PHP version the Control Panel offers for new sites, such as `8.3`. Any other is refused.","type":"string"}},"required":["kind","name"],"type":"object"},"site_id":{"$ref":"#/components/schemas/FeedbackSiteId"},"sites_count":{"description":"How many sites would use it.","maximum":1000,"minimum":1,"type":"integer"},"timeline":{"description":"When you would need it.","enum":["asap","within_3_months","within_a_year","exploring"],"type":"string"},"title":{"$ref":"#/components/schemas/FeedbackTitle"},"type":{"const":"platform_request","type":"string"}},"required":["type","title","description"],"then":{"required":["platform_other"]},"title":"Platform request","type":"object"},"FeedbackReceived":{"properties":{"id":{"minimum":1,"type":"integer"},"reference":{"description":"The reference to quote, such as `FB-1234`.","type":"string"},"status":{"const":"received","type":"string"}},"required":["id","reference","status"],"type":"object"},"FeedbackSiteId":{"description":"The site the feedback is about. Send at most one of `site_id`, `environment_id` and `cluster_id`.","minimum":1,"type":"integer"},"FeedbackSubmission":{"description":"One submission, in the shape of its `type`. Each type is closed: a field of another type, or any field not\nlisted, is refused (`invalid`). Name at most one of `site_id`, `environment_id` and `cluster_id`. Text is\ntrimmed before it is checked, so a field holding only spaces counts as empty. The people who read the\nfeedback see that it came through the API and the name of the token it was sent with.\n","not":{"anyOf":[{"required":["site_id","environment_id"]},{"required":["site_id","cluster_id"]},{"required":["environment_id","cluster_id"]}]},"oneOf":[{"$ref":"#/components/schemas/FeedbackFeatureRequest"},{"$ref":"#/components/schemas/FeedbackBugReport"},{"$ref":"#/components/schemas/FeedbackGeneral"},{"$ref":"#/components/schemas/FeedbackPlatformRequest"}]},"FeedbackTitle":{"description":"A one-line summary.","maxLength":120,"minLength":1,"type":"string"},"FieldRefusal":{"additionalProperties":true,"description":"A field that is missing or wrong, on the endpoints that answer it as `invalid_arguments` (SSH keys, firewall,\nVarnish purge), or a typed confirmation that does not match. `field` names the field.\n","properties":{"code":{"description":"The same value as `reason`.","type":"string"},"errors":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The refused field with its message.","type":"object"},"field":{"type":"string"},"message":{"type":"string"},"reason":{"enum":["invalid_arguments","confirm_mismatch"],"type":"string"}},"required":["message","reason","field","code"],"type":"object"},"FirewallActivityEvent":{"description":"One entry of the firewall activity list.","properties":{"action":{"enum":["entry_added","entry_updated","entry_removed","entry_expired","range_requested","range_approved","range_rejected","preset_attached","preset_detached","applied","apply_failed"],"type":"string"},"actor":{"$ref":"#/components/schemas/FirewallAddedBy"},"at":{"format":"date-time","type":"string"},"channel":{"description":"Where the change was made, such as `ui` (the Control Panel), `api` or `mcp`.","enum":["ui","api","mcp","cli","import","system","staff"],"type":"string"},"cidr":{"description":"The address the event is about, when it is about one.","type":["string","null"]},"layer":{"enum":["agency","company","website","environment","user","preset","http_auth_rule",null],"type":["string","null"]},"owner":{"oneOf":[{"$ref":"#/components/schemas/FirewallOwner"},{"type":"null"}]},"reason":{"type":["string","null"]}},"required":["at","actor","channel","action","cidr","layer","owner","reason"],"type":"object"},"FirewallActivityPage":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"events":{"items":{"$ref":"#/components/schemas/FirewallActivityEvent"},"type":"array"}},"required":["events"],"type":"object"}],"description":"A page of firewall activity, newest first."},"FirewallAddedBy":{"description":"Who added an address or made a change.","properties":{"name":{"description":"Null when the person has been removed, or when Corefinity support added the address.","type":["string","null"]},"on_behalf_of":{"description":"The person Corefinity support added it for.","type":["string","null"]},"support":{"description":"True when Corefinity support added the address for a customer.","type":"boolean"}},"required":["name","support","on_behalf_of"],"type":"object"},"FirewallAgencyClients":{"description":"An agency's client companies.","properties":{"clients":{"items":{"properties":{"environments":{"type":"integer"},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name","environments"],"type":"object"},"type":"array"}},"required":["clients"],"type":"object"},"FirewallChange":{"description":"A firewall change, and how far it has been applied.","properties":{"applied":{"description":"Environments the change is live on.","type":"integer"},"deferred":{"description":"Environments that take the change later, when the firewall is enforced there.","type":"integer"},"failed":{"description":"The environments the change failed on, each with a reason.","items":{"properties":{"environment_id":{"minimum":1,"type":"integer"},"reason":{"type":"string"}},"required":["environment_id","reason"],"type":"object"},"type":"array"},"id":{"minimum":1,"type":"integer"},"state":{"description":"`applied` and `failed` are final for this read; a failed environment is tried again. `recorded` means there was nothing to apply yet.","enum":["applying","applied","failed","recorded"],"type":"string"},"total":{"description":"Environments the change goes to.","type":"integer"}},"required":["id","state","applied","total","deferred","failed"],"type":"object"},"FirewallChangeStarted":{"description":"The change that was started.","properties":{"change_id":{"description":"The change to follow with `GET /firewall/changes/{change}`. Null when nothing needs applying.","type":["integer","null"]}},"required":["change_id"],"type":"object"},"FirewallCompanyView":{"description":"A company's addresses and presets and, for a client of an agency, those its agency holds.","properties":{"agency":{"description":"The clients of an agency. Null unless the company is an agency with clients.","oneOf":[{"$ref":"#/components/schemas/FirewallAgencyClients"},{"type":"null"}]},"company":{"properties":{"id":{"minimum":1,"type":"integer"},"is_agency":{"type":"boolean"},"name":{"type":"string"}},"required":["id","name","is_agency"],"type":"object"},"entries":{"items":{"$ref":"#/components/schemas/FirewallEntry"},"type":"array"},"presets":{"items":{"$ref":"#/components/schemas/FirewallPresetSubscription"},"type":"array"},"reach":{"$ref":"#/components/schemas/FirewallReach"}},"required":["company","entries","presets","reach","agency"],"type":"object"},"FirewallEntry":{"description":"One address or range on a firewall list.","properties":{"added_by":{"$ref":"#/components/schemas/FirewallAddedBy"},"carried_from":{"description":"Where a carried address came from.","type":["string","null"]},"changed_at":{"description":"When the entry last changed where it applies. Compare it with a target's `applied_at` to tell whether the change is live there.","format":"date-time","type":"string"},"cidr":{"description":"The address in CIDR form. A single address reads `/32` (IPv6 `/128`). Removing the entry asks you to send this back.","type":"string"},"comment":{"type":["string","null"]},"created_at":{"format":"date-time","type":"string"},"decision_reason":{"description":"Corefinity's reason, once a range request is rejected.","type":["string","null"]},"editable":{"description":"Whether you may change or remove the entry.","type":"boolean"},"expires_at":{"description":"When the address stops being allowed. Null for no expiry.","format":"date-time","type":["string","null"]},"family":{"description":"The IP version.","enum":[4,6],"type":"integer"},"id":{"description":"The entry id the `/firewall/entries/{entry}` endpoints take.","type":"integer"},"layer":{"description":"The level the address comes from, as you see it. `agency` is an address of your agency.","enum":["agency","company","website","environment","user","preset","http_auth_rule"],"type":"string"},"owner":{"$ref":"#/components/schemas/FirewallOwner"},"path":{"description":"The protected path of a carried `http_auth_rule` address.","type":["string","null"]},"request_reason":{"description":"The reason given with a range request.","type":["string","null"]},"scope":{"$ref":"#/components/schemas/FirewallScope"},"source":{"description":"How the entry came to be, such as `manual`, `one_click` (the address you were calling from) or an import.","enum":["manual","one_click","on_behalf","ip_whitelist","legacy_import","legacy_usage","gcp_rule_import","legacy_delta","platform_seed","http_auth_carry"],"type":"string"},"status":{"description":"`pending_approval` is a range request waiting for Corefinity. `removing` lasts until the address is gone everywhere.","enum":["active","pending_approval","rejected","removing","expired"],"type":"string"},"web_paused":{"description":"True while the address's website access is paused by the platform.","type":"boolean"}},"required":["id","cidr","family","layer","owner","added_by","comment","expires_at","created_at","changed_at","scope","status","source","editable","path","carried_from","web_paused","request_reason","decision_reason"],"type":"object"},"FirewallEntryCreateRequest":{"additionalProperties":false,"properties":{"address":{"description":"An IPv4 or IPv6 address, or a range in CIDR form. A range may be as wide as /24 (IPv6 /48). Private,\nreserved and provider ranges are refused.\n","maxLength":64,"type":"string"},"comment":{"description":"A note to recognise the address by.","maxLength":200,"type":["string","null"]},"expires_in_days":{"$ref":"#/components/schemas/FirewallExpiryDays"},"owner_id":{"description":"The id of the environment, website or company. For `user`, your own user id.","minimum":1,"type":"integer"},"owner_type":{"$ref":"#/components/schemas/FirewallOwnerType"},"scope":{"allOf":[{"$ref":"#/components/schemas/FirewallScopeChoice"}],"description":"Left out, the address gets `both`."}},"required":["owner_type","owner_id","address"],"type":"object"},"FirewallEntryRemoveRequest":{"additionalProperties":false,"properties":{"confirm_address":{"description":"The entry's address, exactly as the lists answer it in `cidr`.","maxLength":64,"type":"string"}},"required":["confirm_address"],"type":"object"},"FirewallEntrySaved":{"description":"A saved entry and the change that applies it.","properties":{"change_id":{"description":"The change to follow with `GET /firewall/changes/{change}`. Null when nothing needs applying.","type":["integer","null"]},"covered_by":{"description":"Set when an entry at another level already allows the address: the level that does.","enum":["agency","company","website","environment","user","preset","http_auth_rule",null],"type":["string","null"]},"entry":{"$ref":"#/components/schemas/FirewallEntry"}},"required":["entry","change_id","covered_by"],"type":"object"},"FirewallEntryUpdateRequest":{"additionalProperties":false,"description":"Send at least one of the three.","minProperties":1,"properties":{"comment":{"description":"The new comment. Null removes it.","maxLength":200,"type":["string","null"]},"expires_in_days":{"allOf":[{"$ref":"#/components/schemas/FirewallExpiryDays"}],"description":"Counted from now. Null removes the expiry."},"scope":{"$ref":"#/components/schemas/FirewallScopeChoice"}},"type":"object"},"FirewallEnvironmentRef":{"description":"An environment, with the website and company it belongs to.","properties":{"company":{"$ref":"#/components/schemas/Named"},"id":{"description":"The environment id, the `{environment}` these endpoints take and the `owner_id` of an environment entry.","type":"integer"},"name":{"type":"string"},"product":{"description":"`cse` is CoreStack Enterprise.","enum":["cse","corestack","corecluster"],"type":"string"},"site_id":{"description":"The site row id the `/corestack/sites/{site}` endpoints take. Null on CoreStack Enterprise.","type":["integer","null"]},"website":{"$ref":"#/components/schemas/Named"}},"required":["id","name","product","site_id","website","company"],"type":"object"},"FirewallEnvironmentView":{"description":"Every address that reaches an environment, and the state of its firewall.","properties":{"closed_by_default":{"description":"True when SSH is refused to every address that is not listed.","type":"boolean"},"covered":{"description":"False for an environment whose SSH the firewall does not manage.","type":"boolean"},"enforcement":{"description":"How far the firewall is in force on the environment.","properties":{"stage":{"enum":["dark","prepare","enforce","paused","deferred"],"type":"string"}},"required":["stage"],"type":"object"},"entries":{"description":"The addresses, from every level that reaches the environment.","items":{"$ref":"#/components/schemas/FirewallEntry"},"type":"array"},"environment":{"$ref":"#/components/schemas/FirewallEnvironmentRef"},"legacy":{"$ref":"#/components/schemas/FirewallLegacy"},"presets":{"description":"The presets attached at any level that reaches the environment.","items":{"$ref":"#/components/schemas/FirewallPresetSubscription"},"type":"array"},"ssh_reach":{"description":"Who can reach SSH now.","properties":{"ends_on":{"description":"The day the older access ends, once a day is set.","format":"date","type":["string","null"]},"state":{"description":"`restricted`: only listed addresses. `legacy_open`: the older open access continues. `legacy_list`: listed addresses and Corefinity's older SSH allow list. `world_open`: Corefinity has opened the environment to everyone. `not_enforced`: the firewall is not in force.","enum":["world_open","legacy_open","legacy_list","restricted","not_enforced"],"type":"string"}},"required":["state","ends_on"],"type":"object"},"targets":{"description":"The SSH ports the list is applied to.","items":{"$ref":"#/components/schemas/FirewallTarget"},"type":"array"},"your_address":{"$ref":"#/components/schemas/FirewallYourAddress"}},"required":["environment","entries","presets","your_address","legacy","targets","covered","closed_by_default","enforcement","ssh_reach"],"type":"object"},"FirewallExpiryDays":{"description":"After how many days the address stops being allowed. Null, or left out, for no expiry.","enum":[1,30,90,365,null],"type":["integer","null"]},"FirewallLegacy":{"description":"The older open SSH access of the environment, while it lasts.","properties":{"banner":{"description":"Whether the Control Panel shows a notice about it.","type":"boolean"},"ends_on":{"description":"The day it ends, once a day is set.","format":"date","type":["string","null"]},"state":{"enum":["none","open","ending","ended"],"type":"string"}},"required":["state","ends_on","banner"],"type":"object"},"FirewallMyIp":{"description":"The address this request came from, whether it can connect and where it can be added.","properties":{"address":{"type":"string"},"allowed":{"type":"boolean"},"family":{"enum":[4,6],"type":"integer"},"options":{"items":{"$ref":"#/components/schemas/FirewallMyIpOption"},"type":"array"},"reason":{"description":"`address_refused` is a private, shared, reserved or provider range, `platform_address` an address of Corefinity. Null when the address can be added.","enum":["address_refused","platform_address",null],"type":["string","null"]},"usable":{"description":"False when this address cannot be added; `reason` says why.","type":"boolean"},"via":{"items":{"$ref":"#/components/schemas/FirewallVia"},"type":"array"}},"required":["address","family","allowed","via","options","usable","reason"],"type":"object"},"FirewallMyIpAdded":{"description":"The entry made, or widened, for the address you are calling from.","properties":{"change_id":{"type":["integer","null"]},"entry":{"$ref":"#/components/schemas/FirewallEntry"}},"required":["entry","change_id"],"type":"object"},"FirewallMyIpOption":{"description":"A level the address you are calling from can be added at.","properties":{"description":{"type":"string"},"label":{"type":"string"},"level":{"description":"`me` adds it for yourself, on every environment you can reach.","enum":["me","environment","website","company"],"type":"string"},"reach":{"description":"What an address at this level opens.","properties":{"environments":{"type":"integer"},"websites":{"type":"integer"}},"required":["environments","websites"],"type":"object"}},"required":["level","label","description","reach"],"type":"object"},"FirewallMyIpPresent":{"description":"The address is already allowed, so nothing was added.","properties":{"present":{"type":"boolean"},"via":{"items":{"$ref":"#/components/schemas/FirewallVia"},"type":"array"}},"required":["present","via"],"type":"object"},"FirewallMyIpRequest":{"additionalProperties":false,"properties":{"comment":{"maxLength":200,"type":["string","null"]},"environment_id":{"description":"The environment you want to reach.","minimum":1,"type":"integer"},"expires_in_days":{"allOf":[{"$ref":"#/components/schemas/FirewallExpiryDays"}],"description":"After how many days a new entry stops being allowed. Null, or left out, for no expiry. An entry the\nlevel already holds for the address is widened instead and keeps its own expiry when that is later, or\nwhen it has none: read `entry.expires_at` in the answer.\n"},"level":{"description":"Where to add the address: for yourself (`me`), for this environment, for its website or for your company.\n","enum":["me","environment","website","company"],"type":"string"}},"required":["environment_id","level"],"type":"object"},"FirewallOwner":{"description":"Where an address is held: a company, a website, an environment or a person. `http_auth_rule` is an address carried over with a password-protected path.","properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"type":{"enum":["company","website","environment","user","http_auth_rule"],"type":"string"}},"required":["type","id","name"],"type":"object"},"FirewallOwnerType":{"description":"The level an address is held at. `user` is yourself.","enum":["environment","website","company","user"],"type":"string"},"FirewallPreset":{"description":"The published address ranges of a common service, kept up to date by Corefinity.","properties":{"description":{"type":["string","null"]},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"ranges_count":{"description":"How many ranges the preset holds.","type":"integer"},"slug":{"description":"The preset's short name. Detaching it asks you to send this back.","type":"string"}},"required":["id","slug","name","description","ranges_count"],"type":"object"},"FirewallPresetAttachRequest":{"additionalProperties":false,"properties":{"owner_id":{"minimum":1,"type":"integer"},"owner_type":{"$ref":"#/components/schemas/FirewallOwnerType"},"preset_id":{"description":"The id of a preset, as `GET /firewall/presets` answers it.","minimum":1,"type":"integer"}},"required":["preset_id","owner_type","owner_id"],"type":"object"},"FirewallPresetDetachRequest":{"additionalProperties":false,"properties":{"confirm_preset":{"description":"The preset's `slug`.","maxLength":64,"type":"string"}},"required":["confirm_preset"],"type":"object"},"FirewallPresetList":{"description":"The presets you can attach.","properties":{"presets":{"items":{"$ref":"#/components/schemas/FirewallPreset"},"type":"array"}},"required":["presets"],"type":"object"},"FirewallPresetSubscription":{"description":"A preset attached at one owner.","properties":{"added_by":{"$ref":"#/components/schemas/FirewallAddedBy"},"created_at":{"format":"date-time","type":"string"},"editable":{"description":"Whether you may detach it.","type":"boolean"},"id":{"description":"The id `DELETE /firewall/preset-subscriptions/{subscription}` takes.","type":"integer"},"layer":{"enum":["agency","company","website","environment","user","preset","http_auth_rule"],"type":"string"},"owner":{"$ref":"#/components/schemas/FirewallOwner"},"preset":{"$ref":"#/components/schemas/FirewallPreset"}},"required":["id","preset","layer","owner","added_by","created_at","editable"],"type":"object"},"FirewallPresetSubscriptionSaved":{"description":"An attached preset and the change that applies it.","properties":{"change_id":{"type":["integer","null"]},"subscription":{"$ref":"#/components/schemas/FirewallPresetSubscription"}},"required":["subscription","change_id"],"type":"object"},"FirewallRangeRequest":{"additionalProperties":false,"properties":{"address":{"description":"A range in CIDR form, IPv4 /9 to /23 or IPv6 /9 to /47.","maxLength":64,"type":"string"},"expires_in_days":{"$ref":"#/components/schemas/FirewallExpiryDays"},"owner_id":{"minimum":1,"type":"integer"},"owner_type":{"$ref":"#/components/schemas/FirewallOwnerType"},"reason":{"description":"Why you need the range. Corefinity reads it when deciding.","maxLength":500,"minLength":1,"type":"string"},"scope":{"allOf":[{"$ref":"#/components/schemas/FirewallScopeChoice"}],"description":"Left out, the range gets `both`."}},"required":["owner_type","owner_id","address","reason"],"type":"object"},"FirewallRangeRequested":{"description":"The entry made for a range request. Its `status` is `pending_approval`.","properties":{"entry":{"$ref":"#/components/schemas/FirewallEntry"}},"required":["entry"],"type":"object"},"FirewallReach":{"description":"How far addresses at this level reach, with the environments.","properties":{"environments":{"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/FirewallReachItem"},"type":"array"},"websites":{"type":"integer"}},"required":["environments","websites","items"],"type":"object"},"FirewallReachItem":{"description":"One environment an address at this level opens.","properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"product":{"enum":["cse","corestack","corecluster"],"type":"string"},"website":{"$ref":"#/components/schemas/Named"}},"required":["id","name","product","website"],"type":"object"},"FirewallRefusal":{"additionalProperties":true,"description":"A refusal of a firewall request. `reason` is a stable code and `code` always carries the same value. Unlike the\nshared `Refusal`, it always carries `field`: the field the refusal is about, or null.\n","properties":{"code":{"description":"The same value as `reason`.","type":"string"},"errors":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Sent with `invalid_arguments` and `confirm_mismatch`. The refused field with its message.","type":"object"},"field":{"description":"The field the refusal is about.","type":["string","null"]},"message":{"description":"What happened, in plain words. It never repeats an address.","type":"string"},"reason":{"description":"The stable code for this refusal.","type":"string"}},"required":["message","reason","field","code"],"type":"object"},"FirewallScope":{"description":"What an address may reach.","properties":{"ssh":{"description":"The address may connect over SSH.","type":"boolean"},"web":{"description":"The address sees the website without the HTTP authentication login or the maintenance page.","type":"boolean"}},"required":["ssh","web"],"type":"object"},"FirewallScopeChoice":{"description":"What the address may reach. `ssh` is SSH only, `web` the website only, `both` both.","enum":["both","ssh","web"],"type":"string"},"FirewallTarget":{"description":"One SSH port of the environment the firewall is applied to.","properties":{"applied_at":{"description":"When the list was last applied to the port.","format":"date-time","type":["string","null"]},"last_error_public":{"description":"Why the last apply failed, in plain words.","type":["string","null"]},"moving":{"description":"True while the port is being moved.","type":"boolean"},"port":{"type":"integer"},"state":{"enum":["pending","applying","applied","failed","drift","deleting","absent"],"type":"string"}},"required":["port","state","moving","applied_at","last_error_public"],"type":"object"},"FirewallUserView":{"description":"Your own addresses. Each opens every environment you can reach.","properties":{"entries":{"items":{"$ref":"#/components/schemas/FirewallEntry"},"type":"array"},"reach":{"$ref":"#/components/schemas/FirewallReach"},"user":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"}},"required":["user","entries","reach"],"type":"object"},"FirewallVia":{"description":"What lets an address in: an entry (`entry_id`) or a range of an attached preset (`subscription_id`).","properties":{"cidr":{"type":"string"},"entry_id":{"type":["integer","null"]},"layer":{"enum":["agency","company","website","environment","user","preset","http_auth_rule"],"type":"string"},"owner":{"$ref":"#/components/schemas/FirewallOwner"},"subscription_id":{"type":["integer","null"]}},"required":["entry_id","subscription_id","layer","cidr","owner"],"type":"object"},"FirewallWebAccess":{"description":"What stands between a visitor and the website, and what a listed address skips.","properties":{"bypass":{"description":"The website access of listed addresses.","properties":{"applied_at":{"format":"date-time","type":["string","null"]},"count":{"description":"How many addresses have website access.","type":"integer"},"covers":{"description":"What a listed address skips: the login, the maintenance page or both.","properties":{"http_auth":{"type":"boolean"},"maintenance":{"type":"boolean"}},"required":["http_auth","maintenance"],"type":"object"},"entries":{"description":"Each entry's own state on the website.","items":{"properties":{"id":{"minimum":1,"type":"integer"},"state":{"enum":["applied","applying","failed"],"type":"string"}},"required":["id","state"],"type":"object"},"type":"array"},"last_error_public":{"type":["string","null"]},"state":{"description":"`none` while website access is not enforced on the site.","enum":["applied","applying","failed","none"],"type":"string"}},"required":["count","covers","applied_at","state","last_error_public","entries"],"type":"object"},"http_auth":{"description":"The site's HTTP authentication. Passwords are never answered.","properties":{"enabled":{"type":"boolean"},"rules_count":{"type":"integer"},"users":{"items":{"properties":{"id":{"minimum":1,"type":"integer"},"revealable":{"type":"boolean"},"username":{"type":"string"}},"required":["id","username","revealable"],"type":"object"},"type":"array"},"version":{"type":"integer"}},"required":["enabled","version","rules_count","users"],"type":"object"},"maintenance":{"description":"Whether maintenance mode is on.","properties":{"on":{"type":"boolean"}},"required":["on"],"type":"object"},"site_id":{"description":"The site row id the `/corestack/sites/{site}` endpoints take.","type":"integer"}},"required":["site_id","http_auth","maintenance","bypass"],"type":"object"},"FirewallWebsiteView":{"description":"The addresses and presets that reach a website: its own and those of its company and agency.","properties":{"entries":{"items":{"$ref":"#/components/schemas/FirewallEntry"},"type":"array"},"environments":{"items":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"site_id":{"type":["integer","null"]},"status_summary":{"enum":["applied","applying","failed","not_enforced","deferred"],"type":"string"}},"required":["id","name","site_id","status_summary"],"type":"object"},"type":"array"},"presets":{"items":{"$ref":"#/components/schemas/FirewallPresetSubscription"},"type":"array"},"website":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"product":{"enum":["cse","corestack","corecluster"],"type":"string"}},"required":["id","name","product"],"type":"object"}},"required":["website","entries","presets","environments"],"type":"object"},"FirewallYourAddress":{"description":"The address this request came from, and whether it can connect.","properties":{"address":{"type":"string"},"allowed":{"type":"boolean"},"via":{"description":"The entries and presets that allow it.","items":{"$ref":"#/components/schemas/FirewallVia"},"type":"array"}},"required":["address","allowed","via"],"type":"object"},"GtmetrixGeneration":{"description":"One request to generate GTmetrix reports.","properties":{"audit_id":{"minimum":1,"type":"integer"},"error":{"description":"On a failed generation: how many tests were not started.","type":["string","null"]},"failures":{"description":"Each test GTmetrix refused.","items":{"properties":{"error":{"type":"string"},"name":{"type":"string"}},"required":["name","error"],"type":"object"},"type":"array"},"finished_at":{"format":"date-time","type":["string","null"]},"id":{"type":"string"},"location_id":{"type":"string"},"reports":{"items":{"properties":{"name":{"type":"string"},"test_id":{"type":"string"}},"required":["name","test_id"],"type":"object"},"type":"array"},"requested_at":{"format":"date-time","type":["string","null"]},"resumed":{"description":"Whether it starts only the tests the last generation at this location did not start.","type":"boolean"},"started":{"description":"How many GTmetrix has started.","minimum":0,"type":"integer"},"status":{"enum":["queued","running","completed","failed"],"type":"string"},"tests":{"description":"The tests of the generation.","minimum":0,"type":"integer"}},"required":["audit_id","id","status","location_id","resumed","tests","started","requested_at","finished_at","error","reports","failures"],"type":"object"},"GtmetrixLocations":{"properties":{"items":{"items":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"}},"required":["items"],"type":"object"},"GtmetrixReport":{"properties":{"error":{"type":["string","null"]},"filmstrip_timings_ms":{"items":{"type":"number"},"type":"array"},"frames":{"description":"With `frames=1`: each filmstrip image.","items":{"properties":{"jpeg_base64":{"type":"string"},"timing_ms":{"type":"number"}},"required":["timing_ms","jpeg_base64"],"type":"object"},"type":"array"},"metrics":{"description":"The figures of a completed test.","oneOf":[{"properties":{"cumulative_layout_shift":{"type":["number","null"]},"dom_content_loaded_time_ms":{"type":["number","null"]},"first_contentful_paint_ms":{"type":["number","null"]},"first_paint_time_ms":{"type":["number","null"]},"fully_loaded_time_ms":{"type":["number","null"]},"gtmetrix_grade":{"type":["string","null"]},"largest_contentful_paint_ms":{"type":["number","null"]},"performance_score":{"type":["number","null"]},"speed_index_ms":{"type":["number","null"]},"structure_score":{"type":["number","null"]},"time_to_first_byte_ms":{"type":["number","null"]},"time_to_interactive_ms":{"type":["number","null"]},"total_blocking_time_ms":{"type":["number","null"]}},"type":"object"},{"type":"null"}]},"name":{"description":"The environment and the page, such as `Corefinity Home`.","type":"string"},"state":{"description":"GTmetrix's own state of the test.","type":["string","null"]},"status":{"description":"`pending`: GTmetrix is still testing. `gone`: GTmetrix no longer has the test. `not_started`: no test was started for it. `unavailable`: GTmetrix did not answer for it this time.","enum":["completed","pending","failed","gone","not_started","unavailable"],"type":"string"},"test_id":{"type":["string","null"]}},"required":["name","test_id","status","state","error","metrics","filmstrip_timings_ms"],"type":"object"},"GtmetrixReportList":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"generation":{"description":"The last generation requested through the API or MCP. Null when none was.","oneOf":[{"$ref":"#/components/schemas/GtmetrixGeneration"},{"type":"null"}]},"items":{"items":{"$ref":"#/components/schemas/GtmetrixReport"},"type":"array"}},"required":["items","generation"],"type":"object"}]},"HttpAuthCredential":{"properties":{"password":{"type":"string"},"revealed_at":{"format":"date-time","type":"string"},"rule_id":{"minimum":1,"type":"integer"},"user_id":{"minimum":1,"type":"integer"},"username":{"type":"string"}},"required":["rule_id","user_id","username","password","revealed_at"],"type":"object"},"HttpAuthRule":{"properties":{"enabled":{"type":"boolean"},"id":{"minimum":1,"type":"integer"},"path_prefix":{"description":"The path the rule protects. Null for the whole environment.","type":["string","null"]},"sort":{"type":"integer"},"users":{"items":{"$ref":"#/components/schemas/HttpAuthUser"},"type":"array"}},"required":["id","path_prefix","enabled","users","sort"],"type":"object"},"HttpAuthRuleInput":{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"},"id":{"description":"A saved rule's id, to keep it. Leave it out, or send null, for a new rule.","type":["integer","null"]},"path_prefix":{"description":"Null for the whole environment. Otherwise a path that starts with `/` and contains only letters, digits,\n`-`, `_`, `.` and `/`.\n","maxLength":200,"type":["string","null"]},"users":{"items":{"$ref":"#/components/schemas/HttpAuthUserInput"},"maxItems":10,"minItems":1,"type":"array"}},"required":["path_prefix","enabled","users"],"type":"object"},"HttpAuthSaveResult":{"properties":{"credentials":{"description":"The passwords this save set or generated. Shown once.","items":{"$ref":"#/components/schemas/HttpAuthCredential"},"type":"array"},"http_auth":{"$ref":"#/components/schemas/HttpAuthSet"},"operation":{"oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]}},"required":["http_auth","operation","credentials"],"type":"object"},"HttpAuthSet":{"properties":{"apply":{"$ref":"#/components/schemas/ApplyState"},"bypass_corefinity":{"description":"How many of Corefinity's own addresses are let past HTTP authentication.","type":"integer"},"bypass_ips":{"description":"Always empty for you. Corefinity's own addresses are let past HTTP authentication and are told to Corefinity staff only; `bypass_corefinity` counts them.","items":{"type":"string"},"type":"array"},"default_for_role":{"description":"Whether an environment with this role starts protected.","type":"boolean"},"enabled":{"description":"Whether the whole environment asks for a login.","type":"boolean"},"limits":{"properties":{"prefix_max":{"type":"integer"},"rules_max":{"type":"integer"},"users_per_rule_max":{"type":"integer"}},"required":["rules_max","users_per_rule_max","prefix_max"],"type":"object"},"note":{"type":"string"},"rules":{"items":{"$ref":"#/components/schemas/HttpAuthRule"},"type":"array"},"version":{"type":"integer"}},"required":["version","enabled","rules","bypass_ips","bypass_corefinity","apply","limits","default_for_role","note"],"type":"object"},"HttpAuthUpdate":{"additionalProperties":false,"properties":{"enabled":{"description":"Whether the whole environment asks for a login. True needs a whole-environment rule (`path_prefix` null)\nwith at least one user, and that rule's own `enabled` must say the same.\n","type":"boolean"},"rules":{"items":{"$ref":"#/components/schemas/HttpAuthRuleInput"},"maxItems":20,"type":"array"},"version":{"description":"The `version` of the last read.","minimum":0,"type":"integer"}},"required":["version","enabled","rules"],"type":"object"},"HttpAuthUser":{"properties":{"created_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"password_set":{"type":"boolean"},"revealed_at":{"description":"When the password was last revealed.","format":"date-time","type":["string","null"]},"username":{"type":"string"}},"required":["id","username","password_set","revealed_at","created_at"],"type":"object"},"HttpAuthUserInput":{"additionalProperties":false,"properties":{"generate":{"default":false,"description":"Ask the Control Panel to generate the password. A new user needs `password` or `generate`, never both; a\nsaved user sent with neither keeps its password.\n","type":"boolean"},"id":{"description":"A saved user's id, to keep it. Leave it out, or send null, for a new user.","type":["integer","null"]},"password":{"description":"A password you choose: at least 12 characters and at most 72 bytes as UTF-8 (so fewer than 72 characters\nwhen it has characters outside ASCII), with at least one letter and one digit and no control characters.\nIt cannot be the username, the site's main domain or its platform address.\n","maxLength":72,"minLength":12,"type":["string","null"]},"username":{"description":"Lower-case letters, digits, dots, dashes and underscores, 3 to 32 characters. The first and the last character are a letter or a digit.","maxLength":32,"minLength":3,"pattern":"^[a-z0-9][a-z0-9._-]{1,30}[a-z0-9]$","type":"string"}},"required":["username"],"type":"object"},"InvalidRefusal":{"additionalProperties":true,"description":"A field that is missing or wrong. `field` names the first refused field; `errors` lists every one.","properties":{"code":{"const":"invalid","type":"string"},"detail_reason":{"$ref":"#/components/schemas/DetailReason"},"errors":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Each refused field with its messages.","type":"object"},"field":{"description":"The first refused field.","type":"string"},"message":{"type":"string"},"reason":{"const":"invalid","type":"string"}},"required":["message","errors","reason","code","field"],"type":"object"},"LaravelQueue":{"properties":{"delayed":{"description":"Jobs waiting for their time.","type":"integer"},"listened":{"description":"Whether a worker listens on the queue. Null when that is not known.","type":["boolean","null"]},"name":{"type":"string"},"name_supported":{"description":"Whether a worker's queue list can name the queue: letters, digits, `.`, `_`, `:` and `-`, 1 to 64 characters.","type":"boolean"},"oldest_ready_at":{"description":"When the oldest ready job became ready. The database driver only, else null.","format":"date-time","type":["string","null"]},"ready":{"description":"Jobs waiting for a worker now.","type":"integer"},"reserved":{"description":"Jobs being worked.","type":"integer"},"unworked":{"description":"True when the queue has jobs ready and no worker listens on it.","type":"boolean"},"waiting_seconds":{"description":"How long the oldest ready job has waited. The database driver only, else null.","type":["integer","null"]}},"required":["name","ready","delayed","reserved","oldest_ready_at","waiting_seconds","listened","unworked","name_supported"],"type":"object"},"LaravelQueues":{"description":"A Laravel site's queues, as they were at `checked_at`.","properties":{"checked_at":{"description":"When the figures were read. An answer may be up to a minute old.","format":"date-time","type":"string"},"config_source":{"description":"Where the queue settings were read from: `cache` (the application's cached configuration), `cache_refused`\n(a cached configuration that holds more than plain values, so the environment was read in its place),\n`env` or `defaults`.\n","enum":["cache","cache_refused","env","defaults"],"type":"string"},"connection":{"description":"The name of the queue connection the workers use (the application's `queue.default`).","type":"string"},"driver":{"description":"The driver of the queue connection the workers use, such as `database` or `redis`.","type":"string"},"failed":{"description":"The number of failed jobs, or null when it could not be counted.","type":["integer","null"]},"listening":{"description":"The queues the site's workers listen on.","properties":{"queues":{"description":"The queue names, or null when they are not known.","oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"source":{"description":"`default`: the connection's own queue. `unknown`: the queues could not be worked out.","enum":["default","unknown"],"type":"string"}},"required":["queues","source"],"type":"object"},"queues":{"description":"At most 50 queues, largest first.","items":{"$ref":"#/components/schemas/LaravelQueue"},"type":"array"},"reason":{"description":"Why `state` is `unsupported`: `driver`, `database_driver`, `table_name` or `redis_connection`. Null otherwise.","type":["string","null"]},"state":{"description":"`ok`; `unsupported` (a driver or database whose jobs cannot be counted: `reason` says which);\n`no_jobs_table` (the application has not created its jobs table).\n","enum":["ok","unsupported","no_jobs_table"],"type":"string"},"truncated":{"description":"True when the site has more queues than are listed.","type":"boolean"},"unreadable_names":{"description":"Queues left out because their name has control characters or is longer than 255 bytes.","type":"integer"},"unworked":{"description":"The names of the queues with jobs ready and no worker listening.","items":{"type":"string"},"type":"array"}},"required":["driver","connection","config_source","state","reason","listening","queues","unworked","truncated","failed","unreadable_names","checked_at"],"type":"object"},"LaravelQueuesFailedRefusal":{"properties":{"code":{"const":"helper_failed","type":"string"},"helper":{"description":"What failed.","enum":["database","redis","exec","output"],"type":"string"},"message":{"type":"string"},"reason":{"const":"helper_failed","type":"string"}},"required":["message","reason","helper","code"],"type":"object"},"LegacyEnvelope":{"additionalProperties":true,"description":"The answer of the older endpoints that wrap their result. `status` is `success` and the result is in `data`.","properties":{"data":{"description":"The result. Each endpoint says what it holds."},"message":{"type":"string"},"status":{"const":"success","type":"string"}},"required":["message","status"],"type":"object"},"LegacyEnvironment":{"additionalProperties":true,"description":"An environment of a website. Ids are sent as strings of digits, such as `\"1311\"`.","properties":{"access_server":{"description":"The server to connect to for shell access, when the environment has one.","type":["string","null"]},"id":{"type":"string"},"name":{"type":["string","null"]},"platform":{"additionalProperties":true,"description":"The application the environment runs.","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"}},"type":"object"},"platform_id":{"description":"The id of the application the environment runs.","type":"string"},"type":{"description":"The kind of environment as a number: 1 development, 2 staging, 3 pre-production, 4 production, 5 project, 6 release, 7 to 11 UAT 1 to 5, 12 a development box.","type":["integer","null"]},"type_description":{"description":"The name of `type`, such as `Production` or `Staging`.","type":["string","boolean","null"]},"url":{"type":["string","null"]},"website_id":{"type":"string"}},"required":["id","name","url","type","type_description","access_server","website_id","platform_id"],"type":"object"},"LegacyRefusal":{"additionalProperties":true,"description":"A refusal of the older endpoints. `status` is `error`; `reason` and `code` are sent when the refusal has a code.","properties":{"code":{"description":"The same value as `reason`.","type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"status":{"const":"error","type":"string"}},"required":["message","status"],"type":"object"},"LegacyWebsite":{"additionalProperties":true,"description":"A website. Ids are sent as strings of digits, such as `\"1310\"`.","properties":{"company_id":{"description":"The company the website belongs to.","type":"string"},"id":{"type":"string"},"name":{"type":["string","null"]},"url":{"type":["string","null"]}},"required":["id","name","url","company_id"],"type":"object"},"LogsContext":{"properties":{"after":{"description":"The later lines, oldest first.","items":{"$ref":"#/components/schemas/LogsLine"},"type":"array"},"before":{"description":"The earlier lines, oldest first.","items":{"$ref":"#/components/schemas/LogsLine"},"type":"array"},"line":{"$ref":"#/components/schemas/LogsLine"}},"required":["line","before","after"],"type":"object"},"LogsExport":{"description":"An export of log lines.","properties":{"bytes":{"description":"The size of the file. Null until it is ready.","type":["integer","null"]},"error":{"description":"Why the export failed. Null otherwise.","type":["string","null"]},"expires_at":{"description":"When the export can no longer be collected.","format":"date-time","type":["string","null"]},"format":{"enum":["csv","json"],"type":"string"},"id":{"description":"The `{download}` of the export endpoints.","type":"string"},"lines":{"description":"The lines in the file. Null until it is ready.","type":["integer","null"]},"state":{"description":"`preparing`, then `ready`. `expired` once it was collected or its time ran out. `failed` when it could not be made.","enum":["preparing","ready","expired","failed"],"type":"string"},"truncated":{"description":"True when the file was cut at 50,000 lines or 64 MiB.","type":"boolean"}},"required":["id","state","format","lines","bytes","truncated","expires_at","error"],"type":"object"},"LogsExportCollectRequest":{"properties":{"capability":{"description":"The `capability` the export's start answered.","maxLength":128,"type":"string"}},"required":["capability"],"type":"object"},"LogsExportFormat":{"properties":{"format":{"description":"`csv`, or `json` for one JSON object a line.","enum":["csv","json"],"type":"string"}},"required":["format"],"type":"object"},"LogsExportRequest":{"allOf":[{"$ref":"#/components/schemas/LogsReadChoice"},{"$ref":"#/components/schemas/LogsExportFormat"}],"description":"An export of a site's logs."},"LogsExportStarted":{"properties":{"capability":{"description":"What opens the file, once. Answered here and never again.","type":"string"},"download":{"$ref":"#/components/schemas/LogsExport"}},"required":["download","capability"],"type":"object"},"LogsFacets":{"anyOf":[{"additionalProperties":{"items":{"$ref":"#/components/schemas/LogsValueCount"},"type":"array"},"type":"object"},{"maxItems":0,"type":"array"}],"description":"The most frequent values of each field, by field name. An empty list when no line matched."},"LogsFacetsResult":{"properties":{"facets":{"$ref":"#/components/schemas/LogsFacets"}},"required":["facets"],"type":"object"},"LogsFieldValues":{"properties":{"field":{"type":"string"},"truncated":{"description":"True when the field has more than 50 values.","type":"boolean"},"values":{"items":{"$ref":"#/components/schemas/LogsValueCount"},"maxItems":50,"type":"array"}},"required":["field","values","truncated"],"type":"object"},"LogsFields":{"properties":{"fields":{"items":{"properties":{"name":{"type":"string"},"top":{"description":"Up to five most frequent values.","items":{"$ref":"#/components/schemas/LogsValueCount"},"type":"array"},"type":{"description":"What the field's most frequent values look like.","enum":["string","number","bool"],"type":"string"}},"required":["name","type","top"],"type":"object"},"type":"array"},"range":{"$ref":"#/components/schemas/LogsWindow"},"source":{"$ref":"#/components/schemas/LogsSource"}},"required":["source","fields","range"],"type":"object"},"LogsFilters":{"additionalProperties":false,"description":"Filters applied beside the query. Every entry must match. A key that is not listed here is refused.\n","properties":{"field":{"description":"Up to ten filters on any field.","items":{"properties":{"name":{"pattern":"^[A-Za-z0-9_.:@-]{1,128}$","type":"string"},"op":{"description":"`=` is, `!=` is not, `~` matches a regular expression, `!~` does not match it.","enum":["=","!=","~","!~"],"type":"string"},"value":{"maxLength":256,"type":"string"}},"required":["name","op","value"],"type":"object"},"maxItems":10,"type":"array"},"ip":{"description":"The address of the visitor, or a range of addresses written with `/`. Digits, the letters `a` to `f`, `.`, `:` and `/`.","pattern":"^[0-9A-Fa-f:./]{1,64}$","type":"string"},"level":{"description":"Lines of any of these levels.","items":{"enum":["debug","info","notice","warning","error","critical"],"type":"string"},"type":"array"},"method":{"description":"HTTP methods in capitals, such as `GET`.","items":{"pattern":"^[A-Z]{1,10}$","type":"string"},"maxItems":10,"type":"array"},"path":{"description":"The request path.","properties":{"mode":{"enum":["prefix","exact","regex"],"type":"string"},"value":{"maxLength":256,"minLength":1,"type":"string"}},"required":["mode","value"],"type":"object"},"status":{"description":"HTTP status classes (`2xx` to `5xx`, also `1xx`) or codes from 100 to 599. Any of them matches.","items":{"anyOf":[{"pattern":"^([1-5]xx|[1-5][0-9]{2})$","type":"string"},{"maximum":599,"minimum":100,"type":"integer"}]},"maxItems":20,"type":"array"},"text":{"description":"Up to five text filters.","items":{"properties":{"mode":{"description":"`phrase` and `word` match the text, `regex` matches a regular expression, `exclude` leaves out lines with the text.","enum":["phrase","word","regex","exclude"],"type":"string"},"value":{"maxLength":256,"minLength":1,"type":"string"}},"required":["mode","value"],"type":"object"},"maxItems":5,"type":"array"}},"type":"object"},"LogsHistogram":{"properties":{"buckets":{"items":{"properties":{"count":{"type":"integer"},"from":{"description":"The start of the slice.","format":"date-time","type":"string"},"levels":{"additionalProperties":{"type":"integer"},"description":"The count of each level in the slice. Lines without a level count as `unknown`.","type":"object"}},"required":["from","count","levels"],"type":"object"},"type":"array"},"warnings":{"items":{"type":"string"},"type":"array"}},"required":["buckets","warnings"],"type":"object"},"LogsLine":{"additionalProperties":true,"description":"One log line.","properties":{"fields":{"anyOf":[{"additionalProperties":{"type":["string","number","boolean","null"]},"type":"object"},{"maxItems":0,"type":"array"}],"description":"The line's other fields, by name. An empty list when it has none."},"msg":{"description":"The line's text.","type":"string"},"source":{"$ref":"#/components/schemas/LogsSource"},"stream_id":{"description":"The stream the line belongs to. With `time`, it names the line for the context endpoint.","type":"string"},"time":{"description":"When the line was written.","format":"date-time","type":"string"}},"required":["time","source","stream_id","msg","fields"],"type":"object"},"LogsPaging":{"description":"The paging fields of a search.","properties":{"cursor":{"description":"The `next_cursor` of the previous page, sent with the same request. A cursor from another request or another access token is refused `422` on `cursor`.","type":["string","null"]},"facets":{"description":"Field names whose ten most frequent values to answer beside the lines, as a list or one comma-separated value.","oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"},{"type":"null"}]},"limit":{"default":200,"description":"Lines a page.","maximum":1000,"minimum":1,"type":["integer","null"]}},"type":"object"},"LogsQueryPage":{"additionalProperties":true,"description":"What a search answers beside `next_cursor`.","properties":{"effective_query":{"description":"The query that was run. `*` when none was sent.","type":"string"},"facets":{"$ref":"#/components/schemas/LogsFacets","description":"The fields asked for with `facets`. Sent only when the request names some and `kind` is `records`."},"kind":{"description":"`records` for log lines, `table` for the answer of an aggregating query.","enum":["records","table"],"type":"string"},"lines":{"description":"The lines, newest first. Empty when `kind` is `table`.","items":{"$ref":"#/components/schemas/LogsLine"},"type":"array"},"stats":{"additionalProperties":true,"properties":{"duration_ms":{"description":"How long the read took.","type":"integer"}},"required":["duration_ms"],"type":"object"},"table":{"description":"The groups of an aggregating query. Null when `kind` is `records`.","oneOf":[{"items":{"$ref":"#/components/schemas/LogsTableGroup"},"type":"array"},{"type":"null"}]},"tenant":{"$ref":"#/components/schemas/LogsQuota"},"truncated":{"description":"True when a table was cut at `limit` rows a group.","type":"boolean"},"warnings":{"items":{"type":"string"},"type":"array"},"window":{"$ref":"#/components/schemas/LogsWindow"}},"required":["kind","lines","table","stats","truncated","warnings","effective_query","tenant","window"],"type":"object"},"LogsQueryRequest":{"allOf":[{"$ref":"#/components/schemas/LogsReadChoice"},{"$ref":"#/components/schemas/LogsPaging"}],"description":"A search of a site's logs. Every field is optional."},"LogsQueryResult":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"$ref":"#/components/schemas/LogsQueryPage"}],"description":"A page of a search of a site's logs. The next page holds the older lines."},"LogsQuota":{"description":"The logs quota the lines count against.","properties":{"percent":{"description":"How much of the quota is used.","type":"integer"},"quota_gb":{"type":"integer"},"retention_days":{"description":"How many days lines are kept for.","type":"integer"},"state":{"$ref":"#/components/schemas/LogsQuotaState"},"stored_gb":{"type":"number"}},"required":["quota_gb","stored_gb","percent","retention_days","state"],"type":"object"},"LogsQuotaState":{"description":"`ok`, `warning` when the quota is nearly used, `over_quota`, or `unavailable`.","enum":["ok","warning","over_quota","unavailable"],"type":"string"},"LogsRange":{"description":"A time range back from now. The sources list answers the ranges your retention allows.","enum":["15m","1h","6h","24h","7d","30d"],"type":"string"},"LogsReadChoice":{"description":"Which lines of a site to read, and over what time.","properties":{"environment_id":{"description":"The site row id of another environment of the same website to read instead of `{site}`.","minimum":1,"type":["integer","null"]},"filters":{"description":"Filters applied beside the query.","oneOf":[{"$ref":"#/components/schemas/LogsFilters"},{"type":"null"}]},"from":{"description":"The start of the time range, as a date and time. It must be inside the time your logs are kept for.","type":["string","null"]},"query":{"description":"A LogsQL query, sent as written. Every line when left out. Up to 4 KB.","maxLength":4096,"type":["string","null"]},"range":{"description":"How far back from now to read. One hour when neither `range` nor `from` is sent. Ignored when `from` is sent.","oneOf":[{"$ref":"#/components/schemas/LogsRange"},{"type":"null"}]},"scope":{"default":"env","description":"`env` reads the one environment. `site` reads every environment of the website that you can see.","enum":["env","site",null],"type":["string","null"]},"source":{"$ref":"#/components/schemas/LogsSource"},"to":{"description":"The end of the time range, as a date and time. Now when left out.","type":["string","null"]}},"type":"object"},"LogsSavedQuery":{"properties":{"can_delete":{"description":"True when you may delete it.","type":"boolean"},"cluster":{"description":"The CoreCluster the query is kept for. Sent only for a query kept for a CoreCluster.","oneOf":[{"$ref":"#/components/schemas/ClusterRef"},{"type":"null"}]},"created_at":{"format":"date-time","type":["string","null"]},"filters":{"description":"The saved filters. Null when none were sent, and an empty list when they were saved as an empty object.","oneOf":[{"$ref":"#/components/schemas/LogsFilters"},{"maxItems":0,"type":"array"},{"type":"null"}]},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"query":{"description":"The LogsQL query. Null for a query saved as filters.","type":["string","null"]},"range":{"enum":["15m","1h","6h","24h","7d","30d","custom"],"type":"string"},"shared":{"description":"True for a query Corefinity support shared with everyone on the site or CoreCluster.","type":"boolean"},"site":{"description":"The site the query is kept for. Null for one kept for every site, or for a CoreCluster.","oneOf":[{"$ref":"#/components/schemas/SiteRef"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/LogsSource"}},"required":["id","name","source","query","filters","range","site","shared","can_delete","created_at"],"type":"object"},"LogsSavedQueryFields":{"properties":{"filters":{"description":"Filters, kept with the query.","oneOf":[{"$ref":"#/components/schemas/LogsFilters"},{"type":"null"}]},"name":{"maxLength":60,"minLength":1,"type":"string"},"query":{"description":"A LogsQL query. Up to 4 KB.","maxLength":4096,"type":["string","null"]},"range":{"description":"The time range the query opens with. `custom` means a range chosen each time.","enum":["15m","1h","6h","24h","7d","30d","custom"],"type":"string"},"source":{"$ref":"#/components/schemas/LogsSource"}},"required":["name","source","range"],"type":"object"},"LogsSavedQueryList":{"properties":{"items":{"items":{"$ref":"#/components/schemas/LogsSavedQuery"},"type":"array"}},"required":["items"],"type":"object"},"LogsSavedQueryRequest":{"allOf":[{"$ref":"#/components/schemas/LogsSavedQueryFields"},{"properties":{"site_id":{"description":"The `{site}` of the request, to keep the query for this site. Left out or null, the query is kept for every site.","minimum":1,"type":["integer","null"]}},"type":"object"}],"description":"A query to save from a site."},"LogsSource":{"default":"all","description":"A log source. `all` reads every source. `search` and `queue` exist only on platforms that run them; the\nsources list says which ones an environment has.\n","enum":["all","web-access","web-error","php","app","cron","database","cache","search","queue"],"type":"string"},"LogsSourceState":{"properties":{"available":{"type":"boolean"},"key":{"$ref":"#/components/schemas/LogsSource"},"label":{"type":"string"},"reason":{"description":"Why the source is not available: `not_collected` (the environment does not run it), or `contract_v3` or\n`tenant_pending` (it starts once the environment's next platform update has applied). Null when available.\n","enum":["not_collected","contract_v3","tenant_pending",null],"type":["string","null"]}},"required":["key","label","available","reason"],"type":"object"},"LogsStreams":{"additionalProperties":true,"description":"What a read of a site's logs can ask for.","properties":{"limits":{"properties":{"max_limit":{"description":"The most lines a page.","type":"integer"},"max_query_bytes":{"type":"integer"},"max_range_days":{"description":"How far back a read may start, in days.","type":"integer"},"queries_per_minute":{"description":"The reads a minute one person may make, across the Control Panel, the API and MCP.","type":"integer"},"timeout_seconds":{"type":"integer"}},"required":["max_range_days","max_limit","max_query_bytes","timeout_seconds","queries_per_minute"],"type":"object"},"ranges":{"description":"The ranges a read may use.","items":{"$ref":"#/components/schemas/LogsRange"},"type":"array"},"sources":{"items":{"$ref":"#/components/schemas/LogsSourceState"},"type":"array"},"tenant":{"$ref":"#/components/schemas/LogsQuota"},"unpack_json":{"description":"True when a line written as JSON is answered with its keys as fields.","type":"boolean"}},"required":["sources","limits","tenant","unpack_json","ranges"],"type":"object"},"LogsTableGroup":{"additionalProperties":true,"description":"The rows of an aggregating query for one group of environments.","properties":{"columns":{"items":{"type":"string"},"type":"array"},"label":{"description":"The environments the rows cover.","type":"string"},"rows":{"items":{"additionalProperties":{"type":"string"},"description":"One row, each column's value as text.","type":"object"},"type":"array"}},"required":["label","columns","rows"],"type":"object"},"LogsUsage":{"additionalProperties":true,"description":"The logs quota and what is stored against it. Not the shared `Usage`, which is the CPU, memory and disk a site\nuses over time.\n","properties":{"addon":{"additionalProperties":true,"description":"The extra log storage on the owner's contract. Sent only while billing is on for your company, the site\nor CoreCluster has a usage-billed contract and you may read its billing account.\n","properties":{"monthly":{"$ref":"#/components/schemas/Money","description":"What the extra GB cost a month."},"purchased_gb":{"description":"The extra GB on the contract now.","type":"integer"},"unit":{"const":"log_storage_gb","type":"string"},"unit_price":{"$ref":"#/components/schemas/Money","description":"The monthly price of one more GB."}},"required":["unit","unit_price","purchased_gb","monthly"],"type":"object"},"by_environment":{"description":"The share of each environment you can see.","items":{"properties":{"environment":{"$ref":"#/components/schemas/EnvironmentRef"},"percent":{"type":"integer"},"stored_bytes":{"type":"integer"}},"required":["environment","stored_bytes","percent"],"type":"object"},"type":"array"},"daily":{"description":"One entry a day for the last 30 days, oldest first, over the environments you can see.","items":{"properties":{"day":{"format":"date","type":"string"},"ingested_bytes":{"type":"integer"},"rows":{"description":"The lines taken in that day.","type":"integer"},"stored_bytes":{"type":"integer"}},"required":["day","ingested_bytes","stored_bytes","rows"],"type":"object"},"type":"array"},"forecast":{"properties":{"days_to_quota":{"description":"Days until the quota is full at the last week's growth. Null when it cannot be told.","type":["integer","null"]},"next_enforce_at":{"description":"When the oldest lines are next removed to bring the store under its quota. Null while the state is `ok`.","format":"date-time","type":["string","null"]}},"required":["days_to_quota","next_enforce_at"],"type":"object"},"percent":{"type":"integer"},"quota":{"properties":{"included_gb":{"type":"integer"},"purchased_gb":{"type":"integer"}},"required":["included_gb","purchased_gb"],"type":"object"},"quota_gb":{"type":"integer"},"retention_days":{"type":"integer"},"stored_gb":{"type":"number"},"tenant":{"additionalProperties":true,"properties":{"owner":{"description":"What the quota belongs to.","properties":{"ref":{"anyOf":[{"$ref":"#/components/schemas/SiteRef"},{"$ref":"#/components/schemas/ClusterRef"}],"description":"The site (`id`, `domain`) or the CoreCluster (`id`, `name`)."},"type":{"enum":["site","corecluster"],"type":"string"}},"required":["type","ref"],"type":"object"},"state":{"$ref":"#/components/schemas/LogsQuotaState"}},"required":["owner","state"],"type":"object"}},"required":["tenant","quota_gb","quota","stored_gb","percent","retention_days","daily","by_environment","forecast"],"type":"object"},"LogsValueCount":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"LogsWindow":{"description":"The exact time range that was read. Send `from` and `to` back to read the same range again.","properties":{"from":{"format":"date-time","type":"string"},"to":{"format":"date-time","type":"string"}},"required":["from","to"],"type":"object"},"MagentoKeys":{"additionalProperties":true,"description":"Which Marketplace keys a company's Magento 2 installs use. A key is never part of the answer, only the last four characters of the public key.","properties":{"agency":{"type":["string","null"]},"can_change":{"type":"boolean"},"commerce_sites":{"description":"The Adobe Commerce sites that use the keys.","properties":{"count":{"type":"integer"},"sites":{"items":{},"type":"array"}},"type":"object"},"entitlements":{"description":"What the keys can install.","properties":{"checked_at":{"format":"date-time","type":["string","null"]},"commerce":{"type":"boolean"},"error":{"type":["string","null"]},"open_source":{"type":"boolean"}},"required":["open_source","commerce","checked_at","error"],"type":"object"},"fallback":{"type":["string","null"]},"public_key_last4":{"type":["string","null"]},"source":{"description":"Where the keys come from: `company` for the company's own, `none` when there are none. Other values name keys the company inherits.","type":"string"},"updated_at":{"format":"date-time","type":["string","null"]},"updated_by":{"description":"Who saved the keys.","oneOf":[{"additionalProperties":true,"properties":{"id":{"type":["integer","null"]},"name":{"type":["string","null"]}},"required":["id","name"],"type":"object"},{"type":"null"}]},"verified_at":{"format":"date-time","type":["string","null"]}},"required":["source","public_key_last4","verified_at","updated_at","updated_by","can_change","entitlements"],"type":"object"},"MagentoKeysDeleteRequest":{"properties":{"confirm_company":{"description":"The company's name, typed exactly. Needed only while Adobe Commerce sites use the keys.","type":"string"}},"type":"object"},"MagentoKeysUpdateRequest":{"properties":{"private_key":{"description":"The private key, in the same form. It is stored encrypted and never answered.","pattern":"^[0-9a-f]{32}$","type":"string"},"public_key":{"description":"The public key: 32 characters, 0 to 9 and a to f.","pattern":"^[0-9a-f]{32}$","type":"string"}},"required":["public_key","private_key"],"type":"object"},"MagentoStoreChoice":{"additionalProperties":false,"properties":{"code":{"description":"The exact code read from Magento. Admission accepts lower-case letters, digits and underscores only.","maxLength":32,"minLength":1,"type":"string"},"type":{"enum":["website","store"],"type":"string"}},"required":["code","type"],"type":"object"},"MagentoStoreDetails":{"properties":{"active":{"type":"boolean"},"base_url":{"type":["string","null"]},"base_url_elsewhere":{"description":"The base URL is on a host not showing this store.","type":"boolean"},"base_url_own":{"description":"The base URL is on the site's preview address, primary domain or its www form and can move automatically with a store domain.","type":"boolean"},"code":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"shown_on":{"items":{"type":"string"},"type":"array"}},"required":["id","code","name","active","shown_on","base_url","base_url_elsewhere","base_url_own"],"type":"object"},"MagentoStoreMappingUpdate":{"additionalProperties":false,"properties":{"default":{"anyOf":[{"$ref":"#/components/schemas/MagentoStoreChoice"},{"type":"null"}],"description":"Omitted keeps the choice; null returns to Magento's default."},"domains_version":{"description":"The domains_version from the stores read.","minimum":0,"type":"integer"},"hosts":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/MagentoStoreChoice"},{"type":"null"}]},"description":"A partial mapping of served hostnames to store choices. Omitted hosts keep their choices; null uses the default without removing the domain or making it redirect.","maxProperties":10,"type":"object"},"nginx_version":{"description":"The nginx_version from the stores read.","minimum":0,"type":"integer"},"point_base_urls":{"description":"Explicitly move these stores' base URLs here, including values on another host. Ask the person first.","items":{"maxLength":253,"minLength":1,"type":"string"},"maxItems":10,"type":"array"}},"required":["nginx_version","domains_version"],"type":"object"},"MagentoStores":{"properties":{"default_hosts":{"description":"Addresses without their own store choice, including the platform address.","items":{"type":"string"},"type":"array"},"default_store":{"anyOf":[{"$ref":"#/components/schemas/MagentoStoreChoice"},{"type":"null"}],"description":"The explicit default, or Magento's default website when none was selected."},"domains_version":{"minimum":0,"type":"integer"},"nginx_version":{"minimum":0,"type":"integer"},"read_at":{"format":"date-time","type":"string"},"store_hosts":{"description":"Extra store addresses set up by support. Non-empty makes customer store changes read-only.","items":{"type":"string"},"type":"array"},"warnings":{"description":"Non-blocking warnings such as base_url_elsewhere, base_url_host_unchosen, store_codes_in_urls and store_not_shown.","items":{"additionalProperties":true,"properties":{"message":{"type":"string"},"reason":{"type":"string"}},"required":["reason","message"],"type":"object"},"type":"array"},"websites":{"items":{"allOf":[{"$ref":"#/components/schemas/MagentoStoreDetails"},{"properties":{"default_group_id":{"type":"integer"},"is_default":{"type":"boolean"},"store_views":{"items":{"allOf":[{"$ref":"#/components/schemas/MagentoStoreDetails"},{"properties":{"group_id":{"type":"integer"},"is_active":{"type":"boolean"},"website_id":{"type":"integer"}},"required":["website_id","group_id","is_active"],"type":"object"}]},"type":"array"}},"required":["is_default","default_group_id","store_views"],"type":"object"}]},"type":"array"}},"required":["websites","default_store","default_hosts","nginx_version","domains_version","warnings","read_at","store_hosts"],"type":"object"},"MaintenanceModeResult":{"properties":{"command":{"additionalProperties":true,"description":"The command that switched it.","properties":{"duration_ms":{"type":["integer","null"]},"error":{"type":["string","null"]},"exit_code":{"type":["integer","null"]},"finished_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"input":{"additionalProperties":true,"description":"What was asked for.","properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"},"kind":{"type":"string"},"label":{"type":"string"},"output_excerpt":{"type":["string","null"]},"queued_at":{"format":"date-time","type":["string","null"]},"result":{"additionalProperties":true,"description":"What the check after the switch found.","properties":{"enabled":{"description":"Whether the site answers with the maintenance page.","type":"boolean"},"host_checked":{"description":"The address the check asked. Null when no check was made, which is the case when the site was already in the state you asked for.","type":["string","null"]},"http_code":{"description":"The status the site answered the check with. Null when no check was made.","type":["integer","null"]}},"type":["object","null"]},"started_at":{"format":"date-time","type":["string","null"]},"status":{"description":"`succeeded`, or `failed` with the reason in `error`.","type":"string"},"status_label":{"type":"string"}},"required":["id","kind","status"],"type":"object"},"maintenance":{"additionalProperties":true,"description":"The site's maintenance state after the switch.","properties":{"by":{"description":"Who switched it on."},"bypass_corefinity":{"description":"How many of Corefinity's own addresses still see the site.","type":"integer"},"bypass_ips":{"description":"Always empty for you. Corefinity's own addresses still see the site and are told to Corefinity staff only; `bypass_corefinity` counts them.","items":{"type":"string"},"type":"array"},"command":{"description":"The last switch, in short."},"enabled":{"type":"boolean"},"page":{"type":["string","null"]},"retry_after_seconds":{"description":"What the maintenance page tells visitors and search engines to wait.","type":["integer","null"]},"since":{"type":["string","null"]}},"required":["enabled"],"type":"object"}},"required":["maintenance","command"],"type":"object"},"MaintenanceModeSwitch":{"properties":{"enabled":{"description":"True switches maintenance mode on, false off.","type":"boolean"}},"required":["enabled"],"type":"object"},"MaintenanceWindowEditRefusal":{"description":"Why the window cannot be changed. Sent only when `editable` is false.","enum":["window_scope_unavailable","forbidden","window_locked"],"type":"string"},"MaintenanceWindowEffective":{"additionalProperties":true,"description":"The window in force, wherever it comes from.","properties":{"end_hour":{"description":"The hour the window closes.","maximum":23,"minimum":0,"type":"integer"},"label":{"description":"The window in words, such as `00:00–04:00 UK time`.","type":"string"},"length_hours":{"type":"integer"},"source":{"description":"The level the window comes from. `staff_lock` is a window Corefinity has set, which cannot be changed here.","enum":["site","cluster","staff_lock","company","platform"],"type":"string"},"source_label":{"type":"string"},"staff_locked":{"description":"True when Corefinity has set the window.","type":"boolean"},"start_hour":{"description":"The hour the window opens, in `timezone`.","maximum":23,"minimum":0,"type":"integer"},"timezone":{"type":"string"}},"required":["start_hour","end_hour","length_hours","timezone","label","source","source_label","staff_locked"],"type":"object"},"MaintenanceWindowHistory":{"properties":{"events":{"items":{"properties":{"action":{"enum":["set","cleared","locked","unlocked"],"type":"string"},"actor":{"properties":{"name":{"description":"The person's name. Corefinity's own changes read `Corefinity`.","type":"string"}},"required":["name"],"type":"object"},"after":{"$ref":"#/components/schemas/MaintenanceWindowOwn"},"at":{"format":"date-time","type":["string","null"]},"before":{"$ref":"#/components/schemas/MaintenanceWindowOwn"},"channel":{"description":"Where the change was made.","enum":["panel","api","mcp","staff","system"],"type":"string"},"level":{"description":"The level that was changed.","enum":["website","cluster","company","platform"],"type":"string"}},"required":["at","actor","channel","action","before","after","level"],"type":"object"},"type":"array"},"next_cursor":{"description":"Send as `cursor` to read the next page. Null on the last page. A number here, not the text the shared `CursorPage` carries, so this page keeps its own shape.","type":["integer","null"]}},"required":["events","next_cursor"],"type":"object"},"MaintenanceWindowInherited":{"description":"The window this level uses when it has none of its own.","properties":{"level":{"enum":["website","cluster","company","platform"],"type":"string"},"name":{"type":["string","null"]},"start_hour":{"maximum":23,"minimum":0,"type":"integer"}},"required":["level","name","start_hour"],"type":"object"},"MaintenanceWindowNoticePeriod":{"description":"The notice period while it runs: `until` is its end, or null before it has a date. Null once it has passed.","oneOf":[{"properties":{"until":{"type":["string","null"]}},"required":["until"],"type":"object"},{"type":"null"}]},"MaintenanceWindowOwn":{"description":"The start hour set at this level. Null when the level has none of its own and inherits.","oneOf":[{"properties":{"start_hour":{"maximum":23,"minimum":0,"type":"integer"}},"required":["start_hour"],"type":"object"},{"type":"null"}]},"MaintenanceWindowPreview":{"additionalProperties":true,"description":"What a change of window would do. Nothing is saved.","properties":{"batches":{"description":"The queued changes that would move, for the sites you can see.","items":{"properties":{"after":{"$ref":"#/components/schemas/MaintenanceWindowPreviewAt"},"before":{"$ref":"#/components/schemas/MaintenanceWindowPreviewAt"},"domain":{"type":"string"},"environment":{"oneOf":[{"$ref":"#/components/schemas/MaintenanceWindowPreviewEnvironment"},{"type":"null"}]},"policy":{"enum":["site","night","platform","rollout"],"type":"string"},"site_id":{"minimum":1,"type":"integer"}},"required":["site_id","domain","environment","policy","before","after"],"type":"object"},"type":"array"},"effective_after":{"description":"The window in force after the change.","properties":{"end_hour":{"maximum":23,"minimum":0,"type":"integer"},"label":{"type":"string"},"source":{"enum":["site","cluster","staff_lock","company","platform"],"type":"string"},"source_label":{"type":"string"},"start_hour":{"maximum":23,"minimum":0,"type":"integer"}},"required":["start_hour","end_hour","label","source","source_label"],"type":"object"},"hold_until":{"description":"Nothing queued is applied before this time, so a change of window never applies work at once.","type":"string"},"moved":{"description":"How many queued changes would move, including those of sites you cannot see.","type":"integer"},"next_after":{"description":"The next occurrence after the change.","oneOf":[{"properties":{"ends_at":{"format":"date-time","type":"string"},"label":{"type":"string"},"starts_at":{"format":"date-time","type":"string"}},"required":["starts_at","ends_at","label"],"type":"object"},{"type":"null"}]},"notice_period":{"$ref":"#/components/schemas/MaintenanceWindowNoticePeriod"},"snapshot_overlap":{"$ref":"#/components/schemas/MaintenanceWindowSnapshotOverlap"},"unchanged":{"description":"True when the window would have the same times as now.","type":"boolean"}},"required":["effective_after","next_after","hold_until","batches","moved","unchanged","notice_period","snapshot_overlap"],"type":"object"},"MaintenanceWindowPreviewAt":{"oneOf":[{"properties":{"label":{"type":"string"},"starts_at":{"format":"date-time","type":"string"}},"required":["starts_at","label"],"type":"object"},{"type":"null"}]},"MaintenanceWindowPreviewEnvironment":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"role":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug","role"],"type":"object"},"MaintenanceWindowSlot":{"description":"One occurrence of a window.","properties":{"ends_at":{"format":"date-time","type":"string"},"hours":{"type":"number"},"label":{"type":["string","null"]},"last_start_at":{"description":"The latest time work may start in this occurrence.","format":"date-time","type":"string"},"local_date":{"type":"string"},"starts_at":{"format":"date-time","type":"string"}},"required":["starts_at","last_start_at","ends_at","local_date","label","hours"],"type":"object"},"MaintenanceWindowSnapshotOverlap":{"description":"A scheduled snapshot that falls inside the window, with its local time. Null when there is none.","oneOf":[{"properties":{"at_local":{"type":"string"}},"required":["at_local"],"type":"object"},{"type":"null"}]},"MaintenanceWindowUpdate":{"additionalProperties":false,"description":"The only field is the start hour. A window always lasts four hours, UK time.","properties":{"start_hour":{"description":"The hour the window opens, from 0 to 23, UK time.","maximum":23,"minimum":0,"type":"integer"}},"required":["start_hour"],"type":"object"},"ManagedElsewhereRefusal":{"description":"The site is managed by another control panel and is read-only here.","properties":{"code":{"const":"managed_elsewhere","type":"string"},"message":{"type":"string"},"reason":{"const":"managed_elsewhere","type":"string"}},"required":["message","reason","code"],"type":"object"},"Message":{"description":"An answer that carries only a sentence in plain words.","properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"Money":{"properties":{"amount":{"type":"string"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"MoveSizeAnswer":{"properties":{"acknowledge_warning":{"description":"Send true with `keep`, once the person has read the option's `warning`.","type":"boolean"},"answer":{"description":"`accept` takes the larger size, `keep` the smaller one.","enum":["accept","keep"],"type":"string"},"confirm_cost":{"description":"Send true with `accept` when the option's `confirm_cost` is true, once the person has agreed to the extra monthly cost.","type":"boolean"},"question_id":{"description":"The `id` of the environment's `move_size`.","minimum":1,"type":"integer"}},"required":["question_id","answer"],"type":"object"},"MoveSizeOption":{"properties":{"answer":{"description":"The value to send as `answer` for this size.","enum":["accept","keep"],"type":"string"},"confirm_cost":{"description":"True when this answer costs more a month, so it must be sent with `confirm_cost: true`.","type":"boolean"},"currency":{"type":["string","null"]},"delta":{"description":"How much more a month the larger size costs than the smaller one.","type":["string","null"]},"included":{"description":"Whether your plan includes this size at no charge.","type":["boolean","null"]},"label":{"type":"string"},"monthly":{"description":"The monthly price of the size from when the move goes live. Null when it could not be priced.","type":["string","null"]},"uat_size":{"description":"The staging size, such as `medium` or `large`.","type":"string"},"warning":{"description":"What keeping the smaller size risks. Sent on the `keep` option.","type":["string","null"]}},"required":["answer","uat_size","monthly","currency","included","delta","label","warning","confirm_cost"],"type":"object"},"MoveSizeQuestion":{"additionalProperties":true,"description":"The staging size an environment's move to CoreStack asks about: the memory it was measured to use, the two sizes with their prices, and the answer once given.","properties":{"answer":{"description":"The answer given. Null until one is.","oneOf":[{"properties":{"answer":{"enum":["accept","keep"],"type":"string"},"answered_at":{"format":"date-time","type":["string","null"]},"on_behalf":{"description":"True when Corefinity recorded the choice for you.","type":["boolean","null"]},"uat_size":{"type":["string","null"]},"warning_acknowledged":{"type":["boolean","null"]}},"required":["answer","uat_size","warning_acknowledged","answered_at","on_behalf"],"type":"object"},{"type":"null"}]},"asked_at":{"format":"date-time","type":["string","null"]},"disk_size":{"description":"The smaller size, which the disk alone suggests.","type":"string"},"id":{"description":"The `question_id` to answer.","minimum":1,"type":"integer"},"measured":{"description":"What was measured, in a sentence.","type":["string","null"]},"memory_size":{"description":"The larger size, which the measured memory suggests.","type":"string"},"options":{"description":"The two answers: `accept` the larger size, or `keep` the smaller one.","items":{"$ref":"#/components/schemas/MoveSizeOption"},"type":"array"},"price_note":{"type":["string","null"]},"priced":{"type":"boolean"},"rule_version":{"type":"string"},"state":{"description":"`open` until answered, then `answered`. An answer can be changed until the move uses it.","enum":["open","answered"],"type":"string"},"window_days":{"description":"How many days of use were measured.","type":"integer"}},"required":["id","state","asked_at","measured","window_days","memory_size","disk_size","priced","price_note","options","answer","rule_version"],"type":"object"},"Named":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"NamedFieldRefusal":{"additionalProperties":true,"description":"A refusal about a field that is not a wrong value, such as a confirmation that is needed. It carries a reason\nof its own and `errors` names the field; there is no `field`.\n","properties":{"code":{"description":"The same value as `reason`.","type":"string"},"errors":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["message","reason","code","errors"],"type":"object"},"NginxBackupGuard":{"description":"Corefinity's backup-file rule on one site.","properties":{"applied":{"description":"Whether the site carries the rule now.","type":"boolean"},"attention_extensions":{"description":"File endings that often hold backups and that the rule does not block.","items":{"type":"string"},"type":"array"},"available":{"description":"Whether the rule is offered for the site. False while it is not, and switching it on is refused.","type":"boolean"},"enabled":{"description":"Whether the rule is wanted. On unless somebody switched it off.","type":"boolean"},"extensions":{"description":"The file endings the rule blocks.","items":{"type":"string"},"type":"array"},"lines":{"description":"The rule as Nginx reads it, for display.","items":{"type":"string"},"type":"array"},"pending":{"description":"Whether a change to the rule is still running.","type":"boolean"},"platform_enforced":{"description":"True when the site's platform always blocks these files itself, so the rule cannot be switched off.","type":"boolean"},"switched_off_at":{"description":"When the rule was switched off. Null while it is on.","format":"date-time","type":["string","null"]},"uncertain":{"description":"True when the last change was saved but not confirmed, so whether the site carries the rule is not\nknown. It is applied again within a few minutes.\n","type":"boolean"}},"required":["available","enabled","applied","uncertain","pending","platform_enforced","extensions","attention_extensions","switched_off_at","lines"],"type":"object"},"NginxBackupGuardSaveResult":{"properties":{"backup_guard":{"$ref":"#/components/schemas/NginxBackupGuard"},"operation":{"description":"The change to follow. Null when nothing was started.","oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]}},"required":["backup_guard","operation"],"type":"object"},"NginxBackupGuardUpdate":{"additionalProperties":false,"properties":{"apply":{"description":"Only `now`, the default. The change always applies at once.","enum":["now"],"type":"string"},"enabled":{"description":"True to block backup files, false to stop.","type":"boolean"}},"required":["enabled"],"type":"object"},"NginxCheckResult":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/NginxDiagnostic"},"type":"array"},"path_apps_rendered":{"description":"With `render: true`: the Nginx text written for the path apps. Null when there are none or they have errors.","oneOf":[{"$ref":"#/components/schemas/NginxPathAppsRendered"},{"type":"null"}]},"policy_version":{"type":"integer"},"test":{"description":"The test run that was started. Null when the test was skipped or the policy found errors.","oneOf":[{"properties":{"id":{"minimum":1,"type":"integer"},"status":{"$ref":"#/components/schemas/NginxTestStatus"}},"required":["id","status"],"type":"object"},{"type":"null"}]}},"required":["diagnostics","policy_version","test"],"type":"object"},"NginxCopyPreview":{"properties":{"content":{"additionalProperties":true,"description":"The hooks as they would be saved: the text of each, null for an empty one.","properties":{"headers":{"type":["string","null"]},"http":{"type":["string","null"]},"php":{"type":["string","null"]},"server":{"type":["string","null"]}},"type":"object"},"diagnostics":{"items":{"$ref":"#/components/schemas/NginxDiagnostic"},"type":"array"},"diff":{"additionalProperties":{"type":["string","null"]},"description":"A unified diff per hook, from this environment's rules to the copied ones. Null where a hook does not change.","type":"object"},"rewrites":{"description":"What was rewritten for this environment, such as the web root.","items":{"properties":{"count":{"type":["integer","null"]},"from":{"type":"string"},"hook":{"type":"string"},"line":{"type":["integer","null"]},"to":{"type":"string"}},"required":["hook","line","from","to","count"],"type":"object"},"type":"array"},"source_revision":{"description":"The revision that would be copied.","oneOf":[{"additionalProperties":true,"properties":{"id":{"minimum":1,"type":"integer"},"number":{"type":"integer"},"site_id":{"minimum":1,"type":"integer"}},"type":"object"},{"type":"null"}]},"state":{"const":"dry_run","type":"string"},"warnings":{"description":"Path apps that would not be carried (`path_app_not_carried`).","items":{"additionalProperties":true,"type":"object"},"type":"array"}},"required":["state","content","rewrites","diff","diagnostics","source_revision"],"type":"object"},"NginxCorefinityRulesMove":{"additionalProperties":false,"properties":{"apply":{"default":"now","description":"Only `now`: a move cannot wait for a window.","enum":["now"],"type":"string"},"blocks":{"description":"The `from_line` of each block to move. Every block that can move when left out.","items":{"type":"integer"},"type":["array","null"]},"test_id":{"description":"A passed test run of the same content, from a check, so it is not run again.","minimum":1,"type":"integer"},"version":{"description":"The `version` from the last read.","minimum":0,"type":"integer"}},"required":["version"],"type":"object"},"NginxDiagnostic":{"additionalProperties":true,"description":"One problem or warning found in the rules.","properties":{"code":{"description":"A stable code for the problem, such as `root_outside_webroot`.","type":"string"},"column":{"type":["integer","null"]},"field":{"description":"For a path app, the field, such as `php.entries.1`.","type":["string","null"]},"hook":{"description":"The part of the rules it is in, such as `server`.","type":["string","null"]},"line":{"type":["integer","null"]},"message":{"type":"string"},"record":{"description":"For a path app, the id of the record. `hook` is then `path_apps`.","type":["string","null"]},"severity":{"description":"`error` refuses a save; anything else is a warning.","type":"string"},"source":{"description":"What found it, such as `policy`.","type":"string"}},"required":["severity","code","message"],"type":"object"},"NginxDrift":{"additionalProperties":true,"properties":{"committed_diagnostics":{"items":{"$ref":"#/components/schemas/NginxDiagnostic"},"type":"array"},"committed_valid":{"description":"Whether the changed rules pass the policy, so that they can be taken as your saved rules.","type":"boolean"},"diff":{"additionalProperties":true,"description":"A unified diff per hook, from your saved rules to the changed ones. Null where a hook agrees.","properties":{"headers":{"type":["string","null"]},"http":{"type":["string","null"]},"php":{"type":["string","null"]},"server":{"type":["string","null"]}},"required":["server","headers","php","http"],"type":"object"},"hooks":{"description":"The hooks that differ.","items":{"type":"string"},"type":"array"},"since":{"type":["string","null"]}},"required":["since","hooks","diff","committed_valid","committed_diagnostics"],"type":"object"},"NginxDriftAnswer":{"additionalProperties":false,"properties":{"action":{"description":"`committed` takes the changed rules as your saved rules; `panel` keeps your saved rules.","enum":["committed","panel"],"type":"string"},"version":{"description":"The `version` from the last read.","minimum":0,"type":"integer"}},"required":["version","action"],"type":"object"},"NginxExplainRequest":{"additionalProperties":true,"properties":{"content":{"anyOf":[{"$ref":"#/components/schemas/NginxHooksContent"},{"type":"string"},{"type":"null"}],"description":"Unsaved hooks to explain instead of the saved ones, or the server hook's text on its own."},"host":{"description":"One of the site's hostnames. Its main one when left out.","type":["string","null"]},"path":{"description":"A path on the site, such as `/media/catalog/product/a.jpg`.","type":"string"},"path_apps":{"description":"An unsaved list of path apps to explain instead of the saved one. Only while path apps are on for your company.","items":{"$ref":"#/components/schemas/NginxPathAppInput"},"type":["array","null"]}},"required":["path"],"type":"object"},"NginxExplanation":{"additionalProperties":true,"properties":{"block":{"additionalProperties":true,"description":"The server block that takes the request.","properties":{"file":{"type":"string"},"line":{"type":"integer"},"server_name":{"type":"string"}},"required":["server_name","file","line"],"type":"object"},"locations":{"description":"The locations that were considered.","items":{"additionalProperties":true,"properties":{"file":{"type":"string"},"hook":{"type":["string","null"]},"line":{"type":"integer"},"match":{"description":"`exact`, `prefix`, `^~` or `regex`.","type":"string"},"nested":{"type":"boolean"},"pattern":{"type":"string"},"record":{"description":"Sent when `source` is `path_app`, the rule of a path app or gate: its id, such as `a1`.","type":["string","null"]},"source":{"description":"Whose rule it is: the platform's, a redirect's or your own.","enum":["platform","redirects","path_app","custom"],"type":"string"}},"type":"object"},"type":"array"},"notes":{"items":{},"type":"array"},"outcome":{"additionalProperties":true,"properties":{"detail":{"description":"What answers, in plain words.","type":"string"},"guard":{"description":"For `blocked`: the protection that answered.","type":"string"},"kind":{"enum":["static","php","redirect","denied","returned","blocked"],"type":"string"}},"required":["kind","detail"],"type":"object"},"server_steps":{"description":"What runs before a location is chosen, in order.","items":{"additionalProperties":true,"type":"object"},"type":"array"},"try_files_branches":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"winner":{"description":"The position in `locations` of the one that answers, starting at 0. Null when none does.","type":["integer","null"]}},"required":["block","server_steps","locations","winner","try_files_branches","outcome","notes"],"type":"object"},"NginxHooksContent":{"additionalProperties":false,"description":"The text of each hook sent. `server` goes inside the site's `server` block (locations, `return`, `rewrite`), `headers` sets response headers for every page, `php` holds settings for PHP requests and `http` sits at the `http` level, for example a `map`.","properties":{"headers":{"type":["string","null"]},"http":{"type":["string","null"]},"php":{"type":["string","null"]},"server":{"type":["string","null"]}},"type":"object"},"NginxHtaccessConversion":{"additionalProperties":true,"properties":{"ai":{"additionalProperties":true,"description":"The AI model's suggestions for the lines the fixed conversion could not handle.","properties":{"error":{"type":["string","null"]},"hooks":{"additionalProperties":{"type":["string","null"]},"description":"The AI's suggested rules, per hook. Null when it made none.","type":["object","null"]},"lines":{"description":"How many lines were sent.","type":"integer"},"notes":{"items":{},"type":"array"},"status":{"enum":["not_needed","running","done","failed","disabled"],"type":"string"},"unconverted":{"items":{},"type":"array"}},"required":["lines","status"],"type":"object"},"converted":{"description":"The lines that were converted, with what they became.","items":{"additionalProperties":true,"type":"object"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"expires_at":{"description":"When the conversion can no longer be read.","format":"date-time","type":"string"},"handled":{"description":"Lines that need no rule, each with why.","items":{"$ref":"#/components/schemas/NginxHtaccessLine"},"type":"array"},"hooks":{"additionalProperties":{"type":"string"},"description":"The Nginx rules, per hook.","type":"object"},"id":{"type":"string"},"platform":{"type":"string"},"pointers":{"description":"Lines that belong in another part of the Control Panel.","items":{"additionalProperties":true,"type":"object"},"type":"array"},"redirects":{"additionalProperties":true,"description":"The redirect lines, to import into the site's redirects.","properties":{"content":{"type":"string"},"count":{"type":"integer"},"format":{"type":"string"},"lines":{"items":{"type":"integer"},"type":"array"}},"type":"object"},"unconverted":{"description":"Lines that could not be converted, each with why.","items":{"$ref":"#/components/schemas/NginxHtaccessLine"},"type":"array"}},"required":["id","platform","hooks","converted","redirects","handled","pointers","unconverted","ai","created_at","expires_at"],"type":"object"},"NginxHtaccessConvert":{"properties":{"content":{"description":"The `.htaccess` text, at most 256 KB.","type":"string"}},"required":["content"],"type":"object"},"NginxHtaccessLine":{"additionalProperties":true,"properties":{"line":{"type":"integer"},"lines":{"items":{"type":"integer"},"type":"array"},"reason":{"type":"string"},"text":{"type":"string"}},"required":["line","text","reason"],"type":"object"},"NginxPathApp":{"allOf":[{"$ref":"#/components/schemas/NginxPathAppInput"},{"required":["id","preset","label"],"type":"object"}],"description":"One saved path app or gate, as it is stored. Every field its `type` takes is present with its value or its default, except `links` and `rate`, which are left out when there are none."},"NginxPathAppInput":{"additionalProperties":true,"allOf":[{"if":{"properties":{"type":{"const":"php-app"}},"required":["type"]},"then":{"properties":{"proxy":false},"required":["root","php"]}},{"if":{"properties":{"type":{"const":"static"}},"required":["type"]},"then":{"properties":{"limits":false,"php":false,"proxy":false,"static":{"properties":{"types":{"minItems":1}}}},"required":["root"]}},{"if":{"properties":{"type":{"const":"proxy"}},"required":["type"]},"then":{"properties":{"limits":false,"links":false,"php":false,"root":false,"static":false},"required":["proxy"]}},{"if":{"properties":{"type":{"const":"gate"}},"required":["type"]},"then":{"properties":{"ips":{"minItems":1},"limits":false,"links":false,"php":false,"proxy":false,"rate":false,"root":false,"static":false},"required":["ips"]}},{"if":{"properties":{"type":{"const":"deny"}},"required":["type"]},"then":{"properties":{"hosts":false,"ips":false,"limits":false,"links":false,"methods":false,"php":false,"proxy":false,"rate":false,"root":false,"static":false}}}],"description":"One path app or gate. Send only the fields its `type` takes: a field the type does not take is refused. A PHP app needs `root` and `php.entries`, a static folder `root`, another site (`proxy`) `proxy.url`, and a gate at least one address in `ips`.","properties":{"hosts":{"description":"Some of the site's hostnames. Empty means all of them.","items":{"type":"string"},"maxItems":16,"type":"array"},"id":{"description":"`a1`, `a2` and so on for a PHP app, static folder, other site or closed path; `g1`, `g2` and so on for a gate. Keep it when you change a record. A new record may leave it out: it is given the next free number.","pattern":"^[ag][1-9][0-9]{0,2}$","type":"string"},"ips":{"description":"Addresses or networks admitted, up to 64. A gate needs at least one. A network of /8 or wider, an address in a special-purpose range (the documentation ranges among them) and the platform's own ranges are refused.","items":{"type":"string"},"maxItems":64,"type":"array"},"label":{"default":"","description":"A note. Empty when left out. Null is refused.","maxLength":80,"type":"string"},"limits":{"additionalProperties":false,"description":"For a PHP app.","properties":{"body_size_mb":{"default":null,"description":"The largest request body in MB, at most the site's upload size. Null, the default, leaves the site's own limit in force.","minimum":1,"type":["integer","null"]},"timeout":{"default":300,"description":"The PHP time limit in seconds.","maximum":300,"minimum":30,"type":"integer"}},"type":"object"},"links":{"description":"For a PHP app or static folder on a folder path: up to 4 folders of the path app that are served from the site's shared folder, such as its uploads. Left out of a saved record when there are none.","items":{"additionalProperties":false,"properties":{"path":{"description":"A folder of the path app, relative to its path and ending in `/`, such as `wp-content/uploads/`. Two links cannot share a folder or lie inside one another, and PHP never runs under a link.","type":"string"},"target":{"description":"A folder below the site's shared folder that holds only public files, such as `shared/wp-content/uploads` on WordPress, with no trailing `/`. Refused: `shared` itself, a hidden folder (a name that starts with `.`), and a folder that is, is inside or contains one where the platform keeps code, logs or secrets, such as `shared/logs` or `shared/vendor`. The list differs per platform; on WordPress `shared/wp-content/uploads` and the folders below it are allowed although the rest of `shared/wp-content` is not.","pattern":"^shared(/[A-Za-z0-9_~-][A-Za-z0-9._~-]{0,63}){1,8}$","type":"string"}},"required":["path","target"],"type":"object"},"maxItems":4,"type":"array"},"methods":{"description":"The request methods admitted. `GET`, `HEAD` and `POST` when left out.","items":{"enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS"],"type":"string"},"minItems":1,"type":"array"},"php":{"additionalProperties":false,"description":"For a PHP app, which needs it.","properties":{"dir_index":{"description":"Up to 8 folders whose `index.php` answers the folder, such as `wp-admin/`.","items":{"type":"string"},"maxItems":8,"type":"array"},"entries":{"description":"1 to 32 PHP files that may run, relative to the path, such as `wp-login.php` or `wp-admin/*.php`. Every other PHP file under the path answers 404.","items":{"type":"string"},"maxItems":32,"minItems":1,"type":"array"},"router":{"description":"Up to 4 folders passed to the app's `index.php`, such as `wp-json/`, or `/` for the whole app.","items":{"type":"string"},"maxItems":4,"type":"array"}},"required":["entries"],"type":"object"},"prefix":{"description":"The path, such as `/wp/`. A PHP app or a gate can also name one file, and a gate `/` with `hosts`.","type":"string"},"preset":{"description":"The preset the record started from.","type":["string","null"]},"proxy":{"additionalProperties":false,"description":"For another site on the path, which needs it.","properties":{"connect_timeout":{"default":5,"maximum":30,"minimum":1,"type":"integer"},"host_header":{"default":"target","description":"`target` (the other site's own name), `visitor` (the name the visitor used) or another host name.","type":"string"},"path":{"default":"keep","description":"`keep` sends the path as it is; `strip` leaves your path out.","enum":["keep","strip"],"type":"string"},"read_timeout":{"default":60,"maximum":300,"minimum":5,"type":"integer"},"share_cookies":{"default":false,"description":"True sends your visitors' cookies and logins to the other site and lets it set cookies here.","type":"boolean"},"url":{"description":"The other site: `https://`, a host name and optionally a port and a folder.","maxLength":255,"type":"string"}},"required":["url"],"type":"object"},"rate":{"additionalProperties":false,"description":"A rate limit per visitor, for a PHP app, a static folder or another site. Send both fields, or leave `rate` out (or send null) for no limit. Left out of a saved record that has none.","properties":{"burst":{"maximum":1000,"minimum":0,"type":"integer"},"per_second":{"maximum":1000,"minimum":1,"type":"integer"}},"required":["per_second","burst"],"type":["object","null"]},"root":{"description":"For a PHP app or static folder: `htdocs` or `shared`, optionally with sub-folders.","type":"string"},"static":{"additionalProperties":false,"description":"For a PHP app or static folder.","properties":{"types":{"description":"Lower-case file extensions served from disk, up to 32. The policy's default list when left out. A static folder serves at least one.","items":{"type":"string"},"maxItems":32,"type":"array"}},"type":"object"},"type":{"description":"A PHP app, a static folder, another site shown on the path (`proxy`), a closed path (`deny`) or a gate that admits only listed addresses.","enum":["php-app","static","proxy","deny","gate"],"type":"string"}},"required":["type","prefix"],"type":"object"},"NginxPathApps":{"additionalProperties":true,"description":"The site's path apps and gates. Present while path apps are on for your company. A revision that changed them names `path_apps` in its `hooks_changed` and carries the list in its `content`, and restoring a revision restores its path apps too.","properties":{"available":{"description":"Whether the site can use path apps yet.","type":"boolean"},"hosts":{"description":"The site's hostnames, which a record can be limited to.","items":{"type":"string"},"type":"array"},"items":{"items":{"$ref":"#/components/schemas/NginxPathApp"},"type":"array"},"presets":{"description":"Ready-made records for the site's platform.","items":{"additionalProperties":true,"type":"object"},"type":"array"},"primary_host":{"type":["string","null"]},"proxy_available":{"description":"Whether the site can show another site on a path yet.","type":"boolean"},"rate_default":{"additionalProperties":true,"description":"The rate limit the editor fills in on a new record. The API never adds one for you.","properties":{"burst":{"type":"integer"},"per_second":{"type":"integer"}},"type":"object"},"rendered":{"description":"With `include=rendered`: the Nginx text written for the path apps. Null when there are none.","oneOf":[{"$ref":"#/components/schemas/NginxPathAppsRendered"},{"type":"null"}]}},"required":["available","proxy_available","rate_default","items","presets","hosts","primary_host"],"type":"object"},"NginxPathAppsRendered":{"additionalProperties":true,"properties":{"back":{"type":"string"},"front":{"type":"string"}},"type":"object"},"NginxPolicy":{"additionalProperties":true,"properties":{"directives":{"description":"The directives that may be used.","items":{"additionalProperties":true,"properties":{"args":{"description":"How many arguments it takes.","items":{"type":"string"},"type":"array"},"checks":{"items":{"type":"string"},"type":"array"},"contexts":{"description":"Where in a hook it may stand.","items":{"type":"string"},"type":"array"},"doc":{"type":["string","null"]},"hooks":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"prefix":{"type":"boolean"}},"required":["name","hooks","contexts"],"type":"object"},"type":"array"},"header_governed":{"description":"Response headers the platform sets (`fixed`), frames (`framing`) or governs (`governed`).","properties":{"fixed":{"items":{"type":"string"},"type":"array"},"framing":{"items":{"type":"string"},"type":"array"},"governed":{"items":{"type":"string"},"type":"array"}},"required":["fixed","framing","governed"],"type":"object"},"hooks":{"description":"The hooks the policy is for.","items":{"type":"string"},"type":"array"},"limits":{"additionalProperties":true,"description":"The limits the rules are held to.","properties":{"buffers_total_max":{"type":"integer"},"hook_file_bytes":{"type":"integer"},"keepalive":{"type":"integer"},"lines_warn":{"type":"integer"},"location_nesting":{"type":"integer"},"map_entries":{"type":"integer"},"max_lines":{"type":"integer"},"max_locations":{"type":"integer"},"max_regex":{"type":"integer"},"size_caps":{"additionalProperties":{"type":"integer"},"description":"The largest value each buffer directive may take, in bytes.","type":"object"},"verify_paths":{"type":"integer"},"zone_total_bytes":{"type":"integer"}},"required":["buffers_total_max","hook_file_bytes","keepalive","lines_warn","location_nesting","map_entries","max_lines","max_locations","max_regex","size_caps","verify_paths","zone_total_bytes"],"type":"object"},"path_apps":{"additionalProperties":true,"description":"What path apps may contain. Present while path apps are on for your company.","type":"object"},"platform_headers":{"items":{"additionalProperties":true,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"platforms":{"items":{"type":"string"},"type":"array"},"policy_version":{"type":"integer"},"rate_limit_presets":{"items":{},"type":"array"},"refused":{"description":"Directives that are refused, each with why.","items":{"additionalProperties":true,"properties":{"context":{"type":["string","null"]},"hook":{"type":["string","null"]},"message":{"type":"string"},"name":{"type":"string"},"reason":{"type":"string"}},"required":["name","reason","message"],"type":"object"},"type":"array"},"reserved_prefixes":{"description":"Name prefixes kept for the platform.","items":{"type":"string"},"type":"array"},"static_extensions":{"items":{"type":"string"},"type":"array"}},"required":["policy_version","platforms","hooks","directives","refused","limits"],"type":"object"},"NginxRevision":{"additionalProperties":true,"description":"One revision in the site's history.","properties":{"author":{"properties":{"client":{"description":"The connected app, for an AI assistant.","type":["string","null"]},"kind":{"description":"Who made it: a person, an AI assistant (`mcp_token`, `oauth`), Corefinity, or an automatic change.","enum":["user","mcp_token","oauth","corefinity","automatic"],"type":"string"},"name":{"type":"string"}},"required":["kind","name","client"],"type":"object"},"created_at":{"format":"date-time","type":["string","null"]},"errors_since":{"description":"Web server errors logged while it was live. Null when logs are not available.","type":["integer","null"]},"hooks_changed":{"description":"The parts this revision changed, by name, such as `server`.","items":{"type":"string"},"type":"array"},"id":{"minimum":1,"type":"integer"},"note":{"type":["string","null"]},"number":{"type":"integer"},"origin":{"description":"How the revision came about.","enum":["editor","revert","copy","env_create","move","clone","move_corefinity","repository_version","system_revert"],"type":"string"},"status":{"$ref":"#/components/schemas/NginxRevisionStatus"},"status_reason":{"type":["string","null"]}},"required":["id","number","created_at","author","origin","status","status_reason","note","hooks_changed","errors_since"],"type":"object"},"NginxRevisionDetail":{"properties":{"against":{"description":"The revision it is compared with.","properties":{"current":{"type":"boolean"},"id":{"type":["integer","null"]}},"required":["id","current"],"type":"object"},"diff":{"additionalProperties":{"type":["string","null"]},"description":"A unified diff per hook. Null where a hook agrees.","type":"object"},"revision":{"allOf":[{"$ref":"#/components/schemas/NginxRevision"},{"properties":{"content":{"additionalProperties":true,"description":"The text of each part the revision holds, by name.","type":"object"}},"required":["content"],"type":"object"}]}},"required":["revision","against","diff"],"type":"object"},"NginxRevisionErrors":{"properties":{"available":{"type":"boolean"},"count":{"description":"Every error line in the range, also when more than 50.","type":"integer"},"from":{"description":"The start of the range: when the revision went live, or the oldest log kept.","type":"string"},"lines":{"items":{"properties":{"at":{"format":"date-time","type":["string","null"]},"level":{"type":"string"},"message":{"type":"string"}},"required":["at","level","message"],"type":"object"},"maxItems":50,"type":"array"},"reason":{"description":"When `available` is false: `never_live`, `logs_not_collected`, `logs_unavailable` or another reason the logs give.","type":"string"},"to":{"description":"When the next revision went live. Null for the live one.","type":["string","null"]}},"required":["available"],"type":"object"},"NginxRevisionPage":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/NginxRevision"},"type":"array"}},"required":["data"],"type":"object"}]},"NginxRevisionRef":{"properties":{"id":{"minimum":1,"type":"integer"},"number":{"description":"The revision's number in the site's history, starting at 1.","type":"integer"},"status":{"$ref":"#/components/schemas/NginxRevisionStatus"}},"required":["id","number","status"],"type":"object"},"NginxRevisionRevert":{"additionalProperties":false,"properties":{"apply":{"allOf":[{"$ref":"#/components/schemas/ApplyChoice"}],"description":"When the change applies, if it needs a one-time update of the site's runtime first. Most changes apply at once whatever is sent."},"note":{"description":"Why, shown in the history. \"Restored revision\" and its number when left out.","maxLength":200,"type":["string","null"]},"test_id":{"description":"A passed test run of the same content, from a check, so it is not run again.","minimum":1,"type":"integer"},"version":{"description":"The `version` from the last read.","minimum":0,"type":"integer"}},"required":["version"],"type":"object"},"NginxRevisionStatus":{"description":"Where a revision stands: `saving` while it is being applied, `pending_verify` until it has been checked, `applied` when live, `superseded` once a later one is, `rejected`, `verify_failed` or `rolled_back` when it failed and the rules before it were put back, `not_committed` when it was never saved, `saved_dormant` when saved and waiting for a runtime update.","enum":["saving","pending_verify","applied","rejected","verify_failed","rolled_back","superseded","not_committed","saved_dormant"],"type":"string"},"NginxRules":{"additionalProperties":true,"description":"A site's Nginx rules and their state.","properties":{"adopted":{"description":"Whether the site's runtime has had the one-time update that the `headers`, `php` and `http` hooks need.","type":"boolean"},"adoption":{"additionalProperties":true,"description":"Where that update stands, and whether a save can make it now or in the next window.","properties":{"adopt_now_refusal":{"description":"Why a save cannot make it now. Null when it can."},"adopted":{"description":"Whether the site has taken the update.","type":"boolean"},"can_adopt_now":{"description":"Whether a save can make the update at once.","type":"boolean"},"can_adopt_tonight":{"description":"Whether a save can queue the update for the next window.","type":"boolean"},"in_progress":{"type":"boolean"},"planned_for":{"type":["string","null"]},"queued_for":{"description":"The night the update waits for, when it is queued.","type":["string","null"]},"revision":{"description":"The revision that made the update, once there is one."}},"required":["adopted","in_progress","can_adopt_now","can_adopt_tonight"],"type":"object"},"backup_guard":{"allOf":[{"$ref":"#/components/schemas/NginxBackupGuard"}],"description":"Corefinity's backup-file rule. Present while the rule is offered for the site."},"corefinity_rules":{"description":"The rules Corefinity set up for the site, read only, with the blocks that can move into yours. Null when there are none to read.","oneOf":[{"additionalProperties":true,"properties":{"blocks":{"items":{"additionalProperties":true,"properties":{"from_line":{"description":"The block's first line. A move names a block by it.","type":"integer"},"movable":{"type":"boolean"},"to_line":{"type":"integer"}},"type":"object"},"type":"array"},"content":{"type":"string"}},"type":"object"},{"type":"null"}]},"drift":{"description":"A change to the rules made outside the Control Panel, to answer. Null when there is none.","oneOf":[{"$ref":"#/components/schemas/NginxDrift"},{"type":"null"}]},"hooks":{"additionalProperties":true,"description":"The four hooks.","properties":{"headers":{"properties":{"available":{"description":"Whether the site can use this hook yet. `headers`, `php` and `http` need a one-time update of the site's runtime first.","type":"boolean"},"available_after":{"description":"Present while the hook is not available: whether that update is `not_scheduled`, `scheduled` (with its `date`) or `in_progress`.","properties":{"date":{"type":["string","null"]},"state":{"enum":["not_scheduled","scheduled","in_progress"],"type":"string"}},"required":["state","date"],"type":"object"},"content":{"description":"The hook's text. Null when empty.","type":["string","null"]}},"required":["content","available"],"type":"object"},"http":{"properties":{"available":{"description":"Whether the site can use this hook yet. `headers`, `php` and `http` need a one-time update of the site's runtime first.","type":"boolean"},"available_after":{"description":"Present while the hook is not available: whether that update is `not_scheduled`, `scheduled` (with its `date`) or `in_progress`.","properties":{"date":{"type":["string","null"]},"state":{"enum":["not_scheduled","scheduled","in_progress"],"type":"string"}},"required":["state","date"],"type":"object"},"content":{"description":"The hook's text. Null when empty.","type":["string","null"]}},"required":["content","available"],"type":"object"},"php":{"properties":{"available":{"description":"Whether the site can use this hook yet. `headers`, `php` and `http` need a one-time update of the site's runtime first.","type":"boolean"},"available_after":{"description":"Present while the hook is not available: whether that update is `not_scheduled`, `scheduled` (with its `date`) or `in_progress`.","properties":{"date":{"type":["string","null"]},"state":{"enum":["not_scheduled","scheduled","in_progress"],"type":"string"}},"required":["state","date"],"type":"object"},"content":{"description":"The hook's text. Null when empty.","type":["string","null"]}},"required":["content","available"],"type":"object"},"server":{"properties":{"available":{"description":"Whether the site can use this hook yet. `headers`, `php` and `http` need a one-time update of the site's runtime first.","type":"boolean"},"available_after":{"description":"Present while the hook is not available: whether that update is `not_scheduled`, `scheduled` (with its `date`) or `in_progress`.","properties":{"date":{"type":["string","null"]},"state":{"enum":["not_scheduled","scheduled","in_progress"],"type":"string"}},"required":["state","date"],"type":"object"},"content":{"description":"The hook's text. Null when empty.","type":["string","null"]}},"required":["content","available"],"type":"object"}},"required":["server","headers","php","http"],"type":"object"},"limits":{"additionalProperties":true,"description":"The limits of a hook, and how much of each the saved hooks use.","properties":{"max_bytes":{"type":"integer"},"max_lines":{"type":"integer"},"max_locations":{"type":"integer"},"used":{"additionalProperties":true,"description":"Per hook; null for an empty hook.","properties":{"headers":{"oneOf":[{"properties":{"bytes":{"type":"integer"},"lines":{"type":"integer"},"locations":{"type":"integer"}},"required":["bytes","locations","lines"],"type":"object"},{"type":"null"}]},"http":{"oneOf":[{"properties":{"bytes":{"type":"integer"},"lines":{"type":"integer"},"locations":{"type":"integer"}},"required":["bytes","locations","lines"],"type":"object"},{"type":"null"}]},"php":{"oneOf":[{"properties":{"bytes":{"type":"integer"},"lines":{"type":"integer"},"locations":{"type":"integer"}},"required":["bytes","locations","lines"],"type":"object"},{"type":"null"}]},"server":{"oneOf":[{"properties":{"bytes":{"type":"integer"},"lines":{"type":"integer"},"locations":{"type":"integer"}},"required":["bytes","locations","lines"],"type":"object"},{"type":"null"}]}},"required":["server","headers","php","http"],"type":"object"},"warn_lines":{"type":"integer"}},"required":["max_bytes","max_locations","warn_lines","max_lines","used"],"type":"object"},"locked":{"description":"Set when Corefinity manages the site's Nginx rules for you: changes are refused `nginx_rules_locked`. Null otherwise.","oneOf":[{"additionalProperties":true,"properties":{"kind":{"type":"string"},"since":{"type":"string"}},"required":["kind","since"],"type":"object"},{"type":"null"}]},"path_apps":{"$ref":"#/components/schemas/NginxPathApps"},"platform":{"type":"string"},"policy_version":{"type":"integer"},"revision":{"description":"The saved revision. Null before the first save.","oneOf":[{"$ref":"#/components/schemas/NginxRevision"},{"type":"null"}]},"site_id":{"minimum":1,"type":"integer"},"status":{"description":"Whether the saved rules are live.","properties":{"applied_revision_id":{"description":"The revision that is live.","type":["integer","null"]},"error":{"description":"Why the last change failed. Null otherwise.","oneOf":[{"properties":{"code":{"type":["string","null"]},"column":{"type":["integer","null"]},"hook":{"type":["string","null"]},"line":{"type":["integer","null"]},"message":{"type":"string"}},"required":["hook","line","column","code","message"],"type":"object"},{"type":"null"}]},"operation_id":{"description":"The change that is running, to follow.","type":["integer","null"]},"pending_reason":{"type":["string","null"]},"revert":{"description":"The automatic return to the rules before a failed change: `running` or `failed`. Null otherwise.","oneOf":[{"properties":{"revision_id":{"type":["integer","null"]},"state":{"enum":["running","failed"],"type":"string"}},"required":["state","revision_id"],"type":"object"},{"type":"null"}]},"revision_id":{"type":["integer","null"]},"state":{"description":"`never` before the first save, `applying` while a change runs, `live`, `pending_verify`, or how the last change ended.","enum":["never","applying","live","pending_verify","rejected","verify_failed","rolled_back"],"type":"string"}},"required":["state","pending_reason","revision_id","applied_revision_id","operation_id","error","revert"],"type":"object"},"verify_paths":{"items":{"$ref":"#/components/schemas/NginxVerifyPath"},"type":"array"},"version":{"description":"Send it back with every change. It moves each time the rules or the verify paths change.","type":"integer"}},"required":["site_id","version","platform","hooks","status","revision","drift","verify_paths","limits","policy_version","adopted","adoption","corefinity_rules","locked"],"type":"object"},"NginxRulesCheck":{"additionalProperties":false,"anyOf":[{"required":["content"]},{"description":"While path apps are on for your company, a list in `path_apps` may be sent instead of `content`.","properties":{"path_apps":{"type":"array"}},"required":["path_apps"]}],"description":"The rules to check instead of the saved ones. `content` is needed, though it may be `{}`, which checks the saved hooks.","properties":{"content":{"$ref":"#/components/schemas/NginxHooksContent"},"path_apps":{"description":"A list of path apps to check instead of the saved one; it may be sent without `content`. Only while path apps are on for your company.","items":{"$ref":"#/components/schemas/NginxPathAppInput"},"type":["array","null"]},"render":{"default":false,"description":"True adds `path_apps_rendered` to the answer. Only while path apps are on for your company.","type":"boolean"},"sandbox":{"default":true,"description":"False checks against the policy only and skips the test on the site's own Nginx.","type":"boolean"}},"type":"object"},"NginxRulesCopy":{"additionalProperties":false,"anyOf":[{"required":["version"]},{"properties":{"dry_run":{"const":true}},"required":["dry_run"]}],"description":"A copy needs the `version`; only a preview (`dry_run` sent as true) is taken without it.","properties":{"apply":{"allOf":[{"$ref":"#/components/schemas/ApplyChoice"}],"description":"When the change applies, if it needs a one-time update of the site's runtime first. Most changes apply at once whatever is sent."},"confirm_production":{"description":"Must be true to copy onto a production environment.","type":"boolean"},"dry_run":{"default":false,"description":"True previews the copy and saves nothing.","type":"boolean"},"from_site_id":{"description":"The id of the environment to copy from: another environment of the same website.","minimum":1,"type":"integer"},"hooks":{"allOf":[{"items":{"enum":["server","headers","php","http","path_apps"],"type":"string"},"minItems":1,"type":"array"},{"description":"While path apps are on for your company, `hooks` left out copies the four hooks and the path apps too. Copying `path_apps` replaces this environment's whole list of path apps and gates with the other environment's, so an empty list there removes every one here. Send `[server, headers, php, http]` to copy the hooks and keep this environment's own path apps."}],"description":"The parts to copy. Left out, every part is copied."},"note":{"description":"Why, shown in the history.","maxLength":200,"type":["string","null"]},"test_id":{"description":"A passed test run of the same content, from a check, so it is not run again.","minimum":1,"type":"integer"},"version":{"description":"The `version` from the last read of this environment. Required unless `dry_run` is true.","minimum":0,"type":"integer"}},"required":["from_site_id"],"type":"object"},"NginxRulesUpdate":{"additionalProperties":false,"anyOf":[{"required":["content"]},{"required":["verify_paths"]},{"description":"While path apps are on for your company, a list in `path_apps` may be sent without `content` and `verify_paths`.","properties":{"path_apps":{"type":"array"}},"required":["path_apps"]}],"description":"Send `content`, `verify_paths` or both with the `version`. A save with neither is refused.","properties":{"apply":{"allOf":[{"$ref":"#/components/schemas/ApplyChoice"}],"description":"When the change applies, if it needs a one-time update of the site's runtime first. Most changes apply at once whatever is sent."},"content":{"$ref":"#/components/schemas/NginxHooksContent"},"note":{"description":"Why, shown in the history.","maxLength":200,"type":["string","null"]},"path_apps":{"description":"The whole list of path apps and gates: `[]` removes every one, and leaving it out or sending null keeps the saved list. It may be sent without `content`. A list whose labels alone changed answers a `revision` with `operation: null`. Refused `invalid` while path apps are not on for your company.","items":{"$ref":"#/components/schemas/NginxPathAppInput"},"type":["array","null"]},"test_id":{"description":"A passed test run of the same content, from a check, so it is not run again.","minimum":1,"type":"integer"},"verify_paths":{"description":"Replaces the list of paths checked after every change. Sent on its own, only this list is saved.","items":{"$ref":"#/components/schemas/NginxVerifyPathInput"},"maxItems":5,"type":"array"},"version":{"description":"The `version` from the last read.","minimum":0,"type":"integer"}},"required":["version"],"type":"object"},"NginxSaveResult":{"additionalProperties":true,"description":"What a change answers.","properties":{"item_id":{"description":"The id of the queued change.","type":["integer","null"]},"operation":{"description":"The change to follow. Null when nothing was started.","oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"path_app_warnings":{"description":"On a copy that carried path apps: the records that were not carried (`path_app_not_carried`).","items":{"additionalProperties":true,"type":"object"},"type":"array"},"queued":{"const":true,"description":"Present when the change waits for a window.","type":"boolean"},"revision":{"description":"The new revision. Null when there is none.","oneOf":[{"$ref":"#/components/schemas/NginxRevisionRef"},{"type":"null"}]},"window":{"description":"The window a queued change waits for. Present only while maintenance windows are on for your company.","oneOf":[{"$ref":"#/components/schemas/QueuedWindow"},{"type":"null"}]},"window_date":{"description":"The date of the window a queued change waits for.","type":["string","null"]}},"required":["operation","revision"],"type":"object"},"NginxSnippet":{"additionalProperties":true,"properties":{"available":{"description":"Whether the site can use the snippet now.","type":"boolean"},"category":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"needs":{"description":"What the site lacks while the snippet is not available.","items":{},"type":"array"},"parts":{"description":"The text to insert, with the hook each part belongs in.","items":{"additionalProperties":true,"properties":{"content":{"description":"A value to fill in is written `{{name}}`.","type":"string"},"hook":{"type":"string"},"placement":{"type":"string"}},"required":["hook","content"],"type":"object"},"type":"array"},"placeholders":{"description":"The values to fill in.","items":{"additionalProperties":true,"properties":{"default":{},"kind":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"validate":{"description":"A regular expression the value must match.","type":["string","null"]}},"required":["name","label"],"type":"object"},"type":"array"},"platforms":{"items":{"type":"string"},"type":"array"},"requires":{"items":{},"type":"array"},"title":{"type":"string"}},"required":["id","title","description","category","platforms","parts","placeholders","available"],"type":"object"},"NginxTestRun":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/NginxDiagnostic"},"type":"array"},"duration_ms":{"type":["integer","null"]},"finished_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"output":{"description":"What the site's Nginx said.","type":["string","null"]},"reason":{"type":["string","null"]},"started_at":{"format":"date-time","type":["string","null"]},"status":{"$ref":"#/components/schemas/NginxTestStatus"}},"required":["id","status","diagnostics","output","reason","started_at","finished_at","duration_ms"],"type":"object"},"NginxTestStatus":{"description":"`passed` or `failed` is the test's result. `unavailable`, `timed_out` and `error` mean the test could not be run; a save then relies on the checks after it.","enum":["queued","running","passed","failed","unavailable","timed_out","error"],"type":"string"},"NginxVerifyPath":{"description":"A path checked after every change.","properties":{"expect":{"default":"<500","description":"The answer expected: an exact status such as `403`, a class such as `2xx`, or `<500`.","type":"string"},"path":{"description":"A path on the site, starting with `/`.","type":"string"}},"required":["path","expect"],"type":"object"},"NginxVerifyPathInput":{"properties":{"expect":{"default":"<500","description":"The answer expected: an exact status such as `403`, a class such as `2xx`, or `<500`.","type":"string"},"path":{"description":"A path on the site, starting with `/`.","type":"string"}},"required":["path"],"type":"object"},"NginxVerifyPathsResult":{"properties":{"verify_paths":{"items":{"$ref":"#/components/schemas/NginxVerifyPath"},"type":"array"},"version":{"type":"integer"}},"required":["version","verify_paths"],"type":"object"},"NotFoundRefusal":{"description":"The 404 of the endpoints that name it `not_found`. It is the same for an id that does not exist and one you cannot see.","properties":{"code":{"const":"not_found","type":"string"},"field":{"type":"null"},"message":{"type":"string"},"reason":{"const":"not_found","type":"string"}},"required":["message","reason","field","code"],"type":"object"},"Operation":{"additionalProperties":true,"description":"A change the Control Panel is making or has made. A save or an action that starts work answers one in\n`operation`; read it again by `id` with `GET /corestack/operations/{operation}` until `status` is `completed`\nor `failed`. Both answers have this shape; the few endpoints that answer a different one say so.\n","properties":{"applied_at":{"type":["string","null"]},"can_retry":{"type":["boolean","null"]},"cluster":{"description":"The cluster the operation runs on.","oneOf":[{"$ref":"#/components/schemas/ClusterRef"},{"type":"null"}]},"committed_at":{"type":["string","null"]},"completed_at":{"type":["string","null"]},"created_at":{"type":["string","null"]},"environment":{"oneOf":[{"$ref":"#/components/schemas/EnvironmentRef"},{"type":"null"}]},"error":{"description":"Why the operation failed, in plain words. Null unless `status` is `failed`.","type":["string","null"]},"failure_reason":{"description":"A stable code for the failure.","type":["string","null"]},"from_version":{"type":["string","null"]},"hot":{"description":"True when the change applies without a maintenance window.","type":["boolean","null"]},"id":{"type":"integer"},"install":{"type":["object","null"]},"label":{"type":["string","null"]},"notes":{"description":"What the operation did differently on purpose. Empty when nothing.","items":{"properties":{"code":{"type":"string"},"text":{"type":"string"}},"required":["code","text"],"type":"object"},"type":"array"},"parent_operation_id":{"type":["integer","null"]},"requested_by":{"description":"Who asked for the change."},"reset_target":{"description":"Present on some site creations and copies."},"result":{"description":"Always null here. A one-time result is read once with the reveal endpoint."},"result_state":{"enum":["none","pending","available","viewed"],"type":"string"},"retried_by_operation_id":{"type":["integer","null"]},"retries_operation_id":{"type":["integer","null"]},"retry_requires":{"description":"What a retry needs first, if anything."},"revealed":{"description":"Who revealed a one-time result and when, when there was one."},"scope":{"enum":["site","cluster","batch"],"type":"string"},"site":{"description":"The website the operation belongs to. Null for a cluster's own operation.","oneOf":[{"$ref":"#/components/schemas/SiteRef"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/OperationStatus"},"status_label":{"type":"string"},"step":{"description":"The key of the step the operation is at. Null once it has completed.","type":["string","null"]},"steps":{"items":{"$ref":"#/components/schemas/OperationStep"},"type":"array"},"subject":{"type":["object","null"]},"summary":{"type":["string","null"]},"to_version":{"type":["string","null"]},"type":{"description":"The kind of change, such as `crons_change` or `redirects_change`.","type":"string"},"type_label":{"type":"string"}},"required":["id","type","type_label","scope","status","status_label","steps","error","created_at","completed_at"],"type":"object"},"OperationCopySafetySnapshot":{"properties":{"safety_snapshot_id":{"description":"The id of the snapshot a copy took of its target before replacing it; null when it took none. Sent only\nfor a copy onto an existing environment, while fast copies onto existing environments are on.\n","minimum":1,"type":["integer","null"]}},"type":"object"},"OperationRead":{"allOf":[{"$ref":"#/components/schemas/Operation"},{"properties":{},"type":"object"},{"$ref":"#/components/schemas/OperationCopySafetySnapshot"}],"description":"An operation, with what the API adds for a copy."},"OperationRetryRequest":{"properties":{"acknowledge_env":{"description":"Send true once you have checked that the site's live `.env` file is the one to continue from. Needed only\nwhen the operation failed because that file changed under it (`failure_reason` is `env_drift`).\n","type":"boolean"}},"type":"object"},"OperationReveal":{"properties":{"credentials":{"properties":{"admin":{"properties":{"password":{"type":"string"},"url":{"type":"string"},"username":{"type":"string"}},"required":["url","username","password"],"type":"object"},"note":{"type":"string"},"revealed_at":{"description":"When the login was shown, in UTC, written with `+00:00`.","format":"date-time","type":"string"}},"required":["admin","revealed_at","note"],"type":"object"},"remaining":{"description":"How many more times the login can be shown. Always 0.","type":"integer"},"revealed_at":{"format":"date-time","type":["string","null"]}},"required":["credentials","revealed_at","remaining"],"type":"object"},"OperationStarted":{"properties":{"operation":{"$ref":"#/components/schemas/Operation"}},"required":["operation"],"type":"object"},"OperationStatus":{"description":"Where a change is. `completed` and `failed` are final; every other status means the change is still running and\nblocks another change to the same site.\n","enum":["pending","committed","rolling_out","executing","completed","failed"],"type":"string"},"OperationStep":{"additionalProperties":true,"description":"One step of an operation.","properties":{"key":{"type":"string"},"label":{"type":"string"},"state":{"description":"One of `done`, `current`, `todo`, `failed` or `skipped`.","type":"string"}},"type":"object"},"OperationSummary":{"additionalProperties":true,"description":"The short form of an operation that other answers embed.","properties":{"id":{"type":"integer"},"scope":{"enum":["site","cluster","batch"],"type":"string"},"status":{"$ref":"#/components/schemas/OperationStatus"},"status_label":{"type":"string"},"summary":{"type":["string","null"]},"to_version":{"type":["string","null"]},"type":{"type":"string"},"type_label":{"type":"string"}},"required":["id","type","type_label","scope","status","status_label","summary","to_version"],"type":"object"},"OperationsPage":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"items":{"items":{"$ref":"#/components/schemas/Operation"},"type":"array"}},"required":["items"],"type":"object"}]},"OrderLinkAddonStep":{"properties":{"max":{"description":"The most the package takes.","type":"integer"},"step":{"description":"The increment the order page takes.","type":"integer"}},"required":["step","max"],"type":"object"},"OrderLinkAddons":{"additionalProperties":false,"description":"Upgrades on top of the package, in whole units. A kind that is left out is 0.","properties":{"cores":{"description":"Extra cores.","minimum":0,"type":"integer"},"disk_gb":{"description":"Extra disk, in GB.","minimum":0,"type":"integer"},"memory_gb":{"description":"Extra memory, in GB.","minimum":0,"type":"integer"}},"type":"object"},"OrderLinkPreview":{"properties":{"addon_steps":{"description":"The increment and ceiling of each upgrade for this package.","properties":{"cores":{"$ref":"#/components/schemas/OrderLinkAddonStep"},"disk_gb":{"$ref":"#/components/schemas/OrderLinkAddonStep"},"memory_gb":{"$ref":"#/components/schemas/OrderLinkAddonStep"}},"required":["cores","memory_gb","disk_gb"],"type":"object"},"quote":{"description":"What the order page's own summary shows before anything is saved.","properties":{"currency":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/OrderLinkQuoteLine"},"type":"array"},"subtotal_monthly":{"description":"The sum of the lines, a decimal number as text.","type":"string"},"vat":{"const":"excluded","description":"The prices exclude VAT.","type":"string"}},"required":["currency","lines","subtotal_monthly","vat"],"type":"object"},"spec":{"description":"The configuration as it was checked.","properties":{"addons":{"properties":{"cores":{"type":"integer"},"disk_gb":{"type":"integer"},"memory_gb":{"type":"integer"}},"required":["cores","memory_gb","disk_gb"],"type":"object"},"billing":{"enum":["monthly","annual"],"type":"string"},"compute_family":{"enum":["general","optimised"],"type":"string"},"currency":{"type":"string"},"package":{"type":"string"},"platform":{"description":"The platform of a CoreStack site; `null` for a CoreCluster.","type":["string","null"]},"product_line":{"description":"`cs` is CoreStack and `cc` is CoreCluster.","enum":["cs","cc"],"type":"string"},"region":{"type":"string"}},"required":["product_line","package","platform","region","currency","compute_family","addons","billing"],"type":"object"},"url":{"description":"The order page's address with every choice in `spec` already made. Choices left at their default are not written into it.","type":"string"}},"required":["url","spec","quote","addon_steps"],"type":"object"},"OrderLinkPreviewRequest":{"properties":{"addons":{"$ref":"#/components/schemas/OrderLinkAddons"},"billing":{"default":"monthly","description":"The billing period the link opens with. The quote's figures are monthly either way.","enum":["monthly","annual"],"type":"string"},"compute_family":{"default":"general","description":"The server type. `general` is Standard and `optimised` is Performance, which is refused where the region does not offer it.","enum":["general","optimised"],"type":"string"},"currency":{"description":"The currency to price in. A currency the order page has no prices in at the moment is refused.","enum":["GBP","USD","EUR"],"type":"string"},"package":{"description":"A package code the order page sells, such as `CS4` or `CC8`. Its first two letters name the line (`CS` CoreStack, `CC` CoreCluster).","type":"string"},"platform":{"description":"The platform of a CoreStack site, such as `wordpress`. Needed for a CoreStack package and ignored for a CoreCluster one.","type":"string"},"region":{"description":"A region the order page offers to everyone, such as `uk`, `us`, `nl` or `aus`. The package's line must be orderable there.","type":"string"}},"required":["package","region","currency"],"type":"object"},"OrderLinkQuoteLine":{"properties":{"key":{"description":"What the line is, such as `package`, `addon_cores`, `addon_memory_gb` or `addon_disk_gb`.","type":"string"},"label":{"type":"string"},"monthly":{"description":"The line's monthly price, a decimal number as text.","type":"string"},"quantity":{"description":"How many units, on an upgrade's line.","type":"integer"},"unit":{"description":"The monthly price of one unit, on an upgrade's line.","type":"string"}},"required":["key","label","monthly"],"type":"object"},"Overview":{"additionalProperties":true,"description":"The overview. `clusters` is always sent.","properties":{"activity":{"items":{"$ref":"#/components/schemas/ActivityItem"},"type":"array"},"attention":{"description":"What needs attention now, the most pressing first.","items":{"$ref":"#/components/schemas/AttentionItem"},"type":"array"},"attention_acknowledged":{"items":{"$ref":"#/components/schemas/AttentionItem"},"type":"array"},"attention_acknowledged_total":{"type":"integer"},"attention_total":{"type":"integer"},"clusters":{"items":{"$ref":"#/components/schemas/OverviewCluster"},"type":"array"},"generated_at":{"format":"date-time","type":"string"},"pagespeed":{"description":"The PageSpeed strip. Null while PageSpeed is off for your company.","type":["object","null"]},"sites":{"items":{"$ref":"#/components/schemas/SiteSummary"},"type":"array"}},"required":["clusters"],"type":"object"},"OverviewCluster":{"additionalProperties":true,"description":"One of your CoreClusters with its usage. Other fields may be present.","properties":{"actions":{"type":["object","null"]},"allowance":{"type":["object","null"]},"capacity":{"type":["object","null"]},"id":{"minimum":1,"type":"integer"},"kind":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"operation":{"oneOf":[{"$ref":"#/components/schemas/OperationSummary"},{"type":"null"}]},"package":{"type":["object","null"]},"pending_changes":{"type":["object","null"]},"region":{"type":["object","null"]},"reserved":{"type":["object","null"]},"sites":{"description":"How many sites the CoreCluster has, in total and by health.","type":["object","null"]},"slug":{"type":"string"},"state":{"type":"string"},"state_label":{"type":"string"},"usage":{"type":["object","null"]}},"required":["id","name"],"type":"object"},"PageSpeedHistory":{"properties":{"enabled":{"description":"Whether PageSpeed tests are running at the moment.","type":"boolean"},"history":{"description":"The finished tests of the range, newest first.","items":{"$ref":"#/components/schemas/PageSpeedHistoryRow"},"type":"array"},"in_flight":{"description":"Tests queued or running now.","items":{"$ref":"#/components/schemas/PageSpeedRun"},"type":"array"},"latest":{"description":"The newest test that succeeded, for each strategy.","properties":{"desktop":{"oneOf":[{"$ref":"#/components/schemas/PageSpeedRun"},{"type":"null"}]},"mobile":{"oneOf":[{"$ref":"#/components/schemas/PageSpeedRun"},{"type":"null"}]}},"required":["mobile","desktop"],"type":"object"},"run_now":{"description":"Whether a test can be run now.","properties":{"available":{"type":"boolean"},"next_at":{"description":"When the hourly limit next has room. Null when no test was run this hour.","format":"date-time","type":["string","null"]},"reason":{"description":"The sentence that says why not. Null when a test can be run.","type":["string","null"]},"remaining_this_hour":{"description":"Tests you can still run now this hour.","type":"integer"}},"required":["available","reason","remaining_this_hour","next_at"],"type":"object"},"series":{"description":"The scores over the range, for a chart.","properties":{"desktop":{"items":{"$ref":"#/components/schemas/PageSpeedPoint"},"type":"array"},"failures":{"description":"The tests that failed in the range.","items":{"properties":{"at":{"format":"date-time","type":["string","null"]},"error":{"type":"string"},"run_id":{"minimum":1,"type":"integer"},"strategy":{"$ref":"#/components/schemas/PageSpeedStrategy"}},"required":["run_id","at","strategy","error"],"type":"object"},"type":"array"},"from":{"format":"date-time","type":"string"},"mobile":{"items":{"$ref":"#/components/schemas/PageSpeedPoint"},"type":"array"},"range":{"enum":["30d","90d"],"type":"string"},"to":{"format":"date-time","type":"string"}},"required":["range","from","to","mobile","desktop","failures"],"type":"object"},"site":{"properties":{"domain":{"type":"string"},"id":{"minimum":1,"type":"integer"},"skipped":{"description":"Why the site is not tested at the moment. Null when it is.","oneOf":[{"properties":{"message":{"type":"string"},"reason":{"enum":["preview","maintenance","deleting"],"type":"string"}},"required":["reason","message"],"type":"object"},{"type":"null"}]},"tested_url":{"description":"The address tests run against. Null while the site is not tested.","type":["string","null"]}},"required":["id","domain","tested_url","skipped"],"type":"object"},"trend":{"additionalProperties":true,"properties":{"desktop":{"$ref":"#/components/schemas/PageSpeedTrend"},"mobile":{"$ref":"#/components/schemas/PageSpeedTrend"}},"required":["mobile","desktop"],"type":"object"}},"required":["site","enabled","latest","in_flight","series","history","trend","run_now"],"type":"object"},"PageSpeedHistoryRow":{"description":"One finished test in the history.","properties":{"cls":{"type":["number","null"]},"error":{"description":"Why a failed test failed. Null otherwise.","oneOf":[{"properties":{"class":{"description":"The kind of failure.","type":"string"},"message":{"type":"string"}},"required":["class","message"],"type":"object"},{"type":"null"}]},"fcp_ms":{"type":["integer","number","null"]},"fetched_at":{"description":"When Google analysed the page, or when a failed test was tried.","format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"inp_ms":{"type":["integer","number","null"]},"lcp_ms":{"type":["integer","number","null"]},"performance_score":{"type":["integer","null"]},"requested_by":{"description":"Who asked for the test. Null for a scheduled test.","oneOf":[{"properties":{"id":{"description":"Null for Corefinity support.","minimum":1,"type":["integer","null"]},"name":{"type":"string"}},"required":["id","name"],"type":"object"},{"type":"null"}]},"speed_index_ms":{"type":["integer","number","null"]},"status":{"$ref":"#/components/schemas/PageSpeedStatus"},"strategy":{"$ref":"#/components/schemas/PageSpeedStrategy"},"tbt_ms":{"type":["integer","number","null"]},"ttfb_ms":{"type":["integer","number","null"]}},"required":["id","strategy","fetched_at","status","performance_score","lcp_ms","cls","inp_ms","tbt_ms","fcp_ms","speed_index_ms","ttfb_ms","requested_by","error"],"type":"object"},"PageSpeedPoint":{"properties":{"at":{"format":"date-time","type":["string","null"]},"run_id":{"minimum":1,"type":"integer"},"score":{"type":"integer"}},"required":["run_id","at","score"],"type":"object"},"PageSpeedRun":{"description":"One test of one strategy, with its score, measurements and suggestions once it has succeeded.","properties":{"created_at":{"format":"date-time","type":["string","null"]},"diagnostics":{"description":"What the page loaded. Null when Google reports none of it.","properties":{"dom_size":{"description":"The number of elements on the page.","type":["integer","null"]},"resources":{"description":"The requests and bytes of each kind of file.","items":{"properties":{"requests":{"type":"integer"},"transfer_bytes":{"type":"integer"},"type":{"description":"Google's name for the kind, such as `script`, `image` or `font`.","type":"string"}},"required":["type","requests","transfer_bytes"],"type":"object"},"type":"array"},"third_party_bytes":{"description":"The bytes loaded from other sites.","type":["integer","null"]},"total_requests":{"type":["integer","null"]},"total_transfer_bytes":{"type":["integer","null"]}},"required":["total_requests","total_transfer_bytes","dom_size","third_party_bytes","resources"],"type":["object","null"]},"error":{"description":"Why a failed test failed. Null otherwise.","oneOf":[{"properties":{"class":{"description":"The kind of failure.","type":"string"},"message":{"type":"string"}},"required":["class","message"],"type":"object"},{"type":"null"}]},"fetched_at":{"description":"When Google analysed the page. Null until the test succeeds.","format":"date-time","type":["string","null"]},"field":{"description":"Google's figures from real visits over the last 28 days. Null when it has none for the page or the site.","properties":{"cls":{"type":["number","null"]},"fcp_ms":{"type":["integer","null"]},"inp_ms":{"type":["integer","null"]},"lcp_ms":{"type":["integer","null"]},"overall":{"description":"Google's verdict in its own word, such as `FAST`, `AVERAGE` or `SLOW`.","type":["string","null"]},"source":{"description":"`page` when the figures are the tested page's; `origin` when any of them is for the whole site.","enum":["page","origin"],"type":"string"},"ttfb_ms":{"type":["integer","null"]}},"required":["source","overall","lcp_ms","cls","inp_ms","fcp_ms","ttfb_ms"],"type":["object","null"]},"finished_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"lighthouse_version":{"type":["string","null"]},"metrics":{"properties":{"cls":{"description":"Cumulative Layout Shift.","properties":{"band":{"enum":["good","needs_improvement","poor",null],"type":["string","null"]},"value":{"type":["number","null"]}},"required":["value","band"],"type":"object"},"fcp":{"description":"First Contentful Paint.","properties":{"band":{"enum":["good","needs_improvement","poor",null],"type":["string","null"]},"value_ms":{"type":["integer","number","null"]}},"required":["value_ms","band"],"type":"object"},"inp":{"description":"Interaction to Next Paint.","properties":{"band":{"enum":["good","needs_improvement","poor",null],"type":["string","null"]},"source":{"description":"`field` when the figure comes from real visits. Null when there is none.","type":["string","null"]},"value_ms":{"type":["integer","number","null"]}},"required":["value_ms","band","source"],"type":"object"},"lcp":{"description":"Largest Contentful Paint.","properties":{"band":{"enum":["good","needs_improvement","poor",null],"type":["string","null"]},"value_ms":{"type":["integer","number","null"]}},"required":["value_ms","band"],"type":"object"},"speed_index":{"description":"Speed Index.","properties":{"band":{"enum":["good","needs_improvement","poor",null],"type":["string","null"]},"value_ms":{"type":["integer","number","null"]}},"required":["value_ms","band"],"type":"object"},"tbt":{"description":"Total Blocking Time.","properties":{"band":{"enum":["good","needs_improvement","poor",null],"type":["string","null"]},"value_ms":{"type":["integer","number","null"]}},"required":["value_ms","band"],"type":"object"},"ttfb":{"description":"Time to first byte.","properties":{"band":{"enum":["good","needs_improvement","poor",null],"type":["string","null"]},"value_ms":{"type":["integer","number","null"]}},"required":["value_ms","band"],"type":"object"}},"required":["lcp","cls","inp","tbt","fcp","speed_index","ttfb"],"type":"object"},"opportunities":{"description":"Google's suggestions with a saving, the largest saving first, ten at most.","items":{"properties":{"display_value":{"description":"The saving in Google's words, when it gives one.","type":["string","null"]},"id":{"description":"Google's name for the check, such as `unused-javascript`.","type":"string"},"savings_ms":{"description":"The time the suggestion could save, in milliseconds.","type":"integer"},"title":{"type":"string"}},"required":["id","title","savings_ms","display_value"],"type":"object"},"maxItems":10,"type":"array"},"requested_by":{"description":"Who asked for the test. Null for a scheduled test.","oneOf":[{"properties":{"id":{"description":"Null for Corefinity support.","minimum":1,"type":["integer","null"]},"name":{"type":"string"}},"required":["id","name"],"type":"object"},{"type":"null"}]},"score":{"description":"The performance score, 0 to 100.","properties":{"band":{"enum":["good","needs_improvement","poor",null],"type":["string","null"]},"value":{"type":["integer","null"]}},"required":["value","band"],"type":"object"},"started_at":{"format":"date-time","type":["string","null"]},"status":{"$ref":"#/components/schemas/PageSpeedStatus"},"status_label":{"description":"The status as the Control Panel shows it, such as `Queued` or `Done`.","type":"string"},"strategy":{"$ref":"#/components/schemas/PageSpeedStrategy"},"url":{"description":"The address tested.","type":"string"}},"required":["id","strategy","status","status_label","requested_by","url","fetched_at","lighthouse_version","score","metrics","field","opportunities","diagnostics","error","created_at","started_at","finished_at"],"type":"object"},"PageSpeedRunsStarted":{"properties":{"runs":{"description":"The mobile test, then the desktop test, both queued.","items":{"$ref":"#/components/schemas/PageSpeedRun"},"maxItems":2,"minItems":2,"type":"array"}},"required":["runs"],"type":"object"},"PageSpeedStatus":{"enum":["queued","running","succeeded","failed"],"type":"string"},"PageSpeedStrategy":{"enum":["mobile","desktop"],"type":"string"},"PageSpeedTrend":{"description":"The median score of the newest seven successful tests (`current`) against the seven before them (`previous`),\nand the difference (`delta`). `current` is null with fewer than three tests; `previous` and `delta` are null\nuntil the seven before also hold three.\n","properties":{"current":{"type":["integer","null"]},"delta":{"type":["integer","null"]},"previous":{"type":["integer","null"]}},"required":["current","previous","delta"],"type":"object"},"PendingChangeEnvironment":{"additionalProperties":true,"properties":{"id":{"description":"The site row id.","minimum":1,"type":"integer"},"name":{"type":"string"},"role":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug","role"],"type":"object"},"PendingChangeItem":{"additionalProperties":true,"properties":{"applied_at":{"format":"date-time","type":["string","null"]},"customer_change":{"description":"What was asked, by whom and when, and whether you can withdraw it. Null for the platform's own changes.","properties":{"can_cancel":{"type":"boolean"},"requested_at":{"format":"date-time","type":["string","null"]},"requested_by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"summary":{"type":"string"},"type":{"type":"string"}},"type":["object","null"]},"error":{"type":["string","null"]},"id":{"description":"The `{item}` to withdraw the change with.","minimum":1,"type":"integer"},"kind":{"description":"A change somebody asked for is `customer_change`. Other kinds are the platform's own.","type":"string"},"label":{"type":"string"},"position":{"type":"integer"},"source_operation":{"description":"Always null.","type":"null"},"status":{"type":"string"}},"required":["id","kind","label","status","customer_change","position","applied_at","error"],"type":"object"},"PendingChangeWithdrawn":{"properties":{"pending":{"$ref":"#/components/schemas/PendingChanges"}},"required":["pending"],"type":"object"},"PendingChanges":{"additionalProperties":true,"properties":{"batch":{"description":"The set of changes that will apply together. Null when nothing is waiting.","properties":{"id":{"minimum":1,"type":"integer"},"status":{"type":"string"},"window_date":{"format":"date","type":"string"}},"type":["object","null"]},"can_apply_now":{"$ref":"#/components/schemas/Availability","description":"Whether the changes can be applied now. `reason` says why not, such as `nothing_pending` or `batch_window`."},"environment":{"$ref":"#/components/schemas/PendingChangeEnvironment"},"items":{"items":{"$ref":"#/components/schemas/PendingChangeItem"},"type":"array"},"notice":{"description":"Whether you are told before the window. Sent only while maintenance windows are on for your company.","type":"boolean"},"platform_maintenance":{"description":"Platform maintenance announced for the site. Sent only while maintenance windows are on for your company.","items":{"properties":{"ends_at":{"format":"date-time","type":"string"},"label":{"type":"string"},"starts_at":{"format":"date-time","type":"string"},"summary":{"type":"string"}},"type":"object"},"type":"array"},"site":{"$ref":"#/components/schemas/SiteRef"},"window":{"$ref":"#/components/schemas/PendingChangesWindow"}},"required":["site","environment","batch","items","window","can_apply_now"],"type":"object"},"PendingChangesApplied":{"properties":{"operation":{"$ref":"#/components/schemas/PendingChangesOperation"}},"required":["operation"],"type":"object"},"PendingChangesApplyRequest":{"properties":{"confirm":{"const":true,"description":"Must be true. Anything else is refused `422` `confirm`.","type":"boolean"}},"required":["confirm"],"type":"object"},"PendingChangesAttention":{"properties":{"attention":{"items":{"$ref":"#/components/schemas/PendingChangesAttentionItem"},"type":"array"},"attention_acknowledged":{"items":{"$ref":"#/components/schemas/PendingChangesAttentionItem"},"type":"array"},"attention_acknowledged_total":{"type":"integer"},"attention_total":{"type":"integer"},"generated_at":{"format":"date-time","type":"string"}},"required":["attention","attention_total","attention_acknowledged","attention_acknowledged_total","generated_at"],"type":"object"},"PendingChangesAttentionItem":{"additionalProperties":true,"properties":{"acknowledgeable":{"type":"boolean"},"acknowledged":{"type":["object","null"]},"action":{"properties":{"href":{"type":"string"},"label":{"type":"string"}},"type":["object","null"]},"cluster":{"type":["object","null"]},"detail":{"type":["string","null"]},"environment":{"type":["object","null"]},"href":{"description":"A path in the Control Panel.","type":["string","null"]},"id":{"type":"string"},"kind":{"type":"string"},"scope":{"type":"string"},"severity":{"type":"string"},"since":{"format":"date-time","type":["string","null"]},"site":{"type":["object","null"]},"subject":{"type":["object","null"]},"title":{"type":"string"}},"required":["id","severity","kind","title","detail","since","href","scope"],"type":"object"},"PendingChangesOperation":{"additionalProperties":true,"description":"The operation that applies a site's pending changes. Follow it by `id` with `getOperation`. It carries fewer\nfields here than the operation you then read.\n","properties":{"applied_at":{"format":"date-time","type":["string","null"]},"committed_at":{"format":"date-time","type":["string","null"]},"completed_at":{"format":"date-time","type":["string","null"]},"created_at":{"format":"date-time","type":["string","null"]},"environment":{"oneOf":[{"$ref":"#/components/schemas/PendingChangeEnvironment"},{"type":"null"}]},"error":{"type":["string","null"]},"failure_reason":{"type":["string","null"]},"id":{"minimum":1,"type":"integer"},"label":{"type":["string","null"]},"requested_by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"scope":{"type":"string"},"site":{"oneOf":[{"$ref":"#/components/schemas/SiteRef"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/OperationStatus"},"status_label":{"type":"string"},"step":{"type":["string","null"]},"steps":{"items":{"$ref":"#/components/schemas/OperationStep"},"type":"array"},"subject":{"type":["object","null"]},"summary":{"type":["string","null"]},"type":{"type":"string"},"type_label":{"type":"string"},"window":{"type":["object","null"]}},"required":["id","type","type_label","scope","status","status_label","steps","error","created_at","completed_at"],"type":"object"},"PendingChangesWindow":{"additionalProperties":true,"properties":{"date":{"format":"date","type":"string"},"ends_at":{"format":"date-time","type":"string"},"label":{"type":"string"},"policy":{"description":"Sent only while maintenance windows are on for your company.","type":["string","null"]},"source":{"description":"Where the window comes from. Sent only while maintenance windows are on for your company.","type":["string","null"]},"starts_at":{"format":"date-time","type":"string"}},"required":["date","starts_at","ends_at","label"],"type":"object"},"PerformanceAudit":{"allOf":[{"$ref":"#/components/schemas/PerformanceAuditSummary"},{"properties":{"log":{"description":"The runs' request log.","type":"string"},"results":{"items":{"$ref":"#/components/schemas/PerformanceAuditResult"},"type":"array"}},"required":["results","log"],"type":"object"}]},"PerformanceAuditConfirmName":{"properties":{"confirm_name":{"description":"The audit's name, typed exactly.","maxLength":255,"minLength":1,"type":"string"}},"required":["confirm_name"],"type":"object"},"PerformanceAuditDomainInput":{"additionalProperties":false,"properties":{"environment":{"description":"A name for the environment, unique in the audit, such as `Current host`. No control characters.","maxLength":100,"minLength":1,"type":"string"},"http_password":{"description":"The HTTP authentication password. No control characters. Never answered.","maxLength":255,"type":["string","null"]},"http_username":{"description":"The HTTP authentication username that opens a protected site for the runs. No control characters. Never answered.","maxLength":255,"type":["string","null"]},"url":{"description":"The address it is served on, a full `http` or `https` URL. No control characters.","maxLength":255,"minLength":1,"type":"string"}},"required":["environment","url"],"type":"object"},"PerformanceAuditList":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"items":{"items":{"$ref":"#/components/schemas/PerformanceAuditSummary"},"type":"array"}},"required":["items"],"type":"object"}]},"PerformanceAuditPageInput":{"additionalProperties":false,"properties":{"check_cache":{"description":"Also test the page cached.","type":"boolean"},"path":{"description":"The path of the page, such as `/shop/`. No control characters.","maxLength":255,"type":["string","null"]},"title":{"description":"A name for the page, unique in the audit. No control characters.","maxLength":100,"minLength":1,"type":"string"}},"required":["title"],"type":"object"},"PerformanceAuditReport":{"properties":{"built_at":{"format":"date-time","type":"string"},"report":{"description":"The report's figures, as the report preview of the Control Panel shows them: today's, not the frozen ones a shared link shows.","properties":{"audit":{"description":"The audit's details.","properties":{"company":{"description":"The name of the audit's company.","type":["string","null"]},"created_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"requests_per_measurement":{"type":"integer"},"run_at":{"description":"When the measurements were saved. Like every time in a report, written with a `+00:00` offset.","format":"date-time","type":["string","null"]},"server_location":{"description":"The name of the server location the pages were loaded from.","type":["string","null"]},"user_agent":{"type":"string"}},"required":["id","name","company","run_at","created_at","requests_per_measurement","user_agent","server_location"],"type":"object"},"baseline":{"description":"The environment the others are compared with: the first.","properties":{"environment":{"description":"The environment's name in the audit.","type":"string"},"host":{"type":"string"},"url":{"type":"string"}},"required":["environment","url","host"],"type":["object","null"]},"built_at":{"format":"date-time","type":"string"},"comparisons":{"description":"Each other environment against the baseline.","items":{"properties":{"environment":{"description":"The environment's name in the audit.","type":"string"},"excluded":{"description":"The page and cache state pairs left out of the figures, each with its `reason`.","items":{"properties":{"page":{"type":"string"},"reason":{"type":"string"},"state":{"type":"string"}},"required":["page","state","reason"],"type":"object"},"type":"array"},"faster_on":{"description":"The measurements this environment was faster on, out of `of`.","type":"integer"},"host":{"type":"string"},"of":{"type":"integer"},"summary":{"description":"The averages over the pages both environments measured, by cache state and overall. A part with nothing to compare is null.","properties":{"cached":{"properties":{"baseline_avg_ms":{"type":"number"},"comparison_avg_ms":{"type":"number"},"diff_percent":{"description":"Above zero when this environment is the faster one.","type":"number"},"measurements":{"description":"The page and cache state pairs counted.","type":"integer"},"saved_ms":{"type":"number"},"speed_multiplier":{"type":["number","null"]}},"required":["baseline_avg_ms","comparison_avg_ms","diff_percent","saved_ms","speed_multiplier","measurements"],"type":["object","null"]},"overall":{"properties":{"baseline_avg_ms":{"type":"number"},"comparison_avg_ms":{"type":"number"},"diff_percent":{"description":"Above zero when this environment is the faster one.","type":"number"},"measurements":{"description":"The page and cache state pairs counted.","type":"integer"},"saved_ms":{"type":"number"},"speed_multiplier":{"type":["number","null"]}},"required":["baseline_avg_ms","comparison_avg_ms","diff_percent","saved_ms","speed_multiplier","measurements"],"type":["object","null"]},"uncached":{"properties":{"baseline_avg_ms":{"type":"number"},"comparison_avg_ms":{"type":"number"},"diff_percent":{"description":"Above zero when this environment is the faster one.","type":"number"},"measurements":{"description":"The page and cache state pairs counted.","type":"integer"},"saved_ms":{"type":"number"},"speed_multiplier":{"type":["number","null"]}},"required":["baseline_avg_ms","comparison_avg_ms","diff_percent","saved_ms","speed_multiplier","measurements"],"type":["object","null"]}},"type":["object","null"]},"url":{"type":"string"}},"required":["environment","url","host","summary","faster_on","of","excluded"],"type":"object"},"type":"array"},"coverage":{"additionalProperties":{"type":"boolean"},"description":"What the results hold, which decides the sections a report can show.","type":"object"},"lighthouse":{"additionalProperties":true,"description":"The Lighthouse comparison, when the audit has one. Never the raw Lighthouse result.","type":["object","null"]},"lighthouse_failure":{"description":"Why the last Lighthouse comparison did not complete. Null unless `lighthouse_state` is `failed`.","examples":[{"code":"upstream","failed_at":"2026-11-03T12:31:00+00:00"}],"properties":{"code":{"description":"`connection` (the Lighthouse service could not be reached), `refused` (it refused the request),\n`upstream` (it failed; trying again may work), `malformed` (its answer could not be used) or\n`lost` (the request never finished).\n","enum":["connection","refused","upstream","malformed","lost"],"type":"string"},"failed_at":{"description":"When the request ended without a result.","format":"date-time","type":"string"}},"required":["failed_at","code"],"type":["object","null"]},"lighthouse_state":{"enum":["unavailable","not_requested","pending","failed","ready","no_scores"],"type":"string"},"metric":{"description":"What the report's figures measure, the time to first byte (`ttfb`) or the whole response (`total`). Null while the audit has no measurement yet.","enum":["ttfb","total",null],"type":["string","null"]},"pages":{"description":"Each page with its measurements, by cache state and environment.","items":{"properties":{"path":{"type":"string"},"states":{"additionalProperties":{"properties":{"key":{"type":"string"},"label":{"type":"string"},"measurements":{"additionalProperties":true,"type":"object"},"requested":{"type":"boolean"}},"required":["key","label","requested","measurements"],"type":"object"},"description":"The cache states measured, by key (`uncached`, `cached`), each with its `measurements` by environment name. A measurement is the report builder's own record of the samples taken.","type":"object"},"title":{"type":"string"}},"required":["title","path","states"],"type":"object"},"type":"array"},"psi":{"additionalProperties":true,"description":"Google's scores, when the audit has them.","type":["object","null"]},"scale":{"additionalProperties":true,"type":"object"},"schema_version":{"type":"integer"}},"required":["schema_version","built_at","audit","baseline","comparisons","pages","metric","scale","psi","lighthouse","coverage","lighthouse_state","lighthouse_failure"],"type":"object"},"sections":{"description":"The section keys each tab shows, in order, and whether the contact block shows.","properties":{"contact":{"type":"boolean"},"simple":{"items":{"type":"string"},"type":"array"},"technical":{"items":{"type":"string"},"type":"array"}},"required":["simple","technical","contact"],"type":"object"}},"required":["built_at","sections","report"],"type":"object"},"PerformanceAuditReportState":{"description":"The shared report's state. It never holds the link itself or the password.","properties":{"frozen_at":{"description":"When the figures the link shows were built.","format":"date-time","type":["string","null"]},"legacy_link_live":{"description":"Whether a link made before the report existed still shows its response times and statuses.","type":"boolean"},"password_protected":{"type":"boolean"},"revoked_at":{"format":"date-time","type":["string","null"]},"sections":{"items":{"properties":{"enabled":{"type":"boolean"},"key":{"enum":["hero","at_a_glance","response_times","gap","improvement","absolute_times","waterfall","filmstrip","full_table","google_scores","definitions","method","timing_breakdown","samples","status_codes","response_headers","raw_lighthouse_json","all_metrics","cta"],"type":"string"},"label":{"type":"string"},"tab":{"enum":["simple","technical","both"],"type":"string"}},"required":["key","label","tab","enabled"],"type":"object"},"type":"array"},"shared":{"description":"Whether the report link works.","type":"boolean"},"shared_at":{"format":"date-time","type":["string","null"]},"username":{"description":"The username the link asks for. Null while it is not protected.","type":["string","null"]}},"required":["shared","legacy_link_live","shared_at","revoked_at","frozen_at","password_protected","username","sections"],"type":"object"},"PerformanceAuditRequest":{"properties":{"domains":{"description":"The environments to test.","items":{"$ref":"#/components/schemas/PerformanceAuditDomainInput"},"maxItems":10,"minItems":1,"type":"array"},"name":{"maxLength":255,"minLength":1,"type":"string"},"number_of_requests":{"default":5,"description":"How many times each page is loaded.","maximum":20,"minimum":1,"type":"integer"},"page_types":{"description":"The pages to test on each environment.","items":{"$ref":"#/components/schemas/PerformanceAuditPageInput"},"maxItems":20,"minItems":1,"type":"array"},"server_location":{"description":"The id of the server location to test from, as an audit answers it in `server_location.id`. The first location when left out.","type":"integer"},"user_agent":{"description":"The user agent the requests carry. No control characters. The Control Panel's own when left out.","maxLength":255,"type":"string"}},"required":["name","domains","page_types"],"type":"object"},"PerformanceAuditResult":{"description":"One cell: an environment, a page and a cache state. A cell has not run when it has no time, or when its time is not a measurement of the page; `error` then says why, or `http_code` is 0.","properties":{"active":{"type":"boolean"},"cache":{"enum":["uncached","cached"],"type":"string"},"environment":{"type":"string"},"error":{"type":["string","null"]},"http_code":{"description":"The HTTP status of the page. 0 when there was no HTTP answer.","type":["integer","null"]},"ipv4_requests":{"type":["integer","null"]},"ipv6_requests":{"type":["integer","null"]},"mean_ttfb_ms":{"description":"The mean time to first byte, connection included. Null when the cell has not run.","type":["number","null"]},"page":{"type":"string"},"path":{"type":["string","null"]},"ran":{"type":"boolean"},"server_response_ms":{"description":"The mean time the server took to answer: time to first byte less DNS, connect and TLS.","type":["number","null"]},"timing_ms":{"oneOf":[{"description":"The mean of each stage, in milliseconds.","properties":{"dns":{"type":"number"},"tcp":{"type":"number"},"tls":{"type":"number"},"total":{"type":"number"},"transfer":{"type":"number"},"ttfb":{"type":"number"}},"required":["dns","tcp","tls","ttfb","transfer","total"],"type":"object"},{"type":"null"}]}},"required":["environment","page","path","cache","active","ran","mean_ttfb_ms","http_code","error","server_response_ms","timing_ms","ipv4_requests","ipv6_requests"],"type":"object"},"PerformanceAuditRunStatus":{"description":"Null for an audit never run through the API.","enum":["queued","running","completed","failed",null],"type":["string","null"]},"PerformanceAuditShareLink":{"properties":{"shared_at":{"format":"date-time","type":["string","null"]},"url":{"description":"The link to the report. Anyone who has it can read the report, behind its login when one is set.","type":"string"}},"required":["url","shared_at"],"type":"object"},"PerformanceAuditSummary":{"description":"An audit without its results. The HTTP usernames and passwords of the audited sites are never answered: `http_auth` says only whether one is set.","properties":{"company_id":{"minimum":1,"type":["integer","null"]},"created_at":{"format":"date-time","type":["string","null"]},"domains":{"items":{"properties":{"environment":{"type":"string"},"http_auth":{"description":"Whether an HTTP authentication username or password is set.","type":"boolean"},"url":{"type":"string"}},"required":["environment","url","http_auth"],"type":"object"},"type":"array"},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"number_of_requests":{"type":"integer"},"page_types":{"items":{"properties":{"check_cache":{"type":"boolean"},"path":{"type":["string","null"]},"title":{"type":"string"}},"required":["title","path","check_cache"],"type":"object"},"type":"array"},"report":{"$ref":"#/components/schemas/PerformanceAuditReportState"},"run":{"description":"The last run started through the API or MCP.","properties":{"error":{"description":"Why a failed run failed.","type":["string","null"]},"finished_at":{"format":"date-time","type":["string","null"]},"requested_at":{"format":"date-time","type":["string","null"]},"started_at":{"format":"date-time","type":["string","null"]},"status":{"$ref":"#/components/schemas/PerformanceAuditRunStatus"}},"required":["status","requested_at","started_at","finished_at","error"],"type":"object"},"server_location":{"description":"Where the runs are made from. Null when the location no longer exists.","oneOf":[{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},{"type":"null"}]},"updated_at":{"format":"date-time","type":["string","null"]},"user_agent":{"type":"string"}},"required":["id","name","company_id","domains","page_types","number_of_requests","user_agent","server_location","run","report","created_at","updated_at"],"type":"object"},"PerformanceAuditUpdate":{"description":"Only the fields sent change. `domains` and `page_types` replace the whole list.","properties":{"domains":{"description":"The environments to test, replacing the whole list. A domain that leaves out `http_username` or `http_password` keeps the one saved for the environment of that name; send an empty string to remove it.","items":{"$ref":"#/components/schemas/PerformanceAuditDomainInput"},"maxItems":10,"minItems":1,"type":"array"},"name":{"maxLength":255,"minLength":1,"type":"string"},"number_of_requests":{"maximum":20,"minimum":1,"type":"integer"},"page_types":{"description":"The pages to test, replacing the whole list.","items":{"$ref":"#/components/schemas/PerformanceAuditPageInput"},"maxItems":20,"minItems":1,"type":"array"},"report_password":{"description":"10 to 72 characters and at most 72 bytes, no NUL character, not only spaces. Never answered; leave it out to keep the one set.","maxLength":72,"minLength":10,"type":["string","null"]},"report_password_protected":{"description":"Whether the shared link asks for a username and password first. Turning it on needs both, sent now or set before.","type":"boolean"},"report_sections":{"description":"The shared report's sections in order. The headline always stays first and the contact block last; a section left out keeps its place and whether it shows.","items":{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"},"key":{"enum":["hero","at_a_glance","response_times","gap","improvement","absolute_times","waterfall","filmstrip","full_table","google_scores","definitions","method","timing_breakdown","samples","status_codes","response_headers","raw_lighthouse_json","all_metrics","cta"],"type":"string"}},"required":["key","enabled"],"type":"object"},"maxItems":19,"type":"array"},"report_username":{"description":"The username the shared link asks for. No control characters.","maxLength":64,"type":["string","null"]},"server_location":{"description":"The id of the server location to test from, as an audit answers it in `server_location.id`.","type":"integer"},"user_agent":{"description":"The user agent the requests carry. No control characters.","maxLength":255,"type":"string"}},"type":"object"},"PermissionRefusal":{"additionalProperties":true,"description":"Your role lacks a permission. `permission` names it, as the Roles screen stores it.","properties":{"code":{"const":"forbidden","type":"string"},"message":{"type":"string"},"permission":{"description":"The permission's key, such as `createDeployments`. Absent when the refusal is not about a role permission.","type":"string"},"reason":{"const":"forbidden","type":"string"}},"required":["message","reason","code"],"type":"object"},"PersonRef":{"description":"A person by id and name. Corefinity staff read as `Corefinity support` with a null id.","properties":{"id":{"type":["integer","null"]},"name":{"type":["string","null"]}},"required":["id","name"],"type":"object"},"PlatformPlugins":{"additionalProperties":true,"description":"A WordPress site's platform plugins: whether they run, and what turning them off would stop.","properties":{"applies":{"description":"True for a WordPress site. No other platform has platform plugins.","type":"boolean"},"applying":{"description":"True while the platform is still applying the last change.","type":"boolean"},"can_change":{"description":"True when you may change the setting: only the site's managing agency and Corefinity can.","type":"boolean"},"changed_at":{"description":"When they were turned off, with a `+00:00` offset rather than `Z`. Null while they are on.","format":"date-time","type":["string","null"]},"cut_over":{"description":"True once the site is past its go-live hold. The platform plugins can then no longer be turned off.","type":"boolean"},"enabled":{"description":"Whether the platform plugins run. True until somebody turns them off.","type":"boolean"},"keyed":{"description":"True for a production site whose setting is also applied by the platform as an operation; a change then answers that operation.","type":"boolean"},"layout":{"description":"The WordPress layout found on the site.","enum":["classic","bedrock"],"type":"string"},"layout_label":{"type":"string"},"needs_attention":{"description":"A sentence saying what to do when the last change could not be confirmed on the site. Null otherwise.","type":["string","null"]},"off_note":{"description":"What to know before turning them off, when a turn-off is still possible.","type":["string","null"]},"off_refused":{"description":"Why a turn-off would be refused, when that is already known.","type":["string","null"]},"off_warning":{"description":"What else a turn-off ends, when a turn-off is still possible.","type":["string","null"]},"reason":{"description":"The sentence those tools are refused with.","type":"string"},"refused_functions":{"description":"The site tools that are refused while the platform plugins are off.","items":{"type":"string"},"type":"array"},"runtime_ready":{"description":"Whether the site's software can turn the platform plugins off. When false, a turn-off is refused `runtime_lacks_capability`.","type":"boolean"},"stops":{"description":"What stops working while the platform plugins are off, in plain words. Show this before sending `confirm_off`.","items":{"type":"string"},"type":"array"}},"required":["applies","enabled","can_change","runtime_ready","changed_at","layout","layout_label","stops","refused_functions","reason","keyed","cut_over","off_refused","off_note","off_warning","applying","needs_attention"],"type":"object"},"PlatformPluginsConfirmRefusal":{"description":"A turn-off that has not been agreed. `stops` lists what would stop working.","properties":{"code":{"const":"confirm","type":"string"},"message":{"type":"string"},"reason":{"const":"confirm","type":"string"},"stops":{"items":{"type":"string"},"type":"array"}},"required":["message","reason","code","stops"],"type":"object"},"PlatformPluginsResult":{"properties":{"platform_plugins":{"$ref":"#/components/schemas/PlatformPlugins"}},"required":["platform_plugins"],"type":"object"},"PlatformPluginsSaved":{"properties":{"changed":{"description":"False when the site already had the value sent, so nothing was done.","type":"boolean"},"operation":{"description":"The operation applying the change on a production site. Null when none started. This answer writes its\ntimes with a `+00:00` offset and leaves out `install`, `step` and `label`; reading the operation by its\n`id` answers the full form.\n","oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"platform_plugins":{"$ref":"#/components/schemas/PlatformPlugins"}},"required":["platform_plugins","changed","operation"],"type":"object"},"PlatformPluginsUpdate":{"properties":{"confirm_off":{"default":false,"description":"Send true with `enabled: false`, once the person has read `stops` and agreed. Not needed to turn them on.","type":"boolean"},"enabled":{"description":"True to turn the platform plugins on, false to turn them off.","type":"boolean"}},"required":["enabled"],"type":"object"},"ProgressStage":{"additionalProperties":true,"properties":{"at":{"type":["string","null"]},"detail":{"type":["string","null"]},"key":{"type":"string"},"label":{"type":"string"},"state":{"description":"Such as `done`, `current`, `todo`, `skipped` or `failed`.","type":"string"}},"required":["key","label","state","at","detail"],"type":"object"},"ProvisioningOptions":{"additionalProperties":true,"properties":{"can_create":{"$ref":"#/components/schemas/Availability"},"capacity":{"description":"What the CoreCluster has and uses.","type":["object","null"]},"cluster":{"$ref":"#/components/schemas/ClusterRef"},"limits":{"type":["object","null"]},"magento_keys":{"type":["object","null"]},"next_port":{"description":"The SSH port the next site is likely to get. For information only.","type":["integer","null"]},"platforms":{"items":{"$ref":"#/components/schemas/ProvisioningPlatform"},"type":"array"},"preview_suffix":{"type":["string","null"]},"ssh_host":{"type":["string","null"]}},"required":["cluster","can_create","platforms"],"type":"object"},"ProvisioningPlatform":{"additionalProperties":true,"properties":{"available":{"type":"boolean"},"content":{"additionalProperties":{"$ref":"#/components/schemas/Availability"},"description":"Whether a new install (`fresh`) and an empty site (`empty`) are available.","type":"object"},"default_tier":{"type":["string","null"]},"fresh_install_inputs":{"description":"The fields a new install takes.","items":{"additionalProperties":true,"properties":{"default":{"type":["string","null"]},"label":{"type":"string"},"name":{"type":"string"},"options":{"items":{"type":"string"},"type":"array"},"required":{"type":"boolean"}},"required":["name","label","required"],"type":"object"},"type":"array"},"key":{"type":"string"},"label":{"type":"string"},"mariadb_versions":{"items":{"additionalProperties":true,"properties":{"default":{"type":"boolean"},"label":{"type":"string"},"version":{"type":"string"}},"required":["version","label","default"],"type":"object"},"type":"array"},"php_versions":{"items":{"additionalProperties":true,"properties":{"default":{"type":"boolean"},"eol_date":{"type":["string","null"]},"label":{"type":"string"},"status":{"type":["string","null"]},"version":{"type":"string"}},"required":["version","label","default"],"type":"object"},"type":"array"},"reason":{"type":["string","null"]},"tiers":{"items":{"$ref":"#/components/schemas/ProvisioningTier"},"type":"array"}},"required":["key","label","available","reason","tiers"],"type":"object"},"ProvisioningTier":{"additionalProperties":true,"properties":{"available":{"type":"boolean"},"disk_bytes":{"type":"integer"},"estimate":{"type":["object","null"]},"fits":{"description":"Whether a site of this size fits in what the CoreCluster has left.","type":"boolean"},"fits_reason":{"type":["string","null"]},"key":{"type":"string"},"label":{"type":"string"},"limits":{"type":"object"},"plain":{"description":"The size in plain words.","type":"string"},"reason":{"type":["string","null"]},"requests":{"type":"object"}},"required":["key","label","available","reason","fits","fits_reason"],"type":"object"},"QueuedChange":{"description":"The answer when a change was queued for a window instead of started.","properties":{"item_id":{"description":"The id of the pending change.","type":"integer"},"operation":{"description":"Always null, because nothing has started yet.","type":"null"},"queued":{"const":true,"type":"boolean"},"window":{"description":"The window the change waits for. Present only while maintenance windows are on for your company.","oneOf":[{"$ref":"#/components/schemas/QueuedWindow"},{"type":"null"}]},"window_date":{"description":"The date of the window the change waits for.","type":"string"}},"required":["operation","queued","window_date","item_id"],"type":"object"},"QueuedWindow":{"properties":{"ends_at":{"type":"string"},"label":{"type":"string"},"policy":{"type":"string"},"source":{"description":"Where the window comes from, such as the site, the cluster or the company.","type":["string","null"]},"starts_at":{"type":"string"}},"required":["starts_at","ends_at","label","source","policy"],"type":"object"},"RedirectImportRequest":{"properties":{"content":{"description":"The text of the file, as UTF-8, up to 512 KiB. Only the first 2,000 lines are read.","type":["string","null"]},"format":{"enum":["nginx","apache","csv"],"type":"string"},"hosts":{"description":"Limit every rule read to these domains of the site.","items":{"type":"string"},"type":["array","null"]}},"required":["format","content"],"type":"object"},"RedirectImportResult":{"properties":{"duplicates":{"type":"integer"},"format":{"type":"string"},"imported":{"type":"integer"},"lines":{"items":{"properties":{"line":{"type":"integer"},"reason":{"type":["string","null"]},"result":{"description":"What happened to the line, such as `added`, `replaces`, `skipped` or `rejected`.","type":"string"},"rule":{"$ref":"#/components/schemas/RedirectRule"}},"required":["line","result","reason"],"type":"object"},"type":"array"},"rules":{"items":{"$ref":"#/components/schemas/RedirectRule"},"type":"array"},"skipped":{"type":"integer"},"warnings":{"items":{"properties":{"line":{"type":"integer"},"message":{"type":"string"},"text":{"type":"string"}},"type":"object"},"type":"array"}},"required":["format","rules","lines","imported","skipped","duplicates","warnings"],"type":"object"},"RedirectMatchType":{"enum":["exact","prefix","regex"],"type":"string"},"RedirectRule":{"description":"One redirect rule as the API answers it.","properties":{"enabled":{"type":"boolean"},"from":{"type":"string"},"hosts":{"description":"The domains the rule is limited to. Null for every domain.","items":{"type":"string"},"type":["array","null"]},"id":{"description":"The rule's id. Null for a rule that is not saved yet, as in an import or a test of unsaved rules.","type":["integer","null"]},"keep_query":{"type":"boolean"},"note":{"type":["string","null"]},"position":{"description":"The rule's place in the table, starting at 1. A rule whose path is the address asked for (an `exact`\nrule, or a `prefix` rule's own path) is taken first, whatever its position. Otherwise `prefix` and\n`regex` rules are tried in this order, and the first match wins.\nOn a domain, the rules limited to it are taken this way before the rules for every domain.\n","type":"integer"},"shadowed_by":{"description":"The id of an earlier rule that always answers first, so this one never matches.","type":["integer","null"]},"status":{"enum":[301,302],"type":"integer"},"to":{"type":"string"},"type":{"$ref":"#/components/schemas/RedirectMatchType"}},"required":["id","position","type","from","to","status","keep_query","enabled","note","hosts","shadowed_by"],"type":"object"},"RedirectRuleInput":{"allOf":[{"description":"A `prefix` rule's target carries no query string.","if":{"properties":{"type":{"const":"prefix"}},"required":["type"]},"then":{"properties":{"to":{"pattern":"^[^?]*$"}}}},{"description":"A target with a query string of its own needs `keep_query` sent as `false`.","if":{"properties":{"to":{"pattern":"[?]"}},"required":["to"]},"then":{"properties":{"keep_query":{"const":false}},"required":["keep_query"]}}],"description":"One rule of a save or of a test of unsaved rules.","properties":{"enabled":{"default":true,"type":"boolean"},"from":{"description":"The path to redirect, without a query string. For a `regex` rule, the pattern, at most 256 bytes.","maxLength":2000,"minLength":1,"type":"string"},"hosts":{"description":"Limit the rule to some of the site's own domains. Null or left out on a new rule means every domain; left\nout on a saved rule keeps what it has.\n","items":{"type":"string"},"type":["array","null"]},"id":{"description":"A saved rule's id, to keep it. Leave it out, or send null, for a new rule.","minimum":1,"type":["integer","null"]},"keep_query":{"default":true,"description":"Whether the request's query string is carried over to the target. Send `false` when the target has a query string of its own.","type":"boolean"},"note":{"maxLength":120,"type":["string","null"]},"status":{"default":301,"enum":[301,302],"type":"integer"},"to":{"description":"A path or an `https://` address. A `regex` rule may use `$1` to `$9`. A target with a query string of its own is taken only with `keep_query` sent as `false`, and never on a `prefix` rule, where the rest of the path is added at its end. The limit is 2,000 bytes of the target as it is stored, not 2,000 characters as sent. The host is written in lower case and each character outside ASCII is percent-encoded, so `é` counts as six bytes (`%C3%A9`).","maxLength":2000,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/RedirectMatchType"}},"required":["type","from","to"],"type":"object"},"RedirectSaveResult":{"properties":{"operation":{"description":"The change that applies the table. Null when the table sent is the one the site already has.","oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"redirects":{"$ref":"#/components/schemas/RedirectSet"}},"required":["redirects","operation"],"type":"object"},"RedirectSet":{"properties":{"apply":{"$ref":"#/components/schemas/ApplyState"},"available_hosts":{"description":"The domains a rule can be limited to.","items":{"properties":{"host":{"type":"string"},"role":{"description":"The domain's role, such as `primary` or `alias`.","type":"string"}},"required":["host","role"],"type":"object"},"type":"array"},"formats":{"description":"The formats import and export take.","items":{"type":"string"},"type":"array"},"host_scoping":{"description":"Whether a rule can be limited to some domains at the moment.","type":"boolean"},"hosts":{"description":"The domains the site answers on.","items":{"type":"string"},"type":"array"},"limits":{"properties":{"from_max":{"type":"integer"},"import_max_bytes":{"type":"integer"},"regex_max":{"type":"integer"},"rules_max":{"type":"integer"},"to_max":{"type":"integer"}},"required":["rules_max","from_max","to_max","regex_max","import_max_bytes"],"type":"object"},"rules":{"items":{"$ref":"#/components/schemas/RedirectRule"},"type":"array"},"version":{"type":"integer"}},"required":["version","rules","apply","hosts","available_hosts","host_scoping","limits","formats"],"type":"object"},"RedirectSetUpdate":{"properties":{"rules":{"description":"Every rule to keep, in the order they are tried. At most 2,000 rules, of which at most 500 are `prefix` or `regex` rules.","items":{"$ref":"#/components/schemas/RedirectRuleInput"},"maxItems":2000,"type":"array"},"version":{"description":"The `version` of the last read. A save with an older version is refused `409` `stale`.","minimum":0,"type":"integer"}},"required":["version","rules"],"type":"object"},"RedirectTestRequest":{"properties":{"host":{"description":"Test as this domain. It must be one of the site's own.","maxLength":253,"type":["string","null"]},"rules":{"description":"An unsaved table to test instead of the saved one.","items":{"$ref":"#/components/schemas/RedirectRuleInput"},"type":["array","null"]},"url":{"description":"A path starting with `/`, or a full `http://` or `https://` address.","maxLength":4096,"type":"string"}},"required":["url"],"type":"object"},"RedirectTestResult":{"properties":{"chain":{"description":"Each redirect the address goes through.","items":{"properties":{"from":{"type":"string"},"status":{"type":"integer"},"to":{"type":"string"}},"type":"object"},"type":"array"},"code":{"type":["integer","null"]},"disabled_match":{"description":"The id of a disabled rule that would have matched. Sent only when there is one.","type":"integer"},"host":{"type":["string","null"]},"matched_rule":{"oneOf":[{"$ref":"#/components/schemas/RedirectRule"},{"type":"null"}]},"path":{"type":"string"},"query":{"type":["string","null"]},"target":{"description":"Where the visitor is sent. Null when no rule matches.","type":["string","null"]},"tried_before":{"description":"The ids of the rules tried before the answer.","items":{"type":["integer","null"]},"type":"array"},"type":{"type":["string","null"]},"url":{"type":"string"},"warnings":{"items":{"type":"string"},"type":"array"}},"required":["url","host","path","query","matched_rule","type","code","target","tried_before","chain","warnings"],"type":"object"},"Refusal":{"additionalProperties":true,"description":"A refusal the API gives for a reason of its own. `reason` is a stable code; `code` always carries the same\nvalue. A refusal may add fields of its own, named on the endpoint that gives it.\n","properties":{"code":{"description":"The same value as `reason`.","type":"string"},"detail_reason":{"$ref":"#/components/schemas/DetailReason"},"message":{"description":"What happened, in plain words.","type":"string"},"reason":{"description":"The stable code for this refusal.","type":"string"}},"required":["message","reason","code"],"type":"object"},"Restore":{"description":"A restore. `created_at`, `completed_at` and `snapshot.created_at` are sent with a `+00:00` offset; the other\ntimes end in `Z`.\n","properties":{"anonymise_requested":{"type":"boolean"},"anonymised":{"type":"boolean"},"completed_at":{"format":"date-time","type":["string","null"]},"created_at":{"format":"date-time","type":["string","null"]},"error":{"description":"What went wrong, in plain words, when the restore failed.","type":["string","null"]},"estimate_seconds":{"type":["integer","null"]},"id":{"minimum":1,"type":"integer"},"kind":{"description":"Null for a copy between environments.","oneOf":[{"$ref":"#/components/schemas/RestoreRecordedKind"},{"type":"null"}]},"mode":{"description":"What is restored. A copy between environments can carry a mode of its own.","type":"string"},"mode_label":{"type":"string"},"needs_recovery":{"description":"True when the restore failed part-way and the site must be restored from its safety snapshot.","type":"boolean"},"operation_id":{"type":["integer","null"]},"outcome":{"description":"Whether the data was restored, known before the site is back up. Null until then.","enum":["completed","failed",null],"type":["string","null"]},"reason":{"description":"The code a failed restore recorded.","type":["string","null"]},"requested_by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"safety_snapshot":{"oneOf":[{"properties":{"id":{"minimum":1,"type":"integer"},"status":{"type":"string"}},"required":["id","status"],"type":"object"},{"type":"null"}]},"sanitise_level":{"$ref":"#/components/schemas/RestoreSanitiseLevel"},"scope":{"oneOf":[{"$ref":"#/components/schemas/RestoreScope"},{"type":"null"}]},"snapshot":{"oneOf":[{"properties":{"created_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"note":{"type":["string","null"]}},"required":["id","created_at","note"],"type":"object"},{"type":"null"}]},"source_site_id":{"description":"The site row the snapshot is of.","type":["integer","null"]},"started_at":{"format":"date-time","type":["string","null"]},"status":{"$ref":"#/components/schemas/RestoreStatus"},"status_label":{"type":"string"},"steps":{"description":"The restore's five steps, in order.","items":{"properties":{"key":{"enum":["safety","stop","copy","start","healthy"],"type":"string"},"state":{"enum":["todo","current","done","skipped","failed"],"type":"string"}},"required":["key","state"],"type":"object"},"type":"array"},"target_site_id":{"type":["integer","null"]},"undo_until":{"format":"date-time","type":["string","null"]},"undoable":{"description":"True while the restore can be undone by restoring its safety snapshot.","type":"boolean"}},"required":["id","mode","mode_label","status","status_label","steps","outcome","needs_recovery","snapshot","safety_snapshot","error","requested_by","created_at","completed_at"],"type":"object"},"RestoreRecordedKind":{"description":"The kind of target a restore was made into. A restore stays listed as it was made, so this names every kind\nthe product has in every state; what you can start now is what the preview answers as available.\n","enum":["in_place","new_environment","existing_environment","production","new_site"],"type":"string"},"RestoreSanitiseLevel":{"description":"The safety measures applied to the data. `safety` is the standard set for a copy; null when unknown.","enum":["none","safety",null],"type":["string","null"]},"RestoreScope":{"description":"What is restored. `files` and `database` restore only that part.","enum":["everything","files","database"],"type":"string"},"RestoreStatus":{"description":"Where a restore is: `safety_snapshot`, `holding`, `stopping`, `copying`, `rolling_back`, `restarting`,\n`starting`, then `completed` or `failed`.\n","enum":["safety_snapshot","holding","stopping","copying","rolling_back","restarting","starting","completed","failed"],"type":"string"},"RuntimeAdoptRequest":{"additionalProperties":true,"properties":{"apply":{"$ref":"#/components/schemas/ApplyChoice","description":"`now` (the default) or `tonight`; `window` means `tonight` while maintenance windows are on for your company."}},"type":"object"},"RuntimeAdoption":{"additionalProperties":true,"description":"The answer to moving a site onto the runtime.","properties":{"adoption":{"$ref":"#/components/schemas/RuntimeAdoptionState"},"item_id":{"minimum":1,"type":["integer","null"]},"operation":{"additionalProperties":true,"description":"The operation that moves the site: read it by its `id` with `GET /corestack/operations/{operation}`. It is the operation of the site's window, so its `scope` is `batch`. Null when the move was queued.","properties":{"id":{"minimum":1,"type":"integer"},"status":{"$ref":"#/components/schemas/OperationStatus"},"type":{"type":"string"}},"type":["object","null"]},"queued":{"const":true,"description":"Sent only when the move waits for the site's window.","type":"boolean"},"window":{"oneOf":[{"$ref":"#/components/schemas/QueuedWindow"},{"type":"null"}]},"window_date":{"description":"The date of the window the move waits for. Null when no window has been set for it yet.","type":["string","null"]}},"required":["operation","adoption"],"type":"object"},"RuntimeAdoptionRefusal":{"additionalProperties":true,"properties":{"adoption":{"$ref":"#/components/schemas/RuntimeAdoptionState"},"code":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}},"required":["message","reason","code"],"type":"object"},"RuntimeAdoptionState":{"additionalProperties":true,"description":"Whether a site is on the runtime, and whether it can move onto it.","properties":{"adopt_now_refusal":{"description":"Why the site cannot move at once, when it cannot.","type":["string","null"]},"adopted":{"description":"True when the site is on the runtime.","type":"boolean"},"can_adopt_now":{"type":"boolean"},"can_adopt_tonight":{"type":"boolean"},"in_progress":{"type":"boolean"},"planned_for":{"description":"The date Corefinity plans to move the site, if one is set.","type":["string","null"]},"queued_for":{"description":"The date of the window the move is queued for, if it is queued.","type":["string","null"]},"revision":{"description":"The runtime revision the site is on, such as `v1`. Null until it is on the runtime.","type":["string","null"]}},"required":["adopted","revision","queued_for","planned_for","in_progress","can_adopt_now","adopt_now_refusal","can_adopt_tonight"],"type":"object"},"RuntimeMariadbVersionChangeRequest":{"additionalProperties":true,"properties":{"apply":{"$ref":"#/components/schemas/ApplyChoice"},"to":{"description":"The MariaDB version to move to, as major and minor.","maxLength":8,"type":"string"}},"required":["to"],"type":"object"},"RuntimeNodeCachesClearRequest":{"additionalProperties":false,"properties":{"which":{"description":"The caches to clear, each once. Left out, all four are cleared.","items":{"enum":["npm","corepack","pnpm","yarn"],"type":"string"},"type":"array","uniqueItems":true}},"type":"object"},"RuntimeNodeCachesCleared":{"properties":{"cleared":{"properties":{"corepack_bytes":{"type":"integer"},"npm_bytes":{"type":"integer"},"pnpm_bytes":{"type":"integer"},"yarn_bytes":{"type":"integer"}},"required":["npm_bytes","corepack_bytes","pnpm_bytes","yarn_bytes"],"type":"object"}},"required":["cleared"],"type":"object"},"RuntimeNodeCatalogue":{"additionalProperties":true,"properties":{"curated":{"description":"Packages suggested as quick picks.","items":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"required":["name","description"],"type":"object"},"type":"array"},"default_for_new":{"description":"The version a new site starts on.","type":["integer","null"]},"limits":{"properties":{"max_packages":{"type":"integer"}},"required":["max_packages"],"type":"object"},"majors":{"items":{"$ref":"#/components/schemas/RuntimeNodeOption"},"type":"array"}},"required":["majors","default_for_new","curated","limits"],"type":"object"},"RuntimeNodeOption":{"additionalProperties":true,"description":"A Node.js version.","properties":{"arrives_with":{"description":"What brings the version to the site when it is not there yet. Null when it is."},"available_on_this_row":{"description":"Whether the site, or a new site, has this version to hand.","type":"boolean"},"codename":{"type":["string","null"]},"default_for_new":{"type":"boolean"},"end_of_life_on":{"type":["string","null"]},"label":{"type":"string"},"major":{"type":"integer"},"needs_ack":{"description":"What `acknowledge` must carry to choose it, such as `eol`.","items":{"type":"string"},"type":"array"},"reason":{"description":"Why it cannot be chosen, when it cannot.","type":["string","null"]},"recommended":{"type":"boolean"},"selectable":{"description":"Whether it can be chosen.","type":"boolean"},"status":{"description":"Such as `active_lts`, `maintenance_lts` or `end_of_life`.","type":"string"}},"required":["major","label","status","codename","end_of_life_on","selectable","reason","needs_ack","recommended","default_for_new","available_on_this_row","arrives_with"],"type":"object"},"RuntimeNodePackage":{"additionalProperties":true,"description":"A global package of the site.","properties":{"advisories":{"additionalProperties":true,"description":"The security advisories of the last check, by severity.","properties":{"critical":{"type":"integer"},"high":{"type":"integer"}},"type":"object"},"bins":{"description":"The commands the installed package provides.","items":{"type":"string"},"type":"array"},"error":{"description":"What went wrong when the package failed to install (`message`, `tail`). Null otherwise.","type":["object","null"]},"has_install_script":{"description":"Null when the registry has not been asked.","type":["boolean","null"]},"installed_version":{"type":["string","null"]},"latest":{"description":"The newest version on the registry at the last check, which may be outside the selector.","type":["string","null"]},"name":{"type":"string"},"origin":{"description":"Where the line comes from. `panel` for one saved here or in the Control Panel.","type":"string"},"resolved":{"description":"The version the selector is pinned to.","type":["string","null"]},"scripts":{"description":"Whether the package's install scripts run.","type":"boolean"},"selector":{"description":"The version, range or tag asked for.","type":["string","null"]},"state":{"description":"`installed`, `installing`, `failed` or `pending`.","type":"string"},"update_available":{"type":"boolean"},"wanted":{"description":"The newest version within the selector at the last check.","type":["string","null"]}},"required":["name","selector","resolved","origin","scripts","state","installed_version","latest","wanted","update_available","advisories","error","has_install_script","bins"],"type":"object"},"RuntimeNodePackageLine":{"additionalProperties":false,"properties":{"name":{"description":"The package's name on the public npm registry, with its `@scope/` when it has one: lower-case letters,\ndigits, `-`, `.`, `_` and `~`, at most 214 characters. Not a URL, a git or GitHub address, a file, a\ntarball or an npm alias. The name and the selector together are at most 255 bytes.\n","maxLength":214,"pattern":"^(?:@[a-z0-9~-][a-z0-9._~-]*/[a-z0-9~-][a-z0-9._~-]*|[a-z0-9~][a-z0-9._~-]*)$","type":"string"},"scripts":{"default":false,"description":"True to run the package's install scripts. Turning it on for a package that does not run them now needs the `exec` scope.","type":"boolean"},"selector":{"description":"A version (`1.93.2`), a range written without spaces (`^1.90`, `>=1.2.0`, `1.x`, `1||2`) or a tag\n(`latest`), at most 64 characters. A range with a space in it, such as `>=1 <2`, is refused\n`package_spec_invalid`. Left out, the newest version is pinned.\n","maxLength":64,"pattern":"^(?:[0-9A-Za-z.^~<>=|*x+-]{1,64}|[a-z][a-z0-9._-]{0,63})$","type":"string"}},"required":["name"],"type":"object"},"RuntimeNodePackageLookup":{"additionalProperties":true,"properties":{"deprecated":{"description":"The deprecation notice, when the version is deprecated.","type":["string","null"]},"description":{"type":["string","null"]},"exists":{"description":"Null when the registry could not be asked.","type":["boolean","null"]},"has_install_script":{"type":["boolean","null"]},"latest":{"type":["string","null"]},"licence":{"type":["string","null"]},"resolved_version":{"description":"The version the selector resolves to now.","type":["string","null"]}},"required":["exists","resolved_version","description","licence","has_install_script","deprecated","latest"],"type":"object"},"RuntimeNodePackagesCheck":{"additionalProperties":true,"properties":{"advisories":{"items":{"additionalProperties":true,"properties":{"installed":{"type":["string","null"]},"name":{"type":"string"},"severity":{"type":"string"},"title":{"type":["string","null"]},"url":{"type":["string","null"]}},"required":["name","installed","severity","title","url"],"type":"object"},"type":"array"},"audit":{"description":"`ok` when the advisories could be read.","type":"string"},"outdated":{"description":"The packages with a newer version.","items":{"additionalProperties":true,"properties":{"latest":{"description":"The newest version on the registry.","type":["string","null"]},"name":{"type":"string"},"resolved":{"type":["string","null"]},"selector":{"type":["string","null"]},"wanted":{"description":"The newest version within the selector.","type":["string","null"]}},"required":["name","selector","resolved","wanted","latest"],"type":"object"},"type":"array"},"read_at":{"format":"date-time","type":"string"}},"required":["outdated","advisories","audit","read_at"],"type":"object"},"RuntimeNodeRuntime":{"additionalProperties":true,"description":"A site's Node.js configuration.","properties":{"adopted":{"type":"boolean"},"adoption":{"$ref":"#/components/schemas/RuntimeAdoptionState"},"apply":{"additionalProperties":true,"description":"The Node.js change still running, what the site refused in the last one, and a change waiting for the window.","properties":{"error":{"type":["object","null"]},"operation":{"oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"pending_tonight":{"description":"The `window_date` and `item_id` of a change that waits for the site's window.","type":["object","null"]}},"required":["operation","error","pending_tonight"],"type":"object"},"caches":{"description":"The size of each package cache (`npm_bytes`, `corepack_bytes`, `pnpm_bytes`, `yarn_bytes`) and when it was measured. Null until the site has reported them.","type":["object","null"]},"follow_repository":{"description":"True when each deployment switches to the version the repository asks for.","type":"boolean"},"last_applied_at":{"format":"date-time","type":["string","null"]},"limits":{"properties":{"max_packages":{"type":"integer"}},"required":["max_packages"],"type":"object"},"locked":{"description":"Set when Corefinity has locked the site's Node.js configuration, with the `reason`. Null otherwise.","type":["object","null"]},"major":{"description":"The Node.js version the site is set to.","type":["integer","null"]},"memory":{"description":"The memory of the site's command line (`cli_limit_bytes`) and Node.js's heap (`heap_mib`). Null until the site has reported them.","type":["object","null"]},"options":{"description":"The versions the site may move to.","items":{"$ref":"#/components/schemas/RuntimeNodeOption"},"type":"array"},"packages":{"items":{"$ref":"#/components/schemas/RuntimeNodePackage"},"type":"array"},"repository":{"description":"What the repository asks for (`source`, `raw`, `majors`, `satisfied`, `read_at`), when it has been read. Null otherwise.","type":["object","null"]},"revision":{"description":"The write token. Send it back with every change; a change made since your read is refused `stale`.","type":"integer"},"status":{"description":"The lifecycle of the site's version (`key`, `label`, `end_of_life_on`).","type":["object","null"]},"unmanaged":{"description":"Global packages found on the site that were installed by hand, by name.","items":{"type":"string"},"type":"array"},"version":{"description":"The full version the site reports, when it has reported one.","type":["string","null"]}},"required":["adopted","adoption","locked","revision","major","version","status","options","packages","unmanaged","limits","follow_repository","repository","caches","memory","apply","last_applied_at"],"type":"object"},"RuntimeNodeRuntimeChange":{"additionalProperties":true,"description":"The answer to a change of the Node.js configuration.","properties":{"item_id":{"minimum":1,"type":["integer","null"]},"node_runtime":{"$ref":"#/components/schemas/RuntimeNodeRuntime"},"operation":{"description":"The operation that applies the change. Null when nothing differs, when only follow mode changed and when the change was queued.","oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"queued":{"const":true,"description":"Sent only when the change waits for the site's window.","type":"boolean"},"warnings":{"items":{"$ref":"#/components/schemas/Warning"},"type":"array"},"window":{"description":"Sent only with `queued`, while maintenance windows are on for your company.","oneOf":[{"$ref":"#/components/schemas/QueuedWindow"},{"type":"null"}]},"window_date":{"type":"string"}},"required":["node_runtime","operation","warnings"],"type":"object"},"RuntimeNodeRuntimeCopy":{"additionalProperties":true,"properties":{"changes":{"items":{"additionalProperties":true,"properties":{"operation":{"oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"refused":{"description":"What this target refused. `part` names the part left out; it is null when the whole target refused.","oneOf":[{"additionalProperties":true,"properties":{"message":{"type":"string"},"part":{"type":["string","null"]},"reason":{"type":"string"}},"required":["part","reason","message"],"type":"object"},{"type":"null"}]},"site_id":{"minimum":1,"type":"integer"},"warnings":{"items":{"$ref":"#/components/schemas/Warning"},"type":"array"}},"required":["site_id","operation","warnings","refused"],"type":"object"},"type":"array"}},"required":["changes"],"type":"object"},"RuntimeNodeRuntimeCopyRequest":{"additionalProperties":false,"properties":{"acknowledge":{"description":"`eol` when the version copied is past its end of life.","items":{"enum":["eol"],"type":"string"},"type":"array"},"confirm_production":{"default":false,"description":"Must be true when a target is production.","type":"boolean"},"parts":{"description":"What to copy.","items":{"enum":["version","packages","follow_repository"],"type":"string"},"minItems":1,"type":"array","uniqueItems":true},"targets":{"description":"The ids of the environments to copy to, each once. Each must be another environment of this site that you may change.","items":{"minimum":1,"type":"integer"},"maxItems":20,"minItems":1,"type":"array","uniqueItems":true}},"required":["targets","parts"],"type":"object"},"RuntimeNodeRuntimeUpdateRequest":{"additionalProperties":false,"description":"What to change. No other key is accepted.","properties":{"acknowledge":{"description":"`eol` for a version past its end of life.","items":{"enum":["eol"],"type":"string"},"type":"array"},"apply":{"$ref":"#/components/schemas/ApplyChoice"},"follow_repository":{"type":"boolean"},"keep_legacy_tools":{"default":true,"description":"When leaving Node.js 16, keep the tools that came with it as packages.","type":"boolean"},"major":{"description":"The Node.js version to move to. The packages are installed again for it at their pinned versions.","type":"integer"},"packages":{"description":"The full list of global packages. A package left out is removed.","items":{"$ref":"#/components/schemas/RuntimeNodePackageLine"},"maxItems":20,"type":"array"},"revision":{"description":"The `revision` of your last read.","minimum":0,"type":"integer"},"update":{"description":"Names of listed packages to look up again for a newer version within their selector.","items":{"type":"string"},"type":"array"}},"required":["revision"],"type":"object"},"RuntimePhpCatalogue":{"additionalProperties":true,"properties":{"builtin":{"description":"The extensions built into PHP, by name. They are always loaded.","items":{"type":"string"},"type":"array"},"directives":{"additionalProperties":{"additionalProperties":true,"properties":{"access":{"description":"`all`, `perdir`, `system` or `user`.","type":"string"},"default":{"type":["string","null"]},"extension":{"type":["string","null"]}},"type":"object"},"description":"Every php.ini directive of this version, with its `default`, where it may be set (`access`) and the `extension` it belongs to.","type":"object"},"eol_date":{"type":["string","null"]},"examples":{"description":"Example php.ini text.","items":{"additionalProperties":true,"properties":{"description":{"type":"string"},"key":{"type":"string"},"text":{"type":"string"},"title":{"type":"string"}},"required":["key","title","description","text"],"type":"object"},"type":"array"},"extensions":{"items":{"additionalProperties":true,"properties":{"always_on":{"type":"boolean"},"available":{"type":"boolean"},"baseline_for":{"description":"Platforms whose new sites start with it on.","items":{"type":"string"},"type":"array"},"conflicts":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"docs_url":{"type":["string","null"]},"group":{"type":"string"},"kind":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"non_production_only":{"type":"boolean"},"recommended_for":{"description":"Platforms it is recommended for.","items":{"type":"string"},"type":"array"},"required_by":{"description":"Platforms that need it.","items":{"type":"string"},"type":"array"},"requires":{"description":"Extensions it needs on as well.","items":{"type":"string"},"type":"array"},"unavailable_reason":{"type":["string","null"]},"version":{"type":["string","null"]}},"required":["name","label","group","description","kind","version","available","unavailable_reason","requires","required_by","recommended_for","baseline_for","always_on","non_production_only","conflicts"],"type":"object"},"type":"array"},"php_version":{"description":"The full version, such as `8.4.9`.","type":["string","null"]},"presets":{"description":"Sets of directives to apply together.","items":{"additionalProperties":true,"properties":{"available":{"type":"boolean"},"directives":{"type":["object","array"]},"git_mode_note":{"type":["string","null"]},"git_mode_only":{"type":["object","array"]},"key":{"type":"string"},"label":{"type":"string"},"reason":{"type":["string","null"]},"xdebug":{"type":"boolean"}},"required":["key","label","directives","available"],"type":"object"},"type":"array"},"status":{"description":"Such as `supported`, `security` or `eol`.","type":"string"},"tools":{"items":{"$ref":"#/components/schemas/RuntimePhpTool"},"type":"array"},"unavailable":{"description":"Extensions this version cannot offer, each with the reason. An empty list when there is none.","type":["object","array"]},"version":{"type":"string"}},"required":["version","status","eol_date","php_version","extensions","builtin","unavailable","tools","directives","presets","examples"],"type":"object"},"RuntimePhpCustomIni":{"additionalProperties":true,"description":"The site's custom php.ini.","properties":{"banner":{"description":"The lines the Control Panel writes at the top of the file.","items":{"type":"string"},"type":"array"},"bytes":{"description":"The size of the file as it is stored, the banner included.","type":"integer"},"content":{"description":"The text, exactly as it was saved. Empty when there is none.","type":"string"},"lines":{"type":"integer"},"max_bytes":{"type":"integer"},"overrides":{"description":"The settings form directives the php.ini sets, with the line that sets each.","items":{"properties":{"directive":{"type":"string"},"line":{"type":"integer"}},"required":["directive","line"],"type":"object"},"type":"array"}},"required":["content","bytes","lines","max_bytes","banner","overrides"],"type":"object"},"RuntimePhpEffective":{"additionalProperties":true,"properties":{"cli":{"$ref":"#/components/schemas/RuntimePhpEffectiveSide","description":"The command line, measured on the site."},"fpm":{"$ref":"#/components/schemas/RuntimePhpEffectiveSide","description":"The web side. Every value is calculated."},"read_at":{"format":"date-time","type":"string"},"tools":{"items":{"properties":{"name":{"type":"string"},"version":{"type":["string","null"]}},"required":["name","version"],"type":"object"},"type":"array"},"user_ini":{"description":"The `.user.ini` in the site's document root, and what each of its lines does.","properties":{"lines":{"description":"Each line with its `directive`, `value`, whether it is `effective` and `why`.","items":{"additionalProperties":true,"type":"object"},"type":"array"},"path":{"description":"Where the file is, from the site's folder. Null, with no `lines`, when the site's document root could not be worked out from how its files are laid out.","type":["string","null"]}},"required":["path","lines"],"type":"object"}},"required":["read_at","fpm","cli","user_ini","tools"],"type":"object"},"RuntimePhpEffectiveSide":{"additionalProperties":true,"description":"PHP as one side runs it.","properties":{"extensions":{"items":{"properties":{"name":{"type":"string"},"version":{"type":["string","null"]}},"required":["name","version"],"type":"object"},"type":"array"},"ini":{"items":{"additionalProperties":true,"properties":{"layer":{"description":"Where the value comes from, such as `form`, `ini`, `pool`, `platform` or `image`.","type":"string"},"masked":{"description":"True when the value is hidden because the directive holds a secret.","type":"boolean"},"measured":{"description":"True when the value was read from the running PHP, false when it was calculated.","type":"boolean"},"name":{"type":"string"},"set":{"description":"Sent for a masked directive, to say whether it has a value.","type":"boolean"},"value":{"type":["string","null"]}},"required":["name","value","layer","measured"],"type":"object"},"type":"array"},"php_version":{"type":["string","null"]}},"required":["php_version","extensions","ini"],"type":"object"},"RuntimePhpExtension":{"additionalProperties":true,"description":"An optional extension as it stands on the site.","properties":{"available":{"type":"boolean"},"conflicts":{"description":"Extensions that cannot be on at the same time.","items":{"type":"string"},"type":"array"},"description":{"type":"string"},"docs_url":{"type":["string","null"]},"enabled":{"type":"boolean"},"group":{"type":"string"},"kind":{"description":"`extension` or `zend_extension`.","type":"string"},"label":{"type":"string"},"locked":{"description":"True when the platform keeps it on or off for this site.","type":"boolean"},"locked_reason":{"type":["string","null"]},"name":{"description":"The name a change sends in `extensions`.","type":"string"},"non_production_only":{"type":"boolean"},"recommended":{"type":"boolean"},"required_by_app":{"description":"True when the application's requirements name it.","type":"boolean"},"so":{"type":["string","null"]},"version":{"type":["string","null"]}},"required":["name","label","group","description","kind","version","available","enabled","locked","locked_reason","recommended","required_by_app","non_production_only","conflicts"],"type":"object"},"RuntimePhpFpm":{"additionalProperties":true,"description":"PHP-FPM as it applies to the site. A null value is inherited from the platform.","properties":{"bounds":{"additionalProperties":true,"description":"The values `pm` may take, and the range of `max_requests` and `process_idle_timeout`.","type":"object"},"live":{"description":"The pool's figures when they were last read (`active`, `idle`, `max_children_reached`, `read_at`), or null.","type":["object","null"]},"max_children":{"description":"Set by the site's size; it cannot be changed here.","type":["integer","null"]},"max_requests":{"type":["integer","null"]},"pm":{"description":"`dynamic`, `ondemand` or `static`.","type":["string","null"]},"process_idle_timeout":{"description":"Seconds. Applies only with `pm` `ondemand`.","type":["integer","null"]},"source":{"additionalProperties":{"type":"string"},"description":"Where each value comes from, such as `platform`, `site` or `package`.","type":"object"}},"required":["pm","max_requests","process_idle_timeout","max_children","source","bounds"],"type":"object"},"RuntimePhpHistory":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"additionalProperties":true,"properties":{"revisions":{"items":{"additionalProperties":true,"properties":{"actor":{"additionalProperties":true,"description":"Who made the change.","properties":{"kind":{"description":"`user`, `mcp_token`, `oauth` or `corefinity`.","type":"string"},"name":{"description":"Not sent for `corefinity`.","type":["string","null"]}},"required":["kind"],"type":"object"},"at":{"type":["string","null"]},"current":{"description":"True for the configuration the site has now.","type":"boolean"},"revision":{"type":"integer"},"source":{"description":"How the change was made, such as `baseline`, `panel` (the Control Panel or this API), `mcp`, `copy`, `revert` or `version_change`.","type":"string"},"status":{"description":"`applied`, `applying`, `failed` or `unconfirmed`.","type":"string"},"summary":{"type":["string","null"]}},"required":["revision","at","actor","source","summary","status","current"],"type":"object"},"type":"array"}},"required":["revisions"],"type":"object"}]},"RuntimePhpIniCheck":{"additionalProperties":true,"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/RuntimePhpIniDiagnostic"},"type":"array"},"effective":{"description":"Each directive the php.ini sets, with its value before and after.","items":{"additionalProperties":true,"properties":{"after":{"type":["string","null"]},"before":{"type":["string","null"]},"directive":{"type":"string"},"layer":{"description":"Where the value before comes from, such as `custom`, `setting`, `platform` or `image`.","type":"string"}},"required":["directive","before","after","layer"],"type":"object"},"type":"array"},"ok":{"description":"False when a diagnostic is an error.","type":"boolean"}},"required":["ok","diagnostics","effective"],"type":"object"},"RuntimePhpIniCheckRequest":{"additionalProperties":false,"properties":{"custom_ini":{"description":"The php.ini text to check.","type":"string"},"extensions":{"description":"Draft extensions to check it against.","items":{"type":"string"},"type":"array"},"settings":{"additionalProperties":{"type":["integer","string","boolean","null"]},"description":"Draft settings to check it against, as a change sends them.","type":"object"}},"required":["custom_ini"],"type":"object"},"RuntimePhpIniDiagnostic":{"additionalProperties":true,"description":"One finding about a php.ini. Lines and columns count from 1 and match the text sent, blank lines included.","properties":{"code":{"description":"Such as `locked` for a directive the platform keeps fixed.","type":"string"},"column":{"type":"integer"},"end_column":{"type":"integer"},"line":{"type":"integer"},"message":{"type":"string"},"severity":{"description":"`error` or `warning`.","type":"string"}},"required":["line","severity","code","message"],"type":"object"},"RuntimePhpIniTest":{"additionalProperties":true,"properties":{"completed":{"description":"True when PHP started with the candidate.","type":"boolean"},"effective":{"description":"The value PHP took for each directive the candidate sets.","items":{"additionalProperties":true,"properties":{"directive":{"type":"string"},"measured":{"description":"False for a directive the test switches off, whose value is the configured one.","type":"boolean"},"value":{"type":["string","null"]}},"required":["directive","value","measured"],"type":"object"},"type":"array"},"startup":{"description":"The warnings and errors PHP printed as it started.","items":{"type":"string"},"type":"array"}},"required":["completed","startup","effective"],"type":"object"},"RuntimePhpIniTestRequest":{"additionalProperties":false,"properties":{"custom_ini":{"description":"The php.ini text to test.","type":"string"},"extensions":{"description":"Draft extensions to test it with.","items":{"type":"string"},"type":"array"},"settings":{"additionalProperties":{"type":["integer","string","boolean","null"]},"description":"Draft settings to test it with, as a change sends them.","type":"object"}},"required":["custom_ini"],"type":"object"},"RuntimePhpInvalidRefusal":{"additionalProperties":true,"description":"A PHP change, check or copy that is not valid. Unlike other endpoints, `errors` is a list: every refused field\nwith its own `code`. `diagnostics` carries the php.ini's findings when it was checked. With `reason`\n`ini_invalid`, only the php.ini is wrong and `errors` is empty.\n","properties":{"code":{"enum":["invalid","ini_invalid"],"type":"string"},"diagnostics":{"items":{"$ref":"#/components/schemas/RuntimePhpIniDiagnostic"},"type":"array"},"errors":{"items":{"properties":{"code":{"description":"Such as `invalid`, `bounds`, `setting_unknown`, `extension_unknown` or `non_production_only`.","type":"string"},"field":{"description":"The body key, `settings.<directive>`, `fpm.<setting>`, `xdebug` or `extensions`.","type":"string"},"message":{"type":"string"}},"required":["field","code","message"],"type":"object"},"type":"array"},"field":{"description":"The first refused field. Not sent with `ini_invalid`.","type":"string"},"message":{"type":"string"},"reason":{"enum":["invalid","ini_invalid"],"type":"string"}},"required":["message","reason","code","errors","diagnostics"],"type":"object"},"RuntimePhpRequirements":{"additionalProperties":true,"description":"What the application asks of PHP, as last read from the site.","properties":{"application":{"properties":{"name":{"type":["string","null"]},"version":{"type":["string","null"]}},"required":["name","version"],"type":"object"},"ext":{"properties":{"by":{"description":"For an extension, the packages that ask for it. An empty list when none is recorded.","type":["object","array"]},"required":{"description":"The extensions the application needs, as `ext-<name>`.","items":{"type":"string"},"type":"array"}},"required":["required","by"],"type":"object"},"missing_extensions":{"description":"The required extensions that are not loaded on the site, by name.","items":{"type":"string"},"type":"array"},"outside_range":{"description":"True when the site's PHP version is outside the range the application accepts.","type":"boolean"},"php":{"properties":{"constraint":{"description":"The PHP range the application names, such as `>=8.2`.","type":["string","null"]},"packages":{"description":"The packages that name a PHP range of their own, each with `name`, `version` and `constraint`.","items":{"additionalProperties":true,"type":"object"},"type":"array"},"range":{"description":"The PHP versions on offer that satisfy every range the application carries.","type":["string","null"]}},"required":["constraint","range","packages"],"type":"object"},"read_at":{"format":"date-time","type":["string","null"]},"source":{"description":"`deploy` (read from a deployment) or `probe` (read from the running site). Null before the first read.","type":["string","null"]}},"required":["source","read_at","application","php","ext","missing_extensions","outside_range"],"type":"object"},"RuntimePhpRevision":{"additionalProperties":true,"properties":{"revision":{"type":"integer"},"state":{"additionalProperties":true,"description":"The configuration, in the units a change sends.","properties":{"custom_ini":{"type":["string","null"]},"extensions":{"items":{"type":"string"},"type":"array"},"fpm":{"additionalProperties":true,"properties":{"max_requests":{"type":["integer","null"]},"pm":{"type":["string","null"]},"process_idle_timeout":{"type":["integer","null"]}},"type":"object"},"settings":{"description":"Each directive the change set and its value. A directive that was not set is absent.","type":["object","array"]},"xdebug":{"type":["object","null"]}},"required":["extensions","settings","fpm","custom_ini"],"type":"object"}},"required":["revision","state"],"type":"object"},"RuntimePhpRuntime":{"additionalProperties":true,"description":"A site's PHP configuration.","properties":{"adopted":{"description":"True when the site is on the runtime. Extensions, the full settings form, PHP-FPM, Xdebug and the php.ini need it.","type":"boolean"},"adoption":{"$ref":"#/components/schemas/RuntimeAdoptionState"},"apply":{"additionalProperties":true,"description":"The PHP change still running, and the error of the last one that failed.","properties":{"error":{"type":["string","null"]},"operation":{"description":"The PHP change still running, in short. Null when none is.","oneOf":[{"additionalProperties":true,"properties":{"id":{"minimum":1,"type":"integer"},"status":{"$ref":"#/components/schemas/OperationStatus"},"status_label":{"type":"string"},"summary":{"type":["string","null"]},"to_version":{"type":["string","null"]},"type":{"type":"string"},"type_label":{"type":"string"}},"required":["id","type","type_label","status","status_label","summary","to_version"],"type":"object"},{"type":"null"}]},"pending_tonight":{"description":"Always null at present."}},"required":["operation","error"],"type":"object"},"custom_ini":{"$ref":"#/components/schemas/RuntimePhpCustomIni"},"extensions":{"description":"Empty when the site's PHP version has no catalogue.","items":{"$ref":"#/components/schemas/RuntimePhpExtension"},"type":"array"},"fpm":{"$ref":"#/components/schemas/RuntimePhpFpm"},"image":{"additionalProperties":true,"description":"The PHP the site runs.","properties":{"line":{"description":"`new` for the runtime's PHP, `legacy` for the earlier one.","type":"string"},"minor":{"description":"Such as `8.4`.","type":["string","null"]},"patch":{"description":"The full version, such as `8.4.9`, when it is known.","type":["string","null"]}},"required":["line","minor","patch"],"type":"object"},"last_applied_at":{"format":"date-time","type":["string","null"]},"locked":{"description":"Set when Corefinity has locked the site's PHP configuration, with the `reason`. Null otherwise.","oneOf":[{"additionalProperties":true,"properties":{"reason":{"type":["string","null"]}},"required":["reason"],"type":"object"},{"type":"null"}]},"requirements":{"description":"What the application asks of PHP, as it was last stored. Null before the first read. `GET …/php-runtime/requirements` answers it with what is missing.","type":["object","null"]},"role":{"description":"The environment's role, such as `production` or `staging`.","type":"string"},"settings":{"properties":{"fields":{"description":"The settings form. A site that is not on the runtime has only memory limit, upload size and execution time.","items":{"$ref":"#/components/schemas/RuntimePhpSettingField"},"type":"array"},"legacy":{"description":"What `GET /corestack/sites/{site}/php-settings` answers. Null for a site with a custom size.","oneOf":[{"$ref":"#/components/schemas/RuntimePhpSettings"},{"type":"null"}]},"shm":{"description":"The shared memory OPcache, its JIT and APCu may use together (`cap_mb`, and that as a `percent` of PHP's memory). Null for a site that is not on the runtime.","type":["object","null"]}},"required":["fields","legacy","shm"],"type":"object"},"tools":{"items":{"$ref":"#/components/schemas/RuntimePhpTool"},"type":"array"},"version":{"description":"The write token. Send it back with every change; a change made since your read is refused `stale`.","type":"integer"},"versions":{"items":{"$ref":"#/components/schemas/RuntimePhpVersionOption"},"type":"array"},"warnings":{"items":{"$ref":"#/components/schemas/Warning"},"type":"array"},"xdebug":{"description":"Null on production and on a site that is not on the runtime.","oneOf":[{"$ref":"#/components/schemas/RuntimePhpXdebug"},{"type":"null"}]}},"required":["version","adopted","adoption","image","locked","role","versions","extensions","settings","fpm","xdebug","custom_ini","warnings","tools","requirements","apply","last_applied_at"],"type":"object"},"RuntimePhpRuntimeChange":{"additionalProperties":true,"description":"The answer to a change of the PHP configuration.","properties":{"adopting":{"description":"True when the change also moves the site onto the runtime.","type":"boolean"},"item_id":{"description":"The id of the pending change. Sent only with `queued`.","minimum":1,"type":["integer","null"]},"operation":{"description":"The operation that applies the change. Null when nothing differs and when the change was queued.","oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"php_runtime":{"$ref":"#/components/schemas/RuntimePhpRuntime"},"queued":{"const":true,"description":"Sent only when the change waits for the site's window.","type":"boolean"},"warnings":{"items":{"$ref":"#/components/schemas/Warning"},"type":"array"},"window":{"description":"The window the change waits for. Sent only with `queued`, while maintenance windows are on for your company.","oneOf":[{"$ref":"#/components/schemas/QueuedWindow"},{"type":"null"}]},"window_date":{"description":"The date of the window the change waits for. Sent only with `queued`.","type":"string"}},"required":["php_runtime","operation","adopting","warnings"],"type":"object"},"RuntimePhpRuntimeCopy":{"additionalProperties":true,"properties":{"changes":{"items":{"additionalProperties":true,"properties":{"adopting":{"type":"boolean"},"item_id":{"minimum":1,"type":["integer","null"]},"operation":{"description":"The operation that applies the copy on this target. Null when nothing differs, when it was queued and when the target refused.","oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"queued":{"const":true,"type":"boolean"},"refused":{"description":"Why this target refused, with the `status` a change of it would answer. Null when it did not.","oneOf":[{"additionalProperties":true,"properties":{"message":{"type":"string"},"reason":{"type":["string","null"]},"status":{"type":"integer"}},"required":["status","reason","message"],"type":"object"},{"type":"null"}]},"site_id":{"minimum":1,"type":"integer"},"warnings":{"items":{"$ref":"#/components/schemas/Warning"},"type":"array"},"window":{"oneOf":[{"$ref":"#/components/schemas/QueuedWindow"},{"type":"null"}]},"window_date":{"type":"string"}},"required":["site_id","operation","adopting","warnings","refused"],"type":"object"},"type":"array"}},"required":["changes"],"type":"object"},"RuntimePhpRuntimeCopyRequest":{"additionalProperties":false,"properties":{"apply":{"$ref":"#/components/schemas/ApplyChoice"},"confirm_production":{"default":false,"description":"Must be true when a target is production.","type":"boolean"},"parts":{"description":"What to copy. `ini` is the custom php.ini.","items":{"enum":["extensions","settings","fpm","ini"],"type":"string"},"minItems":1,"type":"array","uniqueItems":true},"targets":{"description":"The ids of the environments to copy to, each once. Each must be another environment of this site that you may change.","items":{"minimum":1,"type":"integer"},"maxItems":20,"minItems":1,"type":"array","uniqueItems":true}},"required":["targets","parts"],"type":"object"},"RuntimePhpRuntimeRevertRequest":{"additionalProperties":false,"properties":{"apply":{"$ref":"#/components/schemas/ApplyChoice"},"revision":{"description":"The number of the change to restore, as the history lists it.","minimum":1,"type":"integer"},"version":{"description":"The `version` of your last read of the PHP configuration.","minimum":0,"type":"integer"}},"required":["version","revision"],"type":"object"},"RuntimePhpRuntimeUpdateRequest":{"additionalProperties":false,"description":"The parts of the PHP configuration to change. No other key is accepted.","properties":{"apply":{"$ref":"#/components/schemas/ApplyChoice"},"custom_ini":{"description":"The whole custom php.ini, saved exactly as sent. An empty string removes it.","type":["string","null"]},"extensions":{"description":"Every optional extension to load, by name. An empty list turns them all off.","items":{"type":"string"},"type":"array"},"fpm":{"additionalProperties":false,"description":"PHP-FPM settings, merged into the ones the site has: a setting you leave out keeps its value, and null\nputs one back to the platform's value. Each setting has two spellings that mean the same.\n","properties":{"max_requests":{"maximum":100000,"minimum":100,"type":["integer","null"]},"pm":{"enum":["dynamic","ondemand","static",null],"type":["string","null"]},"pm.max_requests":{"description":"The same as `max_requests`.","maximum":100000,"minimum":100,"type":["integer","null"]},"pm.process_idle_timeout":{"description":"The same as `process_idle_timeout`. Seconds. Only with `pm` `ondemand`.","maximum":300,"minimum":5,"type":["integer","null"]},"process_idle_timeout":{"description":"Seconds. Only with `pm` `ondemand`.","maximum":300,"minimum":5,"type":["integer","null"]}},"type":"object"},"settings":{"additionalProperties":{"type":["integer","string","boolean","null"]},"description":"Directives of the settings form and their values, merged into the settings the site has: a directive you\nleave out keeps its value. Sizes are whole numbers of bytes. Null puts a directive back to its default,\nexcept `memory_limit`, `upload_max_filesize` and `max_execution_time`, which always have a value: null for\none of those is refused `422` with the code `required`.\n","type":"object"},"version":{"description":"The `version` of your last read.","minimum":0,"type":"integer"},"xdebug":{"description":"Xdebug's set-up, or null to turn it off. Refused on production.","oneOf":[{"properties":{"idekey":{"default":"PHPSTORM","pattern":"^[A-Za-z0-9_.-]{1,64}$","type":"string"},"mode":{"description":"One or more of `develop`, `coverage`, `debug`, `gcstats`, `profile` and `trace`, joined by commas.","type":"string"},"start_with_request":{"default":"trigger","enum":["trigger","yes"],"type":"string"}},"required":["mode"],"type":"object"},{"type":"null"}]}},"required":["version"],"type":"object"},"RuntimePhpSettingBound":{"additionalProperties":true,"description":"One of the three settings with its bounds. Sizes are in bytes, times in seconds.","properties":{"default":{"type":"integer"},"max":{"type":"integer"},"min":{"type":"integer"},"options":{"description":"The only values accepted, when the setting takes a fixed list.","items":{"type":"integer"},"type":"array"},"step":{"type":"integer"},"unit":{"enum":["bytes","seconds"],"type":"string"},"value":{"type":"integer"}},"required":["value","default","min","max","unit","step"],"type":"object"},"RuntimePhpSettingField":{"additionalProperties":true,"description":"One PHP directive of the settings form.","properties":{"bounds":{"additionalProperties":true,"description":"What the value may be. Memory, upload size and execution time carry `default`, `min`, `max`, `unit` (`bytes`\nor `seconds`), `step` and sometimes `options`. Every other directive carries `type` (`size`, `int`, `enum`,\n`bool`, `expr`, `timezone` or `path`) and what that type needs.\n","properties":{"default":{},"max":{"type":"integer"},"min":{"type":"integer"},"options":{"type":"array"},"root":{"type":"string"},"step":{"type":"integer"},"type":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"effective":{"description":"The value in effect.","type":["integer","string","boolean","null"]},"locked":{"type":"boolean"},"locked_reason":{"description":"Such as `production` or `platform`.","type":["string","null"]},"name":{"description":"The directive, as a change sends it in `settings`.","type":"string"},"source":{"description":"Where the value in effect comes from: `site` (set for the site), `ini` (the custom php.ini), `platform`,\n`image` (PHP's own default) or `locked` (kept fixed by the platform).\n","type":"string"},"value":{"description":"The value set for the site. Null when none is set, so the default applies. Sizes are in bytes.","type":["integer","string","boolean","null"]}},"required":["name","value","effective","source","bounds","locked","locked_reason"],"type":"object"},"RuntimePhpSettings":{"additionalProperties":true,"description":"A site's memory limit, upload size and execution time, with the bounds of its platform and size.","properties":{"apply":{"$ref":"#/components/schemas/ApplyState"},"bounds":{"additionalProperties":true,"description":"The bounds of the platform and size, before the site's own values.","type":"object"},"container_memory_limit_bytes":{"description":"The memory PHP has on this site.","type":"integer"},"notes":{"description":"What the environment's creation changed to fit its size, while that still applies. Usually empty.","items":{"properties":{"code":{"description":"Such as `php_settings_clamped`.","type":"string"},"text":{"type":"string"}},"required":["code","text"],"type":"object"},"type":"array"},"php_version":{"type":["string","null"]},"platform":{"type":"string"},"settings":{"properties":{"max_execution_time":{"$ref":"#/components/schemas/RuntimePhpSettingBound"},"memory_limit":{"$ref":"#/components/schemas/RuntimePhpSettingBound"},"post_max_size":{"$ref":"#/components/schemas/RuntimePhpSettingBound","description":"Follows the upload size; it is not set on its own."},"upload_max_filesize":{"$ref":"#/components/schemas/RuntimePhpSettingBound"}},"required":["memory_limit","upload_max_filesize","post_max_size","max_execution_time"],"type":"object"},"tier":{"description":"The site's size.","type":"string"},"version":{"description":"The write token. Send it back with a change.","type":"integer"}},"required":["version","php_version","platform","tier","container_memory_limit_bytes","bounds","settings","apply"],"type":"object"},"RuntimePhpSettingsChange":{"additionalProperties":true,"properties":{"item_id":{"minimum":1,"type":["integer","null"]},"operation":{"description":"The operation that applies the change. Null when nothing differs and when the change was queued.","oneOf":[{"$ref":"#/components/schemas/VersionChangeOperation"},{"type":"null"}]},"php_settings":{"$ref":"#/components/schemas/RuntimePhpSettings"},"queued":{"const":true,"description":"Sent only when the change waits for the site's window.","type":"boolean"},"window":{"description":"Sent only with `queued`, while maintenance windows are on for your company.","oneOf":[{"$ref":"#/components/schemas/QueuedWindow"},{"type":"null"}]},"window_date":{"type":"string"}},"required":["php_settings","operation"],"type":"object"},"RuntimePhpSettingsUpdateRequest":{"additionalProperties":true,"properties":{"apply":{"$ref":"#/components/schemas/ApplyChoice"},"max_execution_time_seconds":{"description":"The execution time in seconds, one of the three on offer (`bounds.max_execution_time.options`).","enum":[60,120,300],"type":"integer"},"memory_limit_bytes":{"description":"The memory limit in bytes, from 128 MiB in steps of 64 MiB. The most this site may have depends on its\nplatform and size, so read `bounds.memory_limit` (`min`, `max`, `step`) from the site's settings first.\n","minimum":134217728,"multipleOf":67108864,"type":"integer"},"upload_max_filesize_bytes":{"description":"The largest upload in bytes, from 2 MiB to 1024 MiB in steps of 1 MiB (`bounds.upload_max_filesize`).","maximum":1073741824,"minimum":2097152,"multipleOf":1048576,"type":"integer"},"version":{"description":"The `version` of your last read.","minimum":0,"type":"integer"}},"required":["version","memory_limit_bytes","upload_max_filesize_bytes","max_execution_time_seconds"],"type":"object"},"RuntimePhpTool":{"additionalProperties":true,"description":"A command-line tool that comes with the PHP version.","properties":{"label":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"purpose":{"type":"string"},"version":{"type":["string","null"]}},"required":["name","version"],"type":"object"},"RuntimePhpVersionChangeRequest":{"additionalProperties":true,"properties":{"acknowledge":{"description":"What the version's `requires_ack` asks you to acknowledge: `eol` (past its end of life), `app_constraint` (outside the range the application accepts), `extensions_off` (extensions the version does not have are turned off) or `ini_incompatible` (lines of the custom php.ini it does not accept).","items":{"enum":["eol","app_constraint","extensions_off","ini_incompatible"],"type":"string"},"maxItems":4,"type":"array","uniqueItems":true},"apply":{"$ref":"#/components/schemas/ApplyChoice"},"to":{"description":"The PHP version to move to, as major and minor.","maxLength":8,"type":"string"}},"required":["to"],"type":"object"},"RuntimePhpVersionOption":{"additionalProperties":true,"description":"A PHP version the site could run.","properties":{"ack_detail":{"description":"A sentence for each entry of `requires_ack`, by its key. An empty list when nothing is asked.","type":["object","array"]},"allowed":{"description":"Whether the site may move to this version.","type":"boolean"},"changes":{"description":"What moving to this version changes besides the version.","items":{"type":"string"},"type":"array"},"current":{"type":"boolean"},"eol_date":{"description":"The day the version stops getting security fixes.","type":["string","null"]},"label":{"type":"string"},"reason":{"description":"Why it is not allowed, when it is not.","type":["string","null"]},"requires_ack":{"description":"What `acknowledge` must carry to move to this version, such as `eol`.","items":{"type":"string"},"type":"array"},"status":{"description":"Such as `supported`, `security` or `eol`.","type":"string"},"version":{"description":"Major and minor, such as `8.4`.","type":"string"}},"required":["version","label","current","allowed","reason","status","eol_date","requires_ack","ack_detail","changes"],"type":"object"},"RuntimePhpXdebug":{"additionalProperties":true,"description":"Xdebug on an environment that is not production.","properties":{"connect":{"description":"How to connect an IDE: the `proxy` address on the environment, the `ssh_command` that opens the tunnel, the port to listen on (`ide_port_suggested`) and the `path_mapping`.","type":["object","null"]},"enabled":{"type":"boolean"},"idekey":{"type":["string","null"]},"mode":{"description":"The modes that are on.","items":{"type":"string"},"type":"array"},"start_with_request":{"type":["string","null"]}},"required":["enabled","mode","start_with_request","idekey","connect"],"type":"object"},"RuntimeSummary":{"additionalProperties":true,"description":"A site's runtime.","properties":{"adopted":{"type":"boolean"},"adoption":{"$ref":"#/components/schemas/RuntimeAdoptionState"},"handover":{"description":"True once sites of this kind can be moved onto the runtime.","type":"boolean"},"hot_apply":{"additionalProperties":{"type":"boolean"},"description":"For `php`, `nginx` and `node`, whether a change applies without waiting for a window.","type":"object"},"images":{"additionalProperties":true,"description":"The versions the site runs.","properties":{"nginx":{"additionalProperties":true,"description":"The nginx `version` and `revision`.","type":"object"},"node_toolchain":{"additionalProperties":true,"description":"The Node.js toolchain `revision`, the `major` in use and its `status`.","type":"object"},"php":{"additionalProperties":true,"description":"The PHP `minor` and `patch` version, the `round` of its build, whether that is the `current` one and the `latest_round`.","type":"object"}},"type":"object"},"last_apply":{"additionalProperties":{"type":["object","null"]},"description":"For `php`, `nginx` and `node`, the last change (`state`, `at`, `reason`), or null before the first.","type":"object"},"new_relic":{"additionalProperties":true,"description":"Whether New Relic is set up on the runtime for this site (`state`, `app`).","type":"object"},"pending":{"description":"What waits for the site's window.","items":{"additionalProperties":true,"properties":{"id":{"minimum":1,"type":"integer"},"kind":{"type":"string"},"label":{"type":["string","null"]},"state":{"type":"string"},"window_date":{"type":["string","null"]}},"required":["id","kind","window_date","state","label"],"type":"object"},"type":"array"},"queued_for":{"description":"The date of the window a move onto the runtime is queued for.","type":["string","null"]},"revision":{"type":["string","null"]},"varnish":{"additionalProperties":true,"description":"The site's Varnish. Sent only for a Magento 2 site, while Varnish is on for your company.","type":"object","x-unverified":true},"window_only":{"description":"True when changes to this site's cluster are made only in its window.","type":"boolean"}},"required":["adopted","revision","queued_for","hot_apply","images","last_apply","pending","adoption"],"type":"object"},"ScopeRequiredRefusal":{"description":"The token does not hold the scope the request needs.","properties":{"code":{"const":"scope_required","type":"string"},"message":{"type":"string"},"reason":{"const":"scope_required","type":"string"},"scope":{"$ref":"#/components/schemas/TokenScope"}},"required":["message","reason","code","scope"],"type":"object"},"SiteAccess":{"allOf":[{"$ref":"#/components/schemas/SiteAccessCore"},{"properties":{"host_keys":{"description":"The host keys the site presents.","properties":{"current":{"items":{"$ref":"#/components/schemas/SshHostKey"},"type":"array"},"managed_by":{"type":["string","null"]},"next":{"description":"The host keys a staged rotation will switch to.","items":{"$ref":"#/components/schemas/SshHostKey"},"type":["array","null"]}},"required":["managed_by","current","next"],"type":"object"},"known_hosts":{"description":"Complete `known_hosts` lines for the site's host keys. Empty when none are recorded.","items":{"type":"string"},"type":"array"},"logins":{"description":"The usernames you can connect with.","properties":{"web":{"properties":{"command":{"type":["string","null"]},"login":{"type":"string"}},"required":["login","command"],"type":"object"},"you":{"description":"Your own username on this environment.","oneOf":[{"$ref":"#/components/schemas/SshYourLogin"},{"type":"null"}]}},"required":["web","you"],"type":"object"},"persons":{"description":"The personal usernames that reach the site, with their keys. Read-only here.","items":{"properties":{"can_change":{"const":false,"type":"boolean"},"can_delete":{"const":false,"type":"boolean"},"keys":{"items":{"$ref":"#/components/schemas/SiteAccessKey"},"type":"array"},"kind":{"const":"person","type":"string"},"login":{"type":"string"},"person":{"oneOf":[{"$ref":"#/components/schemas/SshPerson"},{"type":"null"}]},"you":{"type":"boolean"}},"required":["login","kind","person","you","keys","can_change","can_delete"],"type":"object"},"type":"array"},"ready_lines":{"description":"Ready commands for the built-in `web` user. An empty list while the site has no SSH host or port yet.\n","oneOf":[{"properties":{"rsync":{"description":"Copies the current folder into the site's `htdocs`.","type":"string"},"sftp":{"type":"string"},"ssh":{"type":"string"},"tunnel":{"description":"Opens a tunnel to the database.","type":"string"}},"required":["ssh","sftp","rsync","tunnel"],"type":"object"},{"maxItems":0,"type":"array"}]}},"required":["known_hosts","ready_lines"],"type":"object"}],"description":"A site's or environment's SSH and SFTP access, as `GET /corestack/sites/{site}/access` answers it. `logins`,\n`persons` and `host_keys` are sent while SSH keys are on for your company.\n"},"SiteAccessCore":{"additionalProperties":true,"description":"A site's or environment's SSH and SFTP access, as a change answers it.","properties":{"apply":{"allOf":[{"$ref":"#/components/schemas/ApplyState"}],"description":"Whether the saved users and keys are live on the site."},"company_keys":{"description":"The company keys that can reach the site.","items":{"properties":{"applied_here":{"description":"Whether the key reaches this site.","type":"boolean"},"applies":{"description":"Whether the company key applies to all of the company's sites or to selected ones.","enum":["all","selected"],"type":"string"},"fingerprint":{"type":"string"},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name","fingerprint","applies","applied_here"],"type":"object"},"type":"array"},"connection":{"description":"Where to connect.","properties":{"host":{"description":"The SSH host of the site's cluster. Empty while the site has none yet.","type":"string"},"port":{"description":"The site's or environment's own port.","type":["integer","null"]},"ssh_user":{"description":"The built-in user, `web`.","type":"string"},"tunnel_command":{"description":"An `ssh` command that opens a tunnel to the database on `127.0.0.1:3306` of your machine.","type":"string"}},"required":["host","port","ssh_user","tunnel_command"],"type":"object"},"limits":{"properties":{"company_keys_max":{"type":"integer"},"keys_per_user_max":{"type":"integer"},"root_path_suggestions":{"description":"Folders an SFTP user is often limited to on this kind of site.","items":{"type":"string"},"type":"array"},"users_max":{"description":"The most named users a site can have.","type":"integer"}},"required":["users_max","keys_per_user_max","company_keys_max","root_path_suggestions"],"type":"object"},"terminal":{"description":"Whether the browser terminal can be opened for the site.","properties":{"active_session":{"description":"The open terminal session on the site, when there is one, whoever opened it.","properties":{"id":{"minimum":1,"type":"integer"},"started_at":{"description":"When the session started, in UTC with a `+00:00` offset.","format":"date-time","type":["string","null"]},"user":{"allOf":[{"$ref":"#/components/schemas/PersonRef"}],"description":"Who opened the session. A session Corefinity support opened reads `Corefinity support` with a\nnull id.\n"}},"required":["id","user","started_at"],"type":["object","null"]},"available":{"type":"boolean"},"reason":{"description":"Why not, in plain words.","type":["string","null"]}},"required":["available","reason","active_session"],"type":"object"},"users":{"description":"The built-in `web` user first, then the named users.","items":{"$ref":"#/components/schemas/SiteAccessUser"},"type":"array"}},"required":["connection","users","company_keys","apply","terminal","limits"],"type":"object"},"SiteAccessKey":{"additionalProperties":true,"description":"A public key on one of the site's users. The key itself is never answered, only its fingerprint.","properties":{"added_at":{"type":["string","null"]},"added_by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"bits":{"type":["integer","null"]},"can_delete":{"description":"Whether this endpoint group can remove the key. Other keys are removed where they were added.","type":"boolean"},"comment":{"description":"The comment at the end of the key line, when it had one.","type":["string","null"]},"company_key_id":{"type":["integer","null"]},"fingerprint":{"description":"The SHA-256 fingerprint, as `ssh-keygen -lf` prints it.","type":"string"},"id":{"description":"The id `DELETE /corestack/sites/{site}/access/keys/{key}` takes. 0 for the Corefinity deploy key.","type":"integer"},"name":{"type":"string"},"origin":{"description":"Sent while SSH keys are on for your company. The level the key comes from.","properties":{"layer":{"enum":["agency","company","website","environment","user","legacy","system"],"type":"string"},"owner":{"oneOf":[{"$ref":"#/components/schemas/SshOwner"},{"type":"null"}]}},"required":["layer","owner"],"type":"object"},"restricted":{"description":"True when the key carries restrictions from before it was imported. Only Corefinity changes those.","type":"boolean"},"restrictions":{"items":{"type":"string"},"type":"array"},"source":{"description":"`company` is a company key. `system` is the Corefinity deploy key. Everything else reads `user`.","enum":["user","company","system"],"type":"string"},"status":{"enum":["pending","applied","failed","removing"],"type":"string"},"status_label":{"type":"string"},"type":{"description":"The key type, such as `ssh-ed25519` or `ssh-rsa`.","type":"string"}},"required":["id","name","type","bits","fingerprint","comment","source","company_key_id","status","status_label","added_by","added_at","restricted","restrictions","can_delete"],"type":"object"},"SiteAccessKeyChanged":{"properties":{"key":{"$ref":"#/components/schemas/SiteAccessKey"},"operation":{"$ref":"#/components/schemas/Operation"}},"required":["key","operation"],"type":"object"},"SiteAccessKeyCreateRequest":{"properties":{"key":{"description":"One public key, in OpenSSH, PEM or PuTTY format. At most 16,384 bytes once the space around it is\ntrimmed: a longer one is refused as too long to be a public key.\n","maxLength":16384,"minLength":1,"type":"string"},"name":{"description":"A name to recognise the key by.","maxLength":64,"minLength":1,"type":"string"}},"required":["name","key"],"type":"object"},"SiteAccessKeyDeleteRequest":{"properties":{"confirm_fingerprint":{"description":"The key's fingerprint, exactly. Checked only while SSH keys are on for your company.","type":"string"}},"type":"object"},"SiteAccessPassword":{"description":"A generated password. It is in this answer only and is kept nowhere.","properties":{"revealed_at":{"type":"string"},"value":{"type":"string"}},"required":["value","revealed_at"],"type":"object"},"SiteAccessUser":{"additionalProperties":true,"description":"The built-in `web` user, or a named SSH or SFTP user.","properties":{"can_change":{"type":"boolean"},"can_delete":{"type":"boolean"},"connection":{"properties":{"command":{"description":"The `ssh` command. Null for an SFTP user.","type":["string","null"]},"sftp_command":{"type":["string","null"]}},"required":["command","sftp_command"],"type":"object"},"created_at":{"type":["string","null"]},"created_by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"id":{"description":"The id the `/access/users/{user}` endpoints take.","type":"integer"},"keys":{"description":"The user's keys. While SSH keys are on for your company, `web` lists every key that can log in as it, from\nevery level.\n","items":{"$ref":"#/components/schemas/SiteAccessKey"},"type":"array"},"kind":{"description":"`built_in` is `web`. It cannot be changed or removed.","enum":["built_in","named"],"type":"string"},"label":{"type":["string","null"]},"password":{"description":"Whether the user has a password. The password itself is never answered here.","properties":{"set":{"type":"boolean"},"set_at":{"type":["string","null"]},"set_by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]}},"required":["set","set_at","set_by"],"type":"object"},"root_path":{"description":"The folder an SFTP user is limited to, relative to the site.","type":["string","null"]},"root_path_absolute":{"description":"The same folder as a path on the server.","type":["string","null"]},"status":{"description":"`pending` until the change that made or changed the user is live.","enum":["pending","applied","failed","removing"],"type":"string"},"status_label":{"type":"string"},"type":{"enum":["ssh","sftp"],"type":"string"},"type_label":{"type":"string"},"uid":{"description":"The user's numeric id on the server.","type":["integer","null"]},"username":{"type":"string"}},"required":["uid","id","username","kind","type","type_label","label","root_path","root_path_absolute","password","keys","status","status_label","connection","created_by","created_at","can_change","can_delete"],"type":"object"},"SiteAccessUserCreateRequest":{"properties":{"label":{"description":"A note to recognise the user by.","maxLength":60,"type":["string","null"]},"password":{"description":"`none` (the default) makes a user that signs in with keys only. `set` uses `password_value`. `generate`\nmakes a password and answers it once; it also needs the `exec` scope.\n","enum":["generate","set","none",null],"type":["string","null"]},"password_value":{"description":"The password, with `set`, and needed then: 12 to 64 characters, not the username and not containing the\nsite's domain. One that breaks these is refused on `password_value`.\n","maxLength":64,"minLength":12,"type":["string","null"]},"root_path":{"description":"For `sftp` users, the folder the user is limited to, inside `htdocs` or `shared`. Left out, it is `htdocs`.\nNot accepted for `ssh` users. At most 200 characters, with no `/` at either end; each\npart is letters, digits, dots, dashes and underscores.\n","maxLength":200,"type":["string","null"]},"type":{"description":"`ssh` gives SSH and SFTP over the whole site. `sftp` gives SFTP only, inside `root_path`.","enum":["ssh","sftp"],"type":"string"},"username":{"description":"3 to 31 lower-case letters, digits or dashes, starting with a letter. Some names are reserved.","pattern":"^[a-z][a-z0-9-]{2,30}$","type":"string"}},"required":["username","type"],"type":"object"},"SiteAccessUserCreated":{"properties":{"access":{"allOf":[{"$ref":"#/components/schemas/SiteAccessCore"}],"description":"The site's access with the new user in it."},"operation":{"$ref":"#/components/schemas/Operation"},"password":{"description":"The generated password, or null when none was generated.","oneOf":[{"$ref":"#/components/schemas/SiteAccessPassword"},{"type":"null"}]},"user":{"$ref":"#/components/schemas/SiteAccessUser"}},"required":["user","operation","access","password"],"type":"object"},"SiteAccessUserDeleteRequest":{"properties":{"confirm_username":{"description":"The user's username, exactly. Checked only while SSH keys are on for your company.","type":"string"}},"type":"object"},"SiteAccessUserRemoved":{"properties":{"operation":{"$ref":"#/components/schemas/Operation"},"user":{"$ref":"#/components/schemas/SiteAccessUser"}},"required":["user","operation"],"type":"object"},"SiteAccessUserUpdateRequest":{"description":"Send only what changes.","properties":{"label":{"maxLength":60,"type":["string","null"]},"password":{"description":"`set` uses `password_value`. `generate` makes a password and answers it once; it also needs the `exec`\nscope. `clear` removes the password, and so does `none`. Leave `password` out to keep the password as it\nis.\n","enum":["generate","set","clear","none",null],"type":["string","null"]},"password_value":{"description":"The password, with `set`, and needed then: 12 to 64 characters, not the username and not containing the\nsite's domain. One that breaks these is refused on `password_value`.\n","maxLength":64,"minLength":12,"type":["string","null"]},"root_path":{"description":"As when the user is created.","maxLength":200,"type":["string","null"]},"type":{"enum":["ssh","sftp",null],"type":["string","null"]}},"type":"object"},"SiteAccessUserUpdated":{"properties":{"operation":{"allOf":[{"$ref":"#/components/schemas/Operation"}],"description":"Sent when a change is being applied. A change of the label alone has none."},"password":{"allOf":[{"$ref":"#/components/schemas/SiteAccessPassword"}],"description":"Sent when a password was generated."},"user":{"$ref":"#/components/schemas/SiteAccessUser"}},"required":["user"],"type":"object"},"SiteAnswer":{"properties":{"site":{"$ref":"#/components/schemas/SiteDetail"}},"required":["site"],"type":"object"},"SiteCreateClusterRequest":{"allOf":[{"$ref":"#/components/schemas/SiteCreateSite"},{"required":["tier"],"type":"object"}],"description":"The site to create in the CoreCluster: the same fields as `site` in the other create, with `tier` required and no environments."},"SiteCreateCredential":{"description":"A generated HTTP authentication login, shown only in this answer.","properties":{"password":{"description":"Null when the token does not hold the `exec` scope.","type":["string","null"]},"password_withheld":{"description":"Sent when the password was withheld.","properties":{"message":{"type":"string"},"scope":{"type":"string"}},"type":"object"},"revealed_at":{"format":"date-time","type":["string","null"]},"rule_id":{"minimum":1,"type":"integer"},"user_id":{"minimum":1,"type":"integer"},"username":{"type":"string"}},"required":["rule_id","user_id","username","password","revealed_at"],"type":"object"},"SiteCreateEnvironment":{"additionalProperties":false,"description":"One further environment to create with the site.","properties":{"included":{"description":"On a Corefinity platform: this is the environment the package includes. At most one.","type":"boolean"},"name":{"description":"The environment's name, 40 characters at most, not blank, with no `<` or `>` and no control characters. Each name must be different, and none may be a reserved name such as production.","maxLength":40,"minLength":1,"type":"string"},"source":{"description":"How the environment starts. Only `{\"type\": \"empty\"}` is taken at create.","properties":{"type":{"enum":["empty"],"type":"string"}},"type":"object"},"tier":{"description":"In a CoreCluster: the environment's size. Left out, the site's `tier`. Refused on a Corefinity platform.","type":"string"},"uat_size":{"description":"On a Corefinity platform, and required there: the environment's size. Magento 2 takes `medium` or `large`, Shopware `small`, `medium` or `large`. Refused in a CoreCluster.","enum":["xsmall","small","medium","large"],"type":"string"}},"required":["name"],"type":"object"},"SiteCreateFreshSettings":{"additionalProperties":false,"description":"Settings of a fresh install, read only when `content` is `fresh`. All are optional; a field that is not listed here is refused.","properties":{"admin_email":{"description":"The admin's email address, 190 characters at most, with no space, quote, `<`, `>` or backslash. It is saved in lower case. Left out, the platform's default, else your own address.","format":"email","maxLength":190,"type":"string"},"admin_username":{"description":"3 to 32 characters: a lower-case letter first, then lower-case letters, digits or `_`. `admin` is refused. Left out, the platform's default, else `siteadmin`.","not":{"const":"admin"},"pattern":"^[a-z][a-z0-9_]{2,31}$","type":"string"},"currency":{"description":"Taken only for a platform whose fresh install has a currency, and then one of the currencies it offers; refused as a field that is not part of the request for every other platform.","type":"string"},"locale":{"description":"One of the locales the platform installs, `en_GB` or `en_US` unless the platform offers its own list. Left out, the platform's default, else `en_GB`.","type":"string"},"site_title":{"description":"The site's title, 100 characters at most, with no control characters (a line break is one). Left out, or blank (a blank title is read as left out), the platform's default, else the domain.","maxLength":100,"pattern":"^[^\\x00-\\x1F\\x7F]*$","type":"string"}},"type":"object"},"SiteCreateRequest":{"additionalProperties":false,"description":"The create takes one of two shapes, by `placement.kind`.\nOn a Corefinity platform (`platform`): `placement.region` and `package` are required, `site.tier` is refused\n(the package sets the size), and each environment needs a `uat_size` and takes no `tier`.\nIn one of your CoreClusters (`cluster`): `placement.cluster_id` and `site.tier` are required, `package` is\nrefused, and an environment takes a `tier` (left out, the site's) and no `uat_size` or `included`.\n`environments` may be left out: the site is then created on its own.\n","oneOf":[{"properties":{"environments":{"items":{"not":{"required":["tier"]},"required":["name","uat_size"]}},"placement":{"properties":{"kind":{"const":"platform"}},"required":["kind","region"]},"site":{"not":{"required":["tier"]}}},"required":["package"],"title":"On a Corefinity platform"},{"not":{"required":["package"]},"properties":{"environments":{"items":{"not":{"anyOf":[{"required":["uat_size"]},{"required":["included"]}]}}},"placement":{"properties":{"kind":{"const":"cluster"}},"required":["kind","cluster_id"]},"site":{"required":["tier"]}},"title":"In one of your CoreClusters"}],"properties":{"compute_family":{"description":"The server type: Standard (`general`) or Performance (`optimised`).","enum":["general","optimised"],"type":"string"},"environments":{"description":"The environments to create with the site. May be empty or left out.","items":{"$ref":"#/components/schemas/SiteCreateEnvironment"},"type":"array"},"package":{"description":"With a `platform` placement, and required then: the package key, such as `cs4`. Refused with a `cluster` placement.","type":"string"},"placement":{"description":"Where the site runs.","properties":{"cluster_id":{"description":"With `cluster`, and required then: the id of your CoreCluster.","minimum":1,"type":"integer"},"kind":{"description":"`platform` for a Corefinity platform in a region; `cluster` for one of your CoreClusters.","enum":["platform","cluster"],"type":"string"},"region":{"description":"With `platform`, and required then: the region key, such as `uk` (2 to 4 letters).","pattern":"^[a-z]{2,4}$","type":"string"}},"required":["kind"],"type":"object"},"site":{"$ref":"#/components/schemas/SiteCreateSite"}},"required":["placement","site"],"type":"object"},"SiteCreateSite":{"additionalProperties":false,"description":"The site to create.","properties":{"acknowledge":{"description":"What the chosen line asks you to acknowledge.","items":{"enum":["eol"],"type":"string"},"type":"array"},"app_version":{"description":"The `key` of a line from the application versions list. Left out, the recommended line. Taken only while application versions are on for your company.","type":"string"},"content":{"description":"`fresh` installs the platform; `empty` creates a site for your own code.","enum":["fresh","empty"],"type":"string"},"domain":{"description":"The site's public domain in lower case, without `www`. You choose `www` or not when you attach the domain.","maxLength":253,"minLength":4,"type":"string"},"edition":{"description":"The edition of the line, such as `open_source`. Taken only while application versions are on for your company.","type":"string"},"fresh":{"$ref":"#/components/schemas/SiteCreateFreshSettings"},"http_auth":{"default":false,"description":"Create the site behind HTTP authentication, with one whole-site rule and a generated login.","type":"boolean"},"mariadb_version":{"description":"Left out, the platform's default.","type":"string"},"node_acknowledge":{"description":"`[\"eol\"]` to choose a major that no longer receives fixes; otherwise leave it out or send `[]`.","items":{"enum":["eol"],"type":"string"},"maxItems":1,"type":"array"},"node_major":{"description":"The Node.js major version for the site, as a whole number (`22`, never `\"22\"`), and one of the majors offered to new sites of the platform. Left out, the default major. Refused while choosing a Node.js version is switched off, and where a new site cannot take one yet.","maximum":99,"minimum":1,"type":"integer"},"php_version":{"description":"Such as `8.3`. Left out, the platform's default.","type":"string"},"platform":{"description":"`wordpress`, `magento2`, `laravel`, `shopware`, or another platform offered to your company.","type":"string"},"search":{"description":"Shopware only: whether search is on.","type":"boolean"},"tier":{"description":"The size, such as `S`, `M` or `L`. Required in a CoreCluster; refused on a Corefinity platform, where the package sets the size.","type":"string"},"varnish":{"additionalProperties":false,"description":"Magento 2 only, where offered: start the site with Varnish.","properties":{"enabled":{"type":"boolean"},"version":{"type":"string"}},"required":["enabled"],"type":"object"}},"required":["platform","domain","content"],"type":"object"},"SiteCreated":{"additionalProperties":true,"properties":{"cluster":{"allOf":[{"$ref":"#/components/schemas/ClusterRef"}],"description":"The cluster the site was placed on. Other fields may be present."},"company_enabled":{"type":"boolean"},"credentials":{"description":"The generated HTTP authentication logins of the site and its environments.","items":{"$ref":"#/components/schemas/SiteCreateCredential"},"type":"array"},"environments":{"items":{"properties":{"environment":{"$ref":"#/components/schemas/SiteDetail"},"note":{"type":"string"},"operation":{"$ref":"#/components/schemas/Operation"},"queued_after_site":{"description":"Sent when the environment waits for the site to be ready.","type":"boolean"}},"required":["environment","operation"],"type":"object"},"type":"array"},"not_queued":{"description":"Sent with queued environments."},"operation":{"$ref":"#/components/schemas/Operation","description":"The operation creating the site. This answer writes its times with a `+00:00` offset; reading the operation by its `id` answers them in UTC with `Z`."},"payment":{"description":"Sent when the site was created before the company had a payment method: `method_needed`, `add_by`, `message` and `href`.","type":["object","null"]},"progress_href":{"description":"The path of the progress page in the Control Panel.","type":"string"},"quote":{"description":"Always null in this answer."},"reveal_url":{"description":"The endpoint that reveals the fresh install's admin login once. Sent only for a fresh install with an admin login.","type":"string"},"site":{"$ref":"#/components/schemas/SiteDetail"},"state":{"description":"`creating`, or `capacity_being_added` while the create waits for room to be added. No other value is sent.","enum":["creating","capacity_being_added"],"type":"string"}},"required":["site","cluster","operation","environments","credentials","progress_href","state"],"type":"object"},"SiteCreatedInCluster":{"properties":{"credentials":{"allOf":[{"$ref":"#/components/schemas/SiteCreateCredential"}],"description":"The site's generated HTTP authentication login. Sent only when the request asked for `http_auth`."},"operation":{"$ref":"#/components/schemas/Operation","description":"The operation creating the site. This answer writes its times with a `+00:00` offset; reading the operation by its `id` answers them in UTC with `Z`."},"reveal_url":{"description":"The endpoint that reveals the fresh install's admin login once. Sent only for a fresh install with an admin login.","type":"string"},"site":{"$ref":"#/components/schemas/SiteDetail"}},"required":["site","operation"],"type":"object"},"SiteDeleteAccepted":{"allOf":[{"$ref":"#/components/schemas/OperationStarted"},{"properties":{"site":{"$ref":"#/components/schemas/SiteDetail"}},"required":["site"],"type":"object"}],"description":"The shared `OperationStarted`, with the row as it reads once the delete has started."},"SiteDeleteQueued":{"additionalProperties":true,"properties":{"held_delete_id":{"minimum":1,"type":"integer"},"message":{"type":"string"},"reason":{"const":"external_db_delete_queued","type":"string"},"turn_off_operation_id":{"description":"The operation that is turning external database access off.","minimum":1,"type":["integer","null"]}},"required":["message","reason","held_delete_id"],"type":"object"},"SiteDeleteRequest":{"description":"The typed confirmation of the row to delete. Send the one field that row takes.","minProperties":1,"properties":{"confirm_domain":{"description":"To delete a site, name its production row in `{site}` and send the site's domain here, exactly.","type":"string"},"confirm_name":{"description":"To delete one environment, name that environment's row in `{site}` and send its name here, exactly as the\nsite shows it, such as `Staging`. A production row takes `confirm_domain` instead.\n","type":"string"}},"type":"object"},"SiteDeployment":{"additionalProperties":true,"description":"One deployment of a site.","properties":{"attempt_id":{"description":"The deployment's current attempt. A retry moves it on.","type":["integer","null"]},"binding":{"description":"The pipeline the deployment ran with.","oneOf":[{"additionalProperties":true,"properties":{"id":{"type":"integer"},"label":{"type":"string"}},"required":["id","label"],"type":"object"},{"type":"null"}]},"can_retry":{"description":"True for a failed deployment, and for one stopped in its after-deploy commands once its release was live,\nunless it is a rollback, a stop of it is still putting the earlier release back, or its release archive\nwas removed.\n","type":"boolean"},"can_rollback":{"description":"True when the site can roll back to this deployment's release.","type":"boolean"},"can_stop":{"description":"True for a running deployment, and for a failed one whose scheduled tasks and queues stay paused after\nits database stage failed (`crons_paused.state` `database_failed`) while no other deployment of the site\nis in progress.\n","type":"boolean"},"crons_paused":{"description":"On a failed or stopped deployment whose crons and queues stay paused: `state` (`database_failed` or\n`revert_unfinished`) and `message`. A stop or a retry resumes them.\n","type":["object","null"]},"duration_seconds":{"type":["integer","null"]},"error":{"description":"Why a failed deployment failed, or what a queued one waits for.","type":["string","null"]},"finished_at":{"type":["string","null"]},"git_author":{"description":"The commit's author (`name`, `avatar_url`), when the push said.","type":["object","null"]},"git_commit_url":{"description":"The commit's page at the provider, when the push said.","type":["string","null"]},"git_merge_request":{"description":"The commit's merge request or pull request (`ref`, `kind`, `url`), when the push said.","type":["object","null"]},"href":{"description":"The path of the deployment's page in the Control Panel.","type":"string"},"id":{"type":"integer"},"is_current":{"description":"True for the deployment whose release is live.","type":"boolean"},"maintenance_lift":{"description":"On a failed deployment that switched maintenance mode on, whether it was switched off again (`state`, `message`).","type":["object","null"]},"queued_at":{"type":["string","null"]},"ref":{"$ref":"#/components/schemas/SiteDeploymentRef"},"release_id":{"description":"The id of the release the deployment made. Null until its release goes live.","type":["string","null"]},"requested_by":{"description":"Who started it. Null for a push.","oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"retry_warning":{"description":"What a retry would do when this is not the site's newest deployment. Such a retry needs `confirm_older`.","type":["string","null"]},"stage":{"description":"The stage a running deployment is at, or a failed one stopped at.","type":["string","null"]},"stage_label":{"type":["string","null"]},"started_at":{"type":["string","null"]},"status":{"description":"`waiting` is a push that arrived while deploy on push is off; `skipped` is a waiting deployment that a\nlater one overtook.\n","enum":["waiting","queued","running","succeeded","failed","cancelled","skipped"],"type":"string"},"status_label":{"type":"string"},"stop_termination":{"description":"On a stopped deployment whose running step could not be confirmed ended (`state`, `checked_at`).","type":["object","null"]},"task":{"description":"The step a running deployment is at, or a failed one stopped at.","type":["string","null"]},"trigger":{"description":"What started it. `manual` is Deploy now, `webhook` a push, `rollback` a rollback.","enum":["manual","webhook","api","rollback","unknown"],"type":"string"}},"required":["id","status","status_label","trigger","ref","release_id","is_current","requested_by","queued_at","started_at","finished_at","duration_seconds","stage","stage_label","task","error","href","can_rollback","can_stop","can_retry"],"type":"object"},"SiteDeploymentAnswer":{"properties":{"deployment":{"$ref":"#/components/schemas/SiteDeployment"}},"required":["deployment"],"type":"object"},"SiteDeploymentBranchList":{"properties":{"branches":{"items":{"properties":{"default":{"type":"boolean"},"name":{"type":"string"},"sha":{"description":"The branch's newest commit.","type":["string","null"]}},"required":["name","sha","default"],"type":"object"},"maxItems":200,"type":"array"}},"required":["branches"],"type":"object"},"SiteDeploymentCarriedOver":{"additionalProperties":true,"properties":{"attention_id":{"type":["integer","string","null"]},"auto_deploy":{"type":"boolean"},"bindings":{"description":"Each carried-over pipeline, with its translated lines and whether it is accepted.","items":{"additionalProperties":true,"properties":{"also_set":{"description":"Settings the translation made, in words.","items":{"type":"string"},"type":"array"},"binding_id":{"type":"integer"},"label":{"type":"string"},"lines":{"items":{"additionalProperties":true,"properties":{"change":{"description":"What the translation did with the line, such as `kept`, `rewritten` or `removed`.","type":"string"},"needs_review":{"type":"boolean"},"reason":{"description":"Why the line needs a look.","type":"string"},"result":{"description":"The lines it became, each with its stage.","items":{"additionalProperties":true,"type":"object"},"type":"array"},"source":{"description":"The line's `stage` and `index`, which a decision names it by.","properties":{"index":{"type":"integer"},"stage":{"type":"string"}},"required":["stage","index"],"type":"object"},"text":{"description":"The command as it was carried over.","type":"string"}},"required":["source","text","result","change","needs_review"],"type":"object"},"type":"array"},"rehearsal":{"type":["object","null"]},"repository":{"description":"The repository the pipeline deploys from.","type":["object","null"]},"revision":{"description":"Send this with the accept when it is not null.","type":["string","null"]},"state":{"description":"`needs_review` while a line needs a look, `accepted` once the pipeline has been accepted.","type":"string"}},"required":["binding_id","state","lines"],"type":"object"},"type":"array"},"files_mode":{"type":"boolean"},"moved_at":{"type":["string","null"]}},"required":["bindings"],"type":"object"},"SiteDeploymentCarriedOverAcceptRequest":{"additionalProperties":false,"properties":{"binding_id":{"minimum":1,"type":"integer"},"lines":{"description":"A decision for each line that needs a look, named by its `stage` and `index` as the read answers them. An empty list accepts the translation as it is.","items":{"additionalProperties":false,"properties":{"action":{"enum":["accept","remove","edit"],"type":"string"},"index":{"minimum":0,"type":"integer"},"stage":{"enum":["build","database","post_deploy"],"type":"string"},"text":{"description":"With `edit`, the new line.","maxLength":4096,"type":"string"}},"required":["stage","index","action"],"type":"object"},"maxItems":600,"type":"array"},"revision":{"description":"The pipeline's `revision` from the read. Leave it out while that is null.","type":"string"}},"required":["binding_id","lines"],"type":"object"},"SiteDeploymentCommand":{"additionalProperties":true,"description":"A command the Control Panel runs on the site.","properties":{"error":{"type":["string","null"]},"finished_at":{"type":["string","null"]},"id":{"type":"integer"},"kind":{"description":"`releases_flatten` for the switch to manual deployments.","type":"string"},"label":{"type":"string"},"queued_at":{"type":["string","null"]},"requested_by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"started_at":{"type":["string","null"]},"status":{"description":"Such as `running`, `succeeded` or `failed`.","type":"string"},"status_label":{"type":"string"}},"required":["id","kind","label","status","status_label","error","queued_at","started_at","finished_at"],"type":"object"},"SiteDeploymentConnectionRef":{"additionalProperties":true,"description":"A repository connection, as the deployment settings name it.","properties":{"id":{"description":"The connection's id. 0 when the repository's connection no longer exists or is not one of the site's company.","type":"integer"},"label":{"description":"The provider and the account's username.","type":"string"},"needs_reauth":{"description":"True when the provider no longer accepts the connection.","type":"boolean"},"provider":{"description":"One of `github`, `gitlab`, `bitbucket` or `gitlab_self_hosted`.","type":"string"},"provider_label":{"type":"string"}},"required":["id","provider","provider_label","label","needs_reauth"],"type":"object"},"SiteDeploymentCreateRequest":{"properties":{"binding_id":{"description":"Another pipeline of the same site, by its id in the settings' `pipeline.bindings`. Refused `422`\n`feature_off` while choosing a pipeline is not on for your company.\n","minimum":1,"type":["integer","null"]},"ref":{"description":"A branch name or a 40-character commit SHA. Left out, the connected branch is deployed.","maxLength":255,"type":["string","null"]}},"type":"object"},"SiteDeploymentInheritedVariable":{"description":"A company variable that reaches this environment. Never its value.","properties":{"company":{"$ref":"#/components/schemas/Named"},"level":{"description":"Whose variable it is, such as `owner` for the company that owns the site.","type":"string"},"name":{"type":"string"},"overridden":{"description":"Whether the environment has a variable of its own with this name, whose value is used instead.","type":"boolean"},"shared":{"description":"Whether an agency shares it with the companies it manages.","type":"boolean"},"used_by":{"description":"The deployment stages whose commands read it.","items":{"type":"string"},"type":"array"}},"required":["name","company","level","shared","used_by","overridden"],"type":"object"},"SiteDeploymentModeGitAnswer":{"properties":{"operation":{"$ref":"#/components/schemas/Operation"},"settings":{"$ref":"#/components/schemas/SiteDeploymentSettings"}},"required":["settings","operation"],"type":"object"},"SiteDeploymentModeManualAnswer":{"properties":{"command":{"description":"The command that switches the site to manual deployments. Null when the site already deploys by upload.","oneOf":[{"$ref":"#/components/schemas/SiteDeploymentCommand"},{"type":"null"}]},"settings":{"$ref":"#/components/schemas/SiteDeploymentSettings"}},"required":["settings","command"],"type":"object"},"SiteDeploymentModeRequest":{"properties":{"mode":{"enum":["git","manual"],"type":"string"},"reconvert":{"description":"With `mode` `git` on a site whose conversion is pending, converts again.","type":"boolean"}},"required":["mode"],"type":"object"},"SiteDeploymentOptions":{"additionalProperties":true,"properties":{"build_reads":{"items":{"type":"string"},"type":"array"},"cloudflare_purge":{"type":"boolean"},"extra_shared_paths":{"items":{"$ref":"#/components/schemas/SiteDeploymentOptionsPath"},"type":"array"},"migrate":{"description":"Laravel only, read only. The environment's own switch, which a pipeline whose `run_migrations` is null follows. Null on every other platform.","type":["boolean","null"]},"platform_shared":{"description":"The paths the platform itself keeps between releases.","items":{"$ref":"#/components/schemas/SiteDeploymentOptionsPath"},"type":"array"},"pre_switch_check":{"$ref":"#/components/schemas/SiteDeploymentOptionsSwitchWithPaths"},"snapshot_before_upgrade":{"type":"boolean"},"varnish_purge":{"description":"Magento 2 only. Whether Varnish is purged after the switch.","type":"boolean"},"warm_up":{"$ref":"#/components/schemas/SiteDeploymentOptionsSwitchWithPaths"}},"required":["extra_shared_paths","build_reads","pre_switch_check","warm_up","cloudflare_purge"],"type":"object"},"SiteDeploymentOptionsPath":{"additionalProperties":true,"properties":{"kind":{"enum":["dir","file"],"type":"string"},"path":{"description":"A path relative to the site's root.","maxLength":255,"type":"string"},"shared":{"description":"Where the path's data is kept between releases, relative to the shared folder, when that is not the default.","type":"string"}},"required":["path"],"type":"object"},"SiteDeploymentOptionsRelativePath":{"description":"A path inside the site, relative to its root: no leading slash, no `.` or `..` segment, of letters, digits\nand `. _ / @ + -`, at most 255 characters.\n","maxLength":255,"minLength":1,"pattern":"^(?!/)(?!(?:.*/)?\\.\\.?(?:/|$))[A-Za-z0-9._/@+-]+$","type":"string"},"SiteDeploymentOptionsRequest":{"additionalProperties":false,"properties":{"build_reads":{"description":"The whole list of paths a build may read from the live site, at most 50, each named once.","items":{"$ref":"#/components/schemas/SiteDeploymentOptionsRelativePath"},"maxItems":50,"type":"array"},"cloudflare_purge":{"description":"Purge Cloudflare's cache after the switch.","type":"boolean"},"extra_shared_paths":{"description":"The whole list of extra paths kept between releases, at most 50, each named once: a folder's path, or\n`{path, kind}`. No path may equal, hold or sit inside another, or one the platform itself keeps\n(`platform_shared` in the answer).\n","items":{"anyOf":[{"$ref":"#/components/schemas/SiteDeploymentOptionsRelativePath"},{"additionalProperties":false,"properties":{"kind":{"description":"A folder (`dir`, the default) or a file.","enum":["dir","file"],"type":"string"},"path":{"$ref":"#/components/schemas/SiteDeploymentOptionsRelativePath"},"shared":{"description":"Where the path's data is kept between releases, relative to the shared folder. Leave it out to keep the saved place, or the default for a new path.","oneOf":[{"$ref":"#/components/schemas/SiteDeploymentOptionsRelativePath"},{"type":"null"}]}},"required":["path"],"type":"object"}]},"maxItems":50,"type":"array"},"pre_switch_check":{"anyOf":[{"type":"boolean"},{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"},"paths":{"items":{"$ref":"#/components/schemas/SiteDeploymentOptionsUrlPath"},"maxItems":5,"type":"array"}},"required":["enabled"],"type":"object"}],"description":"Check the new release answers before visitors are switched to it. Off (`false`), on (`true`), or on with up to five paths to request."},"snapshot_before_upgrade":{"description":"Magento 2 only.","type":"boolean"},"varnish_purge":{"description":"Magento 2 only. Purge Varnish after the switch.","type":"boolean"},"warm_up":{"anyOf":[{"type":"boolean"},{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"},"paths":{"items":{"$ref":"#/components/schemas/SiteDeploymentOptionsUrlPath"},"maxItems":10,"type":"array"}},"required":["enabled"],"type":"object"}],"description":"Request pages of the new release before the switch. Off (`false`), on (`true`), or on with up to ten paths to request."}},"type":"object"},"SiteDeploymentOptionsSwitchWithPaths":{"anyOf":[{"type":"boolean"},{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"},"paths":{"description":"Paths starting with a slash.","items":{"$ref":"#/components/schemas/SiteDeploymentOptionsUrlPath"},"type":"array"}},"required":["enabled"],"type":"object"}],"description":"Off (`false`), on (`true`), or on with the paths to request."},"SiteDeploymentOptionsUrlPath":{"description":"A path of the site's address, starting with a slash, of letters, digits and `. _ ~ / % -`, at most 251 characters.","maxLength":251,"pattern":"^/[A-Za-z0-9._~/%-]*$","type":"string"},"SiteDeploymentPipeline":{"additionalProperties":true,"properties":{"binding_id":{"description":"The pipeline this answer is about.","type":"integer"},"bindings":{"description":"The environment's pipelines.","items":{"additionalProperties":true,"properties":{"id":{"type":"integer"},"is_default":{"type":"boolean"},"label":{"type":"string"},"tag":{"type":["string","null"]}},"required":["id","label"],"type":"object"},"type":"array"},"can":{"additionalProperties":true,"properties":{"edit":{"type":"boolean"},"edit_code":{"type":["string","null"]},"edit_reason":{"type":["string","null"]},"rehearse":{"type":"boolean"},"rehearse_code":{"type":["string","null"]},"rehearse_reason":{"type":["string","null"]}},"required":["edit","rehearse"],"type":"object"},"carry_over":{"type":["object","null"]},"classic":{"description":"The commands of a pipeline that does not have the three stages yet. Null for a three-stage pipeline.","type":["object","null"]},"conversion":{"type":["object","null"]},"locked":{"description":"Set while Corefinity has locked the pipeline, so it cannot be edited. Null when it can.","properties":{"reason":{"description":"Why, in Corefinity's words.","type":"string"}},"required":["reason"],"type":["object","null"]},"options":{"$ref":"#/components/schemas/SiteDeploymentOptions"},"origin":{"type":["string","null"]},"placement":{"additionalProperties":true,"description":"What a build of this environment runs with, such as its Node.js version and whether it opens a tunnel.","type":"object"},"presets":{"additionalProperties":true,"description":"The build presets this platform offers, and the ones found in the site's code.","properties":{"detected":{"items":{},"type":"array"},"offered":{"items":{"additionalProperties":true,"properties":{"key":{"type":"string"},"kind":{"type":"string"},"label":{"type":"string"}},"required":["key","kind","label"],"type":"object"},"type":"array"}},"type":"object"},"revision":{"description":"Send this with a save.","type":["string","null"]},"saved":{"description":"The last save. Null for a pipeline that has not been saved.","oneOf":[{"additionalProperties":true,"properties":{"at":{"type":"string"},"by":{"additionalProperties":true,"type":"object"},"number":{"type":"integer"},"source":{"type":"string"}},"type":"object"},{"type":"null"}]},"settings":{"description":"The settings. Null for a pipeline that does not have the three stages yet.","oneOf":[{"$ref":"#/components/schemas/SiteDeploymentPipelineSettings"},{"type":"null"}]},"stage_model":{"description":"`three_stage` for a pipeline with the three stages. Null for one that still holds the commands it was carried over with.","type":["string","null"]},"stages":{"description":"The three stages. Null for a pipeline that does not have them yet.","oneOf":[{"$ref":"#/components/schemas/SiteDeploymentPipelineStages"},{"type":"null"}]},"template":{"description":"The deployment template each stage follows or has left. Present while deployment templates are on for your company.","type":["object","null"]}},"required":["bindings","binding_id","stage_model","revision","stages","settings","can"],"type":"object"},"SiteDeploymentPipelineBadge":{"additionalProperties":true,"properties":{"id":{"type":"string"},"label":{"type":"string"},"severity":{"type":"string"}},"required":["id","label"],"type":"object"},"SiteDeploymentPipelineCopyAnswer":{"additionalProperties":true,"properties":{"dry_run":{"type":"boolean"},"from_site_id":{"type":"integer"},"parts":{"description":"Each part asked for, with what changed.","items":{"additionalProperties":true,"properties":{"added":{"description":"What the copy adds to this pipeline.","items":{"type":"string"},"type":"array"},"overwritten":{"description":"What it replaces.","items":{"type":"string"},"type":"array"},"part":{"type":"string"},"removed":{"items":{"type":"string"},"type":"array"},"unchanged":{"description":"What is already the same.","items":{"type":"string"},"type":"array"}},"required":["part"],"type":"object"},"type":"array"}},"required":["dry_run","parts"],"type":"object"},"SiteDeploymentPipelineCopyRequest":{"additionalProperties":false,"properties":{"confirm_production":{"description":"True to copy onto a production environment.","type":"boolean"},"dry_run":{"description":"Write nothing and answer what would change.","type":"boolean"},"from_binding_id":{"description":"One of that environment's pipelines. Its repository's pipeline when left out.","minimum":1,"type":"integer"},"from_site_id":{"description":"The site row of another environment of the same site.","minimum":1,"type":"integer"},"parts":{"items":{"enum":["stages","settings","variables","secrets","options"],"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"revision":{"description":"The revision of this pipeline that you read. Needed to copy `stages` or `settings`, which are refused `stale` without it; a dry run checks against the pipeline as it is now when it is left out.","type":"string"}},"required":["from_site_id","parts"],"type":"object"},"SiteDeploymentPipelineLine":{"additionalProperties":true,"description":"One line of a stage, with what the platform makes of it.","properties":{"badges":{"items":{"$ref":"#/components/schemas/SiteDeploymentPipelineBadge"},"type":"array"},"comments":{"items":{"type":"string"},"type":"array"},"origin":{"description":"Where the line comes from, such as `custom` for one of your own.","type":"string"},"text":{"description":"The command.","type":"string"},"verdict":{"description":"Such as `files`, `services`, `platform_duplicate` or `unknown`.","type":"string"}},"required":["text"],"type":"object"},"SiteDeploymentPipelineSettings":{"additionalProperties":true,"properties":{"keep_node_modules":{"type":"boolean"},"maintenance_policy":{"description":"When a deployment puts the site into maintenance mode.","enum":["when_needed","always","off"],"type":"string"},"pause_crons":{"description":"Whether scheduled tasks pause during the database stage. `auto` or `off`.","type":["string","null"]},"run_migrations":{"description":"Laravel only. Null follows the environment.","type":["boolean","null"]},"timeout_defaults":{"description":"The same four timeouts as they are when the pipeline sets none of its own.","type":["object","array"]},"timeouts":{"description":"The seconds allowed in effect for the whole build (`build`), for one line of it (`build_line`) and for one line of the database and after-deploy stages (`database_line`, `post_line`).","type":["object","array"]},"timeouts_own":{"description":"The timeouts the pipeline itself holds, by the same names. Empty when it holds none.","type":["object","array"]},"tunnels":{"description":"Whether a build may reach the environment's services.","enum":["auto","on","off"],"type":"string"}},"type":"object"},"SiteDeploymentPipelineSettingsRequest":{"additionalProperties":false,"properties":{"keep_node_modules":{"type":"boolean"},"maintenance_policy":{"enum":["when_needed","always","off"],"type":"string"},"pause_crons":{"enum":["auto","off"],"type":"string"},"revision":{"description":"The pipeline revision you read.","type":"string"},"run_migrations":{"description":"Laravel only. Null follows the environment.","type":["boolean","null"]},"timeouts":{"additionalProperties":false,"description":"The pipeline's own timeouts, in whole seconds from 60 to 3600 each. The map is sent whole: a timeout left\nout, or sent null, goes back to its default. A value outside the bounds, or one that is not a whole\nnumber, is refused `timeout_out_of_range`; any other key is refused `invalid`. One exception: a timeout\nCorefinity has raised above 3600 is kept when it is sent back exactly as the pipeline holds it\n(`settings.timeouts_own` in the pipeline read).\n","properties":{"build":{"$ref":"#/components/schemas/SiteDeploymentPipelineTimeout"},"build_line":{"$ref":"#/components/schemas/SiteDeploymentPipelineTimeout"},"database_line":{"$ref":"#/components/schemas/SiteDeploymentPipelineTimeout"},"post_line":{"$ref":"#/components/schemas/SiteDeploymentPipelineTimeout"}},"type":"object"},"tunnels":{"enum":["auto","on","off"],"type":"string"}},"type":"object"},"SiteDeploymentPipelineStageRequest":{"additionalProperties":false,"properties":{"hooks":{"additionalProperties":true,"description":"Build only. Your own lines for each hook of a preset build.","type":"object"},"lines":{"description":"The stage's commands, one a line, at most 200 of them. The database and after-deploy stages take these alone; the build stage takes them with `mode` `custom`.","items":{"description":"One command, at most 8,192 bytes.","maxLength":8192,"type":"string"},"maxItems":200,"type":"array"},"mode":{"description":"Build only.","enum":["preset","custom"],"type":"string"},"platform_step_at":{"description":"Database only. How many of the lines run before the platform's own database step.","minimum":0,"type":"integer"},"preset":{"additionalProperties":true,"description":"Build only, with `mode` `preset`: `platform`, `frontend` (a list) and `options`, from the presets the pipeline read offers.","type":"object"},"revision":{"description":"The pipeline revision you read.","type":"string"}},"type":"object"},"SiteDeploymentPipelineStages":{"properties":{"build":{"additionalProperties":true,"properties":{"effective":{"description":"The lines the build runs.","items":{"$ref":"#/components/schemas/SiteDeploymentPipelineLine"},"type":"array"},"hooks":{"description":"Your own lines to run at points of a preset build, by hook.","type":["object","array"]},"lines":{"description":"With `mode` `custom`, your own build lines.","items":{"$ref":"#/components/schemas/SiteDeploymentPipelineLine"},"type":"array"},"mode":{"enum":["preset","custom"],"type":"string"},"preset":{"additionalProperties":true,"description":"With `mode` `preset`, the `platform` preset, the `frontend` presets and their `options`.","type":["object","null"]}},"required":["mode"],"type":"object"},"database":{"additionalProperties":true,"properties":{"lines":{"items":{"$ref":"#/components/schemas/SiteDeploymentPipelineLine"},"type":"array"},"platform_step_at":{"description":"How many of the lines run before the platform's own database step.","type":"integer"}},"required":["lines"],"type":"object"},"post_deploy":{"additionalProperties":true,"properties":{"lines":{"items":{"$ref":"#/components/schemas/SiteDeploymentPipelineLine"},"type":"array"}},"required":["lines"],"type":"object"}},"required":["build","database","post_deploy"],"type":"object"},"SiteDeploymentPipelineTemplateResetRequest":{"additionalProperties":false,"properties":{"confirm_production":{"description":"True to reset a production environment.","type":"boolean"},"revision":{"description":"The pipeline revision you read.","type":"string"},"stages":{"description":"What to reset, each named once, of the three stages and `settings`. There is no word for all of them, so name each.","items":{"enum":["build","database","post_deploy","settings"],"type":"string"},"maxItems":4,"minItems":1,"type":"array"},"version":{"anyOf":[{"additionalProperties":false,"properties":{"revision":{"minimum":1,"type":"integer"},"template_id":{"minimum":1,"type":"integer"}},"required":["template_id","revision"],"type":"object"},{"additionalProperties":false,"properties":{"corefinity_version":{"minimum":1,"type":"integer"}},"required":["corefinity_version"],"type":"object"}],"description":"An earlier version of the template to hold here instead of following it: a template version's\n`version_ref`, or `corefinity_version` for a version of Corefinity's default.\n"}},"required":["stages","revision"],"type":"object"},"SiteDeploymentPipelineTimeout":{"description":"Seconds, or null for the default.","maximum":3600,"minimum":60,"type":["integer","null"]},"SiteDeploymentPipelineVersion":{"allOf":[{"$ref":"#/components/schemas/SiteDeploymentPipelineVersionSummary"},{"properties":{"compare_to":{"description":"`current`, or the `version_id` compared with.","type":["string","integer"]},"diff":{"additionalProperties":true,"description":"By stage that differs, its lines `before` (this version) and `after` (what it is compared with), and\nunder `settings`, by setting that differs, its value `before` and `after`. Null when nothing differs.\n","type":["object","null"]},"settings":{"description":"The settings as the version held them. Null for a version kept of a pipeline that did not have the three stages yet.","oneOf":[{"$ref":"#/components/schemas/SiteDeploymentPipelineSettings"},{"type":"null"}]},"stages":{"description":"The stages as the version held them. Null for a version kept of a pipeline that did not have the three stages yet.","oneOf":[{"$ref":"#/components/schemas/SiteDeploymentPipelineStages"},{"type":"null"}]}},"required":["compare_to","stages","settings","diff"],"type":"object"}]},"SiteDeploymentPipelineVersionSummary":{"additionalProperties":true,"properties":{"at":{"type":"string"},"by":{"description":"The name of the person who saved it.","type":["string","null"]},"changed":{"description":"The stages this version changed, and `settings`.","items":{"type":"string"},"type":"array"},"number":{"description":"The version's number in this pipeline, counting from 1.","type":"integer"},"restorable":{"type":"boolean"},"restorable_reason":{"description":"Why not, when it cannot be restored.","type":["string","null"]},"source":{"description":"How the version was made, such as `editor`, `restore` or `template`.","type":"string"},"template":{"additionalProperties":true,"description":"For a version a deployment template wrote, the template (`template_id`) and its revision (`template_revision`).","type":"object"},"version_id":{"type":"integer"}},"required":["version_id","number","at","changed","restorable"],"type":"object"},"SiteDeploymentRef":{"description":"The branch and commit a deployment deploys.","properties":{"branch":{"type":["string","null"]},"message":{"description":"The first line of the commit's message.","type":["string","null"]},"sha":{"type":["string","null"]},"short_sha":{"type":["string","null"]}},"required":["branch","sha","short_sha","message"],"type":"object"},"SiteDeploymentRehearsalAnswer":{"properties":{"rehearsal":{"additionalProperties":true,"properties":{"binding_id":{"description":"The pipeline of this environment the rehearsal runs on.","type":"integer"},"failed_line":{"additionalProperties":true,"description":"Present when one line failed. Its `stage`, `index` and `text`.","type":"object"},"failure":{"additionalProperties":true,"description":"Present on a rehearsal that failed. What went wrong, with its `message`.","type":"object"},"finished_at":{"type":["string","null"]},"id":{"type":"integer"},"per_stage":{"additionalProperties":{"type":"string"},"description":"Each part of the rehearsal with where it is, such as `pending` or `skipped`.","type":"object"},"skipped":{"description":"What the rehearsal leaves out, each with why.","items":{},"type":"array"},"started_at":{"type":["string","null"]},"state":{"description":"`running` until the rehearsal has finished, then how it ended, such as `passed`.","type":"string"}},"required":["id","state"],"type":"object"}},"required":["rehearsal"],"type":"object"},"SiteDeploymentRehearsalRequest":{"additionalProperties":false,"properties":{"binding_id":{"description":"This environment's pipeline, or one of another environment of the same site, whose stages then run here.","minimum":1,"type":"integer"},"proposal":{"additionalProperties":true,"description":"Stages or settings that are not saved, by name (`build`, `database`, `post_deploy`, `settings`), each as its save takes it. Checked and rehearsed, never saved.","type":"object"},"ref":{"description":"A branch or a commit to build. The head of the repository's branch when left out.","maxLength":255,"type":"string"}},"required":["binding_id"],"type":"object"},"SiteDeploymentRepository":{"additionalProperties":true,"description":"The repository a site deploys.","properties":{"auto_deploy":{"description":"True when a push to the branch deploys.","type":"boolean"},"branch":{"type":"string"},"connection":{"$ref":"#/components/schemas/SiteDeploymentConnectionRef"},"contents":{"description":"`whole_site` when the repository holds the whole site. `site_content` when it holds part of a WordPress\nsite, such as its themes.\n","enum":["whole_site","site_content"],"type":"string"},"effective_target_path":{"description":"Where a repository of site content goes now. Null for a repository that holds the whole site.","type":["string","null"]},"repo":{"description":"The repository as `owner/name`, in lower case.","type":"string"},"root_directory":{"description":"The folder of the repository that holds the site. Empty for the repository's root.","type":"string"},"target_path":{"description":"Where a repository of site content goes, relative to the site's root. Null for the default.","type":["string","null"]},"url":{"description":"The repository's page at the provider.","type":["string","null"]},"webhook":{"description":"The webhook that tells the Control Panel about pushes.","properties":{"error":{"type":["string","null"]},"last_received_at":{"type":["string","null"]},"state":{"enum":["missing","failed","active","pending"],"type":"string"}},"required":["state","last_received_at","error"],"type":"object"}},"required":["connection","repo","branch","url","root_directory","contents","target_path","effective_target_path","auto_deploy","webhook"],"type":"object"},"SiteDeploymentRepositoryList":{"properties":{"repositories":{"items":{"properties":{"admin":{"description":"True when the connection's account can manage webhooks on the repository, which connecting it needs.","type":"boolean"},"default_branch":{"type":["string","null"]},"name":{"type":"string"},"repo":{"description":"The repository as `owner/name`, as the repository endpoint takes it.","type":"string"},"url":{"type":["string","null"]}},"required":["repo","name","url","default_branch","admin"],"type":"object"},"maxItems":50,"type":"array"}},"required":["repositories"],"type":"object"},"SiteDeploymentRepositoryRequest":{"properties":{"auto_deploy":{"description":"True to deploy every push to the branch.","type":"boolean"},"branch":{"description":"The branch to deploy. No spaces, no `..`, and no `-` at the start.","maxLength":255,"minLength":1,"pattern":"^(?!-)(?!.*\\.\\.)\\S+$","type":"string"},"connection_id":{"description":"A connection from the settings' `connections`.","type":"integer"},"contents":{"description":"`whole_site` or `site_content` (WordPress only). Left out, the repository keeps what it has.\n","enum":["whole_site","site_content",null],"type":["string","null"]},"repo":{"description":"The repository as `owner/name`, or `group/subgroup/name` on GitLab: two or more parts of letters, digits,\n`.`, `_` and `-`, each starting with a letter or a digit, at most 200 characters in all. Spaces around it\nare dropped and it is stored in lower case.\n","maxLength":200,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*(/[A-Za-z0-9][A-Za-z0-9._-]*)+$","type":"string"},"root_directory":{"description":"The folder of the repository that holds the site, relative to the repository's root, such as `web` or\n`apps/site`: letters, digits, `_`, `.`, `-` and `/`, starting with a letter or a digit, at most 121\ncharacters, with no leading `/`, no empty part and no `.` or `..` part. Spaces around it and a closing\n`/` are dropped, and it is stored in lower case. Null, empty or left out for the repository's root. A\nrepository of site content always uses its root.\n","maxLength":121,"pattern":"^$|^[A-Za-z0-9][A-Za-z0-9_./-]{0,120}$","type":["string","null"]},"target_path":{"description":"Where a repository of site content goes, relative to the site's root, such as `wp-content/themes`. Null\nfor the default. Left out, the repository keeps what it has.\n","maxLength":255,"type":["string","null"]}},"required":["connection_id","repo","branch","auto_deploy"],"type":"object"},"SiteDeploymentRetryRequest":{"properties":{"confirm_older":{"description":"True to retry a deployment that is not the site's newest.","type":"boolean"}},"type":"object"},"SiteDeploymentRollbackRequest":{"properties":{"release_id":{"description":"The `release_id` of a successful deployment of this site to roll back to, instead of the deployment in the path.","maxLength":64,"type":["string","null"]}},"type":"object"},"SiteDeploymentSecret":{"description":"One saved registry credential. Never its token or its username.","properties":{"auth_type":{"description":"How a Composer registry signs in. Null for npm.","enum":["http-basic","bearer","github-oauth","gitlab-token",null],"type":["string","null"]},"id":{"minimum":1,"type":"integer"},"kind":{"enum":["npm","composer"],"type":"string"},"label":{"description":"The name you gave the credential.","type":"string"},"last4":{"description":"The last four characters of the token. Null for a token shorter than 12 characters.","type":["string","null"]},"last_used_at":{"description":"When a build last received the credential, in UTC.","format":"date-time","type":["string","null"]},"registry":{"description":"An npm registry's HTTPS URL, with one trailing slash; a Composer registry's host, with its port when that\nis not 443. Both in lower case.\n","type":"string"},"scope":{"description":"The npm scope the credential is for, such as `@northwind-digital`. An empty string for the default registry and for Composer.","type":"string"},"verified_at":{"description":"When the registry last accepted the credential, in UTC. Null when it has not been checked since it last changed.","format":"date-time","type":["string","null"]}},"required":["id","kind","label","registry","scope","auth_type","last4","verified_at","last_used_at"],"type":"object"},"SiteDeploymentSecretCreateRequest":{"additionalProperties":false,"allOf":[{"if":{"properties":{"kind":{"const":"composer"}},"required":["kind"]},"then":{"required":["auth_type"]}},{"if":{"properties":{"auth_type":{"const":"http-basic"},"kind":{"const":"composer"}},"required":["kind","auth_type"]},"then":{"required":["username"]}}],"properties":{"auth_type":{"description":"For Composer, how the registry signs in. Required when `kind` is `composer`.","enum":["http-basic","bearer","github-oauth","gitlab-token"],"type":"string"},"kind":{"enum":["npm","composer"],"type":"string"},"label":{"description":"A name for the credential.","maxLength":255,"minLength":1,"type":"string"},"registry":{"description":"For npm, the registry's HTTPS URL. For Composer, its host name, with a port if it needs one.","maxLength":255,"type":"string"},"scope":{"description":"For npm only, the scope the credential is for, such as `@northwind-digital`: `@`, then letters, digits,\ndots, hyphens and underscores, starting with a letter or digit. Leave out for the default registry.\n","maxLength":214,"type":"string"},"token":{"description":"The token or password, kept exactly as sent. No line breaks or control characters; an npm token may not contain `${`.","maxLength":4096,"minLength":1,"type":"string","writeOnly":true},"username":{"description":"For Composer with `http-basic`, the username, which is then required. No line breaks or control characters.","maxLength":255,"minLength":1,"type":"string"},"verify":{"description":"Ask the registry once, after the save, whether it accepts the credential. The answer then adds `verification`.","type":"boolean"}},"required":["kind","label","registry","token"],"type":"object"},"SiteDeploymentSecretList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SiteDeploymentSecret"},"type":"array"},"verification":{"description":"What the registry answered. Present only when the request sent `verify` true.","properties":{"id":{"description":"The secret that was checked.","minimum":1,"type":"integer"},"message":{"description":"What the registry answered, in plain words.","type":"string"},"verified":{"type":"boolean"},"verified_at":{"format":"date-time","type":["string","null"]}},"required":["id","verified","verified_at","message"],"type":"object"}},"required":["data"],"type":"object"},"SiteDeploymentSecretUpdateRequest":{"additionalProperties":false,"description":"Any of the fields of a new credential but `kind`, or `verify` true on its own. At least one. The credential\nis checked as a whole after the change, so a Composer credential changed to `http-basic` needs a `username`\nunless it already holds one.\n","minProperties":1,"properties":{"auth_type":{"enum":["http-basic","bearer","github-oauth","gitlab-token"],"type":"string"},"label":{"maxLength":255,"minLength":1,"type":"string"},"registry":{"maxLength":255,"type":"string"},"scope":{"maxLength":214,"type":"string"},"token":{"maxLength":4096,"minLength":1,"type":"string","writeOnly":true},"username":{"maxLength":255,"minLength":1,"type":"string"},"verify":{"description":"Ask the registry whether it accepts the credential, after any change in the same request.","type":"boolean"}},"type":"object"},"SiteDeploymentSettings":{"additionalProperties":true,"description":"How a site deploys, with its last 10 deployments.","properties":{"can_change_mode":{"$ref":"#/components/schemas/Availability"},"can_change_repository":{"$ref":"#/components/schemas/Availability"},"can_deploy":{"$ref":"#/components/schemas/Availability"},"can_retry_deployments":{"$ref":"#/components/schemas/Availability"},"can_rollback":{"$ref":"#/components/schemas/Availability"},"can_stop_deployments":{"$ref":"#/components/schemas/Availability"},"can_switch_to_git":{"$ref":"#/components/schemas/Availability"},"can_turn_off_auto_deploy":{"$ref":"#/components/schemas/Availability"},"can_turn_on_auto_deploy":{"$ref":"#/components/schemas/Availability"},"connections":{"description":"The repository connections you may use on this site.","items":{"$ref":"#/components/schemas/SiteDeploymentConnectionRef"},"type":"array"},"conversion":{"description":"The operation that is moving the site's files into the releases layout, while one is running.","oneOf":[{"$ref":"#/components/schemas/OperationSummary"},{"type":"null"}]},"deployments":{"description":"The last 10 deployments, newest first.","items":{"$ref":"#/components/schemas/SiteDeployment"},"maxItems":10,"type":"array"},"layout":{"description":"`releases` once the site's files are in the releases layout git deployments need. Otherwise `plain`.","enum":["releases","plain"],"type":"string"},"manual":{"description":"How to change the site's files while it deploys by upload.","properties":{"note":{"type":"string"},"sftp_command":{"type":["string","null"]}},"required":["note","sftp_command"],"type":"object"},"mode":{"description":"`git` deploys from a repository. `manual` deploys by upload.","enum":["git","manual"],"type":"string"},"mode_label":{"type":"string"},"node":{"additionalProperties":true,"description":"The Node.js version the site's builds use, when one is set.","type":"object"},"pipeline":{"additionalProperties":true,"description":"A summary of the site's deployment pipeline. `bindings` lists the pipelines a deployment can choose with\n`binding_id` (`id`, `label`, `is_default`). The deployment pipeline endpoints answer the rest.\n","type":["object","null"]},"releases":{"additionalProperties":true,"description":"The releases kept on the site.","properties":{"count":{"type":"integer"},"current":{"description":"The live release (`id`, `deployed_at`, `ref`).","type":["object","null"]},"keep":{"description":"How many releases are kept.","type":"integer"},"previous":{"description":"The release before it (`id`, `deployed_at`).","type":["object","null"]}},"required":["keep","count","current","previous"],"type":"object"},"repository":{"description":"The connected repository. Null when none is connected.","oneOf":[{"$ref":"#/components/schemas/SiteDeploymentRepository"},{"type":"null"}]},"repository_options":{"additionalProperties":true,"description":"Whether a repository of site content can be chosen on this site, and what a new connection starts from.","properties":{"default_contents":{"type":"string"},"default_target_path":{"type":["string","null"]},"layout_target_path":{"type":["string","null"]},"site_content":{"type":"boolean"}},"type":["object","null"]}},"required":["mode","mode_label","layout","conversion","repository","repository_options","connections","pipeline","releases","deployments","can_deploy","can_rollback","manual"],"type":"object"},"SiteDeploymentSettingsAnswer":{"properties":{"settings":{"$ref":"#/components/schemas/SiteDeploymentSettings"}},"required":["settings"],"type":"object"},"SiteDeploymentSharedFiles":{"properties":{"files":{"items":{"properties":{"message":{"description":"What to do, in plain words.","type":"string"},"path":{"description":"The file, relative to the site's release.","type":"string"},"shared_path":{"description":"Where the file belongs in the shared folder.","type":"string"},"status":{"description":"`present` is in the shared folder. `from_live_release` is in the live release, and a deployment\nmoves it. `from_htdocs` is in `htdocs`, for a rehearsal. `missing` is in none of them.\n`unreadable` is there, but the site cannot read it.\n","enum":["present","from_live_release","from_htdocs","missing","unreadable"],"type":"string"}},"required":["path","shared_path","status","message"],"type":"object"},"type":"array"},"for":{"enum":["deployment","rehearsal"],"type":"string"},"message":{"type":"string"},"state":{"description":"`missing` when a file is missing or cannot be read. `not_applicable` when the site deploys by upload, so\nthere is nothing to check.\n","enum":["ok","missing","not_applicable"],"type":"string"}},"required":["for","state","message","files"],"type":"object"},"SiteDeploymentVariable":{"additionalProperties":true,"description":"One deployment variable of an environment. Never its value.","properties":{"log_visibility":{"description":"Whether the value may appear in deployment logs. `hidden` masks it there.","enum":["hidden","shown",null],"type":["string","null"]},"masked":{"description":"The mask shown in place of the value. A value of 16 characters or more also shows its last four.","type":"string"},"name":{"description":"The name, without the `CF_` prefix builds see it with.","type":"string"},"overrides":{"description":"The company whose variable of the same name this one takes the place of. Null when there is none.","oneOf":[{"properties":{"company":{"$ref":"#/components/schemas/Named"}},"required":["company"],"type":"object"},{"type":"null"}]},"replaces_platform":{"description":"Whether the name is one CoreStack sets itself, so this value replaces the platform's.","type":"boolean"},"tool_credential":{"description":"A sentence saying the build tool named never reads this variable, when the name is one a build tool reads\nits own credentials from and no stage reads it. Null otherwise.\n","type":["string","null"]},"updated_at":{"description":"When the variable last changed, in UTC.","format":"date-time","type":["string","null"]},"updated_by":{"description":"Always null at present.","type":"null"},"used_in":{"description":"The deployment stages whose commands read the variable.","items":{"enum":["build","database","post_deploy"],"type":"string"},"type":"array"}},"required":["name","masked","log_visibility","replaces_platform","updated_at","used_in","tool_credential"],"type":"object"},"SiteDeploymentVariableList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SiteDeploymentVariable"},"type":"array"},"inherited":{"description":"The company variables that reach this environment. Present while deployment templates are on for your company.","items":{"$ref":"#/components/schemas/SiteDeploymentInheritedVariable"},"type":"array"}},"required":["data"],"type":"object"},"SiteDeploymentVariableSetRequest":{"additionalProperties":false,"properties":{"log_visibility":{"description":"Whether the value may appear in deployment logs. `hidden`, the default, masks it there.","enum":["hidden","shown"],"type":"string"},"value":{"description":"The value, kept exactly as sent: at most 2,048 characters, with no line breaks, control or invisible\nformatting characters. Leave out to change only `log_visibility`.\n","maxLength":2048,"type":"string"}},"type":"object"},"SiteDetail":{"allOf":[{"$ref":"#/components/schemas/SiteSummary"},{"properties":{"access_summary":{"type":["object","null"]},"actions":{"additionalProperties":{"$ref":"#/components/schemas/Availability"},"description":"What you can do with the row now. Each entry says whether it is available and, when not, why.","type":["object","null"]},"adoption":{"type":["string","null"]},"cloudflare":{"type":["object","null"]},"cluster":{"$ref":"#/components/schemas/ClusterRef"},"commands":{"items":{"type":"object"},"type":"array"},"counts":{"additionalProperties":{"type":"integer"},"description":"How many scheduled tasks and redirects the row has, each while its feature is on.","type":"object"},"crons_enabled":{"type":["boolean","null"]},"database":{"description":"How to connect to the database. The password is never in this answer.","type":["object","null"]},"deleted":{"description":"When the site was deleted and until when it can be restored. Null for a site that is not deleted.","type":["object","null"]},"deploy_mode":{"type":["string","null"]},"deploy_mode_label":{"type":["string","null"]},"deployments_summary":{"type":["object","null"]},"domains_summary":{"type":["object","null"]},"email_summary":{"type":["object","null"]},"environments":{"items":{"$ref":"#/components/schemas/EnvironmentRef"},"type":"array"},"http_auth_summary":{"type":["object","null"]},"lifecycle":{"description":"Where the row is in its life, such as `active` or `deleted`.","type":"string"},"live":{"description":"The status last read from the cluster. Null until one has been read.","type":["object","null"]},"maintenance":{"type":["object","null"]},"operations":{"description":"The row's most recent operations.","items":{"$ref":"#/components/schemas/Operation"},"type":"array"},"preview":{"description":"The row's platform address, and whether HTTP authentication protects it.","type":["object","null"]},"production_hosts":{"items":{"type":"string"},"type":"array"},"provisioning":{"type":["object","null"]},"runtime":{"description":"The PHP, MariaDB and Node.js versions with the versions the row can change to.","type":"object"},"settings":{"description":"The environment's own switches, as `PATCH /corestack/sites/{site}/environment` sets them.","properties":{"auto_deploy":{"description":"Whether the environment deploys automatically from Git.","type":"boolean"},"http_auth_enabled":{"description":"Whether HTTP authentication is on for the whole environment.","type":"boolean"},"scheduled_snapshots":{"description":"Whether scheduled snapshots are on.","type":"boolean"}},"type":["object","null"]},"ssh":{"description":"How to connect over SSH and SFTP.","type":["object","null"]}},"type":"object"}],"description":"One site or environment in full. The summaries (`domains_summary`, `access_summary` and the others) are short\nforms of what the endpoints of each feature answer in full.\n"},"SiteFunction":{"additionalProperties":true,"properties":{"availability":{"$ref":"#/components/schemas/Availability"},"confirm":{"description":"True when a run must send `\"confirm\": true`.","type":"boolean"},"description":{"type":"string"},"effect":{"type":"string"},"group":{"type":["string","null"]},"group_label":{"type":["string","null"]},"inputs":{"description":"The inputs a run takes, each with its name and type.","items":{"additionalProperties":true,"type":"object"},"type":"array"},"key":{"description":"The `{function}` to run it with.","type":"string"},"label":{"type":"string"},"last":{"description":"The last run, in short.","type":["object","null"]},"limits":{"properties":{"per_hour":{"type":["integer","null"]}},"type":"object"},"sync":{"type":"boolean"}},"required":["key","label","description","confirm","inputs","availability"],"type":"object"},"SiteFunctionList":{"additionalProperties":true,"properties":{"functions":{"items":{"$ref":"#/components/schemas/SiteFunction"},"type":"array"},"groups":{"items":{"properties":{"key":{"type":"string"},"label":{"type":"string"}},"type":"object"},"type":"array"},"maintenance":{"description":"The site's maintenance page state.","type":["object","null"]},"platform":{"type":"string"},"running":{"description":"A command that is running now, if any."}},"required":["platform","functions"],"type":"object"},"SiteFunctionRun":{"properties":{"command":{"$ref":"#/components/schemas/Command"},"secret":{"description":"A password the tool created, answered once and never stored. Sent only by tools that create one."}},"required":["command"],"type":"object"},"SiteInstallLogin":{"properties":{"credentials":{"additionalProperties":true,"properties":{"admin":{"description":"The admin login. Null for a platform whose install has no admin.","oneOf":[{"additionalProperties":true,"properties":{"password":{"type":"string"},"url":{"type":"string"},"username":{"type":"string"}},"type":"object"},{"type":"null"}]},"note":{"type":"string"},"revealed_at":{"format":"date-time","type":"string"}},"required":["admin","revealed_at","note"],"type":"object"},"remaining":{"description":"Always 0: the login is shown once.","type":"integer"},"revealed_at":{"format":"date-time","type":"string"}},"required":["credentials","revealed_at","remaining"],"type":"object"},"SiteList":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"sites":{"items":{"$ref":"#/components/schemas/SiteListEntry"},"type":"array"}},"required":["sites"],"type":"object"}]},"SiteListEntry":{"allOf":[{"$ref":"#/components/schemas/SiteSummary"},{"properties":{"cluster":{"$ref":"#/components/schemas/ClusterRef"},"covers_site":{"description":"Always true on this endpoint.","type":"boolean"},"environment_count":{"description":"How many environments the site has besides production.","type":"integer"},"environments":{"description":"Every row of the site, the production row first.","items":{"$ref":"#/components/schemas/EnvironmentRef"},"type":"array"}},"required":["environments","environment_count","covers_site","site","platform","cluster"],"type":"object"}],"description":"One site of the list, with its environments."},"SiteMaintenanceWindow":{"additionalProperties":true,"description":"A site's maintenance window. An environment answers its website's window.","properties":{"edit_refusal":{"$ref":"#/components/schemas/MaintenanceWindowEditRefusal"},"editable":{"type":"boolean"},"effective":{"$ref":"#/components/schemas/MaintenanceWindowEffective"},"inherited":{"$ref":"#/components/schemas/MaintenanceWindowInherited"},"next":{"description":"The next occurrence of the window.","oneOf":[{"$ref":"#/components/schemas/MaintenanceWindowSlot"},{"type":"null"}]},"notice_period":{"$ref":"#/components/schemas/MaintenanceWindowNoticePeriod"},"own":{"$ref":"#/components/schemas/MaintenanceWindowOwn"},"pending":{"description":"Changes waiting for the window.","properties":{"count":{"type":"integer"},"notice":{"description":"Whether you are told about them before they apply.","type":"boolean"}},"required":["count","notice"],"type":"object"},"restamped":{"description":"Sent after a change: how many queued changes moved to the new window.","type":"integer"},"site":{"$ref":"#/components/schemas/SiteRef"},"snapshot_overlap":{"$ref":"#/components/schemas/MaintenanceWindowSnapshotOverlap"}},"required":["site","effective","own","inherited","next","pending","snapshot_overlap","notice_period","editable"],"type":"object"},"SiteProgress":{"additionalProperties":true,"properties":{"capacity":{"description":"What the create is waiting for while capacity is being added.","type":["object","null"]},"cluster":{"description":"The cluster the site is created in.","type":["object","null"]},"elapsed_seconds":{"type":["integer","null"]},"environments":{"description":"The progress of each environment created with the site.","items":{"type":"object"},"type":"array"},"failed":{"type":["object","null"]},"operation":{"$ref":"#/components/schemas/Operation"},"order":{"type":["object","null"]},"payment":{"description":"Null unless the site was created before your company had a payment method. Then `add_by` is the date to add\none by and `message` says so in plain words.\n","type":["object","null"]},"requested":{"oneOf":[{"$ref":"#/components/schemas/SiteProgressRequest"},{"type":"null"}]},"retried":{"description":"The same for a retry of the create, or null.","oneOf":[{"$ref":"#/components/schemas/SiteProgressRequest"},{"type":"null"}]},"site":{"$ref":"#/components/schemas/SiteSummary"},"stages":{"items":{"$ref":"#/components/schemas/ProgressStage"},"type":"array"},"state":{"enum":["creating","capacity_being_added","ready","failed"],"type":"string"}},"required":["site","operation","state","stages","requested","retried","payment"],"type":"object"},"SiteProgressRequest":{"description":"When something was asked for, and by whom.","properties":{"at":{"description":"Sent with an offset, as `2026-11-14T09:00:00+00:00`.","format":"date-time","type":["string","null"]},"by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]}},"required":["at","by"],"type":"object"},"SiteProvisioningProgress":{"additionalProperties":true,"properties":{"credentials":{"description":"Always null here. The login is revealed once, with its own endpoint.","type":"null"},"credentials_state":{"description":"Whether a one-time admin login is waiting to be revealed.","enum":["none","pending","available","viewed"],"type":"string"},"eta_seconds":{"type":["integer","null"]},"operation":{"$ref":"#/components/schemas/Operation"},"preview_credentials_note":{"type":["string","null"]},"reset_target":{"type":["object","string","null"]},"revealed":{"type":["object","null"]},"seed":{"type":["object","null"]},"site":{"additionalProperties":true,"properties":{"content":{"description":"`fresh` for a new install, `empty` for an empty site.","type":["string","null"]},"domain":{"type":"string"},"id":{"minimum":1,"type":"integer"},"platform":{"type":"string"},"preview_url":{"type":["string","null"]},"site_id":{"description":"The site's name on the platform, such as `rs-northwind-harbourandfinch-example-com`.","type":"string"},"ssh_port":{"type":["integer","null"]}},"required":["id","domain"],"type":"object"}},"required":["operation","site","credentials_state","credentials"],"type":"object"},"SiteRef":{"additionalProperties":true,"description":"A site by its id and domain.","properties":{"domain":{"type":"string"},"id":{"type":"integer"}},"required":["id","domain"],"type":"object"},"SiteSummary":{"additionalProperties":true,"description":"A site or environment row as lists and progress answers show it. Other fields may be present; the ones named\nhere are always sent.\n","properties":{"compute_family":{"type":["string","null"]},"domain":{"type":"string"},"environment":{"oneOf":[{"$ref":"#/components/schemas/EnvironmentRef"},{"type":"null"}]},"health":{"enum":["healthy","degraded","down","applying","unknown","not_live"],"type":"string"},"hosting":{"additionalProperties":true,"properties":{"cluster_kind":{"description":"`customer` for a site in one of your CoreClusters, `platform` for a standalone CoreStack site.","type":"string"},"label":{"type":"string"}},"type":["object","null"]},"id":{"description":"The site row id, the `{site}` of every `/corestack/sites/{site}` endpoint.","type":"integer"},"kind":{"description":"On a read (a site, the list of sites, a CoreCluster's sites, the overview): `corecluster` for a site in one\nof your CoreClusters, `corestack` for a standalone CoreStack site. The answer to a change that carries the\nrow, such as creating a site, can send `corestack` for either; `hosting.cluster_kind` tells the two apart\non every answer.\n","enum":["corecluster","corestack"],"type":"string"},"limits":{"additionalProperties":true,"properties":{"cpu_millicores":{"type":["integer","null"]},"disk_bytes":{"type":["integer","null"]},"memory_bytes":{"type":["integer","null"]}},"type":"object"},"logs":{"type":["object","null"]},"mariadb":{"additionalProperties":true,"properties":{"version":{"type":["string","null"]}},"type":"object"},"mode":{"description":"`production` once a domain is attached, `staging` before.","enum":["production","staging","unknown"],"type":"string"},"mode_label":{"type":"string"},"operation":{"description":"The change running on the row now, or null.","oneOf":[{"$ref":"#/components/schemas/OperationSummary"},{"type":"null"}]},"package":{"description":"The package of a standalone CoreStack site, with its `key`, `code` and `name`. Null for a CoreCluster site.","type":["object","null"]},"pending_changes":{"additionalProperties":true,"description":"The changes waiting for the row's next maintenance window.","properties":{"count":{"type":"integer"},"window_starts_at":{"type":["string","null"]}},"type":"object"},"php":{"additionalProperties":true,"properties":{"version":{"type":["string","null"]}},"type":"object"},"platform":{"properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"],"type":"object"},"platform_url":{"description":"The row's own address on the platform.","type":["string","null"]},"primary_url":{"type":["string","null"]},"removed":{"type":"boolean"},"restore":{"description":"The restore running on the row now, or null.","type":["object","null"]},"site":{"description":"The site the row belongs to. For a production row, the row itself.","oneOf":[{"$ref":"#/components/schemas/SiteRef"},{"type":"null"}]},"site_id":{"description":"The row's platform identifier.","type":"string"},"snapshots":{"additionalProperties":true,"description":"A summary of the row's snapshots.","properties":{"count":{"type":"integer"},"effective_frequency":{"type":"string"},"effective_label":{"type":"string"},"latest_ready_at":{"type":["string","null"]},"next_scheduled_at":{"type":["string","null"]},"overridden":{"type":"boolean"},"stored_gb":{"type":"number"}},"type":"object"},"tier":{"description":"The size of the row, such as `S`, `M` or `L`.","type":["string","null"]},"uat_size":{"description":"The size of a staging environment. Null for a production row.","type":["string","null"]},"usage":{"additionalProperties":true,"properties":{"cpu_millicores":{"type":["number","null"]},"disk_used_bytes":{"type":["number","null"]},"memory_bytes":{"type":["number","null"]},"observed_at":{"type":["string","null"]},"source":{"type":["string","null"]}},"type":"object"}},"required":["id","domain","mode","mode_label","kind","health","primary_url","php","mariadb","tier","limits","usage","operation","removed"],"type":"object"},"Snapshot":{"additionalProperties":true,"description":"A copy of one site's files and database at one moment.","properties":{"archived":{"description":"True for a snapshot kept from before the site moved storage. Only Corefinity support can restore it.","type":"boolean"},"available":{"description":"Whether it can be used as a source now. Sent only while restoring to another environment is on for your company.","type":"boolean"},"can_delete":{"description":"Whether you can delete it now.","type":"boolean"},"can_protect":{"description":"Whether you can keep it, or stop keeping it, now.","type":"boolean"},"created_at":{"format":"date-time","type":["string","null"]},"delete_reason":{"description":"Why the snapshot was deleted. Null until a delete is asked for.","oneOf":[{"enum":["retention","quota","manual","failed_cleanup","cluster_deleted","clone_cleanup","operator_expired","site_purged","rehome_expired","volume_retired"],"type":"string"},{"type":"null"}]},"delete_reason_label":{"type":["string","null"]},"deleted_at":{"format":"date-time","type":["string","null"]},"error":{"description":"Why the snapshot failed, in plain words.","type":["string","null"]},"expires_at":{"description":"When retention removes the snapshot. Null while it is kept or no retention is set.","format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"in_use":{"description":"Whether a restore or a copy is reading it. Sent only while restoring to another environment is on for your company.","type":"boolean"},"kept":{"description":"The same as `protected`. Sent only while restoring to another environment is on for your company.","type":"boolean"},"kind":{"description":"Why the snapshot was taken.","enum":["scheduled","manual","pre_restore","final","clone","pre_deploy"],"type":"string"},"kind_label":{"type":"string"},"mariadb_version":{"type":["string","null"]},"note":{"type":["string","null"]},"php_version":{"type":["string","null"]},"protected":{"description":"True while the snapshot is kept.","type":"boolean"},"ready_at":{"format":"date-time","type":["string","null"]},"requested_by":{"oneOf":[{"$ref":"#/components/schemas/PersonRef"},{"type":"null"}]},"restorable":{"$ref":"#/components/schemas/SnapshotRestorable"},"restore_size_bytes":{"description":"The size of the site the snapshot restores to. Null until it is known.","type":["integer","null"]},"status":{"description":"`retrying` is a scheduled snapshot that failed and will be tried again; `retried` is a failed attempt that\na later one replaced.\n","enum":["pending","creating","ready","failed","deleting","deleted","retrying","retried"],"type":"string"},"status_label":{"type":"string"},"stored_bytes":{"description":"The space the snapshot uses. Null until it is measured.","type":["integer","null"]},"unavailable_reason":{"description":"Why it cannot be used as a source. Sent only when `available` is false.","type":"string"}},"required":["id","kind","kind_label","status","status_label","archived","created_at","ready_at","note","protected","restore_size_bytes","stored_bytes","php_version","mariadb_version","expires_at","requested_by","error","deleted_at","delete_reason","delete_reason_label","restorable","can_delete","can_protect"],"type":"object"},"SnapshotClusterSettings":{"description":"A CoreCluster's snapshot settings.","properties":{"can_change_frequency":{"description":"False when the CoreCluster's package sets its snapshot settings.","type":"boolean"},"can_change_limits":{"description":"Always false for you. The quota and the retention are set by Corefinity.","type":"boolean"},"enabled":{"type":"boolean"},"frequency":{"$ref":"#/components/schemas/SnapshotFrequency"},"frequency_label":{"type":"string"},"frequency_options":{"items":{"$ref":"#/components/schemas/SnapshotFrequencyOption"},"type":"array"},"over_quota":{"type":"boolean"},"protect_cap_bytes":{"type":["integer","null"]},"protected_bytes":{"type":"integer"},"pruned_recently":{"type":"boolean"},"quota_bytes":{"type":["integer","null"]},"retention_days":{"type":["integer","null"]},"usage_bytes":{"type":["integer","null"]},"usage_synced_at":{"format":"date-time","type":["string","null"]}},"required":["enabled","frequency","frequency_label","frequency_options","quota_bytes","retention_days","usage_bytes","usage_synced_at","protected_bytes","protect_cap_bytes","pruned_recently","over_quota","can_change_frequency","can_change_limits"],"type":"object"},"SnapshotClusterSettingsRequest":{"properties":{"frequency":{"$ref":"#/components/schemas/SnapshotFrequency"}},"required":["frequency"],"type":"object"},"SnapshotCreateRequest":{"properties":{"note":{"maxLength":140,"type":["string","null"]}},"type":"object"},"SnapshotFrequency":{"description":"How often scheduled snapshots are taken.","enum":["1h","2h","3h","4h","6h","12h","daily","weekly","monthly","off"],"type":"string"},"SnapshotFrequencyOption":{"properties":{"label":{"type":"string"},"value":{"$ref":"#/components/schemas/SnapshotFrequency"}},"required":["value","label"],"type":"object"},"SnapshotList":{"properties":{"restore":{"description":"The restore still running on the site, as `GET /corestack/restores/{restore}` answers it, or null.","oneOf":[{"$ref":"#/components/schemas/Restore"},{"type":"null"}]},"settings":{"$ref":"#/components/schemas/SnapshotSiteSettings"},"snapshots":{"items":{"$ref":"#/components/schemas/Snapshot"},"type":"array"}},"required":["settings","snapshots","restore"],"type":"object"},"SnapshotRestorable":{"additionalProperties":true,"description":"What the snapshot can be restored as now, and why not when it cannot.","properties":{"database":{"type":"boolean"},"everything":{"type":"boolean"},"files":{"type":"boolean"},"reason":{"description":"Why something cannot be restored, in plain words.","type":["string","null"]}},"required":["everything","database","files"],"type":"object"},"SnapshotScheduledFailure":{"properties":{"at":{"format":"date-time","type":["string","null"]},"error":{"type":"string"}},"required":["at","error"],"type":"object"},"SnapshotSiteFrequencyRequest":{"properties":{"frequency":{"description":"The site's own frequency, or null to follow the default.","oneOf":[{"$ref":"#/components/schemas/SnapshotFrequency"},{"type":"null"}]}},"required":["frequency"],"type":"object"},"SnapshotSiteSettings":{"description":"One site's snapshot settings.","properties":{"cluster_frequency":{"$ref":"#/components/schemas/SnapshotFrequency","description":"The default the site follows, its CoreCluster's or, for a CoreStack site, its package's."},"cluster_label":{"type":"string"},"effective_frequency":{"$ref":"#/components/schemas/SnapshotFrequency"},"effective_label":{"type":"string"},"enabled":{"description":"Whether snapshots are enabled for the site.","type":"boolean"},"frequency":{"description":"The site's own frequency. Null while it follows the default.","oneOf":[{"$ref":"#/components/schemas/SnapshotFrequency"},{"type":"null"}]},"frequency_options":{"items":{"$ref":"#/components/schemas/SnapshotFrequencyOption"},"type":"array"},"last_scheduled_failed":{"description":"The latest scheduled snapshot, if it failed and will not be tried again.","oneOf":[{"$ref":"#/components/schemas/SnapshotScheduledFailure"},{"type":"null"}]},"manual_remaining_this_hour":{"description":"How many more one-off snapshots can be taken this hour.","type":"integer"},"next_scheduled_at":{"format":"date-time","type":["string","null"]},"over_quota":{"type":"boolean"},"per_site":{"description":"True for a CoreStack site, whose quota figures below are its own package's, measured over the site and its\nenvironments. False for a site on a CoreCluster, where the figures below are null, 0 or false and the\nCoreCluster's snapshot settings carry them.\n","type":"boolean"},"policy_source":{"description":"Where the schedule and the retention come from: the site's `package`, its CoreCluster (`cluster`), or the\nschedule kept for a site moved from CoreStack Enterprise (`cse_move`). Null when the site has none.\n","oneOf":[{"enum":["package","cluster","cse_move"],"type":"string"},{"type":"null"}]},"protect_cap_bytes":{"description":"The most space kept snapshots may use.","type":["integer","null"]},"protected_bytes":{"description":"The space kept snapshots use.","type":"integer"},"pruned_recently":{"description":"True when the quota removed snapshots in the last 24 hours.","type":"boolean"},"quota_bytes":{"type":["integer","null"]},"retention_days":{"description":"How many days a snapshot is kept before retention removes it. Null when no retention is set.","type":["integer","null"]},"usage_bytes":{"description":"Null until sizes have been measured for the first time.","type":["integer","null"]},"usage_synced_at":{"format":"date-time","type":["string","null"]}},"required":["frequency","effective_frequency","effective_label","cluster_frequency","cluster_label","frequency_options","next_scheduled_at","manual_remaining_this_hour","last_scheduled_failed","enabled","per_site","quota_bytes","usage_bytes","usage_synced_at","protected_bytes","protect_cap_bytes","pruned_recently","over_quota"],"type":"object"},"SnapshotUpdateRequest":{"properties":{"note":{"description":"Null clears the note.","maxLength":140,"type":["string","null"]},"protected":{"description":"True keeps the snapshot until you stop keeping it.","type":"boolean"}},"type":"object"},"SshActivityEvent":{"description":"One entry of the SSH activity list.","properties":{"action":{"enum":["key.added","key.updated","key.removed","key.quarantined","legacy.imported","legacy.kept","legacy.placed","legacy.removed","legacy.cut_off","login.issued","login.retired","host_keys.adopted","host_keys.staged","host_keys.promoted","host_keys.rotated_now","host_keys.aborted","host_keys.republished","delivery.adopted","delivery.applied","delivery.failed","revocation.pending","revocation.applied","revocation.lifted"],"type":"string"},"actor":{"description":"Who did it. Null for the platform.","oneOf":[{"$ref":"#/components/schemas/SshAddedBy"},{"type":"null"}]},"at":{"format":"date-time","type":"string"},"channel":{"description":"Where the change was made, such as `ui` (the Control Panel), `api` or `mcp`.","enum":["ui","api","mcp","cli","import","system","staff"],"type":"string"},"fingerprint":{"description":"The key the event is about, when it is about one.","pattern":"^SHA256:[A-Za-z0-9+/]{43}$","type":["string","null"]},"layer":{"enum":["agency","company","website","environment","user","legacy","system",null],"type":["string","null"]},"login":{"type":["string","null"]},"owner":{"oneOf":[{"$ref":"#/components/schemas/SshOwner"},{"type":"null"}]},"reason":{"type":["string","null"]}},"required":["at","actor","channel","action","fingerprint","layer","owner","login","reason"],"type":"object"},"SshActivityPage":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"events":{"items":{"$ref":"#/components/schemas/SshActivityEvent"},"type":"array"}},"required":["events"],"type":"object"}],"description":"A page of SSH activity, newest first."},"SshAddOption":{"description":"A level you may add a key at from this environment.","properties":{"level":{"enum":["environment","website","company","user"],"type":"string"},"login":{"description":"The username a key added at this level logs in with.","type":"string"},"owner":{"$ref":"#/components/schemas/SshOwner"},"reach":{"$ref":"#/components/schemas/SshReachCount"}},"required":["level","owner","login","reach"],"type":"object"},"SshAddRefusal":{"description":"A level you can see but may not add a key at, with the reason.","properties":{"level":{"enum":["company"],"type":"string"},"message":{"type":"string"},"refused":{"enum":["forbidden"],"type":"string"}},"required":["level","refused","message"],"type":"object"},"SshAddedBy":{"description":"Who added a key or made a change.","properties":{"former":{"description":"True when the person has left the company.","type":"boolean"},"name":{"description":"Null when the person has been removed, or when Corefinity support made the change for nobody by name.","type":["string","null"]},"support":{"description":"True when Corefinity support added the key or made the change. `name` is then the person it was done for, or null.","type":"boolean"}},"required":["name","former","support"],"type":"object"},"SshAgencyClients":{"description":"An agency's client companies.","properties":{"clients":{"items":{"properties":{"environments":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name","environments"],"type":"object"},"type":"array"}},"required":["clients"],"type":"object"},"SshAppliesTo":{"description":"The environments a company or website key reaches.","properties":{"environment_ids":{"description":"Empty unless `mode` is `selected`.","items":{"type":"integer"},"type":"array"},"mode":{"description":"`all` reaches every environment of the owner. `selected` reaches `environment_ids` only. `cscc` reaches the company's CoreStack and CoreCluster environments; it is read-only and never accepted in a request.","enum":["all","selected","cscc"],"type":"string"}},"required":["mode","environment_ids"],"type":"object"},"SshAppliesToInput":{"description":"The environments a company or website key applies to: the word `all`, `{mode: all}`, or a selection. A\nselection with `environment_ids` and no `mode` means `selected`.\n","oneOf":[{"const":"all","type":"string"},{"additionalProperties":false,"properties":{"mode":{"const":"all","type":"string"}},"required":["mode"],"type":"object"},{"additionalProperties":false,"properties":{"environment_ids":{"description":"Environment ids. Each must be one the owner reaches.","items":{"minimum":1,"type":"integer"},"maxItems":500,"minItems":1,"type":"array"},"mode":{"const":"selected","type":"string"}},"required":["environment_ids"],"type":"object"}]},"SshCanAdd":{"description":"Whether you may add a key here.","properties":{"allowed":{"type":"boolean"},"refused":{"description":"Why not. `managed_elsewhere`, which only an environment's answer gives, means the keys are managed on another environment of the same server (`managed_on`).","enum":["managed_elsewhere",null],"type":["string","null"]}},"required":["allowed","refused"],"type":"object"},"SshChange":{"description":"A change to keys, and how far it has been applied.","properties":{"applied":{"description":"Environments the change is live on.","type":"integer"},"failed":{"description":"The environments the change failed on, each with a reason.","items":{"properties":{"environment_id":{"type":"integer"},"reason":{"type":"string"}},"required":["environment_id","reason"],"type":"object"},"type":"array"},"id":{"type":"integer"},"not_on_new_system":{"description":"Environments whose keys the Control Panel does not manage yet. Not counted in `total`.","type":"integer"},"state":{"description":"`applied` and `failed` are final.","enum":["applying","applied","failed"],"type":"string"},"total":{"description":"Environments the change goes to.","type":"integer"},"waiting":{"description":"Environments that take the change only when they switch over or get a platform update.","type":"integer"}},"required":["id","state","applied","total","waiting","not_on_new_system","failed"],"type":"object"},"SshCompanyCanAdd":{"description":"Whether you may add a company key.","properties":{"allowed":{"type":"boolean"},"message":{"description":"The sentence a `forbidden` add is refused with.","type":["string","null"]},"refused":{"description":"Why not. `forbidden` means your role lacks the Create Company SSH Keys permission.","enum":["forbidden",null],"type":["string","null"]}},"required":["allowed","refused","message"],"type":"object"},"SshCompanyKeys":{"description":"A company's SSH keys.","properties":{"agency":{"description":"The clients of an agency. Null unless the company is an agency with clients.","oneOf":[{"$ref":"#/components/schemas/SshAgencyClients"},{"type":"null"}]},"can_add":{"$ref":"#/components/schemas/SshCompanyCanAdd"},"company":{"properties":{"handle":{"description":"The company's SSH handle, the first part of its people's usernames.","type":["string","null"]},"id":{"type":"integer"},"is_agency":{"type":"boolean"},"name":{"type":"string"}},"required":["id","name","is_agency","handle"],"type":"object"},"grants":{"description":"The company's own keys.","items":{"$ref":"#/components/schemas/SshKey"},"type":"array"},"inherited":{"description":"Your agency's keys that reach this company. Read-only.","items":{"$ref":"#/components/schemas/SshKey"},"type":"array"},"legacy":{"description":"The company's Legacy keys, counted.","properties":{"count":{"type":"integer"},"ends_on":{"format":"date","type":["string","null"]},"environments":{"type":"integer"}},"required":["count","environments","ends_on"],"type":"object"},"reach":{"$ref":"#/components/schemas/SshReach"}},"required":["company","grants","inherited","reach","agency","legacy","can_add"],"type":"object"},"SshConnection":{"description":"How to connect to the environment over SSH.","properties":{"host":{"type":["string","null"]},"host_keys":{"$ref":"#/components/schemas/SshHostKeys"},"port":{"type":["integer","null"]},"tunnel_target":{"description":"The `host:port` a database tunnel forwards to. Null when there is none.","type":["string","null"]},"web_command":{"description":"The `ssh` command for the shared `web` user.","type":["string","null"]},"your_login":{"$ref":"#/components/schemas/SshYourLogin"}},"required":["host","port","web_command","tunnel_target","your_login","host_keys"],"type":"object"},"SshDelivery":{"description":"Whether the environment's keys are managed by the Control Panel, and whether the latest change is live.","properties":{"applied_at":{"format":"date-time","type":["string","null"]},"group_write":{"description":"CoreStack Enterprise only; null elsewhere.","enum":["off","rolling","verified",null],"type":["string","null"]},"last_error_public":{"description":"Why the last change failed, in plain words.","type":["string","null"]},"mode":{"description":"`managed` once the Control Panel manages the environment's keys.","enum":["legacy","managed"],"type":"string"},"next_attempt_at":{"description":"When a failed change is tried again.","format":"date-time","type":["string","null"]},"not_on_new_system":{"description":"True when the Control Panel does not manage this environment's keys and no switch-over is planned.","type":"boolean"},"planned_for":{"description":"When the environment is planned to switch over.","format":"date-time","type":["string","null"]},"state":{"enum":["pending","applying","applied","failed","drift","waiting","unmanaged"],"type":"string"},"verified_at":{"format":"date-time","type":["string","null"]},"waiting_for":{"description":"What a waiting environment waits for.","enum":["adoption","platform_update","persons_gate","cli_override",null],"type":["string","null"]}},"required":["mode","group_write","state","applied_at","verified_at","waiting_for","planned_for","next_attempt_at","last_error_public","not_on_new_system"],"type":"object"},"SshEffectiveKey":{"description":"One key that can log in to an environment, as that environment sees it.","properties":{"added_at":{"format":"date-time","type":["string","null"]},"added_by":{"oneOf":[{"$ref":"#/components/schemas/SshAddedBy"},{"type":"null"}]},"bits":{"description":"The key size, for RSA keys.","type":["integer","null"]},"delivery":{"description":"Whether the key works on this environment yet.","properties":{"planned_for":{"description":"When a waiting environment is planned to switch over.","format":"date-time","type":["string","null"]},"state":{"description":"`waiting` means the environment has not switched to keys managed by the Control Panel yet.","enum":["applied","applying","removing","failed","waiting"],"type":"string"}},"required":["state","planned_for"],"type":"object"},"editable":{"description":"Whether you may rename the key or change where it applies.","type":"boolean"},"fingerprint":{"description":"The SHA-256 fingerprint, as `ssh-keygen -lf` prints it.","pattern":"^SHA256:[A-Za-z0-9+/]{43}$","type":"string"},"id":{"description":"The key id the `/ssh/keys/{key}` endpoints take. Null for the Corefinity deploy key.","type":["integer","null"]},"last_used_at":{"format":"date-time","type":["string","null"]},"legacy":{"description":"Set for a Legacy key, else null.","oneOf":[{"$ref":"#/components/schemas/SshLegacyState"},{"type":"null"}]},"name":{"type":"string"},"removable":{"description":"Whether you may remove the key.","type":"boolean"},"restricted":{"description":"True when the key carries restrictions from before it was imported.","type":"boolean"},"restrictions":{"description":"The restrictions as they are written in front of the key. Read-only.","items":{"type":"string"},"type":"array"},"source":{"$ref":"#/components/schemas/SshKeySource"},"type":{"description":"The key type, such as `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, `ecdsa-sha2-nistp521` or `ssh-rsa`. A key imported from a server may carry an older type (`ssh-dss`) or a security-key type (`sk-`), which new keys may not.","enum":["ssh-ed25519","ecdsa-sha2-nistp256","ecdsa-sha2-nistp384","ecdsa-sha2-nistp521","ssh-rsa","ssh-dss","sk-ssh-ed25519@openssh.com","sk-ecdsa-sha2-nistp256@openssh.com"],"type":"string"},"weak":{"description":"True for a key that would be refused if it were added today.","type":"boolean"}},"required":["id","name","type","bits","weak","fingerprint","source","added_by","added_at","last_used_at","restricted","restrictions","legacy","delivery","editable","removable"],"type":"object"},"SshEnvironmentAccess":{"description":"Who can log in to an environment over SSH, and how to connect.","properties":{"add_options":{"description":"The levels you may add a key at.","items":{"$ref":"#/components/schemas/SshAddOption"},"type":"array"},"add_refusals":{"description":"Levels left out of `add_options` because your role may not add there.","items":{"$ref":"#/components/schemas/SshAddRefusal"},"type":"array"},"can_add":{"$ref":"#/components/schemas/SshCanAdd"},"connection":{"$ref":"#/components/schemas/SshConnection"},"delivery":{"$ref":"#/components/schemas/SshDelivery"},"environment":{"$ref":"#/components/schemas/SshEnvironmentRef"},"forwarding":{"$ref":"#/components/schemas/SshForwarding"},"legacy":{"$ref":"#/components/schemas/SshLegacySummary"},"logins":{"description":"Each username with its keys.","items":{"$ref":"#/components/schemas/SshLogin"},"type":"array"},"managed_on":{"description":"Set when this environment shares a server with another one that manages its keys. Keys are then changed on that environment.","oneOf":[{"$ref":"#/components/schemas/Named"},{"type":"null"}]},"notes":{"description":"Sentences about the environment's state, in plain words.","items":{"type":"string"},"type":"array"}},"required":["environment","connection","logins","delivery","legacy","forwarding","can_add","add_options","add_refusals","notes","managed_on"],"type":"object"},"SshEnvironmentRef":{"description":"An environment, with the website and company it belongs to.","properties":{"company":{"$ref":"#/components/schemas/Named"},"id":{"description":"The environment id, the `{environment}` these endpoints take and the `owner.id` of an environment key.","type":"integer"},"name":{"type":"string"},"product":{"description":"`cse` is CoreStack Enterprise.","enum":["cse","corestack","corecluster"],"type":"string"},"site_id":{"description":"The site row id the `/corestack/sites/{site}` endpoints take. Null on CoreStack Enterprise.","type":["integer","null"]},"website":{"$ref":"#/components/schemas/Named"}},"required":["id","name","product","site_id","website","company"],"type":"object"},"SshForwarding":{"description":"Where SSH port forwarding may connect to.","properties":{"restricted":{"type":"boolean"},"targets":{"items":{"type":"string"},"type":"array"}},"required":["restricted","targets"],"type":"object"},"SshHostKey":{"description":"One of the server's host keys.","properties":{"fingerprint":{"pattern":"^SHA256:[A-Za-z0-9+/]{43}$","type":"string"},"type":{"enum":["ed25519","ecdsa","rsa"],"type":"string"}},"required":["type","fingerprint"],"type":"object"},"SshHostKeyRotation":{"description":"A host-key rotation.","properties":{"id":{"type":"integer"},"last_error_public":{"type":["string","null"]},"mode":{"description":"`staged` offers the new keys beside the old ones first. `now` switches at once.","enum":["staged","now"],"type":"string"},"offered_at":{"description":"When the new keys were first offered.","format":"date-time","type":["string","null"]},"promote_after":{"description":"When a staged rotation may be finished.","format":"date-time","type":["string","null"]},"rotation_id":{"description":"The id a rotation request answers, so you can tell your rotation from a later one.","type":"string"},"state":{"enum":["staging","offered","promoting","verifying","aborting","done","failed","cancelled","aborted"],"type":"string"}},"required":["id","rotation_id","mode","state","offered_at","promote_after","last_error_public"],"type":"object"},"SshHostKeyRotationRequest":{"additionalProperties":false,"properties":{"action":{"description":"`stage` offers new host keys beside the current ones. `finish` switches to the staged keys. `cancel` drops\na staged rotation. `now` makes new keys and switches at once.\n","enum":["stage","now","finish","cancel"],"type":"string"},"confirm_environment":{"description":"The environment's name, exactly as `GET /environments/{environment}/ssh` answers it.","type":"string"}},"required":["action","confirm_environment"],"type":"object"},"SshHostKeys":{"description":"The host keys an SSH client checks when it connects.","properties":{"changed_at":{"format":"date-time","type":["string","null"]},"current":{"items":{"$ref":"#/components/schemas/SshHostKey"},"type":"array"},"known_hosts":{"description":"Complete `known_hosts` lines for this environment. Public keys only.","items":{"type":"string"},"type":"array"},"managed_by":{"description":"`panel` host keys can be rotated here. `corefinity` host keys (CoreStack Enterprise) are read-only.","enum":["panel","corefinity"],"type":"string"},"next":{"description":"The host keys a staged rotation will switch to. Null when no rotation is staged.","items":{"$ref":"#/components/schemas/SshHostKey"},"type":["array","null"]}},"required":["managed_by","current","next","known_hosts","changed_at"],"type":"object"},"SshHostKeysView":{"description":"An environment's host keys and whether they can be rotated.","properties":{"environment":{"$ref":"#/components/schemas/SshEnvironmentRef"},"host_keys":{"$ref":"#/components/schemas/SshHostKeys"},"reason":{"description":"Why `rotatable` is false.","enum":["unmanaged","platform_update","switched_off","in_progress",null],"type":["string","null"]},"rotatable":{"type":"boolean"},"rotation":{"description":"The latest rotation. Null when there has been none.","oneOf":[{"$ref":"#/components/schemas/SshHostKeyRotation"},{"type":"null"}]}},"required":["environment","host_keys","rotation","rotatable","reason"],"type":"object"},"SshKey":{"description":"A key held at one owner: a company, a website, an environment or a person.","properties":{"added_at":{"format":"date-time","type":"string"},"added_by":{"$ref":"#/components/schemas/SshAddedBy"},"also_granted":{"description":"Other places the same key is held that you can see.","items":{"properties":{"environments":{"type":"integer"},"layer":{"enum":["agency","company","website","environment","user","legacy","system"],"type":"string"},"owner":{"$ref":"#/components/schemas/SshOwner"}},"required":["layer","owner","environments"],"type":"object"},"type":"array"},"applies_to":{"description":"Null for environment and personal keys.","oneOf":[{"$ref":"#/components/schemas/SshAppliesTo"},{"type":"null"}]},"bits":{"description":"The key size, for RSA keys.","type":["integer","null"]},"delivery":{"description":"Where the key works so far, counted over the environments it reaches.","properties":{"applied":{"description":"Environments the key works on.","type":"integer"},"not_on_new_system":{"description":"Environments whose keys the Control Panel does not manage yet.","type":"integer"},"removed":{"description":"For a key being removed, environments it no longer works on.","type":"integer"},"state":{"enum":["applied","applying","removing","failed","waiting"],"type":"string"},"total":{"description":"Environments the key reaches, without those in `not_on_new_system`.","type":"integer"},"waiting":{"description":"Environments where the key, or its removal, waits for the environment to switch over or for a platform update.","type":"integer"},"waiting_platform_update":{"description":"How many of `waiting` wait for a platform update.","type":"integer"}},"required":["state","applied","total","waiting","waiting_platform_update","removed","not_on_new_system"],"type":"object"},"editable":{"description":"Whether you may rename the key or change where it applies.","type":"boolean"},"fingerprint":{"description":"The SHA-256 fingerprint, as `ssh-keygen -lf` prints it. Removing the key, or narrowing where it applies, asks you to send it back.","pattern":"^SHA256:[A-Za-z0-9+/]{43}$","type":"string"},"id":{"description":"The key id the `/ssh/keys/{key}` endpoints take.","type":"integer"},"last_used_at":{"format":"date-time","type":["string","null"]},"layer":{"description":"The level the key is held at, as you see it. `agency` is a key of your agency.","enum":["agency","company","website","environment","user","legacy","system"],"type":"string"},"legacy":{"description":"Set for a Legacy key, else null.","oneOf":[{"$ref":"#/components/schemas/SshLegacyState"},{"type":"null"}]},"lifecycle":{"description":"`quarantined` is a key Corefinity has stopped from working; `quarantine_reason` says why.","enum":["active","removing","quarantined"],"type":"string"},"login":{"description":"The username the key logs in with: `web`, or the person's own username for a personal key (null until one is issued).","type":["string","null"]},"name":{"type":"string"},"owner":{"$ref":"#/components/schemas/SshOwner"},"quarantine_reason":{"type":["string","null"]},"reach":{"$ref":"#/components/schemas/SshReachCount"},"removable":{"description":"Whether you may remove the key.","type":"boolean"},"restricted":{"description":"True when the key carries restrictions from before it was imported.","type":"boolean"},"restrictions":{"description":"The restrictions as they are written in front of the key. Read-only.","items":{"type":"string"},"type":"array"},"type":{"description":"The key type, such as `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, `ecdsa-sha2-nistp521` or `ssh-rsa`. A key imported from a server may carry an older type (`ssh-dss`) or a security-key type (`sk-`), which new keys may not.","enum":["ssh-ed25519","ecdsa-sha2-nistp256","ecdsa-sha2-nistp384","ecdsa-sha2-nistp521","ssh-rsa","ssh-dss","sk-ssh-ed25519@openssh.com","sk-ecdsa-sha2-nistp256@openssh.com"],"type":"string"},"weak":{"description":"True for a key that would be refused if it were added today.","type":"boolean"}},"required":["id","name","type","bits","weak","fingerprint","owner","layer","login","applies_to","reach","delivery","lifecycle","quarantine_reason","restricted","restrictions","legacy","added_by","added_at","last_used_at","also_granted","editable","removable"],"type":"object"},"SshKeyCreateRequest":{"additionalProperties":false,"properties":{"applies_to":{"allOf":[{"$ref":"#/components/schemas/SshAppliesToInput"}],"description":"For company and website keys only. Left out, the key applies to all environments."},"name":{"description":"A name to recognise the key by.","maxLength":100,"minLength":1,"type":"string"},"owner":{"$ref":"#/components/schemas/SshOwnerInput"},"public_key":{"description":"One public key. An OpenSSH line (`ssh-ed25519 AAAA… comment`) is taken as it is; a PEM, RFC 4716 or PKCS#1\npublic key is converted to it. Never send a private key. At most 16,384 bytes, counted without the white\nspace around it: a longer value is refused `ssh_key_invalid`, and one over 20,000 characters\n`invalid_arguments`.\n","maxLength":16384,"minLength":1,"type":"string"}},"required":["owner","public_key","name"],"type":"object"},"SshKeyRemoveRequest":{"additionalProperties":false,"properties":{"confirm_fingerprint":{"description":"The key's fingerprint, exactly as the lists answer it.","type":"string"}},"required":["confirm_fingerprint"],"type":"object"},"SshKeyRemoved":{"description":"The change that removes a key.","properties":{"change_id":{"type":"integer"},"remaining_sources":{"description":"Places the same key is still held. It keeps working through them.","items":{"$ref":"#/components/schemas/SshRemainingSource"},"type":"array"}},"required":["change_id","remaining_sources"],"type":"object"},"SshKeySaved":{"description":"A saved key and the change that applies it.","properties":{"change_id":{"description":"The change to follow with `GET /ssh/changes/{change}`. Null when nothing needs applying.","type":["integer","null"]},"converted_from":{"description":"The format the key was sent in, when it was converted to the one-line OpenSSH format: `pem`\n(`BEGIN PUBLIC KEY`), `pem_rsa` (`BEGIN RSA PUBLIC KEY`), `ssh2` (`BEGIN SSH2 PUBLIC KEY`, RFC 4716),\n`bare` (the key data of one of those without its first and last lines) or `wrapped` (an OpenSSH line\nbroken across lines). Null for a key sent as one OpenSSH line.\n","enum":["pem","pem_rsa","ssh2","bare","wrapped",null],"type":["string","null"]},"key":{"$ref":"#/components/schemas/SshKey"},"notices":{"items":{"$ref":"#/components/schemas/SshNotice"},"type":"array"}},"required":["key","change_id","converted_from","notices"],"type":"object"},"SshKeySource":{"description":"The level a key on an environment comes from.","properties":{"layer":{"description":"`agency` is a key of your agency. `system` is the Corefinity deploy key.","enum":["agency","company","website","environment","user","legacy","system"],"type":"string"},"owner":{"description":"Null for a key that has no owner you can see.","oneOf":[{"$ref":"#/components/schemas/SshOwner"},{"type":"null"}]}},"required":["layer","owner"],"type":"object"},"SshKeyUpdateRequest":{"additionalProperties":false,"anyOf":[{"required":["name"]},{"required":["applies_to"]}],"description":"Send `name`, `applies_to` or both. `confirm_fingerprint` alone changes nothing and is refused.","properties":{"applies_to":{"allOf":[{"$ref":"#/components/schemas/SshAppliesToInput"}],"description":"For company and website keys only."},"confirm_fingerprint":{"description":"The key's fingerprint, exactly as the lists answer it. Needed when `applies_to` can take an environment\naway from the key, and checked whenever it is sent.\n","type":"string"},"name":{"maxLength":100,"minLength":1,"type":"string"}},"type":"object"},"SshLegacyExtension":{"description":"A later last day for a company's Legacy keys.","properties":{"until":{"format":"date","type":"string"}},"required":["until"],"type":"object"},"SshLegacyKeepRequest":{"additionalProperties":false,"properties":{"owner":{"allOf":[{"$ref":"#/components/schemas/SshOwnerInput"}],"description":"Where to keep the key."}},"required":["owner"],"type":"object"},"SshLegacyKeys":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"$ref":"#/components/schemas/SshLegacyKeysBody"}],"description":"A company's Legacy keys, grouped by environment."},"SshLegacyKeysBody":{"description":"What a page of Legacy keys holds beside `next_cursor`.","properties":{"company":{"$ref":"#/components/schemas/Named"},"ends_on":{"description":"The day they stop working.","format":"date","type":["string","null"]},"environments":{"items":{"properties":{"environment":{"$ref":"#/components/schemas/SshEnvironmentRef"},"keys":{"items":{"$ref":"#/components/schemas/SshEffectiveKey"},"type":"array"},"not_on_new_system":{"type":"boolean"}},"required":["environment","not_on_new_system","keys"],"type":"object"},"type":"array"},"extension":{"description":"Set when Corefinity has moved that day for the company.","oneOf":[{"$ref":"#/components/schemas/SshLegacyExtension"},{"type":"null"}]}},"required":["company","ends_on","extension","environments"],"type":"object"},"SshLegacyPlacement":{"description":"Where a Legacy key was placed.","properties":{"layer":{"enum":["agency","company","website","environment","user","legacy","system"],"type":"string"},"login":{"description":"The username the key logs in with there.","type":"string"},"owner":{"$ref":"#/components/schemas/SshOwner"}},"required":["layer","owner","login"],"type":"object"},"SshLegacyState":{"description":"A Legacy key is one that was on the server before the Control Panel managed its keys. It stops working on `ends_on` unless someone keeps it.","properties":{"ci_hint":{"description":"A note when the key looks like one a deployment service uses.","type":["string","null"]},"ends_on":{"description":"The day the key stops working. Null when no day is set.","format":"date","type":["string","null"]},"placed_at":{"oneOf":[{"$ref":"#/components/schemas/SshLegacyPlacement"},{"type":"null"}]},"state":{"description":"`legacy` is untouched, `placed` was matched to an owner, `kept` was kept by a person.","enum":["legacy","placed","kept"],"type":"string"}},"required":["state","ends_on","ci_hint","placed_at"],"type":"object"},"SshLegacySummary":{"description":"The Legacy keys on the environment.","properties":{"count":{"type":"integer"},"ends_on":{"description":"The day they stop working.","format":"date","type":["string","null"]}},"required":["count","ends_on"],"type":"object"},"SshLogin":{"description":"One username on an environment, with the keys that can log in as it.","properties":{"keys":{"items":{"$ref":"#/components/schemas/SshEffectiveKey"},"type":"array"},"kind":{"description":"`web` is the site's shared user. `person` is one person's own username.","enum":["web","person"],"type":"string"},"login":{"description":"The username.","type":"string"},"person":{"description":"The person, for a `person` username.","oneOf":[{"$ref":"#/components/schemas/SshPerson"},{"type":"null"}]},"you":{"description":"True for your own username.","type":"boolean"}},"required":["login","kind","person","you","keys"],"type":"object"},"SshLoginReach":{"description":"One environment your username reaches.","properties":{"command":{"description":"The `ssh` command to connect.","type":["string","null"]},"environment":{"$ref":"#/components/schemas/SshEnvironmentRef"},"host":{"type":["string","null"]},"port":{"type":["integer","null"]},"state":{"enum":["ready","waiting_for_switch_over","waiting_for_platform_update","not_switched_on","failed","unmanaged"],"type":"string"}},"required":["environment","host","port","state","command"],"type":"object"},"SshNotice":{"description":"Something to know about a saved key.","properties":{"code":{"enum":["also_granted","stays_restricted","converted","weak_import"],"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SshOwner":{"description":"Where a key is held: a company, a website, an environment or a person.","properties":{"id":{"description":"The id of the company, website, environment or user.","type":"integer"},"name":{"type":"string"},"type":{"enum":["company","website","environment","user"],"type":"string"}},"required":["type","id","name"],"type":"object"},"SshOwnerInput":{"additionalProperties":false,"description":"The owner of a key in a request.","properties":{"id":{"description":"The id of the environment, website or company. For `user`, your own user id, which `GET /user/ssh`\nanswers in `user_id`.\n","minimum":1,"type":"integer"},"type":{"description":"The level the key is held at. `user` is yourself.","enum":["environment","website","company","user"],"type":"string"}},"required":["type","id"],"type":"object"},"SshPerson":{"description":"A person who has a username.","properties":{"former":{"type":"boolean"},"name":{"type":"string"},"user_id":{"type":"integer"}},"required":["user_id","name","former"],"type":"object"},"SshPersonLogin":{"description":"A person's SSH username.","properties":{"handle":{"description":"The company handle the username starts with.","type":"string"},"issued_at":{"format":"date-time","type":"string"},"login":{"type":"string"},"uid":{"type":"integer"}},"required":["login","uid","handle","issued_at"],"type":"object"},"SshPersonalKeys":{"description":"Your own SSH keys and username.","properties":{"can_add":{"$ref":"#/components/schemas/SshCanAdd"},"can_have_login":{"type":"boolean"},"keys":{"items":{"$ref":"#/components/schemas/SshKey"},"type":"array"},"login":{"description":"Your username. Null while none can be issued; `reason` says why.","oneOf":[{"$ref":"#/components/schemas/SshPersonLogin"},{"type":"null"}]},"reach":{"description":"The environments your username reaches.","items":{"$ref":"#/components/schemas/SshLoginReach"},"type":"array"},"reason":{"description":"Why `login` is null. `handle_missing` means your company has no SSH handle yet, or your account belongs to no company.","enum":["handle_missing",null],"type":["string","null"]},"ssh_config":{"description":"A `~/.ssh/config` block for every environment that is ready. Null when none is.","type":["string","null"]},"user_id":{"description":"Your user id, the `owner.id` of a personal key.","type":"integer"}},"required":["user_id","login","can_have_login","reason","can_add","keys","reach","ssh_config"],"type":"object"},"SshReach":{"description":"How far the keys here reach, with the environments.","properties":{"clients":{"type":"integer"},"environments":{"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/SshReachItem"},"type":"array"},"websites":{"type":"integer"}},"required":["environments","websites","clients","items"],"type":"object"},"SshReachCount":{"description":"How far a key reaches.","properties":{"clients":{"description":"Client companies an agency's key reaches.","type":"integer"},"environments":{"type":"integer"},"websites":{"type":"integer"}},"required":["environments","websites","clients"],"type":"object"},"SshReachItem":{"description":"One environment a key reaches.","properties":{"company":{"$ref":"#/components/schemas/Named"},"id":{"type":"integer"},"name":{"type":"string"},"product":{"enum":["cse","corestack","corecluster"],"type":"string"},"site_id":{"type":["integer","null"]},"website":{"$ref":"#/components/schemas/Named"}},"required":["id","name","product","site_id","website","company"],"type":"object"},"SshRefusal":{"additionalProperties":true,"description":"A refusal of an SSH request for a reason of its own. It differs from the shared `Refusal` in one way: `field`\nis always sent, naming the field the refusal is about or null. A refusal may add fields of its own, named on\nthe endpoint that gives it.\n","properties":{"code":{"description":"The same value as `reason`.","type":"string"},"environment":{"allOf":[{"$ref":"#/components/schemas/Named"}],"description":"Sent with `ssh_cap_exceeded` when one environment cannot take another key."},"errors":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Sent with `invalid_arguments` and `confirm_mismatch`. The refused field with its message.","type":"object"},"field":{"description":"The field the refusal is about.","type":["string","null"]},"managed_on":{"allOf":[{"$ref":"#/components/schemas/Named"}],"description":"Sent with `ssh_managed_on_another_environment`. The environment that manages the keys."},"message":{"description":"What happened, in plain words.","type":"string"},"permission":{"description":"Sent with `forbidden`. The key of the permission your role lacks.","type":"string"},"reason":{"description":"The stable code for this refusal.","type":"string"},"retry_after":{"description":"Sent with `ssh_throttled` on a host-key rotation. Seconds to wait. Kept for older clients; read `retry_after_seconds`.","type":"integer"},"retry_after_seconds":{"description":"Seconds to wait, the same key as every other limit of the API. Sent with `rate_limited`, and with `ssh_throttled` on a host-key rotation.","type":"integer"}},"required":["message","reason","field","code"],"type":"object"},"SshRemainingSource":{"description":"Another place the same key is still held, so it can still log in.","properties":{"environments":{"type":"integer"},"layer":{"enum":["agency","company","website","environment","user","legacy","system"],"type":"string"},"owner":{"$ref":"#/components/schemas/SshOwner"}},"required":["layer","owner","environments"],"type":"object"},"SshRotationStarted":{"description":"The host-key rotation that was started or moved on.","properties":{"change_id":{"description":"Always 0. A rotation is followed by its `rotation_id`, not as a change.","type":"integer"},"rotation":{"description":"The rotation as it stands. Null only when it could not be read back; read the host keys instead.","oneOf":[{"$ref":"#/components/schemas/SshHostKeyRotation"},{"type":"null"}]},"rotation_id":{"description":"The rotation's id, the same value as `rotation.rotation_id` in the host keys.","type":"string"}},"required":["change_id","rotation_id","rotation"],"type":"object"},"SshWebsiteKeys":{"description":"A website's SSH keys.","properties":{"can_add":{"$ref":"#/components/schemas/SshCanAdd"},"environments":{"items":{"properties":{"delivery_state":{"enum":["pending","applying","applied","failed","drift","waiting","unmanaged"],"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"site_id":{"type":["integer","null"]}},"required":["id","name","site_id","delivery_state"],"type":"object"},"type":"array"},"grants":{"description":"The website's own keys.","items":{"$ref":"#/components/schemas/SshKey"},"type":"array"},"inherited":{"description":"Keys from the company and agency levels that reach the website.","items":{"$ref":"#/components/schemas/SshEffectiveKey"},"type":"array"},"website":{"properties":{"company":{"$ref":"#/components/schemas/Named"},"id":{"type":"integer"},"name":{"type":"string"},"product":{"enum":["cse","corestack","corecluster"],"type":"string"}},"required":["id","name","product","company"],"type":"object"}},"required":["website","grants","inherited","environments","can_add"],"type":"object"},"SshYourLogin":{"description":"Your own username on this environment.","properties":{"command":{"description":"The `ssh` command to connect with it.","type":["string","null"]},"delivered":{"description":"True once the username works on the environment.","type":"boolean"},"login":{"type":["string","null"]},"state":{"description":"`ready` works now. `no_key` means you have no personal key yet, `no_login` that no username has been issued. The `waiting_` states and `not_switched_on` mean the environment is not ready for personal usernames yet.","enum":["ready","waiting_for_switch_over","waiting_for_platform_update","not_switched_on","failed","unmanaged","no_key","no_login"],"type":"string"}},"required":["login","command","delivered","state"],"type":"object"},"SupportTicket":{"allOf":[{"$ref":"#/components/schemas/SupportTicketSummary"},{"properties":{"attachments":{"description":"The first message's files.","items":{"$ref":"#/components/schemas/SupportTicketFile"},"type":"array"},"body_html":{"description":"The first message, as the page shows it.","type":"string"},"body_text":{"description":"The first message as plain text.","type":"string"},"can":{"description":"What you may do with the ticket.","properties":{"change_priority":{"type":"boolean"},"close":{"type":"boolean"},"reopen":{"type":"boolean"},"reply":{"type":"boolean"}},"required":["reply","close","reopen","change_priority"],"type":"object"},"raised_by":{"description":"Who raised the ticket: it can be raised for someone else.","oneOf":[{"properties":{"email":{"type":["string","null"]},"id":{"description":"Null for somebody with no account, such as a person who emailed the ticket in, or whose account is no longer active.","minimum":1,"type":["integer","null"]},"name":{"type":"string"}},"required":["id","name","email"],"type":"object"},{"type":"null"}]},"replication_step_html":{"description":"The steps to see the problem, when given.","type":["string","null"]},"replies":{"description":"Every reply, yours and Corefinity's, oldest first.","items":{"$ref":"#/components/schemas/SupportTicketReply"},"type":"array"},"reply_count":{"type":"integer"}},"required":["raised_by","body_html","body_text","replication_step_html","attachments","replies","reply_count","can"],"type":"object"}]},"SupportTicketFile":{"properties":{"download_url":{"description":"The file for your token: the download endpoint.","type":"string"},"id":{"minimum":1,"type":"integer"},"mime_type":{"type":["string","null"]},"name":{"type":"string"},"size":{"description":"Bytes.","type":["integer","null"]},"url":{"description":"Opens the file in the Control Panel when you are signed in.","type":"string"}},"required":["id","name","size","mime_type","url","download_url"],"type":"object"},"SupportTicketList":{"properties":{"last_page":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"tickets":{"items":{"$ref":"#/components/schemas/SupportTicketSummary"},"type":"array"},"total":{"type":"integer"}},"required":["tickets","page","per_page","total","last_page"],"type":"object"},"SupportTicketOpen":{"properties":{"body":{"description":"The problem, in Markdown.","maxLength":65535,"type":"string"},"company_id":{"description":"The company the ticket is for. Required when the choices say `chooses_company`; refused for anyone else unless it is their own company.","minimum":1,"type":["integer","null"]},"confirm_emergency":{"description":"`true` for an `emergency`, once you agree to what the `emergency_notice` says. An emergency pages Corefinity's on-call engineers.","type":"boolean"},"department_id":{"description":"One of the `departments` the choices offer.","minimum":1,"type":"integer"},"environment_id":{"description":"One environment, in place of `environment_ids`.","minimum":1,"type":["integer","null"]},"environment_ids":{"description":"Environments of those websites, from the choices.","items":{"minimum":1,"type":"integer"},"maxItems":50,"type":"array"},"priority":{"description":"`medium` when left out.","enum":["emergency","high","medium","low",null],"type":["string","null"]},"replication_step":{"description":"The steps to see the problem, in Markdown.","maxLength":65535,"type":["string","null"]},"subject":{"maxLength":255,"type":"string"},"website_id":{"description":"One website, in place of `website_ids`.","minimum":1,"type":["integer","null"]},"website_ids":{"description":"The websites the ticket is about, from the choices.","items":{"minimum":1,"type":"integer"},"maxItems":50,"type":"array"}},"required":["subject","body","department_id"],"type":"object"},"SupportTicketOptions":{"description":"What the New Ticket form offers you.","properties":{"chooses_company":{"description":"Whether the form asks which company the ticket is for, as it does for an agency.","type":"boolean"},"companies":{"description":"Those companies. Null when the form does not ask.","items":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":["array","null"]},"company_id":{"description":"The company you gave.","minimum":1,"type":["integer","null"]},"default_priority":{"enum":["emergency","high","medium","low"],"type":"string"},"departments":{"items":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"emergency_notice":{"description":"What the form tells you when you choose Emergency. Null when nothing is set.","type":["string","null"]},"environment_groups":{"description":"The same environments under their website.","items":{"properties":{"environments":{"items":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"website_id":{"minimum":1,"type":"integer"},"website_name":{"type":"string"}},"required":["website_id","website_name","environments"],"type":"object"},"type":["array","null"]},"environments":{"description":"Every environment of those websites. Null until you give a website.","items":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"website_id":{"minimum":1,"type":"integer"}},"required":["id","name","website_id"],"type":"object"},"type":["array","null"]},"priorities":{"items":{"properties":{"label":{"type":"string"},"value":{"enum":["emergency","high","medium","low"],"type":"string"}},"required":["value","label"],"type":"object"},"type":"array"},"website_id":{"description":"The first of the websites you gave.","minimum":1,"type":["integer","null"]},"website_ids":{"description":"The websites you gave.","items":{"type":"integer"},"type":"array"},"websites":{"description":"The websites a ticket can be about. Null when the form asks for a company and `company_id` was not given.","items":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":["array","null"]}},"required":["chooses_company","companies","company_id","websites","website_id","website_ids","environments","environment_groups","departments","priorities","default_priority","emergency_notice"],"type":"object"},"SupportTicketPerson":{"properties":{"company_name":{"type":["string","null"]},"email":{"type":["string","null"]},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name","email","company_name"],"type":"object"},"SupportTicketReply":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/SupportTicketFile"},"type":"array"},"author":{"oneOf":[{"properties":{"email":{"type":["string","null"]},"id":{"description":"Null for somebody with no account, such as a person who emailed the ticket in, or whose account is no longer active.","minimum":1,"type":["integer","null"]},"name":{"type":"string"}},"required":["id","name","email"],"type":"object"},{"type":"null"}]},"body_html":{"description":"The reply as the page shows it.","type":"string"},"body_text":{"description":"The same words as plain text.","type":"string"},"created_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"}},"required":["id","author","body_html","body_text","created_at","attachments"],"type":"object"},"SupportTicketReplyAnswer":{"allOf":[{"$ref":"#/components/schemas/SupportTicketReply"},{"properties":{"ticket":{"allOf":[{"$ref":"#/components/schemas/SupportTicketSummary"}],"description":"The ticket as the list shows it after the reply."}},"required":["ticket"],"type":"object"}]},"SupportTicketReplyRequest":{"description":"A reply needs `body`, a file, or both.","properties":{"body":{"description":"The reply, in Markdown.","type":["string","null"]},"upload_ids":{"description":"Files sent ahead, by their `upload_id`. Each is attached once, so an id named twice is refused. With the files of a multipart form, at most 20 in one reply.","items":{"format":"uuid","type":"string"},"maxItems":20,"type":["array","null"],"uniqueItems":true}},"type":"object"},"SupportTicketSubscriberCandidates":{"properties":{"candidates":{"items":{"$ref":"#/components/schemas/SupportTicketPerson"},"maxItems":6,"type":"array"},"search":{"type":"string"},"ticket_id":{"minimum":1,"type":"integer"}},"required":["ticket_id","search","candidates"],"type":"object"},"SupportTicketSubscribers":{"properties":{"can_manage":{"description":"Whether you may add and remove followers.","type":"boolean"},"subscribers":{"items":{"$ref":"#/components/schemas/SupportTicketPerson"},"type":"array"},"ticket_id":{"minimum":1,"type":"integer"}},"required":["ticket_id","can_manage","subscribers"],"type":"object"},"SupportTicketSummary":{"description":"A ticket as the list shows it.","properties":{"company":{"description":"The company the ticket is for.","oneOf":[{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},{"type":"null"}]},"created_at":{"format":"date-time","type":["string","null"]},"department":{"description":"The department the ticket is in.","oneOf":[{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},{"type":"null"}]},"environment":{"description":"The first of `environments`, or null.","oneOf":[{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},{"type":"null"}]},"environments":{"description":"Every environment the ticket is about.","items":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"id":{"minimum":1,"type":"integer"},"priority":{"enum":["emergency","high","medium","low"],"type":"string"},"priority_label":{"type":"string"},"requester":{"description":"Who the ticket is for.","oneOf":[{"properties":{"email":{"type":["string","null"]},"id":{"description":"Null for somebody with no account, such as a person who emailed the ticket in, or whose account is no longer active.","minimum":1,"type":["integer","null"]},"name":{"type":"string"}},"required":["id","name","email"],"type":"object"},{"type":"null"}]},"scheduled_for":{"description":"When a scheduled ticket comes back to Corefinity's queue. Null once a ticket is resolved or closed.","format":"date-time","type":["string","null"]},"status":{"enum":["pending","open","in_progress","waiting_on_customer","waiting_on_thirdparty","on_hold","scheduled","resolved","closed"],"type":"string"},"status_label":{"type":"string"},"subject":{"type":"string"},"updated_at":{"format":"date-time","type":["string","null"]},"url":{"description":"The ticket in the Control Panel.","type":"string"},"website":{"description":"The first of `websites`, or null.","oneOf":[{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},{"type":"null"}]},"websites":{"description":"Every website the ticket is about.","items":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"}},"required":["id","subject","status","status_label","priority","priority_label","department","company","website","websites","environment","environments","requester","scheduled_for","created_at","updated_at","url"],"type":"object"},"SupportTicketUpload":{"properties":{"expires_at":{"description":"The file waits until then for a reply, then it is deleted.","format":"date-time","type":"string"},"lines":{"properties":{"note":{"type":"string"},"one_request":{"description":"A curl line that sends the file.","type":"string"}},"required":["one_request","note"],"type":"object"},"max_bytes":{"description":"The largest file an upload takes.","type":"integer"},"method":{"const":"PUT","type":"string"},"upload_id":{"description":"What a reply names in `upload_ids`.","format":"uuid","type":"string"},"url":{"description":"The signed address to send the file to. Shown only now, and good until `url_expires_at`.","type":"string"},"url_expires_at":{"format":"date-time","type":"string"}},"required":["upload_id","method","url","url_expires_at","expires_at","max_bytes","lines"],"type":"object"},"SupportTicketUploadStored":{"description":"What the signed `PUT` answers once the file is stored.","properties":{"expires_at":{"format":"date-time","type":"string"},"filename":{"type":"string"},"mime_type":{"type":["string","null"]},"size_bytes":{"type":"integer"},"upload_id":{"format":"uuid","type":"string"}},"required":["upload_id","filename","size_bytes","mime_type","expires_at"],"type":"object"},"SwitchedOffRefusal":{"description":"Corefinity has switched this action off for the moment. `switch` names what is off.","properties":{"code":{"const":"switched_off","type":"string"},"message":{"type":"string"},"reason":{"const":"switched_off","type":"string"},"switch":{"examples":["delete"],"type":"string"}},"required":["message","reason","code","switch"],"type":"object"},"TeamAssignableRolesAnswer":{"allOf":[{"$ref":"#/components/schemas/LegacyEnvelope"},{"properties":{"data":{"description":"One item, an object of role slug to role name. Empty when you may give no role.","items":{"oneOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"maxItems":0,"type":"array"}]},"maxItems":1,"minItems":1,"type":"array"}},"required":["data"],"type":"object"}]},"TeamCompanyDetails":{"additionalProperties":false,"description":"Your company and its settings. Ids are numbers here, unlike in `GET /company`.","properties":{"address":{"type":["string","null"]},"can_change":{"description":"Whether you may change the settings.","type":"boolean"},"country":{"type":["string","null"]},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"phone":{"type":["string","null"]},"settings":{"properties":{"alerts_notifications":{"type":"boolean"},"deployment_started_notifications":{"type":"boolean"},"slack_channels":{"$ref":"#/components/schemas/TeamSlackChannels"}},"required":["deployment_started_notifications","alerts_notifications","slack_channels"],"type":"object"},"slack":{"properties":{"connected":{"description":"Whether your company has connected Slack. Slack is connected in the Control Panel.","type":"boolean"},"delivery":{"description":"The state of recent notification deliveries to Slack, one item for each destination. Empty when there is nothing to report.","items":{"$ref":"#/components/schemas/TeamSlackDelivery"},"type":"array"},"workspace":{"description":"The connected workspace's name. Null while Slack is not connected.","type":["string","null"]}},"required":["connected","workspace","delivery"],"type":"object"},"type":{"enum":["agency","client"],"type":"string"}},"required":["id","name","phone","address","country","type","slack","settings","can_change"],"type":"object"},"TeamCompanyDetailsAnswer":{"properties":{"data":{"$ref":"#/components/schemas/TeamCompanyDetails"}},"required":["data"],"type":"object"},"TeamCompanyEnvelope":{"description":"Your company under `company`. Not the shared `LegacyEnvelope`: this answer has no `message`, `status` or\n`data`.\n","properties":{"company":{"$ref":"#/components/schemas/Company"}},"required":["company"],"type":"object"},"TeamCompanyUpdateRequest":{"additionalProperties":false,"description":"Send at least one of these.","minProperties":1,"properties":{"alerts_notifications":{"type":"boolean"},"deployment_started_notifications":{"type":"boolean"},"slack_channels":{"additionalProperties":false,"description":"The channels to change. A key left out stays as it is.","properties":{"alerts":{"maxLength":255,"type":["string","null"]},"deployment_started":{"maxLength":255,"type":["string","null"]},"deployments":{"maxLength":255,"type":["string","null"]},"maintenance_windows":{"maxLength":255,"type":["string","null"]},"tickets":{"maxLength":255,"type":["string","null"]}},"type":"object"}},"type":"object"},"TeamCustomRole":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"permissions":{"items":{"type":"string"},"type":"array"},"slug":{"description":"The name as a slug, then a unique suffix. The slug does not change when the role is renamed.","type":"string"}},"required":["id","name","slug","permissions"],"type":"object"},"TeamEmailChange":{"description":"What happened to a new address the update named for somebody else. The address was not saved.","properties":{"message":{"type":"string"},"requested_email":{"type":"string"},"status":{"description":"`member_asked` when the member was emailed to say you asked; `notice_not_sent` when that email could not be\nsent.\n","enum":["member_asked","notice_not_sent"],"type":"string"}},"required":["status","requested_email","message"],"type":"object"},"TeamInviteAnswer":{"allOf":[{"$ref":"#/components/schemas/LegacyEnvelope"},{"properties":{"data":{"$ref":"#/components/schemas/TeamInvitedUser"}},"required":["data"],"type":"object"}]},"TeamInviteRequest":{"properties":{"email":{"description":"The address the invitation goes to. Compared without regard to case.","format":"email","maxLength":254,"type":"string"},"name":{"maxLength":255,"type":"string"},"role":{"description":"The slug of a role you may give, as `GET /roles` lists them.","type":"string"}},"required":["name","email","role"],"type":"object"},"TeamInvitedUser":{"description":"The person who was invited.","properties":{"created_at":{"description":"When the invitation was made, in UTC, with microseconds.","format":"date-time","type":"string"},"email":{"description":"The address the person was invited at.","type":"string"},"id":{"description":"The new user's id, as a string of digits.","type":"string"},"name":{"type":"string"},"role":{"description":"The name of the role, not its slug.","type":"string"}},"required":["id","name","email","role","created_at"],"type":"object"},"TeamMember":{"additionalProperties":false,"description":"A person in a team. Ids are numbers here, unlike in the `/user` routes.","properties":{"company_id":{"minimum":1,"type":["integer","null"]},"email":{"description":"The address the person is shown with. For somebody invited who has not accepted, the address they were invited at.","type":"string"},"id":{"minimum":1,"type":"integer"},"invitation_expires_at":{"description":"When the invitation expires, in UTC, written with `+00:00`.","format":"date-time","type":["string","null"]},"invited_at":{"description":"When the invitation was last sent, in UTC, written with `+00:00`.","format":"date-time","type":["string","null"]},"name":{"type":"string"},"notifications":{"additionalProperties":false,"description":"The person's notification preferences.","properties":{"alerts_notifications":{"type":"boolean"},"email_notifications":{"type":"boolean"},"maintenance_window_notifications":{"type":"boolean"},"subscribe_to_deployment_alerts":{"type":"boolean"},"subscribe_to_emergency_alerts":{"type":"boolean"},"subscribe_to_newsletters":{"type":"boolean"}},"type":"object"},"position":{"type":["string","null"]},"roles":{"description":"The person's roles, by name.","items":{"properties":{"name":{"type":"string"},"slug":{"type":"string"}},"required":["slug","name"],"type":"object"},"type":"array"},"status":{"description":"The team list holds `active`, `invite_sent` and `invite_expired`; one person read by id can have any of these.","enum":["unassigned","pending_invite","invite_sent","active","inactive","invite_expired","unknown"],"type":"string"}},"required":["id","name","email","position","company_id","status","roles","notifications","invited_at","invitation_expires_at"],"type":"object"},"TeamMemberAnswer":{"properties":{"data":{"$ref":"#/components/schemas/TeamMember"}},"required":["data"],"type":"object"},"TeamMemberPageAnswer":{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"items":{"items":{"$ref":"#/components/schemas/TeamMember"},"type":"array"}},"required":["items"],"type":"object"}]}},"required":["data"],"type":"object"},"TeamPermissionsAnswer":{"allOf":[{"$ref":"#/components/schemas/LegacyEnvelope"},{"properties":{"data":{"description":"Permission slugs.","items":{"type":"string"},"type":"array"}},"required":["data"],"type":"object"}]},"TeamRefusal":{"allOf":[{"$ref":"#/components/schemas/LegacyRefusal"},{"properties":{"reason":{"enum":["forbidden","privileged_target","last_owner","only_user","already_active","invite_company_gone","not_connected","in_use","owner_grant","permission_grant"],"type":"string"}},"required":["reason","code"],"type":"object"}],"description":"A refusal of the team, roles and company routes: the shared `LegacyRefusal`, except that `reason` and `code`\nare always sent and `reason` is one of these codes.\n"},"TeamRoleAnswer":{"allOf":[{"$ref":"#/components/schemas/LegacyEnvelope"},{"properties":{"data":{"$ref":"#/components/schemas/TeamCustomRole"}},"required":["data"],"type":"object"}]},"TeamRoleCatalogueAnswer":{"properties":{"data":{"properties":{"roles":{"items":{"$ref":"#/components/schemas/TeamRoleEntry"},"type":"array"}},"required":["roles"],"type":"object"}},"required":["data"],"type":"object"},"TeamRoleEntry":{"additionalProperties":false,"properties":{"assignable":{"description":"Whether you may give this role to somebody in your company.","type":"boolean"},"custom":{"description":"True for a role your company made; false for a standard role.","type":"boolean"},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"permissions":{"description":"The slugs of the permissions the role gives.","items":{"type":"string"},"type":"array"},"slug":{"type":"string"}},"required":["id","slug","name","custom","permissions","assignable"],"type":"object"},"TeamRoleMembershipRequest":{"properties":{"role":{"description":"The slug of the role.","type":"string"},"user_id":{"description":"The id of the team member.","oneOf":[{"minimum":1,"type":"integer"},{"pattern":"^[1-9][0-9]*$","type":"string"}]}},"required":["user_id","role"],"type":"object"},"TeamRoleRequest":{"properties":{"name":{"maxLength":255,"type":"string"},"permissions":{"description":"The slugs of the permissions the role gives, each one you hold yourself. The whole set, not a change to it.","items":{"maxLength":255,"type":"string"},"minItems":1,"type":"array"}},"required":["name","permissions"],"type":"object"},"TeamSlackChannels":{"additionalProperties":false,"description":"The Slack channel each kind of notification goes to, as `#name`, or null for none. A null `deployment_started` uses the `deployments` channel.","properties":{"alerts":{"type":["string","null"]},"deployment_started":{"type":["string","null"]},"deployments":{"type":["string","null"]},"maintenance_windows":{"type":["string","null"]},"tickets":{"type":["string","null"]}},"required":["deployments","deployment_started","tickets","maintenance_windows","alerts"],"type":"object"},"TeamSlackDelivery":{"description":"How notifications to one Slack destination are going. It never names the channel.","properties":{"action":{"description":"What to do, in plain words, when `state` is `needs_attention`. Null otherwise.","type":["string","null"]},"attempts":{"minimum":1,"type":"integer"},"checked_at":{"description":"When the last delivery was tried, in UTC, written with `+00:00`.","format":"date-time","type":"string"},"destination_id":{"description":"An opaque id for the destination, 64 hexadecimal characters.","type":"string"},"driver":{"description":"How the notification is sent, such as `slack`.","type":"string"},"error":{"description":"Slack's error code for the last delivery, such as `channel_not_found`. Null after a delivery that worked.","type":["string","null"]},"last_delivered_at":{"description":"When a notification last arrived. Null when none has.","format":"date-time","type":["string","null"]},"state":{"description":"`healthy`, `retrying` after a delivery that will be tried again, or `needs_attention` when deliveries have stopped.","enum":["healthy","retrying","needs_attention"],"type":"string"}},"required":["destination_id","driver","state","error","attempts","checked_at","last_delivered_at","action"],"type":"object"},"TeamUserAnswer":{"allOf":[{"$ref":"#/components/schemas/LegacyEnvelope"},{"properties":{"data":{"$ref":"#/components/schemas/User"}},"required":["data"],"type":"object"}]},"TeamUserUpdateAnswer":{"allOf":[{"$ref":"#/components/schemas/LegacyEnvelope"},{"properties":{"data":{"$ref":"#/components/schemas/User"},"email_change":{"description":"Null unless the update named a new address for somebody else.","oneOf":[{"$ref":"#/components/schemas/TeamEmailChange"},{"type":"null"}]}},"required":["data","email_change"],"type":"object"}]},"TeamUserUpdateRequest":{"properties":{"alerts_notifications":{"type":["boolean","null"]},"email":{"description":"Send the address the member has now. A different one is not saved: the member is emailed to say you asked.\nA different address for yourself is refused `422`.\n","format":"email","maxLength":254,"type":"string"},"email_notifications":{"type":["boolean","null"]},"maintenance_window_notifications":{"type":["boolean","null"]},"name":{"maxLength":255,"type":"string"},"position":{"maxLength":255,"type":["string","null"]},"role":{"description":"The slug of a role the member holds already or one you may give them.","type":"string"},"subscribe_to_deployment_alerts":{"type":["boolean","null"]},"subscribe_to_newsletters":{"type":["boolean","null"]}},"required":["name","email","role"],"type":"object"},"TerminalSession":{"description":"One browser terminal session.","properties":{"duration_seconds":{"description":"Null while the session is active.","type":["integer","null"]},"end_reason":{"description":"Why the session ended, such as `closed` (the person closed it), `idle` or `max_duration` (it timed out:\n`status` is then `timed_out`), `site_stopped`, `access_revoked` (the person may no longer see the site),\nor `socket_closed`, `connect_failed`, `exec_failed`, `error` or `lost` when the connection or the shell\nfailed. Null while the session is active.\n","type":["string","null"]},"ended_at":{"description":"Null while the session is active.","format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"site":{"$ref":"#/components/schemas/SiteRef"},"started_at":{"format":"date-time","type":["string","null"]},"status":{"enum":["active","ended","timed_out","failed"],"type":"string"},"status_label":{"type":"string"},"transcript":{"description":"The session's recording.","properties":{"available":{"description":"True when the session has ended and its recording is kept.","type":"boolean"},"expires_at":{"description":"When the recording is deleted. Null when there is none.","format":"date-time","type":["string","null"]},"url":{"description":"The recording's address on the API (the transcript endpoint, with the session's `id`), when you may\ndownload it; null otherwise. It needs the `exec` scope.","type":["string","null"]}},"required":["available","url","expires_at"],"type":"object"},"user":{"description":"Who opened the session, by their own id and name.","properties":{"id":{"minimum":1,"type":"integer"},"name":{"description":"The person's name. Empty when the account no longer exists.","type":"string"}},"required":["id","name"],"type":"object"}},"required":["id","site","user","status","status_label","started_at","ended_at","duration_seconds","end_reason","transcript"],"type":"object"},"TerminalSessionList":{"properties":{"active":{"description":"Your own session on this site while one is open, else null.","oneOf":[{"$ref":"#/components/schemas/TerminalSession"},{"type":"null"}]},"sessions":{"description":"The newest 50 sessions of the site, newest first.","items":{"$ref":"#/components/schemas/TerminalSession"},"type":"array"}},"required":["sessions","active"],"type":"object"},"TokenScope":{"description":"A token scope, or `deploy`: an ability a token holds beside its scopes, which every request that starts,\nretries, stops, cancels or rolls back a deployment asks for.\n","enum":["read","write","exec","destructive","deploy"],"type":"string"},"UpcomingMaintenanceWindows":{"properties":{"days":{"items":{"properties":{"local_date":{"type":"string"},"slots":{"items":{"properties":{"domain":{"type":"string"},"ends_at":{"format":"date-time","type":"string"},"environment":{"oneOf":[{"$ref":"#/components/schemas/MaintenanceWindowPreviewEnvironment"},{"type":"null"}]},"label":{"type":"string"},"pending":{"description":"What is queued for this occurrence.","items":{"properties":{"kind_label":{"type":"string"},"own":{"description":"True for a change you made yourself.","type":"boolean"}},"required":["kind_label","own"],"type":"object"},"type":"array"},"site_id":{"minimum":1,"type":"integer"},"starts_at":{"format":"date-time","type":"string"}},"required":["site_id","domain","environment","starts_at","ends_at","label","pending"],"type":"object"},"type":"array"}},"required":["local_date","slots"],"type":"object"},"type":"array"}},"required":["days"],"type":"object"},"UpgradeClusterAddonsChange":{"properties":{"cluster":{"$ref":"#/components/schemas/Cluster"},"operation":{"$ref":"#/components/schemas/Operation"},"quote":{"description":"The price the change was made at. `null` when the CoreCluster has no billing contract.","oneOf":[{"$ref":"#/components/schemas/BillingQuote"},{"type":"null"}]}},"required":["cluster","quote","operation"],"type":"object"},"UpgradeClusterAddonsRequest":{"properties":{"cores":{"description":"Extra cores, in all.","maximum":512,"minimum":0,"type":"integer"},"disk_gb":{"description":"Extra disk in GB, in all.","maximum":102400,"minimum":0,"type":"integer"},"log_storage_gb":{"description":"Extra log storage in GB, in all.","maximum":65536,"minimum":0,"type":"integer"},"memory_gb":{"description":"Extra memory in GB, in all.","maximum":4096,"minimum":0,"type":"integer"},"quote_id":{"$ref":"#/components/schemas/UpgradeQuoteId"}},"required":["cores","memory_gb","disk_gb","log_storage_gb"],"type":"object"},"UpgradeClusterFamilyChange":{"properties":{"already":{"description":"The sites that are on the server type already.","items":{"additionalProperties":true,"type":"object"},"type":"array"},"cluster":{"additionalProperties":true,"description":"The CoreCluster, as `GET /corestack/clusters/{cluster}` answers it.","type":"object"},"items":{"description":"One entry for each site that moves.","items":{"additionalProperties":true,"properties":{"item":{"additionalProperties":true,"type":"object"},"operation":{"additionalProperties":true,"type":["object","null"]},"reason":{"type":["string","null"]},"site":{"additionalProperties":true,"type":["object","null"]},"started":{"type":"boolean"}},"type":"object"},"type":"array"},"operation":{"description":"Always `null`. Each site's move is its own operation.","type":"null"},"pending":{"type":"null"},"queued":{"type":"boolean"},"quote":{"additionalProperties":true,"type":["object","null"]},"settled":{"description":"Whether no site had to move.","type":"boolean"}},"required":["cluster","operation","queued","items","already","settled","quote","pending"],"type":"object"},"UpgradeClusterFamilyRequest":{"properties":{"apply":{"$ref":"#/components/schemas/ApplyChoice"},"confirm_name":{"description":"The CoreCluster's name, typed exactly.","maxLength":253,"type":"string"},"family":{"description":"The server type to move to. `general` is Standard and `optimised` is Performance.","enum":["general","optimised"],"type":"string"},"quote_id":{"$ref":"#/components/schemas/UpgradeQuoteId"}},"required":["family","confirm_name"],"type":"object"},"UpgradeClusterPackageChange":{"properties":{"cluster":{"$ref":"#/components/schemas/Cluster"},"operation":{"$ref":"#/components/schemas/Operation"},"quote":{"description":"The price the change was made at. `null` when the CoreCluster has no billing contract.","oneOf":[{"$ref":"#/components/schemas/BillingQuote"},{"type":"null"}]},"shape_change":{"description":"Whether the new package runs on different servers, which takes longer.","type":"boolean"},"warnings":{"description":"Sentences to show with the change, such as snapshots that will be trimmed to the new package's allowance. Usually empty.","items":{"type":"string"},"type":"array"}},"required":["cluster","operation","shape_change","warnings"],"type":"object"},"UpgradeClusterPackageRequest":{"properties":{"confirm_name":{"description":"The CoreCluster's name, typed exactly.","type":"string"},"package":{"description":"The CoreCluster package to move to, by its key, such as `cc12`.","type":"string"},"quote_id":{"$ref":"#/components/schemas/UpgradeQuoteId"}},"required":["package","confirm_name"],"type":"object"},"UpgradeOptionPackage":{"properties":{"available":{"$ref":"#/components/schemas/Availability","description":"Whether the package can be chosen, and why not when it cannot."},"change":{"description":"What moving to the package would be. `null` for the package the subject is on.","oneOf":[{"properties":{"direction":{"enum":["upgrade","downgrade"],"type":"string"},"notes":{"items":{"type":"string"},"type":"array"}},"required":["direction","notes"],"type":"object"},{"type":"null"}]},"code":{"type":"string"},"cores":{"type":"number"},"disk_gb":{"type":"number"},"key":{"type":"string"},"memory_gib":{"type":"number"},"monthly":{"description":"The package's monthly price for this subject's server type and platform. `null` when it is not priced.","oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"name":{"type":"string"}},"required":["key","code","name","cores","memory_gib","disk_gb","monthly","change","available"],"type":"object"},"UpgradeOptionUnits":{"properties":{"cores":{"type":"integer"},"disk_gb":{"type":"integer"},"log_storage_gb":{"type":"integer"},"memory_gb":{"type":"integer"}},"required":["cores","memory_gb","disk_gb","log_storage_gb"],"type":"object"},"UpgradeOptions":{"properties":{"addons":{"properties":{"available":{"$ref":"#/components/schemas/Availability"},"current":{"$ref":"#/components/schemas/UpgradeOptionUnits","description":"The add-ons the subject holds now."},"max":{"$ref":"#/components/schemas/UpgradeOptionUnits","description":"The most of each add-on a change takes."},"unit":{"description":"Each add-on with the monthly price of one unit, its ceiling and its step.","items":{"properties":{"key":{"type":"string"},"label":{"type":"string"},"max":{"type":"integer"},"monthly":{"oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"step":{"type":"integer"},"unit":{"type":"string"}},"required":["key","label","unit","monthly","max","step"],"type":"object"},"type":"array"}},"required":["current","unit","max","available"],"type":"object"},"apply_default":{"type":"string"},"can_apply_tonight":{"description":"Whether a change can wait for tonight.","type":"boolean"},"contract":{"description":"The billing contract a change is priced against, or `null`.","oneOf":[{"properties":{"id":{"minimum":1,"type":"integer"},"reference":{"type":"string"}},"required":["id","reference"],"type":"object"},{"type":"null"}]},"currency":{"type":"string"},"family":{"description":"The server types.","items":{"properties":{"available":{"type":"boolean"},"current":{"type":"boolean"},"key":{"enum":["general","optimised"],"type":"string"},"label":{"type":"string"},"monthly_delta":{"description":"What moving to it adds a month. `null` when it is not priced.","oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"note":{"type":["string","null"]},"provisioned":{"description":"Whether servers of this type are running where the subject is. When they are not, the first move to it takes longer.","type":"boolean"},"reason":{"description":"`first` when no server of this type is running there yet.","type":["string","null"]}},"required":["key","label","available","provisioned","reason","note","current","monthly_delta"],"type":"object"},"type":"array"},"not_billed":{"description":"For a subject with no billing contract, why its changes carry no price. `null` otherwise.","oneOf":[{"properties":{"message":{"type":"string"},"reason":{"type":"string"}},"required":["reason","message"],"type":"object"},{"type":"null"}]},"packages":{"items":{"$ref":"#/components/schemas/UpgradeOptionPackage"},"type":"array"},"pending":{"description":"For a site, the changes waiting for the night. `null` for a CoreCluster and for a site inside one.","oneOf":[{"$ref":"#/components/schemas/PendingChanges"},{"type":"null"}]},"rights":{"$ref":"#/components/schemas/BillingRights"},"subject":{"description":"The site or CoreCluster, with what it runs on now.","properties":{"family":{"enum":["general","optimised"],"type":"string"},"monthly":{"description":"What the subject's package and add-ons cost a month now. `null` without a contract.","oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"package":{"oneOf":[{"properties":{"code":{"type":"string"},"key":{"type":"string"}},"required":["key","code"],"type":"object"},{"type":"null"}]},"ref":{"description":"The site's `id` and `domain`, or the CoreCluster's `id` and `name`.","properties":{"domain":{"type":"string"},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id"],"type":"object"},"region":{"description":"The region the contract is priced in. `null` without a contract.","oneOf":[{"properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"],"type":"object"},{"type":"null"}]},"type":{"enum":["site","cluster"],"type":"string"}},"required":["type","ref","package","family","region","monthly"],"type":"object"},"uat":{"description":"For a site, each staging environment with every size it can take. `null` for a CoreCluster and for a site inside one.","oneOf":[{"items":{"properties":{"current":{"type":["string","null"]},"environment":{"properties":{"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"role":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug","role"],"type":"object"},"included":{"description":"Whether this is the staging environment the package includes.","type":"boolean"},"sizes":{"items":{"properties":{"available":{"$ref":"#/components/schemas/Availability"},"delta":{"description":"What the size adds or takes off a month. `null` when it is not priced.","oneOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"key":{"type":"string"},"monthly":{"$ref":"#/components/schemas/Money"}},"required":["key","monthly","delta","available"],"type":"object"},"type":"array"}},"required":["environment","current","included","sizes"],"type":"object"},"type":"array"},{"type":"null"}]}},"required":["subject","currency","packages","addons","uat","family","apply_default","can_apply_tonight","contract","pending","rights","not_billed"],"type":"object"},"UpgradePackage":{"properties":{"capacity":{"properties":{"cpu_millicores":{"type":"integer"},"memory_bytes":{"type":"integer"}},"required":["cpu_millicores","memory_bytes"],"type":"object"},"change":{"description":"With `cluster_id`, what moving the CoreCluster to this package would be: `upgrade`, `downgrade`,\n`shape_change` (a larger package on servers of another shape) or `current` (the package it is on). Null\nwithout `cluster_id`.\n","enum":["upgrade","downgrade","shape_change","current",null],"type":["string","null"]},"code":{"type":"string"},"cores":{"type":"number"},"current":{"description":"With `cluster_id`, whether the CoreCluster is on this package.","type":"boolean"},"estimates":{"additionalProperties":true,"description":"What a site of each platform and size is expected to use, by platform and then by size.","type":"object"},"families":{"description":"The server types the package is offered on.","items":{"type":"string"},"type":"array"},"included_uat":{"description":"The staging environments a CoreStack package includes, or null when it includes none.","oneOf":[{"properties":{"count":{"minimum":1,"type":"integer"},"size":{"description":"The size of each, by its code.","type":"string"}},"required":["size","count"],"type":"object"},{"type":"null"}]},"key":{"description":"The package's key, as the package and CoreCluster routes take it.","type":"string"},"limits":{"properties":{"snapshot_frequency":{"type":"string"},"snapshot_quota_bytes":{"type":"integer"},"snapshot_retention_days":{"type":"integer"},"storage_bytes":{"type":"integer"}},"required":["storage_bytes","snapshot_quota_bytes","snapshot_retention_days","snapshot_frequency"],"type":"object"},"log_quota_gb":{"type":["number","null"]},"log_retention_days":{"type":["integer","null"]},"memory_per_core_gib":{"type":"number"},"name":{"type":"string"},"platforms":{"description":"The platforms the package can run.","items":{"type":"string"},"type":"array"},"product_line":{"enum":["cc","cs"],"type":"string"},"regions":{"items":{"type":"string"},"type":"array"},"tiers":{"description":"The site sizes the package takes.","items":{"type":"string"},"type":"array"}},"required":["key","name","cores","memory_per_core_gib","capacity","limits","platforms","tiers","regions","current","change","product_line","code"],"type":"object"},"UpgradePackageList":{"properties":{"ladder":{"description":"The keys of `packages`, smallest first.","items":{"type":"string"},"type":"array"},"packages":{"items":{"$ref":"#/components/schemas/UpgradePackage"},"type":"array"},"platforms":{"description":"The platforms a new site can be created on, each with its versions and site sizes.","items":{"additionalProperties":true,"properties":{"available":{"type":"boolean"},"key":{"type":"string"},"label":{"type":"string"},"reason":{"type":["string","null"]}},"required":["key","label","available","reason"],"type":"object"},"type":"array"},"product_line":{"enum":["cc","cs"],"type":"string"}},"required":["packages","ladder","platforms","product_line"],"type":"object"},"UpgradeQuoteId":{"description":"The `id` of a quote from `POST /corestack/billing/quote`. With it, the change is refused `409 stale` when the price is no longer the quote's.","format":"uuid","type":["string","null"]},"UpgradeRegion":{"properties":{"default":{"type":"boolean"},"key":{"type":"string"},"label":{"type":"string"},"latency_hint":{"description":"Which visitors the region suits.","type":["string","null"]},"packages":{"description":"The keys of the packages offered there.","items":{"type":"string"},"type":"array"},"place":{"description":"Where the region is.","type":"string"},"reason":{"description":"Why not, in a few words, when it cannot.","type":["string","null"]},"state":{"description":"Whether a CoreCluster can be created there now. `coming_soon` is a region that is not open yet.","type":"string"}},"required":["key","label","place","state","reason","latency_hint","packages","default"],"type":"object"},"UpgradeRegionList":{"properties":{"checked_at":{"description":"When the regions were judged.","format":"date-time","type":"string"},"regions":{"items":{"$ref":"#/components/schemas/UpgradeRegion"},"type":"array"}},"required":["regions","checked_at"],"type":"object"},"UpgradeSiteAddonsRequest":{"properties":{"apply":{"$ref":"#/components/schemas/ApplyChoice"},"cores":{"description":"Extra cores, in all.","maximum":512,"minimum":0,"type":"integer"},"disk_gb":{"description":"Extra disk in GB, in all.","maximum":102400,"minimum":0,"type":"integer"},"log_storage_gb":{"description":"Extra log storage in GB, in all.","maximum":65536,"minimum":0,"type":"integer"},"memory_gb":{"description":"Extra memory in GB, in all.","maximum":4096,"minimum":0,"type":"integer"},"quote_id":{"$ref":"#/components/schemas/UpgradeQuoteId"}},"required":["cores","memory_gb","disk_gb","log_storage_gb"],"type":"object"},"UpgradeSiteChange":{"properties":{"item":{"description":"The pending change, when it is queued.","oneOf":[{"$ref":"#/components/schemas/PendingChangeItem"},{"type":"null"}]},"operation":{"description":"The change, when it started now. `null` when it is queued.","oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"pending":{"$ref":"#/components/schemas/PendingChanges","description":"The site's waiting changes."},"queued":{"description":"Whether the change waits for the night or a window.","type":"boolean"},"quote":{"description":"The price the change was made at. `null` when the site has no billing contract.","oneOf":[{"$ref":"#/components/schemas/BillingQuote"},{"type":"null"}]},"site":{"$ref":"#/components/schemas/SiteDetail"},"window":{"description":"For a queued change while maintenance windows are on, the window it waits for.","oneOf":[{"$ref":"#/components/schemas/QueuedWindow"},{"type":"null"}]}},"required":["site","operation","queued","item","quote","pending"],"type":"object"},"UpgradeSiteFamilyRequest":{"properties":{"apply":{"$ref":"#/components/schemas/ApplyChoice"},"confirm_domain":{"description":"The site's domain, typed to confirm.","maxLength":253,"type":"string"},"family":{"description":"The server type to move to. `general` is Standard and `optimised` is Performance.","enum":["general","optimised"],"type":"string"},"quote_id":{"$ref":"#/components/schemas/UpgradeQuoteId"}},"required":["family","confirm_domain"],"type":"object"},"UpgradeSitePackageRequest":{"properties":{"apply":{"$ref":"#/components/schemas/ApplyChoice"},"confirm_domain":{"description":"The site's domain, typed to confirm.","maxLength":253,"type":"string"},"package":{"description":"The package to move to, by its code, such as `CS8`.","maxLength":16,"type":"string"},"quote_id":{"$ref":"#/components/schemas/UpgradeQuoteId"}},"required":["package","confirm_domain"],"type":"object"},"UrlChangePreview":{"properties":{"blockers":{"description":"What stops the change. Empty when nothing does.","items":{},"type":"array"},"can_proceed":{"type":"boolean"},"checks":{"properties":{"advice":{"oneOf":[{"$ref":"#/components/schemas/DomainAdvice"},{"type":"null"}]},"dns_plan":{"oneOf":[{"$ref":"#/components/schemas/DnsPlan"},{"type":"null"}]},"hosts":{"items":{"$ref":"#/components/schemas/DomainHostCheck"},"type":"array"},"ok":{"type":"boolean"}},"required":["hosts","ok","dns_plan","advice"],"type":"object"},"current_primary":{"type":"string"},"expires_at":{"format":"date-time","type":["string","null"]},"new_canonical_url":{"type":"string"},"new_primary":{"type":"string"},"platform":{"description":"The site's platform, such as `wordpress`.","type":"string"},"preview_token":{"description":"Send this with the change. Valid until `expires_at`.","type":["string","null"]},"replacements":{"additionalProperties":{"type":["object","null"]},"description":"What the change would rewrite in the site, by platform. Only the entry of the site's own `platform` is\nfilled; the others are null. A site on a platform not listed here carries an entry of its own under its\nplatform's name.\n","properties":{"laravel":{"description":"The environment setting that would change. Null on other platforms.","oneOf":[{"properties":{"current":{"type":"string"},"env_key":{"description":"The setting's name, `APP_URL`.","type":"string"},"new":{"type":"string"}},"required":["env_key","current","new"],"type":"object"},{"type":"null"}]},"magento2":{"description":"The base URLs that would change. Null on other platforms.","oneOf":[{"properties":{"base_urls":{"items":{"properties":{"current":{"type":"string"},"new":{"type":"string"},"path":{"description":"The configuration path, such as `web/secure/base_url`.","type":"string"},"scope":{"type":"string"}},"required":["scope","path","current","new"],"type":"object"},"type":"array"}},"required":["base_urls"],"type":"object"},{"type":"null"}]},"wordpress":{"description":"How many database rows mention the old address. Null on other platforms, and when the count is still\nrunning (a warning says so).\n","oneOf":[{"additionalProperties":true,"properties":{"by_table":{"items":{"properties":{"column":{"type":"string"},"rows":{"type":"integer"},"table":{"type":"string"}},"required":["table","column","rows"],"type":"object"},"type":"array"},"duration_ms":{"type":"integer"},"rows":{"type":"integer"},"serialised_safe":{"description":"Whether serialised values can be rewritten safely.","type":"boolean"},"tables":{"type":"integer"}},"required":["tables","rows","by_table","serialised_safe","duration_ms"],"type":"object"},{"type":"null"}]}},"required":["wordpress","laravel","magento2"],"type":"object"},"warnings":{"items":{"type":"string"},"type":"array"}},"required":["current_primary","new_primary","new_canonical_url","checks","platform","replacements","warnings","blockers","can_proceed","preview_token","expires_at"],"type":"object"},"UrlChangePreviewRequest":{"properties":{"new_primary":{"description":"The new main domain, as a plain hostname.","type":"string"},"www":{"description":"Whether the site answers on the `www` form or the `bare` form of the new domain. Left out, it follows\n`new_primary`.\n","enum":["www","bare"],"type":"string"}},"required":["new_primary"],"type":"object"},"UrlChangeRequest":{"properties":{"confirm_domain":{"description":"The site's current main domain, typed exactly.","type":"string"},"confirm_replacements":{"default":false,"description":"True to let `point_dns` replace DNS records that already exist.","type":"boolean"},"new_primary":{"type":"string"},"point_dns":{"default":false,"description":"True to point DNS through your connected Cloudflare account as part of the change.","type":"boolean"},"preview_token":{"description":"The `preview_token` of a preview of the same `new_primary` and `www`, at most 15 minutes old.","type":"string"},"www":{"enum":["www","bare"],"type":"string"}},"required":["new_primary","preview_token","confirm_domain"],"type":"object"},"Usage":{"additionalProperties":true,"properties":{"cpu":{"$ref":"#/components/schemas/UsageSeries"},"disk":{"$ref":"#/components/schemas/UsageSeries"},"from":{"type":"string"},"last_sample_at":{"type":["string","null"]},"memory":{"$ref":"#/components/schemas/UsageSeries"},"range":{"enum":["6h","24h","7d","30d"],"type":"string"},"source":{"type":["string","null"]},"step_seconds":{"type":"integer"},"to":{"type":"string"}},"required":["range","step_seconds","from","to","cpu","memory","disk"],"type":"object"},"UsageSeries":{"additionalProperties":true,"properties":{"limit":{"description":"The most the row can use.","type":["number","null"]},"points":{"description":"One point for each step: the time in epoch milliseconds, then the figures for that step. A figure is null\nwhere nothing was measured.\n","items":{"items":{"type":["number","null"]},"type":"array"},"type":"array"},"request":{"description":"The guaranteed amount.","type":["number","null"]},"size":{"description":"The size of the disk.","type":["number","null"]},"unit":{"type":"string"}},"required":["unit","points"],"type":"object"},"User":{"description":"A person with a Control Panel account. Ids are sent as strings.","properties":{"company":{"description":"The user's company, as `GET /companies` answers it. Null when the account belongs to no company.","oneOf":[{"$ref":"#/components/schemas/Company"},{"type":"null"}]},"company_id":{"description":"The id of the user's company, as a string of digits. An empty string when the account belongs to no company.","type":"string"},"email":{"description":"The address the person is shown with. For somebody invited who has not accepted, the address they were invited at.","type":"string"},"id":{"description":"The user's id, as a string of digits.","type":"string"},"mobile":{"type":["string","null"]},"name":{"type":"string"},"role":{"description":"The person's roles.","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["id","company_id","name","email","mobile","role"],"type":"object"},"UserEnvelope":{"description":"The answer sits under `user`. It is not the `{message, status, data}` envelope of the other older endpoints.","properties":{"user":{"$ref":"#/components/schemas/User"}},"required":["user"],"type":"object"},"UserRole":{"properties":{"name":{"type":"string"},"permissions":{"description":"The keys of the permissions the role grants, such as `viewWebsites`.","items":{"type":"string"},"type":"array"},"slug":{"type":"string"}},"required":["name","slug","permissions"],"type":"object"},"Varnish":{"additionalProperties":true,"description":"A Magento 2 site's Varnish.","properties":{"default_version":{"type":["string","null"]},"enabled":{"type":"boolean"},"live":{"description":"The latest sampled figures. Null until the site has been sampled."},"magento_config":{"description":"Whether Magento's own cache settings match.","properties":{"checked_at":{"format":"date-time","type":["string","null"]},"state":{"enum":["varnish","builtin","needs_repair","pending_code",null],"type":["string","null"]}},"type":"object"},"memory_mib":{"description":"Varnish's share of the site's memory, in MiB.","type":["integer","null"]},"offered":{"description":"Whether the site can use Varnish yet.","type":"boolean"},"opt_out":{"description":"Whether somebody switched Varnish off for the site.","type":"boolean"},"options":{"items":{"$ref":"#/components/schemas/VarnishVersionOption"},"type":"array"},"pending":{"description":"The switch or version change that is still running: its `type`, what it changes to (`on` or `off` for a switch, the version for a version change) and the operation to follow. Null when none is.","oneOf":[{"properties":{"operation_id":{"minimum":1,"type":"integer"},"to":{"type":["string","null"]},"type":{"enum":["varnish_set","varnish_version"],"type":"string"}},"required":["type","to","operation_id"],"type":"object"},{"type":"null"}]},"purge":{"description":"The site's purges.","properties":{"available_in":{"description":"Seconds until the next purge may be asked for. 0 while any are left.","type":"integer"},"last":{"description":"The latest purge, whoever or whatever sent it. Null when there has been none.","oneOf":[{"properties":{"at":{"format":"date-time","type":["string","null"]},"by":{"type":["string","null"]},"count":{"type":["integer","null"]},"items":{"items":{"type":"string"},"type":"array"},"mode":{"type":["string","null"]},"origin":{"description":"Where it came from: `panel`, `api`, `mcp`, or what triggered an automatic one, such as a deployment.","type":"string"},"status":{"type":["string","null"]}},"type":"object"},{"type":"null"}]},"limit_per_hour":{"type":"integer"},"remaining_this_hour":{"type":"integer"}},"required":["remaining_this_hour","limit_per_hour","available_in","last"],"type":"object"},"redis_mib":{"description":"Redis's memory, in MiB, with Varnish `on` and `off`. Null when the site's size cannot be told.","oneOf":[{"properties":{"off":{"type":"integer"},"on":{"type":"integer"}},"type":"object"},{"type":"null"}]},"site":{"properties":{"domain":{"type":"string"},"environment":{"type":"string"},"id":{"minimum":1,"type":"integer"}},"required":["id","domain","environment"],"type":"object"},"storage_mib":{"description":"The cache size, in MiB.","type":["integer","null"]},"switched_off":{"description":"When somebody switched it off, as `at`. Null otherwise.","oneOf":[{"properties":{"at":{"format":"date-time","type":["string","null"]}},"type":"object"},{"type":"null"}]},"version":{"description":"The Varnish version. While Varnish is off, the one the site had last; a switch-on without `version` uses it while it is still allowed for the site, and `default_version` otherwise.","type":["string","null"]}},"required":["offered","enabled","version","options","default_version","opt_out","magento_config","pending","site","purge"],"type":"object"},"VarnishChangeStarted":{"properties":{"operation":{"$ref":"#/components/schemas/VersionChangeOperation"}},"required":["operation"],"type":"object"},"VarnishCommand":{"additionalProperties":true,"description":"A command on the site: a purge, or a repair of Magento's cache settings.","properties":{"duration_ms":{"type":["integer","null"]},"error":{"description":"Why it failed, in plain words.","type":["string","null"]},"exit_code":{"type":["integer","null"]},"finished_at":{"format":"date-time","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"input":{"additionalProperties":true,"description":"What was asked for. For a purge: its `mode`, the items it names and where the request came from (`via`). Null for a repair.","properties":{"host":{"description":"The one host the purge was limited to, when it was.","type":["string","null"]},"include_query":{"type":"boolean"},"mode":{"enum":["all","tags","urls","patterns"],"type":"string"},"patterns":{"items":{"type":"string"},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"target":{"description":"Always `varnish` for a purge.","type":"string"},"urls":{"items":{"type":"string"},"type":"array"},"via":{"description":"Where the purge was asked for, such as `api`.","type":["string","null"]}},"type":["object","null"]},"kind":{"enum":["varnish_purge","magento_varnish_config"],"type":"string"},"label":{"type":"string"},"output_excerpt":{"type":["string","null"]},"queued_at":{"format":"date-time","type":["string","null"]},"requested_by":{},"result":{"additionalProperties":true,"description":"What the command did. For a purge: the requests `sent`, how many were needed (`requests`) and whether Varnish `confirmed` them. For a repair: the cache Magento was set up for (`mode`: `varnish` or `builtin`) and whether anything had to be `changed`. Null until it finishes.","properties":{"changed":{"description":"For a repair: whether Magento's settings had to be changed.","type":"boolean"},"confirmed":{"type":"boolean"},"count":{"description":"How many items the purge named; 1 for everything.","type":"integer"},"hosts":{"items":{"type":"string"},"type":"array"},"mode":{"description":"For a purge, its mode. For a repair, `varnish` or `builtin`: the cache Magento's settings now name.","type":"string"},"objects":{"type":["integer","null"]},"requests":{"type":"integer"},"seconds":{"type":"number"},"sent":{"type":"integer"},"target":{"type":"string"},"warnings":{"description":"Present only when the purge has something to warn about: a pattern broad enough to empty most of the cache, or an address too long to purge with its query variants, of which only the exact address was purged.","items":{"type":"string"},"type":"array"}},"type":["object","null"]},"site":{"$ref":"#/components/schemas/SiteRef"},"started_at":{"format":"date-time","type":["string","null"]},"status":{"description":"`queued` or `running` while it runs, then `succeeded` or `failed`.","type":"string"},"status_label":{"type":"string"}},"required":["id","kind","label","status"],"type":"object"},"VarnishCommandResult":{"properties":{"command":{"$ref":"#/components/schemas/VarnishCommand"}},"required":["command"],"type":"object"},"VarnishOperationResult":{"allOf":[{"$ref":"#/components/schemas/OperationStarted"},{"properties":{"vcl":{"additionalProperties":true,"description":"For a VCL change: whether Varnish loaded it.","properties":{"applied":{"type":"boolean"},"applied_at":{"format":"date-time","type":["string","null"]},"outcome":{"description":"`saving` while it is being saved and loaded, `pending_verify` while the site is checked with it, `applied` once Varnish runs it, `saved` when Varnish is off (it loads when Varnish is switched on), `refused` when Varnish or the save refused it, `verify_failed` while the VCL before it is being put back, `rolled_back` once it has been, and `superseded` when a later save replaced it first.","enum":["saving","pending_verify","applied","saved","refused","verify_failed","rolled_back","superseded"],"type":"string"},"reason":{"description":"Why it was not applied.","type":["string","null"]},"revision":{"type":["integer","null"]},"status":{"type":["string","null"]},"warnings":{"items":{},"type":"array"}},"required":["revision","outcome","applied"],"type":"object"}},"type":"object"}],"description":"The shared `OperationStarted`, with `vcl` beside the operation for a VCL change."},"VarnishPlatformVcl":{"additionalProperties":true,"properties":{"content":{"description":"The platform's VCL.","type":["string","null"]},"insertion":{"description":"The line of the platform's VCL where each snippet is inserted. Null where it is not known.","properties":{"backend_response":{"type":["integer","null"]},"deliver":{"type":["integer","null"]},"recv":{"type":["integer","null"]}},"type":"object"}},"required":["content","insertion"],"type":"object"},"VarnishPurge":{"description":"One of four ways to purge, chosen by `mode`. Send only the list of the mode you choose: another mode's list beside it is refused `invalid_arguments`.","oneOf":[{"additionalProperties":false,"description":"Every page, on every hostname of the site.","properties":{"mode":{"const":"all","type":"string"}},"required":["mode"],"title":"Everything","type":"object"},{"additionalProperties":false,"description":"The pages carrying any of the Magento cache tags, on every hostname of the site.","properties":{"mode":{"const":"tags","type":"string"},"tags":{"description":"1 to 50 Magento cache tags, such as `cat_p_1180`. A tag sent twice counts once.","items":{"pattern":"^[A-Za-z0-9_]{1,64}$","type":"string"},"maxItems":50,"minItems":1,"type":"array"}},"required":["mode","tags"],"title":"By tag","type":"object"},{"additionalProperties":false,"description":"Single addresses.","properties":{"host":{"description":"One of the site's hostnames, to purge the paths on that hostname only. Every hostname when null, `all`, `*` or left out. A hostname that is not the site's is refused `host_not_owned`.","type":["string","null"]},"include_query":{"default":false,"description":"True to purge each address with every query string it has been cached under, not only the one sent. That is done with a pattern made from the address's path, which may be at most 256 bytes: a path of about 250 bytes or more (fewer when it holds characters a pattern must escape) is purged as the exact address sent instead, and the command's `result.warnings` says so.","type":"boolean"},"mode":{"const":"urls","type":"string"},"urls":{"description":"1 to 30 addresses. Each is a path starting with `/`, or a full address on one of the site's hostnames (`https://www.example.com/sale`, or `www.example.com/sale` without the scheme), which is then purged on that hostname whatever `host` says. Only `http` and `https` addresses are taken, without a user name. A fragment is dropped; the path and query are at most 2,048 bytes once characters outside ASCII are percent-encoded (the patterns below count characters), without spaces, double quotes or control characters. An address that is none of these is refused `invalid_urls`.","items":{"anyOf":[{"pattern":"^/(?!/)[^\\x00-\\x20\"\\x7F#]{0,2047}(#.*)?$","title":"A path"},{"pattern":"^[Hh][Tt][Tt][Pp][Ss]?://[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?(\\.[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?)+\\.?(:[0-9]{1,5})?(/[^\\x00-\\x20\"\\x7F#]{0,2047}|\\?[^\\x00-\\x20\"\\x7F#]{0,2046})?(#.*)?$","title":"A full address"},{"pattern":"^[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?(\\.[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?)+\\.?(:[0-9]{1,5})?((/[^\\x00-\\x20\"\\x7F#]{0,2047}|\\?[^\\x00-\\x20\"\\x7F#]{0,2046})(#.*)?)?$","title":"A full address without its scheme"}],"type":"string"},"maxItems":30,"minItems":1,"type":"array"}},"required":["mode","urls"],"title":"By address","type":"object"},{"additionalProperties":false,"description":"Every address matching a pattern.","properties":{"host":{"description":"One of the site's hostnames, to purge on that hostname only. Every hostname when null, `all`, `*` or left out. A hostname that is not the site's is refused `host_not_owned`.","type":["string","null"]},"mode":{"const":"patterns","type":"string"},"patterns":{"description":"1 to 5 regular expressions (PCRE2), matched from the start of the path and query. Each starts with `/` (a leading `^` is allowed and dropped), is at most 256 characters without that `^`, holds printable ASCII only, without spaces or double quotes, and must compile, or it is refused `invalid_pattern` with the position of the fault.","items":{"pattern":"^\\^?/[!#-~]{0,255}$","type":"string"},"maxItems":5,"minItems":1,"type":"array"}},"required":["mode","patterns"],"title":"By pattern","type":"object"}]},"VarnishStats":{"additionalProperties":true,"properties":{"available":{"type":"boolean"},"bucket_seconds":{"description":"The length of one step.","type":"integer"},"buckets":{"description":"One entry a step. A figure is null where there was no sample.","items":{"additionalProperties":true,"properties":{"at":{"format":"date-time","type":"string"},"backend_errors":{"type":["integer","null"]},"backend_fetches":{"type":["integer","null"]},"bytes_free":{"type":["integer","null"]},"bytes_used":{"type":["integer","null"]},"evictions":{"type":["integer","null"]},"hit_ratio":{"type":["number","null"]},"hits":{"type":["integer","null"]},"misses":{"type":["integer","null"]},"objects":{"description":"Cached pages.","type":["integer","null"]},"passes":{"type":["integer","null"]},"requests":{"type":["integer","null"]},"requests_per_s":{"type":["number","null"]},"reset":{"description":"True where the counters started again, for example after a version change.","type":"boolean"},"samples":{"type":"integer"},"storage_bytes":{"type":["integer","null"]},"transient_bytes":{"type":["integer","null"]}},"required":["at"],"type":"object"},"type":"array"},"from":{"type":"string"},"hosts":{"description":"The site's hostnames.","items":{"type":"string"},"type":"array"},"purges_this_hour":{"properties":{"available_at":{"format":"date-time","type":["string","null"]},"limit":{"type":"integer"},"used":{"type":"integer"}},"type":"object"},"range":{"enum":["1h","24h","7d"],"type":"string"},"reason":{"description":"Why there are no figures, such as `sampler_pending` before the first sample.","type":["string","null"]},"recent_purges":{"description":"The latest purges, newest first.","items":{"additionalProperties":true,"properties":{"at":{"format":"date-time","type":["string","null"]},"by":{"description":"The person who asked, by `name`. Null for a purge nobody asked for, or when the account no longer exists.","oneOf":[{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},{"type":"null"}]},"confirmed":{"type":["boolean","null"]},"hosts":{"items":{"type":"string"},"type":"array"},"id":{"minimum":1,"type":"integer"},"item_count":{"type":"integer"},"items":{"items":{"type":"string"},"type":"array"},"mode":{"type":"string"},"reference":{"description":"What the trigger refers to, when it names something. For a deployment, its id.","type":["integer","string","null"]},"source":{"description":"Who or what asked: a `person`, a `deployment`, or the platform by itself (`automatic`).","enum":["person","deployment","automatic"],"type":"string"},"status":{"type":"string"},"trigger":{"description":"What set off a purge nobody asked for, such as `deployment`, `go_live` or `enable`. Null for a person's.","type":["string","null"]},"via":{"description":"Where a person asked. Null for a purge nobody asked for.","enum":["panel","api","mcp",null],"type":["string","null"]}},"required":["id","at","source","mode","items","item_count","hosts","status"],"type":"object"},"type":"array"},"sampled_at":{"format":"date-time","type":["string","null"]},"stale":{"description":"True when the latest sample is old.","type":"boolean"},"to":{"type":"string"},"totals":{"additionalProperties":true,"description":"The same figures over the whole range. A figure is null while there are no samples for it; `missing` names those.","properties":{"backend_errors":{"type":["number","null"]},"backend_fetches":{"type":["number","null"]},"bytes_free":{"type":["number","null"]},"bytes_used":{"type":["number","null"]},"evictions":{"type":["number","null"]},"hit_ratio":{"type":["number","null"]},"hit_ratio_7d":{"type":["number","null"]},"hits":{"type":["number","null"]},"misses":{"type":["number","null"]},"missing":{"items":{"type":"string"},"type":"array"},"objects":{"type":["number","null"]},"pass_ratio":{"type":["number","null"]},"passes":{"type":["number","null"]},"peak_requests_per_s":{"type":["number","null"]},"requests":{"type":["number","null"]},"requests_per_s":{"type":["number","null"]},"resets":{"description":"How many times the counters started again in the range.","type":"integer"},"storage_bytes":{"type":["number","null"]},"transient_bytes":{"type":["number","null"]}},"required":["hits","misses","passes","requests","backend_fetches","backend_errors","evictions","hit_ratio","pass_ratio","requests_per_s","peak_requests_per_s","hit_ratio_7d","objects","bytes_used","bytes_free","storage_bytes","transient_bytes","resets","missing"],"type":"object"}},"required":["available","range","bucket_seconds","from","to","buckets","totals"],"type":"object"},"VarnishSwitch":{"properties":{"apply":{"allOf":[{"$ref":"#/components/schemas/ApplyChoice"}],"description":"When the change is applied. Here `window` is always taken, and means the same as `tonight`."},"enabled":{"type":"boolean"},"version":{"description":"The version to switch on with, such as `8.0`.","maxLength":8,"type":["string","null"]}},"required":["enabled"],"type":"object"},"VarnishVcl":{"additionalProperties":true,"properties":{"applied_at":{"format":"date-time","type":["string","null"]},"applied_by":{"description":"Who saved it."},"applied_revision":{"description":"The number of the revision Varnish runs.","type":["integer","null"]},"available":{"type":"boolean"},"enabled":{"description":"Whether Varnish is on.","type":["boolean","null"]},"hooks":{"$ref":"#/components/schemas/VarnishVclHooks"},"limits":{"properties":{"per_hook_bytes":{"type":"integer"},"statements_per_hook":{"type":"integer"},"total_bytes":{"type":"integer"},"used":{"additionalProperties":{"type":"integer"},"type":"object"}},"required":["per_hook_bytes","total_bytes","statements_per_hook"],"type":"object"},"locked":{"description":"True while Corefinity manages the site's VCL: saves are refused `vcl_locked`.","type":"boolean"},"platform":{"additionalProperties":true,"description":"The platform's part of the VCL, which your snippets run inside.","properties":{"content_url":{"description":"The path of `GET /corestack/sites/{site}/varnish/vcl/platform`, with the `/api` prefix.","type":"string"}},"required":["content_url"],"type":"object"},"policy_url":{"description":"The path of `GET /corestack/sites/{site}/varnish/vcl/policy`, with the `/api` prefix.","type":"string"},"refusal":{"description":"Why Varnish refused the saved revision, when it did."},"revert":{"description":"The automatic return to the revision before a refused one, while it runs or after it failed."},"revision":{"description":"The number of the saved revision.","type":["integer","null"]},"snippets_url":{"description":"The path of `GET /corestack/sites/{site}/varnish/vcl/snippets`, with the `/api` prefix.","type":"string"},"status":{"description":"Where the saved revision stands, such as `applied`, `saving`, `pending_verify` or `saved_dormant`.","type":["string","null"]},"status_reason":{"type":["string","null"]},"varnish_version":{"type":["string","null"]},"version":{"description":"Send it back with every save.","type":"integer"}},"required":["platform","policy_url","snippets_url","available","enabled","version","revision","status","applied_revision","locked","hooks","limits"],"type":"object"},"VarnishVclCheck":{"properties":{"hooks":{"$ref":"#/components/schemas/VarnishVclHooksInput"},"varnish_version":{"description":"A Varnish version to compile with instead of the site's, such as `8.0`. One that is not available yet is refused `version_unsupported`.","enum":["6.0","7.7","8.0","9.1",null],"type":["string","null"]}},"required":["hooks"],"type":"object"},"VarnishVclCheckResult":{"properties":{"diagnostics":{"items":{"$ref":"#/components/schemas/VarnishVclDiagnostic"},"type":"array"},"test":{"description":"The compile. Null when the policy found errors first.","oneOf":[{"additionalProperties":true,"properties":{"id":{"type":["integer","null"]},"outcome":{"description":"`passed` or `failed`, or `unavailable` when it could not be compiled now (`reason` says why): a save then compiles it again.","type":"string"},"reason":{"type":["string","null"]},"skipped":{"type":"boolean"},"varnish":{"description":"The Varnish version that compiled it.","type":["string","null"]}},"type":"object"},{"type":"null"}]},"valid":{"type":"boolean"}},"required":["valid","diagnostics"],"type":"object"},"VarnishVclDiagnostic":{"additionalProperties":true,"description":"One finding about the VCL, from the policy or from the compiler.","properties":{"code":{"description":"The policy's rule, such as `VN-POL-09`; the policy explains each. Left out of a finding of the compiler, which has no rule.","type":"string"},"column":{"type":["integer","null"]},"hook":{"description":"The snippet it is about (`recv`, `backend_response` or `deliver`), or `*` for the policy's limit on the snippets together. Empty for a finding of the compiler about the VCL as a whole, whose `line` and `column` are 0.","type":["string","null"]},"kind":{"description":"What found it: the policy (`policy` for an error, `advice` for a warning) or the compiler (`compile`).","enum":["policy","compile","advice"],"type":"string"},"line":{"type":["integer","null"]},"message":{"type":"string"},"severity":{"enum":["error","warning"],"type":"string"},"source":{"description":"What found it, in words, such as the Varnish version the compile ran on. Left out of a finding of the policy.","type":"string"}},"required":["severity","kind","message"],"type":"object"},"VarnishVclHooks":{"description":"The three snippets: `recv` runs when a request arrives, `backend_response` when Magento has answered, `deliver` before the answer is sent.","properties":{"backend_response":{"type":"string"},"deliver":{"type":"string"},"recv":{"type":"string"}},"required":["recv","backend_response","deliver"],"type":"object"},"VarnishVclHooksInput":{"additionalProperties":false,"description":"The snippets to change. One left out stays as it is; `\"\"` or null empties it.","minProperties":1,"properties":{"backend_response":{"type":["string","null"]},"deliver":{"type":["string","null"]},"recv":{"type":["string","null"]}},"type":"object"},"VarnishVclPolicy":{"additionalProperties":true,"properties":{"codes":{"description":"What each rule code means."},"hook_order":{"items":{"type":"string"},"type":"array"},"hooks":{"additionalProperties":{"additionalProperties":true,"properties":{"header_root":{"description":"The object whose headers the snippet works on, such as `req`.","type":"string"},"placement":{"description":"Where in the subroutine the snippet runs.","type":"string"},"refused_references":{"description":"Variables the snippet may not read, each with its rule. An empty list when there are none."},"reserved_headers":{"description":"Headers kept for the platform.","items":{"type":"string"},"type":"array"},"returns":{"description":"The `return` actions the snippet may use, each with what it takes. An empty list when it may use none."},"routing_headers":{"description":"Request headers the snippet may not change.","items":{"type":"string"},"type":"array"},"secret_headers_readable":{"type":"boolean"},"stub":{"description":"The comment an empty snippet starts with.","type":"string"},"sub":{"description":"The VCL subroutine the snippet runs in, such as `vcl_recv`.","type":"string"},"writable":{"description":"The variables the snippet may set.","items":{"type":"string"},"type":"array"}},"required":["sub","stub","placement","header_root","writable","routing_headers","reserved_headers","secret_headers_readable"],"type":"object"},"description":"For each snippet: where it runs, what it may set and return, and what is kept for the platform.","type":"object"},"limits":{"additionalProperties":true,"properties":{"codes":{"additionalProperties":{"type":"string"},"description":"The rule each limit is refused under.","type":"object"},"per_hook_bytes":{"type":"integer"},"per_hook_statements":{"type":"integer"},"total_bytes":{"type":"integer"}},"required":["per_hook_bytes","total_bytes","per_hook_statements","codes"],"type":"object"},"name":{"type":"string"},"policy_version":{"type":"integer"},"refused_hooks":{"additionalProperties":{"type":"string"},"type":"object"}},"required":["policy_version","hooks"],"type":"object"},"VarnishVclRevision":{"additionalProperties":true,"properties":{"applied":{"description":"Whether Varnish runs it.","type":"boolean"},"author":{"description":"The person's name, or Corefinity. Left out when the account no longer exists.","type":["string","null"]},"created_at":{"format":"date-time","type":["string","null"]},"current":{"description":"Whether it is the saved VCL.","type":"boolean"},"diagnostics":{"properties":{"errors":{"type":"integer"},"warnings":{"type":"integer"}},"type":"object"},"hooks":{"description":"The snippets it changed.","items":{"enum":["recv","backend_response","deliver"],"type":"string"},"type":"array"},"id":{"minimum":1,"type":"integer"},"mcp":{"description":"Whether an AI assistant made it.","type":"boolean"},"note":{"type":["string","null"]},"number":{"type":"integer"},"operation_id":{"type":["integer","null"]},"origin":{"description":"How the revision came about, such as `save`, `revert` or `platform` for revision 0.","type":"string"},"status":{"description":"Where the revision stands, such as `saving`, `pending_verify`, `applied`, `rejected`, `verify_failed`, `rolled_back`, `superseded` or `saved_dormant`.","type":"string"}},"required":["id","number","created_at","origin","status","current","applied","hooks"],"type":"object"},"VarnishVclRevisionDetail":{"allOf":[{"$ref":"#/components/schemas/VarnishVclRevision"},{"properties":{"against":{"description":"The number of the revision it is compared with. Null when the site has no revision with the number asked for; the diff is then against nothing.","type":["integer","null"]},"content":{"$ref":"#/components/schemas/VarnishVclHooks"},"content_sha256":{"type":"string"},"diagnostics_list":{"items":{"$ref":"#/components/schemas/VarnishVclDiagnostic"},"type":"array"},"diff":{"description":"A unified diff per snippet. Null where it agrees.","properties":{"backend_response":{"type":["string","null"]},"deliver":{"type":["string","null"]},"recv":{"type":["string","null"]}},"type":"object"}},"required":["content","against","diff"],"type":"object"}]},"VarnishVclRevisionPage":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"revisions":{"items":{"$ref":"#/components/schemas/VarnishVclRevision"},"type":"array"}},"required":["revisions"],"type":"object"}]},"VarnishVclSaveResult":{"properties":{"applied":{"description":"False, present when Varnish is off.","type":"boolean"},"message":{"type":"string"},"operation":{"description":"The change to follow. Null when nothing changed.","oneOf":[{"$ref":"#/components/schemas/Operation"},{"type":"null"}]},"revision":{"description":"The new revision. Null when nothing changed.","oneOf":[{"properties":{"number":{"type":["integer","null"]},"status":{"type":["string","null"]}},"required":["number","status"],"type":"object"},{"type":"null"}]},"varnish_off":{"description":"True when Varnish is off: the VCL loads when it is switched on.","type":"boolean"},"warnings":{"description":"What the policy warns about in the saved snippets. A warning never stops the save.","items":{"$ref":"#/components/schemas/VarnishVclDiagnostic"},"type":"array"}},"required":["revision","operation"],"type":"object"},"VarnishVclSnippet":{"additionalProperties":true,"properties":{"content":{"type":"string"},"description":{"type":"string"},"hook":{"enum":["recv","backend_response","deliver"],"type":"string"},"id":{"type":"string"},"title":{"type":"string"}},"required":["id","hook","title","content"],"type":"object"},"VarnishVclUpdate":{"properties":{"hooks":{"$ref":"#/components/schemas/VarnishVclHooksInput"},"note":{"description":"Why, shown in the history.","maxLength":200,"type":["string","null"]},"version":{"description":"The `version` from the last read.","minimum":0,"type":"integer"}},"required":["version","hooks"],"type":"object"},"VarnishVersionChange":{"properties":{"acknowledge":{"description":"What you accept about the version. `eol` for one past its end of life.","items":{"enum":["eol"],"type":"string"},"maxItems":1,"type":"array"},"apply":{"allOf":[{"$ref":"#/components/schemas/ApplyChoice"}],"description":"When the change is applied. Here `window` is always taken, and means the same as `tonight`."},"version":{"description":"The version to move to, such as `8.0`. A refusal may name this field `to`, an older name for it.","maxLength":8,"type":"string"}},"required":["version"],"type":"object"},"VarnishVersionOption":{"properties":{"allowed":{"description":"Whether the site may move to it. False for the current version, which it already runs.","type":"boolean"},"current":{"type":"boolean"},"reason":{"description":"Why it is not allowed; for the current version, that it is the current one.","type":["string","null"]},"status":{"description":"Where the version stands, such as `lts`, `eol` or `prerelease`.","type":"string"},"version":{"type":"string"}},"required":["version","allowed","current","status","reason"],"type":"object"},"VarnishVersions":{"properties":{"default_version":{"type":["string","null"]},"enabled":{"type":["boolean","null"]},"options":{"items":{"$ref":"#/components/schemas/VarnishVersionOption"},"type":"array"},"version":{"type":["string","null"]}},"required":["enabled","version","default_version","options"],"type":"object"},"VersionChangeOperation":{"additionalProperties":true,"description":"The short operation a version change answers when it starts. Follow it by `id` with\n`GET /corestack/operations/{operation}`, which answers the full `Operation`.\n","properties":{"committed_at":{"type":["string","null"]},"completed_at":{"type":["string","null"]},"created_at":{"type":["string","null"]},"error":{"type":["string","null"]},"from_version":{"type":["string","null"]},"id":{"type":"integer"},"requested_by":{"description":"Who asked for the change."},"status":{"$ref":"#/components/schemas/OperationStatus"},"status_label":{"type":"string"},"steps":{"items":{"$ref":"#/components/schemas/OperationStep"},"type":"array"},"to_version":{"type":["string","null"]},"type":{"type":"string"},"type_label":{"type":"string"}},"required":["id","type","type_label","from_version","to_version","status","status_label","steps","error","created_at","committed_at","completed_at"],"type":"object"},"Warning":{"description":"Something to know about a setting or a change. It never stops the change.","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"WebsiteCreateOptions":{"properties":{"app_versions":{"additionalProperties":true,"description":"The application versions on offer, by platform. Only while application versions are on for your company.","type":"object"},"corecluster":{"properties":{"available":{"$ref":"#/components/schemas/Availability"},"href":{"type":["string","null"]}},"required":["available","href"],"type":"object"},"corestack":{"properties":{"available":{"$ref":"#/components/schemas/Availability"},"new_cluster_href":{"description":"Where a new CoreCluster is ordered in the Control Panel.","type":["string","null"]},"packages":{"description":"The `key` of each package on offer.","items":{"type":"string"},"type":"array"},"placements":{"description":"Where a new CoreStack site can be placed: a region of the platform (`kind` `platform`), or one of your CoreClusters with its room (`kind` `cluster`).","items":{"properties":{"available":{"$ref":"#/components/schemas/Availability"},"capacity":{"$ref":"#/components/schemas/ClusterCapacity","description":"`cluster`: how much of its package the CoreCluster uses."},"cluster":{"$ref":"#/components/schemas/ClusterRef","description":"`cluster`: the CoreCluster."},"family":{"description":"The compute families on offer there.","items":{"additionalProperties":true,"properties":{"available":{"type":"boolean"},"key":{"description":"`general` or `optimised`: the value to send as `compute_family`.","type":"string"},"label":{"type":"string"},"note":{"type":["string","null"]},"provisioned":{"description":"False when the first site of this family waits for its servers.","type":"boolean"},"reason":{"type":["string","null"]}},"required":["key","label","available","provisioned","reason","note"],"type":"object"},"type":"array"},"grows":{"description":"`cluster`: true when the CoreCluster grows by itself when a site needs more room.","type":"boolean"},"kind":{"enum":["platform","cluster"],"type":"string"},"label":{"description":"`platform`: the region's name.","type":"string"},"region":{"description":"The region code, such as `uk`. Empty for a CoreCluster whose region is not known.","type":"string"},"state":{"description":"`platform`: `coming_soon` while the region takes no CoreStack site yet.","enum":["ready","coming_soon"],"type":"string"}},"required":["kind","region","family","available"],"type":"object"},"type":"array"},"uat_sizes":{"description":"The `key` of each staging size on offer.","items":{"type":"string"},"type":"array"}},"required":["available","placements","packages","uat_sizes","new_cluster_href"],"type":"object"},"enterprise":{"properties":{"available":{"$ref":"#/components/schemas/Availability"},"href":{"type":["string","null"]}},"required":["available","href"],"type":"object"},"owner":{"description":"The company the site would belong to. Null when you have no company.","oneOf":[{"properties":{"host_slug":{"description":"The company's part of a new site's platform address.","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"}},"required":["id","name","host_slug"],"type":"object"},{"type":"null"}]}},"required":["corestack","owner","corecluster","enterprise"],"type":"object"},"WebsiteList":{"properties":{"can_create":{"description":"Which products you can create a site on.","properties":{"corecluster":{"type":"boolean"},"corestack":{"type":"boolean"},"enterprise":{"type":"boolean"}},"required":["corestack","corecluster","enterprise"],"type":"object"},"counts":{"description":"How many websites match the filters, in all and by product.","properties":{"all":{"type":"integer"},"corecluster":{"type":"integer"},"corestack":{"type":"integer"},"enterprise":{"type":"integer"},"mixed":{"type":"integer"}},"required":["all","enterprise","corestack","corecluster","mixed"],"type":"object"},"page":{"type":"integer"},"per_page":{"type":"integer"},"rows":{"items":{"$ref":"#/components/schemas/WebsiteRow"},"type":"array"},"sort":{"properties":{"dir":{"enum":["asc","desc"],"type":"string"},"key":{"enum":["name","company","status","kind","updated"],"type":"string"}},"required":["key","dir"],"type":"object"},"total":{"type":"integer"}},"required":["rows","total","page","per_page","counts","sort","can_create"],"type":"object"},"WebsiteRow":{"properties":{"attention":{"description":"How many things on the website need attention.","type":"integer"},"badge":{"description":"The product the website runs on.","properties":{"kind":{"enum":["enterprise","corestack","corecluster","mixed"],"type":"string"},"label":{"type":"string"}},"required":["kind","label"],"type":"object"},"cluster":{"description":"The cluster the website is in. Null for a website that is in none.","oneOf":[{"properties":{"href":{"description":"Where the CoreCluster opens in the Control Panel. Null for a cluster that has no page of yours.","type":["string","null"]},"id":{"minimum":1,"type":"integer"},"kind":{"description":"`customer` for one of your CoreClusters, `platform` for the CoreStack platform, `legacy` for a CoreStack Enterprise cluster.","type":"string"},"label":{"type":"string"}},"required":["id","kind","label","href"],"type":"object"},{"type":"null"}]},"company":{"$ref":"#/components/schemas/Named"},"environment_count":{"type":"integer"},"environments":{"items":{"properties":{"group":{"description":"Where the environment is listed, such as `production` or `staging`.","type":"string"},"hosting_kind":{"description":"`corestack` for a row `/corestack/sites/{site}` takes, `enterprise` for a CoreStack Enterprise environment.","enum":["corestack","enterprise"],"type":"string"},"href":{"description":"Where the environment opens in the Control Panel.","type":["string","null"]},"id":{"description":"The environment's id. Not a site row id.","minimum":1,"type":"integer"},"label":{"type":"string"},"name":{"type":"string"},"pending_changes":{"description":"How many changes wait for the maintenance window.","type":"integer"},"reseller_site_id":{"description":"The site row id to use in `/corestack/sites/{site}`. Null for a CoreStack Enterprise environment.","minimum":1,"type":["integer","null"]},"role":{"type":["string","null"]},"state":{"description":"Such as `ready`, `provisioning` or `unknown`.","type":"string"},"uat_size":{"description":"The staging size of a CoreStack site's environment. Left out for a production row.","type":["string","null"]}},"required":["id","label","name","role","group","hosting_kind","reseller_site_id","state","href","pending_changes"],"type":"object"},"type":"array"},"hrefs":{"properties":{"open":{"description":"Where the website opens in the Control Panel.","type":["string","null"]}},"required":["open"],"type":"object"},"id":{"minimum":1,"type":"integer"},"name":{"type":"string"},"pending_changes":{"type":"integer"},"platform":{"description":"The platform of the website's production environment. Null when it has none.","oneOf":[{"properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"],"type":"object"},{"type":"null"}]},"region":{"description":"The region the website is in, when known.","oneOf":[{"properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"],"type":"object"},{"type":"null"}]},"status":{"properties":{"key":{"description":"0 inactive, 1 pending setup, 2 onboarding, 3 active.","enum":[0,1,2,3],"type":"integer"},"label":{"type":"string"}},"required":["key","label"],"type":"object"},"updated_at":{"format":"date-time","type":["string","null"]},"url":{"type":["string","null"]}},"required":["id","name","url","badge","company","status","platform","cluster","region","environments","environment_count","attention","pending_changes","updated_at","hrefs"],"type":"object"},"WhatsNewEntry":{"description":"One change log entry or announcement.","properties":{"content_html":{"description":"The entry as the page shows it, as HTML.","type":"string"},"content_text":{"description":"The same words as plain text, one line for each block.","type":"string"},"id":{"minimum":1,"type":"integer"},"published_on":{"description":"The date the entry is presented under.","format":"date","type":["string","null"]},"seen":{"description":"Whether you have read the entry.","type":"boolean"},"title":{"type":"string"},"type":{"$ref":"#/components/schemas/WhatsNewType"},"type_label":{"description":"The category as the page shows it, such as `New feature`.","type":"string"}},"required":["id","title","type","type_label","published_on","content_html","content_text","seen"],"type":"object"},"WhatsNewEntryAnswer":{"properties":{"data":{"$ref":"#/components/schemas/WhatsNewEntry"}},"required":["data"],"type":"object"},"WhatsNewListAnswer":{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CursorPage"},{"properties":{"items":{"description":"The entries, newest first. One recorded for a coming release is never listed.","items":{"$ref":"#/components/schemas/WhatsNewEntry"},"type":"array"}},"required":["items"],"type":"object"}]}},"required":["data"],"type":"object"},"WhatsNewMarkSeen":{"properties":{"announcement_ids":{"description":"The ids of the entries to mark as read. A repeated id counts once.","items":{"minimum":1,"type":"integer"},"maxItems":50,"minItems":1,"type":"array"}},"required":["announcement_ids"],"type":"object"},"WhatsNewSeenAnswer":{"properties":{"data":{"properties":{"seen":{"description":"The ids now read, newest first.","items":{"type":"integer"},"type":"array"},"unseen":{"description":"How many entries you have still not read.","type":"integer"}},"required":["seen","unseen"],"type":"object"}},"required":["data"],"type":"object"},"WhatsNewType":{"description":"An entry's category. Change log entries are `new_feature`, `improvement`, `bug_fix` or `chore`; older\nannouncements are `announcement`, `news`, `event`, `maintenance`, `other` or `changelog`.\n","enum":["announcement","news","event","changelog","maintenance","other","new_feature","improvement","bug_fix","chore"],"type":"string"}},"securitySchemes":{"bearerAuth":{"description":"A personal access token made on your profile page in the Control Panel, sent as\n`Authorization: Bearer <token>`. A token holds the scopes chosen when it was made.\n","scheme":"bearer","type":"http"}}}}