{
"message": "This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."
}
{
"message": "Not found."
}
{
"message": "Too Many Attempts."
}
Servers
Get a server
Overview
Returns a server’s name, plan, usage, limits, location and last known power state. These saved details may be a few seconds old. Add ?include=user to include the account that owns it.
Permissions
Requires the server.read (View servers) permission for the selected team. Resources outside that team return 404.
Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.
Why the hold above is on, in the words of whoever put it on, or null where no reason was given. Only ever set alongside suspended: it is cleared when the suspension is lifted. Show it to the customer - it is written for them, and it is the difference between a machine that says it is suspended and one that says what to do about it.
Set only while the last install or rebuild is still an unread failure: cleared by the next attempt, and by the customer dismissing the notice it draws.
Set only while the last backup or snapshot restore is still an unread failure: cleared by the next restore or reinstall, and by the customer dismissing the notice it draws.
What the server's transfer really looks like once purchased blocks and pooling exist. Null, like cpu_throttle above it, whenever the plan's own allowance is the whole story.
The city the server stands in, e.g. "Nuremberg, DE". A location is a city now; displayName() also reads back the older codes that carried the product alongside it in brackets.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Advin Servers","colors":{"primary":"#232323","light":"#ffffff","dark":"#232323"},"logo":{"light":"https://mintcdn.com/advinservers/hsoR78mplm26jwSe/logo/light.svg?fit=max\u0026auto=format\u0026n=hsoR78mplm26jwSe\u0026q=85\u0026s=5adfd787faa2746d42842a3dbe9d5c55","dark":"https://mintcdn.com/advinservers/pwCfGukIkzeLYqrm/logo/dark.svg?fit=max\u0026auto=format\u0026n=pwCfGukIkzeLYqrm\u0026q=85\u0026s=97d478977cc103da1d2432e03943b388"},"favicon":"https://mintcdn.com/advinservers/MD6yusifmHDEhuzq/logo/logo.jpg?fit=max\u0026auto=format\u0026n=MD6yusifmHDEhuzq\u0026q=85\u0026s=4a842dcaf66f28bd660d8b3448d9ca0c","appearance":{"default":"dark","strict":false},"background":{"color":{"dark":"#0d0d0d"}},"navbar":{"links":[{"href":"https://clients.advinservers.com/contact.php","label":"Support"}],"primary":{"type":"button","label":"Home","href":"https://clients.advinservers.com"}},"footer":{"socials":{"twitter":"https://x.com/@advinservers","linkedin":"https://www.linkedin.com/company/98505920","facebook":"https://www.facebook.com/profile.php?id=61554233398872","instagram":"https://www.instagram.com/advin_servers"}},"fonts":{"family":"Geist"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Console","icon":"terminal","href":"https://console.advinservers.com"},{"anchor":"Network Status","icon":"signal-bars","href":"https://status.advinservers.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"advinservers","hasAudioNarration":false,"actualSubdomain":"advinservers","customDomains":["docs.advinservers.com"],"gitSource":{"type":"github","owner":"advin-servers","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af2def2a8d5ba2dc2cd4074","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API","count":219},{"language":"default","tag":"Endpoints","count":218},{"language":"default","tag":"Console","count":30},{"language":"default","tag":"Billing","count":24},{"language":"default","tag":"Servers","count":19},{"language":"default","tag":"General","count":15},{"language":"default","tag":"Bandwidth","count":15},{"language":"default","tag":"Firewall groups","count":15},{"language":"default","tag":"Server settings","count":15},{"language":"default","tag":"Snapshots","count":15}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":".dark{--background-dark: 13 13 13;--gray-50: 237 237 237;--gray-100: 237 237 237;--gray-200: 237 237 237;--gray-300: 204 204 204;--gray-400: 161 161 161;--gray-500: 138 138 138;--gray-600: 52 52 52;--gray-700: 44 44 44;--gray-800: 30 30 30;--gray-900: 22 22 22;--gray-950: 15 15 15;--primary-dark: 212 212 212}.dark #navbar>div:first-child{background-color:#0f0f0f;border-color:#343434}.dark #search-bar-entry,.dark #search-bar-entry-mobile{background-color:#0f0f0f;border-color:#404040;color:#a1a1a1}.dark #topbar-cta-button a>div,.dark #topbar-cta-button a>div>*{color:#0d0d0d}.dark #sidebar [aria-current=\"page\"],.dark #sidebar .bg-primary\\/10{background-color:#1e1e1e;color:#ededed}.dark .code-block{background-color:#0f0f0f;border-color:#343434}.dark .prose :not(pre)>code{background-color:#161616;border-color:#343434;color:#ededed}.dark .card,.dark [data-component-part=\"card\"],.dark .accordion,.dark [data-component-part=\"accordion\"]{background-color:#0f0f0f;border-color:#343434}.dark .callout{--callout-rgb: 59 130 246;--callout-text: 147 197 253;--callout-icon: 96 165 250;--callout-bg-alpha: 0.07;--callout-border-alpha: 0.25;background-color:rgb(var(--callout-rgb) / var(--callout-bg-alpha));border-color:rgb(var(--callout-rgb) / var(--callout-border-alpha));color:rgb(var(--callout-text) / 0.8)}.dark .callout [data-component-part=\"callout-icon\"],.dark .callout [data-component-part=\"callout-icon\"] svg{color:rgb(var(--callout-icon))}.dark .callout [data-component-part=\"callout-content\"],.dark .callout [data-component-part=\"callout-content\"] :is(p,li,strong,a,span){color:rgb(var(--callout-text) / 0.8)}.dark .callout[data-callout-type=\"tip\"],.dark .callout[data-callout-type=\"check\"]{--callout-rgb: 22 163 74;--callout-text: 134 239 172;--callout-icon: 74 222 128}.dark .callout[data-callout-type=\"warning\"]{--callout-rgb: 228 158 34;--callout-text: 247 185 85;--callout-icon: 247 185 85;--callout-bg-alpha: 0.09;--callout-border-alpha: 0.3}.dark .callout[data-callout-type=\"danger\"]{--callout-rgb: 189 65 63;--callout-text: 211 117 115;--callout-icon: 211 117 115}.dark .mdx-content img{border:1px solid #343434}"}],"page":{"pagePath":"api-reference/servers/get-a-server","slug":"/api-reference/servers/get-a-server","pageMetadata":{"title":"Get a server","description":"### Overview\n\nReturns a server's name, plan, usage, limits, location and last known power state. These saved details may be a few seconds old. Add `?include=user` to include the account that owns it.\n\n### Permissions\n\nRequires the `server.read` (View servers) permission for the selected team. Resources outside that team return 404.","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}","href":"/api-reference/servers/get-a-server","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h3: \"h3\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.h3, {\n children: \"Overview\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Returns a server’s name, plan, usage, limits, location and last known power state. These saved details may be a few seconds old. Add \", _jsx(_components.code, {\n children: \"?include=user\"\n }), \" to include the account that owns it.\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Permissions\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Requires the \", _jsx(_components.code, {\n children: \"server.read\"\n }), \" (View servers) permission for the selected team. Resources outside that team return 404.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a server","description":"### Overview\n\nReturns a server's name, plan, usage, limits, location and last known power state. These saved details may be a few seconds old. Add `?include=user` to include the account that owns it.\n\n### Permissions\n\nRequires the `server.read` (View servers) permission for the selected team. Resources outside that team return 404.","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}","href":"/api-reference/servers/get-a-server","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"client.servers.show","description":"### Overview\n\nReturns a server's name, plan, usage, limits, location and last known power state. These saved details may be a few seconds old. Add `?include=user` to include the account that owns it.\n\n### Permissions\n\nRequires the `server.read` (View servers) permission for the selected team. Resources outside that team return 404.","summary":"Get a server","tags":["Servers"],"parameters":["1d4314b8-a42e-44fd-af20-3fbef7645091","58047086-c4fb-4dff-9ce6-de75e63feb42"],"responses":{"200":"f1d6f21f-8b68-4416-bde9-2c76e272b27c","401":"f2f2c19e-393c-4a0b-a554-41ad9c276c59","403":"59b47677-242d-4960-bea1-7509b4188ccf","404":"6c42e822-5620-4961-ae67-0d5a74254ba8","429":"809cd40e-c422-4f5c-99bf-7a345ad56176"},"method":"get","type":"path","servers":["49ace053-d2ae-45c8-8b5e-9b487eb81f6a"],"security":["f8b33b37-6c4c-4349-ac95-09bac911f9ea"],"path":"/servers/{server}","baseUrlOptions":["https://console.advinservers.com/api/v1/client"],"title":"Get a server","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1d4314b8-a42e-44fd-af20-3fbef7645091":{"name":"server","in":"path","required":true,"description":"The server UUID","schema":{"type":"string","examples":["ecc6f4f1"],"isRequired":true,"description":"The server UUID","uniqueKey":"","typeLabel":"string"},"example":"ecc6f4f1"},"58047086-c4fb-4dff-9ce6-de75e63feb42":{"name":"include","in":"query","description":"Related records to include, with multiple values separated by commas.","schema":{"type":"string","examples":["user"],"description":"Related records to include, with multiple values separated by commas.","uniqueKey":"","typeLabel":"string"},"example":"user"}},"responses":{"f1d6f21f-8b68-4416-bde9-2c76e272b27c":{"description":"The record, as a JSON object. There is no envelope.","content":{"application/json":{"schema":{"type":"object","title":"ServerData","description":"A server and its current configuration and status.","required":["id","uuid","hostname","name","description","status","suspension_reason","power_state","windows","template_name","template_icon_url","custom_icon_url","default_icon_url","created_at","usages","limits","internal_id","restoration_progress","installation_progress","install_failed_at","restore_failed_at","cpu_throttle","bandwidth","provisioning_scripts_supported","snapshots_supported","maintenance","maintenance_events","location","product_group_name"],"example":{"id":"ecc6f4f1","uuid":"ecc6f4f1-c89b-4dce-a20b-a330641c5b0b","hostname":"lambda-core.blackmesa.example.com","name":"lambda-core","description":"Lambda Complex test chamber telemetry","status":null,"suspension_reason":null,"power_state":"running","windows":false,"template_name":"Ubuntu 24.04","template_icon_url":"https://img.icons8.com/color/48/ubuntu.png","custom_icon_url":null,"default_icon_url":"https://img.icons8.com/color/48/ubuntu.png","created_at":"2026-03-02T19:14:36.000000Z","usages":{"bandwidth":500000000000,"actual_bandwidth":500000000000,"rx":200000000000,"tx":300000000000},"limits":{"cpu":4,"memory":4294967296,"disk":85899345920,"hdd_disk":null,"snapshots":2,"backups":2,"bandwidth":5497558138880,"addresses":{"ipv4":[{"id":58213,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":true,"address":"203.0.113.24","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null},{"id":58391,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":false,"address":"203.0.113.88","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null}],"ipv6":[{"id":58214,"address_pool_id":5,"server_id":4821,"user_id":null,"type":"ipv6","is_primary":false,"address":"2001:db8:4b2:18::1","cidr":64,"gateway":"2001:db8:4b2::1","mac_address":"52:54:00:3a:7c:91","onlink":"2001:db8:4b2::18","floating_ip_uuid":null}]},"mac_address":"52:54:00:3a:7c:91","effective_bandwidth":5497558138880,"bandwidth_blocks":0,"plan_bandwidth":5497558138880},"internal_id":4821,"restoration_progress":null,"installation_progress":null,"install_failed_at":null,"restore_failed_at":null,"cpu_throttle":null,"bandwidth":null,"provisioning_scripts_supported":true,"snapshots_supported":true,"maintenance":null,"maintenance_events":[],"location":"Kansas City, MO","product_group_name":"Standard VPS"},"properties":{"id":{"type":"string","description":"The short uuid. This is what every customer-facing URL is keyed by.","examples":["ecc6f4f1"],"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"uuid":{"type":"string","description":"The uuid UUID.","examples":["ecc6f4f1-c89b-4dce-a20b-a330641c5b0b"],"isRequired":true,"uniqueKey":"uuid","typeLabel":"string"},"hostname":{"type":"string","description":"The fully qualified hostname.","examples":["lambda-core.blackmesa.example.com"],"isRequired":true,"uniqueKey":"hostname","typeLabel":"string"},"name":{"type":"string","description":"The name shown to customers.","examples":["lambda-core"],"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"An optional description shown to customers.","examples":["Lambda Complex test chamber telemetry"],"isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional description shown to customers.","examples":["Lambda Complex test chamber telemetry"],"isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","description":"A pending server operation, or null when there is none. `starting` and `stopping` clear when the power command finishes.","enum":["installing","install_failed","suspended","restoring_backup","restoring_snapshot","snapshotting","deleting","deletion_failed","upgrading","migrating","starting","stopping",null],"examples":[null],"isRequired":true,"uniqueKey":"status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"A pending server operation, or null when there is none. `starting` and `stopping` clear when the power command finishes.","enum":["installing","install_failed","suspended","restoring_backup","restoring_snapshot","snapshotting","deleting","deletion_failed","upgrading","migrating","starting","stopping",null],"examples":[null],"isRequired":true,"uniqueKey":"status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring> | null"},"suspension_reason":{"oneOf":[{"type":"string","description":"Why the hold above is on, in the words of whoever put it on, or null where no reason was given. Only ever set alongside `suspended`: it is cleared when the suspension is lifted. Show it to the customer - it is written for them, and it is the difference between a machine that says it is suspended and one that says what to do about it.","examples":[null],"isRequired":true,"uniqueKey":"suspension_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Why the hold above is on, in the words of whoever put it on, or null where no reason was given. Only ever set alongside `suspended`: it is cleared when the suspension is lifted. Show it to the customer - it is written for them, and it is the difference between a machine that says it is suspended and one that says what to do about it.","examples":[null],"isRequired":true,"uniqueKey":"suspension_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"suspension_reason","typeLabel":"string | null"},"power_state":{"oneOf":[{"type":"string","description":"The value of `power_state`.","enum":["running","stopped","paused",null],"examples":["running"],"isRequired":true,"uniqueKey":"power_state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The value of `power_state`.","enum":["running","stopped","paused",null],"examples":["running"],"isRequired":true,"uniqueKey":"power_state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"power_state","typeLabel":"enum\u003cstring> | null"},"windows":{"type":"boolean","description":"The value of `windows`.","examples":[false],"isRequired":true,"uniqueKey":"windows","typeLabel":"boolean"},"template_name":{"oneOf":[{"type":"string","description":"The value of `template_name`.","examples":["Ubuntu 24.04"],"isRequired":true,"uniqueKey":"template_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `template_name`.","examples":["Ubuntu 24.04"],"isRequired":true,"uniqueKey":"template_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"template_name","typeLabel":"string | null"},"template_icon_url":{"oneOf":[{"type":"string","description":"The icon actually in force: the customer's own pick where they have made one, otherwise the artwork snapshotted from the template.","examples":["https://img.icons8.com/color/48/ubuntu.png"],"isRequired":true,"uniqueKey":"template_icon_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The icon actually in force: the customer's own pick where they have made one, otherwise the artwork snapshotted from the template.","examples":["https://img.icons8.com/color/48/ubuntu.png"],"isRequired":true,"uniqueKey":"template_icon_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"template_icon_url","typeLabel":"string | null"},"custom_icon_url":{"oneOf":[{"type":"string","description":"The raw override, so a form can tell a pick from a default.","examples":[null],"isRequired":true,"uniqueKey":"custom_icon_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The raw override, so a form can tell a pick from a default.","examples":[null],"isRequired":true,"uniqueKey":"custom_icon_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"custom_icon_url","typeLabel":"string | null"},"default_icon_url":{"oneOf":[{"type":"string","description":"What the icon falls back to if that override is cleared.","examples":["https://img.icons8.com/color/48/ubuntu.png"],"isRequired":true,"uniqueKey":"default_icon_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"What the icon falls back to if that override is cleared.","examples":["https://img.icons8.com/color/48/ubuntu.png"],"isRequired":true,"uniqueKey":"default_icon_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"default_icon_url","typeLabel":"string | null"},"created_at":{"type":"string","description":"The date and time for created at, in UTC.","examples":["2026-03-02T19:14:36.000000Z"],"isRequired":true,"uniqueKey":"created_at","typeLabel":"string"},"usages":{"type":"object","description":"The value of `usages`.","examples":[{"bandwidth":500000000000,"actual_bandwidth":500000000000,"rx":200000000000,"tx":300000000000}],"properties":{"bandwidth":{"type":"integer","description":"The billed figure, clamped to whatever allowance was in force when it was accrued.","examples":[500000000000],"isRequired":true,"uniqueKey":"usages.bandwidth","typeLabel":"integer"},"actual_bandwidth":{"oneOf":[{"type":"integer","description":"The unclamped counter, which is what the pool is shared against. Null on a server that has never been metered.","examples":[500000000000],"isRequired":true,"uniqueKey":"usages.actual_bandwidth.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The unclamped counter, which is what the pool is shared against. Null on a server that has never been metered.","examples":[500000000000],"isRequired":true,"uniqueKey":"usages.actual_bandwidth.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"usages.actual_bandwidth","typeLabel":"integer | null"},"rx":{"type":"integer","description":"Inbound and outbound halves of the accrued usage, accounted on the public NIC only. Servers that last accrued before the split was recorded carry zeroes here while `bandwidth` is non-zero, so a consumer has to read 0/0 as \"not broken down\" rather than as \"no traffic\".","examples":[200000000000],"isRequired":true,"uniqueKey":"usages.rx","typeLabel":"integer"},"tx":{"type":"integer","description":"The value of `tx`.","examples":[300000000000],"isRequired":true,"uniqueKey":"usages.tx","typeLabel":"integer"}},"required":["bandwidth","actual_bandwidth","rx","tx"],"title":"ServerUsagesData","isRequired":true,"uniqueKey":"usages","typeLabel":"ServerUsagesData · object"},"limits":{"type":"object","description":"The value of `limits`.","examples":[{"cpu":4,"memory":4294967296,"disk":85899345920,"hdd_disk":null,"snapshots":2,"backups":2,"bandwidth":5497558138880,"addresses":{"ipv4":[{"id":58213,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":true,"address":"203.0.113.24","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null},{"id":58391,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":false,"address":"203.0.113.88","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null}],"ipv6":[{"id":58214,"address_pool_id":5,"server_id":4821,"user_id":null,"type":"ipv6","is_primary":false,"address":"2001:db8:4b2:18::1","cidr":64,"gateway":"2001:db8:4b2::1","mac_address":"52:54:00:3a:7c:91","onlink":"2001:db8:4b2::18","floating_ip_uuid":null}]},"mac_address":"52:54:00:3a:7c:91","effective_bandwidth":5497558138880,"bandwidth_blocks":0,"plan_bandwidth":5497558138880}],"properties":{"cpu":{"type":"integer","description":"The value of `cpu`.","examples":[4],"isRequired":true,"uniqueKey":"limits.cpu","typeLabel":"integer"},"memory":{"type":"integer","description":"Memory and disk are in bytes; their columns are kept in mebibytes.","examples":[4294967296],"isRequired":true,"uniqueKey":"limits.memory","typeLabel":"integer"},"disk":{"type":"integer","description":"The value of `disk`.","examples":[85899345920],"isRequired":true,"uniqueKey":"limits.disk","typeLabel":"integer"},"hdd_disk":{"oneOf":[{"type":"integer","description":"Secondary spinning disk, in bytes. Null on a server sold without one.","examples":[null],"isRequired":true,"uniqueKey":"limits.hdd_disk.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Secondary spinning disk, in bytes. Null on a server sold without one.","examples":[null],"isRequired":true,"uniqueKey":"limits.hdd_disk.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.hdd_disk","typeLabel":"integer | null"},"snapshots":{"oneOf":[{"type":"integer","description":"The value of `snapshots`.","examples":[2],"isRequired":true,"uniqueKey":"limits.snapshots.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The value of `snapshots`.","examples":[2],"isRequired":true,"uniqueKey":"limits.snapshots.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.snapshots","typeLabel":"integer | null"},"backups":{"oneOf":[{"type":"integer","description":"The value of `backups`.","examples":[2],"isRequired":true,"uniqueKey":"limits.backups.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The value of `backups`.","examples":[2],"isRequired":true,"uniqueKey":"limits.backups.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.backups","typeLabel":"integer | null"},"bandwidth":{"oneOf":[{"type":"integer","description":"The PLAN's own allowance, in bytes, not the ceiling in force. Null on an unmetered server.","examples":[5497558138880],"isRequired":true,"uniqueKey":"limits.bandwidth.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The PLAN's own allowance, in bytes, not the ceiling in force. Null on an unmetered server.","examples":[5497558138880],"isRequired":true,"uniqueKey":"limits.bandwidth.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.bandwidth","typeLabel":"integer | null"},"addresses":{"type":"object","description":"The value of `addresses`.","examples":[{"ipv4":[{"id":58213,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":true,"address":"203.0.113.24","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null},{"id":58391,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":false,"address":"203.0.113.88","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null}],"ipv6":[{"id":58214,"address_pool_id":5,"server_id":4821,"user_id":null,"type":"ipv6","is_primary":false,"address":"2001:db8:4b2:18::1","cidr":64,"gateway":"2001:db8:4b2::1","mac_address":"52:54:00:3a:7c:91","onlink":"2001:db8:4b2::18","floating_ip_uuid":null}]}],"properties":{"ipv4":{"type":"array","description":"The value of `ipv4`.","examples":[[{"id":58213,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":true,"address":"203.0.113.24","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null},{"id":58391,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":false,"address":"203.0.113.88","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null}]],"items":{"type":"object","description":"An IP address attached to a server.","examples":[{"id":58213,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":true,"address":"203.0.113.24","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null}],"properties":{"id":{"type":"integer","description":"The id ID.","examples":[58213],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].id","typeLabel":"integer"},"address_pool_id":{"type":"integer","description":"The address pool id ID.","examples":[4],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].address_pool_id","typeLabel":"integer"},"server_id":{"oneOf":[{"type":"integer","description":"The server id ID.","examples":[4821],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].server_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The server id ID.","examples":[4821],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].server_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].server_id","typeLabel":"integer | null"},"user_id":{"oneOf":[{"type":"integer","description":"The account holding this address out of its own allowance, or null when an administrator handed it out. On a customer payload a non-null value can only ever be the viewer's own account - an address reserved by somebody else cannot be attached to their server.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].user_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The account holding this address out of its own allowance, or null when an administrator handed it out. On a customer payload a non-null value can only ever be the viewer's own account - an address reserved by somebody else cannot be attached to their server.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].user_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].user_id","typeLabel":"integer | null"},"type":{"type":"string","description":"The type of operation or resource.","enum":["ipv4","ipv6"],"examples":["ipv4"],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"is_primary":{"type":"boolean","description":"Whether the resource is primary.","examples":[true],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].is_primary","typeLabel":"boolean"},"address":{"type":"string","description":"The IP address assigned to the resource.","examples":["203.0.113.24"],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].address","typeLabel":"string"},"cidr":{"type":"integer","description":"The network prefix length.","examples":[24],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].cidr","typeLabel":"integer"},"gateway":{"type":"string","description":"The gateway address for the network.","examples":["203.0.113.1"],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].gateway","typeLabel":"string"},"mac_address":{"oneOf":[{"type":"string","description":"The value of `mac_address`.","examples":["52:54:00:3a:7c:91"],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].mac_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `mac_address`.","examples":["52:54:00:3a:7c:91"],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].mac_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].mac_address","typeLabel":"string | null"},"onlink":{"oneOf":[{"type":"string","description":"The value of `onlink`.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].onlink.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `onlink`.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].onlink.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].onlink","typeLabel":"string | null"},"floating_ip_uuid":{"oneOf":[{"type":"string","description":"The floating address purchase holding this row, when there is one.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].floating_ip_uuid.oneOf.0","typeLabel":"string"},{"type":"null","description":"The floating address purchase holding this row, when there is one.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].floating_ip_uuid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.addresses.ipv4.items.[INDEX].floating_ip_uuid","typeLabel":"string | null"}},"required":["id","address_pool_id","server_id","user_id","type","is_primary","address","cidr","gateway","mac_address","onlink","floating_ip_uuid"],"title":"ServerAddressData","uniqueKey":"limits.addresses.ipv4.items.[INDEX]","typeLabel":"ServerAddressData · object"},"isRequired":true,"uniqueKey":"limits.addresses.ipv4","typeLabel":"ServerAddressData · object[]"},"ipv6":{"type":"array","description":"The value of `ipv6`.","examples":[[{"id":58214,"address_pool_id":5,"server_id":4821,"user_id":null,"type":"ipv6","is_primary":false,"address":"2001:db8:4b2:18::1","cidr":64,"gateway":"2001:db8:4b2::1","mac_address":"52:54:00:3a:7c:91","onlink":"2001:db8:4b2::18","floating_ip_uuid":null}]],"items":{"type":"object","description":"An IP address attached to a server.","examples":[{"id":58213,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":true,"address":"203.0.113.24","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null}],"properties":{"id":{"type":"integer","description":"The id ID.","examples":[58213],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].id","typeLabel":"integer"},"address_pool_id":{"type":"integer","description":"The address pool id ID.","examples":[4],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].address_pool_id","typeLabel":"integer"},"server_id":{"oneOf":[{"type":"integer","description":"The server id ID.","examples":[4821],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].server_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The server id ID.","examples":[4821],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].server_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].server_id","typeLabel":"integer | null"},"user_id":{"oneOf":[{"type":"integer","description":"The account holding this address out of its own allowance, or null when an administrator handed it out. On a customer payload a non-null value can only ever be the viewer's own account - an address reserved by somebody else cannot be attached to their server.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].user_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The account holding this address out of its own allowance, or null when an administrator handed it out. On a customer payload a non-null value can only ever be the viewer's own account - an address reserved by somebody else cannot be attached to their server.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].user_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].user_id","typeLabel":"integer | null"},"type":{"type":"string","description":"The type of operation or resource.","enum":["ipv4","ipv6"],"examples":["ipv4"],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"is_primary":{"type":"boolean","description":"Whether the resource is primary.","examples":[true],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].is_primary","typeLabel":"boolean"},"address":{"type":"string","description":"The IP address assigned to the resource.","examples":["203.0.113.24"],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].address","typeLabel":"string"},"cidr":{"type":"integer","description":"The network prefix length.","examples":[24],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].cidr","typeLabel":"integer"},"gateway":{"type":"string","description":"The gateway address for the network.","examples":["203.0.113.1"],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].gateway","typeLabel":"string"},"mac_address":{"oneOf":[{"type":"string","description":"The value of `mac_address`.","examples":["52:54:00:3a:7c:91"],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].mac_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `mac_address`.","examples":["52:54:00:3a:7c:91"],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].mac_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].mac_address","typeLabel":"string | null"},"onlink":{"oneOf":[{"type":"string","description":"The value of `onlink`.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].onlink.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `onlink`.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].onlink.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].onlink","typeLabel":"string | null"},"floating_ip_uuid":{"oneOf":[{"type":"string","description":"The floating address purchase holding this row, when there is one.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].floating_ip_uuid.oneOf.0","typeLabel":"string"},{"type":"null","description":"The floating address purchase holding this row, when there is one.","examples":[null],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].floating_ip_uuid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.addresses.ipv6.items.[INDEX].floating_ip_uuid","typeLabel":"string | null"}},"required":["id","address_pool_id","server_id","user_id","type","is_primary","address","cidr","gateway","mac_address","onlink","floating_ip_uuid"],"title":"ServerAddressData","uniqueKey":"limits.addresses.ipv6.items.[INDEX]","typeLabel":"ServerAddressData · object"},"isRequired":true,"uniqueKey":"limits.addresses.ipv6","typeLabel":"ServerAddressData · object[]"}},"required":["ipv4","ipv6"],"title":"ServerAddressesData","isRequired":true,"uniqueKey":"limits.addresses","typeLabel":"ServerAddressesData · object"},"mac_address":{"oneOf":[{"type":"string","description":"The value of `mac_address`.","examples":["52:54:00:3a:7c:91"],"isRequired":true,"uniqueKey":"limits.mac_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `mac_address`.","examples":["52:54:00:3a:7c:91"],"isRequired":true,"uniqueKey":"limits.mac_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.mac_address","typeLabel":"string | null"},"effective_bandwidth":{"oneOf":[{"type":"integer","description":"The transfer ceiling actually enforced: the plan's allowance plus whatever the customer has bought, or their share of the city's pool. Null when the server is unmetered.","examples":[5497558138880],"isRequired":true,"uniqueKey":"limits.effective_bandwidth.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The transfer ceiling actually enforced: the plan's allowance plus whatever the customer has bought, or their share of the city's pool. Null when the server is unmetered.","examples":[5497558138880],"isRequired":true,"uniqueKey":"limits.effective_bandwidth.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.effective_bandwidth","typeLabel":"integer | null"},"bandwidth_blocks":{"type":"integer","description":"Transfer granted on top of the plan, in bytes. Zero, never negative, for a pooled server whose share of the city has been eaten by a heavier neighbour.","examples":[0],"isRequired":true,"uniqueKey":"limits.bandwidth_blocks","typeLabel":"integer"},"plan_bandwidth":{"oneOf":[{"type":"integer","description":"The plan's allowance again, published beside the effective one so that neither has to be guessed from the other. A customer holding a block is not living on the figure their plan sold them, and the meter on the server says so in both numbers.","examples":[5497558138880],"isRequired":true,"uniqueKey":"limits.plan_bandwidth.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The plan's allowance again, published beside the effective one so that neither has to be guessed from the other. A customer holding a block is not living on the figure their plan sold them, and the meter on the server says so in both numbers.","examples":[5497558138880],"isRequired":true,"uniqueKey":"limits.plan_bandwidth.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"limits.plan_bandwidth","typeLabel":"integer | null"}},"required":["cpu","memory","disk","hdd_disk","snapshots","backups","bandwidth","addresses","mac_address","effective_bandwidth","bandwidth_blocks","plan_bandwidth"],"title":"ServerLimitsData","isRequired":true,"uniqueKey":"limits","typeLabel":"ServerLimitsData · object"},"internal_id":{"type":"integer","description":"The primary key. See the note on `id` above.","examples":[4821],"isRequired":true,"uniqueKey":"internal_id","typeLabel":"integer"},"restoration_progress":{"oneOf":[{"type":"integer","description":"The value of `restoration_progress`.","examples":[null],"isRequired":true,"uniqueKey":"restoration_progress.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The value of `restoration_progress`.","examples":[null],"isRequired":true,"uniqueKey":"restoration_progress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"restoration_progress","typeLabel":"integer | null"},"installation_progress":{"oneOf":[{"type":"integer","description":"The value of `installation_progress`.","examples":[null],"isRequired":true,"uniqueKey":"installation_progress.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The value of `installation_progress`.","examples":[null],"isRequired":true,"uniqueKey":"installation_progress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"installation_progress","typeLabel":"integer | null"},"install_failed_at":{"oneOf":[{"type":"string","description":"Set only while the last install or rebuild is still an unread failure: cleared by the next attempt, and by the customer dismissing the notice it draws.","examples":[null],"isRequired":true,"uniqueKey":"install_failed_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Set only while the last install or rebuild is still an unread failure: cleared by the next attempt, and by the customer dismissing the notice it draws.","examples":[null],"isRequired":true,"uniqueKey":"install_failed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"install_failed_at","typeLabel":"string | null"},"restore_failed_at":{"oneOf":[{"type":"string","description":"Set only while the last backup or snapshot restore is still an unread failure: cleared by the next restore or reinstall, and by the customer dismissing the notice it draws.","examples":[null],"isRequired":true,"uniqueKey":"restore_failed_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Set only while the last backup or snapshot restore is still an unread failure: cleared by the next restore or reinstall, and by the customer dismissing the notice it draws.","examples":[null],"isRequired":true,"uniqueKey":"restore_failed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"restore_failed_at","typeLabel":"string | null"},"cpu_throttle":{"oneOf":[{"type":"object","title":"ServerCpuThrottleData","description":"The value of `cpu_throttle`.","required":["cap_percent","average_cpu","threshold_percent","window_minutes","capped_at","release_at","manual"],"example":null,"properties":{"cap_percent":{"oneOf":[{"type":"integer","description":"The ceiling being enforced, as a percentage of one core.","examples":[33],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.cap_percent.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The ceiling being enforced, as a percentage of one core.","examples":[33],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.cap_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.cap_percent","typeLabel":"integer | null"},"average_cpu":{"oneOf":[{"type":"number","description":"What the server averaged over the window that earned it the cap.","examples":[91.7],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.average_cpu.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the server averaged over the window that earned it the cap.","examples":[91.7],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.average_cpu.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.average_cpu","typeLabel":"number | null"},"threshold_percent":{"type":"integer","description":"The installation's tunables rather than this server's: the figure the average was judged against, and the length of the window it was measured over. Carried so the banner can say why the cap happened without a second request for the settings row. A repeat cap was judged on the observation period rather than the full window.","examples":[80],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.threshold_percent","typeLabel":"integer"},"window_minutes":{"type":"integer","description":"The value of `window_minutes`.","examples":[60],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.window_minutes","typeLabel":"integer"},"capped_at":{"oneOf":[{"type":"string","description":"The date and time for capped at, in UTC.","examples":["2026-09-14T14:05:00+00:00"],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.capped_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date and time for capped at, in UTC.","examples":["2026-09-14T14:05:00+00:00"],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.capped_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.capped_at","typeLabel":"string | null"},"release_at":{"oneOf":[{"type":"string","description":"When the cap lifts on its own. Null on a cap set by hand.","examples":["2026-09-14T20:05:00+00:00"],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.release_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the cap lifts on its own. Null on a cap set by hand.","examples":["2026-09-14T20:05:00+00:00"],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.release_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.release_at","typeLabel":"string | null"},"manual":{"type":"boolean","description":"Whether an administrator applied this rather than the sweep.","examples":[false],"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0.manual","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.0","typeLabel":"ServerCpuThrottleData · object"},{"type":"null","description":"The value of `cpu_throttle`.","example":null,"isRequired":true,"uniqueKey":"cpu_throttle.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cpu_throttle","typeLabel":"ServerCpuThrottleData · object | null"},"bandwidth":{"oneOf":[{"type":"object","title":"ServerBandwidthData","description":"What the server's transfer really looks like once purchased blocks and pooling exist. Null, like `cpu_throttle` above it, whenever the plan's own allowance is the whole story.","required":["limit","plan_limit","block_bytes","shaped","pooled","pool"],"example":null,"properties":{"limit":{"type":"integer","description":"The ceiling in force, in bytes.","examples":[7696581394432],"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.limit","typeLabel":"integer"},"plan_limit":{"type":"integer","description":"The plan's own allowance, for the half of the meter it accounts for.","examples":[5497558138880],"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.plan_limit","typeLabel":"integer"},"block_bytes":{"type":"integer","description":"Everything this server has been granted beyond its own plan. In a pool that is not the same as what its owner bought: a quiet neighbour's unused share is lent out too, and the city's own purchased balance is reported on `pool` instead.","examples":[2199023255552],"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.block_bytes","typeLabel":"integer"},"shaped":{"type":"boolean","description":"Whether the server is being rate limited right now.","examples":[false],"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.shaped","typeLabel":"boolean"},"pooled":{"type":"boolean","description":"The value of `pooled`.","examples":[false],"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.pooled","typeLabel":"boolean"},"pool":{"oneOf":[{"type":"object","title":"ServerBandwidthPoolData","description":"Null when the server is not pooled, or its location is unknown.","required":["location","limit","usage","block_bytes","exhausted"],"example":null,"properties":{"location":{"type":"string","description":"The city display name, such as Nuremberg, DE.","examples":["Los Angeles, CA"],"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.pool.oneOf.0.location","typeLabel":"string"},"limit":{"type":"integer","description":"The sum of the member servers' own plan allowances.","examples":[10995116277760],"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.pool.oneOf.0.limit","typeLabel":"integer"},"usage":{"type":"integer","description":"What the members have accrued between them.","examples":[1340000000000],"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.pool.oneOf.0.usage","typeLabel":"integer"},"block_bytes":{"type":"integer","description":"What the team's blocks add to the pool on top of `limit`.","examples":[0],"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.pool.oneOf.0.block_bytes","typeLabel":"integer"},"exhausted":{"type":"boolean","description":"The whole city is shaped together the moment its shared budget runs out, which is what sharing one costs.","examples":[false],"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.pool.oneOf.0.exhausted","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.pool.oneOf.0","typeLabel":"ServerBandwidthPoolData · object"},{"type":"null","description":"Null when the server is not pooled, or its location is unknown.","example":null,"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.pool.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bandwidth.oneOf.0.pool","typeLabel":"ServerBandwidthPoolData · object | null"}},"isRequired":true,"uniqueKey":"bandwidth.oneOf.0","typeLabel":"ServerBandwidthData · object"},{"type":"null","description":"What the server's transfer really looks like once purchased blocks and pooling exist. Null, like `cpu_throttle` above it, whenever the plan's own allowance is the whole story.","example":null,"isRequired":true,"uniqueKey":"bandwidth.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bandwidth","typeLabel":"ServerBandwidthData · object | null"},"provisioning_scripts_supported":{"type":"boolean","description":"The value of `provisioning_scripts_supported`.","examples":[true],"isRequired":true,"uniqueKey":"provisioning_scripts_supported","typeLabel":"boolean"},"snapshots_supported":{"type":"boolean","description":"Whether snapshot storage is available in this server's location.","examples":[true],"isRequired":true,"uniqueKey":"snapshots_supported","typeLabel":"boolean"},"maintenance":{"oneOf":[{"type":"object","title":"ServerMaintenanceData","description":"Null unless maintenance that affects this server is planned or under way.","required":["uuid","type","scope","status","is_live","title","body","impact","impact_label","target","starts_at","ends_at","status_url"],"example":null,"properties":{"uuid":{"type":"string","description":"The uuid UUID.","examples":["e7f8cb40-a971-4c6c-8af8-8f6066bb253e"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.uuid","typeLabel":"string"},"type":{"type":"string","description":"A planned window, or unplanned disruption.","enum":["maintenance","incident"],"examples":["maintenance"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.type","typeLabel":"enum\u003cstring>"},"scope":{"type":"string","description":"Whether this covers the host the server runs on (`node`) or a whole city (`location`).","enum":["location","node"],"examples":["node"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.scope","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"The value of `status`.","enum":["scheduled","in_progress","identified","monitoring","completed","cancelled"],"examples":["scheduled"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.status","typeLabel":"enum\u003cstring>"},"is_live":{"type":"boolean","description":"Whether it is happening now rather than scheduled or finished.","examples":[false],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.is_live","typeLabel":"boolean"},"title":{"type":"string","description":"The value of `title`.","examples":["Host kernel update"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.title","typeLabel":"string"},"body":{"oneOf":[{"type":"string","description":"The message body.","examples":["The host is moving to a new kernel. Servers on it are moved to another host in Kansas City first, with a pause of a few seconds."],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.body.oneOf.0","typeLabel":"string"},{"type":"null","description":"The message body.","examples":["The host is moving to a new kernel. Servers on it are moved to another host in Kansas City first, with a pause of a few seconds."],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.body.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.body","typeLabel":"string | null"},"impact":{"type":"string","description":"How severely the maintenance affects the component, with a readable label.","enum":["OPERATIONAL","UNDERMAINTENANCE","DEGRADEDPERFORMANCE","PARTIALOUTAGE","MAJOROUTAGE"],"examples":["UNDERMAINTENANCE"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.impact","typeLabel":"enum\u003cstring>"},"impact_label":{"type":"string","description":"The value of `impact_label`.","examples":["Under maintenance"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.impact_label","typeLabel":"string"},"target":{"oneOf":[{"type":"string","description":"The city the event covers, or null when it covers the host the server runs on rather than the whole city.","examples":[null],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.target.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city the event covers, or null when it covers the host the server runs on rather than the whole city.","examples":[null],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.target.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.target","typeLabel":"string | null"},"starts_at":{"oneOf":[{"type":"string","description":"The date and time for starts at, in UTC.","examples":["2026-09-17T06:00:00+00:00"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.starts_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date and time for starts at, in UTC.","examples":["2026-09-17T06:00:00+00:00"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.starts_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.starts_at","typeLabel":"string | null"},"ends_at":{"oneOf":[{"type":"string","description":"The date and time for ends at, in UTC.","examples":["2026-09-17T08:00:00+00:00"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.ends_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date and time for ends at, in UTC.","examples":["2026-09-17T08:00:00+00:00"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.ends_at","typeLabel":"string | null"},"status_url":{"oneOf":[{"type":"string","description":"Where the event is published on the public status page, if it is.","examples":["https://status.example.com/cmf2x7k0q0001ab12cd34ef56"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.status_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Where the event is published on the public status page, if it is.","examples":["https://status.example.com/cmf2x7k0q0001ab12cd34ef56"],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.status_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance.oneOf.0.status_url","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"maintenance.oneOf.0","typeLabel":"ServerMaintenanceData · object"},{"type":"null","description":"Null unless maintenance that affects this server is planned or under way.","example":null,"isRequired":true,"uniqueKey":"maintenance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance","typeLabel":"ServerMaintenanceData · object | null"},"maintenance_events":{"type":"array","description":"Every maintenance or incident that affects this server, most pressing first. `maintenance` is the first of these.","examples":[[]],"items":{"type":"object","description":"Maintenance or an incident that affects a server.","examples":[{"uuid":"e7f8cb40-a971-4c6c-8af8-8f6066bb253e","type":"maintenance","scope":"node","status":"scheduled","is_live":false,"title":"Host kernel update","body":"The host is moving to a new kernel. Servers on it are moved to another host in Kansas City first, with a pause of a few seconds.","impact":"UNDERMAINTENANCE","impact_label":"Under maintenance","target":null,"starts_at":"2026-09-17T06:00:00+00:00","ends_at":"2026-09-17T08:00:00+00:00","status_url":"https://status.example.com/cmf2x7k0q0001ab12cd34ef56"}],"properties":{"uuid":{"type":"string","description":"The uuid UUID.","examples":["e7f8cb40-a971-4c6c-8af8-8f6066bb253e"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].uuid","typeLabel":"string"},"type":{"type":"string","description":"A planned window, or unplanned disruption.","enum":["maintenance","incident"],"examples":["maintenance"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"scope":{"type":"string","description":"Whether this covers the host the server runs on (`node`) or a whole city (`location`).","enum":["location","node"],"examples":["node"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].scope","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"The value of `status`.","enum":["scheduled","in_progress","identified","monitoring","completed","cancelled"],"examples":["scheduled"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"is_live":{"type":"boolean","description":"Whether it is happening now rather than scheduled or finished.","examples":[false],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].is_live","typeLabel":"boolean"},"title":{"type":"string","description":"The value of `title`.","examples":["Host kernel update"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].title","typeLabel":"string"},"body":{"oneOf":[{"type":"string","description":"The message body.","examples":["The host is moving to a new kernel. Servers on it are moved to another host in Kansas City first, with a pause of a few seconds."],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].body.oneOf.0","typeLabel":"string"},{"type":"null","description":"The message body.","examples":["The host is moving to a new kernel. Servers on it are moved to another host in Kansas City first, with a pause of a few seconds."],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].body.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].body","typeLabel":"string | null"},"impact":{"type":"string","description":"How severely the maintenance affects the component, with a readable label.","enum":["OPERATIONAL","UNDERMAINTENANCE","DEGRADEDPERFORMANCE","PARTIALOUTAGE","MAJOROUTAGE"],"examples":["UNDERMAINTENANCE"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].impact","typeLabel":"enum\u003cstring>"},"impact_label":{"type":"string","description":"The value of `impact_label`.","examples":["Under maintenance"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].impact_label","typeLabel":"string"},"target":{"oneOf":[{"type":"string","description":"The city the event covers, or null when it covers the host the server runs on rather than the whole city.","examples":[null],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].target.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city the event covers, or null when it covers the host the server runs on rather than the whole city.","examples":[null],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].target.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].target","typeLabel":"string | null"},"starts_at":{"oneOf":[{"type":"string","description":"The date and time for starts at, in UTC.","examples":["2026-09-17T06:00:00+00:00"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].starts_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date and time for starts at, in UTC.","examples":["2026-09-17T06:00:00+00:00"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].starts_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].starts_at","typeLabel":"string | null"},"ends_at":{"oneOf":[{"type":"string","description":"The date and time for ends at, in UTC.","examples":["2026-09-17T08:00:00+00:00"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].ends_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date and time for ends at, in UTC.","examples":["2026-09-17T08:00:00+00:00"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].ends_at","typeLabel":"string | null"},"status_url":{"oneOf":[{"type":"string","description":"Where the event is published on the public status page, if it is.","examples":["https://status.example.com/cmf2x7k0q0001ab12cd34ef56"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].status_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Where the event is published on the public status page, if it is.","examples":["https://status.example.com/cmf2x7k0q0001ab12cd34ef56"],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].status_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maintenance_events.items.[INDEX].status_url","typeLabel":"string | null"}},"required":["uuid","type","scope","status","is_live","title","body","impact","impact_label","target","starts_at","ends_at","status_url"],"title":"ServerMaintenanceData","uniqueKey":"maintenance_events.items.[INDEX]","typeLabel":"ServerMaintenanceData · object"},"isRequired":true,"uniqueKey":"maintenance_events","typeLabel":"ServerMaintenanceData · object[]"},"location":{"type":"string","description":"The city the server stands in, e.g. \"Nuremberg, DE\". A location is a city now; `displayName()` also reads back the older codes that carried the product alongside it in brackets.","examples":["Kansas City, MO"],"isRequired":true,"uniqueKey":"location","typeLabel":"string"},"product_group_name":{"oneOf":[{"type":"string","description":"The product the server was sold as, such as `Standard VPS`, or null when no product is linked.","examples":["Standard VPS"],"isRequired":true,"uniqueKey":"product_group_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The product the server was sold as, such as `Standard VPS`, or null when no product is linked.","examples":["Standard VPS"],"isRequired":true,"uniqueKey":"product_group_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"product_group_name","typeLabel":"string | null"},"user":{"type":"object","description":"The account the server belongs to, present only when a caller asked for it by name.","examples":[{"name":"Gordon Freeman","email":"gordon.freeman@blackmesa.example.com"}],"properties":{"name":{"type":"string","description":"The name shown to customers.","examples":["Gordon Freeman"],"isRequired":true,"uniqueKey":"user.name","typeLabel":"string"},"email":{"type":"string","description":"The email address.","examples":["gordon.freeman@blackmesa.example.com"],"isRequired":true,"uniqueKey":"user.email","typeLabel":"string"}},"required":["name","email"],"title":"AccountOwnerData","uniqueKey":"user","typeLabel":"AccountOwnerData · object"}},"uniqueKey":"","typeLabel":"ServerData · object"},"examples":{"Example":{"title":"Example","value":{"id":"ecc6f4f1","uuid":"ecc6f4f1-c89b-4dce-a20b-a330641c5b0b","hostname":"lambda-core.blackmesa.example.com","name":"lambda-core","description":"Lambda Complex test chamber telemetry","status":null,"suspension_reason":null,"power_state":"running","windows":false,"template_name":"Ubuntu 24.04","template_icon_url":"https://img.icons8.com/color/48/ubuntu.png","custom_icon_url":null,"default_icon_url":"https://img.icons8.com/color/48/ubuntu.png","created_at":"2026-03-02T19:14:36.000000Z","usages":{"bandwidth":500000000000,"actual_bandwidth":500000000000,"rx":200000000000,"tx":300000000000},"limits":{"cpu":4,"memory":4294967296,"disk":85899345920,"hdd_disk":null,"snapshots":2,"backups":2,"bandwidth":5497558138880,"addresses":{"ipv4":[{"id":58213,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":true,"address":"203.0.113.24","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null},{"id":58391,"address_pool_id":4,"server_id":4821,"user_id":null,"type":"ipv4","is_primary":false,"address":"203.0.113.88","cidr":24,"gateway":"203.0.113.1","mac_address":"52:54:00:3a:7c:91","onlink":null,"floating_ip_uuid":null}],"ipv6":[{"id":58214,"address_pool_id":5,"server_id":4821,"user_id":null,"type":"ipv6","is_primary":false,"address":"2001:db8:4b2:18::1","cidr":64,"gateway":"2001:db8:4b2::1","mac_address":"52:54:00:3a:7c:91","onlink":"2001:db8:4b2::18","floating_ip_uuid":null}]},"mac_address":"52:54:00:3a:7c:91","effective_bandwidth":5497558138880,"bandwidth_blocks":0,"plan_bandwidth":5497558138880},"internal_id":4821,"restoration_progress":null,"installation_progress":null,"install_failed_at":null,"restore_failed_at":null,"cpu_throttle":null,"bandwidth":null,"provisioning_scripts_supported":true,"snapshots_supported":true,"maintenance":null,"maintenance_events":[],"location":"Kansas City, MO","product_group_name":"Standard VPS"}}},"exampleType":"generated"}},"exampleType":"generated"},"f2f2c19e-393c-4a0b-a554-41ad9c276c59":{"description":"The key was missing, malformed, revoked, or belongs to an account that no longer exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","examples":["Unauthenticated."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthenticated."}}},"exampleType":"generated"}},"exampleType":"generated"},"59b47677-242d-4960-bea1-7509b4188ccf":{"description":"Access denied. Check the key's team, permissions and allowed IP addresses. Some actions, such as managing API keys, require a browser session. The response message explains the reason.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","examples":["This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."}}},"exampleType":"generated"}},"exampleType":"generated"},"6c42e822-5620-4961-ae67-0d5a74254ba8":{"description":"The resource was not found in the selected team. Resources in another account or team also return 404.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","examples":["Not found."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Not found."}}},"exampleType":"generated"}},"exampleType":"generated"},"809cd40e-c422-4f5c-99bf-7a345ad56176":{"description":"Too many requests. The `Retry-After` header says how many seconds to wait. Limits are per account, so several keys on one account share them.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","examples":["Too Many Attempts."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Too Many Attempts."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f8b33b37-6c4c-4349-ac95-09bac911f9ea":{"http":{"type":"http","description":"Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.","scheme":"bearer","scopes":[],"schemeName":"http"}}},"servers":{"49ace053-d2ae-45c8-8b5e-9b487eb81f6a":{"url":"https://console.advinservers.com/api/v1/client"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.","scheme":"bearer","scopes":[],"schemeName":"http"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"http","name":"Authorization"}],"title":"http"}]},"originalFileLocation":"https://console.advinservers.com/docs/openapi.json"},"subdomain":"advinservers","siteName":"Advin Servers","title":"Get a server - Advin Servers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T09:08:18.555Z","originalFileLocation":"api-reference/servers/get-a-server.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"### Overview Returns a server\u0026#x27;s name, plan, usage, limits, location and last known power state. These saved details may be a few seconds old. Add ?include=user to include the account that owns it. ### Permissions Requires the server.read (View servers) permission for the selected team. Resources outside that team return 404.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Advin Servers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a server - Advin Servers\">\u003cmeta data-mint-head property=\"og:description\" content=\"### Overview Returns a server\u0026#x27;s name, plan, usage, limits, location and last known power state. These saved details may be a few seconds old. Add ?include=user to include the account that owns it. ### Permissions Requires the server.read (View servers) permission for the selected team. Resources outside that team return 404.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Advin Servers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.advinservers.com/api-reference/servers/get-a-server\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://advinservers.mintlify.site/_mintlify/api/og/v2?division=Servers\u0026amp;title=Get+a+server\u0026amp;description=%23%23%23+Overview%0A%0AReturns+a+server%27s+name%2C+plan%2C+usage%2C+limits%2C+location+and+last+known+power+state.+These+saved+details+may+be+a+few+seconds+old.+Add+%60%3Finclude%3Duse\u0026amp;theme=d60cb8f636d682ed22c76013\u0026amp;signature=039e46b0c4a1824d4d9764c16fe679ca1b4f78ec93368400f2bf1d7bd3e953db\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a server - Advin Servers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"### Overview Returns a server\u0026#x27;s name, plan, usage, limits, location and last known power state. These saved details may be a few seconds old. Add ?include=user to include the account that owns it. ### Permissions Requires the server.read (View servers) permission for the selected team. Resources outside that team return 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://advinservers.mintlify.site/_mintlify/api/og/v2?division=Servers\u0026amp;title=Get+a+server\u0026amp;description=%23%23%23+Overview%0A%0AReturns+a+server%27s+name%2C+plan%2C+usage%2C+limits%2C+location+and+last+known+power+state.+These+saved+details+may+be+a+few+seconds+old.+Add+%60%3Finclude%3Duse\u0026amp;theme=d60cb8f636d682ed22c76013\u0026amp;signature=039e46b0c4a1824d4d9764c16fe679ca1b4f78ec93368400f2bf1d7bd3e953db\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Advin Servers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#232323\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.advinservers.com/api-reference/servers/get-a-server\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/servers/get-a-server.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.advinservers.com/#organization\",\"name\":\"Advin Servers\",\"url\":\"https://docs.advinservers.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/advinservers/hsoR78mplm26jwSe/logo/light.svg?fit=max\u0026auto=format\u0026n=hsoR78mplm26jwSe\u0026q=85\u0026s=5adfd787faa2746d42842a3dbe9d5c55\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.advinservers.com#website\",\"name\":\"Advin Servers\",\"url\":\"https://docs.advinservers.com\",\"publisher\":{\"@id\":\"https://docs.advinservers.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.advinservers.com/api-reference/servers/get-a-server#webpage\",\"url\":\"https://docs.advinservers.com/api-reference/servers/get-a-server\",\"name\":\"Get a server\",\"description\":\"### Overview Returns a server's name, plan, usage, limits, location and last known power state. These saved details may be a few seconds old. Add ?include=user to include the account that owns it. ### Permissions Requires the server.read (View servers) permission for the selected team. Resources outside that team return 404.\",\"dateModified\":\"2026-11-10T09:08:18.555Z\",\"isPartOf\":{\"@id\":\"https://docs.advinservers.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.advinservers.com/api-reference/servers/get-a-server#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.advinservers.com/api-reference/servers/get-a-server#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.advinservers.com/api-reference/account/get-account-details\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Servers\",\"item\":\"https://docs.advinservers.com/api-reference/servers/list-servers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a server\",\"item\":\"https://docs.advinservers.com/api-reference/servers/get-a-server\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.advinservers.com/api-reference/servers/get-a-server#apireference\",\"headline\":\"Get a server\",\"name\":\"Get a server\",\"description\":\"### Overview Returns a server's name, plan, usage, limits, location and last known power state. These saved details may be a few seconds old. Add ?include=user to include the account that owns it. ### Permissions Requires the server.read (View servers) permission for the selected team. Resources outside that team return 404.\",\"url\":\"https://docs.advinservers.com/api-reference/servers/get-a-server\",\"mainEntityOfPage\":{\"@id\":\"https://docs.advinservers.com/api-reference/servers/get-a-server#webpage\"},\"dateModified\":\"2026-11-10T09:08:18.555Z\",\"publisher\":{\"@id\":\"https://docs.advinservers.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.advinservers.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Advin Servers\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Advin Servers\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/servers/get-a-server.md","siteName":"Advin Servers","nav":{"global":{"anchors":[{"anchor":"Console","icon":"terminal","href":"https://console.advinservers.com"},{"anchor":"Network Status","icon":"signal-bars","href":"https://status.advinservers.com"}]},"tabs":[{"tab":"General","icon":"book-open","pages":[{"title":"General","href":"/introduction"}]},{"tab":"Console","icon":"terminal","pages":[{"title":"Console","href":"/guides/controlpanel"}]},{"tab":"Policies","icon":"scale-balanced","pages":[{"title":"Policies","href":"/policies/fair-use"}]},{"tab":"API","icon":"code","groups":[{"group":"Getting Started","pages":[{"title":"API Introduction","sidebarTitle":"Introduction","icon":"code","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Account","pages":[{"title":"Get account details","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /account","href":"/api-reference/account/get-account-details"},{"title":"Update account details","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /account","href":"/api-reference/account/update-account-details"},{"title":"Check account setup progress","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /account/setup","href":"/api-reference/account/check-account-setup-progress"},{"title":"Accept the terms of service","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /account/setup/terms","href":"/api-reference/account/accept-the-terms-of-service"}]},{"group":"Account activity","pages":[{"title":"List account activity","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /audit-logs","href":"/api-reference/account-activity/list-account-activity"}]},{"group":"Backups","pages":[{"title":"List a server's backups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/backups","href":"/api-reference/backups/list-a-servers-backups"},{"title":"Restore a backup","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/backups/{backup}/restore","href":"/api-reference/backups/restore-a-backup"},{"title":"Delete a backup","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/backups/{backup}","href":"/api-reference/backups/delete-a-backup"},{"title":"Delete multiple backups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/backups/bulk/delete","href":"/api-reference/backups/delete-multiple-backups"},{"title":"Get the nightly backup setting","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/backups/schedule","href":"/api-reference/backups/get-the-nightly-backup-setting"},{"title":"Enable or disable nightly backups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/backups/schedule","href":"/api-reference/backups/enable-or-disable-nightly-backups"}]},{"group":"Bandwidth","pages":[{"title":"List bandwidth blocks","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks","href":"/api-reference/bandwidth/list-bandwidth-blocks"},{"title":"Buy a bandwidth block","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks","href":"/api-reference/bandwidth/buy-a-bandwidth-block"},{"title":"Get bandwidth prices","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/catalog","href":"/api-reference/bandwidth/get-bandwidth-prices"},{"title":"List bandwidth usage by location","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/pools","href":"/api-reference/bandwidth/list-bandwidth-usage-by-location"},{"title":"List locations for bandwidth pools","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/locations","href":"/api-reference/bandwidth/list-locations-for-bandwidth-pools"},{"title":"Enable or disable bandwidth pooling for a location","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /bandwidth-blocks/pooling","href":"/api-reference/bandwidth/enable-or-disable-bandwidth-pooling-for-a-location"},{"title":"Preview a bandwidth pooling change","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/pooling/preview","href":"/api-reference/bandwidth/preview-a-bandwidth-pooling-change"},{"title":"Get a quote for a bandwidth block","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/quote","href":"/api-reference/bandwidth/get-a-quote-for-a-bandwidth-block"},{"title":"List servers a bandwidth block can be assigned to","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/{bandwidthBlock}/servers","href":"/api-reference/bandwidth/list-servers-a-bandwidth-block-can-be-assigned-to"},{"title":"List bandwidth block usage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/{bandwidthBlock}/draws","href":"/api-reference/bandwidth/list-bandwidth-block-usage"},{"title":"Assign a bandwidth block to a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/{bandwidthBlock}/attach","href":"/api-reference/bandwidth/assign-a-bandwidth-block-to-a-server"},{"title":"Remove a bandwidth block from a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/{bandwidthBlock}/detach","href":"/api-reference/bandwidth/remove-a-bandwidth-block-from-a-server"},{"title":"Assign a bandwidth block to a location pool","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/{bandwidthBlock}/bind","href":"/api-reference/bandwidth/assign-a-bandwidth-block-to-a-location-pool"},{"title":"Remove a bandwidth block from a location pool","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/{bandwidthBlock}/unbind","href":"/api-reference/bandwidth/remove-a-bandwidth-block-from-a-location-pool"},{"title":"Cancel an unpaid bandwidth block","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/{bandwidthBlock}/cancel","href":"/api-reference/bandwidth/cancel-an-unpaid-bandwidth-block"}]},{"group":"Billing","pages":[{"title":"List service billing details","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/services","href":"/api-reference/billing/list-service-billing-details"},{"title":"List services with payment settings","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/managed-services","href":"/api-reference/billing/list-services-with-payment-settings"},{"title":"Get a service","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/managed-services/{service}","href":"/api-reference/billing/get-a-service"},{"title":"Set up automatic payment for a service","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /billing/managed-services/{service}/subscription","href":"/api-reference/billing/set-up-automatic-payment-for-a-service"},{"title":"Stop a service's automatic payment","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /billing/managed-services/{service}/subscription","href":"/api-reference/billing/stop-a-services-automatic-payment"},{"title":"List billing cycle prices","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/managed-services/{service}/billing-cycle","href":"/api-reference/billing/list-billing-cycle-prices"},{"title":"Change a service's billing cycle","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /billing/managed-services/{service}/billing-cycle","href":"/api-reference/billing/change-a-services-billing-cycle"},{"title":"Enable or disable account credit for a service","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /billing/managed-services/{service}/account-credit","href":"/api-reference/billing/enable-or-disable-account-credit-for-a-service"},{"title":"Cancel a service","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /billing/managed-services/{service}/cancel","href":"/api-reference/billing/cancel-a-service"},{"title":"Withdraw a service cancellation","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /billing/managed-services/{service}/cancel","href":"/api-reference/billing/withdraw-a-service-cancellation"},{"title":"List automatic payments","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/subscriptions","href":"/api-reference/billing/list-automatic-payments"},{"title":"Cancel an automatic payment","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /billing/subscriptions/{subscription}/cancel","href":"/api-reference/billing/cancel-an-automatic-payment"},{"title":"Get the display currency","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/currency","href":"/api-reference/billing/get-the-display-currency"},{"title":"Get account credit","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/credit","href":"/api-reference/billing/get-account-credit"},{"title":"List top-ups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/deposits","href":"/api-reference/billing/list-top-ups"},{"title":"Add funds to the account","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /billing/deposits","href":"/api-reference/billing/add-funds-to-the-account"},{"title":"Cancel a top-up","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /billing/deposits/{fundDeposit}/cancel","href":"/api-reference/billing/cancel-a-top-up"},{"title":"List saved PayPal accounts","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/paypal-accounts","href":"/api-reference/billing/list-saved-paypal-accounts"},{"title":"Remove a saved PayPal account","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /billing/paypal-accounts/{paypalAccount}","href":"/api-reference/billing/remove-a-saved-paypal-account"},{"title":"List saved payment methods","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/payment-methods","href":"/api-reference/billing/list-saved-payment-methods"},{"title":"Delete a saved payment method","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /billing/payment-methods/{payMethod}","href":"/api-reference/billing/delete-a-saved-payment-method"}]},{"group":"Checkout","pages":[{"title":"List payment options","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /checkout/options","href":"/api-reference/checkout/list-payment-options"},{"title":"Get a checkout","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /checkout/{uuid}","href":"/api-reference/checkout/get-a-checkout"},{"title":"Start a checkout payment","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /checkout/{uuid}/start","href":"/api-reference/checkout/start-a-checkout-payment"},{"title":"Cancel a checkout","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /checkout/{uuid}/cancel","href":"/api-reference/checkout/cancel-a-checkout"}]},{"group":"DDoS protection","pages":[{"title":"Get a server's DDoS protection","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection","href":"/api-reference/ddos-protection/get-a-servers-ddos-protection"},{"title":"List DDoS filtering presets","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection/presets","href":"/api-reference/ddos-protection/list-ddos-filtering-presets"},{"title":"List DDoS filtering presets for an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection/ip/{ip}/presets","href":"/api-reference/ddos-protection/list-ddos-filtering-presets-for-an-ip-address"},{"title":"Get DDoS filtering settings for an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection/ip/{ip}/settings","href":"/api-reference/ddos-protection/get-ddos-filtering-settings-for-an-ip-address"},{"title":"Update DDoS filtering settings for an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/ddos-protection/ip/{ip}/settings","href":"/api-reference/ddos-protection/update-ddos-filtering-settings-for-an-ip-address"},{"title":"List DDoS filtering rules for an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection/ip/{ip}/profiles","href":"/api-reference/ddos-protection/list-ddos-filtering-rules-for-an-ip-address"},{"title":"Add a DDoS filtering rule to an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/ddos-protection/ip/{ip}/profiles","href":"/api-reference/ddos-protection/add-a-ddos-filtering-rule-to-an-ip-address"},{"title":"Delete a DDoS filtering rule from an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/ddos-protection/ip/{ip}/profiles/{profileId}","href":"/api-reference/ddos-protection/delete-a-ddos-filtering-rule-from-an-ip-address"},{"title":"List DDoS attacks on an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection/ip/{ip}/attacks","href":"/api-reference/ddos-protection/list-ddos-attacks-on-an-ip-address"},{"title":"Reset DDoS filtering for an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/ddos-protection/ip/{ip}/reset","href":"/api-reference/ddos-protection/reset-ddos-filtering-for-an-ip-address"}]},{"group":"Firewall groups","pages":[{"title":"List firewall groups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /firewall-groups","href":"/api-reference/firewall-groups/list-firewall-groups"},{"title":"Create a firewall group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /firewall-groups","href":"/api-reference/firewall-groups/create-a-firewall-group"},{"title":"Get a firewall group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /firewall-groups/{firewallGroup}","href":"/api-reference/firewall-groups/get-a-firewall-group"},{"title":"Delete a firewall group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /firewall-groups/{firewallGroup}","href":"/api-reference/firewall-groups/delete-a-firewall-group"},{"title":"Rename a firewall group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /firewall-groups/{firewallGroup}","href":"/api-reference/firewall-groups/rename-a-firewall-group"},{"title":"Set a firewall group's servers","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /firewall-groups/{firewallGroup}/servers","href":"/api-reference/firewall-groups/set-a-firewall-groups-servers"},{"title":"Reorder firewall rules","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /firewall-groups/{firewallGroup}/rules/reorder","href":"/api-reference/firewall-groups/reorder-firewall-rules"},{"title":"Add a firewall rule","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /firewall-groups/{firewallGroup}/rules","href":"/api-reference/firewall-groups/add-a-firewall-rule"},{"title":"Delete a firewall rule","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /firewall-groups/{firewallGroup}/rules/{rule}","href":"/api-reference/firewall-groups/delete-a-firewall-rule"},{"title":"Update a firewall rule","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /firewall-groups/{firewallGroup}/rules/{rule}","href":"/api-reference/firewall-groups/update-a-firewall-rule"},{"title":"List firewall groups for a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/firewall-groups","href":"/api-reference/firewall-groups/list-firewall-groups-for-a-server"},{"title":"Create a firewall group for a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/firewall-groups","href":"/api-reference/firewall-groups/create-a-firewall-group-for-a-server"},{"title":"Reorder a server's firewall groups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/firewall-groups/reorder","href":"/api-reference/firewall-groups/reorder-a-servers-firewall-groups"},{"title":"Apply a firewall group to a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/firewall-groups/{firewallGroup}/attach","href":"/api-reference/firewall-groups/apply-a-firewall-group-to-a-server"},{"title":"Remove a firewall group from a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/firewall-groups/{firewallGroup}/detach","href":"/api-reference/firewall-groups/remove-a-firewall-group-from-a-server"}]},{"group":"IP addresses","pages":[{"title":"List floating IPs","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /floating-ips","href":"/api-reference/ip-addresses/list-floating-ips"},{"title":"Buy a floating IP","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips","href":"/api-reference/ip-addresses/buy-a-floating-ip"},{"title":"List locations for floating IPs","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /floating-ips/locations","href":"/api-reference/ip-addresses/list-locations-for-floating-ips"},{"title":"Get a quote for a floating IP","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/quote","href":"/api-reference/ip-addresses/get-a-quote-for-a-floating-ip"},{"title":"List servers a floating IP can attach to","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /floating-ips/{floatingIp}/servers","href":"/api-reference/ip-addresses/list-servers-a-floating-ip-can-attach-to"},{"title":"Attach a floating IP to a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/attach","href":"/api-reference/ip-addresses/attach-a-floating-ip-to-a-server"},{"title":"Detach a floating IP from a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/detach","href":"/api-reference/ip-addresses/detach-a-floating-ip-from-a-server"},{"title":"Swap a floating IP with the primary address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/swap-primary","href":"/api-reference/ip-addresses/swap-a-floating-ip-with-the-primary-address"},{"title":"Cancel an unpaid floating IP order","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/cancel-checkout","href":"/api-reference/ip-addresses/cancel-an-unpaid-floating-ip-order"},{"title":"Cancel a floating IP","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/cancel","href":"/api-reference/ip-addresses/cancel-a-floating-ip"},{"title":"Withdraw a floating IP cancellation","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/withdraw-cancellation","href":"/api-reference/ip-addresses/withdraw-a-floating-ip-cancellation"},{"title":"Release a floating IP","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /floating-ips/{floatingIp}","href":"/api-reference/ip-addresses/release-a-floating-ip"},{"title":"Set a server's primary IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/addresses/{addressId}/primary","href":"/api-reference/ip-addresses/set-a-servers-primary-ip-address"}]},{"group":"IP groups","pages":[{"title":"List IP groups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /ip-groups","href":"/api-reference/ip-groups/list-ip-groups"},{"title":"Create an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /ip-groups","href":"/api-reference/ip-groups/create-an-ip-group"},{"title":"Get an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /ip-groups/{firewallIpGroup}","href":"/api-reference/ip-groups/get-an-ip-group"},{"title":"Delete an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /ip-groups/{firewallIpGroup}","href":"/api-reference/ip-groups/delete-an-ip-group"},{"title":"Rename an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /ip-groups/{firewallIpGroup}","href":"/api-reference/ip-groups/rename-an-ip-group"},{"title":"Add addresses to an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /ip-groups/{firewallIpGroup}/entries","href":"/api-reference/ip-groups/add-addresses-to-an-ip-group"},{"title":"Remove an address from an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /ip-groups/{firewallIpGroup}/entries/{entry}","href":"/api-reference/ip-groups/remove-an-address-from-an-ip-group"},{"title":"Update an address in an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /ip-groups/{firewallIpGroup}/entries/{entry}","href":"/api-reference/ip-groups/update-an-address-in-an-ip-group"}]},{"group":"ISO images","pages":[{"title":"List ISOs","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /isos","href":"/api-reference/iso-images/list-isos"},{"title":"Download an ISO","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /isos","href":"/api-reference/iso-images/download-an-iso"},{"title":"Check an ISO download link","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /isos/query-link","href":"/api-reference/iso-images/check-an-iso-download-link"},{"title":"Delete an ISO","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /isos/{iso}","href":"/api-reference/iso-images/delete-an-iso"},{"title":"Rename an ISO","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /isos/{iso}","href":"/api-reference/iso-images/rename-an-iso"},{"title":"List ISOs available to a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/isos","href":"/api-reference/iso-images/list-isos-available-to-a-server"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /invoices/{invoice}","href":"/api-reference/invoices/get-an-invoice"},{"title":"Download an invoice PDF","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /invoices/{invoice}/pdf","href":"/api-reference/invoices/download-an-invoice-pdf"},{"title":"Create a checkout for an invoice","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /invoices/{invoice}/pay","href":"/api-reference/invoices/create-a-checkout-for-an-invoice"},{"title":"List invoices that can be paid together","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /invoices/bulk-payment","href":"/api-reference/invoices/list-invoices-that-can-be-paid-together"},{"title":"Create a checkout for several invoices","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /invoices/bulk-payment","href":"/api-reference/invoices/create-a-checkout-for-several-invoices"}]},{"group":"Private networks","pages":[{"title":"List private networks","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /private-networks","href":"/api-reference/private-networks/list-private-networks"},{"title":"Create a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /private-networks","href":"/api-reference/private-networks/create-a-private-network"},{"title":"List locations for private networks","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /private-networks/locations","href":"/api-reference/private-networks/list-locations-for-private-networks"},{"title":"Get a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /private-networks/{privateNetwork}","href":"/api-reference/private-networks/get-a-private-network"},{"title":"Delete a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /private-networks/{privateNetwork}","href":"/api-reference/private-networks/delete-a-private-network"},{"title":"Rename a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /private-networks/{privateNetwork}","href":"/api-reference/private-networks/rename-a-private-network"},{"title":"List servers that can join a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /private-networks/{privateNetwork}/eligible-servers","href":"/api-reference/private-networks/list-servers-that-can-join-a-private-network"},{"title":"List a server's private networks","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/private-networks","href":"/api-reference/private-networks/list-a-servers-private-networks"},{"title":"Create a private network in a server's location","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/private-networks","href":"/api-reference/private-networks/create-a-private-network-in-a-servers-location"},{"title":"Attach a server to a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/private-networks/{privateNetwork}/attach","href":"/api-reference/private-networks/attach-a-server-to-a-private-network"},{"title":"Detach a server from a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/private-networks/{privateNetwork}/detach","href":"/api-reference/private-networks/detach-a-server-from-a-private-network"},{"title":"Delete a server's private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/private-networks/{privateNetwork}","href":"/api-reference/private-networks/delete-a-servers-private-network"}]},{"group":"Reverse DNS","pages":[{"title":"List a server's reverse DNS addresses","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/rdns","href":"/api-reference/reverse-dns/list-a-servers-reverse-dns-addresses"},{"title":"List reverse DNS records for an address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/rdns/{ipId}","href":"/api-reference/reverse-dns/list-reverse-dns-records-for-an-address"},{"title":"Create a reverse DNS record","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/rdns/{ipId}","href":"/api-reference/reverse-dns/create-a-reverse-dns-record"},{"title":"Delete a reverse DNS record","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/rdns/{ipId}/{recordId}","href":"/api-reference/reverse-dns/delete-a-reverse-dns-record"}]},{"group":"SSH keys","pages":[{"title":"List SSH keys","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /ssh-keys","href":"/api-reference/ssh-keys/list-ssh-keys"},{"title":"Add an SSH key","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /ssh-keys","href":"/api-reference/ssh-keys/add-an-ssh-key"},{"title":"Delete an SSH key","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /ssh-keys/{sshKey}","href":"/api-reference/ssh-keys/delete-an-ssh-key"},{"title":"Update an SSH key","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /ssh-keys/{sshKey}","href":"/api-reference/ssh-keys/update-an-ssh-key"},{"title":"Delete multiple SSH keys","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /ssh-keys/bulk/delete","href":"/api-reference/ssh-keys/delete-multiple-ssh-keys"},{"title":"List SSH keys for a reinstall","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/ssh-keys","href":"/api-reference/ssh-keys/list-ssh-keys-for-a-reinstall"}]},{"group":"Server firewall","pages":[{"title":"Get a server's default firewall policy","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/firewall/policy","href":"/api-reference/server-firewall/get-a-servers-default-firewall-policy"},{"title":"List externally managed firewall rules","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/firewall-groups/unmanaged-rules","href":"/api-reference/server-firewall/list-externally-managed-firewall-rules"}]},{"group":"Server settings","pages":[{"title":"Rename a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/settings/rename","href":"/api-reference/server-settings/rename-a-server"},{"title":"Change a server's icon","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/icon","href":"/api-reference/server-settings/change-a-servers-icon"},{"title":"List templates for a reinstall","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/template-groups","href":"/api-reference/server-settings/list-templates-for-a-reinstall"},{"title":"Reinstall a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/settings/reinstall","href":"/api-reference/server-settings/reinstall-a-server"},{"title":"Get the boot order","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/hardware/boot-order","href":"/api-reference/server-settings/get-the-boot-order"},{"title":"Set the boot order","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/hardware/boot-order","href":"/api-reference/server-settings/set-the-boot-order"},{"title":"Get hardware settings","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/hardware/options","href":"/api-reference/server-settings/get-hardware-settings"},{"title":"Update hardware settings","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/hardware/options","href":"/api-reference/server-settings/update-hardware-settings"},{"title":"Change the boot firmware","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/hardware/bios","href":"/api-reference/server-settings/change-the-boot-firmware"},{"title":"Mount an ISO","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/settings/hardware/isos/{iso}/mount","href":"/api-reference/server-settings/mount-an-iso"},{"title":"Unmount an ISO","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/settings/hardware/isos/{iso}/unmount","href":"/api-reference/server-settings/unmount-an-iso"},{"title":"Get DNS resolvers","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/network","href":"/api-reference/server-settings/get-dns-resolvers"},{"title":"Set DNS resolvers","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/network","href":"/api-reference/server-settings/set-dns-resolvers"},{"title":"Get a server's SSH keys","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/auth","href":"/api-reference/server-settings/get-a-servers-ssh-keys"},{"title":"Change a server's password or SSH keys","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/auth","href":"/api-reference/server-settings/change-a-servers-password-or-ssh-keys"}]},{"group":"Server upgrades","pages":[{"title":"List upgrade plans for a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/upgrades/catalog","href":"/api-reference/server-upgrades/list-upgrade-plans-for-a-server"},{"title":"Get the current plan change","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/upgrades/current","href":"/api-reference/server-upgrades/get-the-current-plan-change"},{"title":"Get a quote for a plan change","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/upgrades/quote","href":"/api-reference/server-upgrades/get-a-quote-for-a-plan-change"},{"title":"Buy a plan change","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/upgrades","href":"/api-reference/server-upgrades/buy-a-plan-change"},{"title":"Cancel a plan change","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/upgrades/{upgrade}/cancel","href":"/api-reference/server-upgrades/cancel-a-plan-change"}]},{"group":"Servers","pages":[{"title":"List servers","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers","href":"/api-reference/servers/list-servers"},{"title":"Order servers","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers","href":"/api-reference/servers/order-servers"},{"title":"List server plans","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/catalog","href":"/api-reference/servers/list-server-plans"},{"title":"List templates","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/templates","href":"/api-reference/servers/list-templates"},{"title":"Get a quote for a server order","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/quote","href":"/api-reference/servers/get-a-quote-for-a-server-order"},{"title":"List outstanding server orders","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/orders","href":"/api-reference/servers/list-outstanding-server-orders"},{"title":"Cancel a server order","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/orders/{serverOrder}/cancel","href":"/api-reference/servers/cancel-a-server-order"},{"title":"Get power states for multiple servers","description":"### Overview\n\nReturns power states for up to 100 servers. Pass `?servers[]=\u003cid>\u0026servers[]=\u003cid>` using IDs from the server payload. Servers you do not own are omitted. If a server cannot be reached, its last known state is returned.\n\n### Permissions\n\nRequires the `server.read` (View servers) permission for the selected team. Resources outside that team return 404.","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/power-states","href":"/api-reference/servers/get-power-states-for-multiple-servers"},{"title":"Get a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}","href":"/api-reference/servers/get-a-server"},{"title":"Get a server's billing service","description":"### Overview\n\nReturns the billing service linked to this server, using the same fields as the managed-services listing. Returns null when no service is linked. Only the account holder can read billing; API keys need billing.read. Available while the server is suspended or another operation is in progress.\n\n### Permissions\n\nRequires the `billing.read` (View billing) permission for the selected team. Resources outside that team return 404.","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/billing","href":"/api-reference/servers/get-a-servers-billing-service"},{"title":"Get a server's unpaid invoice","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/billing/overdue-invoice","href":"/api-reference/servers/get-a-servers-unpaid-invoice"},{"title":"Get a server's live configuration","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/details","href":"/api-reference/servers/get-a-servers-live-configuration"},{"title":"Dismiss an installation failure notice","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/install-failure","href":"/api-reference/servers/dismiss-an-installation-failure-notice"},{"title":"Get all usage graphs","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/metrics","href":"/api-reference/servers/get-all-usage-graphs"},{"title":"Get one usage graph","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/metrics-data/{type}/{period}","href":"/api-reference/servers/get-one-usage-graph"},{"title":"List a server's audit log","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/audit-log","href":"/api-reference/servers/list-a-servers-audit-log"},{"title":"Get a server's live status","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/state","href":"/api-reference/servers/get-a-servers-live-status"},{"title":"Send a power command","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /servers/{server}/state","href":"/api-reference/servers/send-a-power-command"},{"title":"Open a console session","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/create-console-session","href":"/api-reference/servers/open-a-console-session"}]},{"group":"Setup scripts","pages":[{"title":"List setup scripts","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /user-scripts","href":"/api-reference/setup-scripts/list-setup-scripts"},{"title":"Add a setup script","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /user-scripts","href":"/api-reference/setup-scripts/add-a-setup-script"},{"title":"Delete a setup script","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /user-scripts/{userScript}","href":"/api-reference/setup-scripts/delete-a-setup-script"},{"title":"Update a setup script","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /user-scripts/{userScript}","href":"/api-reference/setup-scripts/update-a-setup-script"},{"title":"List setup scripts for a reinstall","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/user-scripts","href":"/api-reference/setup-scripts/list-setup-scripts-for-a-reinstall"}]},{"group":"Snapshots","pages":[{"title":"List the team's snapshots","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /snapshots","href":"/api-reference/snapshots/list-the-teams-snapshots"},{"title":"List snapshot storages","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /snapshots/storages","href":"/api-reference/snapshots/list-snapshot-storages"},{"title":"Buy a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/storages","href":"/api-reference/snapshots/buy-a-snapshot-storage"},{"title":"Get a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /snapshots/storages/{snapshotStorage}","href":"/api-reference/snapshots/get-a-snapshot-storage"},{"title":"Rename a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /snapshots/storages/{snapshotStorage}","href":"/api-reference/snapshots/rename-a-snapshot-storage"},{"title":"Get a quote for resizing a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/storages/{snapshotStorage}/resize/quote","href":"/api-reference/snapshots/get-a-quote-for-resizing-a-snapshot-storage"},{"title":"Resize a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/storages/{snapshotStorage}/resize","href":"/api-reference/snapshots/resize-a-snapshot-storage"},{"title":"Cancel a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/storages/{snapshotStorage}/cancel","href":"/api-reference/snapshots/cancel-a-snapshot-storage"},{"title":"Withdraw a snapshot storage cancellation","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/storages/{snapshotStorage}/withdraw-cancellation","href":"/api-reference/snapshots/withdraw-a-snapshot-storage-cancellation"},{"title":"Move a snapshot to another storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/{snapshot}/move","href":"/api-reference/snapshots/move-a-snapshot-to-another-storage"},{"title":"Delete a snapshot by ID","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /snapshots/{snapshot}","href":"/api-reference/snapshots/delete-a-snapshot-by-id"},{"title":"List snapshots available to a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/snapshots","href":"/api-reference/snapshots/list-snapshots-available-to-a-server"},{"title":"Take a snapshot","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/snapshots","href":"/api-reference/snapshots/take-a-snapshot"},{"title":"Restore a snapshot","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/snapshots/{snapshot}/restore","href":"/api-reference/snapshots/restore-a-snapshot"},{"title":"Delete a snapshot","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/snapshots/{snapshot}","href":"/api-reference/snapshots/delete-a-snapshot"}]},{"group":"Support tickets","pages":[{"title":"List support tickets","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /tickets","href":"/api-reference/support-tickets/list-support-tickets"},{"title":"Open a support ticket","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /tickets","href":"/api-reference/support-tickets/open-a-support-ticket"},{"title":"List ticket departments","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /tickets/departments","href":"/api-reference/support-tickets/list-ticket-departments"},{"title":"Get a ticket","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /tickets/{ticket}","href":"/api-reference/support-tickets/get-a-ticket"},{"title":"Download a ticket attachment","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /tickets/{ticket}/messages/{message}/attachments/{index}","href":"/api-reference/support-tickets/download-a-ticket-attachment"},{"title":"Close a ticket","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /tickets/{ticket}/close","href":"/api-reference/support-tickets/close-a-ticket"},{"title":"Reply to a ticket","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /tickets/{ticket}/reply","href":"/api-reference/support-tickets/reply-to-a-ticket"}]},{"group":"Team activity","pages":[{"title":"List a team's audit log","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/{team}/audit-logs","href":"/api-reference/team-activity/list-a-teams-audit-log"}]},{"group":"Team members","pages":[{"title":"List a team's members","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/{team}/members","href":"/api-reference/team-members/list-a-teams-members"},{"title":"Invite a team member","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /teams/{team}/members","href":"/api-reference/team-members/invite-a-team-member"},{"title":"Remove a team member","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /teams/{team}/members/{member}","href":"/api-reference/team-members/remove-a-team-member"},{"title":"Change a member's role","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /teams/{team}/members/{member}","href":"/api-reference/team-members/change-a-members-role"},{"title":"Withdraw an invitation","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /teams/{team}/invitations/{invitation}","href":"/api-reference/team-members/withdraw-an-invitation"}]},{"group":"Team roles","pages":[{"title":"List role permissions","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/permissions","href":"/api-reference/team-roles/list-role-permissions"},{"title":"List a team's roles","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/{team}/roles","href":"/api-reference/team-roles/list-a-teams-roles"},{"title":"Create a role","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /teams/{team}/roles","href":"/api-reference/team-roles/create-a-role"},{"title":"Get a role","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/{team}/roles/{role}","href":"/api-reference/team-roles/get-a-role"},{"title":"Delete a role","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /teams/{team}/roles/{role}","href":"/api-reference/team-roles/delete-a-role"},{"title":"Update a role","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /teams/{team}/roles/{role}","href":"/api-reference/team-roles/update-a-role"}]},{"group":"Teams","pages":[{"title":"List teams","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams","href":"/api-reference/teams/list-teams"},{"title":"Create a team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /teams","href":"/api-reference/teams/create-a-team"},{"title":"Get the current team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/context","href":"/api-reference/teams/get-the-current-team"},{"title":"Delete a team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /teams/{team}","href":"/api-reference/teams/delete-a-team"},{"title":"Rename a team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /teams/{team}","href":"/api-reference/teams/rename-a-team"},{"title":"Set the default team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /teams/{team}/default","href":"/api-reference/teams/set-the-default-team"}]},{"group":"Transfers","pages":[{"title":"Transfer resources to another team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /transfers","href":"/api-reference/transfers/transfer-resources-to-another-team"}]}]}]}]},"basePath":"","title":"Get a server - Advin Servers","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}