{"openapi":"3.0.1","servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"info":{"contact":{"email":"support@linode.com","name":"Linode","url":"https://linode.com"},"description":"## Introduction\nThe Linode API provides the ability to programmatically manage the full\nrange of Linode products and services.\n\nThis reference is designed to assist application developers and system\nadministrators. Each endpoint includes descriptions, request syntax, and\nexamples using standard HTTP requests. Response data is returned in JSON\nformat.\n\n\nThis document was generated from our OpenAPI Specification. See the\nOpenAPI website for more information.\n\nDownload the Linode OpenAPI Specification.\n\n\n## Changelog\n\nView our Changelog to see release\nnotes on all changes made to our API.\n\n## Access and Authentication\n\nSome endpoints are publicly accessible without requiring authentication.\nAll endpoints affecting your Account, however, require either a Personal\nAccess Token or OAuth authentication (when using third-party\napplications).\n\n### Personal Access Token\n\nThe easiest way to access the API is with a Personal Access Token (PAT)\ngenerated from the\nLinode Cloud Manager or\nthe [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint.\n\nAll scopes for the OAuth security model ([defined below](/docs/api/#oauth)) apply to this\nsecurity model as well.\n\n### Authentication\n\n| Security Scheme Type: | HTTP |\n|-----------------------|------|\n| **HTTP Authorization Scheme** | bearer |\n\n## OAuth\n\nIf you only need to access the Linode API for personal use,\nwe recommend that you create a [personal access token](/docs/api/#personal-access-token).\nIf you're designing an application that can authenticate with an arbitrary Linode user, then\nyou should use the OAuth 2.0 workflows presented in this section.\n\nFor a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange).\n\nBefore you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients):\n\n - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager).\n - The response from this endpoint will give you a `client_id` and a `secret`.\n - Clients can be public or private, and are private by default. You can choose to make the client public when it is created.\n - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation.\n - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client.\n - Public and private clients follow different workflows, as described below.\n\n### OAuth Workflow\n\nThe OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used\nto authenticate a user before an application can start making API calls on the user's behalf.\n\nNotes:\n\n- With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*)\nis the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api server*) is the Resource Server.\n- The OAuth spec refers to the private and public workflows listed below as the [authorization code flow](https://tools.ietf.org/html/rfc6749#section-1.3.1) and [implicit flow](https://tools.ietf.org/html/rfc6749#section-1.3.2).\n\n| PRIVATE WORKFLOW | PUBLIC WORKFLOW |\n|------------------|------------------|\n| 1. The user visits the application's website and is directed to login with Linode. | 1. The user visits the application's website and is directed to login with Linode. |\n| 2. Your application then redirects the user to Linode's [login server](https://login.linode.com) with the client application's `client_id` and requested OAuth `scope`, which should appear in the URL of the login page. | 2. Your application then redirects the user to Linode's [login server](https://login.linode.com) with the client application's `client_id` and requested OAuth `scope`, which should appear in the URL of the login page. |\n| 3. The user logs into the login server with their username and password. | 3. The user logs into the login server with their username and password. |\n| 4. The login server redirects the user to the specificed redirect URL with a temporary authorization `code` (exchange code) in the URL. | 4. The login server redirects the user back to your application with an OAuth `access_token` embedded in the redirect URL's hash. This is temporary and expires in two hours. No `refresh_token` is issued. Therefore, once the `access_token` expires, a new one will need to be issued by having the user log in again. |\n| 5. The application issues a POST request (*see additional details below*) to the login server with the exchange code, `client_id`, and the client application's `client_secret`. | |\n| 6. The login server responds to the client application with a new OAuth `access_token` and `refresh_token`. The `access_token` is set to expire in two hours. | |\n| 7. The `refresh_token` can be used by contacting the login server with the `client_id`, `client_secret`, `grant_type`, and `refresh_token` to get a new OAuth `access_token` and `refresh_token`. The new `access_token` is good for another two hours, and the new `refresh_token` can be used to extend the session again by this same method (*see additional details below*). | |\n\n#### OAuth Private Workflow - Additional Details\n\nThe following information expands on steps 5 through 7 of the private workflow:\n\nOnce the user has logged into Linode and you have received an exchange code,\nyou will need to trade that exchange code for an `access_token` and `refresh_token`. You\ndo this by making an HTTP POST request to the following address:\n\n```\nhttps://login.linode.com/oauth/token\n```\n\nMake this request as `application/x-www-form-urlencoded` or as\n`multipart/form-data` and include the following parameters in the POST body:\n\n| PARAMETER | DESCRIPTION |\n|-----------|-------------|\n| client_id | Your app's client ID. |\n| client_secret | Your app's client secret. |\n| code | The code you just received from the redirect. |\n\nYou'll get a response like this:\n\n```json\n{\n \"scope\": \"linodes:read_write\",\n \"access_token\": \"03d084436a6c91fbafd5c4b20c82e5056a2e9ce1635920c30dc8d81dc7a6665c\",\n \"refresh_token\": \"f2ec9712e616fdb5a2a21aa0e88cfadea7502ebc62cf5bd758dbcd65e1803bad\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7200\n}\n```\n\nIncluded in the response is an `access_token`. With this token, you can proceed to make\nauthenticated HTTP requests to the API by adding this header to each request:\n\n```\nAuthorization: Bearer 03d084436a6c91fbafd5c4b20c82e5056a2e9ce1635920c30dc8d81dc7a6665c\n```\n\nThis `access_token` is set to expire in two hours. To refresh access prior to expiration, make another request to the same URL with the following parameters in the POST body:\n\n| PARAMETER | DESCRIPTION |\n|-----------|-------------|\n| grant_type | The grant type you're using. Use \"refresh_token\" when refreshing access. |\n| client_id | Your app's client ID. |\n| client_secret | Your app's client secret. |\n| refresh_token | The `refresh_token` received from the previous response. |\n\nYou'll get another response with an updated `access_token` and `refresh_token`, which can then be used to refresh access again.\n\n### OAuth Reference\n\n| Security Scheme Type | OAuth 2.0 |\n|-----------------------|--------|\n| **Authorization URL** | `https://login.linode.com/oauth/authorize` |\n| **Token URL** | `https://login.linode.com/oauth/token` |\n| **Scopes** |
|\n\n## Requests\n\nRequests must be made over HTTPS to ensure transactions are encrypted. Data included in requests must be supplied in json format unless otherwise specified in the command description.\n\nThe following request methods are supported:\n\n| METHOD | USAGE |\n|---------|-------|\n| GET | Retrieves data about collections and individual resources. |\n| POST | For collections, creates a new resource of that type. Also used to perform actions on action endpoints. |\n| PUT | Updates an existing resource. |\n| DELETE | Deletes a resource. This is a destructive action. |\n| HEAD | Returns only the response header information of a GET request |\n| OPTIONS | Provides permitted communication options for a command |\n\n## Responses\n\n### Response Status Codes\n\nActions will return one of the following HTTP response status codes:\n\n| STATUS | DESCRIPTION |\n|---------|-------------|\n| 200 OK | The request was successful. |\n| 202 Accepted | The request was successful, but processing has not been completed. The response body includes a \"warnings\" array containing the details of incomplete processes. |\n| 204 No Content | The server successfully fulfilled the request and there is no additional content to send. |\n| 299 Deprecated | The request was successful, but involved a deprecated endpoint. The response body includes a \"warnings\" array containing warning messages. |\n| 400 Bad Request | You submitted an invalid request (missing parameters, etc.). |\n| 401 Unauthorized | You failed to authenticate for this resource. |\n| 403 Forbidden | You are authenticated, but don't have permission to do this. |\n| 404 Not Found | The resource you're requesting does not exist. |\n| 429 Too Many Requests | You've hit a rate limit. |\n| 500 Internal Server Error | Please [open a Support Ticket](/docs/api/support/#support-ticket-open). |\n\n### Response Headers\n\nThere are many ways to access response header information for individual command URLs, depending on how you are accessing the Linode API. For example, to view HTTP response headers for the `/regions` endpoint when making requests with `curl`, use the `-I` or `--head` option as follows:\n\n```Shell\ncurl -I https://api.linode.com/v4/regions\n```\n\nResponses may include the following headers:\n\n| HEADER | DESCRIPTION | EXAMPLE |\n|--------|-------------|---------|\n| Access-Control-Allow-Credentials | Responses to credentialed requests are exposed to frontend JavaScript code. | true |\n| Access-Control-Allow-Headers | All permissible request headers for this endpoint. | Authorization, Origin, X-Requested-With, Content-Type, Accept, X-Filter |\n| Access-Control-Allow-Methods | Permissible HTTP methods for this endpoint | HEAD, GET, OPTIONS, POST, PUT, DELETE |\n| Access-Control-Allow-Origin | Indicates origin access permissions. The wildcard character `*` means any origin can access the resource. | * |\n| Access-Control-Expose-Headers | Available headers to include in response to cross-origin requests. | X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Status |\n| Cache-Control | Controls caching in browsers and shared caches such as CDNs. | private, max-age=60, s-maxage=60 |\n| Content-Security-Policy | Controls which resources are allowed to load. By default, resources do not load. | default-src 'none' |\n| Content-Type | All responses are in json format. | application/json |\n| Content-Warning | A message containing instructions for successful requests that were not able to be completed. | Please contact support for assistance. |\n| Retry-After | The remaining time in seconds until the current [rate limit](#rate-limiting) window resets. | 60 |\n| Strict-Transport-Security | Enforces HTTPS-only access until the returned time in seconds. | max-age=31536000 |\n| Vary | Optional request headers that affected the response content. | Authorization, X-Filter |\n| X-Accepted-OAuth-Scopes | Required [scopes](#oauth-reference) for accessing the requested command. | linodes:read_only |\n| X-Customer-UUID | A unique identifier for the account owning the the [personal access token](#personal-access-token) that was used for the request. | ABCDEF01-3456-789A-BCDEF0123456789A |\n| X-OAuth-Scopes | Allowed [scopes](#oauth-reference) associated with the [personal access token](#personal-access-token) that was used for the request. A value of `*` indicates read/write access for all scope categories. | images:read_write linodes:read_only |\n| X-RateLimit-Limit | The maximum number of permitted requests during the [rate limit](#rate-limiting) window for this endpoint. | 800 |\n| X-RateLimit-Remaining | The remaining number of permitted requests in the current [rate limit](#rate-limiting) window. | 798 |\n| X-RateLimit-Reset | The time when the current [rate limit](#rate-limiting) window rests in UTC epoch seconds. | 1674747739 |\n| X-Spec-Version | The current API version that handled the request. | 4.150.0 |\n\n## Errors\n\nSuccess is indicated via Standard HTTP status codes.\n`2xx` codes indicate success, `4xx` codes indicate a request error, and\n`5xx` errors indicate a server error. A\nrequest error might be an invalid input, a required parameter being omitted,\nor a malformed request. A server error means something went wrong processing\nyour request. If this occurs, please\n[open a Support Ticket](/docs/api/support/#support-ticket-open)\nand let us know. Though errors are logged and we work quickly to resolve issues,\nopening a ticket and providing us with reproducable steps and data is always helpful.\n\nThe `errors` field is an array of the things that went wrong with your request.\nWe will try to include as many of the problems in the response as possible,\nbut it's conceivable that fixing these errors and resubmitting may result in\nnew errors coming back once we are able to get further along in the process\nof handling your request.\n\nWithin each error object, the `field` parameter will be included if the error\npertains to a specific field in the JSON you've submitted. This will be\nomitted if there is no relevant field. The `reason` is a human-readable\nexplanation of the error, and will always be included.\n\n## Pagination\n\nResource lists are always paginated. The response will look similar to this:\n\n```json\n{\n \"data\": [ ... ],\n \"page\": 1,\n \"pages\": 3,\n \"results\": 300\n}\n```\n\n* Pages start at 1. You may retrieve a specific page of results by adding\n`?page=x` to your URL (for example, `?page=4`). If the value of `page`\nexceeds `2^64/page_size`, the last possible page will be returned.\n\n\n* Page sizes default to 100,\nand can be set to return between 25 and 500. Page size can be set using\n`?page_size=x`.\n\n## Filtering and Sorting\n\nCollections are searchable by fields they include, marked in the spec as\n`x-linode-filterable: true`. Filters are passed\nin the `X-Filter` header and are formatted as JSON objects. Here is a request\ncall for Linode Types in our \"standard\" class:\n\n```Shell\ncurl \"https://api.linode.com/v4/linode/types\" \\\n -H 'X-Filter: { \"class\": \"standard\" }'\n```\n\nThe filter object's keys are the keys of the object you're filtering,\nand the values are accepted values. You can add multiple filters by\nincluding more than one key. For example, filtering for \"standard\" Linode\nTypes that offer one vcpu:\n\n```Shell\n curl \"https://api.linode.com/v4/linode/types\" \\\n -H 'X-Filter: { \"class\": \"standard\", \"vcpus\": 1 }'\n```\n\nIn the above example, both filters are combined with an \"and\" operation.\nHowever, if you wanted either Types with one vcpu or Types in our \"standard\"\nclass, you can add an operator:\n\n ```Shell\ncurl \"https://api.linode.com/v4/linode/types\" \\\n -H 'X-Filter: { \"+or\": [ { \"vcpus\": 1 }, { \"class\": \"standard\" } ] }'\n```\n\nEach filter in the `+or` array is its own filter object, and all conditions\nin it are combined with an \"and\" operation as they were in the previous example.\n\nOther operators are also available. Operators are keys of a Filter JSON\nobject. Their value must be of the appropriate type, and they are evaluated\nas described below:\n\n| OPERATOR | TYPE | DESCRIPTION |\n|----------|--------|-----------------------------------|\n| +and | array | All conditions must be true. |\n| +or | array | One condition must be true. |\n| +gt | number | Value must be greater than number. |\n| +gte | number | Value must be greater than or equal to number. |\n| +lt | number | Value must be less than number. |\n| +lte | number | Value must be less than or equal to number. |\n| +contains | string | Given string must be in the value. |\n| +neq | string | Does not equal the value. |\n| +order_by | string | Attribute to order the results by - must be filterable. |\n| +order | string | Either \"asc\" or \"desc\". Defaults to \"asc\". Requires `+order_by`. |\n\nFor example, filtering for [Linode Types](/docs/api/linode-types/)\nthat offer memory equal to or higher than 61440:\n\n```Shell\ncurl \"https://api.linode.com/v4/linode/types\" \\\n -H '\n X-Filter: {\n \"memory\": {\n \"+gte\": 61440\n }\n }'\n```\n\nYou can combine and nest operators to construct arbitrarily-complex queries.\nFor example, give me all [Linode Types](/docs/api/linode-types/)\nwhich are either `standard` or `highmem` class, or\nhave between 12 and 20 vcpus:\n\n```Shell\ncurl \"https://api.linode.com/v4/linode/types\" \\\n -H '\n X-Filter: {\n \"+or\": [\n {\n \"+or\": [\n {\n \"class\": \"standard\"\n },\n {\n \"class\": \"highmem\"\n }\n ]\n },\n {\n \"+and\": [\n {\n \"vcpus\": {\n \"+gte\": 12\n }\n },\n {\n \"vcpus\": {\n \"+lte\": 20\n }\n }\n ]\n }\n ]\n }'\n```\n## Time Values\n\nAll times returned by the API are in UTC, regardless of the timezone configured within your user's profile (see `timezone` property within [Profile View](/docs/api/profile/#profile-view__responses)).\n\n## Rate Limiting\n\nRate limits on API requests help maintain the health and stability of the Linode API. Accordingly, every endpoint of the Linode API applies a rate limit on a per user basis as determined by OAuth token for authenticated requests or IP address for public endpoints.\n\nEach rate limit consists of a total number of requests and a time window. For example, if an endpoint has a rate limit of 800 requests per minute, then up to 800 requests over a one minute window are permitted. Subsequent requests to an endpoint after hitting a rate limit return a 429 error. You can successfully remake requests to that endpoint after the rate limit window resets.\n\n### Linode APIv4 Rate Limits\n\nWith the Linode API, you can generally make up to 1,600 general API requests every two minutes. Additionally, all endpoints have a rate limit of 800 requests per minute unless otherwise specified below.\n\n**Note:** There may be rate limiting applied at other levels outside of the API, for example, at the load balancer.\n\nCreating Linodes has a dedicated rate limit of 10 requests per 30 seconds. That endpoint is:\n\n* [Linode Create](/docs/api/linode-instances/#linode-create)\n\n`/stats` endpoints have their own dedicated rate limits of 100 requests per minute. These endpoints are:\n\n* [View Linode Statistics](/docs/api/linode-instances/#linode-statistics-view)\n* [View Linode Statistics (year/month)](/docs/api/linode-instances/#statistics-yearmonth-view)\n* [View NodeBalancer Statistics](/docs/api/nodebalancers/#nodebalancer-statistics-view)\n* [List Managed Stats](/docs/api/managed/#managed-stats-list)\n\nObject Storage endpoints have a dedicated rate limit of 750 requests per second. The Object Storage endpoints are:\n\n* [Object Storage Endpoints](/docs/api/object-storage/)\n\nOpening Support Tickets has a dedicated rate limit of 2 requests per minute. That endpoint is:\n\n* [Open Support Ticket](/docs/api/support/#support-ticket-open)\n\nAccepting Service Transfers has a dedicated rate limit of 2 requests per minute. That endpoint is:\n\n* [Service Transfer Accept](/docs/api/account/#service-transfer-accept)\n\n### Rate Limit HTTP Response Headers\n\nThe Linode API includes the following HTTP response headers which are designed to help you avoid hitting rate limits which might disrupt your applications:\n\n* **X-RateLimit-Limit**: The maximum number of permitted requests during the rate limit window for this endpoint.\n* **X-RateLimit-Remaining**: The remaining number of permitted requests in the current rate limit window.\n* **X-RateLimit-Reset**: The time when the current rate limit window rests in UTC epoch seconds.\n* **Retry-After**: The remaining time in seconds until the current rate limit window resets.\n\n## CLI (Command Line Interface)\n\nThe Linode CLI allows you to easily\nwork with the API using intuitive and simple syntax. It requires a\n[Personal Access Token](/docs/api/#personal-access-token)\nfor authentication, and gives you access to all of the features and functionality\nof the Linode API that are documented here with CLI examples.\n\nEndpoints that do not have CLI examples are currently unavailable through the CLI, but\ncan be accessed via other methods such as Shell commands and other third-party applications.\n","title":"Linode API","version":"4.151.1","x-apisguru-categories":["cloud"],"x-origin":[{"converter":{"url":"https://github.com/mermade/oas-kit","version":"7.0.4"},"format":"openapi","url":"https://www.linode.com/docs/api/openapi.yaml","version":"3.0"}],"x-providerName":"linode.com"},"tags":[{"description":"Use the Account endpoints to manage user settings, billing, and payments. You can also initiate and maintain OAuth client application authentication, enable the Linode Managed service, and create new users on your account.","name":"Account"},{"description":"Managed Databases is Linode's fully-managed, high-performance database service. Use the Managed Databases endpoints to create and manage database clusters.","name":"Databases"},{"description":"Use the Domains endpoints to create and manage domains and domain records on your account.","name":"Domains"},{"description":"Use the Images endpoints to capture, store, and manage custom Linode images.","name":"Images"},{"description":"Use the Linode Instances endpoints to create, configure, and manage your Linode instances. You can also manage the Linode Backup service; maintain and manage configuration profiles; create and maintain disks, intiate a host migration; view Linode Instance statistics; and more.","name":"Linode Instances"},{"description":"Use the Linode Types endpoints to retrieve information about Linode plan types, including pricing information, hardware resources, and network transfer allotment.","name":"Linode Types"},{"description":"Linode Kubernetes Engine (LKE) is Linode's managed Kubernetes service. Use the LKE endpoints to create and manage Kubernetes clusters and their associated Node Pools.","name":"Linode Kubernetes Engine (LKE)"},{"description":"Longview is Linode's system-level monitoring and graphing service. Use the Longview endpoints to manage your Longview subscription and plan and to create and maintain Longview clients.","name":"Longview"},{"description":"Managed is Linode's incident response service. Use the Managed endpoints to register a service to be monitored by the Managed Service team, provide secure access to your managed services, view information about detected issues, and more.","name":"Managed"},{"description":"Use the Networking endpoints to view all IP addresses on your account, reorganize assigned IPv4 addresses, update RDNS, and configure IP sharing.","name":"Networking"},{"description":"NodeBalancers is Linode's load balancing service. Use the NodeBalancers endpoints to create and manage NodeBalancers. You can also create and maintain configurations; create and maintain nodes, and view statistics.","name":"NodeBalancers"},{"description":"Object Storage is Linode's S3-compatible data storage service. Use the Object Storage endpoints to create and maintaining buckets, add and remove objects from buckets, create and maintain Object Storage keys, and cancel the Object Storage service.","name":"Object Storage"},{"description":"Use the Profile endpoints to manage your Linode user profile preferences and security settings. This includes creating and maintaining personal access tokens, creating and maintaining SSH keys, confirming and enabling two-factor authentication, and updating user and profile preferences.","name":"Profile"},{"description":"Use the Regions endpoints to view information about the various Linode data center regions, including the service capabilities for each region, country, status, and more.","name":"Regions"},{"description":"Linode StackScripts allow you to create reusable scripts to configure new Linode instances. Use the StackScripts endpoints to create and manage StackScripts on your account.","name":"StackScripts"},{"description":"Use the Support endpoints to open, view, and close Linode Support tickets. You can also create and manage your Support ticket replies.","name":"Support"},{"description":"Tags allow you to organize and group your various Linode services. Use the Tags endpoints to create, assign, and delete your account tags.","name":"Tags"},{"description":"Volumes is Linode's block storage service. Use the Volumes endpoints to create, attach, and manage your account Volumes.","name":"Volumes"}],"paths":{"/account":{"get":{"description":"Returns the contact and billing information related to your Account.\n","operationId":"getAccount","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Returns a single Account object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Account View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account\n"},{"lang":"CLI","source":"linode-cli account view\n"}],"x-linode-cli-action":"view","x-linode-grant":"read_only"},"put":{"description":"Updates contact and billing information related to your Account.\n","operationId":"updateAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Update contact and billing information.\n\nAccount properties that are excluded from a request remain unchanged.\n\nWhen updating an Account's `country` to \"US\", an error is returned if the Account's `zip` is not a valid US zip code.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"The updated Account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Account Update","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"address_1\": \"123 Main St.\",\n \"address_2\": \"Suite 101\",\n \"city\": \"Philadelphia\",\n \"company\": \"My Company, LLC\",\n \"country\": \"US\",\n \"email\": \"jsmith@mycompany.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"phone\": \"555-555-1212\",\n \"state\": \"PA\",\n \"tax_id\": \"ATU99999999\",\n \"zip\": \"19102\"\n }' \\\n https://api.linode.com/v4/account\n"},{"lang":"CLI","source":"linode-cli account update \\\n --address_1 \"123 Main St.\" \\\n --address_2 \"Suite 101\" \\\n --city Philadelphia \\\n --company My Company \\ LLC \\\n --country US \\\n --email jsmith@mycompany.com \\\n --first_name John \\\n --last_name Smith \\\n --phone 555-555-1212 \\\n --state PA \\\n --tax_id ATU99999999 \\\n --zip 19102\n"}],"x-linode-cli-action":"update","x-linode-grant":"read_write"},"x-linode-cli-command":"account"},"/account/cancel":{"post":{"description":"Cancels an active Linode account. This action will cause Linode to attempt to charge the credit card on file for the remaining balance. An error will occur if Linode fails to charge the credit card on file. Restricted users will not be able to cancel an account.\n","operationId":"cancelAccount","requestBody":{"content":{"application/json":{"schema":{"properties":{"comments":{"description":"Any reason for cancelling the account, and any other comments you might have about your Linode service.\n","example":"I'm consolidating multiple accounts into one.","type":"string"}}}}},"description":"Supply a comment stating the reason that you are cancelling your account.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"survey_link":"https://alinktothesurvey.com'"},"properties":{"survey_link":{"description":"A link to Linode's exit survey.","type":"string"}},"type":"object"}}},"description":"Account cancelled"},"409":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"reason":{"description":"A string explaining that the account could not be cancelled because there is an outstanding balance on the account that must be paid first.\n","example":"We were unable to charge your credit card for services rendered. We cannot cancel this account until the balance has been paid.\n","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Could not charge the credit card on file"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Account Cancel","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"comments\": \"I am consolidating my accounts.\"\n }' \\\n https://api.linode.com/v4/account/cancel\n"},{"lang":"CLI","source":"linode-cli account cancel \\\n --comments \"I'm consolidating my accounts\"\n"}],"x-linode-cli-action":"cancel","x-linode-grant":"read_write"},"x-linode-cli-command":"account"},"/account/credit-card":{"post":{"deprecated":true,"description":"**DEPRECATED**. Please use Payment Method Add ([POST /account/payment-methods](/docs/api/account/#payment-method-add)).\n\nAdds a credit card Payment Method to your account and sets it as the default method.\n","operationId":"createCreditCard","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditCard"}}},"description":"Update the credit card information associated with your Account.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Credit Card updated."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Credit Card Add/Edit","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"card_number\": \"4111111111111111\",\n \"expiry_month\": 11,\n \"expiry_year\": 2020,\n \"cvv\": \"111\"\n }' \\\n https://api.linode.com/v4/account/credit-card\n"},{"lang":"CLI","source":"linode-cli account update-card \\\n --card_number 4111111111111111 \\\n --expiry_month 11 \\\n --expiry_year 2025 \\\n --cvv 111\n"}],"x-linode-cli-action":"update-card","x-linode-cli-skip":true,"x-linode-grant":"read_write"},"x-linode-cli-command":"account"},"/account/entity-transfers":{"get":{"deprecated":true,"description":"**DEPRECATED**. Please use [Service Transfers List](/docs/api/account/#service-transfers-list).\n","operationId":"getEntityTransfers","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationEnvelope"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/EntityTransfer"},"type":"array"}}}]}}},"description":"Returns a paginated list of Entity Transfer objects containing the details of all transfers that have been created and accepted by this account.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Entity Transfers List","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/entity-transfers\n"}],"x-linode-cli-skip":true,"x-linode-grant":"unrestricted only"},"post":{"deprecated":true,"description":"**DEPRECATED**. Please use [Service Transfer Create](/docs/api/account/#service-transfer-create).\n","operationId":"createEntityTransfer","requestBody":{"content":{"application/json":{"schema":{"properties":{"entities":{"$ref":"#/components/schemas/EntityTransfer/properties/entities"}},"required":["entities"],"type":"object"}}},"description":"The entities to include in this transfer request."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityTransfer"}}},"description":"Returns an Entity Transfer object for the request.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Entity Transfer Create","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"entities\": {\n \"linodes\": [\n 111,\n 222\n ]\n }\n }' \\\n https://api.linode.com/v4/account/entity-transfers\n"}],"x-linode-cli-skip":true,"x-linode-grant":"unrestricted only"}},"/account/entity-transfers/{token}":{"delete":{"deprecated":true,"description":"**DEPRECATED**. Please use [Service Transfer Cancel](/docs/api/account/#service-transfer-cancel).\n","operationId":"deleteEntityTransfer","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Entity Transfer cancelled.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Entity Transfer Cancel","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/account/entity-transfers/123E4567-E89B-12D3-A456-426614174000\n"}],"x-linode-cli-skip":true,"x-linode-grant":"unrestricted only"},"get":{"deprecated":true,"description":"**DEPRECATED**. Please use [Service Transfer View](/docs/api/account/#service-transfer-view).\n","operationId":"getEntityTransfer","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityTransfer"}}},"description":"Returns an Entity Transfer object containing the details of the transfer for the specified token.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Entity Transfer View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/entity-transfers/123E4567-E89B-12D3-A456-426614174000\n"}],"x-linode-cli-skip":true,"x-linode-grant":"unrestricted only"},"parameters":[{"description":"The UUID of the Entity Transfer.","in":"path","name":"token","required":true,"schema":{"format":"uuid","type":"string"}}]},"/account/entity-transfers/{token}/accept":{"parameters":[{"description":"The UUID of the Entity Transfer.","in":"path","name":"token","required":true,"schema":{"format":"uuid","type":"string"}}],"post":{"deprecated":true,"description":"**DEPRECATED**. Please use [Service Transfer Accept](/docs/api/account/#service-transfer-accept).\n","operationId":"acceptEntityTransfer","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Entity Transfer accepted.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Entity Transfer Accept","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/account/entity-transfers/123E4567-E89B-12D3-A456-426614174000/accept\n"}],"x-linode-cli-skip":true,"x-linode-grant":"unrestricted only"}},"/account/events":{"get":{"description":"Returns a collection of Event objects representing actions taken on your Account from the last 90 days. The Events returned depend on your grants.\n","operationId":"getEvents","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Event"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated lists of Event objects from the last 90 days.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["events:read_only"]}],"summary":"Events List","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/events\n"},{"lang":"CLI","source":"linode-cli events list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"x-linode-cli-command":"events"},"/account/events/{eventId}":{"get":{"description":"Returns a single Event object.\n","operationId":"getEvent","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}},"description":"An Event object"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["events:read_only"]}],"summary":"Event View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/events/123\n"},{"lang":"CLI","source":"linode-cli events view 123\n"}],"x-linode-cli-action":"view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Event.","in":"path","name":"eventId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"events"},"/account/events/{eventId}/read":{"parameters":[{"description":"The ID of the Event to designate as read.","in":"path","name":"eventId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Marks a single Event as read.","operationId":"eventRead","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Event read."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["events:read_only"]}],"summary":"Event Mark as Read","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/account/events/123/read\n"},{"lang":"CLI","source":"linode-cli events mark-read 123\n"}],"x-linode-cli-action":"mark-read","x-linode-grant":"read_only"},"x-linode-cli-command":"events"},"/account/events/{eventId}/seen":{"parameters":[{"description":"The ID of the Event to designate as seen.","in":"path","name":"eventId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Marks all Events up to and including this Event by ID as seen.\n","operationId":"eventSeen","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Events seen."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["events:read_only"]}],"summary":"Event Mark as Seen","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/account/events/123/seen\n"},{"lang":"CLI","source":"linode-cli events mark-seen 123\n"}],"x-linode-cli-action":"mark-seen","x-linode-grant":"read_write"},"x-linode-cli-command":"events"},"/account/invoices":{"get":{"description":"Returns a paginated list of Invoices against your Account.\n","operationId":"getInvoices","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Invoice"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of Invoice objects."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Invoices List","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/invoices\n"},{"lang":"CLI","source":"linode-cli account invoices-list\n"}],"x-linode-cli-action":"invoices-list","x-linode-grant":"read_only"},"x-linode-cli-command":"account"},"/account/invoices/{invoiceId}":{"get":{"description":"Returns a single Invoice object.","operationId":"getInvoice","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}},"description":"An Invoice object"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Invoice View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/invoices/123\n"},{"lang":"CLI","source":"linode-cli account invoice-view 123\n"}],"x-linode-cli-action":"invoice-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Invoice.","in":"path","name":"invoiceId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"account"},"/account/invoices/{invoiceId}/items":{"get":{"description":"Returns a paginated list of Invoice items.","operationId":"getInvoiceItems","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InvoiceItem"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of InvoiceItem objects"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Invoice Items List","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/invoices/123/items\n"},{"lang":"CLI","source":"linode-cli account invoice-items 123\n"}],"x-linode-cli-action":"invoice-items","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Invoice.","in":"path","name":"invoiceId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"account"},"/account/logins":{"get":{"description":"Returns a collection of successful logins for all users on the account during the last 90 days. This command can only be accessed by the unrestricted users of an account.\n","operationId":"getAccountLogins","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Login"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A collection of successful logins for all users on the account during the last 90 days.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"User Logins List All","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/logins\n"},{"lang":"CLI","source":"linode-cli account logins-list\n"}],"x-linode-cli-action":"logins-list"},"x-linode-cli-command":"account"},"/account/logins/{loginId}":{"get":{"description":"Returns a Login object that displays information about a successful login. The logins that can be viewed can be for any user on the account, and are not limited to only the logins of the user that is accessing this API endpoint. This command can only be accessed by the unrestricted users of the account.\n","operationId":"getAccountLogin","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Login"}}},"description":"The requested login object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Login View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/logins/1234\n"},{"lang":"CLI","source":"linode-cli account login-view 1234\n"}],"x-linode-cli-action":"login-view"},"parameters":[{"description":"The ID of the login object to access.","in":"path","name":"loginId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"account"},"/account/maintenance":{"get":{"description":"Returns a collection of Maintenance objects for any entity a user has permissions to view. Cancelled Maintenance objects are not returned.\n\nCurrently, Linodes are the only entities available for viewing.\n","operationId":"getMaintenance","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Maintenance"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of Maintenance objects."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":[]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Maintenance List","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/maintenance\n"},{"lang":"CLI","source":"linode-cli account maintenance-list\n"}],"x-linode-cli-action":"maintenance-list","x-linode-grant":"read_only"},"x-linode-cli-command":"account"},"/account/notifications":{"get":{"description":"Returns a collection of Notification objects representing important, often time-sensitive items related to your Account.\nYou cannot interact directly with Notifications, and a Notification will disappear when the circumstances causing it have been resolved. For example, if you have an important Ticket open, you must respond to the Ticket to dismiss the Notification.\n","operationId":"getNotifications","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Notification"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of Notification objects."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Notifications List","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/notifications\n"},{"lang":"CLI","source":"linode-cli account notifications-list\n"}],"x-linode-cli-action":"notifications-list","x-linode-grant":"read_only"},"x-linode-cli-command":"account"},"/account/oauth-clients":{"get":{"description":"Returns a paginated list of OAuth Clients registered to your Account. OAuth Clients allow users to log into applications you write or host using their Linode Account, and may allow them to grant some level of access to their Linodes or other entities to your application.\n","operationId":"getClients","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OAuthClient"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of OAuth Clients."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"OAuth Clients List","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/oauth-clients\n"},{"lang":"CLI","source":"linode-cli account clients-list\n"}],"x-linode-cli-action":"clients-list","x-linode-grant":"read_only"},"post":{"description":"Creates an OAuth Client, which can be used to allow users (using their Linode account) to log in to your own application, and optionally grant your application some amount of access to their Linodes or other entities.\n","operationId":"createClient","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OAuthClient"}],"required":["label","redirect_uri"]}}},"description":"Information about the OAuth Client to create."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthClient"}}},"description":"Client created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"OAuth Client Create","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"redirect_uri\": \"https://example.org/oauth/callback\",\n \"label\": \"Test_Client_1\",\n \"public\": false\n }' \\\n https://api.linode.com/v4/account/oauth-clients\n"},{"lang":"CLI","source":"linode-cli account client-create \\\n --label Test_Client_1 \\\n --redirect_uri https://example.org/callback\n"}],"x-linode-cli-action":"client-create"},"x-linode-cli-command":"account"},"/account/oauth-clients/{clientId}":{"delete":{"description":"Deletes an OAuth Client registered with Linode. The Client ID and Client secret will no longer be accepted by https://login.linode.com, and all tokens issued to this client will be invalidated (meaning that if your application was using a token, it will no longer work).\n","operationId":"deleteClient","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Client deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"OAuth Client Delete","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/account/oauth-clients/edc6790ea9db4d224c5c\n"},{"lang":"CLI","source":"linode-cli account client-delete \\\n edc6790ea9db4d224c5c\n"}],"x-linode-cli-action":"client-delete"},"get":{"description":"Returns information about a single OAuth client.\n","operationId":"getClient","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthClient"}}},"description":"Information about the requested client."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"OAuth Client View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/oauth-clients/edc6790ea9db4d224c5c\n"},{"lang":"CLI","source":"linode-cli account client-view \\\n edc6790ea9db4d224c5c\n"}],"x-linode-cli-action":"client-view"},"parameters":[{"description":"The OAuth Client ID to look up.","in":"path","name":"clientId","required":true,"schema":{"type":"string"}}],"put":{"description":"Update information about an OAuth Client on your Account. This can be especially useful to update the `redirect_uri` of your client in the event that the callback url changed in your application.\n","operationId":"updateClient","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthClient"}}},"description":"The fields to update."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthClient"}}},"description":"Client updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"OAuth Client Update","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"redirect_uri\": \"https://example.org/oauth/callback\",\n \"label\": \"Test_Client_1\"\n }\n }' \\\n https://api.linode.com/v4/account/oauth-clients/edc6790ea9db4d224c5c\n"},{"lang":"CLI","source":"linode-cli account client-update \\\n edc6790ea9db4d224c5c \\\n --label Test_Client_1\n"}],"x-linode-cli-action":"client-update"},"x-linode-cli-command":"account"},"/account/oauth-clients/{clientId}/reset-secret":{"parameters":[{"description":"The OAuth Client ID to look up.","in":"path","name":"clientId","required":true,"schema":{"type":"string"}}],"post":{"description":"Resets the OAuth Client secret for a client you own, and returns the OAuth Client with the plaintext secret. This secret is not supposed to be publicly known or disclosed anywhere. This can be used to generate a new secret in case the one you have has been leaked, or to get a new secret if you lost the original. The old secret is expired immediately, and logins to your client with the old secret will fail.\n","operationId":"resetClientSecret","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthClient"}}},"description":"Client secret reset successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"OAuth Client Secret Reset","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/account/oauth-clients/edc6790ea9db4d224c5c/reset-secret\n"},{"lang":"CLI","source":"linode-cli account client-reset-secret \\\n edc6790ea9db4d224c5c\n"}],"x-linode-cli-action":"client-reset-secret"},"x-linode-cli-command":"account"},"/account/oauth-clients/{clientId}/thumbnail":{"get":{"description":"Returns the thumbnail for this OAuth Client. This is a publicly-viewable endpoint, and can be accessed without authentication.\n","operationId":"getClientThumbnail","responses":{"200":{"content":{"image/png":{"schema":{"format":"binary","type":"string"}}},"description":"The client's thumbnail."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"OAuth Client Thumbnail View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/oauth-clients/edc6790ea9db4d224c5c/thumbnail > thumbnail.png\n"}],"x-linode-cli-action":"client-thumbnail","x-linode-cli-skip":true},"parameters":[{"description":"The OAuth Client ID to look up.","in":"path","name":"clientId","required":true,"schema":{"type":"string"}}],"put":{"description":"Upload a thumbnail for a client you own. You must upload an image file that will be returned when the thumbnail is retrieved. This image will be publicly-viewable.\n","operationId":"setClientThumbnail","requestBody":{"content":{"image/png":{"schema":{"format":"binary","type":"string"}}},"description":"The image to set as the thumbnail.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Thumbnail updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"OAuth Client Thumbnail Update","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: image/png\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT \\\n --data-binary \"@/path/to/image\"\n https://api.linode.com/v4/account/oauth-clients/edc6790ea9db4d224c5c/thumbnail\n"}],"x-linode-cli-action":"update-client-thumbnail","x-linode-cli-skip":true},"x-linode-cli-command":"account"},"/account/payment-methods":{"get":{"description":"Returns a paginated list of Payment Methods for this Account.\n","operationId":"getPaymentMethods","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentMethod"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of Payment Method objects."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Payment Methods List","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/payment-methods\n"},{"lang":"CLI","source":"linode-cli payment-methods list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Adds a Payment Method to your Account with the option to set it as the default method.\n\n* Adding a default Payment Method removes the default status from any other Payment Method.\n\n* An Account can have up to 6 active Payment Methods.\n\n* Up to 60 Payment Methods can be added each day.\n\n* Prior to adding a Payment Method, ensure that your billing address information is up-to-date\nwith a valid `zip` by using the Account Update ([PUT /account](/docs/api/account/#account-update)) endpoint.\n\n* A `payment_method_add` event is generated when a payment is successfully submitted.\n","operationId":"createPaymentMethod","requestBody":{"content":{"application/json":{"schema":{"description":"Payment Method Request Object.","properties":{"data":{"$ref":"#/components/schemas/CreditCard"},"is_default":{"$ref":"#/components/schemas/PaymentMethod/properties/is_default"},"type":{"description":"The type of Payment Method.\n\nAlternative Payment Methods including Google Pay and PayPal can be added using the Cloud Manager. See the [Manage Payment Methods](/docs/products/platform/billing/guides/payment-methods/) guide\nfor details and instructions.\n","enum":["credit_card"],"example":"credit_card","type":"string"}},"required":["type","data","is_default"],"type":"object"}}},"description":"The details of the Payment Method to add.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Payment Method added."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Payment Method Add","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"type\": \"credit_card\",\n \"is_default\": true,\n \"data\": {\n \"card_number\": \"4111111111111111\",\n \"expiry_month\": 11,\n \"expiry_year\": 2020,\n \"cvv\": \"111\"\n }\n }' \\\n https://api.linode.com/v4/account/payment-methods\n"},{"lang":"CLI","source":"linode-cli payment-methods add \\\n --type credit_card \\\n --is_default true \\\n --data.card_number 4111111111111111 \\\n --data.expiry_month 11 \\\n --data.expiry_year 2020 \\\n --data.cvv 111\n"}],"x-linode-cli-action":"add","x-linode-grant":"read_write"},"x-linode-cli-command":"payment-methods"},"/account/payment-methods/{paymentMethodId}":{"delete":{"description":"Deactivate the specified Payment Method.\n\nThe default Payment Method can not be deleted. To add a new default Payment Method, access the Payment Method\nAdd ([POST /account/payment-methods](/docs/api/account/#payment-method-add)) endpoint. To designate an existing\nPayment Method as the default method, access the Payment Method Make Default\n([POST /account/payment-methods/{paymentMethodId}/make-default](/docs/api/account/#payment-method-make-default))\nendpoint.\n","operationId":"deletePaymentMethod","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Payment Method deactivated."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Payment Method Delete","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/account/payment-methods/123\n"},{"lang":"CLI","source":"linode-cli payment-methods delete 123\n"}],"x-linode-cli-action":["delete","rm"],"x-linode-grant":"read_write"},"get":{"description":"View the details of the specified Payment Method.\n","operationId":"getPaymentMethod","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}},"description":"Returns a Payment Method Object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Payment Method View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/payment-methods/123\n"},{"lang":"CLI","source":"linode-cli payment-methods view 123\n"}],"x-linode-cli-action":"view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Payment Method to look up.","in":"path","name":"paymentMethodId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"payment-methods"},"/account/payment-methods/{paymentMethodId}/make-default":{"parameters":[{"description":"The ID of the Payment Method to make default.","in":"path","name":"paymentMethodId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Make the specified Payment Method the default method for automatically processing payments.\n\nRemoves the default status from any other Payment Method.\n","operationId":"makePaymentMethodDefault","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Payment Method successfully set as the default method."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Payment Method Make Default","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/account/payment-methods/123/make-default\n"},{"lang":"CLI","source":"linode-cli payment-methods default 123\n"}],"x-linode-cli-action":"default","x-linode-grant":"read_write"},"x-linode-cli-command":"payment-methods"},"/account/payments":{"get":{"description":"Returns a paginated list of Payments made on this Account.\n","operationId":"getPayments","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Payment"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of Payment objects."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Payments List","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/payments\n"},{"lang":"CLI","source":"linode-cli account payments-list\n"}],"x-linode-cli-action":"payments-list","x-linode-grant":"read_only"},"post":{"description":"Makes a Payment to your Account.\n\n* The requested amount is charged to the default Payment Method if no `payment_method_id` is specified.\n\n* A `payment_submitted` event is generated when a payment is successfully submitted.\n","operationId":"createPayment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}},"description":"Information about the Payment you are making.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}},"description":"Payment submitted successfully."},"202":{"$ref":"#/components/responses/AcceptedResponse"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Payment Make","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"cvv\": \"123\",\n \"usd\": \"120.50\",\n \"payment_method_id\": 123\n }' \\\n https://api.linode.com/v4/account/payments\n"},{"lang":"CLI","source":"linode-cli account payment-create \\\n --cvv 123 \\\n --usd 120.50 \\\n --payment_method_id 123\n"}],"x-linode-cli-action":"payment-create","x-linode-grant":"read_write"},"x-linode-cli-command":"account"},"/account/payments/paypal":{"post":{"deprecated":true,"description":"**Note**: This endpoint is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](/docs/products/platform/billing/guides/payment-methods/).\n","operationId":"createPayPalPayment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPal"}}},"description":"The amount of the Payment to submit via PayPal.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"checkout_token":{"description":"The checkout token generated for this Payment.\n","example":"EC-1A2B3C4D5E6F7G8H9","readOnly":true,"type":"string"},"payment_id":{"description":"The paypal-generated ID for this Payment. Used when authorizing the Payment in PayPal's interface.\n","example":"PAY-1234567890ABCDEFGHIJKLMN","type":"string"}},"type":"object"}}},"description":"PayPal Payment staged."},"299":{"$ref":"#/components/responses/DeprecatedResponse"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"PayPal Payment Stage","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"usd\": \"120.50\",\n \"redirect_url\": \"https://example.org\",\n \"cancel_url\": \"https://example.org\"\n }' \\\n https://api.linode.com/v4/account/payments/paypal\n"},{"lang":"CLI","source":"linode-cli account paypal-start \\\n --cancel_url https://example.org \\\n --redirect_url https://example.org \\\n --usd 120.50\n"}],"x-linode-cli-action":"paypal-start","x-linode-cli-skip":true,"x-linode-grant":"read_only"},"x-linode-cli-command":"account"},"/account/payments/paypal/execute":{"post":{"deprecated":true,"description":"**Note**: This endpoint is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](/docs/products/platform/billing/guides/payment-methods/).\n","operationId":"executePayPalPayment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPalExecute"}}},"description":"The details of the Payment to execute.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"PayPal Payment executed."},"202":{"$ref":"#/components/responses/AcceptedResponse"},"299":{"$ref":"#/components/responses/DeprecatedResponse"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Staged/Approved PayPal Payment Execute","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"payment_id\": \"PAY-1234567890ABCDEFGHIJKLMN\",\n \"payer_id\": \"ABCDEFGHIJKLM\"\n }' \\\n https://api.linode.com/v4/account/payments/paypal\n"},{"lang":"CLI","source":"linode-cli account paypal-execute\n"}],"x-linode-cli-action":"paypal-execute","x-linode-cli-skip":true,"x-linode-grant":"read_write"},"x-linode-cli-command":"account"},"/account/payments/{paymentId}":{"get":{"description":"Returns information about a specific Payment.\n","operationId":"getPayment","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}},"description":"A Payment object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Payment View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/payments/123\n"},{"lang":"CLI","source":"linode-cli account payment-view 123\n"}],"x-linode-cli-action":"payment-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Payment to look up.","in":"path","name":"paymentId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"account"},"/account/promo-codes":{"post":{"description":"Adds an expiring Promo Credit to your account.\n\nThe following restrictions apply:\n\n* Your account must be less than 90 days old.\n* There must not be an existing Promo Credit already on your account.\n* The requesting User must be unrestricted. Use the User Update\n ([PUT /account/users/{username}](/docs/api/account/#user-update)) to change a User's restricted status.\n* The `promo_code` must be valid and unexpired.\n","operationId":"createPromoCredit","requestBody":{"content":{"application/json":{"schema":{"properties":{"promo_code":{"description":"The Promo Code.\n","maxLength":32,"minLength":1,"type":"string"}},"required":["promo_code"],"type":"object"}}},"description":"Enter a Promo Code to add its associated credit to your Account."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}},"description":"Promo Credit successfully added.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Promo Credit Add","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"promo_code\": \"abcdefABCDEF1234567890\"\n }' \\\n https://api.linode.com/v4/account/promo-codes\n"},{"lang":"CLI","source":"linode-cli account \\\n promo-add \\\n --promo-code abcdefABCDEF1234567890\n"}],"x-linode-cli-action":"promo-add","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"account"},"/account/service-transfers":{"get":{"description":"Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getServiceTransfers","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ServiceTransfer"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of Service Transfer objects containing the details of all transfers that have been created and accepted by this account.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Service Transfers List","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/service-transfers\n"},{"lang":"CLI","source":"linode-cli service-transfers \\\n list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"unrestricted only"},"post":{"description":"Creates a transfer request for the specified services. A request can contain any of the specified service types\nand any number of each service type. At this time, only Linodes can be transferred.\n\nWhen created successfully, a confirmation email is sent to the account that created this transfer containing a\ntransfer token and instructions on completing the transfer.\n\nWhen a transfer is [accepted](/docs/api/account/#service-transfer-accept), the requested services are moved to\nthe receiving account. Linode services will not experience interruptions due to the transfer process. Backups\nfor Linodes are transferred as well.\n\nDNS records that are associated with requested services will not be transferred or updated. Please ensure that\nassociated DNS records have been updated or communicated to the recipient prior to the transfer.\n\nA transfer can take up to three hours to complete once accepted. When a transfer is\ncompleted, billing for transferred services ends for the sending account and begins for the receiving account.\n\nThis command can only be accessed by the unrestricted users of an account.\n\nThere are several conditions that must be met in order to successfully create a transfer request:\n\n1. The account creating the transfer must not have a past due balance or active Terms of Service violation.\n\n1. The service must be owned by the account that is creating the transfer.\n\n1. The service must not be assigned to another Service Transfer that is pending or that has been accepted and is\nincomplete.\n\n1. Linodes must not:\n\n * be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service.\n\n * have any attached Block Storage Volumes.\n\n * have any shared IP addresses.\n\n * have any assigned /56, /64, or /116 IPv6 ranges.\n","operationId":"createServiceTransfer","requestBody":{"content":{"application/json":{"schema":{"properties":{"entities":{"$ref":"#/components/schemas/ServiceTransfer/properties/entities"}},"required":["entities"],"type":"object"}}},"description":"The services to include in this transfer request."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceTransfer"}}},"description":"Returns a Service Transfer object for the request.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Service Transfer Create","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"entities\": {\n \"linodes\": [\n 111,\n 222\n ]\n }\n }' \\\n https://api.linode.com/v4/account/service-transfers\n"},{"lang":"CLI","source":"linode-cli service-transfers \\\n create \\\n --entities.linodes 111 \\\n --entities.linodes 222\n"}],"x-linode-cli-action":"create","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"service-transfers"},"/account/service-transfers/{token}":{"delete":{"description":"Cancels the Service Transfer for the provided token. Once cancelled, a transfer cannot be accepted or otherwise\nacted on in any way. If cancelled in error, the transfer must be\n[created](/docs/api/account/#service-transfer-create) again.\n\nWhen cancelled, an email notification for the cancellation is sent to the account that created\nthis transfer. Transfers can not be cancelled if they are expired or have been accepted.\n\nThis command can only be accessed by the unrestricted users of the account that created this transfer.\n","operationId":"deleteServiceTransfer","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Service Transfer cancelled.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Service Transfer Cancel","tags":["account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/account/service-transfers/123E4567-E89B-12D3-A456-426614174000\n"},{"lang":"CLI","source":"linode-cli service-transfers \\\n cancel 123E4567-E89B-12D3-A456-426614174000\n"}],"x-linode-cli-action":"cancel","x-linode-grant":"unrestricted only"},"get":{"description":"Returns the details of the Service Transfer for the provided token.\n\nWhile a transfer is pending, any unrestricted user *of any account* can access this command. After a\ntransfer has been accepted, it can only be viewed by unrestricted users of the accounts that created and\naccepted the transfer. If cancelled or expired, only unrestricted users of the account that created the\ntransfer can view it.\n","operationId":"getServiceTransfer","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceTransfer"}}},"description":"Returns a Service Transfer object containing the details of the transfer for the specified token.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Service Transfer View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/service-transfers/123E4567-E89B-12D3-A456-426614174000\n"},{"lang":"CLI","source":"linode-cli service-transfers \\\n view 123E4567-E89B-12D3-A456-426614174000\n"}],"x-linode-cli-action":"view","x-linode-grant":"unrestricted only"},"parameters":[{"description":"The UUID of the Service Transfer.","in":"path","name":"token","required":true,"schema":{"format":"uuid","type":"string"}}],"x-linode-cli-command":"service-transfers"},"/account/service-transfers/{token}/accept":{"parameters":[{"description":"The UUID of the Service Transfer.","in":"path","name":"token","required":true,"schema":{"format":"uuid","type":"string"}}],"post":{"description":"Accept a Service Transfer for the provided token to receive the services included in the transfer to your\naccount. At this time, only Linodes can be transferred.\n\nWhen accepted, email confirmations are sent to the accounts that created and accepted the transfer. A transfer\ncan take up to three hours to complete once accepted. Once a transfer is completed, billing for transferred\nservices ends for the sending account and begins for the receiving account.\n\nThis command can only be accessed by the unrestricted users of the account that receives the transfer. Users\nof the same account that created a transfer cannot accept the transfer.\n\nThere are several conditions that must be met in order to accept a transfer request:\n\n1. Only transfers with a `pending` status can be accepted.\n\n1. The account accepting the transfer must have a registered payment method and must not have a past due\n balance or other account limitations for the services to be transferred.\n\n1. Both the account that created the transfer and the account that is accepting the transfer must not have any\nactive Terms of Service violations.\n\n1. The service must still be owned by the account that created the transfer.\n\n1. Linodes must not:\n\n * be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service.\n\n * have any attached Block Storage Volumes.\n\n * have any shared IP addresses.\n\n * have any assigned /56, /64, or /116 IPv6 ranges.\n\nAny and all of the above conditions must be cured and maintained by the relevant account prior to the\ntransfer's expiration to allow the transfer to be accepted by the receiving account.\n","operationId":"acceptServiceTransfer","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Service Transfer accepted.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Service Transfer Accept","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/account/service-transfers/123E4567-E89B-12D3-A456-426614174000/accept\n"},{"lang":"CLI","source":"linode-cli service-transfers \\\n accept 123E4567-E89B-12D3-A456-426614174000\n"}],"x-linode-cli-action":"accept","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"service-transfers"},"/account/settings":{"get":{"description":"Returns information related to your Account settings: Managed service subscription, Longview subscription, and network helper.\n","operationId":"getAccountSettings","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSettings"}}},"description":"Returns a single Account settings object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Account Settings View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/settings\n"},{"lang":"CLI","source":"linode-cli account settings\n"}],"x-linode-cli-action":"settings","x-linode-grant":"read_only"},"put":{"description":"Updates your Account settings.\n\nTo update your Longview subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#longview-plan-update).\n","operationId":"updateAccountSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSettings"}}},"description":"Update Account settings information.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSettings"}}},"description":"The updated Account settings."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Account Settings Update","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"network_helper\": true,\n }' \\\n https://api.linode.com/v4/account/settings\n"},{"lang":"CLI","source":"linode-cli account settings-update \\\n --network_helper false\n"}],"x-linode-cli-action":"settings-update","x-linode-grant":"read_write"},"x-linode-cli-command":"account"},"/account/settings/managed-enable":{"post":{"description":"Enables Linode Managed for the entire account and sends a welcome email to the account's associated email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See our [Linode Managed guide](/docs/guides/linode-managed/) to learn more.\n","operationId":"enableAccountManaged","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Managed services enabled for account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Linode Managed Enable","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/account/settings/managed-enable\n"},{"lang":"CLI","source":"linode-cli account enable-managed\n"}],"x-linode-cli-action":"enable-managed","x-linode-grant":"read_write"},"x-linode-cli-command":"account"},"/account/transfer":{"get":{"description":"Returns a Transfer object showing your network utilization, in GB, for the current month.\n","operationId":"getTransfer","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transfer"}}},"description":"Returns a single Transfer object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Network Utilization View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/transfer\n"},{"lang":"CLI","source":"linode-cli account transfer\n"}],"x-linode-cli-action":"transfer","x-linode-grant":"read_only"},"x-linode-cli-command":"account"},"/account/users":{"get":{"description":"Returns a paginated list of Users on your Account.\n\nThis command can only be accessed by the unrestricted users of an account.\n\nUsers may access all or part of your Account based on their restricted status and grants. An unrestricted User may access everything on the account, whereas restricted User may only access entities or perform actions they've been given specific grants to.\n","operationId":"getUsers","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/User"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of Users."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Users List","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/users\n"},{"lang":"CLI","source":"linode-cli users list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"unrestricted only"},"post":{"description":"Creates a User on your Account. Once created, a confirmation message containing\npassword creation and login instructions is sent to the User's email address.\n\nThis command can only be accessed by the unrestricted users of an account.\n\nThe User's account access is determined by whether or not they are restricted,\nand what grants they have been given.\n","operationId":"createUser","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}],"required":["username","email"]}}},"description":"Information about the User to create."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"New User created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"User Create","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"username\": \"example_user\",\n \"email\": \"person@place.com\",\n \"restricted\": true\n }' \\\n https://api.linode.com/v4/account/users\n"},{"lang":"CLI","source":"linode-cli users create \\\n --username example_user \\\n --email example_user@linode.com \\\n --restricted true\n"}],"x-linode-cli-action":"create","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"users"},"/account/users/{username}":{"delete":{"description":"Deletes a User. The deleted User will be immediately logged out and\nmay no longer log in or perform any actions. All of the User's Grants\nwill be removed.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"deleteUser","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"User deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"User Delete","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/account/users/example_user\n"},{"lang":"CLI","source":"linode-cli users delete example_user\n"}],"x-linode-cli-action":["delete","rm"],"x-linode-grant":"unrestricted only"},"get":{"description":"Returns information about a single User on your Account.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getUser","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"The requested User object"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"User View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/users/example_user\n"},{"lang":"CLI","source":"linode-cli users view example_user\n"}],"x-linode-cli-action":"view","x-linode-grant":"unrestricted only"},"parameters":[{"description":"The username to look up.","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"put":{"description":"Update information about a User on your Account. This can be used to\nchange the restricted status of a User. When making a User restricted,\nno grants will be configured by default and you must then set up grants\nin order for the User to access anything on the Account.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"updateUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"The information to update."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"User updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"User Update","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"username\": example_user,\n \"email\": example@linode.com,\n \"restricted\": true\n }' \\\n https://api.linode.com/v4/account/users/example_user\n"},{"lang":"CLI","source":"linode-cli users update example_user \\\n --username example_user \\\n --email example@linode.com \\\n --restricted true\n"}],"x-linode-cli-action":"update","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"users"},"/account/users/{username}/grants":{"get":{"description":"Returns the full grants structure for the specified account User\n(other than the account owner, see below for details). This includes all entities\non the Account alongside the level of access this User has to each of them.\n\nThis command can only be accessed by the unrestricted users of an account.\n\nThe current authenticated User, including the account owner, may view their\nown grants at the [/profile/grants](/docs/api/profile/#grants-list)\nendpoint, but will not see entities that they do not have access to.\n","operationId":"getUserGrants","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantsResponse"}}},"description":"The User's grants."},"204":{"description":"This is an unrestricted User, and therefore has no grants to return. This User may access everything on the Account and perform all actions.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"User's Grants View","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/account/users/example_user/grants\n"}],"x-linode-cli-action":"grants","x-linode-cli-skip":true,"x-linode-grant":"unrestricted only"},"parameters":[{"description":"The username to look up.","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"put":{"description":"Update the grants a User has. This can be used to give a User access\nto new entities or actions, or take access away. You do not need to\ninclude the grant for every entity on the Account in this request; any\nthat are not included will remain unchanged.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"updateUserGrants","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantsResponse"}}},"description":"The grants to update. Omitted grants will be left unchanged.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantsResponse"}}},"description":"Grants updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"User's Grants Update","tags":["Account"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"global\": {\n \"add_linodes\": true,\n \"add_nodebalancers\": false,\n \"add_databases\": true;\n \"add_domains\": true,\n \"add_longview\": false,\n \"add_stackscripts\": true,\n \"longview_subscription\": true,\n \"add_images\": true,\n \"add_volumes\": true,\n \"add_firewalls\": true,\n \"account_access\": \"read_only\",\n \"cancel_account\": false\n },\n \"domain\": [\n {\n \"id\": 123,\n \"permissions\": \"read_only\"\n }\n ],\n \"image\": [\n {\n \"id\": 123,\n \"permissions\": \"read_only\"\n }\n ],\n \"linode\": [\n {\n \"id\": 123,\n \"permissions\": \"read_only\"\n },\n {\n \"id\": 234,\n \"permissions\": \"read_write\"\n },\n {\n \"id\": 345,\n \"permissions\": \"read_only\"\n },\n ],\n \"longview\": [\n {\n \"id\": 123,\n \"permissions\": \"read_only\"\n },\n {\n \"id\": 234,\n \"permissions\": \"read_write\"\n }\n ],\n \"nodebalancer\": [\n {\n \"id\": 123,\n \"permissions\": \"read_write\"\n }\n ],\n \"stackscript\": [\n {\n \"id\": 123,\n \"permissions\": \"read_only\"\n },\n {\n \"id\": 124,\n \"permissions\": \"read_write\"\n }\n ],\n \"volume\": [\n {\n \"id\": 123,\n \"permissions\": \"read_only\"\n }\n ]\n }' \\\n https://api.linode.com/v4/account/users/example_user/grants\n"}],"x-linode-cli-action":"update-grants","x-linode-cli-skip":true,"x-linode-grant":"unrestricted only"},"x-linode-cli-command":"users"},"/databases/engines":{"get":{"description":"Display all available Managed Database engine types and versions. Engine IDs are used when creating new Managed Databases.\n","operationId":"getDatabasesEngines","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationEnvelope"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatabaseEngine"},"type":"array"}},"type":"object"}]}}},"description":"Returns a paginated list of all available Managed Database engines and versions."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed Database Engines List","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/databases/engines/\n"},{"lang":"CLI","source":"linode-cli databases engines\n"}],"x-linode-cli-action":"engines"},"x-linode-cli-command":"databases"},"/databases/engines/{engineId}":{"get":{"description":"Display information for a single Managed Database engine type and version.\n","operationId":"getDatabasesEngine","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseEngine"}}},"description":"Returns information for a single Managed Database engine type and version."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed Database Engine View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/databases/engines/mysql/5.7.30\n"},{"lang":"CLI","source":"linode-cli databases engine-view mysql/5.7.30\n"}],"x-linode-cli-action":"engine-view"},"parameters":[{"description":"The ID of the Managed Database engine.","in":"path","name":"engineId","required":true,"schema":{"type":"string"}}],"x-linode-cli-command":"databases"},"/databases/instances":{"get":{"description":"Display all Managed Databases that are accessible by your User, regardless of engine type.\n\nFor more detailed information on a particular Database instance, make a request to its `instance_uri`.\n","operationId":"getDatabasesInstances","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationEnvelope"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Database"},"type":"array"}},"type":"object"}]}}},"description":"Returns a paginated list of all accessible Managed Databases on your Account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed Databases List All","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/instances\n"},{"lang":"CLI","source":"linode-cli databases list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"x-linode-cli-command":"databases"},"/databases/mongodb/instances":{"get":{"description":"Display all accessible Managed MongoDB Databases.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"getDatabasesMongoDBInstances","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationEnvelope"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatabaseMongoDB"},"type":"array"}},"type":"object"}]}}},"description":"Returns a paginated list of all accessible Managed MongoDB Databases on your Account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Databases List","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mongodb/instances/\n"},{"lang":"CLI","source":"linode-cli databases mongodb-list\n"}],"x-linode-cli-action":"mongodb-list","x-linode-grant":"read_only"},"x-linode-cli-command":"databases"},"/databases/mongodb/instances/{instanceId}":{"delete":{"description":"Remove a Managed MongoDB Database from your Account.\n\nRequires `read_write` access to the Database.\n\nThe Database must have an `active`, `failed`, or `degraded` status to perform this command.\n\nOnly unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"deleteDatabasesMongoDBInstance","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Managed MongoDB Database successfully deleted."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database Delete","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/databases/mongodb/instances/123\n"},{"lang":"CLI","source":"linode-cli databases mongodb-delete 123\n"}],"x-linode-cli-action":"mongodb-delete","x-linode-grant":"read_write"},"get":{"description":"Display information for a single, accessible Managed MongoDB Database.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"getDatabasesMongoDBInstance","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseMongoDB"}}},"description":"Returns information for a single Managed MongoDB Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mongodb/instances/123\n"},{"lang":"CLI","source":"linode-cli databases mongodb-view 123\n"}],"x-linode-cli-action":"mongodb-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed MongoDB Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Update a Managed MongoDB Database.\n\nRequires `read_write` access to the Database.\n\nThe Database must have an `active` status to perform this command.\n\nUpdating addresses in the `allow_list` overwrites any existing addresses.\n\n* IP addresses and ranges on this list can access the Managed Database. All other sources are blocked.\n\n* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.\n\n* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.\n\n* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.\n\nAll Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MongoDB Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.\n\n* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.\n\n* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"putDatabasesMongoDBInstance","requestBody":{"content":{"application/json":{"schema":{"description":"Updated information for the Managed MongoDB Database.","properties":{"allow_list":{"$ref":"#/components/schemas/Database/properties/allow_list"},"label":{"$ref":"#/components/schemas/DatabaseMongoDB/properties/label"},"updates":{"$ref":"#/components/schemas/Database/properties/updates"}},"type":"object"}}},"description":"Updated information for the Managed MongoDB Database.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseMongoDB"}}},"description":"Managed Database updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database Update","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"example-db\",\n \"allow_list\": [\n \"203.0.113.1\",\n \"192.0.1.0/24\"\n ],\n \"updates\" = {\n \"frequency\": \"monthly\",\n \"duration\": 3,\n \"hour_of_day\": 12,\n \"day_of_week\": 4,\n \"week_of_month\": 3,\n }\n }' \\\n https://api.linode.com/v4/databases/mongodb/instances/123\n"},{"lang":"CLI","source":"linode-cli databases mongodb-update 123 \\\n --label example-db \\\n --allow_list 203.0.113.1 \\\n --allow_list 192.0.1.0/24 \\\n --updates.frequency monthly \\\n --updates.duration 3 \\\n --updates.hour_of_day 12 \\\n --updates.day_of_week 4 \\\n --updates.week_of_month 3\n"}],"x-linode-cli-action":"mongodb-update","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/mongodb/instances/{instanceId}/backups":{"get":{"description":"Display all backups for an accessible Managed MongoDB Database.\n\nThe Database must not be provisioning to perform this command.\n\nDatabase `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.\n\nDatabase `snapshot` type backups are created by accessing the **Managed MongoDB Database Backup Snapshot Create** ([POST /databases/mongodb/instances/{instanceId}/backups](/docs/api/databases/#managed-mongodb-database-backup-snapshot-create)) command.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"getDatabasesMongoDBInstanceBackups","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationEnvelope"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatabaseBackup"},"type":"array"}},"type":"object"}]}}},"description":"Returns a paginated list of backups for the Managed MongoDB Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database Backups List","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mongodb/instances/123/backups\n"},{"lang":"CLI","source":"linode-cli databases mongodb-backups-list 123\n"}],"x-linode-cli-action":"mongodb-backups-list","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed MongoDB Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Creates a snapshot backup of a Managed MongoDB Database.\n\nRequires `read_write` access to the Database.\n\nUp to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.\n\nBackups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.\n\nThe Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"postDatabasesMongoDBInstanceBackup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseBackupSnapshot"}}},"description":"Information about the snapshot backup to create."},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Database snapshot backup request successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database Backup Snapshot Create","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -X POST -d '{\n \"label\": \"snapshot1\",\n \"target\": \"primary\"\n }' \\\n https://api.linode.com/v4/databases/mongodb/instances/123/backups/\n"},{"lang":"CLI","source":"linode-cli databases mongodb-backup-snapshot 123 \\\n --label snapshot1 \\\n --target primary\n"}],"x-linode-cli-action":"mongodb-backup-snapshot","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/mongodb/instances/{instanceId}/backups/{backupId}":{"delete":{"description":"Delete a single backup for an accessible Managed MongoDB Database.\n\nRequires `read_write` access to the Database.\n\nThe Database must not be provisioning to perform this command.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"deleteDatabaseMongoDBInstanceBackup","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Request to delete Database backup successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database Backup Delete","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/databases/mongodb/instances/123/backups/456\n"},{"lang":"CLI","source":"linode-cli databases mongodb-backup-delete 123 456\n"}],"x-linode-cli-action":"mongodb-backup-delete"},"get":{"description":"Display information for a single backup for an accessible Managed MongoDB Database.\n\nThe Database must not be provisioning to perform this command.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"getDatabasesMongoDBInstanceBackup","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseBackup"}}},"description":"Returns a single backup for the Managed MongoDB Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database Backup View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mongodb/instances/123/backups/456\n"},{"lang":"CLI","source":"linode-cli databases mongodb-backup-view 123 456\n"}],"x-linode-cli-action":"mongodb-backup-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed MongoDB Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Managed MongoDB Database backup.","in":"path","name":"backupId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"databases"},"/databases/mongodb/instances/{instanceId}/backups/{backupId}/restore":{"parameters":[{"description":"The ID of the Managed MongoDB Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Managed MongoDB Database backup.","in":"path","name":"backupId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Restore a backup to a Managed MongoDB Database on your Account.\n\nRequires `read_write` access to the Database.\n\nThe Database must have an `active` status to perform this command.\n\n**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.\n\n**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"postDatabasesMongoDBInstanceBackupRestore","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Request to restore backup successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database Backup Restore","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST https://api.linode.com/v4/databases/mongodb/instances/123/backups/456/restore\n"},{"lang":"CLI","source":"linode-cli databases mongodb-backup-restore 123 456\n"}],"x-linode-cli-action":"mongodb-backup-restore","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/mongodb/instances/{instanceId}/credentials":{"get":{"description":"Display the root username and password for an accessible Managed MongoDB Database.\n\nThe Database must have an `active` status to perform this command.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"getDatabasesMongoDBInstanceCredentials","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseCredentials"}}},"description":"Managed Database root username and password."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database Credentials View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mongodb/instances/123/credentials/\n"},{"lang":"CLI","source":"linode-cli databases mongodb-creds-view 123\n"}],"x-linode-cli-action":"mongodb-creds-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed MongoDB Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"databases"},"/databases/mongodb/instances/{instanceId}/credentials/reset":{"parameters":[{"description":"The ID of the Managed MongoDB Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Reset the root password for a Managed MongoDB Database.\n\nRequires `read_write` access to the Database.\n\nA new root password is randomly generated and accessible with the **Managed MongoDB Database Credentials View** ([GET /databases/mongodb/instances/{instanceId}/credentials](/docs/api/databases/#managed-mongodb-database-credentials-view)) command.\n\nOnly unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.\n\n**Note**: Note that it may take several seconds for credentials to reset.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"postDatabasesMongoDBInstanceCredentialsReset","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Managed Database instance credentials successfully reset."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database Credentials Reset","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST https://api.linode.com/v4/databases/mongodb/instances/123/credentials/reset\n"},{"lang":"CLI","source":"linode-cli databases mongodb-creds-reset 123\n"}],"x-linode-cli-action":"mongodb-creds-reset","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/mongodb/instances/{instanceId}/patch":{"parameters":[{"description":"The ID of the Managed MongoDB Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Apply security patches and updates to the underlying operating system of the Managed MongoDB Database. This function runs during regular maintenance windows, which are configurable with the **Managed MongoDB Database Update** ([PUT /databases/mongodb/instances/{instanceId}](/docs/api/databases/#managed-mongodb-database-update)) command.\nRequires `read_write` access to the Database.\n\nThe Database must have an `active` status to perform this command.\n\n**Note**:\n\n* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.\n\n* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"postDatabasesMongoDBInstancePatch","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Managed Database instance patch request successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database Patch","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST https://api.linode.com/v4/databases/mongodb/instances/123/patch\n"},{"lang":"CLI","source":"linode-cli databases mongodb-patch 123\n"}],"x-linode-cli-action":"mongodb-patch","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/mongodb/instances/{instanceId}/ssl":{"get":{"description":"Display the SSL CA certificate for an accessible Managed MongoDB Database.\n\nThe Database must have an `active` status to perform this command.\n\n**Note**: New MongoDB Databases cannot currently be created.\n","operationId":"getDatabasesMongoDBInstanceSSL","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseSSL"}}},"description":"Returns the SSL CA certificate of a single Managed MongoDB Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MongoDB Database SSL Certificate View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mongodb/instances/123/ssl\n"},{"lang":"CLI","source":"linode-cli databases mongodb-ssl-cert 123\n"}],"x-linode-cli-action":"mongodb-ssl-cert","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed MongoDB Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"databases"},"/databases/mysql/instances":{"get":{"description":"Display all accessible Managed MySQL Databases.\n","operationId":"getDatabasesMySQLInstances","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationEnvelope"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatabaseMySQL"},"type":"array"}},"type":"object"}]}}},"description":"Returns a paginated list of all accessible Managed MySQL Databases on your Account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Databases List","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mysql/instances/\n"},{"lang":"CLI","source":"linode-cli databases mysql-list\n"}],"x-linode-cli-action":"mysql-list","x-linode-grant":"read_only"},"post":{"description":"Provision a Managed MySQL Database.\n\nRestricted Users must have the `add_databases` grant to use this command.\n\nNew instances can take approximately 15 to 30 minutes to provision.\n\nThe `allow_list` is used to control access to the Managed Database.\n\n* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.\n\n* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.\n\n* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.\n\nAll Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.\n\nAll Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database during configurable maintenance windows.\n\n* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.\n\n* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one.\n\n* To modify update the maintenance window for a Database, use the **Managed MySQL Database Update** ([PUT /databases/mysql/instances/{instanceId}](/docs/api/databases/#managed-mysql-database-update)) command.\n","operationId":"postDatabasesMySQLInstances","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseMySQLRequest"}}},"description":"Information about the Managed MySQL Database you are creating.","required":true,"x-linode-cli-allowed-defaults":["engine","region","type"]},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseMySQL"}}},"description":"A new Managed MySQL Database is provisioning."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database Create","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"example-db\",\n \"region\": \"us-east\",\n \"type\": \"g6-dedicated-2\",\n \"cluster_size\": 3,\n \"engine\": \"mysql/8.0.26\",\n \"encrypted\": false,\n \"ssl_connection\": true,\n \"replication_type\": \"semi_synch\",\n \"allow_list\": [\n \"203.0.113.1\",\n \"192.0.1.0/24\"\n ]\n }' \\\n https://api.linode.com/v4/databases/mysql/instances\n"},{"lang":"CLI","source":"linode-cli databases mysql-create \\\n --label example-db1 \\\n --region us-east \\\n --type g6-dedicated-2 \\\n --cluster_size 3 \\\n --engine mysql/8.0.26 \\\n --encrypted false \\\n --ssl_connection false \\\n --replication_type semi_synch \\\n --allow_list 203.0.113.1 \\\n --allow_list 192.0.1.0/24\n"}],"x-linode-cli-action":"mysql-create","x-linode-grant":"add_databases"},"x-linode-cli-command":"databases"},"/databases/mysql/instances/{instanceId}":{"delete":{"description":"Remove a Managed MySQL Database from your Account.\n\nRequires `read_write` access to the Database.\n\nThe Database must have an `active`, `failed`, or `degraded` status to perform this command.\n\nOnly unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.\n","operationId":"deleteDatabasesMySQLInstance","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Managed MySQL Database successfully deleted."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database Delete","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/databases/mysql/instances/123\n"},{"lang":"CLI","source":"linode-cli databases mysql-delete 123\n"}],"x-linode-cli-action":"mysql-delete","x-linode-grant":"read_write"},"get":{"description":"Display information for a single, accessible Managed MySQL Database.\n","operationId":"getDatabasesMySQLInstance","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseMySQL"}}},"description":"Returns information for a single Managed MySQL Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mysql/instances/123\n"},{"lang":"CLI","source":"linode-cli databases mysql-view 123\n"}],"x-linode-cli-action":"mysql-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed MySQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Update a Managed MySQL Database.\n\nRequires `read_write` access to the Database.\n\nThe Database must have an `active` status to perform this command.\n\nUpdating addresses in the `allow_list` overwrites any existing addresses.\n\n* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.\n\n* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.\n\n* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.\n\n* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.\n\nAll Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.\n\n* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.\n\n* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one.\n","operationId":"putDatabasesMySQLInstance","requestBody":{"content":{"application/json":{"schema":{"description":"Updated information for the Managed MySQL Database.","properties":{"allow_list":{"$ref":"#/components/schemas/Database/properties/allow_list"},"label":{"$ref":"#/components/schemas/DatabaseMySQL/properties/label"},"updates":{"$ref":"#/components/schemas/Database/properties/updates"}},"type":"object"}}},"description":"Updated information for the Managed MySQL Database.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseMySQL"}}},"description":"Managed Database updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database Update","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"example-db\",\n \"allow_list\": [\n \"203.0.113.1\",\n \"192.0.1.0/24\"\n ],\n \"updates\" = {\n \"frequency\": \"monthly\",\n \"duration\": 3,\n \"hour_of_day\": 12,\n \"day_of_week\": 4,\n \"week_of_month\": 3,\n }\n }' \\\n https://api.linode.com/v4/databases/mysql/instances/123\n"},{"lang":"CLI","source":"linode-cli databases mysql-update 123 \\\n --label example-db \\\n --allow_list 203.0.113.1 \\\n --allow_list 192.0.1.0/24 \\\n --updates.frequency monthly \\\n --updates.duration 3 \\\n --updates.hour_of_day 12 \\\n --updates.day_of_week 4 \\\n --updates.week_of_month 3\n"}],"x-linode-cli-action":"mysql-update","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/mysql/instances/{instanceId}/backups":{"get":{"description":"Display all backups for an accessible Managed MySQL Database.\n\nThe Database must not be provisioning to perform this command.\n\nDatabase `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.\n\nDatabase `snapshot` type backups are created by accessing the **Managed MySQL Database Backup Snapshot Create** ([POST /databases/mysql/instances/{instanceId}/backups](/docs/api/databases/#managed-mysql-database-backup-snapshot-create)) command.\n","operationId":"getDatabasesMySQLInstanceBackups","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationEnvelope"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatabaseBackup"},"type":"array"}},"type":"object"}]}}},"description":"Returns a paginated list of backups for the Managed MySQL Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database Backups List","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mysql/instances/123/backups\n"},{"lang":"CLI","source":"linode-cli databases mysql-backups-list 123\n"}],"x-linode-cli-action":"mysql-backups-list","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed MySQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Creates a snapshot backup of a Managed MySQL Database.\n\nRequires `read_write` access to the Database.\n\nUp to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.\n\nBackups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.\n\nThe Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.\n","operationId":"postDatabasesMySQLInstanceBackup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseBackupSnapshot"}}},"description":"Information about the snapshot backup to create."},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Database snapshot backup request successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database Backup Snapshot Create","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -X POST -d '{\n \"label\": \"snapshot1\",\n \"target\": \"primary\"\n }' \\\n https://api.linode.com/v4/databases/mysql/instances/123/backups/\n"},{"lang":"CLI","source":"linode-cli databases mysql-backup-snapshot 123 \\\n --label snapshot1 \\\n --target primary\n"}],"x-linode-cli-action":"mysql-backup-snapshot","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/mysql/instances/{instanceId}/backups/{backupId}":{"delete":{"description":"Delete a single backup for an accessible Managed MySQL Database.\n\nRequires `read_write` access to the Database.\n\nThe Database must not be provisioning to perform this command.\n","operationId":"deleteDatabaseMySQLInstanceBackup","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Request to delete Database backup successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database Backup Delete","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/databases/mysql/instances/123/backups/456\n"},{"lang":"CLI","source":"linode-cli databases mysql-backup-delete 123 456\n"}],"x-linode-cli-action":"mysql-backup-delete"},"get":{"description":"Display information for a single backup for an accessible Managed MySQL Database.\n\nThe Database must not be provisioning to perform this command.\n","operationId":"getDatabasesMySQLInstanceBackup","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseBackup"}}},"description":"Returns a single backup for the Managed MySQL Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database Backup View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mysql/instances/123/backups/456\n"},{"lang":"CLI","source":"linode-cli databases mysql-backup-view 123 456\n"}],"x-linode-cli-action":"mysql-backup-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed MySQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Managed MySQL Database backup.","in":"path","name":"backupId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"databases"},"/databases/mysql/instances/{instanceId}/backups/{backupId}/restore":{"parameters":[{"description":"The ID of the Managed MySQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Managed MySQL Database backup.","in":"path","name":"backupId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Restore a backup to a Managed MySQL Database on your Account.\n\nRequires `read_write` access to the Database.\n\nThe Database must have an `active` status to perform this command.\n\n**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.\n\n**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.\n","operationId":"postDatabasesMySQLInstanceBackupRestore","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Request to restore backup successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database Backup Restore","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST https://api.linode.com/v4/databases/mysql/instances/123/backups/456/restore\n"},{"lang":"CLI","source":"linode-cli databases mysql-backup-restore 123 456\n"}],"x-linode-cli-action":"mysql-backup-restore","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/mysql/instances/{instanceId}/credentials":{"get":{"description":"Display the root username and password for an accessible Managed MySQL Database.\n\nThe Database must have an `active` status to perform this command.\n","operationId":"getDatabasesMySQLInstanceCredentials","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseCredentials"}}},"description":"Managed Database root username and password."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database Credentials View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mysql/instances/123/credentials/\n"},{"lang":"CLI","source":"linode-cli databases mysql-creds-view 123\n"}],"x-linode-cli-action":"mysql-creds-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed MySQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"databases"},"/databases/mysql/instances/{instanceId}/credentials/reset":{"parameters":[{"description":"The ID of the Managed MySQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Reset the root password for a Managed MySQL Database.\n\nRequires `read_write` access to the Database.\n\nA new root password is randomly generated and accessible with the **Managed MySQL Database Credentials View** ([GET /databases/mysql/instances/{instanceId}/credentials](/docs/api/databases/#managed-mysql-database-credentials-view)) command.\n\nOnly unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.\n\n**Note**: Note that it may take several seconds for credentials to reset.\n","operationId":"postDatabasesMySQLInstanceCredentialsReset","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Managed Database instance credentials successfully reset."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database Credentials Reset","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST https://api.linode.com/v4/databases/mysql/instances/123/credentials/reset\n"},{"lang":"CLI","source":"linode-cli databases mysql-creds-reset 123\n"}],"x-linode-cli-action":"mysql-creds-reset","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/mysql/instances/{instanceId}/patch":{"parameters":[{"description":"The ID of the Managed MySQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Apply security patches and updates to the underlying operating system of the Managed MySQL Database. This function runs during regular maintenance windows, which are configurable with the **Managed MySQL Database Update** ([PUT /databases/mysql/instances/{instanceId}](/docs/api/databases/#managed-mysql-database-update)) command.\n\nRequires `read_write` access to the Database.\n\nThe Database must have an `active` status to perform this command.\n\n**Note**\n\n* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.\n\n* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one.\n","operationId":"postDatabasesMySQLInstancePatch","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Managed Database instance patch request successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database Patch","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST https://api.linode.com/v4/databases/mysql/instances/123/patch\n"},{"lang":"CLI","source":"linode-cli databases mysql-patch 123\n"}],"x-linode-cli-action":"mysql-patch","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/mysql/instances/{instanceId}/ssl":{"get":{"description":"Display the SSL CA certificate for an accessible Managed MySQL Database.\n\nThe Database must have an `active` status to perform this command.\n","operationId":"getDatabasesMySQLInstanceSSL","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseSSL"}}},"description":"Returns the SSL CA certificate of a single Managed MySQL Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed MySQL Database SSL Certificate View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/mysql/instances/123/ssl\n"},{"lang":"CLI","source":"linode-cli databases mysql-ssl-cert 123\n"}],"x-linode-cli-action":"mysql-ssl-cert","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed MySQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"databases"},"/databases/postgresql/instances":{"get":{"description":"Display all accessible Managed PostgreSQL Databases.\n","operationId":"getDatabasesPostgreSQLInstances","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationEnvelope"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatabasePostgreSQL"},"type":"array"}},"type":"object"}]}}},"description":"Returns a paginated list of all accessible Managed PostgreSQL Databases on your Account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Databases List","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/postgresql/instances/\n"},{"lang":"CLI","source":"linode-cli databases postgresql-list\n"}],"x-linode-cli-action":"postgresql-list","x-linode-grant":"read_only"},"post":{"description":"Provision a Managed PostgreSQL Database.\n\nRestricted Users must have the `add_databases` grant to use this command.\n\nNew instances can take approximately 15 to 30 minutes to provision.\n\nThe `allow_list` is used to control access to the Managed Database.\n\n* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.\n\n* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.\n\n* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.\n\nAll Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.\n\nAll Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database during configurable maintenance windows.\n\n* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.\n\n* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.\n\n* To modify update the maintenance window for a Database, use the **Managed PostgreSQL Database Update** ([PUT /databases/postgresql/instances/{instanceId}](/docs/api/databases/#managed-postgresql-database-update)) command.\n","operationId":"postDatabasesPostgreSQLInstances","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabasePostgreSQLRequest"}}},"description":"Information about the Managed PostgreSQL Database you are creating.","required":true,"x-linode-cli-allowed-defaults":["engine","region","type"]},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabasePostgreSQL"}}},"description":"A new Managed PostgreSQL Database is provisioning."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database Create","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\ -H \"Authorization: Bearer $TOKEN\" \\ -X POST -d '{\n \"label\": \"example-db\",\n \"region\": \"us-east\",\n \"type\": \"g6-dedicated-2\",\n \"cluster_size\": 3,\n \"engine\": \"postgresql/13.2\",\n \"encrypted\": false,\n \"ssl_connection\": false,\n \"replication_type\": \"asynch\",\n \"replication_commit_type\": \"local\",\n \"allow_list\": [\n \"203.0.113.1\",\n \"192.0.1.0/24\"\n ]\n}' \\ https://api.linode.com/v4/databases/postgresql/instances\n"},{"lang":"CLI","source":"linode-cli databases postgresql-create \\\n --label example-db \\\n --region us-east \\\n --type g6-dedicated-2 \\\n --cluster_size 3 \\\n --engine postgresql/13.2 \\\n --encrypted false \\\n --ssl_connection false \\\n --replication_type asynch \\\n --replication_commit_type local \\\n --allow_list 203.0.113.1 \\\n --allow_list 192.0.1.0/24\n"}],"x-linode-cli-action":"postgresql-create","x-linode-grant":"add_databases"},"x-linode-cli-command":"databases"},"/databases/postgresql/instances/{instanceId}":{"delete":{"description":"Remove a Managed PostgreSQL Database from your Account.\n\nRequires `read_write` access to the Database.\n\nThe Database must have an `active`, `failed`, or `degraded` status to perform this command.\n\nOnly unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.\n","operationId":"deleteDatabasesPostgreSQLInstance","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Managed PostgreSQL Database successfully deleted."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database Delete","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/databases/postgresql/instances/123\n"},{"lang":"CLI","source":"linode-cli databases postgresql-delete 123\n"}],"x-linode-cli-action":"postgresql-delete","x-linode-grant":"read_write"},"get":{"description":"Display information for a single, accessible Managed PostgreSQL Database.\n","operationId":"getDatabasesPostgreSQLInstance","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabasePostgreSQL"}}},"description":"Returns information for a single Managed PostgreSQL Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/postgresql/instances/123\n"},{"lang":"CLI","source":"linode-cli databases postgresql-view 123\n"}],"x-linode-cli-action":"postgresql-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed PostgreSQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Update a Managed PostgreSQL Database.\n\nRequires `read_write` access to the Database.\n\nThe Database must have an `active` status to perform this command.\n\nUpdating addresses in the `allow_list` overwrites any existing addresses.\n\n* IP addresses and ranges in this list can access the Managed Database. All other sources are blocked.\n\n* If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.\n\n* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.\n\n* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.\n\nAll Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.\n\n* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.\n\n* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.\n","operationId":"putDatabasesPostgreSQLInstance","requestBody":{"content":{"application/json":{"schema":{"description":"Updated information for the Managed PostgreSQL Database.","properties":{"allow_list":{"$ref":"#/components/schemas/Database/properties/allow_list"},"label":{"$ref":"#/components/schemas/DatabasePostgreSQL/properties/label"},"updates":{"$ref":"#/components/schemas/Database/properties/updates"}},"type":"object"}}},"description":"Updated information for the Managed PostgreSQL Database.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabasePostgreSQL"}}},"description":"Managed Database updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database Update","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"example-db\",\n \"allow_list\": [\n \"203.0.113.1\",\n \"192.0.1.0/24\"\n ],\n \"updates\" = {\n \"frequency\": \"monthly\",\n \"duration\": 3,\n \"hour_of_day\": 12,\n \"day_of_week\": 4,\n \"week_of_month\": 3,\n }\n }' \\\n https://api.linode.com/v4/databases/postgresql/instances/123\n"},{"lang":"CLI","source":"linode-cli databases postgresql-update 123 \\\n --label example-db \\\n --allow_list 203.0.113.1 \\\n --allow_list 192.0.1.0/24 \\\n --updates.frequency monthly \\\n --updates.duration 3 \\\n --updates.hour_of_day 12 \\\n --updates.day_of_week 4 \\\n --updates.week_of_month 3\n"}],"x-linode-cli-action":"postgresql-update","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/postgresql/instances/{instanceId}/backups":{"get":{"description":"Display all backups for an accessible Managed PostgreSQL Database.\n\nThe Database must not be provisioning to perform this command.\n\nDatabase `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.\n\nDatabase `snapshot` type backups are created by accessing the **Managed PostgreSQL Database Backup Snapshot Create** ([POST /databases/postgresql/instances/{instanceId}/backups](/docs/api/databases/#managed-postgresql-database-backup-snapshot-create)) command.\n","operationId":"getDatabasesPostgreSQLInstanceBackups","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationEnvelope"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatabaseBackup"},"type":"array"}},"type":"object"}]}}},"description":"Returns a paginated list of backups for the Managed PostgreSQL Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database Backups List","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/postgresql/instances/123/backups\n"},{"lang":"CLI","source":"linode-cli databases postgresql-backups-list 123\n"}],"x-linode-cli-action":"postgresql-backups-list","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed PostgreSQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Creates a snapshot backup of a Managed PostgreSQL Database.\n\nRequires `read_write` access to the Database.\n\nUp to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.\n\nBackups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.\n\nThe Database must have an `active` status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.\n","operationId":"postDatabasesPostgreSQLInstanceBackup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseBackupSnapshot"}}},"description":"Information about the snapshot backup to create."},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Database snapshot backup request successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database Backup Snapshot Create","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -X POST -d '{\n \"label\": \"snapshot1\",\n \"target\": \"primary\"\n }' \\\n https://api.linode.com/v4/databases/postgresql/instances/123/backups/\n"},{"lang":"CLI","source":"linode-cli databases postgresql-backup-snapshot 123 \\\n --label snapshot1 \\\n --target primary\n"}],"x-linode-cli-action":"postgresql-backup-snapshot","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/postgresql/instances/{instanceId}/backups/{backupId}":{"delete":{"description":"Delete a single backup for an accessible Managed PostgreSQL Database.\n\nRequires `read_write` access to the Database.\n\nThe Database must not be provisioning to perform this command.\n","operationId":"deleteDatabasePostgreSQLInstanceBackup","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Request to delete Database backup successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database Backup Delete","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/databases/postgresql/instances/123/backups/456\n"},{"lang":"CLI","source":"linode-cli databases postgresql-backup-delete 123 456\n"}],"x-linode-cli-action":"postgresql-backup-delete"},"get":{"description":"Display information for a single backup for an accessible Managed PostgreSQL Database.\n\nThe Database must not be provisioning to perform this command.\n","operationId":"getDatabasesPostgreSQLInstanceBackup","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseBackup"}}},"description":"Returns a single backup for the Managed PostgreSQL Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database Backup View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/postgresql/instances/123/backups/456\n"},{"lang":"CLI","source":"linode-cli databases postgresql-backup-view 123 456\n"}],"x-linode-cli-action":"postgresql-backup-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed PostgreSQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Managed PostgreSQL Database backup.","in":"path","name":"backupId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"databases"},"/databases/postgresql/instances/{instanceId}/backups/{backupId}/restore":{"parameters":[{"description":"The ID of the Managed PostgreSQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Managed PostgreSQL Database backup.","in":"path","name":"backupId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Restore a backup to a Managed PostgreSQL Database on your Account.\n\nRequires `read_write` access to the Database.\n\nThe Database must have an `active` status to perform this command.\n\n**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.\n\n**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.\n","operationId":"postDatabasesPostgreSQLInstanceBackupRestore","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Request to restore backup successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database Backup Restore","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST https://api.linode.com/v4/databases/postgresql/instances/123/backups/456/restore\n"},{"lang":"CLI","source":"linode-cli databases postgresql-backup-restore 123 456\n"}],"x-linode-cli-action":"postgresql-backup-restore","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/postgresql/instances/{instanceId}/credentials":{"get":{"description":"Display the root username and password for an accessible Managed PostgreSQL Database.\n\nThe Database must have an `active` status to perform this command.\n","operationId":"getDatabasesPostgreSQLInstanceCredentials","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseCredentials"}}},"description":"Managed Database root username and password."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database Credentials View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/postgresql/instances/123/credentials/\n"},{"lang":"CLI","source":"linode-cli databases postgresql-creds-view 123\n"}],"x-linode-cli-action":"postgresql-creds-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed PostgreSQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"databases"},"/databases/postgresql/instances/{instanceId}/credentials/reset":{"parameters":[{"description":"The ID of the Managed PostgreSQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Reset the root password for a Managed PostgreSQL Database.\n\nRequires `read_write` access to the Database.\n\nA new root password is randomly generated and accessible with the **Managed PostgreSQL Database Credentials View** ([GET /databases/postgresql/instances/{instanceId}/credentials](/docs/api/databases/#managed-postgresql-database-credentials-view)) command.\n\nOnly unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.\n\n**Note**: Note that it may take several seconds for credentials to reset.\n","operationId":"postDatabasesPostgreSQLInstanceCredentialsReset","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Managed Database instance credentials successfully reset."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database Credentials Reset","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST https://api.linode.com/v4/databases/postgresql/instances/123/credentials/reset\n"},{"lang":"CLI","source":"linode-cli databases postgresql-creds-reset 123\n"}],"x-linode-cli-action":"postgresql-creds-reset","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/postgresql/instances/{instanceId}/patch":{"parameters":[{"description":"The ID of the Managed PostgreSQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. This function runs during regular maintenance windows, which are configurable with the **Managed PostgreSQL Database Update** ([PUT /databases/postgresql/instances/{instanceId}](/docs/api/databases/#managed-postgresql-database-update)) command.\n\nRequires `read_write` access to the Database.\n\nThe Database must have an `active` status to perform this command.\n\n**Note**\n\n* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.\n\n* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.\n","operationId":"postDatabasesPostgreSQLInstancePatch","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Managed Database instance patch request successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database Patch","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST https://api.linode.com/v4/databases/postgresql/instances/123/patch\n"},{"lang":"CLI","source":"linode-cli databases postgresql-patch 123\n"}],"x-linode-cli-action":"postgresql-patch","x-linode-grant":"read_write"},"x-linode-cli-command":"databases"},"/databases/postgresql/instances/{instanceId}/ssl":{"get":{"description":"Display the SSL CA certificate for an accessible Managed PostgreSQL Database.\n\nThe Database must have an `active` status to perform this command.\n","operationId":"getDatabasesPostgreSQLInstanceSSL","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseSSL"}}},"description":"Returns the SSL CA certificate of a single Managed PostgreSQL Database."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["databases:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed PostgreSQL Database SSL Certificate View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/databases/postgresql/instances/123/ssl\n"},{"lang":"CLI","source":"linode-cli databases postgresql-ssl-cert 123\n"}],"x-linode-cli-action":"postgresql-ssl-cert","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Managed PostgreSQL Database.","in":"path","name":"instanceId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"databases"},"/databases/types":{"get":{"description":"Display all Managed Database node types. The type and number of nodes determine the resources and price of a Managed Database instance.\n\nEach Managed Database can have one node type. In the case of a high availabilty Database, all nodes are provisioned according to the chosen type.\n","operationId":"getDatabasesTypes","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationEnvelope"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatabaseType"},"type":"array"}},"type":"object"}]},"x-linode-cli-nested-list":"engines.mysql, engines.postgresql, engines.mongodb","x-linode-cli-use-schema":{"properties":{"_split":{"x-linode-cli-display":2.5},"engines":{"properties":{"price":{"properties":{"hourly":{"x-linode-cli-display":4},"monthly":{"x-linode-cli-display":5}}},"quantity":{"x-linode-cli-display":3}}},"id":{"x-linode-cli-display":1},"label":{"x-linode-cli-display":2}},"type":"object"}}},"description":"Returns a paginated list of all Managed Database types."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed Database Types List","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/databases/types\n"},{"lang":"CLI","source":"linode-cli databases types\n"}],"x-linode-cli-action":"types"},"x-linode-cli-command":"databases"},"/databases/types/{typeId}":{"get":{"description":"Display the details of a single Managed Database type. The type and number of nodes determine the resources and price of a Managed Database instance.\n","operationId":"getDatabasesType","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseType"},"x-linode-cli-nested-list":"engines.mysql, engines.postgresql, engines.mongodb","x-linode-cli-use-schema":{"properties":{"_split":{"x-linode-cli-display":2.5},"engines":{"properties":{"price":{"properties":{"hourly":{"x-linode-cli-display":4},"monthly":{"x-linode-cli-display":5}}},"quantity":{"x-linode-cli-display":3}}},"id":{"x-linode-cli-display":1},"label":{"x-linode-cli-display":2}},"type":"object"}}},"description":"Returns a single Managed Database type."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Managed Database Type View","tags":["Databases"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/databases/types/g6-nanode-1\n"},{"lang":"CLI","source":"linode-cli databases type-view g6-nanode-1\n"}],"x-linode-cli-action":"type-view"},"parameters":[{"description":"The ID of the Managed Database type.","in":"path","name":"typeId","required":true,"schema":{"type":"string"}}],"x-linode-cli-command":"databases"},"/domains":{"get":{"description":"This is a collection of Domains that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for these to work you must own the domains and point your registrar at Linode's nameservers.\n","operationId":"getDomains","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Domain"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of Domains you have registered."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_only"]}],"summary":"Domains List","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/domains\n"},{"lang":"CLI","source":"linode-cli domains list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Adds a new Domain to Linode's DNS Manager. Linode is not a registrar, and you must own the domain before adding it here. Be sure to point your registrar to Linode's nameservers so that the records hosted here are used.\n","operationId":"createDomain","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Domain"}],"required":["domain","type"]}}},"description":"Information about the domain you are registering.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}},"description":"Domain added successfully.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_write"]}],"summary":"Domain Create","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"domain\": \"example.com\",\n \"type\": \"master\",\n \"soa_email\": \"admin@example.com\",\n \"description\": \"Example Description\",\n \"refresh_sec\": 14400,\n \"retry_sec\": 3600,\n \"expire_sec\": 604800,\n \"ttl_sec\": 3600,\n \"status\": \"active\",\n \"master_ips\": [\"127.0.0.1\",\"255.255.255.1\",\"123.123.123.7\"],\n \"axfr_ips\": [\"44.55.66.77\"],\n \"group\": \"Example Display Group\",\n \"tags\": [\"tag1\",\"tag2\"]\n }' \\\n https://api.linode.com/v4/domains\n"},{"lang":"CLI","source":"linode-cli domains create \\\n --type master \\\n --domain example.org \\\n --soa_email admin@example.org\n"}],"x-linode-cli-action":"create","x-linode-grant":"add_domains"},"x-linode-cli-command":"domains"},"/domains/import":{"post":{"description":"Imports a domain zone from a remote nameserver.\nYour nameserver must allow zone transfers (AXFR) from the following IPs:\n\n - 96.126.114.97\n - 96.126.114.98\n - 2600:3c00::5e\n - 2600:3c00::5f\n","operationId":"importDomain","requestBody":{"content":{"application/json":{"schema":{"properties":{"domain":{"description":"The domain to import.\n","example":"example.com","type":"string"},"remote_nameserver":{"description":"The remote nameserver that allows zone transfers (AXFR).\n","example":"examplenameserver.com","type":"string"}},"required":["domain","remote_nameserver"]}}},"description":"Information about the Domain to import."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}},"description":"A single Domain in Linode's DNS Manager.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_write"]}],"summary":"Domain Import","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"domain\": \"example.com\",\n \"remote_nameserver\": \"examplenameserver.com\"\n }' \\\n https://api.linode.com/v4/domains/import\n"},{"lang":"CLI","source":"linode-cli domains import --domain example.com --remote_nameserver examplenameserver.com\n"}],"x-linode-cli-action":"import","x-linode-cli-command":"domains","x-linode-grant":"read_write"},"x-linode-cli-command":"domains"},"/domains/{domainId}":{"delete":{"description":"Deletes a Domain from Linode's DNS Manager. The Domain will be removed from Linode's nameservers shortly after this operation completes. This also deletes all associated Domain Records.\n","operationId":"deleteDomain","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Domain deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_write"]}],"summary":"Domain Delete","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/domains/1234\n"},{"lang":"CLI","source":"linode-cli domains delete 1234\n"}],"x-linode-cli-action":["delete","rm"],"x-linode-grant":"read_write"},"get":{"description":"This is a single Domain that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for this Domain record to work you must own the domain and point your registrar at Linode's nameservers.\n","operationId":"getDomain","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}},"description":"A single Domain in Linode's DNS Manager.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_only"]}],"summary":"Domain View","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/domains/123\n"},{"lang":"CLI","source":"linode-cli domains view 123\n"}],"x-linode-cli-action":"view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Domain to access.","in":"path","name":"domainId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Update information about a Domain in Linode's DNS Manager.\n","operationId":"updateDomain","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}},"description":"The Domain information to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}},"description":"Domain update successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_write"]}],"summary":"Domain Update","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"domain\": \"example.com\",\n \"type\": \"master\",\n \"soa_email\": \"admin@example.com\",\n \"description\": \"Example Description\",\n \"refresh_sec\": 14400,\n \"retry_sec\": 3600,\n \"expire_sec\": 604800,\n \"ttl_sec\": 3600,\n \"status\": \"active\",\n \"master_ips\": [\"127.0.0.1\",\"255.255.255.1\",\"123.123.123.7\"],\n \"axfr_ips\": [\"44.55.66.77\"],\n \"group\": \"Example Display Group\",\n \"tags\": [\"tag1\",\"tag2\"]\n }' \\\n https://api.linode.com/v4/domains/123\n"},{"lang":"CLI","source":"linode-cli domains update 1234 \\\n --retry_sec 7200 \\\n --ttl_sec 300\n"}],"x-linode-cli-action":"update","x-linode-grant":"read_write"},"x-linode-cli-command":"domains"},"/domains/{domainId}/clone":{"parameters":[{"description":"ID of the Domain to clone.","in":"path","name":"domainId","required":true,"schema":{"type":"string"}}],"post":{"description":"Clones a Domain and all associated DNS records from a Domain that is registered in Linode's DNS manager.\n","operationId":"cloneDomain","requestBody":{"content":{"application/json":{"schema":{"properties":{"domain":{"description":"The new domain for the clone. Domain labels cannot be longer than 63 characters and must conform to [RFC1035](https://tools.ietf.org/html/rfc1035). Domains must be unique on Linode's platform, including across different Linode accounts; there cannot be two Domains representing the same domain.\n","example":"example.org","maxLength":253,"minLength":1,"pattern":"\\A(\\*\\.)?([a-zA-Z0-9-_]{1,63}\\.)+([a-zA-Z]{2,3}\\.)?([a-zA-Z]{2,16}|xn--[a-zA-Z0-9]+)\\Z","type":"string","x-linode-filterable":true}},"required":["domain"],"type":"object"}}},"description":"Information about the Domain to clone.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}},"description":"A new Domain in Linode's DNS Manager, based on a cloned Domain.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_write"]}],"summary":"Domain Clone","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"domain\": \"example.com\"\n}' \\ https://api.linode.com/v4/domains/123/clone\n"},{"lang":"CLI","source":"linode-cli domains clone 123 --domain example.com\n"}],"x-linode-cli-action":"clone","x-linode-grant":"read_write"},"x-linode-cli-command":"domains"},"/domains/{domainId}/records":{"get":{"description":"Returns a paginated list of Records configured on a Domain in Linode's\nDNS Manager.\n","operationId":"getDomainRecords","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DomainRecord"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A list of Domain Records."}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_only"]}],"summary":"Domain Records List","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/domains/1234/records\n"},{"lang":"CLI","source":"linode-cli domains records-list 1234\n"}],"x-linode-cli-action":"records-list","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Domain we are accessing Records for.","in":"path","name":"domainId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Adds a new Domain Record to the zonefile this Domain represents.\n\nEach domain can have up to 12,000 active records.\n","operationId":"createDomainRecord","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DomainRecord"}],"required":["type"]}}},"description":"Information about the new Record to add.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainRecord"}}},"description":"Domain Record created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_write"]}],"summary":"Domain Record Create","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"type\": \"A\",\n \"name\": \"test\",\n \"target\": \"203.0.113.1\",\n \"priority\": 50,\n \"weight\": 50,\n \"port\": 80,\n \"service\": null,\n \"protocol\": null,\n \"ttl_sec\": 604800\n }' \\\n https://api.linode.com/v4/domains/123/records\n"},{"lang":"CLI","source":"linode-cli domains records-create 123 \\\n --type A \\\n --name test \\\n --target 203.0.113.1 \\\n --priority 50 \\\n --weight 50 \\\n --port 80 \\\n --ttl_sec 604800\n"}],"x-linode-cli-action":"records-create","x-linode-grant":"read_write"},"x-linode-cli-command":"domains"},"/domains/{domainId}/records/{recordId}":{"delete":{"description":"Deletes a Record on this Domain.\n","operationId":"deleteDomainRecord","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Record deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_write"]}],"summary":"Domain Record Delete","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/domains/123/records/234\n"},{"lang":"CLI","source":"linode-cli domains records-delete 123 234\n"}],"x-linode-cli-action":"records-delete","x-linode-grant":"read_write"},"get":{"description":"View a single Record on this Domain.\n","operationId":"getDomainRecord","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainRecord"}}},"description":"A Domain Record object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_only"]}],"summary":"Domain Record View","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/domains/123/records/234\n"},{"lang":"CLI","source":"linode-cli domains records-view 123 234\n"}],"x-linode-cli-action":"records-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Domain whose Record you are accessing.","in":"path","name":"domainId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Record you are accessing.","in":"path","name":"recordId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates a single Record on this Domain.\n","operationId":"updateDomainRecord","requestBody":{"content":{"application/json":{"schema":{"description":"A Domain Record Update request object.","properties":{"name":{"$ref":"#/components/schemas/DomainRecord/properties/name"},"port":{"$ref":"#/components/schemas/DomainRecord/properties/port"},"priority":{"$ref":"#/components/schemas/DomainRecord/properties/priority"},"protocol":{"$ref":"#/components/schemas/DomainRecord/properties/protocol"},"service":{"$ref":"#/components/schemas/DomainRecord/properties/service"},"tag":{"$ref":"#/components/schemas/DomainRecord/properties/tag"},"target":{"$ref":"#/components/schemas/DomainRecord/properties/target"},"ttl_sec":{"$ref":"#/components/schemas/DomainRecord/properties/ttl_sec"},"weight":{"$ref":"#/components/schemas/DomainRecord/properties/weight"}},"type":"object"}}},"description":"The values to change.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainRecord"}}},"description":"Domain Record updated."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_write"]}],"summary":"Domain Record Update","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"name\": \"test\",\n \"target\": \"203.0.113.1\",\n \"priority\": 50,\n \"weight\": 50,\n \"port\": 80,\n \"service\": null,\n \"protocol\": null,\n \"ttl_sec\": 604800,\n \"tag\": null\n }' \\\n https://api.linode.com/v4/domains/123/records/234\n"},{"lang":"CLI","source":"linode-cli domains records-update 123 234 \\\n --name test \\\n --target 203.0.113.1 \\\n --priority 50 \\\n --weight 50 \\\n --port 80 \\\n --ttl_sec 604800\n"}],"x-linode-cli-action":"records-update","x-linode-grant":"read_write"},"x-linode-cli-command":"domains"},"/domains/{domainId}/zone-file":{"get":{"description":"Returns the zone file for the last rendered zone for the specified domain.\n","operationId":"getDomainZone","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"zone_file":{"description":"The lines of the zone file for the last rendered zone for this domain.\n","example":["; example.com [123]","$TTL 864000","@ IN SOA ns1.linode.com. user.example.com. 2021000066 14400 14400 1209600 86400","@ NS ns1.linode.com.","@ NS ns2.linode.com.","@ NS ns3.linode.com.","@ NS ns4.linode.com.","@ NS ns5.linode.com."],"items":{"type":"string"},"type":"array"}}}}},"description":"An array containing the lines of the domain zone file.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["domains:read_only"]}],"summary":"Domain Zone File View","tags":["Domains"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/domains/123/zone-file\n"},{"lang":"CLI","source":"linode-cli domains zone-file 123\n"}],"x-linode-cli-action":"zone-file","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Domain.","in":"path","name":"domainId","required":true,"schema":{"type":"string"}}],"x-linode-cli-command":"domains"},"/images":{"get":{"description":"Returns a paginated list of Images.\n\n* **Public** Images have IDs that begin with \"linode/\". These distribution images are generally available to\nall users.\n\n* **Private** Images have IDs that begin with \"private/\". These Images are Account-specific and only\naccessible to Users with appropriate [Grants](/docs/api/account/#users-grants-view).\n\n* To view only public Images, call this endpoint with or without authentication. To view private Images as well, call this endpoint with authentication.\n","operationId":"getImages","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of Images."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["images:read_only"]}],"summary":"Images List","tags":["Images"],"x-code-samples":[{"lang":"Shell","source":"# Returns public Images only\ncurl https://api.linode.com/v4/images\n\n# Returns private and public Images\ncurl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/images\n"},{"lang":"CLI","source":"linode-cli images list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-redoc-load-ids":true},"post":{"description":"Captures a private gold-master Image from a Linode Disk.\n","operationId":"createImage","requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"description":"A detailed description of this Image.\n","type":"string"},"disk_id":{"description":"The ID of the Linode Disk that this Image will be created from.\n","example":42,"type":"integer"},"label":{"description":"A short title of this Image. Defaults to the label of the Disk it is being created from if not provided.\n","type":"string"}},"required":["disk_id"]}}},"description":"Information about the Image to create."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}},"description":"New private Image created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["images:read_write","linodes:read_only"]}],"summary":"Image Create","tags":["Images"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"disk_id\": 123,\n \"label\": \"this_is_a_label\",\n \"description\": \"A longer description of the image\"\n }' \\\n https://api.linode.com/v4/images\n"},{"lang":"CLI","source":"linode-cli images create \\\n --label this_is_a_label \\\n --description \"A longer description \\\n of the image\" \\\n --disk_id 123\n"}],"x-linode-cli-action":"create","x-linode-grant":"add_images"},"x-linode-cli-command":"images"},"/images/upload":{"post":{"description":"Initiates an Image upload.\n\nThis endpoint creates a new private Image object and returns it along\nwith the URL to which image data can be uploaded.\n\n- Image data must be uploaded within 24 hours of creation or the\nupload will be cancelled and the image deleted.\n\n- Image uploads should be made as an HTTP PUT request to the URL returned in the `upload_to`\nresponse parameter, with a `Content-type: application/octet-stream` header included in the\nrequest. For example:\n\n curl -v \\\n -H \"Content-Type: application/octet-stream\" \\\n --upload-file example.img.gz \\\n $UPLOAD_URL \\\n --progress-bar \\\n --output /dev/null\n\n- Uploaded image data should be compressed in gzip (`.gz`) format. The uncompressed disk should be in raw\ndisk image (`.img`) format. A maximum compressed file size of 5GB is supported for upload at this time.\n\n**Note:** To initiate and complete an Image upload in a single step, see our guide on how to [Upload an Image](/docs/products/tools/images/guides/upload-an-image/) using Cloud Manager or the Linode CLI `image-upload` plugin.\n","requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"description":"Description for the uploaded Image.","example":"This is an example image in the docs.","type":"string"},"label":{"description":"Label for the uploaded Image.","example":"my-image-label","type":"string"},"region":{"description":"The region to upload to. Once uploaded, the Image can be used in any region.\n","example":"eu-central","type":"string"}},"required":["label","region"],"type":"object"}}},"description":"The uploaded Image details.","x-linode-cli-allowed-defaults":["region"]},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"image":{"$ref":"#/components/schemas/Image"},"upload_to":{"description":"The URL to upload the Image to.","type":"string","x-linode-cli-display":1}},"type":"object"}}},"description":"Image Upload object including the upload URL and Image object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["images:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"},{"url":"https://api.linode.com/v4beta"}],"summary":"Image Upload","tags":["Images"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"description\": \"Optional details about the Image\",\n \"label\": \"Example Image\",\n \"region\": \"us-east\"\n }' \\\n https://api.linode.com/v4/images/upload\n"},{"lang":"CLI","source":"# Upload the Image file in a single step\nlinode-cli image-upload \\\n --description \"Optional details about the Image\" \\\n --label \"Example Image\" \\\n --region us-east \\\n /path/to/image-file.img.gz\n\n# Returns the upload_to URL\nlinode-cli images upload \\\n --description \"Optional details about the Image\" \\\n --label \"Example Image\" \\\n --region us-east\n"}],"x-linode-cli-action":"upload","x-linode-grant":"add_images"},"x-linode-cli-command":"images"},"/images/{imageId}":{"delete":{"description":"Deletes a private Image you have permission to `read_write`.\n\n\n**Deleting an Image is a destructive action and cannot be undone.**\n","operationId":"deleteImage","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Delete successful"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["images:read_write"]}],"summary":"Image Delete","tags":["Images"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/images/private/12345\n"},{"lang":"CLI","source":"linode-cli images delete 12345\n"}],"x-linode-cli-action":["delete","rm"],"x-linode-grant":"read_write"},"get":{"description":"Get information about a single Image.\n\n* **Public** Images have IDs that begin with \"linode/\". These distribution images are generally available to\nall users.\n\n* **Private** Images have IDs that begin with \"private/\". These Images are Account-specific and only\naccessible to Users with appropriate [Grants](/docs/api/account/#users-grants-view).\n\n* To view a public Image, call this endpoint with or without authentication. To view a private Image, call this endpoint with authentication.\n","operationId":"getImage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}},"description":"A single Image object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["images:read_only"]}],"summary":"Image View","tags":["Images"],"x-code-samples":[{"lang":"Shell","source":"# Public Image\ncurl https://api.linode.com/v4/images/linode/debian11\n\n# Private Image\ncurl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/images/private/12345\n"},{"lang":"CLI","source":"linode-cli images view linode/debian9\n"}],"x-linode-cli-action":"view"},"parameters":[{"description":"ID of the Image to look up.","in":"path","name":"imageId","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates a private Image that you have permission to `read_write`.\n","operationId":"updateImage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}},"description":"The fields to update.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}},"description":"The updated image."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["images:read_write"]}],"summary":"Image Update","tags":["Images"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"My gold-master image\",\n \"description\": \"The detailed description of my Image.\"\n }' \\\n https://api.linode.com/v4/images/private/12345\n"},{"lang":"CLI","source":"linode-cli images update private/12345 \\\n --label \"My gold-master image\" \\\n --description \"The detailed description \\\n of my Image.\"\n"}],"x-linode-cli-action":"update","x-linode-grant":"read_write"},"x-linode-cli-command":"images"},"/linode/instances":{"get":{"description":"Returns a paginated list of Linodes you have permission to view.\n","operationId":"getLinodeInstances","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Linode"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns an array of all Linodes on your Account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Linodes List","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances\n"},{"lang":"CLI","source":"linode-cli linodes list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Creates a Linode Instance on your Account. In order for this\nrequest to complete successfully, your User must have the `add_linodes` grant. Creating a\nnew Linode will incur a charge on your Account.\n\nLinodes can be created using one of the available Types. See\nTypes List ([GET /linode/types](/docs/api/linode-types/#types-list)) to get more\ninformation about each Type's specs and cost.\n\nLinodes can be created in any one of our available Regions, which are accessible from the\nRegions List ([GET /regions](/docs/api/regions/#regions-list)) endpoint.\n\nIn an effort to fight spam, Linode restricts outbound connections on ports 25, 465, and 587\non all Linodes for new accounts created after November 5th, 2019. For more information,\nsee [Sending Email on Linode](/docs/guides/running-a-mail-server/#sending-email-on-linode).\n\nLinodes can be created in a number of ways:\n\n* Using a Linode Public Image distribution or a Private Image you created based on another Linode.\n * Access the Images List ([GET /images](/docs/api/images/#images-list)) endpoint with authentication to view\n all available Images.\n * The Linode will be `running` after it completes `provisioning`.\n * A default config with two Disks, one being a 512 swap disk, is created.\n * `swap_size` can be used to customize the swap disk size.\n * Requires a `root_pass` be supplied to use for the root User's Account.\n * It is recommended to supply SSH keys for the root User using the `authorized_keys` field.\n * You may also supply a list of usernames via the `authorized_users` field.\n * These users must have an SSH Key associated with your Profile first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information.\n\n* Using a StackScript.\n * See StackScripts List ([GET /linode/stackscripts](/docs/api/stackscripts/#stackscripts-list)) for\n a list of available StackScripts.\n * The Linode will be `running` after it completes `provisioning`.\n * Requires a compatible Image to be supplied.\n * See StackScript View ([GET /linode/stackscript/{stackscriptId}](/docs/api/stackscripts/#stackscript-view)) for compatible Images.\n * Requires a `root_pass` be supplied to use for the root User's Account.\n * It is recommended to supply SSH keys for the root User using the `authorized_keys` field.\n * You may also supply a list of usernames via the `authorized_users` field.\n * These users must have an SSH Key associated with your Profile first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information.\n\n* Using one of your other Linode's backups.\n * You must create a Linode large enough to accommodate the Backup's size.\n * The Disks and Config will match that of the Linode that was backed up.\n * The `root_pass` will match that of the Linode that was backed up.\n\n* Attached to a private VLAN.\n * Review the `interfaces` property of the [Request Body Schema](/docs/api/linode-instances/#linode-create__request-body-schema) for details.\n * For more information, see our guide on [Getting Started with VLANs](/docs/products/networking/vlans/get-started/).\n\n* Create an empty Linode.\n * The Linode will remain `offline` and must be manually started.\n * See Linode Boot ([POST /linode/instances/{linodeId}/boot](/docs/api/linode-instances/#linode-boot)).\n * Disks and Configs must be created manually.\n * This is only recommended for advanced use cases.\n\n**Important**: You must be an unrestricted User in order to add or modify\ntags on Linodes.\n","operationId":"createLinodeInstance","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LinodeRequest"},{"properties":{"backup_id":{"description":"A Backup ID from another Linode's available backups. Your User must have\n`read_write` access to that Linode, the Backup must have a `status` of\n`successful`, and the Linode must be deployed to the same `region` as the Backup.\nSee [GET /linode/instances/{linodeId}/backups](/docs/api/linode-instances/#backups-list)\nfor a Linode's available backups.\n\nThis field and the `image` field are mutually exclusive.\n","example":1234,"type":"integer"},"backups_enabled":{"description":"If this field is set to `true`, the created Linode will automatically be\nenrolled in the Linode Backup service. This will incur an additional charge.\nThe cost for the Backup service is dependent on the Type of Linode deployed.\n\nThis option is always treated as `true` if the account-wide `backups_enabled`\nsetting is `true`. See [account settings](/docs/api/account/#account-settings-view)\nfor more information.\n\nBackup pricing is included in the response from [/linodes/types](/docs/api/linode-types/#types-list)\n","type":"boolean"},"group":{"$ref":"#/components/schemas/Linode/properties/group"},"interfaces":{"$ref":"#/components/schemas/LinodeConfigInterfaces"},"label":{"$ref":"#/components/schemas/Linode/properties/label"},"private_ip":{"description":"If true, the created Linode will have private networking enabled and assigned a private IPv4 address.\n","example":true,"type":"boolean"},"region":{"description":"The [Region](/docs/api/regions/#regions-list) where the Linode will be located.\n","example":"us-east","type":"string"},"swap_size":{"default":512,"description":"When deploying from an Image, this field is optional, otherwise it is ignored. This is used to set the swap disk size for the newly-created Linode.\n","example":512,"type":"integer"},"tags":{"$ref":"#/components/schemas/Linode/properties/tags"},"type":{"description":"The [Linode Type](/docs/api/linode-types/#types-list) of the Linode you are creating.\n","example":"g6-standard-2","type":"string"}}}],"required":["type","region"],"type":"object"}}},"description":"The requested initial state of a new Linode.","required":true,"x-linode-cli-allowed-defaults":["authorized_users","region","image","type"]},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Linode"}}},"description":"A new Linode is being created.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Create","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"backup_id\": 1234,\n \"backups_enabled\": true,\n \"swap_size\": 512,\n \"image\": \"linode/debian9\",\n \"root_pass\": \"aComplexP@ssword\",\n \"stackscript_id\": 10079,\n \"stackscript_data\": {\n \"gh_username\": \"linode\"\n },\n \"interfaces\": [\n {\n \"purpose\": \"public\",\n \"label\": \"\",\n \"ipam_address\": \"\"\n },\n {\n \"purpose\": \"vlan\",\n \"label\": \"vlan-1\",\n \"ipam_address\": \"10.0.0.1/24\"\n }\n ],\n \"authorized_keys\": [\n \"ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer\"\n ],\n \"authorized_users\": [\n \"myUser\",\n \"secondaryUser\"\n ],\n \"booted\": true,\n \"label\": \"linode123\",\n \"type\": \"g6-standard-2\",\n \"region\": \"us-east\",\n \"group\": \"Linode-Group\"\n }' \\\n https://api.linode.com/v4/linode/instances\n"},{"lang":"CLI","source":"linode-cli linodes create \\\n --label linode123 \\\n --root_pass aComplex@Password \\\n --booted true \\\n --stackscript_id 10079 \\\n --stackscript_data '{\"gh_username\": \"linode\"}' \\\n --region us-east \\\n --type g6-standard-2 \\\n --authorized_keys \"ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer\"\n --authorized_users \"myUser\"\n --authorized_users \"secondaryUser\"\n"}],"x-linode-charge":true,"x-linode-cli-action":"create","x-linode-grant":"add_linodes"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}":{"delete":{"description":"Deletes a Linode you have permission to `read_write`.\n\n**Deleting a Linode is a destructive action and cannot be undone.**\n\nAdditionally, deleting a Linode:\n\n * Gives up any IP addresses the Linode was assigned.\n * Deletes all Disks, Backups, Configs, etc.\n * Stops billing for the Linode and its associated services. You will be billed for time used\n within the billing period the Linode was active.\n\nLinodes that are in the process of [cloning](/docs/api/linode-instances/#linode-clone) or [backup restoration](/docs/api/linode-instances/#backup-restore) cannot be deleted.\n","operationId":"deleteLinodeInstance","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Delete successful"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Delete","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/linode/instances/123\n"},{"lang":"CLI","source":"linode-cli linodes delete 123\n"}],"x-linode-cli-action":["delete","rm"],"x-linode-grant":"read_write"},"get":{"description":"Get a specific Linode by ID.","operationId":"getLinodeInstance","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Linode"}}},"description":"Returns a single Linode object.","links":{"boot":{"$ref":"#/components/links/bootLinode"},"clone":{"$ref":"#/components/links/cloneLinode"},"delete":{"$ref":"#/components/links/deleteLinode"},"mutate":{"$ref":"#/components/links/mutateLinode"},"reboot":{"$ref":"#/components/links/rebootLinode"},"rebuild":{"$ref":"#/components/links/rebuildLinode"},"rescue":{"$ref":"#/components/links/rescueLinode"},"resize":{"$ref":"#/components/links/resizeLinode"},"shutdown":{"$ref":"#/components/links/shutdownLinode"},"update":{"$ref":"#/components/links/updateLinode"}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Linode View","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123\n"},{"lang":"CLI","source":"linode-cli linodes view 123\n"}],"x-linode-cli-action":"view","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Linode to look up","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates a Linode that you have permission to `read_write`.\n\n**Important**: You must be an unrestricted User in order to add or modify tags on Linodes.\n","operationId":"updateLinodeInstance","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Linode"}}},"description":"Any field that is not marked as `readOnly` may be updated. Fields that are marked `readOnly` will be ignored. If any updated field fails to pass validation, the Linode will not be updated.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Linode"}}},"description":"The updated Linode."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Update","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"linode123\",\n \"group\": \"Linode-Group\",\n \"alerts\": {\n \"cpu\": 180,\n \"network_in\": 10,\n \"network_out\": 10,\n \"transfer_quota\": 80,\n \"io\": 10000\n },\n \"backups\": {\n \"schedule\": {\n \"day\": \"Saturday\",\n \"window\": \"W22\"\n }\n }\n }' \\\n https://api.linode.com/v4/linode/instances/123\n"},{"lang":"CLI","source":"linode-cli linodes update 7833080 \\\n --label linode123 \\\n --backups.schedule.day \"Saturday\" \\\n --backups.schedule.window \"W22\" \\\n --alerts.cpu 180 \\\n --alerts.network_in 10 \\\n --alerts.network_out 10 \\\n --alerts.transfer_quota 80 \\\n --alerts.io 10000\n"}],"x-linode-cli-action":"update","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/backups":{"get":{"description":"Returns information about this Linode's available backups.\n","operationId":"getBackups","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"automatic":{"items":{"allOf":[{"$ref":"#/components/schemas/Backup"},{"properties":{"type":{"example":"automatic","type":"string"}}}]},"type":"array"},"snapshot":{"properties":{"current":{"$ref":"#/components/schemas/Backup"},"in_progress":{"$ref":"#/components/schemas/Backup"}},"type":"object"}},"type":"object"},"x-linode-cli-rows":["automatic","snapshot.current","snapshot.in_progress"],"x-linode-cli-use-schema":{"$ref":"#/components/schemas/Backup"}}},"description":"A collection of the specified Linode's available backups."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Backups List","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/backups\n"},{"lang":"CLI","source":"linode-cli linodes backups-list 123\n"}],"x-linode-cli-action":"backups-list","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Linode the backups belong to.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Creates a snapshot Backup of a Linode.\n\n**Important:** If you already have a snapshot of this Linode, this is a destructive\naction. The previous snapshot will be deleted.\n","operationId":"createSnapshot","requestBody":{"content":{"application/json":{"schema":{"properties":{"label":{"description":"The label for the new snapshot.","example":"SnapshotLabel","maxLength":255,"minLength":1,"type":"string"}},"required":["label"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Backup"}}},"description":"Snapshot request successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Snapshot Create","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"MyNewSnapshot\"\n }' \\\n https://api.linode.com/v4/linode/instances/123/backups\n"},{"lang":"CLI","source":"linode-cli linodes snapshot 123\n"}],"x-linode-cli-action":"snapshot","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/backups/cancel":{"parameters":[{"description":"The ID of the Linode to cancel backup service for.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Cancels the Backup service on the given Linode. Deletes all of this Linode's existing backups forever.\n","operationId":"cancelBackups","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Backup service was cancelled for the specified Linode."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Backups Cancel","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/linode/instances/123/backups/cancel\n"},{"lang":"CLI","source":"linode-cli linodes backups-cancel 123\n"}],"x-linode-cli-action":"backups-cancel","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/backups/enable":{"parameters":[{"description":"The ID of the Linode to enable backup service for.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Enables backups for the specified Linode.\n","operationId":"enableBackups","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Backup service was enabled."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Backups Enable","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/linode/instances/123/backups/enable\n"},{"lang":"CLI","source":"linode-cli linodes backups-enable 123\n"}],"x-linode-cli-action":"backups-enable","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/backups/{backupId}":{"get":{"description":"Returns information about a Backup.\n","operationId":"getBackup","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Backup"}}},"description":"A single Backup."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Backup View","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/backups/123456\n"},{"lang":"CLI","source":"linode-cli linodes backup-view 123 123456\n"}],"x-linode-cli-action":"backup-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Linode the Backup belongs to.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Backup to look up.","in":"path","name":"backupId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/backups/{backupId}/restore":{"parameters":[{"description":"The ID of the Linode that the Backup belongs to.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Backup to restore.","in":"path","name":"backupId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Restores a Linode's Backup to the specified Linode.\n","operationId":"restoreBackup","requestBody":{"content":{"application/json":{"schema":{"properties":{"linode_id":{"description":"The ID of the Linode to restore a Backup to.\n","example":234,"type":"integer"},"overwrite":{"description":"If True, deletes all Disks and Configs on the target Linode\nbefore restoring.\n\nIf False, and the Disk image size is larger than the available\nspace on the Linode, an error message indicating insufficient\nspace is returned.\n","example":true,"type":"boolean"}},"required":["linode_id"],"type":"object"}}},"description":"Parameters to provide when restoring the Backup.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Restore from Backup was initiated."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Backup Restore","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"linode_id\": 234,\n \"overwrite\": true\n }' \\\n https://api.linode.com/v4/linode/instances/123/backups/123456/restore\n"},{"lang":"CLI","source":"linode-cli linodes backup-restore 123 123456 \\\n --linode_id 234 \\\n --overwrite true\n"}],"x-linode-cli-action":"backup-restore","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/boot":{"parameters":[{"description":"The ID of the Linode to boot.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Boots a Linode you have permission to modify. If no parameters are given, a Config profile\nwill be chosen for this boot based on the following criteria:\n\n* If there is only one Config profile for this Linode, it will be used.\n* If there is more than one Config profile, the last booted config will be used.\n* If there is more than one Config profile and none were the last to be booted (because the\n Linode was never booted or the last booted config was deleted) an error will be returned.\n","operationId":"bootLinodeInstance","requestBody":{"content":{"application/json":{"schema":{"properties":{"config_id":{"description":"The Linode Config ID to boot into.\n","example":null,"type":"integer"}},"type":"object"}}},"description":"Optional configuration to boot into (see above).","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Boot started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Boot","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/linode/instances/123/boot\n"},{"lang":"CLI","source":"linode-cli linodes boot 123\n"}],"x-linode-cli-action":"boot","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/clone":{"parameters":[{"description":"ID of the Linode to clone.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"You can clone your Linode's existing Disks or Configuration profiles to\nanother Linode on your Account. In order for this request to complete\nsuccessfully, your User must have the `add_linodes` grant. Cloning to a\nnew Linode will incur a charge on your Account.\n\nIf cloning to an existing Linode, any actions currently running or\nqueued must be completed first before you can clone to it.\n\nUp to five clone operations from any given source Linode can be run concurrently.\nIf more concurrent clones are attempted, an HTTP 400 error will be\nreturned by this endpoint.\n\nAny [tags](/docs/api/tags/#tags-list) existing on the source Linode will be cloned to the target Linode.\n","operationId":"cloneLinodeInstance","requestBody":{"content":{"application/json":{"schema":{"properties":{"backups_enabled":{"description":"If this field is set to `true`, the created Linode will\nautomatically be enrolled in the Linode Backup service. This\nwill incur an additional charge. Pricing is included in the\nresponse from\n[/linodes/types](/docs/api/linode-types/#types-list).\n\n* Can only be included when cloning to a new Linode.\n","example":true,"type":"boolean"},"configs":{"description":"An array of configuration profile IDs.\n* If the `configs` parameter **is not provided**, then **all configuration profiles and their associated disks will be cloned** from the source Linode. Any disks specified by the `disks` parameter will also be cloned.\n* **If an empty array is provided** for the `configs` parameter, then **no configuration profiles (nor their associated disks) will be cloned** from the source Linode. Any disks specified by the `disks` parameter will still be cloned.\n* **If a non-empty array is provided** for the `configs` parameter, then **the configuration profiles specified in the array (and their associated disks) will be cloned** from the source Linode. Any disks specified by the `disks` parameter will also be cloned.\n","items":{"example":23456,"type":"integer"},"type":"array"},"disks":{"description":"An array of disk IDs.\n* If the `disks` parameter **is not provided**, then **no extra disks will be cloned** from the source Linode. All disks associated with the configuration profiles specified by the `configs` parameter will still be cloned.\n* **If an empty array is provided** for the `disks` parameter, then **no extra disks will be cloned** from the source Linode. All disks associated with the configuration profiles specified by the `configs` parameter will still be cloned.\n* **If a non-empty array is provided** for the `disks` parameter, then **the disks specified in the array will be cloned** from the source Linode, in addition to any disks associated with the configuration profiles specified by the `configs` parameter.\n","items":{"example":25674,"type":"integer"},"type":"array"},"group":{"deprecated":true,"description":"A label used to group Linodes for display. Linodes are not required to have a group.\n","example":"Linode-Group","type":"string"},"label":{"description":"The label to assign this Linode when cloning to a new Linode.\n* Can only be provided when cloning to a new Linode.\n* Defaults to \"linode\".\n","example":"cloned-linode","maxLength":64,"minLength":3,"type":"string"},"linode_id":{"description":"If an existing Linode is the target for the clone, the ID of that Linode. The existing Linode must have enough resources to accept the clone.\n","example":124,"type":"integer"},"private_ip":{"description":"If true, the created Linode will have private networking enabled and assigned a private IPv4 address.\n* Can only be provided when cloning to a new Linode.\n","example":true,"type":"boolean"},"region":{"description":"This is the Region where the Linode will be deployed.\nTo view all available Regions you can deploy to see [/regions](/docs/api/regions/#regions-list).\n* Region can only be provided and is required when cloning to a new Linode.\n","example":"us-east","type":"string"},"type":{"description":"A Linode's Type determines what resources are available to\nit, including disk space, memory, and virtual cpus. The\namounts available to a specific Linode are returned as\n`specs` on the Linode object.\n\nTo view all available Linode Types you can deploy with\nsee [/linode/types](/docs/api/linode-types/#types-list).\n\n* Type can only be provided and is required when cloning to a new Linode.\n","example":"g6-standard-2","type":"string"}},"type":"object"}}},"description":"The requested state your Linode will be cloned into.","required":true,"x-linode-cli-allowed-defaults":["region","type"]},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Linode"}}},"description":"Clone started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Clone","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"region\": \"us-east\",\n \"type\": \"g6-standard-2\",\n \"linode_id\": 124,\n \"label\": \"cloned-linode\",\n \"group\": \"Linode-Group\",\n \"backups_enabled\": true,\n \"disks\": [25674],\n \"configs\": [23456],\n \"private_ip\": true\n }' \\\n https://api.linode.com/v4/linode/instances/123/clone\n"},{"lang":"CLI","source":"linode-cli linodes clone 123 \\\n --linode_id 124 \\\n --region us-east \\\n --type g6-standard-2 \\\n --label cloned-linode \\\n --backups_enabled true \\\n --disks 25674 \\\n --configs 23456 \\\n --private_ip true\n"}],"x-linode-charge":true,"x-linode-cli-action":"clone","x-linode-grant":"add_linodes"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/configs":{"get":{"description":"Lists Configuration profiles associated with a Linode.\n","operationId":"getLinodeConfigs","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LinodeConfig"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns an array of Configuration profiles associated with this Linode.\n"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Configuration Profiles List","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/configs\n"},{"lang":"CLI","source":"linode-cli linodes configs-list 123\n"}],"x-linode-cli-action":"configs-list"},"parameters":[{"description":"ID of the Linode to look up Configuration profiles for.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Adds a new Configuration profile to a Linode.\n","operationId":"addLinodeConfig","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LinodeConfig"}],"required":["label","devices"]}}},"description":"The parameters to set when creating the Configuration profile.\nThis determines which kernel, devices, how much memory, etc. a Linode boots with.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinodeConfig"}}},"description":"A Configuration profile was created.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Configuration Profile Create","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"kernel\": \"linode/latest-64bit\",\n \"comments\": \"This is my main Config\",\n \"memory_limit\": 2048,\n \"run_level\": \"default\",\n \"virt_mode\": \"paravirt\",\n \"interfaces\": [\n {\n \"purpose\": \"public\",\n \"label\": \"\",\n \"ipam_address\": \"\"\n },\n {\n \"purpose\": \"vlan\",\n \"label\": \"vlan-1\",\n \"ipam_address\": \"10.0.0.1/24\"\n }\n ],\n \"helpers\": {\n \"updatedb_disabled\": true,\n \"distro\": true,\n \"modules_dep\": true,\n \"network\": true,\n \"devtmpfs_automount\": false\n },\n \"label\": \"My Config\",\n \"devices\": {\n \"sda\": {\n \"disk_id\": 123456,\n \"volume_id\": null\n },\n \"sdb\": {\n \"disk_id\": 123457,\n \"volume_id\": null\n }\n }\n }' \\\n https://api.linode.com/v4/linode/instances/123/configs\n"},{"lang":"CLI","source":"linode-cli linodes config-create 7590910 \\\n --label \"My Config\" \\\n --devices.sda.disk_id 123456 \\\n --devices.sdb.disk_id 123457\n"}],"x-linode-cli-action":"config-create"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/configs/{configId}":{"delete":{"description":"Deletes the specified Configuration profile from the specified Linode.\n","operationId":"deleteLinodeConfig","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Configuration profile successfully deleted.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Configuration Profile Delete","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/linode/instances/123/configs/23456\n"},{"lang":"CLI","source":"linode-cli linodes config-delete 123 23456\n"}],"x-linode-cli-action":"config-delete","x-linode-grant":"read_write"},"get":{"description":"Returns information about a specific Configuration profile.\n","operationId":"getLinodeConfig","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinodeConfig"}}},"description":"A Configuration profile object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Configuration Profile View","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/configs/23456\n"},{"lang":"CLI","source":"linode-cli linodes config-view 123 23456\n"}],"x-linode-cli-action":"config-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Linode whose Configuration profile to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Configuration profile to look up.","in":"path","name":"configId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates a Configuration profile.\n","operationId":"updateLinodeConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinodeConfig"}}},"description":"The Configuration profile parameters to modify.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinodeConfig"}}},"description":"Configuration profile successfully updated."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Configuration Profile Update","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"kernel\": \"linode/latest-64bit\",\n \"comments\": \"This is my main Config\",\n \"memory_limit\": 2048,\n \"run_level\": \"default\",\n \"virt_mode\": \"paravirt\",\n \"interfaces\": [\n {\n \"purpose\": \"public\",\n \"label\": \"\",\n \"ipam_address\": \"\"\n },\n {\n \"purpose\": \"vlan\",\n \"label\": \"vlan-1\",\n \"ipam_address\": \"10.0.0.1/24\"\n }\n ],\n \"helpers\": {\n \"updatedb_disabled\": true,\n \"distro\": true,\n \"modules_dep\": true,\n \"network\": true,\n \"devtmpfs_automount\": false\n },\n \"label\": \"My Config\",\n \"devices\": {\n \"sda\": {\n \"disk_id\": 123456,\n \"volume_id\": null\n },\n \"sdb\": {\n \"disk_id\": 123457,\n \"volume_id\": null\n }\n }\n }' \\\n https://api.linode.com/v4/linode/instances/123/configs/23456\n"},{"lang":"CLI","source":"linode-cli linodes config-update 123 23456 \\\n --kernel \"linode/latest-64bit\" \\\n --comments \"This is my main Config\" \\\n --memory_limit 2048 \\\n --run_level default \\\n --virt_mode paravirt \\\n --helpers.updatedb_disabled true \\\n --helpers.distro true \\\n --helpers.modules_dep true \\\n --helpers.network true \\\n --helpers.devtmpfs_automount false \\\n --label \"My Config\" \\\n --devices.sda.disk_id 123456 \\\n --devices.sdb.disk_id 123457\n"}],"x-linode-cli-action":"config-update","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/disks":{"get":{"description":"View Disk information for Disks associated with this Linode.\n","operationId":"getLinodeDisks","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Disk"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of disks associated with this Linode."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Disks List","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/disks\n"},{"lang":"CLI","source":"linode-cli linodes disks-list 123\n"}],"x-linode-cli-action":"disks-list","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Adds a new Disk to a Linode.\n\n* You can optionally create a Disk from an Image or an Empty Disk if no Image is provided with a request.\n\n* When creating an Empty Disk, providing a `label` is required.\n\n* If no `label` is provided, an `image` is required instead.\n\n* When creating a Disk from an Image, `root_pass` is required.\n\n* The default filesystem for new Disks is `ext4`. If creating a Disk from an Image, the filesystem\nof the Image is used unless otherwise specified.\n\n* When deploying a StackScript on a Disk:\n * See StackScripts List ([GET /linode/stackscripts](/docs/api/stackscripts/#stackscripts-list)) for\n a list of available StackScripts.\n * Requires a compatible Image to be supplied.\n * See StackScript View ([GET /linode/stackscript/{stackscriptId}](/docs/api/stackscripts/#stackscript-view)) for compatible Images.\n * It is recommended to supply SSH keys for the root User using the `authorized_keys` field.\n * You may also supply a list of usernames via the `authorized_users` field.\n * These users must have an SSH Key associated with their Profiles first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information.\n","operationId":"addLinodeDisk","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DiskRequest"}],"required":["size"]}}},"description":"The parameters to set when creating the Disk.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disk"}}},"description":"Disk created."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Disk Create","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"Debian 9 Disk\",\n \"image\": \"linode/debian9\",\n \"size\": 1300,\n \"authorized_keys\": [\n \"ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer\"\n ],\n \"authorized_users\": [\n \"myUser\",\n \"secondaryUser\"\n ],\n \"root_pass\": \"aComplexP@ssword\",\n \"stackscript_id\": 10079,\n \"stackscript_data\": {\n \"gh_username\": \"linode\"\n }\n }' \\\n https://api.linode.com/v4/linode/instances/123/disks\n"},{"lang":"CLI","source":"linode-cli linodes disk-create 123 \\\n --size 1300 \\\n --authorized_keys \"ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer\" \\\n --authorized_users \"myUser\" \\\n --authorized_users \"secondaryUser\" \\\n --root_pass aComplex@Password \\\n --image \"linode/debian9\" \\\n --stackscript_id 10079 \\\n --stackscript_data '{\"gh_username\": \"linode\"}'\n"}],"x-linode-cli-action":"disk-create"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/disks/{diskId}":{"delete":{"description":"Deletes a Disk you have permission to `read_write`.\n\n**Deleting a Disk is a destructive action and cannot be undone.**\n","operationId":"deleteDisk","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Delete successful"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Disk Delete","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/linode/instances/123/disks/25674\n"},{"lang":"CLI","source":"linode-cli linodes disk-delete 123 24674\n"}],"x-linode-cli-action":"disk-delete","x-linode-grant":"read_write"},"get":{"description":"View Disk information for a Disk associated with this Linode.\n","operationId":"getLinodeDisk","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disk"}}},"description":"Returns a single Disk object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Disk View","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/disks/25674\n"},{"lang":"CLI","source":"linode-cli linodes disk-view 123 25674\n"}],"x-linode-cli-action":"disk-view","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}},{"description":"ID of the Disk to look up.","in":"path","name":"diskId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates a Disk that you have permission to `read_write`.\n","operationId":"updateDisk","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disk"}}},"description":"Updates the parameters of a single Disk.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disk"}}},"description":"The updated Disk."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Disk Update","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"Debian 9 Disk\"\n }' \\\n https://api.linode.com/v4/linode/instances/123/disks/25674\n"},{"lang":"CLI","source":"linode-cli linodes disk-update 123 25674 \\\n --label \"Debian 9 Disk\"\n"}],"x-linode-cli-action":"disk-update","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/disks/{diskId}/clone":{"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}},{"description":"ID of the Disk to clone.","in":"path","name":"diskId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Copies a disk, byte-for-byte, into a new Disk belonging to the same Linode. The Linode must have enough storage space available to accept a new Disk of the same size as this one or this operation will fail.\n","operationId":"cloneLinodeDisk","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disk"}}},"description":"Disk clone initiated."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Disk Clone","tags":["Linode Instances"],"x-linode-cli-action":"disk-clone","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/disks/{diskId}/password":{"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}},{"description":"ID of the Disk to look up.","in":"path","name":"diskId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Resets the password of a Disk you have permission to `read_write`.\n","operationId":"resetDiskPassword","requestBody":{"content":{"application/json":{"schema":{"properties":{"password":{"description":"The new root password for the OS installed on this Disk.\nThe password must meet the complexity strength validation requirements for a strong password.\n","example":"another@complex^Password123","type":"string"}},"required":["password"]}}},"description":"The new password.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Returns a single Disk object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Disk Root Password Reset","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"password\": \"another@complex^Password123\"\n }' \\\n https://api.linode.com/v4/linode/instances/123/disks/25674/password\n"},{"lang":"CLI","source":"linode-cli linodes disk-reset-password \\\n 123 25674 \\\n --password aComplex@Password\n"}],"x-linode-cli-action":"disk-reset-password","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/disks/{diskId}/resize":{"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}},{"description":"ID of the Disk to look up.","in":"path","name":"diskId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Resizes a Disk you have permission to `read_write`.\n\nThe Disk must not be in use. If the Disk is in use, the request will\nsucceed but the resize will ultimately fail. For a request to succeed,\nthe Linode must be shut down prior to resizing the Disk, or the Disk\nmust not be assigned to the Linode's active Configuration Profile.\n\nIf you are resizing the Disk to a smaller size, it cannot be made smaller\nthan what is required by the total size of the files current on the Disk.\n","operationId":"resizeDisk","requestBody":{"content":{"application/json":{"schema":{"properties":{"size":{"description":"The desired size, in MB, of the disk.\n","example":2048,"minimum":1,"type":"integer"}},"required":["size"]}}},"description":"The new size of the Disk.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Resize started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Disk Resize","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"size\": 2048\n }' \\\n https://api.linode.com/v4/linode/instances/123/disks/25674/resize\n"},{"lang":"CLI","source":"linode-cli linodes disk-resize 123 25674 \\\n --size 2048\n"}],"x-linode-cli-action":"disk-resize","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/firewalls":{"get":{"description":"View Firewall information for Firewalls associated with this Linode.\n","operationId":"getLinodeFirewalls","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Firewall"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of Firewalls associated with this Linode."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Firewalls List","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/firewalls\n"},{"lang":"CLI","source":"linode-cli linodes firewalls-list 123\n"}],"x-linode-cli-action":"firewalls-list","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/ips":{"get":{"description":"Returns networking information for a single Linode.\n","operationId":"getLinodeIPs","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"ipv4":{"description":"Information about this Linode's IPv4 addresses.\n","properties":{"private":{"description":"A list of private IP Address objects belonging to this Linode.\n","items":{"$ref":"#/components/schemas/IPAddressPrivate"},"readOnly":true,"type":"array"},"public":{"description":"A list of public IP Address objects belonging to this Linode.\n","items":{"$ref":"#/components/schemas/IPAddress"},"readOnly":true,"type":"array"},"reserved":{"description":"A list of reserved IP Address objects belonging to this Linode.\n","items":{"$ref":"#/components/schemas/IPAddress"},"readOnly":true,"type":"array"},"shared":{"description":"A list of shared IP Address objects assigned to this Linode.\n","items":{"$ref":"#/components/schemas/IPAddress"},"readOnly":true,"type":"array"}},"readOnly":true,"type":"object"},"ipv6":{"description":"Information about this Linode's IPv6 addresses.\n","properties":{"global":{"$ref":"#/components/schemas/IPv6Pool"},"link_local":{"$ref":"#/components/schemas/IPAddressV6LinkLocal"},"slaac":{"$ref":"#/components/schemas/IPAddressV6Slaac"}},"readOnly":true,"type":"object"}}}}},"description":"Requested Linode's networking configuration."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Networking Information List","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n https://api.linode.com/v4/linode/instances/123/ips\n"},{"lang":"CLI","source":"linode-cli linodes 123 ips-list\n"}],"x-linode-cli-action":"ips-list","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Allocates a public or private IPv4 address to a Linode. Public IP Addresses, after the one included with each Linode, incur an additional monthly charge. If you need an additional public IP Address you must request one - please [open a support ticket](/docs/api/support/#support-ticket-open). You may not add more than one private IPv4 address to a single Linode.\n","operationId":"addLinodeIP","requestBody":{"content":{"application/json":{"schema":{"properties":{"public":{"description":"Whether to create a public or private IPv4 address.\n","example":true,"type":"boolean"},"type":{"description":"The type of address you are allocating. Only IPv4 addresses may be allocated through this endpoint.\n","enum":["ipv4"],"example":"ipv4","type":"string"}},"required":["type","public"]}}},"description":"Information about the address you are creating.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPAddress"}}},"description":"IP address was successfully allocated."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"IPv4 Address Allocate","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"type\": \"ipv4\",\n \"public\": true\n }' \\\n https://api.linode.com/v4/linode/instances/123/ips\n"},{"lang":"CLI","source":"linode-cli linodes ip-add 123 \\\n --type ipv4 \\\n --public true\n"}],"x-linode-cli-action":"ip-add","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/ips/{address}":{"delete":{"description":"Deletes a public or private IPv4 address associated with this Linode. This will fail if it is the Linode's last remaining public IPv4 address.\n","operationId":"removeLinodeIP","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"IP address successfully removed."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"IPv4 Address Delete","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/linode/instances/123/ips/97.107.143.141\n"},{"lang":"CLI","source":"linode-cli linodes ip-delete 97.107.143.141\n"}],"x-linode-cli-action":"ip-delete","x-linode-grant":"read_write"},"get":{"description":"View information about the specified IP address associated with the specified Linode.\n","operationId":"getLinodeIP","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPAddress"}}},"description":"A single IP address."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"IP Address View","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n https://api.linode.com/v4/linode/instances/123/ips/97.107.143.141\n"},{"lang":"CLI","source":"linode-cli linodes ip-view 123 97.107.143.141\n"}],"x-linode-cli-action":"ip-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}},{"description":"The IP address to look up.","in":"path","name":"address","required":true,"schema":{"format":"ip","type":"string"}}],"put":{"description":"Updates a the reverse DNS (RDNS) for a particular IP Address associated with this Linode.\n\nSetting the RDNS to `null` for a public IPv4 address, resets it to the default \"ip.linodeusercontent.com\" RDNS value.\n","operationId":"updateLinodeIP","requestBody":{"content":{"application/json":{"schema":{"properties":{"rdns":{"description":"The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set.\n","example":"test.example.org","nullable":true,"type":"string"}},"required":["rdns"],"type":"object"}}},"description":"The information to update for the IP address."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPAddress"}}},"description":"The updated IP address record."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"IP Address Update","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"rdns\": \"test.example.org\"\n }' \\\n https://api.linode.com/v4/linode/instances/123/ips/203.0.113.1\n"},{"lang":"CLI","source":"linode-cli linodes ip-update 123 \\\n 203.0.113.1 \\\n --rdns test.example.org\n"}],"x-linode-cli-action":"ip-update","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/migrate":{"parameters":[{"description":"ID of the Linode to migrate.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Initiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration. A list of pending migrations, if any, can be accessed from [GET /account/notifications](/docs/api/account/#notifications-list). When the migration begins, your Linode will be shutdown if not already off. If the migration initiated the shutdown, it will reboot the Linode when completed.\n\nTo initiate a cross DC migration, you must pass a `region` parameter to the request body specifying the target data center region. You can view a list of all available regions and their feature capabilities from [GET /regions](/docs/api/regions/#regions-list). If your Linode has a DC migration already queued or you have initiated a previously scheduled migration, you will not be able to initiate a DC migration until it has completed.\n\n**Note:** Next Generation Network (NGN) data centers do not support IPv6 `/116` pools or IP Failover. If you have these features enabled on your Linode and attempt to migrate to an NGN data center, the migration will not initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support.\n","operationId":"migrateLinodeInstance","requestBody":{"content":{"application/json":{"schema":{"properties":{"region":{"description":"The region to which the Linode will be migrated. Must be a valid region slug. A list of regions can be viewed by using the [GET /regions](/docs/api/regions/#regions-list) endpoint. A cross data center migration will cancel a pending migration that has not yet been initiated.\nA cross data center migration will initiate a `linode_migrate_datacenter_create` event.\n","example":"us-east","type":"string"},"upgrade":{"default":false,"description":"When initiating a cross DC migration, setting this value to true will also ensure that the Linode is upgraded to the latest generation of hardware that corresponds to your Linode's Type, if any free upgrades are available for it.\nIf no free upgrades are available, and this value is set to true, then the endpoint will return a 400 error code and the migration will not be performed.\nIf the data center set in the `region` field does not allow upgrades, then the endpoint will return a 400 error code and the migration will not be performed.\n","example":false,"type":"boolean"}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Scheduled migration started"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"DC Migration/Pending Host Migration Initiate","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"region\": \"us-central\"\n }' \\\n https://api.linode.com/v4/linode/instances/123/migrate\n"},{"lang":"CLI","source":"linode-cli linodes migrate 123 --region us-central\n"}],"x-linode-cli-action":"migrate","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/mutate":{"parameters":[{"description":"ID of the Linode to mutate.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Linodes created with now-deprecated Types are entitled to a free upgrade to the next generation. A mutating Linode will be allocated any new resources the upgraded Type provides, and will be subsequently restarted if it was currently running.\nIf any actions are currently running or queued, those actions must be completed first before you can initiate a mutate.\n","operationId":"mutateLinodeInstance","requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_auto_disk_resize":{"default":true,"description":"Automatically resize disks when resizing a Linode. When resizing down to a smaller plan your Linode's data must fit within the smaller disk size.\n","example":true,"type":"boolean"}},"type":"object"}}},"description":"Whether to automatically resize disks or not.","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Mutate started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Upgrade","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/linode/instances/123/mutate\n"},{"lang":"CLI","source":"linode-cli linodes upgrade 123\n"}],"x-linode-cli-action":"upgrade","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/nodebalancers":{"get":{"description":"Returns a list of NodeBalancers that are assigned to this Linode and readable by the requesting User.\n\nRead permission to a NodeBalancer can be given to a User by accessing the User's Grants Update\n([PUT /account/users/{username}/grants](/docs/api/account/#users-grants-update)) endpoint.\n","operationId":"getLinodeNodeBalancers","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NodeBalancer"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of NodeBalancers."}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Linode NodeBalancers View","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/nodebalancers\n"},{"lang":"CLI","source":"linode-cli linodes nodebalancers 123\n"}],"x-linode-cli-action":"nodebalancers","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Linode to look up","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/password":{"parameters":[{"description":"ID of the Linode for which to reset its root password.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Resets the root password for this Linode.\n* Your Linode must be [shut down](/docs/api/linode-instances/#linode-shut-down) for a password reset to complete.\n* If your Linode has more than one disk (not counting its swap disk), use the [Reset Disk Root Password](/docs/api/linode-instances/#disk-root-password-reset) endpoint to update a specific disk's root password.\n* A `password_reset` event is generated when a root password reset is successful.\n","operationId":"resetLinodePassword","requestBody":{"content":{"application/json":{"schema":{"properties":{"root_pass":{"description":"The root user's password on this Linode. Linode passwords must meet a password strength score requirement that is calculated internally by the API. If the strength requirement is not met, you will receive a Password does not meet strength requirement error.\n","example":"a$eCure4assw0rd!43v51","type":"string"}},"required":["root_pass"]}}},"description":"This Linode's new root password."},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Password Reset."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Root Password Reset","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"root_pass\": \"a$eCure4assw0rd!43v51\"\n }' \\\n https://api.linode.com/v4/linode/instances/123/password\n"},{"lang":"CLI","source":"linode-cli linodes linode-reset-password 123 a$eCure4assw0rd!43v51\n"}],"x-linode-cli-action":"linode-reset-password","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/reboot":{"parameters":[{"description":"ID of the linode to reboot.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Reboots a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a reboot.\n","operationId":"rebootLinodeInstance","requestBody":{"content":{"application/json":{"schema":{"properties":{"config_id":{"description":"The Linode Config ID to reboot into. If null or omitted, the last booted config will be used. If there was no last booted config and this Linode only has one config, it will be used. If a config cannot be determined, an error will be returned.\n","example":null,"type":"integer"}}}}},"description":"Optional reboot parameters."},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Reboot started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Reboot","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/linode/instances/123/reboot\n"},{"lang":"CLI","source":"linode-cli linodes reboot 123\n"}],"x-linode-cli-action":"reboot","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/rebuild":{"parameters":[{"description":"ID of the Linode to rebuild.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Rebuilds a Linode you have the `read_write` permission to modify.\nA rebuild will first shut down the Linode, delete all disks and configs on the Linode, and then deploy a new `image` to the Linode with the given attributes. Additionally:\n\n * Requires an `image` be supplied.\n * Requires a `root_pass` be supplied to use for the root User's Account.\n * It is recommended to supply SSH keys for the root User using the\n `authorized_keys` field.\n","operationId":"rebuildLinodeInstance","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LinodeRequest"}],"required":["image","root_pass"],"type":"object"}}},"description":"The requested state your Linode will be rebuilt into.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Linode"}}},"description":"Rebuild started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Rebuild","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"image\": \"linode/debian9\",\n \"root_pass\": \"aComplexP@ssword\",\n \"authorized_keys\": [\n \"ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer\"\n ],\n \"authorized_users\": [\n \"myUsername\",\n \"secondaryUsername\"\n ],\n \"booted\": true,\n \"stackscript_id\": 10079,\n \"stackscript_data\": {\n \"gh_username\": \"linode\"\n }\n }' \\\n https://api.linode.com/v4/linode/instances/123/rebuild\n"},{"lang":"CLI","source":"linode-cli linodes rebuild 123 \\\n --image \"linode/debian9\" \\\n --root_pass aComplex@Password \\\n --authorized_keys \"ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer\" \\\n --authorized_users \"myUsername\" \\\n --authorized_users \"secondaryUsername\" \\\n --booted true \\\n --stackscript_id 10079 \\\n --stackscript_data '{\"gh_username\": \"linode\"}'\n"}],"x-linode-cli-action":"rebuild","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/rescue":{"parameters":[{"description":"ID of the Linode to rescue.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Rescue Mode is a safe environment for performing many system recovery and disk management tasks. Rescue Mode is based on the Finnix recovery distribution, a self-contained and bootable Linux distribution. You can also use Rescue Mode for tasks other than disaster recovery, such as formatting disks to use different filesystems, copying data between disks, and downloading files from a disk via SSH and SFTP.\n* Note that \"sdh\" is reserved and unavailable during rescue.\n","operationId":"rescueLinodeInstance","requestBody":{"content":{"application/json":{"schema":{"properties":{"devices":{"$ref":"#/components/schemas/RescueDevices"}},"type":"object"}}},"description":"Optional object of devices to be mounted.","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Rescue started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Boot into Rescue Mode","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"devices\": {\n \"sda\": {\n \"disk_id\": 124458,\n \"volume_id\": null\n },\n \"sdb\": {\n \"disk_id\": null,\n \"volume_id\": null\n }\n }\n }' \\\n https://api.linode.com/v4/linode/instances/123/rescue\n"},{"lang":"CLI","source":"linode-cli linodes rescue 123 \\\n --devices.sda.disk_id 124458\n"}],"x-linode-cli-action":"rescue","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/resize":{"parameters":[{"description":"ID of the Linode to resize.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Resizes a Linode you have the `read_write` permission to a different Type. If any actions are currently running or queued, those actions must be completed first before you can initiate a resize. Additionally, the following criteria must be met in order to resize a Linode:\n\n * The Linode must not have a pending migration.\n * Your Account cannot have an outstanding balance.\n * The Linode must not have more disk allocation than the new Type allows.\n * In that situation, you must first delete or resize the disk to be smaller.\n","operationId":"resizeLinodeInstance","requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_auto_disk_resize":{"default":true,"description":"Automatically resize disks when resizing a Linode. When resizing down to a smaller plan your Linode's data must fit within the smaller disk size.\n","example":true,"type":"boolean"},"type":{"description":"The ID representing the Linode Type.","example":"g6-standard-2","type":"string","x-linode-cli-display":1}},"required":["type"],"type":"object"}}},"description":"The Type your current Linode will resize to, and whether to attempt to automatically resize the Linode's disks.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Resize started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Resize","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"type\": \"g6-standard-2\"\n }' \\\n https://api.linode.com/v4/linode/instances/123/resize\n"},{"lang":"CLI","source":"linode-cli linodes resize 123 \\\n --type g6-standard-2\n"}],"x-linode-cli-action":"resize","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/shutdown":{"parameters":[{"description":"ID of the Linode to shutdown.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Shuts down a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a shutdown.\n","operationId":"shutdownLinodeInstance","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Shutdown started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_write"]}],"summary":"Linode Shut Down","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/linode/instances/123/shutdown\n"},{"lang":"CLI","source":"linode-cli linodes shutdown 123\n"}],"x-linode-cli-action":"shutdown","x-linode-grant":"read_write"},"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/stats":{"get":{"description":"Returns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours.\n","operationId":"getLinodeStats","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinodeStats"}}},"description":"The Linode's stats for the past 24 hours."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Linode Statistics View","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/stats\n"}],"x-linode-cli-action":"stats","x-linode-cli-skip":true},"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/stats/{year}/{month}":{"get":{"description":"Returns statistics for a specific month. The year/month values must be either a date in the past, or the current month. If the current month, statistics will be retrieved for the past 30 days.\n","operationId":"getLinodeStatsByYearMonth","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinodeStats"}}},"description":"The Linode's statistics for the requested period."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Statistics View (year/month)","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/stats/2018/01\n"}],"x-linode-cli-action":"stats-month","x-linode-cli-skip":true},"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}},{"description":"Numeric value representing the year to look up.","in":"path","name":"year","required":true,"schema":{"type":"integer"}},{"description":"Numeric value representing the month to look up.","in":"path","name":"month","required":true,"schema":{"maximum":12,"minimum":1,"type":"integer"}}],"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/transfer":{"get":{"description":"Returns a Linode's network transfer pool statistics for the current month.\n","operationId":"getLinodeTransfer","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"billable":{"description":"The amount of network transfer this Linode has used, in GB, past your monthly quota.\n","example":0,"readOnly":true,"type":"integer"},"quota":{"description":"The amount of network transfer this Linode adds to your transfer pool, in GB, for the current month's billing cycle.\n","example":2000,"readOnly":true,"type":"integer"},"used":{"description":"The amount of network transfer used by this Linode, in bytes, for the current month's billing cycle.\n","example":22956600198,"readOnly":true,"type":"integer"}}}}},"description":"A collection of the specified Linode's network transfer statistics."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Network Transfer View","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/transfer\n"},{"lang":"CLI","source":"linode-cli linodes transfer-view 123\n"}],"x-linode-cli-action":"transfer-view","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/transfer/{year}/{month}":{"get":{"description":"Returns a Linode's network transfer statistics for a specific month. The year/month values must be either a date in the past, or the current month.\n","operationId":"getLinodeTransferByYearMonth","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"bytes_in":{"description":"The amount of inbound public network traffic received by this Linode, in bytes, for a specific year/month.\n","example":30471077120,"readOnly":true,"type":"integer"},"bytes_out":{"description":"The amount of outbound public network traffic sent by this Linode, in bytes, for a specific year/month.\n","example":22956600198,"readOnly":true,"type":"integer"},"bytes_total":{"description":"The total amount of public network traffic sent and received by this Linode, in bytes, for a specific year/month.\n","example":53427677318,"readOnly":true,"type":"integer"}}}}},"description":"A collection of the specified Linode's network transfer statistics for the requested month.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Network Transfer View (year/month)","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/transfer/2018/01\n"}],"x-linode-cli-action":"transfer-month","x-linode-cli-skip":true,"x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}},{"description":"Numeric value representing the year to look up.","in":"path","name":"year","required":true,"schema":{"maximum":2037,"minimum":2000,"type":"integer"}},{"description":"Numeric value representing the month to look up.","in":"path","name":"month","required":true,"schema":{"maximum":12,"minimum":1,"type":"integer"}}],"x-linode-cli-command":"linodes"},"/linode/instances/{linodeId}/volumes":{"get":{"description":"View Block Storage Volumes attached to this Linode.\n","operationId":"getLinodeVolumes","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Volume"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns an array of Block Storage Volumes attached to this Linode.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"summary":"Linode's Volumes List","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/linode/instances/123/volumes\n"},{"lang":"CLI","source":"linode-cli linode volumes 123\n"}],"x-linode-cli-action":"volumes"},"parameters":[{"description":"ID of the Linode to look up.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"linodes"},"/linode/kernels":{"get":{"description":"Lists available Kernels.\n","operationId":"getKernels","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Kernel"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns an array of Kernels."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Kernels List","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/linode/kernels\n"},{"lang":"CLI","source":"linode-cli kernels list\n"}],"x-linode-cli-action":["list","ls"]},"x-linode-cli-command":"kernels"},"/linode/kernels/{kernelId}":{"get":{"description":"Returns information about a single Kernel.\n","operationId":"getKernel","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Kernel"}}},"description":"A single Kernel object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Kernel View","tags":["Linode Instances"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/linode/kernels/linode/latest-64bit\n"},{"lang":"CLI","source":"linode-cli kernels view latest-64bit\n"}],"x-linode-cli-action":"view"},"parameters":[{"description":"ID of the Kernel to look up.","in":"path","name":"kernelId","required":true,"schema":{"type":"string"}}],"x-linode-cli-command":"kernels"},"/linode/stackscripts":{"get":{"description":"If the request is not authenticated, only public StackScripts are returned.\n\nFor more information on StackScripts, please read our [StackScripts documentation](/docs/products/tools/stackscripts/).\n","operationId":"getStackScripts","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/StackScript"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A list of StackScripts available to the User, including private StackScripts owned by the User if the request is authenticated.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["stackscripts:read_only"]}],"summary":"StackScripts List","tags":["StackScripts"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/linode/stackscripts\n"},{"lang":"CLI","source":"linode-cli stackscripts list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Creates a StackScript in your Account.\n","operationId":"addStackScript","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/StackScript"}],"required":["script","label","images"]}}},"description":"The properties to set for the new StackScript.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackScript"}}},"description":"StackScript successfully created."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["stackscripts:read_write"]}],"summary":"StackScript Create","tags":["StackScripts"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"a-stackscript\",\n \"description\": \"This StackScript installs and configures MySQL\",\n \"images\": [\n \"linode/debian9\",\n \"linode/debian8\"\n ],\n \"is_public\": true,\n \"rev_note\": \"Set up MySQL\",\n \"script\": \"#!/bin/bash\"\n }' \\\n https://api.linode.com/v4/linode/stackscripts\n"},{"lang":"CLI","source":"linode-cli stackscripts create \\\n --label a-stackscript \\\n --description \"This StackScript install and configures MySQL\" \\\n --images \"linode/debian9\" \\\n --images \"linode/debian8\" \\\n --is_public true \\\n --rev_note \"Set up MySQL\" \\\n --script '#!/bin/bash'\n"}],"x-linode-cli-action":"create","x-linode-grant":"add_stackscripts"},"x-linode-cli-command":"stackscripts"},"/linode/stackscripts/{stackscriptId}":{"delete":{"description":"Deletes a private StackScript you have permission to `read_write`. You cannot delete a public StackScript.\n","operationId":"deleteStackScript","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"StackScript was deleted."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["stackscripts:read_write"]}],"summary":"StackScript Delete","tags":["StackScripts"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/linode/stackscripts/10079\n"},{"lang":"CLI","source":"linode-cli stackscripts delete 10079\n"}],"x-linode-cli-action":["delete","rm"],"x-linode-grant":"read_write"},"get":{"description":"Returns all of the information about a specified StackScript, including the contents of the script.\n","operationId":"getStackScript","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackScript"}}},"description":"A single StackScript."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["stackscripts:read_only"]}],"summary":"StackScript View","tags":["StackScripts"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/linode/stackscripts/10079\n"},{"lang":"CLI","source":"linode-cli stackscripts view 10079\n"}],"x-linode-cli-action":"view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the StackScript to look up.","in":"path","name":"stackscriptId","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates a StackScript.\n\n**Once a StackScript is made public, it cannot be made private.**\n","operationId":"updateStackScript","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackScript"}}},"description":"The fields to update."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackScript"}}},"description":"StackScript was successfully modified."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["stackscripts:read_write"]}],"summary":"StackScript Update","tags":["StackScripts"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"a-stackscript\",\n \"description\": \"This StackScript installs and configures MySQL\",\n \"images\": [\n \"linode/debian9\",\n \"linode/debian8\"\n ],\n \"is_public\": true,\n \"rev_note\": \"Set up MySQL\",\n \"script\": \"#!/bin/bash\"\n }' \\\n https://api.linode.com/v4/linode/stackscripts/10079\n"},{"lang":"CLI","source":"linode-cli stackscripts update 10079 \\\n --label a-stackscript \\\n --description \"This StackScript installs \\\n and configures MySQL\" \\\n --images \"linode/debian9\" \\\n --images \"linode/debian8\" \\\n --is_public true \\\n --rev_note \"Set up MySQL\" \\\n --script '#!/bin/bash'\n"}],"x-linode-cli-action":"update","x-linode-grant":"read_write"},"x-linode-cli-command":"stackscripts"},"/linode/types":{"get":{"description":"Returns collection of Linode Types, including pricing and specifications for each Type. These are used when [creating](/docs/api/linode-instances/#linode-create) or [resizing](/docs/api/linode-instances/#linode-resize) Linodes.\n","operationId":"getLinodeTypes","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LinodeType"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A collection of Linode Types."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Types List","tags":["Linode Types"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/linode/types\n"},{"lang":"CLI","source":"linode-cli linodes types\n"}],"x-linode-cli-action":"types","x-linode-redoc-load-ids":true},"x-linode-cli-command":"linodes"},"/linode/types/{typeId}":{"get":{"description":"Returns information about a specific Linode Type, including pricing and specifications. This is used when [creating](/docs/api/linode-instances/#linode-create) or [resizing](/docs/api/linode-instances/#linode-resize) Linodes.\n","operationId":"getLinodeType","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinodeType"}}},"description":"A single Linode Type."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Type View","tags":["Linode Types"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/linode/types/g6-standard-2\n"},{"lang":"CLI","source":"linode-cli linodes type-view g6-standard-2\n"}],"x-linode-cli-action":"type-view"},"parameters":[{"description":"The ID of the Linode Type to look up.","in":"path","name":"typeId","required":true,"schema":{"type":"string"}}],"x-linode-cli-command":"linodes"},"/lke/clusters":{"get":{"description":"Lists current Kubernetes clusters available on your account.\n","operationId":"getLKEClusters","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LKECluster"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns an array of all Kubernetes clusters on your Account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_only"]}],"summary":"Kubernetes Clusters List","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/lke/clusters\n"},{"lang":"CLI","source":"linode-cli lke clusters-list\n"}],"x-linode-cli-action":"clusters-list","x-linode-grant":"read_only"},"post":{"description":"Creates a Kubernetes cluster. The Kubernetes cluster will be created\nasynchronously. You can use the events system to determine when the\nKubernetes cluster is ready to use. Please note that it often takes 2-5 minutes before the\n[Kubernetes API server endpoint](/docs/api/linode-kubernetes-engine-lke/#kubernetes-api-endpoints-list) and\nthe [Kubeconfig file](/docs/api/linode-kubernetes-engine-lke/#kubeconfig-view) for the new cluster\nare ready.\n","operationId":"createLKECluster","requestBody":{"content":{"application/json":{"schema":{"properties":{"control_plane":{"description":"Defines settings for the Kubernetes Control Plane. Allows for the enabling of High Availability (HA) for Control Plane Components. Enabling High Availability for LKE is an **irreversible** change.\n","properties":{"high_availability":{"description":"Defines whether High Availability is enabled for the Control Plane Components of the cluster. Defaults to `false`.\n","example":true,"type":"boolean"}},"type":"object"},"k8s_version":{"$ref":"#/components/schemas/LKECluster/properties/k8s_version"},"label":{"$ref":"#/components/schemas/LKECluster/properties/label"},"node_pools":{"items":{"$ref":"#/components/schemas/LKENodePoolRequestBody"},"required":["type","count"],"type":"array"},"region":{"$ref":"#/components/schemas/LKECluster/properties/region"},"tags":{"$ref":"#/components/schemas/LKECluster/properties/tags"}},"required":["label","region","k8s_version","node_pools"],"type":"object"}}},"description":"Configuration for the Kubernetes cluster","x-linode-cli-allowed-defaults":["region"]},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LKECluster"}}},"description":"Kubernetes cluster creation has started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Kubernetes Cluster Create","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"cluster12345\",\n \"region\": \"us-central\",\n \"k8s_version\": \"1.25\",\n \"tags\": [\"ecomm\", \"blogs\"],\n \"control_plane\": {\n \"high_availability\": true\n },\n \"node_pools\": [\n {\n \"type\": \"g6-standard-4\",\n \"count\": 6,\n \"autoscaler\": {\n \"enabled\": true,\n \"max\": 12,\n \"min\": 3\n }\n },\n {\n \"type\": \"g6-standard-8\",\n \"count\": 3\n }\n ]\n }' \\\n https://api.linode.com/v4/lke/clusters\n"},{"lang":"CLI","source":"linode-cli lke cluster-create \\\n --label cluster12345 \\\n --region us-central \\\n --k8s_version 1.25 \\\n --control_plane.high_availability true \\\n --node_pools.type g6-standard-4 --node_pools.count 6 \\\n --node_pools.type g6-standard-8 --node_pools.count 3 \\\n --node_pools.autoscaler.enabled true \\\n --node_pools.autoscaler.max 12 \\\n --node_pools.autoscaler.min 3 \\\n --tags ecomm\n"}],"x-linode-charge":true,"x-linode-cli-action":"cluster-create","x-linode-grant":"add_clusters"},"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}":{"delete":{"description":"Deletes a Cluster you have permission to `read_write`.\n\n**Deleting a Cluster is a destructive action and cannot be undone.**\n\nDeleting a Cluster:\n - Deletes all Linodes in all pools within this Kubernetes cluster\n - Deletes all supporting Kubernetes services for this Kubernetes\n cluster (API server, etcd, etc)\n - Deletes all NodeBalancers created by this Kubernetes cluster\n - Does not delete any of the volumes created by this Kubernetes\n cluster\n","operationId":"deleteLKECluster","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Delete successful"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Kubernetes Cluster Delete","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/lke/clusters/12345\n"},{"lang":"CLI","source":"linode-cli lke cluster-delete 12345\n"}],"x-linode-cli-action":"cluster-delete"},"get":{"description":"Get a specific Cluster by ID.\n","operationId":"getLKECluster","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LKECluster"}}},"description":"Returns a single Kubernetes cluster."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_only"]}],"summary":"Kubernetes Cluster View","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/lke/clusters/12345\n"},{"lang":"CLI","source":"linode-cli lke cluster-view 12345"}],"x-linode-cli-action":"cluster-view"},"parameters":[{"description":"ID of the Kubernetes cluster to look up.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates a Kubernetes cluster.\n","operationId":"putLKECluster","requestBody":{"content":{"application/json":{"schema":{"properties":{"control_plane":{"description":"Defines settings for the Kubernetes Control Plane. Allows for the enabling of High Availability (HA) for Control Plane Components.\n\nEnabling High Availability for LKE is an **irreversible** change.\n\nWhen upgrading pre-existing LKE clusters to use the HA Control Plane, the following changes will additionally occur:\n\n- All nodes will be deleted and new nodes will be created to replace them.\n\n- Any local storage (such as `hostPath` volumes) will be erased.\n\n- The upgrade process may take several minutes to complete, as nodes will be replaced on a rolling basis.\n","properties":{"high_availability":{"description":"Defines whether High Availability is enabled for the Control Plane Components of the cluster. Defaults to `false`.\n","example":true,"type":"boolean"}},"type":"object"},"k8s_version":{"description":"The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>. New and recycled Nodes in this cluster will be installed with the latest available patch for the Cluster's Kubernetes version.\n\nWhen upgrading the Kubernetes version, only the next latest minor version following the current version can be deployed. For example, a cluster with Kubernetes version 1.19 can be upgraded to version 1.20, but not directly to 1.21.\n\nThe Kubernetes version of a cluster can not be downgraded.\n","type":"string"},"label":{"$ref":"#/components/schemas/LKECluster/properties/label"},"tags":{"description":"An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only. To delete a tag, exclude it from your `tags` array.\n","example":["prod","monitoring","ecomm","blog"],"items":{"type":"string"},"type":"array"}}}}},"description":"The fields to update the Kubernetes cluster."},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"created":{"$ref":"#/components/schemas/LKECluster/properties/created"},"k8s_version":{"$ref":"#/components/schemas/LKECluster/properties/k8s_version"},"label":{"$ref":"#/components/schemas/LKECluster/properties/label"},"region":{"$ref":"#/components/schemas/LKECluster/properties/region"},"tags":{"description":"An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only. To delete a tag, exclude it from your `tags` array.\n","example":["prod","monitoring","ecomm","blog"],"items":{"type":"string"},"type":"array"},"updated":{"$ref":"#/components/schemas/LKECluster/properties/updated"}}}}},"description":"Returns a single Kubernetes cluster."}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Kubernetes Cluster Update","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"lkecluster54321\"\n \"tags\" : [\"ecomm\", \"blog\", \"prod\", \"monitoring\"]\n \"control_plane\": {\n \"high_availability\": true\n },\n \"k8s_version\": \"1.17\"\n }' \\\n https://api.linode.com/v4/lke/clusters/12345\n"},{"lang":"CLI","source":"linode-cli lke cluster-update 12345 \\\n --label lkecluster54321 \\\n --control_plane.high_availability true \\\n --k8s_version 1.25 \\\n --tags ecomm \\\n --tags blog \\\n --tags prod \\\n --tags monitoring\n"}],"x-linode-cli-action":"cluster-update"},"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}/api-endpoints":{"get":{"description":"List the Kubernetes API server endpoints for this cluster. Please note that it often takes 2-5 minutes before the endpoint is ready after first [creating a new cluster](/docs/api/linode-kubernetes-engine-lke/#kubernetes-cluster-create).\n","operationId":"getLKEClusterAPIEndpoints","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"description":"The Kubernetes API server endpoints for this cluster.\n","properties":{"endpoint":{"description":"A Kubernetes API server endpoint for this cluster.\n","example":"https://192.0.2.1:6443","readOnly":true,"type":"string"}},"type":"object"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns the Kubernetes API server endpoints for this cluster."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_only"]}],"summary":"Kubernetes API Endpoints List","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/lke/clusters/12345/api-endpoints\n"},{"lang":"CLI","source":"linode-cli lke api-endpoints-list 12345\n"}],"x-linode-cli-action":"api-endpoints-list"},"parameters":[{"description":"ID of the Kubernetes cluster to look up.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}/dashboard":{"get":{"description":"Get a [Kubernetes Dashboard](https://github.com/kubernetes/dashboard) access URL for this Cluster, which enables performance of administrative tasks through a web interface.\n\nDashboards are installed for Clusters by default.\n\nTo access the Cluster Dashboard login prompt, enter the URL in a web browser. Select either **Token** or **Kubeconfig** authentication, then select **Sign in**.\n\nFor additional guidance on using the Cluster Dashboard, see the [Navigating the Cluster Dashboard](/docs/guides/using-the-kubernetes-dashboard-on-lke/#navigating-the-cluster-dashboard) section of our guide on [Using the Kubernetes Dashboard on LKE](/docs/guides/using-the-kubernetes-dashboard-on-lke/).\n","operationId":"getLKEClusterDashboard","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"url":{"description":"The Cluster Dashboard access URL.","example":"https://example.dashboard.linodelke.net","type":"string"}},"type":"object"}}},"description":"Returns a Kubernetes Cluster Dashboard URL."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_only"]}],"summary":"Kubernetes Cluster Dashboard URL View","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/lke/clusters/12345/dashboard\n"},{"lang":"CLI","source":"linode-cli lke cluster-dashboard-url 12345"}],"x-linode-cli-action":"cluster-dashboard-url"},"parameters":[{"description":"ID of the Kubernetes cluster to look up.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}/kubeconfig":{"delete":{"description":"Delete and regenerate the Kubeconfig file for a Cluster.\n","operationId":"deleteLKEClusterKubeconfig","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Kubeconfig file deleted and regenerated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Kubeconfig Delete","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/lke/clusters/12345/kubeconfig\n"},{"lang":"CLI","source":"linode-cli lke kubeconfig-delete 12345\n"}],"x-linode-cli-action":"kubeconfig-delete"},"get":{"description":"Get the Kubeconfig file for a Cluster. Please note that it often takes 2-5 minutes before\nthe Kubeconfig file is ready after first [creating a new cluster](/docs/api/linode-kubernetes-engine-lke/#kubernetes-cluster-create).\n","operationId":"getLKEClusterKubeconfig","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"kubeconfig":{"description":"The Base64-encoded Kubeconfig file for this Cluster.\n","readOnly":true,"type":"string"}},"type":"object"}}},"description":"Returns the Base64-encoded Kubeconfig file for this Kubernetes cluster."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Kubeconfig View","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/lke/clusters/12345/kubeconfig\n"},{"lang":"CLI","source":"linode-cli lke kubeconfig-view 12345\n"}],"x-linode-cli-action":"kubeconfig-view"},"parameters":[{"description":"ID of the Kubernetes cluster to look up.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}/nodes/{nodeId}":{"delete":{"description":"Deletes a specific Node from a Node Pool.\n\n**Deleting a Node is a destructive action and cannot be undone.**\n\nDeleting a Node will reduce the size of the Node Pool it belongs to.\n","operationId":"deleteLKEClusterNode","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Delete successful"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Node Delete","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/lke/clusters/12345/nodes/12345-6aa78910bc\n"},{"lang":"CLI","source":"linode-cli lke node-delete 12345 12345-6aa78910bc\n"}],"x-linode-cli-action":"node-delete"},"get":{"description":"Returns the values for a specified node object.\n","operationId":"getLKEClusterNode","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"The Node's ID.\n","example":"12345-6aa78910bc","readOnly":true,"type":"string"},"instance_id":{"description":"The Linode's ID. If no Linode is currently provisioned for this Node, this is `null`.\n","example":123456,"type":"integer"},"status":{"description":"The creation status of this Node. This status is distinct from this Node's readiness as a Kubernetes Node Object as determined by the command `kubectl get nodes`.\n\n`not_ready` indicates that the Linode is still being created.\n\n`ready` indicates that the Linode has successfully been created and is running Kubernetes software.\n","enum":["ready","not_ready"],"example":"ready","type":"string"}},"type":"object"}}},"description":"Returns the values of a node object in the form that it appears currently in the node pool array."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Node View","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/lke/clusters/12345/nodes/12345-6aa78910bc\n"},{"lang":"CLI","source":"linode-cli lke node-view 123456 12345-6aa78910bc\n"}],"x-linode-cli-action":"node-view"},"parameters":[{"description":"ID of the Kubernetes cluster containing the Node.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}},{"description":"ID of the Node to look up.","in":"path","name":"nodeId","required":true,"schema":{"type":"string"}}],"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}/nodes/{nodeId}/recycle":{"parameters":[{"description":"ID of the Kubernetes cluster containing the Node.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}},{"description":"ID of the Node to be recycled.","in":"path","name":"nodeId","required":true,"schema":{"type":"string"}}],"post":{"description":"Recycles an individual Node in the designated Kubernetes Cluster. The Node will be deleted\nand replaced with a new Linode, which may take a few minutes. Replacement Nodes are\ninstalled with the latest available patch for the Cluster's Kubernetes Version.\n\n**Any local storage on deleted Linodes (such as \"hostPath\" and \"emptyDir\" volumes, or \"local\" PersistentVolumes) will be erased.**\n","operationId":"postLKEClusterNodeRecycle","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Recycle request succeeded and is in progress."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Node Recycle","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/lke/clusters/12345/nodes/12345-6aa78910bc/recycle\n"},{"lang":"CLI","source":"linode-cli lke node-recycle 12345 12345-6aa78910bc\n"}],"x-linode-cli-action":"node-recycle"},"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}/pools":{"get":{"description":"Returns all active Node Pools on a Kubernetes cluster.\n","operationId":"getLKEClusterPools","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LKENodePool"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"},"x-linode-cli-nested-list":"nodes","x-linode-cli-use-schema":{"properties":{"id":{"x-linode-cli-display":1},"nodes.id":{"x-linode-cli-display":3},"nodes.instance_id":{"x-linode-cli-display":4},"nodes.status":{"x-linode-cli-display":5},"type":{"x-linode-cli-display":2}},"type":"object"}}},"description":"Returns an array of all Pools in this Kubernetes cluster."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_only"]}],"summary":"Node Pools List","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/lke/clusters/12345/pools\n"},{"lang":"CLI","source":"linode-cli lke pools-list 12345\n"}],"x-linode-cli-action":"pools-list"},"parameters":[{"description":"ID of the Kubernetes cluster to look up.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Creates a new Node Pool for the designated Kubernetes cluster.\n","operationId":"postLKEClusterPools","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LKENodePoolRequestBody"}],"required":["type","count"],"type":"object"}}},"description":"Configuration for the Node Pool","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LKENodePool"}}},"description":"Node Pool has been created."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Node Pool Create","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"type\": \"g6-standard-4\",\n \"count\": 6,\n \"tags\": [\"example-tag\"],\n \"autoscaler\": {\n \"enabled\": true,\n \"max\": 12,\n \"min\": 3\n }\n }' \\\n https://api.linode.com/v4/lke/clusters/12345/pools\n"},{"lang":"CLI","source":"linode-cli lke pool-create 12345 \\\n --type g6-standard-4 \\\n --count 6 \\\n --tags example-tag \\\n --autoscaler.enabled true \\\n --autoscaler.max 12 \\\n --autoscaler.min 3\n"}],"x-linode-cli-action":"pool-create"},"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}/pools/{poolId}":{"delete":{"description":"Delete a specific Node Pool from a Kubernetes cluster.\n\n**Deleting a Node Pool is a destructive action and cannot be undone.**\n\nDeleting a Node Pool will delete all Linodes within that Pool.\n","operationId":"deleteLKENodePool","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Delete successful"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Node Pool Delete","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/lke/clusters/12345/pools/456\n"},{"lang":"CLI","source":"linode-cli lke pool-delete 12345 456\n"}],"x-linode-cli-action":"pool-delete"},"get":{"description":"Get a specific Node Pool by ID.\n","operationId":"getLKENodePool","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LKENodePool"}}},"description":"Returns the requested Node Pool."}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_only"]}],"summary":"Node Pool View","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/lke/clusters/12345/pools/456\n"},{"lang":"CLI","source":"linode-cli lke pool-view 12345 456\n"}],"x-linode-cli-action":"pool-view"},"parameters":[{"description":"ID of the Kubernetes cluster to look up.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}},{"description":"ID of the Pool to look up","in":"path","name":"poolId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates a Node Pool's count and autoscaler configuration.\n\nLinodes will be created or deleted to match changes to the Node Pool's count.\n\n**Any local storage on deleted Linodes (such as \"hostPath\" and \"emptyDir\" volumes, or \"local\" PersistentVolumes) will be erased.**\n","operationId":"putLKENodePool","requestBody":{"content":{"application/json":{"schema":{"properties":{"autoscaler":{"$ref":"#/components/schemas/LKENodePoolRequestBody/properties/autoscaler"},"count":{"$ref":"#/components/schemas/LKENodePool/properties/count"}}}}},"description":"The fields to update"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LKENodePool"}}},"description":"Node Pool was successfully modified."}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Node Pool Update","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"count\": 6,\n \"autoscaler\": {\n \"enabled\": true,\n \"max\": 12,\n \"min\": 3\n }' \\\n https://api.linode.com/v4/lke/clusters/12345/pools/456\n"},{"lang":"CLI","source":"linode-cli lke pool-update 12345 456 \\\n --count 6 \\\n --autoscaler.enabled true \\\n --autoscaler.max 12 \\\n --autoscaler.min 3\n"}],"x-linode-cli-action":"pool-update"},"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}/pools/{poolId}/recycle":{"parameters":[{"description":"ID of the Kubernetes cluster this Node Pool is attached to.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}},{"description":"ID of the Node Pool to be recycled.","in":"path","name":"poolId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Recycles a Node Pool for the designated Kubernetes Cluster. All Linodes within the Node Pool will be deleted\nand replaced with new Linodes on a rolling basis, which may take several minutes. Replacement Nodes are\ninstalled with the latest available patch for the Cluster's Kubernetes Version.\n\n**Any local storage on deleted Linodes (such as \"hostPath\" and \"emptyDir\" volumes, or \"local\" PersistentVolumes) will be erased.**\n","operationId":"postLKEClusterPoolRecycle","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Recycle request succeeded and is in progress."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Node Pool Recycle","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/lke/clusters/12345/pools/456/recycle\n"},{"lang":"CLI","source":"linode-cli lke pool-recycle 12345 456\n"}],"x-linode-cli-action":"pool-recycle"},"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}/recycle":{"parameters":[{"description":"ID of the Kubernetes cluster which contains nodes to be recycled.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Recycles all nodes in all pools of a designated Kubernetes Cluster. All Linodes within the Cluster will be deleted\nand replaced with new Linodes on a rolling basis, which may take several minutes. Replacement Nodes are\ninstalled with the latest available [patch version](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/release/versioning.md#kubernetes-release-versioning) for the Cluster's current Kubernetes minor release.\n\n**Any local storage on deleted Linodes (such as \"hostPath\" and \"emptyDir\" volumes, or \"local\" PersistentVolumes) will be erased.**\n","operationId":"postLKEClusterRecycle","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Recycle request succeeded and is in progress."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Cluster Nodes Recycle","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/lke/clusters/12345/recycle\n"},{"lang":"CLI","source":"linode-cli lke cluster-nodes-recycle 12345\n"}],"x-linode-cli-action":"cluster-nodes-recycle"},"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}/regenerate":{"parameters":[{"description":"ID of the target Kubernetes cluster.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Regenerate the Kubeconfig file and/or the service account token for a Cluster.\n\nThis is a helper command that allows performing both the [Kubeconfig Delete](#kubeconfig-delete) and the [Service Token Delete](#service-token-delete) actions with a single request.\n\nWhen using this command, at least one of `kubeconfig` or `servicetoken` is required.\n\n**Note**: When regenerating a service account token, the Cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High Availability Clusters should not experience any disruption, while standard Clusters may experience brief control plane downtime while components are restarted.\n","operationId":"postLKEClusterRegenerate","requestBody":{"content":{"application/json":{"schema":{"properties":{"kubeconfig":{"default":false,"description":"Whether to delete and regenerate the Kubeconfig file for this Cluster.\n","example":true,"type":"boolean"},"servicetoken":{"default":false,"description":"Whether to delete and regenerate the service access token for this Cluster.\n","example":true,"type":"boolean"}}}}},"description":"The Kubernetes Cluster Regenerate request object."},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Regenerate request successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Kubernetes Cluster Regenerate","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"kubeconfig\": true;\n \"servicetoken\": true\n }' \\\n https://api.linode.com/v4/lke/clusters/12345/regenerate\n"},{"lang":"CLI","source":"linode-cli lke regenerate 12345 \\\n --kubeconfig true \\\n --servicetoken true\n"}],"x-linode-cli-action":"regenerate"},"x-linode-cli-command":"lke"},"/lke/clusters/{clusterId}/servicetoken":{"delete":{"description":"Delete and regenerate the service account token for a Cluster.\n\n**Note**: When regenerating a service account token, the Cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High Availability Clusters should not experience any disruption, while standard Clusters may experience brief control plane downtime while components are restarted.\n","operationId":"postLKECServiceTokenDelete","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Service token deleted and regenerated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_write"]}],"summary":"Service Token Delete","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/lke/clusters/12345/servicetoken\n"},{"lang":"CLI","source":"linode-cli lke service-token-delete 12345\n"}],"x-linode-cli-action":"service-token-delete"},"parameters":[{"description":"ID of the target Kubernetes cluster.","in":"path","name":"clusterId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"lke"},"/lke/versions":{"get":{"description":"List the Kubernetes versions available for deployment to a Kubernetes cluster.\n","operationId":"getLKEVersions","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LKEVersion"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a list of Kubernetes versions available for deployment to a Kubernetes cluster.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_only"]}],"summary":"Kubernetes Versions List","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/lke/versions\n"},{"lang":"CLI","source":"linode-cli lke versions-list\n"}],"x-linode-cli-action":"versions-list","x-linode-grant":"read_only"},"x-linode-cli-command":"lke"},"/lke/versions/{version}":{"get":{"description":"View a Kubernetes version available for deployment to a Kubernetes cluster.\n","operationId":"getLKEVersion","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LKEVersion"}}},"description":"Returns a Kubernetes version object that is available for deployment to a Kubernetes cluster.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["lke:read_only"]}],"summary":"Kubernetes Version View","tags":["Linode Kubernetes Engine (LKE)"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/lke/versions/1.25\n"},{"lang":"CLI","source":"linode-cli lke version-view 1.25\n"}],"x-linode-cli-action":"version-view","x-linode-grant":"read_only"},"parameters":[{"description":"The LKE version to view.","in":"path","name":"version","required":true,"schema":{"type":"string"}}],"x-linode-cli-command":"lke"},"/longview/clients":{"get":{"description":"Returns a paginated list of Longview Clients you have access to. Longview Client is used to monitor stats on your Linode with the help of the Longview Client application.\n","operationId":"getLongviewClients","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LongviewClient"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of Longview Clients."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["longview:read_only"]}],"summary":"Longview Clients List","tags":["Longview"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/longview/clients\n"},{"lang":"CLI","source":"linode-cli longview list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Creates a Longview Client. This Client will not begin monitoring the status of your server until you configure the Longview Client application on your Linode using the returning `install_code` and `api_key`.\n","operationId":"createLongviewClient","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongviewClient"}}},"description":"Information about the LongviewClient to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongviewClient"}}},"description":"Longview Client created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["longview:read_write"]}],"summary":"Longview Client Create","tags":["Longview"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"client789\"\n }' \\\n https://api.linode.com/v4/longview/clients\n"},{"lang":"CLI","source":"linode-cli longview create \\\n --label client789\n"}],"x-linode-cli-action":"create","x-linode-grant":"add_longview"},"x-linode-cli-command":"longview"},"/longview/clients/{clientId}":{"delete":{"description":"Deletes a Longview Client from your Account.\n\n**All information stored for this client will be lost.**\n\nThis _does not_ uninstall the Longview Client application for your Linode - you must do that manually.\n","operationId":"deleteLongviewClient","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Longview Client deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["longview:read_write"]}],"summary":"Longview Client Delete","tags":["Longview"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/longview/clients/789\n"},{"lang":"CLI","source":"linode-cli longview delete 789\n"}],"x-linode-cli-action":["delete","rm"],"x-linode-grant":"read_write"},"get":{"description":"Returns a single Longview Client you can access.\n","operationId":"getLongviewClient","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongviewClient"}}},"description":"The requested Longview Client."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["longview:read_only"]}],"summary":"Longview Client View","tags":["Longview"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/longview/clients/789\n"},{"lang":"CLI","source":"linode-cli longview view 789\n"}],"x-linode-cli-action":"view","x-linode-grant":"read_only"},"parameters":[{"description":"The Longview Client ID to access.","in":"path","name":"clientId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates a Longview Client. This cannot update how it monitors your server; use the Longview Client application on your Linode for monitoring configuration.\n","operationId":"updateLongviewClient","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongviewClient"}}},"description":"The fields to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongviewClient"}}},"description":"Longview Client updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["longview:read_write"]}],"summary":"Longview Client Update","tags":["Longview"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"client789\"\n }' \\\n https://api.linode.com/v4/longview/clients/789\n"},{"lang":"CLI","source":"linode-cli longview update 789 \\\n --label client789\n"}],"x-linode-cli-action":"update","x-linode-grant":"read_write"},"x-linode-cli-command":"longview"},"/longview/plan":{"get":{"description":"Get the details of your current Longview plan. This returns a `LongviewSubscription` object for your current Longview Pro plan, or an empty set `{}` if your current plan is Longview Free.\n\nYou must have at least one of the following `global` [User Grants](/docs/api/account/#users-grants-view) in order to access this endpoint:\n\n - `\"account_access\": read_write`\n - `\"account_access\": read_only`\n - `\"longview_subscription\": true`\n - `\"add_longview\": true`\n\n\nTo update your subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#longview-plan-update).\n","operationId":"getLongviewPlan","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongviewSubscription"}}},"description":"The Longview plan details for this account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["longview:read_only"]}],"summary":"Longview Plan View","tags":["Longview"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/longview/plan\n"},{"lang":"CLI","source":"linode-cli longview plan-view\n"}],"x-linode-cli-action":"plan-view"},"put":{"description":"Update your Longview plan to that of the given subcription ID. This returns a `LongviewSubscription` object for the updated Longview Pro plan, or an empty set `{}` if the updated plan is Longview Free.\n\nYou must have `\"longview_subscription\": true` configured as a `global` [User Grant](/docs/api/account/#users-grants-view) in order to access this endpoint.\n\nYou can send a request to the [List Longview Subscriptions](/docs/api/longview/#longview-subscriptions-list) endpoint to receive the details, including `id`'s, of each plan.\n","operationId":"updateLongviewPlan","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongviewPlan"}}},"description":"Update your Longview subscription plan.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongviewSubscription"}}},"description":"The updated Longview plan details for this account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["longview:read_write"]}],"summary":"Longview Plan Update","tags":["Longview"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"longview_subscription\": \"longview-10\"\n }' \\\n https://api.linode.com/v4/longview/plan\n"},{"lang":"CLI","source":"linode-cli longview plan-update --longview_subscription longview-10\n"}],"x-linode-cli-action":"plan-update"},"x-linode-cli-command":"longview"},"/longview/subscriptions":{"get":{"description":"Returns a paginated list of available Longview Subscriptions. This is a public endpoint and requires no authentication.\n","operationId":"getLongviewSubscriptions","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LongviewSubscription"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of Longview Subscriptions."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Longview Subscriptions List","tags":["Longview"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/longview/subscriptions\n"},{"lang":"CLI","source":"linode-cli longview subscriptions-list\n"}],"x-linode-cli-action":"subscriptions-list"},"x-linode-cli-command":"longview"},"/longview/subscriptions/{subscriptionId}":{"get":{"description":"Get the Longview plan details as a single `LongviewSubscription` object for the provided subscription ID. This is a public endpoint and requires no authentication.\n","operationId":"getLongviewSubscription","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongviewSubscription"}}},"description":"The requested Longview Subscription details."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Longview Subscription View","tags":["Longview"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/longview/subscriptions/longview-10\n"},{"lang":"CLI","source":"linode-cli longview subscription-view \\\n longview-10\n"}],"x-linode-cli-action":"subscription-view"},"parameters":[{"description":"The Longview Subscription to look up.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"}}],"x-linode-cli-command":"longview"},"/managed/contacts":{"get":{"description":"Returns a paginated list of Managed Contacts on your Account.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getManagedContacts","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ManagedContact"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of ManagedContacts"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Managed Contacts List","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/contacts\n"},{"lang":"CLI","source":"linode-cli managed contacts-list\n"}],"x-linode-cli-action":"contacts-list","x-linode-grant":"unrestricted only"},"post":{"description":"Creates a Managed Contact. A Managed Contact is someone Linode\nspecial forces can contact in the course of attempting to resolve an issue\nwith a Managed Service.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"createManagedContact","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedContact"}}},"description":"Information about the contact to create."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedContact"}}},"description":"Contact created."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Contact Create","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.org\",\n \"phone\": {\n \"primary\": \"123-456-7890\",\n \"secondary\": null\n },\n \"group\": \"on-call\"\n }' \\\n https://api.linode.com/v4/managed/contacts\n"},{"lang":"CLI","source":"linode-cli managed contact-create \\\n --name \"John Doe\" \\\n --email \"john.doe@example.org\" \\\n --phone.primary \"123-456-7890\"\n"}],"x-linode-cli-action":"contact-create","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/contacts/{contactId}":{"delete":{"description":"Deletes a Managed Contact.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"deleteManagedContact","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Contact deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Contact Delete","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/managed/contacts/567\n"},{"lang":"CLI","source":"linode-cli managed contact-delete 567\n"}],"x-linode-cli-action":"contact-delete","x-linode-grant":"unrestricted only"},"get":{"description":"Returns a single Managed Contact.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getManagedContact","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedContact"}}},"description":"The requested Managed Contact."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Contact View","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/contacts/567\n"},{"lang":"CLI","source":"linode-cli managed contact-view 567\n"}],"x-linode-cli-action":"contact-view","x-linode-grant":"unrestricted only"},"parameters":[{"description":"The ID of the contact to access.","in":"path","name":"contactId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates information about a Managed Contact.\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"updateManagedContact","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedContact"}}},"description":"The fields to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedContact"}}},"description":"Contact updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Contact Update","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.org\",\n \"phone\": {\n \"primary\": \"123-456-7890\",\n \"secondary\": null\n },\n \"group\": \"on-call\"\n }' \\\n https://api.linode.com/v4/managed/contacts/567\n"},{"lang":"CLI","source":"linode-cli managed contact-update 567 \\\n --name \"John Doe\" \\\n --email \"john.doe@example.org\" \\\n --phone.primary \"123-456-7890\"\n"}],"x-linode-cli-action":"contact-update","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/credentials":{"get":{"description":"Returns a paginated list of Managed Credentials on your Account.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getManagedCredentials","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ManagedCredential"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of ManagedCredentials"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Managed Credentials List","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/credentials\n"},{"lang":"CLI","source":"linode-cli managed credentials-list\n"}],"x-linode-cli-action":"credentials-list","x-linode-grant":"unrestricted only"},"post":{"description":"Creates a Managed Credential. A Managed Credential is stored securely\nto allow Linode special forces to access your Managed Services and resolve\nissues.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"createManagedCredential","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ManagedCredential"},{"properties":{"password":{"description":"The password to use when accessing the Managed Service.\n","example":"s3cur3P@ssw0rd","type":"string"},"username":{"description":"The username to use when accessing the Managed Service.\n","example":"johndoe","maxLength":5000,"minLength":0,"type":"string"}},"type":"object"}],"required":["label","password"]}}},"description":"Information about the Credential to create."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedCredential"}}},"description":"Credential created."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Credential Create","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"prod-password-1\",\n \"username\": \"johndoe\",\n \"password\": \"s3cur3P@ssw0rd\"\n }' \\\n https://api.linode.com/v4/managed/credentials\n"},{"lang":"CLI","source":"linode-cli managed credential-create \\\n --label prod-password-1 \\\n --username johndoe \\\n --password s3cur3P@ssw0rd\n"}],"x-linode-cli-action":"credential-create","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/credentials/sshkey":{"get":{"description":"Returns the unique SSH public key assigned to your Linode account's\nManaged service. If you [add this public key](/docs/guides/linode-managed/#adding-the-public-key) to a Linode on your account,\nLinode special forces will be able to log in to the Linode with this key\nwhen attempting to resolve issues.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"viewManagedSSHKey","responses":{"200":{"content":{"application/json":{"schema":{"description":"A unique SSH public key that allows Linode's special forces to access a Managed server to respond to Issues.\n","properties":{"ssh_key":{"description":"The unique SSH public key assigned to your Linode account's Managed service.\n","example":"ssh-rsa AAAAB...oD2ZQ== managedservices@linode","readOnly":true,"type":"string","x-linode-cli-display":1}},"type":"object"}}},"description":"The requested Managed SSH public key."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Managed SSH Key View","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/credentials/sshkey\n"},{"lang":"CLI","source":"linode-cli managed credential-sshkey-view\n"}],"x-linode-cli-action":"credential-sshkey-view","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/credentials/{credentialId}":{"get":{"description":"Returns a single Managed Credential.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getManagedCredential","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedCredential"}}},"description":"The requested Managed Credential."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Credential View","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/credentials/9991\n"},{"lang":"CLI","source":"linode-cli managed credential-view 9991\n"}],"x-linode-cli-action":"credential-view","x-linode-grant":"unrestricted only"},"parameters":[{"description":"The ID of the Credential to access.","in":"path","name":"credentialId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates the label of a Managed Credential. This endpoint does not update the username and password for a Managed Credential. To do this, use the Managed Credential Username and Password Update ([POST /managed/credentials/{credentialId}/update](/docs/api/managed/#managed-credential-username-and-password-update)) endpoint instead.\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"updateManagedCredential","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedCredential"}}},"description":"The fields to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedCredential"}}},"description":"Credential updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Credential Update","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"prod-password-1\"\n }' \\\n https://api.linode.com/v4/managed/credentials/9991\n"},{"lang":"CLI","source":"linode-cli managed credential-update 9991 \\\n --label prod-password-1\n"}],"x-linode-cli-action":"credential-update","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/credentials/{credentialId}/revoke":{"parameters":[{"description":"The ID of the Credential to access.","in":"path","name":"credentialId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Deletes a Managed Credential. Linode special forces will no longer\nhave access to this Credential when attempting to resolve issues.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"deleteManagedCredential","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Credential deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Credential Delete","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/managed/credentials/9991\n"},{"lang":"CLI","source":"linode-cli managed credential-revoke 9991\n"}],"x-linode-cli-action":"credential-revoke","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/credentials/{credentialId}/update":{"parameters":[{"description":"The ID of the Credential to update.","in":"path","name":"credentialId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Updates the username and password for a Managed Credential.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"updateManagedCredentialUsernamePassword","requestBody":{"content":{"application/json":{"schema":{"properties":{"password":{"description":"The password to use when accessing the Managed Service.\n","example":"s3cur3P@ssw0rd","type":"string"},"username":{"description":"The username to use when accessing the Managed Service.\n","example":"johndoe","maxLength":5000,"minLength":0,"type":"string"}},"required":["password"]}}},"description":"The new username and password to assign to the Managed Credential.\n"},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Credential username and password updated."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Credential Username and Password Update","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"username\": \"johndoe\",\n \"password\": \"s3cur3P@ssw0rd\"\n }' \\\n https://api.linode.com/v4/managed/credentials/9991/update\n"},{"lang":"CLI","source":"linode-cli managed credential-update-username-password 9991 \\\n --username johndoe \\\n --password s3cur3P@ssw0rd\n"}],"x-linode-cli-action":"credential-update-username-password","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/issues":{"get":{"description":"Returns a paginated list of recent and ongoing issues detected on your\nManaged Services.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getManagedIssues","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ManagedIssue"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of open or ongoing Managed Issues.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Managed Issues List","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/issues\n"},{"lang":"CLI","source":"linode-cli managed issues-list\n"}],"x-linode-cli-action":"issues-list","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/issues/{issueId}":{"get":{"description":"Returns a single Issue that is impacting or did impact one of your\nManaged Services.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getManagedIssue","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedIssue"}}},"description":"The requested issue."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Managed Issue View","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/issues/823\n"},{"lang":"CLI","source":"linode-cli managed issue-view 823\n"}],"x-linode-cli-action":"issue-view","x-linode-grant":"unrestricted only"},"parameters":[{"description":"The Issue to look up.","in":"path","name":"issueId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"managed"},"/managed/linode-settings":{"get":{"description":"Returns a paginated list of Managed Settings for your Linodes. There will\nbe one entry per Linode on your Account.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getManagedLinodeSettings","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ManagedLinodeSettings"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of Managed settings for your Linodes.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Managed Linode Settings List","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/linode-settings\n"},{"lang":"CLI","source":"linode-cli managed linode-settings-list\n"}],"x-linode-cli-action":"linode-settings-list","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/linode-settings/{linodeId}":{"get":{"description":"Returns a single Linode's Managed settings.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getManagedLinodeSetting","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedLinodeSettings"}}},"description":"The requested Linode's Managed settings."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Linode's Managed Settings View","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/linode-settings/123\n"},{"lang":"CLI","source":"linode-cli managed linode-setting-view 123\n"}],"x-linode-cli-action":"linode-setting-view","x-linode-grant":"unrestricted only"},"parameters":[{"description":"The Linode ID whose settings we are accessing.","in":"path","name":"linodeId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates a single Linode's Managed settings.\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"updateManagedLinodeSetting","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedLinodeSettings"}}},"description":"The settings to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedLinodeSettings"}}},"description":"Settings updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Linode's Managed Settings Update","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"ssh\": {\n \"access\": true,\n \"user\": \"linode\",\n \"ip\": \"203.0.113.1\",\n \"port\": 22\n }\n }' \\\n https://api.linode.com/v4/managed/linode-settings/123\n"},{"lang":"CLI","source":"linode-cli managed linode-setting-update \\\n 7833234 \\\n --ssh.access true \\\n --ssh.user linode \\\n --ssh.port 22 \\\n --ssh.ip 203.0.113.1\n"}],"x-linode-cli-action":"linode-setting-update","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/services":{"get":{"description":"Returns a paginated list of Managed Services on your Account. These\nare the services Linode Managed is monitoring and will report and attempt\nto resolve issues with.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getManagedServices","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ManagedService"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of Managed Services"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Managed Services List","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/services\n"},{"lang":"CLI","source":"linode-cli managed services-list\n"}],"x-linode-cli-action":"services-list","x-linode-grant":"unrestricted only"},"post":{"description":"Creates a Managed Service. Linode Managed will begin monitoring this\nservice and reporting and attempting to resolve any Issues.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"createManagedService","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ManagedService"}],"required":["label","service_type","address","timeout"]}}},"description":"Information about the service to monitor."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedService"}}},"description":"Service created."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Service Create","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"service_type\": \"url\",\n \"label\": \"prod-1\",\n \"address\": \"https://example.org\",\n \"timeout\": 30,\n \"body\": \"it worked\",\n \"consultation_group\": \"on-call\",\n \"notes\": \"The service name is my-cool-application\",\n \"credentials\": [\n 9991\n ]\n }' \\\n https://api.linode.com/v4/managed/services\n"},{"lang":"CLI","source":"linode-cli managed service-create \\\n --service_type url \\\n --label prod-1 \\\n --address \"https://example.org\" \\\n --timeout 30 \\\n --body \"it worked\" \\\n --consultation_group on-call \\\n --notes \"The service name is \\\n my-cool-application\" \\\n --credentials 9991\n"}],"x-linode-cli-action":"service-create","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/services/{serviceId}":{"delete":{"description":"Deletes a Managed Service. This service will no longer be monitored by\nLinode Managed.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"deleteManagedService","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Service deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Service Delete","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/managed/services/9994\n"},{"lang":"CLI","source":"linode-cli managed service-delete 9994\n"}],"x-linode-cli-action":"service-delete","x-linode-grant":"unrestricted only"},"get":{"description":"Returns information about a single Managed Service on your Account.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getManagedService","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedService"}}},"description":"The requested Managed Service."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Managed Service View","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/services/9994\n"},{"lang":"CLI","source":"linode-cli managed service-view 9994\n"}],"x-linode-cli-action":"service-view","x-linode-grant":"unrestricted only"},"parameters":[{"description":"The ID of the Managed Service to access.","in":"path","name":"serviceId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates information about a Managed Service.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"updateManagedService","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedService"}}},"description":"The fields to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedService"}}},"description":"Service updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Service Update","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"service_type\": \"url\",\n \"label\": \"prod-1\",\n \"address\": \"https://example.org\",\n \"timeout\": 30,\n \"body\": \"it worked\",\n \"consultation_group\": \"on-call\",\n \"notes\": \"The service name is my-cool-application\",\n \"credentials\": [\n 9991\n ]\n }' \\\n https://api.linode.com/v4/managed/services/9994\n"},{"lang":"CLI","source":"linode-cli managed service-update 9994 \\\n --service_type url \\\n --label prod-1 \\\n --address \"https://example.org\" \\\n --timeout 30 \\\n --body \"it worked\" \\\n --consultation_group on-call \\\n --notes \"The service name is my-cool-application\" \\\n --credentials 9991\n"}],"x-linode-cli-action":"service-update","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/services/{serviceId}/disable":{"parameters":[{"description":"The ID of the Managed Service to disable.","in":"path","name":"serviceId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Temporarily disables monitoring of a Managed Service.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"disableManagedService","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedService"}}},"description":"Service disabled."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Service Disable","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/managed/services/9994/disable\n"},{"lang":"CLI","source":"linode-cli managed service-disable 9994\n"}],"x-linode-cli-action":"service-disable","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/services/{serviceId}/enable":{"parameters":[{"description":"The ID of the Managed Service to enable.","in":"path","name":"serviceId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Enables monitoring of a Managed Service.\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"enableManagedService","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedService"}}},"description":"Service enabled."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Managed Service Enable","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/managed/services/9994/enable\n"},{"lang":"CLI","source":"linode-cli managed service-enable 9994\n"}],"x-linode-cli-action":"service-enable","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/managed/stats":{"get":{"description":"Returns a list of Managed Stats on your Account in the form of x and y data points.\nYou can use these data points to plot your own graph visualizations. These stats\nreflect the last 24 hours of combined usage across all managed Linodes on your account\ngiving you a high-level snapshot of data for the following:\n\n\n* cpu\n* disk\n* swap\n* network in\n* network out\n\nThis command can only be accessed by the unrestricted users of an account.\n","operationId":"getManagedStats","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"discriminator":{"propertyName":"x-linode-ref-name"},"oneOf":[{"$ref":"#/components/schemas/StatsDataAvailable","x-linode-ref-name":"Stats Available"},{"$ref":"#/components/schemas/StatsDataUnavailable","x-linode-ref-name":"Stats Unavailable"}],"type":"object"}},"type":"object"}}},"description":"A list of Managed Stats from the last 24 hours."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Managed Stats List","tags":["Managed"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/managed/stats\n"},{"lang":"CLI","source":"linode-cli managed stats-list\n"}],"x-linode-cli-action":"stats-list","x-linode-grant":"unrestricted only"},"x-linode-cli-command":"managed"},"/networking/firewalls":{"get":{"description":"Returns a paginated list of accessible Firewalls.\n","operationId":"getFirewalls","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Firewall"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns an array of Firewalls."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["firewall:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Firewalls List","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/networking/firewalls\n"},{"lang":"CLI","source":"linode-cli firewalls list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Creates a Firewall to filter network traffic.\n\n* Use the `rules` property to create inbound and outbound access rules.\n\n* Use the `devices` property to assign the Firewall to a service and apply its Rules to the device. Requires `read_write` [User's Grants](/docs/api/account/#users-grants-view) to the device.\nCurrently, Firewalls can only be assigned to Linode instances.\n\n* A Firewall can be assigned to multiple Linode instances at a time.\n\n* A Linode instance can have one active, assigned Firewall at a time.\nAdditional disabled Firewalls can be assigned to a service, but they cannot be enabled if another active Firewall is already assigned to the same service.\n\n* A `firewall_create` Event is generated when this endpoint returns successfully.\n","operationId":"createFirewalls","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Firewall"}],"properties":{"devices":{"description":"Devices to create for this Firewall.\nWhen a Device is created, the Firewall is assigned to its associated service.\nCurrently, Devices can only be created for Linode instances.\n","properties":{"linodes":{"description":"An array of Linode IDs. A Firewall Device is created for each ID.\n","example":[123,456],"items":{"type":"integer"},"type":"array"}},"type":"object"},"rules":{"properties":{"inbound":{"required":["action","addresses","protocol"]},"outbound":{"required":["action","addresses","protocol"]}},"required":["inbound_policy","outbound_policy"]}},"required":["label","rules"]}}},"description":"Creates a Firewall object that can be applied to a Linode service to filter the service's network traffic."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Firewall"}}},"description":"Returns information about the created Firewall."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["firewall:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Firewall Create","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"firewall123\",\n \"rules\": {\n \"inbound_policy\": \"DROP\",\n \"inbound\": [\n {\n \"protocol\": \"TCP\",\n \"ports\": \"22, 80, 443\",\n \"addresses\": {\n \"ipv4\": [\n \"192.0.2.0/24\"\n ],\n \"ipv6\": [\n \"2001:DB8::/32\"\n ]\n },\n \"action\": \"ACCEPT\",\n \"label\": \"inbound-rule123\",\n \"description\": \"An example inbound rule description.\"\n }\n ],\n \"outbound_policy\": \"DROP\",\n \"outbound\": [\n {\n \"protocol\": \"TCP\",\n \"ports\": \"49152-65535\",\n \"addresses\": {\n \"ipv4\": [\n \"192.0.2.0/24\"\n ],\n \"ipv6\": [\n \"2001:DB8::/32\"\n ]\n },\n \"action\": \"ACCEPT\",\n \"label\": \"outbound-rule123\",\n \"description\": \"An example outbound rule description.\"\n }\n ]\n },\n \"devices\": {\n \"linodes\": [\n 123\n ]\n },\n \"tags\": [\n \"example tag\",\n \"another example\"\n ]\n }' \\\n https://api.linode.com/v4/networking/firewalls\n"},{"lang":"CLI","source":"linode-cli firewalls create \\\n --label example-firewall \\\n --rules.outbound_policy ACCEPT \\\n --rules.inbound_policy DROP \\\n --rules.inbound '[{\"protocol\": \"TCP\", \"ports\": \"22, 80, 8080, 443\", \"addresses\": {\"ipv4\": [\"192.0.2.1\", \"192.0.2.0/24\"], \"ipv6\": [\"2001:DB8::/32\"]}, \"action\": \"ACCEPT\"}]' \\\n --rules.outbound '[{\"protocol\": \"TCP\", \"ports\": \"49152-65535\", \"addresses\": {\"ipv4\": [\"192.0.2.0/24\"],\"ipv6\": [\"2001:DB8::/32\"]}, \"action\": \"DROP\", \"label\": \"outbound-rule123\", \"description\": \"An example outbound rule description.\"}]'\n"}],"x-linode-cli-action":"create","x-linode-grant":"add_firewalls"},"x-linode-cli-command":"firewalls"},"/networking/firewalls/{firewallId}":{"delete":{"description":"Delete a Firewall resource by its ID. This will remove all of the Firewall's Rules\nfrom any Linode services that the Firewall was assigned to.\n\nA `firewall_delete` Event is generated when this endpoint returns successfully.\n","operationId":"deleteFirewall","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Delete Successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["firewall:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Firewall Delete","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/networking/firewalls/123\n"},{"lang":"CLI","source":"linode-cli firewalls delete 123\n"}],"x-linode-cli-action":["delete","rm"],"x-linode-grant":"read_write"},"get":{"description":"Get a specific Firewall resource by its ID. The Firewall's Devices will not be\nreturned in the response. Instead, use the\n[List Firewall Devices](/docs/api/networking/#firewall-devices-list)\nendpoint to review them.\n","operationId":"getFirewall","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Firewall"}}},"description":"Returns information about this Firewall."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["firewall:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Firewall View","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/networking/firewalls/123\n"},{"lang":"CLI","source":"linode-cli firewalls view 123\n"}],"x-linode-cli-action":"view","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Firewall to access.\n","in":"path","name":"firewallId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates information for a Firewall. Some parts of a Firewall's configuration cannot\nbe manipulated by this endpoint:\n\n- A Firewall's Devices cannot be set with this endpoint. Instead, use the\n[Create Firewall Device](/docs/api/networking/#firewall-device-create)\nand [Delete Firewall Device](/docs/api/networking/#firewall-device-delete)\nendpoints to assign and remove this Firewall from Linode services.\n\n- A Firewall's Rules cannot be changed with this endpoint. Instead, use the\n[Update Firewall Rules](/docs/api/networking/#firewall-rules-update)\nendpoint to update your Rules.\n\n- A Firewall's status can be set to `enabled` or `disabled` by this endpoint, but it cannot be\nset to `deleted`. Instead, use the\n[Delete Firewall](/docs/api/networking/#firewall-delete)\nendpoint to delete a Firewall.\n\nIf a Firewall's status is changed with this endpoint, a corresponding `firewall_enable` or\n`firewall_disable` Event will be generated.\n","operationId":"updateFirewall","requestBody":{"content":{"application/json":{"schema":{"properties":{"label":{"$ref":"#/components/schemas/Firewall/properties/label"},"status":{"description":"The status to be applied to this Firewall.\n \n * When a Firewall is first created its status is `enabled`.\n * Use the [Delete Firewall](/docs/api/networking/#firewall-delete) endpoint to delete a Firewall.\n","enum":["enabled","disabled"],"example":"enabled","type":"string","x-linode-cli-display":3},"tags":{"$ref":"#/components/schemas/Firewall/properties/tags"}},"type":"object"}}},"description":"The Firewall information to update."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Firewall"}}},"description":"Firewall updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["firewall:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Firewall Update","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"status\": \"disabled\"\n }' \\\n https://api.linode.com/v4/networking/firewalls/123\n"},{"lang":"CLI","source":"linode-cli firewalls update 123 \\\n --status disabled\n"}],"x-linode-cli-action":"update","x-linode-grant":"read_write"},"x-linode-cli-command":"firewalls"},"/networking/firewalls/{firewallId}/devices":{"get":{"description":"Returns a paginated list of a Firewall's Devices. A Firewall Device assigns a\nFirewall to a Linode service (referred to as the Device's `entity`). Currently,\nonly Devices with an entity of type `linode` are accepted.\n","operationId":"getFirewallDevices","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FirewallDevices"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of Firewall Devices"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["firewall:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Firewall Devices List","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/networking/firewalls/123/devices\n"},{"lang":"CLI","source":"linode-cli firewalls devices-list 123\n"}],"x-linode-cli-action":"devices-list","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Firewall to access.\n","in":"path","name":"firewallId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Creates a Firewall Device, which assigns a Firewall to a service (referred to\nas the Device's `entity`) and applies the Firewall's Rules to the device.\n\n* Currently, only Devices with an entity of type `linode` are accepted.\n\n* A Firewall can be assigned to multiple Linode instances at a time.\n\n* A Linode instance can have one active, assigned Firewall at a time.\nAdditional disabled Firewalls can be assigned to a service, but they cannot be enabled if another active Firewall is already assigned to the same service.\n\n* A `firewall_device_add` Event is generated when the Firewall Device is added successfully.\n","operationId":"createFirewallDevice","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FirewallDevices/properties/entity"}],"required":["id","type"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirewallDevices"}}},"description":"Returns information about the created Firewall Device."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["firewall:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Firewall Device Create","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"type\": \"linode\",\n \"id\": 123\n }' \\\n https://api.linode.com/v4/networking/firewalls/123/devices\n"},{"lang":"CLI","source":"linode-cli firewalls device-create 123 \\\n --id 456 \\\n --type \"linode\"\n"}],"x-linode-cli-action":"device-create","x-linode-grant":"read_write"},"x-linode-cli-command":"firewalls"},"/networking/firewalls/{firewallId}/devices/{deviceId}":{"delete":{"description":"Removes a Firewall Device, which removes a Firewall from the Linode service it was\nassigned to by the Device. This will remove all of the Firewall's Rules from the Linode\nservice. If any other Firewalls have been assigned to the Linode service, then those Rules\nwill remain in effect.\n\nA `firewall_device_remove` Event is generated when the Firewall Device is removed successfully.\n","operationId":"deleteFirewallDevice","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Delete Successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["firewall:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Firewall Device Delete","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/networking/firewalls/123/devices/456\n"},{"lang":"CLI","source":"linode-cli firewalls device-delete 123 456\n"}],"x-linode-cli-action":"device-delete","x-linode-grant":"read_write"},"get":{"description":"Returns information for a Firewall Device, which assigns a Firewall\nto a Linode service (referred to as the Device's `entity`). Currently,\nonly Devices with an entity of type `linode` are accepted.\n","operationId":"getFirewallDevice","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirewallDevices"}}},"description":"The requested Firewall Device."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["firewall:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Firewall Device View","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/networking/firewalls/123/devices/456\n"},{"lang":"CLI","source":"linode-cli firewalls device-view \\\n 123 456\n"}],"x-linode-cli-action":"device-view","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Firewall to access.\n","in":"path","name":"firewallId","required":true,"schema":{"type":"integer"}},{"description":"ID of the Firewall Device to access.\n","in":"path","name":"deviceId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"firewalls"},"/networking/firewalls/{firewallId}/rules":{"get":{"description":"Returns the inbound and outbound Rules for a Firewall.\n","operationId":"getFirewallRules","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Firewall/properties/rules"}}},"description":"The requested Firewall Rules."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["firewall:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Firewall Rules List","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/networking/firewalls/123/rules\n"},{"lang":"CLI","source":"linode-cli firewalls rules-list 123\n"}],"x-linode-cli-action":"rules-list","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Firewall to access.\n","in":"path","name":"firewallId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates the inbound and outbound Rules for a Firewall.\n\n**Note:** This command replaces all of a Firewall's `inbound` and/or `outbound` rulesets with the values specified in your request.\n","operationId":"updateFirewallRules","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Firewall/properties/rules"}],"properties":{"inbound":{"required":["action","addresses","protocol"]},"outbound":{"required":["action","addresses","protocol"]}}}}},"description":"The Firewall Rules information to update."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Firewall/properties/rules"}}},"description":"Firewall Rules updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["firewall:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Firewall Rules Update","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"inbound_policy\": \"DROP\",\n \"inbound\": [\n {\n \"protocol\": \"TCP\",\n \"ports\": \"22, 80, 443\",\n \"addresses\": {\n \"ipv4\": [\n \"192.0.2.0/24\"\n ],\n \"ipv6\": [\n \"2001:DB8::/32\"\n ]\n },\n \"action\": \"ACCEPT\",\n \"label\": \"inbound-rule123\",\n \"description\": \"An example inbound rule description.\"\n }\n ],\n \"outbound_policy\": \"DROP\",\n \"outbound\": [\n {\n \"protocol\": \"TCP\",\n \"ports\": \"49152-65535\",\n \"addresses\": {\n \"ipv4\": [\n \"192.0.2.0/24\"\n ],\n \"ipv6\": [\n \"2001:DB8::/32\"\n ]\n },\n \"action\": \"ACCEPT\",\n \"label\": \"outbound-rule123\",\n \"description\": \"An example outbound rule description.\"\n }\n ]\n }' \\\n https://api.linode.com/v4/networking/firewalls/123/rules\n"},{"lang":"CLI","source":"linode-cli firewalls rules-update 123 \\\n --inbound '[{\"action\":\"ACCEPT\", \"protocol\": \"TCP\", \"ports\": \"22, 80, 8080, 443\", \"addresses\": {\"ipv4\": [\"192.0.2.1/32\", \"192.0.2.0/24\"], \"ipv6\": [\"2001:DB8::/32\"]}}]' \\\n --outbound '[{\"action\":\"DROP\",\"protocol\": \"TCP\", \"ports\": \"49152-65535\", \"addresses\": {\"ipv4\": [\"192.0.2.1/32\", \"192.0.2.0/24\"], \"ipv6\": [\"2001:DB8::/32\"]}}]'\n"}],"x-linode-cli-action":"rules-update","x-linode-grant":"read_write"},"x-linode-cli-command":"firewalls"},"/networking/ips":{"get":{"description":"Returns a paginated list of IP Addresses on your Account, excluding private addresses.\n","operationId":"getIPs","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IPAddress"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of IP Addresses."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_only"]}],"summary":"IP Addresses List","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/networking/ips\n"},{"lang":"CLI","source":"linode-cli networking ips-list\n"}],"x-linode-cli-action":"ips-list","x-linode-grant":"read_only"},"post":{"description":"Allocates a new IPv4 Address on your Account. The Linode must be configured to support additional addresses - please [open a support ticket](/docs/api/support/#support-ticket-open) requesting additional addresses before attempting allocation.\n","operationId":"allocateIP","requestBody":{"content":{"application/json":{"schema":{"properties":{"linode_id":{"description":"The ID of a Linode you you have access to that this address will be allocated to.\n","example":123,"type":"integer"},"public":{"description":"Whether to create a public or private IPv4 address.\n","example":true,"type":"boolean"},"type":{"description":"The type of address you are requesting. Only IPv4 addresses may be allocated through this endpoint.\n","enum":["ipv4"],"example":"ipv4","type":"string"}},"required":["type","public","linode_id"]}}},"description":"Information about the address you are creating.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPAddress"}}},"description":"IP Address allocated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_write","linodes:read_write"]}],"summary":"IP Address Allocate","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"type\": \"ipv4\",\n \"public\": true,\n \"linode_id\": 123\n }' \\\n https://api.linode.com/v4/networking/ips\n"},{"lang":"CLI","source":"linode-cli networking ip-add \\\n --type ipv4 \\\n --public true \\\n --linode_id 123\n"}],"x-linode-cli-action":"ip-add","x-linode-grant":"read_write"},"x-linode-cli-command":"networking"},"/networking/ips/assign":{"post":{"description":"Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes.\n\nThe following restrictions apply:\n* All Linodes involved must have at least one public IPv4 address after assignment.\n* Linodes may have no more than one assigned private IPv4 address.\n* Linodes may have no more than one assigned IPv6 range.\n\n[Open a Support Ticket](/docs/api/support/#support-ticket-open) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits.\n\n**Note**: Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following commands:\n* **Linode's Managed Settings View** ([GET /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-view))\n* **Linode's Managed Settings Update** ([PUT /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-update))\n","operationId":"assignIPs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPAddressesAssignRequest"}}},"description":"Information about what IPv4 address or IPv6 range to assign, and to which Linode.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"All assignments completed successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_write","linodes:read_write"]}],"summary":"IP Addresses Assign","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"region\": \"us-east\",\n \"assignments\": [\n {\n \"address\": \"192.0.2.1\",\n \"linode_id\": 123\n },\n {\n \"address\": \"2001:db8:3c4d:15::/64\",\n \"linode_id\": 234\n }\n ]\n }' \\\n https://api.linode.com/v4/networking/ips/assign\n"},{"lang":"CLI","source":"linode-cli networking ip-assign \\\n --region us-east \\\n --assignments.address 192.0.2.1 \\\n --assignments.linode_id 123 \\\n --assignments.address 2001:db8:3c4d:15::/64 \\\n --assignments.linode_id 234\n"}],"x-linode-cli-action":"ip-assign","x-linode-grant":"read_write"},"x-linode-cli-command":"networking"},"/networking/ips/share":{"post":{"description":"Configure shared IPs.\n\nIP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses.\n\nIP failover requires configuration of a failover service (such as [Keepalived](/docs/guides/ip-failover-keepalived)) within the internal system of the primary Linode.\n","operationId":"shareIPs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPAddressesShareRequest"}}},"description":"Information about what IPs to share with which Linode.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"IP Address sharing successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_write","linodes:read_write"]}],"servers":[{"url":"https://api.linode.com/v4beta"}],"summary":"IP Addresses Share","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"linode_id\": 123,\n \"ips\": [\n \"192.0.2.1\",\n \"2001:db8:3c4d:15::\"\n ]\n }' \\\n https://api.linode.com/v4beta/networking/ips/share\n"},{"lang":"CLI","source":"linode-cli networking ip-share \\\n --linode_id 123 \\\n --ips 192.0.2.1 \\\n --ips 2001:db8:3c4d:15::\n"}],"x-linode-cli-action":"ip-share","x-linode-grant":"read_write"},"x-linode-cli-command":"networking"},"/networking/ips/{address}":{"get":{"description":"Returns information about a single IP Address on your Account.\n","operationId":"getIP","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPAddress"}}},"description":"The requested IP Address."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_only"]}],"summary":"IP Address View","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/networking/ips/97.107.143.141\n"},{"lang":"CLI","source":"linode-cli networking ip-view 97.107.143.141\n"}],"x-linode-cli-action":"ip-view","x-linode-grant":"read_only"},"parameters":[{"description":"The address to operate on.","in":"path","name":"address","required":true,"schema":{"format":"ip","type":"string"}}],"put":{"description":"Sets RDNS on an IP Address. Forward DNS must already be set up for reverse DNS to be applied. If you set the RDNS to `null` for public IPv4 addresses, it will be reset to the default _ip.linodeusercontent.com_ RDNS value.\n","operationId":"updateIP","requestBody":{"content":{"application/json":{"schema":{"properties":{"rdns":{"description":"The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set.\n","example":"test.example.org","nullable":true,"type":"string","x-linode-cli-display":4}},"required":["rdns"],"type":"object"}}},"description":"The information to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPAddress"}}},"description":"RDNS set successfully"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_write"]}],"summary":"IP Address RDNS Update","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"rdns\": \"test.example.org\"\n }' \\\n https://api.linode.com/v4/networking/ips/203.0.113.1\n"},{"lang":"CLI","source":"linode-cli networking ip-update \\\n 203.0.113.1 \\\n --rdns \"test.example.org\"\n"}],"x-linode-cli-action":"ip-update","x-linode-grant":"read_write"},"x-linode-cli-command":"networking"},"/networking/ipv4/assign":{"post":{"description":"This command is equivalent to **IP Addresses Assign** ([POST /networking/ips/assign](#ip-addresses-assign)).\n\nAssign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes.\n\nThe following restrictions apply:\n* All Linodes involved must have at least one public IPv4 address after assignment.\n* Linodes may have no more than one assigned private IPv4 address.\n* Linodes may have no more than one assigned IPv6 range.\n\n[Open a Support Ticket](/docs/api/support/#support-ticket-open) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits.\n\n**Note**: Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following commands:\n* **Linode's Managed Settings View** ([GET /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-view))\n* **Linode's Managed Settings Update** ([PUT /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-update))\n","operationId":"assignIPv4s","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPAddressesAssignRequest"}}},"description":"Information about what IPv4 address to assign, and to which Linode.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"All assignments completed successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_write","linodes:read_write"]}],"summary":"Linodes Assign IPv4s","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"region\": \"us-east\",\n \"assignments\": [\n {\n \"address\": \"192.0.2.1\",\n \"linode_id\": 123\n },\n {\n \"address\": \"2001:db8:3c4d:15::/64\",\n \"linode_id\": 234\n }\n ]\n }' \\\n https://api.linode.com/v4/networking/ipv4/assign\n"},{"lang":"CLI","source":"linode-cli networking ip-assign \\\n --region us-east \\\n --assignments.address 192.0.2.1 \\\n --assignments.linode_id 123 \\\n --assignments.address 2001:db8:3c4d:15::/64 \\\n --assignments.linode_id 234\n"}],"x-linode-cli-skip":true,"x-linode-grant":"read_write"},"x-linode-cli-command":"networking"},"/networking/ipv4/share":{"post":{"description":"This command is equivalent to **IP Addresses Share** ([POST /networking/ips/share](#ip-addresses-share)).\n\nConfigure shared IPs.\n\nIP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses.\n\nIP failover requires configuration of a failover service (such as [Keepalived](/docs/guides/ip-failover-keepalived)) within the internal system of the primary Linode.\n","operationId":"shareIPv4s","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPAddressesShareRequest"}}},"description":"Information about what IPs to share with which Linode.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Sharing configured successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_write","linodes:read_write"]}],"summary":"IPv4 Sharing Configure","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"linode_id\": 123,\n \"ips\": [\n \"192.0.2.1\",\n \"192.0.2.2\"\n ]\n }' \\\n https://api.linode.com/v4/networking/ipv4/share\n"},{"lang":"CLI","source":"linode-cli networking ip-share \\\n --linode_id 123 \\\n --ips 192.0.2.1 \\\n --ips 192.0.2.2\n"}],"x-linode-cli-skip":true,"x-linode-grant":"read_write"},"x-linode-cli-command":"networking"},"/networking/ipv6/pools":{"get":{"description":"Displays the IPv6 pools on your Account. A pool of IPv6 addresses are routed to all of your Linodes in a single [Region](/docs/api/regions/#regions-list). Any Linode on your Account may bring up any address in this pool at any time, with no external configuration required.\n","operationId":"getIPv6Pools","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IPv6Pool"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"The IPv6 pools on your Account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_only"]}],"summary":"IPv6 Pools List","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/networking/ipv6/pools\n"},{"lang":"CLI","source":"linode-cli networking v6-pools\n"}],"x-linode-cli-action":"v6-pools"},"x-linode-cli-command":"networking"},"/networking/ipv6/ranges":{"get":{"description":"Displays the IPv6 ranges on your Account.\n\n\n * An IPv6 range is a `/64` or `/54` block of IPv6 addresses routed to a single Linode in a given [Region](/docs/api/regions/#regions-list).\n\n * Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range.\n\n * Access the IPv6 Range Create ([POST /networking/ipv6/ranges](/docs/api/networking/#ipv6-range-create)) endpoint to add a `/64` or `/56` block of IPv6 addresses to your account.\n","operationId":"getIPv6Ranges","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IPv6Range"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"The IPv6 ranges on your Account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_only"]}],"summary":"IPv6 Ranges List","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/networking/ipv6/ranges\n"},{"lang":"CLI","source":"linode-cli networking v6-ranges\n"}],"x-linode-cli-action":"v6-ranges"},"post":{"description":"Creates an IPv6 Range and assigns it based on the provided Linode or route target IPv6 SLAAC address. See the `ipv6` property when accessing the Linode View ([GET /linode/instances/{linodeId}](/docs/api/linode-instances/#linode-view)) endpoint to view a Linode's IPv6 SLAAC address.\n * Either `linode_id` or `route_target` is required in a request.\n * `linode_id` and `route_target` are mutually exclusive. Submitting values for both properties in a request results in an error.\n * Upon a successful request, an IPv6 range is created in the [Region](/docs/api/regions/#regions-list) that corresponds to the provided `linode_id` or `route_target`.\n * Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range.\n * Access the IP Addresses Assign ([POST /networking/ips/assign](/docs/api/networking/#ip-addresses-assign)) endpoint to re-assign IPv6 Ranges to your Linodes.\n\n**Note**: The following restrictions apply:\n * A Linode can only have one IPv6 range targeting its SLAAC address.\n * An account can only have one IPv6 range in each [Region](/docs/api/regions/#regions-list).\n * [Open a Support Ticket](/docs/api/support/#support-ticket-open) to request expansion of these restrictions.\n","operationId":"postIPv6Range","requestBody":{"content":{"application/json":{"schema":{"properties":{"linode_id":{"description":"The ID of the Linode to assign this range to. The SLAAC address for the provided Linode is used as the range's `route_target`.\n\n* **Required** if `route_target` is omitted from the request.\n\n* Mutually exclusive with `route_target`. Submitting values for both properties in a request results in an error.\n","example":123,"type":"integer"},"prefix_length":{"description":"The prefix length of the IPv6 range.\n","enum":[56,64],"type":"integer"},"route_target":{"description":"The IPv6 SLAAC address to assign this range to.\n\n* **Required** if `linode_id` is omitted from the request.\n\n* Mutually exclusive with `linode_id`. Submitting values for both properties in a request results in an error.\n\n* **Note**: Omit the `/128` prefix length of the SLAAC address when using this property.\n","example":"2001:0db8::1","format":"ipv6","type":"string"}},"required":["prefix_length"]}}},"description":"Information about the IPv6 range to create.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"range":{"description":"The IPv6 network range, including subnet and prefix length.\n","example":"2001:0db8::/64","format":"ipv6/prefix_length","type":"string"},"route_target":{"description":"The route target IPV6 SLAAC address for this range. Does not include the prefix length.\n","example":"2001:0db8::1","format":"ipv6","type":"string"}},"type":"object"}}},"description":"IPv6 range created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_write","linodes:read_write"]}],"summary":"IPv6 Range Create","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"linode_id\": 123,\n \"prefix_length\": 64\n }' \\\n https://api.linode.com/v4/networking/ipv6/ranges\n"},{"lang":"CLI","source":"linode-cli networking v6-range-create \\\n --linode_id 123 \\\n --prefix_length 64\n"}],"x-linode-cli-action":"v6-range-create"},"x-linode-cli-command":"networking"},"/networking/ipv6/ranges/{range}":{"delete":{"description":"Removes this IPv6 range from your account and disconnects the range from any assigned Linodes.\n\n**Note:** Shared IPv6 ranges cannot be deleted at this time. Please contact Customer Support for assistance.\n","operationId":"deleteIPv6Range","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"IPv6 Range deleted."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read_write"]}],"summary":"IPv6 Range Delete","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/networking/ipv6/ranges/2001:0db8::\n"},{"lang":"CLI","source":"linode-cli networking v6-range-delete 2001:0db8::\n"}],"x-linode-cli-action":"v6-range-delete"},"get":{"description":"View IPv6 range information.\n","operationId":"getIPv6Range","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPv6RangeBGP"}}},"description":"Returns IPv6 range information."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["ips:read"]}],"summary":"IPv6 Range View","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" https://api.linode.com/v4/networking/ipv6/ranges/2001:0db8::\n"},{"lang":"CLI","source":"linode-cli networking v6-range-view 2001:0db8::\n"}],"x-linode-cli-action":"v6-range-view"},"parameters":[{"description":"The IPv6 range to access. Corresponds to the `range` property of objects returned from the IPv6 Ranges List ([GET /networking/ipv6/ranges](/docs/api/networking/#ipv6-ranges-list)) command.\n\n**Note**: Omit the prefix length of the IPv6 range.\n","in":"path","name":"range","required":true,"schema":{"format":"ipv6","type":"string"}}],"x-linode-cli-command":"networking"},"/networking/vlans":{"get":{"description":"Returns a list of all Virtual Local Area Networks (VLANs) on your Account. VLANs provide\na mechanism for secure communication between two or more Linodes that are assigned to the\nsame VLAN and are both within the same Layer 2 broadcast domain.\n\nVLANs are created and attached to Linodes by using the `interfaces` property for the following endpoints:\n\n- Linode Create ([POST /linode/instances](/docs/api/linode-instances/#linode-create))\n- Configuration Profile Create ([POST /linode/instances/{linodeId}/configs](/docs/api/linode-instances/#configuration-profile-create))\n- Configuration Profile Update ([PUT /linode/instances/{linodeId}/configs/{configId}](/docs/api/linode-instances/#configuration-profile-update))\n\nThere are several ways to detach a VLAN from a Linode:\n\n- [Update](/docs/api/linode-instances/#configuration-profile-update) the active Configuration Profile to remove the VLAN interface, then [reboot](/docs/api/linode-instances/#linode-reboot) the Linode.\n- [Create](/docs/api/linode-instances/#configuration-profile-create) a new Configuration Profile without the VLAN interface, then [reboot](/docs/api/linode-instances/#linode-reboot) the Linode into the new Configuration Profile.\n- [Delete](/docs/api/linode-instances/#linode-delete) the Linode.\n\n**Note:** Only Next Generation Network (NGN) data centers support VLANs. Use the Regions ([/regions](/docs/api/regions/)) endpoint to view the capabilities of data center regions.\nIf a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center,\nthe migration or cloning will not initiate. If a Linode cannot be migrated because of an incompatibility,\nyou will be prompted to select a different data center or contact support.\n\n**Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) to view additional specifications and limitations.\n","operationId":"getVLANs","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Vlans"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"The VLANs available on this Account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["linodes:read_only"]}],"servers":[{"url":"https://api.linode.com/v4beta"}],"summary":"VLANs List","tags":["Networking"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4beta/networking/vlans/\n"},{"lang":"CLI","source":"linode-cli vlans list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"x-linode-cli-command":"vlans"},"/nodebalancers":{"get":{"description":"Returns a paginated list of NodeBalancers you have access to.\n","operationId":"getNodeBalancers","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NodeBalancer"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of NodeBalancers."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_only"]}],"summary":"NodeBalancers List","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/nodebalancers\n"},{"lang":"CLI","source":"linode-cli nodebalancers list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Creates a NodeBalancer in the requested Region.\n\nNodeBalancers require a port Config with at least one backend Node to start serving requests.\n\nWhen using the Linode CLI to create a NodeBalancer, first create a NodeBalancer without any Configs. Then, create Configs and Nodes for that NodeBalancer with the respective [Config Create](/docs/api/nodebalancers/#config-create) and [Node Create](/docs/api/nodebalancers/#node-create) commands.\n","operationId":"createNodeBalancer","requestBody":{"content":{"application/json":{"schema":{"properties":{"client_conn_throttle":{"$ref":"#/components/schemas/NodeBalancer/properties/client_conn_throttle"},"configs":{"description":"The port Config(s) to create for this NodeBalancer.\n\nEach Config must have a unique port and at least one Node.\n","items":{"description":"A request object representing a NodeBalancer Config, including Nodes.","properties":{"algorithm":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/algorithm"},"check":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/check"},"check_attempts":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/check_attempts"},"check_body":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/check_body"},"check_interval":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/check_interval"},"check_passive":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/check_passive"},"check_path":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/check_path"},"check_timeout":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/check_timeout"},"cipher_suite":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/cipher_suite"},"nodes":{"description":"The NodeBalancer Node(s) that serve this Config.\n","items":{"$ref":"#/components/schemas/NodeBalancerNode"},"type":"array"},"port":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/port"},"protocol":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/protocol"},"proxy_protocol":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/proxy_protocol"},"ssl_cert":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/ssl_cert"},"ssl_key":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/ssl_key"},"stickiness":{"$ref":"#/components/schemas/NodeBalancerConfig/properties/stickiness"}},"type":"object"},"required":["nodes"],"type":"array"},"label":{"$ref":"#/components/schemas/NodeBalancer/properties/label"},"region":{"description":"The ID of the Region to create this NodeBalancer in.\n","example":"us-east","type":"string"}},"required":["region"]}}},"description":"Information about the NodeBalancer to create.","required":true,"x-linode-cli-allowed-defaults":["region"]},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancer"}}},"description":"NodeBalancer created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_write"]}],"summary":"NodeBalancer Create","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"region\": \"us-east\",\n \"label\": \"balancer12345\",\n \"client_conn_throttle\": 0,\n \"configs\": [\n {\n \"port\": 443,\n \"protocol\": \"https\",\n \"algorithm\": \"roundrobin\",\n \"stickiness\": \"http_cookie\",\n \"check\": \"http_body\",\n \"check_interval\": 90,\n \"check_timeout\": 10,\n \"check_attempts\": 3,\n \"check_path\": \"/test\",\n \"check_body\": \"it works\",\n \"check_passive\": true,\n \"proxy_protocol\": \"none\",\n \"cipher_suite\": \"recommended\",\n \"ssl_cert\": \"-----BEGIN CERTIFICATE-----\\nCERTIFICATE_INFORMATION\\n-----END CERTIFICATE-----\",\n \"ssl_key\": \"-----BEGIN PRIVATE KEY-----\\nPRIVATE_KEY_INFORMATION\\n-----END PRIVATE KEY-----\",\n \"nodes\": [\n {\n \"address\": \"192.168.210.120:80\",\n \"label\": \"node1\",\n \"weight\": 50,\n \"mode\": \"accept\"\n },\n {\n \"address\": \"192.168.210.122:81\",\n \"label\": \"node2\",\n \"weight\": 50,\n \"mode\": \"accept\"\n }\n ]\n }\n ]\n }' \\\n https://api.linode.com/v4/nodebalancers\n"},{"lang":"CLI","source":"linode-cli nodebalancers create \\\n --region us-east \\\n --label balancer12345 \\\n --client_conn_throttle 0\n"}],"x-linode-cli-action":"create","x-linode-grant":"add_nodebalancers"},"x-linode-cli-command":"nodebalancers"},"/nodebalancers/{nodeBalancerId}":{"delete":{"description":"Deletes a NodeBalancer.\n\n**This is a destructive action and cannot be undone.**\n\nDeleting a NodeBalancer will also delete all associated Configs and Nodes, although the backend servers represented by the Nodes will not be changed or removed. Deleting a NodeBalancer will cause you to lose access to the IP Addresses assigned to this NodeBalancer.\n","operationId":"deleteNodeBalancer","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"NodeBalancer deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_write"]}],"summary":"NodeBalancer Delete","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/nodebalancers/12345\n"},{"lang":"CLI","source":"linode-cli nodebalancers delete 12345\n"}],"x-linode-cli-action":["delete","rm"],"x-linode-grant":"read_write"},"get":{"description":"Returns a single NodeBalancer you can access.\n","operationId":"getNodeBalancer","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancer"}}},"description":"The requested NodeBalancer object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_only"]}],"summary":"NodeBalancer View","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/nodebalancers/12345\n"},{"lang":"CLI","source":"linode-cli nodebalancers view 12345\n"}],"x-linode-cli-action":"view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the NodeBalancer to access.","in":"path","name":"nodeBalancerId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates information about a NodeBalancer you can access.\n","operationId":"updateNodeBalancer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancer"}}},"description":"The information to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancer"}}},"description":"NodeBalancer updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_write"]}],"summary":"NodeBalancer Update","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"balancer12345\",\n \"client_conn_throttle\": 0\n }' \\\n https://api.linode.com/v4/nodebalancers/12345\n"},{"lang":"CLI","source":"linode-cli nodebalancers update 12345 \\\n --label balancer12345 \\\n --client_conn_throttle 0\n"}],"x-linode-cli-action":"update","x-linode-grant":"read_write"},"x-linode-cli-command":"nodebalancers"},"/nodebalancers/{nodeBalancerId}/configs":{"get":{"description":"Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer will accept traffic on, one Config per port.\n\nFor example, if you wanted to accept standard HTTP traffic, you would need a Config listening on port 80.\n","operationId":"getNodeBalancerConfigs","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NodeBalancerConfig"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginted list of NodeBalancer Configs"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_only"]}],"summary":"Configs List","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/nodebalancers/12345/configs\n"},{"lang":"CLI","source":"linode-cli nodebalancers configs-list 12345\n"}],"x-linode-cli-action":"configs-list","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the NodeBalancer to access.","in":"path","name":"nodeBalancerId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Creates a NodeBalancer Config, which allows the NodeBalancer to accept traffic on a new port. You will need to add NodeBalancer Nodes to the new Config before it can actually serve requests.\n","operationId":"createNodeBalancerConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancerConfig"}}},"description":"Information about the port to configure."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancerConfig"}}},"description":"Config created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_write"]}],"summary":"Config Create","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"port\": 443,\n \"protocol\": \"https\",\n \"algorithm\": \"roundrobin\",\n \"stickiness\": \"http_cookie\",\n \"check\": \"http_body\",\n \"check_interval\": 90,\n \"check_timeout\": 10,\n \"check_attempts\": 3,\n \"check_path\": \"/test\",\n \"check_body\": \"it works\",\n \"check_passive\": true,\n \"proxy_protocol\": \"none\",\n \"ssl_cert\": \"-----BEGIN CERTIFICATE-----\\nCERTIFICATE_INFORMATION\\n-----END CERTIFICATE-----\",\n \"ssl_key\": \"-----BEGIN PRIVATE KEY-----\\nPRIVATE_KEY_INFORMATION\\n-----END PRIVATE KEY-----\",\n \"cipher_suite\": \"recommended\"\n }' \\\n https://api.linode.com/v4/nodebalancers/12345/configs\n"},{"lang":"CLI","source":"linode-cli nodebalancers config-create 12345 \\\n --port 443 \\\n --protocol https \\\n --algorithm roundrobin \\\n --stickiness http_cookie \\\n --check http_body \\\n --check_interval 90 \\\n --check_timeout 10 \\\n --check_attempts 3 \\\n --check_path \"/test\" \\\n --check_body \"it works\" \\\n --check_passive true \\\n --proxy_protocol \"none\" \\\n --ssl_cert \"-----BEGIN CERTIFICATE-----\n CERTIFICATE_INFORMATION\n -----END CERTIFICATE-----\" \\\n --ssl_key \"-----BEGIN PRIVATE KEY-----\n PRIVATE_KEY_INFORMATION\n -----END PRIVATE KEY-----\" \\\n --cipher_suite recommended\n"}],"x-linode-cli-action":"config-create","x-linode-grant":"read_write"},"x-linode-cli-command":"nodebalancers"},"/nodebalancers/{nodeBalancerId}/configs/{configId}":{"delete":{"description":"Deletes the Config for a port of this NodeBalancer.\n\n**This cannot be undone.**\n\nOnce completed, this NodeBalancer will no longer respond to requests on the given port. This also deletes all associated NodeBalancerNodes, but the Linodes they were routing traffic to will be unchanged and will not be removed.\n","operationId":"deleteNodeBalancerConfig","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"NodeBalancer Config deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_write"]}],"summary":"Config Delete","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/nodebalancers/12345/configs/4567\n"},{"lang":"CLI","source":"linode-cli nodebalancers config-delete \\\n 12345 4567\n"}],"x-linode-cli-action":"config-delete","x-linode-grant":"read_write"},"get":{"description":"Returns configuration information for a single port of this NodeBalancer.\n","operationId":"getNodeBalancerConfig","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancerConfig"}}},"description":"The requested NodeBalancer config."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_only"]}],"summary":"Config View","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/nodebalancers/12345/configs/4567\n"},{"lang":"CLI","source":"linode-cli nodebalancers config-view \\\n 12345 4567\n"}],"x-linode-cli-action":"config-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the NodeBalancer to access.","in":"path","name":"nodeBalancerId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the config to access.","in":"path","name":"configId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates the configuration for a single port on a NodeBalancer.\n","operationId":"updateNodeBalancerConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancerConfig"}}},"description":"The fields to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancerConfig"}}},"description":"Config updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_write"]}],"summary":"Config Update","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"port\": 443,\n \"protocol\": \"https\",\n \"algorithm\": \"roundrobin\",\n \"stickiness\": \"http_cookie\",\n \"check\": \"http_body\",\n \"check_interval\": 90,\n \"check_timeout\": 10,\n \"check_attempts\": 3,\n \"check_path\": \"/test\",\n \"check_body\": \"it works\",\n \"check_passive\": true,\n \"proxy_protocol\": \"none\",\n \"ssl_cert\": \"-----BEGIN CERTIFICATE-----\\nCERTIFICATE_INFORMATION\\n-----END CERTIFICATE-----\",\n \"ssl_key\": \"-----BEGIN PRIVATE KEY-----\\nPRIVATE_KEY_INFORMATION\\n-----END PRIVATE KEY-----\",\n \"cipher_suite\": \"recommended\"\n }' \\\n https://api.linode.com/v4/nodebalancers/12345/configs/4567\n"},{"lang":"CLI","source":"linode-cli nodebalancers config-update \\\n 12345 4567 \\\n --port 443 \\\n --protocol https \\\n --algorithm roundrobin \\\n --stickiness http_cookie \\\n --check http_body \\\n --check_interval 90 \\\n --check_timeout 10 \\\n --check_attempts 3 \\\n --check_path \"/test\" \\\n --check_body \"it works\" \\\n --check_passive true \\\n --proxy_protocol \"none\" \\\n --ssl_cert \"-----BEGIN CERTIFICATE-----\n CERTIFICATE_INFORMATION\n -----END CERTIFICATE-----\" \\\n --ssl_key \"-----BEGIN PRIVATE KEY-----\n PRIVATE_KEY_INFORMATION\n -----END PRIVATE KEY-----\" \\\n --cipher_suite recommended\n"}],"x-linode-cli-action":"config-update","x-linode-grant":"read_write"},"x-linode-cli-command":"nodebalancers"},"/nodebalancers/{nodeBalancerId}/configs/{configId}/nodes":{"get":{"description":"Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port.\n","operationId":"getNodeBalancerConfigNodes","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NodeBalancerNode"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of NodeBalancer nodes."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_only"]}],"summary":"Nodes List","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/nodebalancers/12345/configs/4567/nodes\n"},{"lang":"CLI","source":"linode-cli nodebalancers nodes-list 12345 4567\n"}],"x-linode-cli-action":"nodes-list","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the NodeBalancer to access.","in":"path","name":"nodeBalancerId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the NodeBalancer config to access.","in":"path","name":"configId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Creates a NodeBalancer Node, a backend that can accept traffic for this NodeBalancer Config. Nodes are routed requests on the configured port based on their status.\n","operationId":"createNodeBalancerNode","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NodeBalancerNode"}],"required":["label","address"]}}},"description":"Information about the Node to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancerNode"}}},"description":"Node created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_write"]}],"summary":"Node Create","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"address\": \"192.168.210.120:80\",\n \"label\": \"node54321\",\n \"weight\": 50,\n \"mode\": \"accept\"\n }' \\\n https://api.linode.com/v4/nodebalancers/12345/configs/4567/nodes\n"},{"lang":"CLI","source":"linode-cli nodebalancers node-update \\\n 12345 4567 \\\n --address 192.168.210.120:80 \\\n --label node54321 \\\n --weight 50 \\\n --mode accept\n"}],"x-linode-cli-action":"node-create","x-linode-grant":"read_write"},"x-linode-cli-command":"nodebalancers"},"/nodebalancers/{nodeBalancerId}/configs/{configId}/nodes/{nodeId}":{"delete":{"description":"Deletes a Node from this Config. This backend will no longer receive traffic for the configured port of this NodeBalancer.\n\nThis does not change or remove the Linode whose address was used in the creation of this Node.\n","operationId":"deleteNodeBalancerConfigNode","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Node deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_write"]}],"summary":"Node Delete","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/nodebalancers/12345/configs/4567/nodes/54321\n"},{"lang":"CLI","source":"linode-cli nodebalancers node-delete \\\n 12345 4567 54321\n"}],"x-linode-cli-action":"node-delete","x-linode-grant":"read_write"},"get":{"description":"Returns information about a single Node, a backend for this NodeBalancer's configured port.\n","operationId":"getNodeBalancerNode","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancerNode"}}},"description":"A paginated list of NodeBalancer nodes."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_write"]}],"summary":"Node View","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/nodebalancers/12345/configs/4567/nodes/54321\n"},{"lang":"CLI","source":"linode-cli nodebalancers node-view 12345 4567 54321\n"}],"x-linode-cli-action":"node-view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the NodeBalancer to access.","in":"path","name":"nodeBalancerId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Config to access","in":"path","name":"configId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Node to access","in":"path","name":"nodeId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates information about a Node, a backend for this NodeBalancer's configured port.\n","operationId":"updateNodeBalancerNode","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancerNode"}}},"description":"The fields to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancerNode"}}},"description":"Node updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_write"]}],"summary":"Node Update","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"address\": \"192.168.210.120:80\",\n \"label\": \"node54321\",\n \"weight\": 50,\n \"mode\": \"accept\"\n }' \\\n https://api.linode.com/v4/nodebalancers/12345/configs/4567/nodes/54321\n"},{"lang":"CLI","source":"linode-cli nodebalancers node-create \\\n 12345 4567 54321 \\\n --address 192.168.210.120:80 \\\n --label node54321 \\\n --weight 50 \\\n --mode accept\n"}],"x-linode-cli-action":"node-update","x-linode-grant":"read_write"},"x-linode-cli-command":"nodebalancers"},"/nodebalancers/{nodeBalancerId}/configs/{configId}/rebuild":{"parameters":[{"description":"The ID of the NodeBalancer to access.","in":"path","name":"nodeBalancerId","required":true,"schema":{"type":"integer"}},{"description":"The ID of the Config to access.","in":"path","name":"configId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Rebuilds a NodeBalancer Config and its Nodes that you have permission to modify.\n\nUse this command to update a NodeBalancer's Config and Nodes with a single request.\n","operationId":"rebuildNodeBalancerConfig","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NodeBalancerConfig"},{"properties":{"nodes":{"description":"The NodeBalancer Node(s) that serve this Config.\n\nSome considerations for Nodes when rebuilding a config:\n * Current Nodes excluded from the request body will be deleted from the Config.\n * Current Nodes (identified by their Node ID) will be updated.\n * New Nodes (included without a Node ID) will be created.\n","items":{"description":"NodeBalancer Node request object including ID.","properties":{"address":{"$ref":"#/components/schemas/NodeBalancerNode/properties/address"},"id":{"description":"The unique ID of the Node to update.","example":54321,"type":"integer"},"label":{"$ref":"#/components/schemas/NodeBalancerNode/properties/label"},"mode":{"$ref":"#/components/schemas/NodeBalancerNode/properties/mode"},"weight":{"$ref":"#/components/schemas/NodeBalancerNode/properties/weight"}},"type":"object"},"type":"array"}},"required":["nodes"],"type":"object"}]}}},"description":"Information about the NodeBalancer Config to rebuild.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancerConfig"}}},"description":"NodeBalancer created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_write"]}],"summary":"Config Rebuild","tags":["NodeBalancers"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"port\": 1234,\n \"protocol\": \"https\",\n \"algorithm\": \"roundrobin\",\n \"stickiness\": \"http_cookie\",\n \"check\": \"http_body\",\n \"check_interval\": 90,\n \"check_timeout\": 10,\n \"check_attempts\": 3,\n \"check_path\": \"/test\",\n \"check_body\": \"it works\",\n \"check_passive\": true,\n \"proxy_protocol\": \"none\",\n \"cipher_suite\": \"recommended\",\n \"ssl_cert\": \"-----BEGIN CERTIFICATE-----\\nCERTIFICATE_INFORMATION\\n-----END CERTIFICATE-----\",\n \"ssl_key\": \"-----BEGIN PRIVATE KEY-----\\nPRIVATE_KEY_INFORMATION\\n-----END PRIVATE KEY-----\",\n \"nodes\": [\n {\n \"id\": 54321,\n \"address\": \"192.168.210.120:80\",\n \"label\": \"node1\",\n \"weight\": 50,\n \"mode\": \"accept\"\n },\n {\n \"address\": \"192.168.210.122:81\",\n \"label\": \"node2\",\n \"weight\": 50,\n \"mode\": \"accept\"\n }\n ]\n }' \\\n https://api.linode.com/v4/nodebalancers/12345/configs/4567/rebuild\n"},{"lang":"CLI","source":"linode-cli nodebalancers config-rebuild \\\n 12345 4567 \\\n --port 443 \\\n --protocol https \\\n --algorithm roundrobin \\\n --stickiness http_cookie \\\n --check http_body \\\n --check_interval 90 \\\n --check_timeout 10 \\\n --check_attempts 3 \\\n --check_path \"/test\" \\\n --check_body \"it works\" \\\n --check_passive true \\\n --proxy_protocol \"none\" \\\n --ssl_cert \"-----BEGIN CERTIFICATE-----\n CERTIFICATE_INFORMATION\n -----END CERTIFICATE-----\" \\\n --ssl_key \"-----BEGIN PRIVATE KEY-----\n PRIVATE_KEY_INFORMATION\n -----END PRIVATE KEY-----\" \\\n --cipher_suite recommended \\\n --nodes '{\"address\":\"192.168.210.120:80\",\"label\":\"node1\",\"weight\":50,\"mode\":\"accept\"}' \\\n --nodes '{\"address\":\"192.168.210.122:80\",\"label\":\"node2\",\"weight\":50,\"mode\":\"accept\"}'\n"}],"x-linode-cli-action":"config-rebuild","x-linode-grant":"add_nodebalancers"},"x-linode-cli-command":"nodebalancers"},"/nodebalancers/{nodeBalancerId}/stats":{"get":{"description":"Returns detailed statistics about the requested NodeBalancer.\n","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NodeBalancerStats"}}},"description":"The requested stats."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["nodebalancers:read_only"]}],"summary":"NodeBalancer Statistics View","tags":["NodeBalancers"],"x-linode-cli-action":"stats","x-linode-cli-skip":true,"x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the NodeBalancer to access.","in":"path","name":"nodeBalancerId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"nodebalancers"},"/object-storage/buckets":{"get":{"description":"Returns a paginated list of all Object Storage Buckets that you own.\n\n\nThis endpoint is available for convenience. It is recommended that instead you\nuse the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/serviceops/#list-buckets) directly.\n","operationId":"getObjectStorageBuckets","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObjectStorageBucket"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of buckets you own."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Buckets List","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/object-storage/buckets/\n"}],"x-linode-cli-skip":true},"post":{"description":"Creates an Object Storage Bucket in the specified cluster.\n\nAccounts with negative balances cannot access this command.\n\nIf the bucket already exists and is owned by you, this endpoint returns a `200` response with that bucket as if it had just been created.\n\nThis endpoint is available for convenience. It is recommended that instead you use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket) directly.\n","operationId":"createObjectStorageBucket","requestBody":{"content":{"application/json":{"schema":{"properties":{"acl":{"default":"private","description":"The Access Control Level of the bucket using a canned ACL string. For more fine-grained control of ACLs, use the S3 API directly.\n","enum":["private","public-read","authenticated-read","public-read-write"],"example":"private","type":"string"},"cluster":{"description":"The ID of the Object Storage Cluster where this bucket should be created.\n","example":"us-east-1","type":"string"},"cors_enabled":{"default":false,"description":"If true, the bucket will be created with CORS enabled for all origins. For more fine-grained controls of CORS, use the S3 API directly.\n","example":true,"type":"boolean"},"label":{"description":"The name for this bucket. Must be unique in the cluster you are creating the bucket in, or an error will be returned. Labels will be reserved only for the cluster that active buckets are created and stored in. If you want to reserve this bucket's label in another cluster, you must create a new bucket with the same label in the new cluster.\n","example":"example-bucket","pattern":"^[a-z0-09][a-z0-9-]*[a-z0-9]?$","type":"string"}},"required":["label","cluster"],"type":"object"}}},"description":"Information about the bucket you want to create.\n"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectStorageBucket"}}},"description":"The bucket created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Bucket Create","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"example-bucket\",\n \"cluster\": \"us-east-1\",\n \"cors_enabled\": true,\n \"acl\": \"private\"\n }' \\\n https://api.linode.com/v4/object-storage/buckets/\n"}],"x-linode-cli-skip":true}},"/object-storage/buckets/{clusterId}":{"get":{"description":"Returns a list of Buckets in this cluster belonging to this Account.\n\n\nThis endpoint is available for convenience. It is recommended that instead you\nuse the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) directly.\n","operationId":"getObjectStorageBucketinCluster","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObjectStorageBucket"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of buckets you own in this cluster."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Buckets in Cluster List","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1\n"}],"x-linode-cli-skip":true},"parameters":[{"description":"The ID of the cluster this bucket exists in.","in":"path","name":"clusterId","required":true,"schema":{"type":"string"}}]},"/object-storage/buckets/{clusterId}/{bucket}":{"delete":{"description":"Removes a single bucket.\n\nBucket objects must be removed prior to removing the bucket. While buckets containing objects _may_ be\ndeleted using the [s3cmd command-line tool](/docs/products/storage/object-storage/guides/s3cmd/#delete-a-bucket), such operations\ncan fail if the bucket contains too many objects. The recommended\nway to empty large buckets is to use the [S3 API to configure lifecycle policies](https://docs.ceph.com/en/latest/radosgw/bucketpolicy/#) that\nremove all objects, then delete the bucket.\n\nThis endpoint is available for convenience. It is recommended that instead you\nuse the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#delete-bucket) directly.\n","operationId":"deleteObjectStorageBucket","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Bucket deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Bucket Remove","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket\n"}],"x-linode-cli-skip":true},"get":{"description":"Returns a single Object Storage Bucket.\n\n\nThis endpoint is available for convenience. It is recommended that instead you\nuse the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) directly.\n","operationId":"getObjectStorageBucket","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectStorageBucket"}}},"description":"The requested bucket."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Bucket View","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket\n"}],"x-linode-cli-skip":true},"parameters":[{"description":"The ID of the cluster this bucket exists in.","in":"path","name":"clusterId","required":true,"schema":{"type":"string"}},{"description":"The bucket name.","in":"path","name":"bucket","required":true,"schema":{"type":"string"}}]},"/object-storage/buckets/{clusterId}/{bucket}/access":{"parameters":[{"description":"The ID of the cluster this bucket exists in.","in":"path","name":"clusterId","required":true,"schema":{"type":"string"}},{"description":"The bucket name.","in":"path","name":"bucket","required":true,"schema":{"type":"string"}}],"post":{"description":"Allows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings.\nOnly allows enabling/disabling CORS for all origins, and/or setting canned ACLs.\n\n\nFor more fine-grained control of both systems, please use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl) directly.\n","operationId":"modifyObjectStorageBucketAccess","requestBody":{"content":{"application/json":{"schema":{"properties":{"acl":{"description":"The Access Control Level of the bucket, as a canned ACL string. For more fine-grained control of ACLs, use the S3 API directly.\n","enum":["private","public-read","authenticated-read","public-read-write","custom"],"example":"private","type":"string"},"cors_enabled":{"description":"If true, the bucket will be created with CORS enabled for all origins. For more fine-grained controls of CORS, use the S3 API directly.\n","example":true,"type":"boolean"}}}}},"description":"The changes to make to the bucket's access controls."},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Access controls updated."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Bucket Access Modify","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\ -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"cors_enabled\": true,\n \"acl\": \"private\"\n }' \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/access\n"}],"x-linode-cli-skip":true},"put":{"description":"Allows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings.\nOnly allows enabling/disabling CORS for all origins, and/or setting canned ACLs.\n\n\nFor more fine-grained control of both systems, please use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl) directly.\n","operationId":"updateObjectStorageBucketAccess","requestBody":{"content":{"application/json":{"schema":{"properties":{"acl":{"description":"The Access Control Level of the bucket, as a canned ACL string. For more fine-grained control of ACLs, use the S3 API directly.\n","enum":["private","public-read","authenticated-read","public-read-write","custom"],"example":"private","type":"string"},"cors_enabled":{"description":"If true, the bucket will be created with CORS enabled for all origins. For more fine-grained controls of CORS, use the S3 API directly.\n","example":true,"type":"boolean"}}}}},"description":"The changes to make to the bucket's access controls."},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Access controls updated."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Bucket Access Update","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\ -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"cors_enabled\": true,\n \"acl\": \"private\"\n }' \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/access\n"}],"x-linode-cli-skip":true}},"/object-storage/buckets/{clusterId}/{bucket}/object-acl":{"get":{"description":"View an Object's configured Access Control List (ACL) in this Object Storage bucket.\nACLs define who can access your buckets and objects and specify the level of access\ngranted to those users.\n\n\nThis endpoint is available for convenience. It is recommended that instead you\nuse the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object-acl) directly.\n","operationId":"viewObjectStorageBucketACL","parameters":[{"description":"The `name` of the object for which to retrieve its Access Control List (ACL). Use the [Object Storage Bucket Contents List](/docs/api/object-storage/#object-storage-bucket-contents-list) endpoint to access all object names in a bucket.\n","in":"query","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"acl":{"description":"The Access Control Level of the bucket, as a canned ACL string. For more fine-grained control of ACLs, use the S3 API directly.\n","enum":["private","public-read","authenticated-read","public-read-write","custom"],"example":"public-read","type":"string"},"acl_xml":{"description":"The full XML of the object's ACL policy.\n","example":"...","type":"string"}},"type":"object"}}},"description":"The Object's canned ACL and policy."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Object ACL Config View","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/object-acl?name=example.txt\n"}],"x-linode-cli-skip":true},"parameters":[{"description":"The ID of the cluster this bucket exists in.","in":"path","name":"clusterId","required":true,"schema":{"type":"string"}},{"description":"The bucket name.","in":"path","name":"bucket","required":true,"schema":{"type":"string"}}],"put":{"description":"Update an Object's configured Access Control List (ACL) in this Object Storage bucket.\nACLs define who can access your buckets and objects and specify the level of access\ngranted to those users.\n\n\nThis endpoint is available for convenience. It is recommended that instead you\nuse the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#set-object-acl) directly.\n","operationId":"updateObjectStorageBucketACL","requestBody":{"content":{"application/json":{"schema":{"properties":{"acl":{"description":"The Access Control Level of the bucket, as a canned ACL string. For more fine-grained control of ACLs, use the S3 API directly.\n","enum":["private","public-read","authenticated-read","public-read-write","custom"],"example":"public-read","type":"string"},"name":{"description":"The `name` of the object for which to update its Access Control List (ACL). Use the [Object Storage Bucket Contents List](/docs/api/object-storage/#object-storage-bucket-contents-list) endpoint to access all object names in a bucket.\n","type":"string"}},"required":["acl","name"]}}},"description":"The changes to make to this Object's access controls."},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"acl":{"description":"The Access Control Level of the bucket, as a canned ACL string. For more fine-grained control of ACLs, use the S3 API directly.\n","enum":["private","public-read","authenticated-read","public-read-write","custom"],"example":"public-read","type":"string"},"acl_xml":{"description":"The full XML of the object's ACL policy.\n","example":"...","type":"string"}},"type":"object"}}},"description":"The Object's canned ACL and policy."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Object ACL Config Update","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\ -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"acl\": \"public-read\",\n \"name\": \"example.txt\"\n }' \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/object-acl\n"}],"x-linode-cli-skip":true}},"/object-storage/buckets/{clusterId}/{bucket}/object-list":{"get":{"description":"Returns the contents of a bucket. The contents are paginated using a `marker`,\nwhich is the name of the last object on the previous page. Objects may\nbe filtered by `prefix` and `delimiter` as well; see Query Parameters for more\ninformation.\n\n\nThis endpoint is available for convenience. It is recommended that instead you\nuse the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object) directly.\n","operationId":"getObjectStorageBucketContent","parameters":[{"description":"The \"marker\" for this request, which can be used to paginate through large buckets. Its value should be the value of the `next_marker` property returned with the last page. Listing bucket contents *does not* support arbitrary page access. See the `next_marker` property in the responses section for more details.\n","in":"query","name":"marker","required":false,"schema":{"type":"string"}},{"description":"The delimiter for object names; if given, object names will be returned up to the first occurrence of this character. This is most commonly used with the `/` character to allow bucket transversal in a manner similar to a filesystem, however any delimiter may be used. Use in conjunction with `prefix` to see object names past the first occurrence of the delimiter.\n","in":"query","name":"delimiter","required":false,"schema":{"type":"string"}},{"description":"Filters objects returned to only those whose name start with the given prefix. Commonly used in conjunction with `delimiter` to allow transversal of bucket contents in a manner similar to a filesystem.\n","in":"query","name":"prefix","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"description":"This page of objects in the bucket.","items":{"$ref":"#/components/schemas/ObjectStorageObject"},"type":"array"}}}}},"description":"One page of the requested bucket's contents."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Bucket Contents List","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/object-list\n"}],"x-linode-cli-skip":true},"parameters":[{"description":"The ID of the cluster this bucket exists in.","in":"path","name":"clusterId","required":true,"schema":{"type":"string"}},{"description":"The bucket name.","in":"path","name":"bucket","required":true,"schema":{"type":"string"}}]},"/object-storage/buckets/{clusterId}/{bucket}/object-url":{"parameters":[{"description":"The ID of the cluster this bucket exists in.","in":"path","name":"clusterId","required":true,"schema":{"type":"string"}},{"description":"The bucket name.","in":"path","name":"bucket","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a pre-signed URL to access a single Object in a bucket. This\ncan be used to share objects, and also to create/delete objects by using\nthe appropriate HTTP method in your request body's `method` parameter.\n\n\nThis endpoint is available for convenience. It is recommended that instead you\nuse the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/)\ndirectly.\n","operationId":"createObjectStorageObjectURL","requestBody":{"content":{"application/json":{"schema":{"properties":{"content_type":{"description":"The expected `Content-type` header of the request this signed URL will be valid for. If provided, the `Content-type` header _must_ be sent with the request when this URL is used, and _must_ be the same as it was when the signed URL was created. Required for all methods *except* \"GET\" or \"DELETE\".\n","example":null,"type":"string"},"expires_in":{"default":3600,"description":"How long this signed URL will be valid for, in seconds. If omitted, the URL will be valid for 3600 seconds (1 hour).\n","example":null,"maximum":86400,"minimum":360,"type":"integer"},"method":{"default":"GET","description":"The HTTP method allowed to be used with the pre-signed URL.","example":"GET","type":"string"},"name":{"description":"The name of the object that will be accessed with the pre-signed URL. This object need not exist, and no error will be returned if it doesn't. This behavior is useful for generating pre-signed URLs to upload new objects to by setting the `method` to \"PUT\".\n","example":"example","type":"string"}},"required":["name","method"]}}},"description":"Information about the request to sign."},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"url":{"description":"The signed URL to perform the request at.","example":"https://us-east-1.linodeobjects.com/example-bucket/example?Signature=qr98TEucCntPgEG%2BsZQGDsJg93c%3D&Expires=1567609905&AWSAccessKeyId=G4YAF81XWY61DQM94SE0","type":"string"}}}}},"description":"The URL with which to access your object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Object URL Create","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\ -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"method\": \"GET\",\n \"name\": \"example\"\n }' \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/object-url\n"}],"x-linode-cli-skip":true}},"/object-storage/buckets/{clusterId}/{bucket}/ssl":{"delete":{"description":"Deletes this Object Storage bucket's user uploaded TLS/SSL certificate and private key.\n","operationId":"deleteObjectStorageSSL","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Deletes this Object Storage bucket's user uploaded TLS/SSL certificate and private key."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage TLS/SSL Cert Delete","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/ssl\n"},{"lang":"CLI","source":"linode-cli object-storage ssl-delete \\\n us-east-1 example-bucket\n"}],"x-linode-cli-action":"ssl-delete"},"get":{"description":"Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was\nuploaded by an Account user.\n","operationId":"getObjectStorageSSL","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectStorageSSLResponse"}}},"description":"Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage TLS/SSL Cert View","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/ssl\n"},{"lang":"CLI","source":"linode-cli object-storage ssl-view \\\n us-east-1 example-bucket\n"}],"x-linode-cli-action":"ssl-view"},"parameters":[{"description":"The ID of the cluster this bucket exists in.","in":"path","name":"clusterId","required":true,"schema":{"type":"string"}},{"description":"The bucket name.","in":"path","name":"bucket","required":true,"schema":{"type":"string"}}],"post":{"description":"Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS.\nYour TLS/SSL certificate and private key are stored encrypted at rest.\n\n\nTo replace an expired certificate, [delete your current certificate](/docs/api/object-storage/#object-storage-tlsssl-cert-delete)\nand upload a new one.\n","operationId":"createObjectStorageSSL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectStorageSSL"}}},"description":"Upload this TLS/SSL certificate with its corresponding secret key."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectStorageSSLResponse"}}},"description":"Returns whether this bucket has a corresponding TLS/SSL certificate that was uploaded by a user."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage TLS/SSL Cert Upload","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"certificate\": \"-----BEGIN CERTIFICATE-----\\nCERTIFICATE_INFORMATION\\n-----END CERTIFICATE-----\",\n \"private_key\": \"-----BEGIN PRIVATE KEY-----\\nPRIVATE_KEY_INFORMATION\\n-----END PRIVATE KEY-----\"\n }' \\\n https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/ssl\n"},{"lang":"CLI","source":"linode-cli object-storage ssl-upload \\\n us-east-1 example-bucket \\\n --certificate \"-----BEGIN CERTIFICATE-----\n CERTIFICATE_INFORMATION\n -----END CERTIFICATE-----\" \\\n --private_key \"-----BEGIN PRIVATE KEY-----\n PRIVATE_KEY_INFORMATION\n -----END PRIVATE KEY-----\"\n"}],"x-linode-cli-action":"ssl-upload"},"x-linode-cli-command":"object-storage"},"/object-storage/cancel":{"post":{"description":"Cancel Object Storage on an Account.\n\n**Warning**: Removes all buckets and their contents from your Account. This data is irretrievable once removed.\n","operationId":"cancelObjectStorage","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object Storage cancellation successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Cancel","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/object-storage/cancel\n"},{"lang":"CLI","source":"linode-cli object-storage cancel\n"}],"x-linode-cli-action":"cancel"},"x-linode-cli-command":"object-storage"},"/object-storage/clusters":{"get":{"description":"Returns a paginated list of Object Storage Clusters that are available for\nuse. Users can connect to the clusters with third party clients to create buckets\nand upload objects.\n","operationId":"getObjectStorageClusters","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObjectStorageCluster"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of available clusters."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Clusters List","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/object-storage/clusters\n"},{"lang":"CLI","source":"linode-cli object-storage clusters-list\n"}],"x-linode-cli-action":"clusters-list"},"x-linode-cli-command":"object-storage"},"/object-storage/clusters/{clusterId}":{"get":{"description":"Returns a single Object Storage Cluster.\n","operationId":"getObjectStorageCluster","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectStorageCluster"}}},"description":"The requested Cluster"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Cluster View","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/object-storage/clusters/us-east-1\n"},{"lang":"CLI","source":"linode-cli object-storage clusters-view us-east-1\n"}],"x-linode-cli-action":"clusters-view"},"parameters":[{"description":"The ID of the Cluster.","in":"path","name":"clusterId","required":true,"schema":{"type":"string"}}],"x-linode-cli-command":"object-storage"},"/object-storage/keys":{"get":{"description":"Returns a paginated list of Object Storage Keys for authenticating to\nthe Object Storage S3 API.\n","operationId":"getObjectStorageKeys","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObjectStorageKey"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of Object Storage Keys"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Keys List","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/object-storage/keys\n"},{"lang":"CLI","source":"linode-cli object-storage keys-list\n"}],"x-linode-cli-action":"keys-list"},"post":{"description":"Provisions a new Object Storage Key on your account.\n\nAccounts with negative balances cannot access this command.\n\n* To create a Limited Access Key with specific permissions, send a `bucket_access` array.\n\n* To create a Limited Access Key without access to any buckets, send an empty `bucket_access` array.\n\n* To create an Access Key with unlimited access to all clusters and all buckets, omit the `bucket_access` array.\n","operationId":"createObjectStorageKeys","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectStorageKey"}}},"description":"The label of the key to create. This is used to identify the created key.\n"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectStorageKey"}}},"description":"The new keypair. **This is the only time** the secret key is returned."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Key Create","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"my-object-storage-key\",\n \"bucket_access\": [\n {\n \"cluster\": \"ap-south-1\",\n \"bucket_name\": \"bucket-example-1\",\n \"permissions\": \"read_write\"\n },\n {\n \"cluster\": \"us-east-1\",\n \"bucket_name\": \"bucket-example-2\",\n \"permissions\": \"read_only\"\n }\n ]\n }' \\\n https://api.linode.com/v4/object-storage/keys\n"},{"lang":"CLI","source":"linode-cli object-storage keys-create \\\n --label \"my-object-storage-key\" \\\n --bucket_access '[{\"cluster\": \"ap-south-1\", \"bucket_name\": \"bucket-example-1\", \"permissions\": \"read_write\" }]'\n"}],"x-linode-cli-action":"keys-create"},"x-linode-cli-command":"object-storage"},"/object-storage/keys/{keyId}":{"delete":{"description":"Revokes an Object Storage Key. This keypair will no longer be usable by third-party clients.\n","operationId":"deleteObjectStorageKey","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Deletion successful"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Key Revoke","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/object-storage/keys/12345\n"},{"lang":"CLI","source":"linode-cli object-storage keys-delete 12345\n"}],"x-linode-cli-action":"keys-delete"},"get":{"description":"Returns a single Object Storage Key provisioned for your account.\n","operationId":"getObjectStorageKey","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectStorageKey"}}},"description":"The keypair"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Key View","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/object-storage/keys/12345\n"},{"lang":"CLI","source":"linode-cli object-storage keys-view \\\n --keyId 12345\n"}],"x-linode-cli-action":"keys-view"},"parameters":[{"description":"The key to look up.","in":"path","name":"keyId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates an Object Storage Key on your account.\n","operationId":"updateObjectStorageKey","requestBody":{"content":{"application/json":{"schema":{"properties":{"label":{"description":"The label for this keypair, for display purposes only.","example":"my-key","type":"string"}},"type":"object"}}},"description":"The fields to update."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectStorageKey"}}},"description":"Update Successful"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_write"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Key Update","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\ -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"my-object-storage-key\"\n }' \\\n https://api.linode.com/v4/object-storage/keys/12345\n"},{"lang":"CLI","source":"linode-cli object-storage keys-update \\\n --keyId 12345\n --label \"my-object-storage-key\"\n"}],"x-linode-cli-action":"keys-update"},"x-linode-cli-command":"object-storage"},"/object-storage/transfer":{"get":{"description":"The amount of outbound data transfer used by your account's Object Storage buckets.\nObject Storage adds 1 terabyte of outbound data transfer to your data transfer pool.\nSee the [Object Storage Overview](/docs/products/storage/object-storage/#pricing)\nguide for details on Object Storage transfer quotas.\n","operationId":"getObjectStorageTransfer","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"used":{"description":"The amount of outbound data transfer used by your account's Object Storage buckets, in bytes, for the current month's billing cycle.\n","example":12956600198,"readOnly":true,"type":"integer"}}}}},"description":"Returns the amount of outbound data transfer used by your account's Object Storage buckets.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["object_storage:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Object Storage Transfer View","tags":["Object Storage"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/object-storage/transfer/\n"}],"x-linode-cli-skip":true}},"/profile":{"get":{"description":"Returns information about the current User. This can be used to see who is acting in applications where more than one token is managed. For example, in third-party OAuth applications.\n\nThis endpoint is always accessible, no matter what OAuth scopes the acting token has.\n","operationId":"getProfile","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}},"description":"Profile response."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":[]}],"summary":"Profile View","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile\n"},{"lang":"CLI","source":"linode-cli profile view\n"}],"x-linode-cli-action":"view"},"put":{"description":"Update information in your Profile. This endpoint requires the \"account:read_write\" OAuth Scope.\n","operationId":"updateProfile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}},"description":"The fields to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}},"description":"Profile updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Profile Update","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"email\": \"example-user@gmail.com\",\n \"timezone\": \"US/Eastern\",\n \"email_notifications\": true,\n \"lish_auth_method\": \"keys_only\",\n \"authorized_keys\": null,\n \"two_factor_auth\": true,\n \"restricted\": false\n }' \\\n https://api.linode.com/v4/profile\n"},{"lang":"CLI","source":"linode-cli profile update \\\n --email example-user@gmail.com \\\n --timezone US/Eastern \\\n --email_notifications true \\\n --list_auth_method keys_only \\\n --two_factor_auth true \\\n --restricted false\n"}],"x-linode-cli-action":"update"},"x-linode-cli-command":"profile"},"/profile/apps":{"get":{"description":"This is a collection of OAuth apps that you've given access to your Account, and includes the level of access granted.\n","operationId":"getProfileApps","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AuthorizedApp"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of apps you've authorized.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Authorized Apps List","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/apps\n"},{"lang":"CLI","source":"linode-cli profile apps-list\n"}],"x-linode-cli-action":"apps-list"},"x-linode-cli-command":"profile"},"/profile/apps/{appId}":{"delete":{"description":"Expires this app token. This token may no longer be used to access your Account.\n","operationId":"deleteProfileApp","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"App's authorization has been revoked."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"App Access Revoke","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/profile/apps/123\n"},{"lang":"CLI","source":"linode-cli profile app-delete 123\n"}],"x-linode-cli-action":"app-delete"},"get":{"description":"Returns information about a single app you've authorized to access your Account.\n","operationId":"getProfileApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizedApp"}}},"description":"The app requested."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Authorized App View","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/apps/123\n"},{"lang":"CLI","source":"linode-cli profile app-view 1234\n"}],"x-linode-cli-action":"app-view"},"parameters":[{"description":"The authorized app ID to manage.","in":"path","name":"appId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"profile"},"/profile/devices":{"get":{"description":"Returns a paginated list of active TrustedDevices for your User. Browsers with an active Remember Me Session are logged into your account until the session expires or is revoked.\n","operationId":"getDevices","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TrustedDevice"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of TrustedDevice objects."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Trusted Devices List","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/devices\n"},{"lang":"CLI","source":"linode-cli profile devices-list\n"}],"x-linode-cli-action":"devices-list"},"x-linode-cli-command":"profile"},"/profile/devices/{deviceId}":{"delete":{"description":"Revoke an active TrustedDevice for your User. Once a TrustedDevice is revoked, this device will have to log in again before accessing your Linode account.\n","operationId":"revokeTrustedDevice","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Session revoked successfully"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Trusted Device Revoke","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/profile/devices/123\n"},{"lang":"CLI","source":"linode-cli profile device-revoke 123\n"}],"x-linode-cli-action":"device-revoke"},"get":{"description":"Returns a single active TrustedDevice for your User.\n","operationId":"getTrustedDevice","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrustedDevice"}}},"description":"The requested TrustedDevice object"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Trusted Device View","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/devices/123\n"},{"lang":"CLI","source":"linode-cli profile device-view 123\n"}],"x-linode-cli-action":"device-view"},"parameters":[{"description":"The ID of the TrustedDevice","in":"path","name":"deviceId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"profile"},"/profile/grants":{"get":{"description":"This returns a GrantsResponse describing what the acting User has been granted access to. For unrestricted users, this will return a 204 and no body because unrestricted users have access to everything without grants. This will not return information about entities you do not have access to. This endpoint is useful when writing third-party OAuth applications to see what options you should present to the acting User.\n\nFor example, if they do not have `global.add_linodes`, you might not display a button to deploy a new Linode.\n\nAny client may access this endpoint; no OAuth scopes are required.\n","operationId":"getProfileGrants","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantsResponse"}}},"description":"GrantsResponse"},"204":{"description":"This is an unrestricted User, who has no grants. This User can access everything on the Account.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":[]}],"summary":"Grants List","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/grants\n"}],"x-linode-cli-action":"grants","x-linode-cli-skip":true},"x-linode-cli-command":"profile"},"/profile/logins":{"get":{"description":"Returns a collection of successful account logins from this user during the last 90 days.\n","operationId":"getProfileLogins","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Login"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"An array of successful account logins from this user during the last 90 days.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Logins List","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/logins\n"},{"lang":"CLI","source":"linode-cli profile logins-list\n"}],"x-linode-cli-action":"logins-list"},"x-linode-cli-command":"profile"},"/profile/logins/{loginId}":{"get":{"description":"Returns a login object displaying information about a successful account login from this user.\n","operationId":"getProfileLogin","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Login"}}},"description":"The requested login object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Login View","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/logins/1234\n"},{"lang":"CLI","source":"linode-cli profile login-view 1234\n"}],"x-linode-cli-action":"login-view"},"parameters":[{"description":"The ID of the login object to access.","in":"path","name":"loginId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"profile"},"/profile/phone-number":{"delete":{"description":"Delete the verified phone number for the User making this request.\n\nUse this command to opt out of SMS messages for the requesting User after a phone number has been verified with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.\n","operationId":"deleteProfilePhoneNumber","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Phone number deletion request successful.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Phone Number Delete","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/profile/phone-number\n"},{"lang":"CLI","source":"linode-cli phone delete\n"}],"x-linode-cli-action":"delete","x-linode-grant":"read_write"},"post":{"description":"Send a one-time verification code via SMS message to the submitted phone number. Providing your phone number helps ensure you can securely access your Account in case other ways to connect are lost. Your phone number is only used to verify your identity by sending an SMS message. Standard carrier messaging fees may apply.\n\n* By accessing this command you are opting in to receive SMS messages. You can opt out of SMS messages by using the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command after your phone number is verified.\n\n* Verification codes are valid for 10 minutes after they are sent.\n\n* Subsequent requests made prior to code expiration result in sending the same code.\n\nOnce a verification code is received, verify your phone number with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.\n","operationId":"postProfilePhoneNumber","requestBody":{"content":{"application/json":{"schema":{"properties":{"iso_code":{"description":"The two-letter ISO 3166 country code associated with the phone number.","example":"US","type":"string"},"phone_number":{"description":"A valid phone number.","example":"555-555-5555","format":"phone","type":"string"}},"required":["iso_code","phone_number"],"type":"object"}}},"description":"Enter a phone number and country code for verification."},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Phone number verification code request successful.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Phone Number Verification Code Send","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"iso_code\": \"US\",\n \"phone_number\": \"555-555-5555\"\n }' \\\n https://api.linode.com/v4/profile/phone-number\n"},{"lang":"CLI","source":"linode-cli phone sms-code-send \\\n --iso-code US \\\n --phone-number 555-555-5555\n"}],"x-linode-cli-action":"sms-code-send","x-linode-grant":"read_write"},"x-linode-cli-command":"phone"},"/profile/phone-number/verify":{"post":{"description":"Verify a phone number by confirming the one-time code received via SMS message after accessing the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.\n\n* Verification codes are valid for 10 minutes after they are sent.\n\n* Only the same User that made the verification code request can use that code with this command.\n\nOnce completed, the verified phone number is assigned to the User making the request. To change the verified phone number for a User, first use the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command, then begin the verification process again with the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.\n","operationId":"postProfilePhoneNumberVerify","requestBody":{"content":{"application/json":{"schema":{"properties":{"otp_code":{"description":"The one-time code received via SMS message after accessing the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.","example":"US","type":"string"}},"required":["otp_code"],"type":"object"}}},"description":"Enter a phone verification code for confirmation."},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Phone number verification successful.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Phone Number Verify","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"otp_code\": \"123456\"\n }' \\\n https://api.linode.com/v4/profile/phone-number/verify\n"},{"lang":"CLI","source":"linode-cli phone verify \\\n --otp_code 123456\n"}],"x-linode-cli-action":"verify","x-linode-grant":"read_write"},"x-linode-cli-command":"phone"},"/profile/preferences":{"get":{"description":"View a list of user preferences tied to the OAuth client that generated\nthe token making the request. The user preferences endpoints allow\nconsumers of the API to store arbitrary JSON data, such as a user's font\nsize preference or preferred display name. User preferences are available\nfor each OAuth client registered to your account, and as such an account can\nhave multiple user preferences.\n","operationId":"getUserPreferences","responses":{"200":{"content":{"application/json":{"schema":{"description":"A dictionary of user preferences.","example":{"key1":"value1","key2":"value2"},"type":"object"}}},"description":"Returns an object of user preferences."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"User Preferences View","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/preferences\n"}],"x-linode-cli-action":"preferences-view","x-linode-cli-skip":true,"x-linode-grant":"read_only"},"put":{"description":"Updates a user's preferences. These preferences are tied to the OAuth client that generated the token making the request. The user preferences endpoints allow consumers of the API to store arbitrary JSON data, such as a user's font size preference or preferred display name. An account may have multiple preferences. Preferences, and the pertaining request body, may contain any arbitrary JSON data that the user would like to store.\n","operationId":"updateUserPreferences","requestBody":{"content":{"application/json":{"schema":{"description":"Arbitrary JSON of your choosing. Overwrites any existing preferences for this user.\n\nTotal length cannot exceed 65,535 characters.\n","maxLength":65535,"type":"object"}}},"description":"The user preferences to update or store.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"An object of user preferences.","example":{"key1":"value1","key2":"value2"},"type":"object"}}},"description":"Returns an object of user preferences."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"User Preferences Update","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n }' \\\n https://api.linode.com/v4/profile/preferences\n"}],"x-linode-cli-action":"preferences-update","x-linode-cli-skip":true},"x-linode-cli-command":"profile"},"/profile/security-questions":{"get":{"description":"Returns a collection of security questions and their responses, if any, for your User Profile.\n","operationId":"getSecurityQuestions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityQuestionsGet"},"x-linode-cli-nested-list":"security_questions","x-linode-cli-use-schema":{"properties":{"security_questions.id":{"x-linode-cli-display":1},"security_questions.question":{"x-linode-cli-display":2},"security_questions.response":{"x-linode-cli-display":3}},"type":"object"}}},"description":"Returns a list of security questions."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"servers":[{"url":"https://api.linode.com/v4"}],"summary":"Security Questions List","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/security-questions\n"},{"lang":"CLI","source":"linode-cli security-questions list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Adds security question responses for your User.\n\nRequires exactly three unique questions.\n\nPrevious responses are overwritten if answered or reset to `null` if unanswered.\n\n**Note**: Security questions must be answered for your User prior to accessing the **Two Factor Secret Create** ([POST /profile/tfa-enable](/docs/api/profile/#two-factor-secret-create)) command.\n","operationId":"postSecurityQuestions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityQuestionsPost"}}},"description":"Answer Security Questions"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityQuestionsPost"}}},"description":"Security Questions answered successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Security Questions Answer","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"security_questions\": [\n {\n \"question_id\": 1,\n \"response\": \"secret answer 1\"\n },\n {\n \"question_id\": 2,\n \"response\": \"secret answer 2\"\n },\n {\n \"question_id\": 11,\n \"response\": \"secret answer 3\"\n }\n ]\n }' \\\n https://api.linode.com/v4/profile/security-questions\n"}],"x-linode-cli-action":"answer","x-linode-cli-skip":true},"x-linode-cli-command":"security-questions"},"/profile/sshkeys":{"get":{"description":"Returns a collection of SSH Keys you've added to your Profile.\n","operationId":"getSSHKeys","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SSHKey"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of SSH Key objects."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"SSH Keys List","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/sshkeys\n"},{"lang":"CLI","source":"linode-cli sshkeys list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Adds an SSH Key to your Account profile.\n","operationId":"addSSHKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}},"description":"Add SSH Key"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}},"description":"SSH Key associated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"SSH Key Add","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"My SSH Key\",\n \"ssh_key\": \"ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer\"\n }' \\\n https://api.linode.com/v4/profile/sshkeys\n"},{"lang":"CLI","source":"linode-cli sshkeys create \\\n --label \"My SSH Key\" \\\n --ssh_key \"ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer\"\n"}],"x-linode-cli-action":"create"},"x-linode-cli-command":"sshkeys"},"/profile/sshkeys/{sshKeyId}":{"delete":{"description":"Deletes an SSH Key you have access to.\n\n**Note:** deleting an SSH Key will *not* remove it from any Linode or Disk that was deployed with `authorized_keys`. In those cases, the keys must be manually deleted on the Linode or Disk. This endpoint will only delete the key's association from your Profile.\n","operationId":"deleteSSHKey","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"SSH Key deleted successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"SSH Key Delete","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authoriztion: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/profile/sshkeys/42\n"},{"lang":"CLI","source":"linode-cli sshkeys delete 42\n"}],"x-linode-cli-action":["delete","rm"]},"get":{"description":"Returns a single SSH Key object identified by `id` that you have access to view.\n","operationId":"getSSHKey","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}},"description":"An SSH Key object"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"SSH Key View","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/sshkeys/42\n"},{"lang":"CLI","source":"linode-cli sshkeys view 42\n"}],"x-linode-cli-action":"view"},"parameters":[{"description":"The ID of the SSHKey","in":"path","name":"sshKeyId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates an SSH Key that you have permission to `read_write`.\n\nOnly SSH key labels can be updated.\n","operationId":"updateSSHKey","requestBody":{"content":{"application/json":{"schema":{"properties":{"label":{"$ref":"#/components/schemas/SSHKey/properties/label"}},"type":"object"}}},"description":"The fields to update.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}},"description":"SSH Key updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"SSH Key Update","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"my laptop\"\n }' \\\n https://api.linode.com/v4/profile/sshkeys/42\n"},{"lang":"CLI","source":"linode-cli sshkeys update 42 \\\n --label \"my laptop\"\n"}],"x-linode-cli-action":"update"},"x-linode-cli-command":"sshkeys"},"/profile/tfa-disable":{"post":{"description":"Disables Two Factor Authentication for your User. Once successful, login attempts from untrusted computers will only require a password before being successful. This is less secure, and is discouraged.\n","operationId":"tfaDisable","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"TFA disabled."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Two Factor Authentication Disable","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/profile/tfa-disable\n"},{"lang":"CLI","source":"linode-cli profile tfa-disable\n"}],"x-linode-cli-action":"tfa-disable"},"x-linode-cli-command":"profile"},"/profile/tfa-enable":{"post":{"description":"Generates a Two Factor secret for your User. To enable TFA for your User, enter the secret obtained from this command with the **Two Factor Authentication Confirm/Enable** ([POST /profile/tfa-enable-confirm](/docs/api/profile/#two-factor-authentication-confirmenable)) command.\nOnce enabled, logins from untrusted computers are required to provide\na TFA code before they are successful.\n\n**Note**: Before you can enable TFA, security questions must be answered for your User by accessing the **Security Questions Answer** ([POST /profile/security-questions](/docs/api/profile/#security-questions-answer)) command.\n","operationId":"tfaEnable","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"expiry":{"description":"When this Two Factor secret expires.\n","example":"2025-08-15T13:51:51.400Z","format":"date-time","type":"string"},"secret":{"description":"Your Two Factor secret. This is used to generate time-based two factor codes required for logging in. Doing this will be required to confirm TFA an actually enable it.\n","example":"5FXX6KLACOC33GTC","type":"string"}}}}},"description":"Two Factor secret generated"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Two Factor Secret Create","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/profile/tfa-enable\n"},{"lang":"CLI","source":"linode-cli profile tfa-enable\n"}],"x-linode-cli-action":"tfa-enable"},"x-linode-cli-command":"profile"},"/profile/tfa-enable-confirm":{"post":{"description":"Confirms that you can successfully generate Two Factor codes and enables TFA on your Account. Once this is complete, login attempts from untrusted computers will be required to provide a Two Factor code before they are successful.\n","operationId":"tfaConfirm","requestBody":{"content":{"application/json":{"schema":{"properties":{"tfa_code":{"description":"The Two Factor code you generated with your Two Factor secret. These codes are time-based, so be sure it is current.\n","example":"213456","type":"string"}}}}},"description":"The Two Factor code you generated with your Two Factor secret.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"scratch":{"description":"A one-use code that can be used in place of your Two Factor code, in case you are unable to generate one. Keep this in a safe place to avoid being locked out of your Account.\n","example":"sample two factor scratch","type":"string"}}}}},"description":"TFA enabled successfully"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Two Factor Authentication Confirm/Enable","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"tfa_code\": \"213456\"\n }' \\\n https://api.linode.com/v4/profile/tfa-enable-confirm\n"},{"lang":"CLI","source":"linode-cli profile tfa-confirm \\\n --tfa_code 213456\n"}],"x-linode-cli-action":"tfa-confirm"},"x-linode-cli-command":"profile"},"/profile/tokens":{"get":{"description":"Returns a paginated list of Personal Access Tokens currently active for your User.\n","operationId":"getPersonalAccessTokens","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PersonalAccessToken"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of active tokens."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Personal Access Tokens List","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/tokens\n"},{"lang":"CLI","source":"linode-cli profile tokens-list\n"}],"x-linode-cli-action":"tokens-list"},"post":{"description":"Creates a Personal Access Token for your User. The raw token will be returned in the response, but will never be returned again afterward so be sure to take note of it. You may create a token with _at most_ the scopes of your current token. The created token will be able to access your Account until the given expiry, or until it is revoked.\n","operationId":"createPersonalAccessToken","requestBody":{"content":{"application/json":{"schema":{"properties":{"expiry":{"description":"When this token should be valid until. If omitted, the new token will be valid until it is manually revoked.\n","example":null,"format":"date-time","type":"string"},"label":{"$ref":"#/components/schemas/PersonalAccessToken/properties/label"},"scopes":{"description":"The access [scopes](/docs/api#oauth-reference) to grant to the created token. These cannot be changed after creation, and may not exceed the scopes of the acting token.\n\nIf omitted or entered with a wildcard character (`*`), the new token will have the same scopes as the acting token.\n\nMultiple scopes are separated by a space character (` `).\n\nFor example, `linodes:read_write account:read_only`.\n","example":"*","format":"oauth-scope","type":"string"}}}}},"description":"Information about the requested token.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalAccessToken"}}},"description":"Token created successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Personal Access Token Create","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"scopes\": \"*\",\n \"expiry\": \"2018-01-01T13:46:32\",\n \"label\": \"linode-cli\"\n }' \\\n https://api.linode.com/v4/profile/tokens\n"},{"lang":"CLI","source":"linode-cli profile token-create \\\n --scopes '*' \\\n --expiry '2018-01-01T13:46:32' \\\n --label linode-cli\n"}],"x-linode-cli-action":"token-create"},"x-linode-cli-command":"profile"},"/profile/tokens/{tokenId}":{"delete":{"description":"Revokes a Personal Access Token. The token will be invalidated immediately, and requests using that token will fail with a 401. It is possible to revoke access to the token making the request to revoke a token, but keep in mind that doing so could lose you access to the api and require you to create a new token through some other means.\n","operationId":"deletePersonalAccessToken","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Token revoked successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Personal Access Token Revoke","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/profile/tokens/123\n"},{"lang":"CLI","source":"linode-cli profile token-delete 123\n"}],"x-linode-cli-action":"token-delete"},"get":{"description":"Returns a single Personal Access Token.\n","operationId":"getPersonalAccessToken","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalAccessToken"}}},"description":"The requested token."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Personal Access Token View","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/profile/tokens/123\n"},{"lang":"CLI","source":"linode-cli profile token-view 123\n"}],"x-linode-cli-action":"token-view"},"parameters":[{"description":"The ID of the token to access.","in":"path","name":"tokenId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates a Personal Access Token.\n","operationId":"updatePersonalAccessToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalAccessToken"}}},"description":"The fields to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalAccessToken"}}},"description":"Token updated successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Personal Access Token Update","tags":["Profile"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"linode-cli\"\n }' \\\n https://api.linode.com/v4/profile/tokens/123\n"},{"lang":"CLI","source":"linode-cli profile token-update 123 \\\n --label linode-cli\n"}],"x-linode-cli-action":"token-update"},"x-linode-cli-command":"profile"},"/regions":{"get":{"description":"Lists the Regions available for Linode services. Not all services are guaranteed to be\navailable in all Regions.\n","operationId":"getRegions","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Region"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns an array of Regions."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Regions List","tags":["Regions"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/regions\n"},{"lang":"CLI","source":"linode-cli regions list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-redoc-load-ids":true},"x-linode-cli-command":"regions"},"/regions/{regionId}":{"get":{"description":"Returns a single Region.\n","operationId":"getRegion","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Region"}}},"description":"A single Region object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"summary":"Region View","tags":["Regions"],"x-code-samples":[{"lang":"Shell","source":"curl https://api.linode.com/v4/regions/us-east\n"},{"lang":"CLI","source":"linode-cli regions view us-east\n"}],"x-linode-cli-action":"view"},"parameters":[{"description":"ID of the Region to look up.","in":"path","name":"regionId","required":true,"schema":{"type":"string"}}],"x-linode-cli-command":"regions"},"/support/tickets":{"get":{"description":"Returns a collection of Support Tickets on your Account. Support Tickets can be both tickets you open with Linode for support, as well as tickets generated by Linode regarding your Account.\nThis collection includes all Support Tickets generated on your Account, with open tickets returned first.\n","operationId":"getTickets","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SupportTicket"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of SupportTicket objects."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Support Tickets List","tags":["Support"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/support/tickets\n"},{"lang":"CLI","source":"linode-cli tickets list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Open a Support Ticket.\nOnly one of the ID attributes (`linode_id`, `domain_id`, etc.) can be set on a single Support Ticket.\n","operationId":"createTicket","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportTicketRequest"}}},"description":"Open a Support Ticket."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportTicket"}}},"description":"Support Ticket opened."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Support Ticket Open","tags":["Support"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"description\": \"I'm having trouble setting the root password on my Linode. I tried following the instructions but something is not working and I'm not sure what I'm doing wrong. Can you please help me figure out how I can reset it?\",\n \"linode_id\": 123,\n \"summary\": \"Having trouble resetting root password on my Linode\"\n }' \\\n https://api.linode.com/v4/support/tickets\n"},{"lang":"CLI","source":"linode-cli tickets create \\\n --description \"I'm having trouble setting the root password on my Linode. I tried following the instructions but something is not working and I'm not sure what I'm doing wrong. Can you please help me figure out how I can reset it?\" \\\n --linode_id 123 \\\n --summary \"Having trouble resetting root password on my Linode\"\n"}],"x-linode-cli-action":"create","x-linode-grant":"read_write"},"x-linode-cli-command":"tickets"},"/support/tickets/{ticketId}":{"get":{"description":"Returns a Support Ticket under your Account.\n","operationId":"getTicket","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportTicket"}}},"description":"Returns a single SupportTicket object."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Support Ticket View","tags":["Support"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/support/tickets/11223344\n"},{"lang":"CLI","source":"linode-cli tickets view 11223344\n"}],"x-linode-cli-action":"view","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Support Ticket.","in":"path","name":"ticketId","required":true,"schema":{"type":"integer"}}],"x-linode-cli-command":"tickets"},"/support/tickets/{ticketId}/attachments":{"parameters":[{"description":"The ID of the Support Ticket.","in":"path","name":"ticketId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Adds a file attachment to an existing Support\nTicket on your Account. File attachments are used to assist our\nSupport team in resolving your Ticket. Examples of attachments\nare screen shots and text files that provide additional information.\n\nThe file attachment is submitted in the request as multipart/form-data.\n\n**Note**: Accepted file extensions include: .gif, .jpg, .jpeg, .pjpg,\n.pjpeg, .tif, .tiff, .png, .pdf, or .txt.\n","operationId":"createTicketAttachment","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"The local, absolute path to the file you want to attach to your Support Ticket.\n","example":"/Users/LinodeGuy/pictures/screen_shot.jpg","type":"string"}},"required":["file"]}}},"description":"Add an attachment.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Attachment created."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Support Ticket Attachment Create","tags":["Support"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n -F 'file=@/Users/LinodeGuy/pictures/screen_shot.jpg' \\\n https://api.linode.com/v4/support/tickets/11223344/attachments\n"}],"x-linode-cli-action":"upload-attachment","x-linode-cli-skip":true,"x-linode-grant":"read_write"},"x-linode-cli-command":"tickets"},"/support/tickets/{ticketId}/close":{"parameters":[{"description":"The ID of the Support Ticket.","in":"path","name":"ticketId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Closes a Support Ticket you have access to modify.\n","operationId":"closeTicket","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Support Ticket closed successfully."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Support Ticket Close","tags":["Support"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/support/tickets/11223344/close\n"},{"lang":"CLI","source":"linode-cli tickets close 11223344\n"}],"x-linode-cli-action":"close","x-linode-grant":"read_write"},"x-linode-cli-command":"tickets"},"/support/tickets/{ticketId}/replies":{"get":{"description":"Returns a collection of replies to a Support Ticket on your Account.\n","operationId":"getTicketReplies","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SupportTicketReply"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns a paginated list of SupportTicketReply objects."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Replies List","tags":["Support"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/support/tickets/11223344/replies\n"},{"lang":"CLI","source":"linode-cli tickets replies 11223344\n"}],"x-linode-cli-action":"replies","x-linode-grant":"read_only"},"parameters":[{"description":"The ID of the Support Ticket.","in":"path","name":"ticketId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Adds a reply to an existing Support Ticket.\n","operationId":"createTicketReply","requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"description":"The content of your reply.\n","example":"Thank you for your help. I was able to figure out what the problem was and I successfully reset my password. You guys are the best!\n","maxLength":65535,"minLength":1,"type":"string"}},"required":["description"]}}},"description":"Add a reply.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportTicketReply"}}},"description":"Reply created."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Reply Create","tags":["Support"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"description\": \"Thank you for your help. I was able to figure out what the problem was and I successfully reset my password. You guys are the best!\"\n }' \\\n https://api.linode.com/v4/support/tickets/11223344/replies\n"},{"lang":"CLI","source":"linode-cli tickets reply 11223344 \\\n --description \"Thank you for your help. I was able to figure out what the problem was and I successfully reset my password. You guys are the best!\"\n"}],"x-linode-cli-action":"reply","x-linode-grant":"read_write"},"x-linode-cli-command":"tickets"},"/tags":{"get":{"description":"Tags are User-defined labels attached to objects in your Account, such as Linodes. They are used for specifying and grouping attributes of objects that are relevant to the User.\n\nThis endpoint returns a paginated list of Tags on your account.\n","operationId":"getTags","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"A paginated list of Tags"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Tags List","tags":["Tags"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/tags\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Creates a new Tag and optionally tags requested objects with it immediately.\n\n**Important**: You must be an unrestricted User in order to add or modify Tags.\n","operationId":"createTag","requestBody":{"content":{"application/json":{"schema":{"properties":{"domains":{"description":"A list of Domain IDs to apply the new Tag to. You must be allowed to `read_write` all of the requested Domains, or the Tag will not be created and an error will be returned.\n","example":[564,565],"items":{"type":"integer"},"type":"array"},"label":{"description":"The new Tag.\n","example":"example tag","maxLength":50,"minLength":3,"type":"string"},"linodes":{"description":"A list of Linode IDs to apply the new Tag to. You must be allowed to `read_write` all of the requested Linodes, or the Tag will not be created and an error will be returned.\n","example":[123,456],"items":{"type":"integer"},"type":"array"},"nodebalancers":{"description":"A list of NodeBalancer IDs to apply the new Tag to. You must be allowed to `read_write` all of the requested NodeBalancers, or the Tag will not be created and an error will be returned.\n","example":[10301,10501],"items":{"type":"integer"},"type":"array"},"volumes":{"description":"A list of Volume IDs to apply the new Tag to. You must be allowed to `read_write` all of the requested Volumes, or the Tag will not be created and an error will be returned.\n","example":[9082,10003],"items":{"type":"integer"},"type":"array"}},"required":["label"],"type":"object"}}},"description":"The tag to create, and optionally the objects to tag.\n"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"The new Tag."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"New Tag Create","tags":["Tags"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"example tag\",\n \"linodes\": [123,456],\n \"volumes\": [9082,10003]\n }' \\\n https://api.linode.com/v4/tags\n"},{"lang":"CLI","source":"linode-cli tags create \\\n --label 'example tag' \\\n --linodes 123 \\\n --linodes 456 \\\n --volumes 9082 \\\n --volumes 10003\n"}],"x-linode-cli-action":"create"},"x-linode-cli-command":"tags"},"/tags/{label}":{"delete":{"description":"Remove a Tag from all objects and delete it.\n\n**Important**: You must be an unrestricted User in order to add or modify Tags.\n","operationId":"deleteTag","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Tag deleted."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_write"]}],"summary":"Tag Delete","tags":["Tags"],"x-linode-cli-action":["delete","rm"]},"get":{"description":"Returns a paginated list of all objects you've tagged with the requested Tag. This is a mixed collection of all object types.\n","operationId":"getTaggedObjects","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"data":{"discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/Linode","x-linode-ref-name":"linode"},{"$ref":"#/components/schemas/Domain","x-linode-ref-name":"domain"},{"$ref":"#/components/schemas/Volume","x-linode-ref-name":"volume"},{"$ref":"#/components/schemas/NodeBalancer","x-linode-ref-name":"nodeBalancer"}]},"type":{"example":"linode","type":"string"}},"type":"object"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}}}}},"description":"A paginated list of objects, organized by type, that have been tagged with the requested Tag.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["account:read_only"]}],"summary":"Tagged Objects List","tags":["Tags"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n \"https://api.linode.com/v4/tags/example tag\"\n"}],"x-linode-cli-command":"view","x-linode-cli-skip":true},"parameters":[{"in":"path","name":"label","required":true,"schema":{"type":"string"}}],"x-linode-cli-command":"tags"},"/volumes":{"get":{"description":"Returns a paginated list of Volumes you have permission to view.\n","operationId":"getVolumes","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Volume"},"type":"array"},"page":{"$ref":"#/components/schemas/PaginationEnvelope/properties/page"},"pages":{"$ref":"#/components/schemas/PaginationEnvelope/properties/pages"},"results":{"$ref":"#/components/schemas/PaginationEnvelope/properties/results"}},"type":"object"}}},"description":"Returns an array of all Volumes on your Account."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["volumes:read_only"]}],"summary":"Volumes List","tags":["Volumes"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/volumes\n"},{"lang":"CLI","source":"linode-cli volumes list\n"}],"x-linode-cli-action":["list","ls"],"x-linode-grant":"read_only"},"post":{"description":"Creates a Volume on your Account. In order for this to complete successfully, your User must have the `add_volumes` grant. Creating a new Volume will start accruing additional charges on your account.\n","operationId":"createVolume","requestBody":{"content":{"application/json":{"schema":{"properties":{"config_id":{"description":"When creating a Volume attached to a Linode, the ID of the Linode Config to include the new Volume in. This Config must belong to the Linode referenced by `linode_id`. Must _not_ be provided if `linode_id` is not sent. If a `linode_id` is sent without a `config_id`, the volume will be attached:\n\n * to the Linode's only config if it only has one config.\n * to the Linode's last used config, if possible.\n\nIf no config can be selected for attachment, an error will be returned.\n","example":23456,"type":"integer"},"label":{"description":"The Volume's label, which is also used in the `filesystem_path` of the resulting volume.\n","example":"my-volume","maxLength":32,"minLength":1,"pattern":"^[a-zA-Z]((?!--|__)[a-zA-Z0-9-_])+$","type":"string"},"linode_id":{"description":"The Linode this volume should be attached to upon creation. If not given, the volume will be created without an attachment.\n","example":123,"type":"integer"},"region":{"description":"The Region to deploy this Volume in. This is only required if a linode_id is not given.\n","example":null,"type":"string"},"size":{"default":20,"description":"The initial size of this volume, in GB. Be aware that volumes may only be resized up after creation.\n","example":20,"type":"integer"},"tags":{"description":"An array of Tags applied to this object. Tags are for organizational purposes only.\n","example":["example tag","another example"],"items":{"type":"string"},"type":"array","x-linode-filterable":true}},"required":["label"],"type":"object"}}},"description":"The requested initial state of a new Volume.","required":true,"x-linode-cli-allowed-defaults":["region"]},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}},"description":"Creating Volume.\n"},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["volumes:read_write"]}],"summary":"Volume Create","tags":["Volumes"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"my-volume\",\n \"size\": 20,\n \"linode_id\": 12346\n }' \\\n https://api.linode.com/v4/volumes\n"},{"lang":"CLI","source":"linode-cli volumes create \\\n --label my-volume \\\n --size 20 \\\n --linode_id 12346 \\\n --no-defaults\n"}],"x-linode-charge":true,"x-linode-cli-action":"create","x-linode-grant":"add_volumes"},"x-linode-cli-command":"volumes"},"/volumes/{volumeId}":{"delete":{"description":"Deletes a Volume you have permission to `read_write`.\n\n* **Deleting a Volume is a destructive action and cannot be undone.**\n\n* Deleting stops billing for the Volume. You will be billed for time used within\nthe billing period the Volume was active.\n\n* Volumes that are migrating cannot be deleted until the migration is finished.\n","operationId":"deleteVolume","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Volume deletion successful."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["volumes:read_write"]}],"summary":"Volume Delete","tags":["Volumes"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X DELETE \\\n https://api.linode.com/v4/volumes/12345\n"},{"lang":"CLI","source":"linode-cli volumes delete 12345\n"}],"x-linode-cli-action":["delete","rm"],"x-linode-grant":"read_write"},"get":{"description":"Get information about a single Volume.\n","operationId":"getVolume","parameters":[{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/pageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}},"description":"Returns a single Volume object.","links":{"attach":{"$ref":"#/components/links/attachVolume"},"clone":{"$ref":"#/components/links/cloneVolume"},"detach":{"$ref":"#/components/links/detachVolume"},"resize":{"$ref":"#/components/links/resizeVolume"}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["volumes:read_only"]}],"summary":"Volume View","tags":["Volumes"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Authorization: Bearer $TOKEN\" \\\n https://api.linode.com/v4/volumes/12345\n"},{"lang":"CLI","source":"linode-cli volumes view 12345\n"}],"x-linode-cli-action":"view","x-linode-grant":"read_only"},"parameters":[{"description":"ID of the Volume to look up.","in":"path","name":"volumeId","required":true,"schema":{"type":"integer"}}],"put":{"description":"Updates a Volume that you have permission to `read_write`.\n","operationId":"updateVolume","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Volume"},{"properties":{"linode_id":{"readOnly":true},"size":{"readOnly":true}},"type":"object"}]}}},"description":"If any updated field fails to pass validation, the Volume will not be updated.\n","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}},"description":"The updated Volume."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["volumes:read_write"]}],"summary":"Volume Update","tags":["Volumes"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X PUT -d '{\n \"label\": \"my-volume\"\n }' \\\n https://api.linode.com/v4/volumes/12345\n"},{"lang":"CLI","source":"linode-cli volumes update 12345 \\\n --label my_volume\n"}],"x-linode-cli-action":"update","x-linode-grant":"read_write"},"x-linode-cli-command":"volumes"},"/volumes/{volumeId}/attach":{"parameters":[{"description":"ID of the Volume to attach.","in":"path","name":"volumeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Attaches a Volume on your Account to an existing Linode on your Account. In order for this request to complete successfully, your User must have `read_only` or `read_write` permission to the Volume and `read_write` permission to the Linode. Additionally, the Volume and Linode must be located in the same Region.\n","operationId":"attachVolume","requestBody":{"content":{"application/json":{"schema":{"properties":{"config_id":{"description":"The ID of the Linode Config to include this Volume in. Must belong to the Linode referenced by `linode_id`. If not given, the last booted Config will be chosen.\n","example":23456,"type":"integer"},"linode_id":{"description":"The ID of the Linode to attach the volume to.","type":"integer"},"persist_across_boots":{"description":"Defaults to true, if false is provided, the Volume will not be attached to the Linode Config. In this case more than 8 Volumes may be attached to a Linode if a Linode has 16GB of RAM or more. The number of volumes that can be attached is equal to the number of GB of RAM that the Linode has, up to a maximum of 64. `config_id` should not be passed if this is set to false and linode_id must be passed. The Linode must be running.\n","type":"boolean"}},"required":["linode_id"],"type":"object"}}},"description":"Volume to attach to a Linode.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}},"description":"Volume was attached to a Linode."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["volumes:read_write","linodes:read_write"]}],"summary":"Volume Attach","tags":["Volumes"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"linode_id\": 12346,\n \"config_id\": 23456\n }' \\\n https://api.linode.com/v4/volumes/12345/attach\n"},{"lang":"CLI","source":"linode-cli volumes attach 12345 \\\n --linode_id 12346 \\\n --config_id 23456\n"}],"x-linode-cli-action":"attach"},"x-linode-cli-command":"volumes"},"/volumes/{volumeId}/clone":{"parameters":[{"description":"ID of the Volume to clone.","in":"path","name":"volumeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Creates a Volume on your Account. In order for this request to complete successfully, your User must have the `add_volumes` grant. The new Volume will have the same size and data as the source Volume. Creating a new Volume will incur a charge on your Account.\n* Only Volumes with a `status` of \"active\" can be cloned.\n","operationId":"cloneVolume","requestBody":{"content":{"application/json":{"schema":{"properties":{"label":{"$ref":"#/components/schemas/Volume/properties/label"}},"required":["label"],"type":"object"}}},"description":"The requested state your Volume will be cloned into.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}},"description":"Clone started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["volumes:read_write"]}],"summary":"Volume Clone","tags":["Volumes"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"label\": \"my-volume\"\n }' \\\n https://api.linode.com/v4/volumes/12345/clone\n"},{"lang":"CLI","source":"linode-cli volumes clone 12345 \\\n --label my-volume\n"}],"x-linode-charge":true,"x-linode-cli-action":"clone","x-linode-grant":"add_volumes"},"x-linode-cli-command":"volumes"},"/volumes/{volumeId}/detach":{"parameters":[{"description":"ID of the Volume to detach.","in":"path","name":"volumeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Detaches a Volume on your Account from a Linode on your Account. In order for this request to complete successfully, your User must have `read_write` access to the Volume and `read_write` access to the Linode.\n","operationId":"detachVolume","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Volume was detached from a Linode."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["volumes:read_write","linodes:read_write"]}],"summary":"Volume Detach","tags":["Volumes"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST \\\n https://api.linode.com/v4/volumes/12345/detach\n"},{"lang":"CLI","source":"linode-cli volumes detach 12345\n"}],"x-linode-cli-action":"detach"},"x-linode-cli-command":"volumes"},"/volumes/{volumeId}/resize":{"parameters":[{"description":"ID of the Volume to resize.","in":"path","name":"volumeId","required":true,"schema":{"type":"integer"}}],"post":{"description":"Resize an existing Volume on your Account. In order for this request to complete successfully, your User must have the `read_write` permissions to the Volume.\n* Volumes can only be resized up.\n* Only Volumes with a `status` of \"active\" can be resized.\n","operationId":"resizeVolume","requestBody":{"content":{"application/json":{"schema":{"properties":{"size":{"$ref":"#/components/schemas/Volume/properties/size"}},"required":["size"],"type":"object"}}},"description":"The requested size to increase your Volume to.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}},"description":"Volume resize started."},"default":{"$ref":"#/components/responses/ErrorResponse"}},"security":[{"personalAccessToken":[]},{"oauth":["volumes:read_write"]}],"summary":"Volume Resize","tags":["Volumes"],"x-code-samples":[{"lang":"Shell","source":"curl -H \"Content-Type: application/json\" \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -X POST -d '{\n \"size\": 30\n }' \\\n https://api.linode.com/v4/volumes/12345/resize\n"},{"lang":"CLI","source":"linode-cli volumes resize 12345 \\\n --size 30\n"}],"x-linode-charge":true,"x-linode-cli-action":"resize"},"x-linode-cli-command":"volumes"}},"components":{"links":{"attachVolume":{"operationId":"attachVolume","parameters":{"volumeID":"$request.body#/id"}},"bootLinode":{"operationId":"bootLinodeInstance","parameters":{"linodeId":"$request.body#/id"}},"cloneLinode":{"operationId":"cloneLinodeInstance","parameters":{"linodeId":"$request.body#/id"}},"cloneVolume":{"operationId":"cloneVolume","parameters":{"volumeId":"$request.body#/id"}},"deleteLinode":{"operationId":"deleteLinodeInstance","parameters":{"linodeId":"$request.body#/id"}},"detachVolume":{"operationId":"detachVolume","parameters":{"volumeId":"$request.body#/id"}},"mutateLinode":{"operationId":"mutateLinodeInstance","parameters":{"linodeId":"$request.body#/id"}},"rebootLinode":{"operationId":"rebootLinodeInstance","parameters":{"linodeId":"$request.body#/id"}},"rebuildLinode":{"operationId":"rebuildLinodeInstance","parameters":{"linodeId":"$request.body#/id"}},"rescueLinode":{"operationId":"rescueLinodeInstance","parameters":{"linodeId":"$request.body#/id"}},"resizeLinode":{"operationId":"resizeLinodeInstance","parameters":{"linodeId":"$request.body#/id"}},"resizeVolume":{"operationId":"resizeVolume","parameters":{"volumeId":"$request.body#/id"}},"shutdownLinode":{"operationId":"shutdownLinodeInstance","parameters":{"linodeId":"$request.body#/id"}},"updateLinode":{"operationId":"updateLinodeInstance","parameters":{"linodeId":"$request.body#/id"}}},"parameters":{"pageOffset":{"description":"The page of a collection to return.","in":"query","name":"page","required":false,"schema":{"default":1,"minimum":1,"type":"integer"}},"pageSize":{"description":"The number of items to return per page.","in":"query","name":"page_size","schema":{"default":100,"maximum":500,"minimum":25,"type":"integer"}}},"responses":{"AcceptedResponse":{"content":{"application/json":{"schema":{"properties":{"warnings":{"items":{"$ref":"#/components/schemas/WarningObject"},"type":"array"}},"type":"object"}}},"description":"Accepted with warning.\n\nA warnings array is included with the standard 200 response body.\n"},"DeprecatedResponse":{"content":{"application/json":{"schema":{"properties":{"warnings":{"items":{"$ref":"#/components/schemas/WarningObject"},"type":"array"}},"type":"object"}}},"description":"Request successful. This endpoint is deprecated and may be removed in a future release.\n\nA warnings array is included with the standard 200 response body.\n"},"ErrorResponse":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorObject"},"type":"array"}},"type":"object"}}},"description":"Error"}},"schemas":{"Account":{"description":"Account object","properties":{"active_promotions":{"items":{"$ref":"#/components/schemas/Promotion"},"readOnly":true,"type":"array"},"active_since":{"description":"The datetime of when the account was activated.","example":"2025-08-15T13:51:51.401Z","format":"date-time","readOnly":true,"type":"string"},"address_1":{"description":"First line of this Account's billing address.","example":"123 Main Street","maxLength":64,"type":"string"},"address_2":{"description":"Second line of this Account's billing address.","example":"Suite A","maxLength":64,"type":"string"},"balance":{"description":"This Account's balance, in US dollars.","example":200,"readOnly":true,"type":"number","x-linode-cli-display":4},"balance_uninvoiced":{"description":"This Account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.\n","example":145,"readOnly":true,"type":"number","x-linode-cli-display":4},"billing_source":{"description":"The source of service charges for this Account, as determined by its relationship with Akamai.\nAccounts that are associated with Akamai-specific customers return a value of `akamai`.\nAll other Accounts return a value of `linode`.\n","enum":["akamai","linode"],"example":"akamai","readOnly":true,"type":"string"},"capabilities":{"description":"A list of capabilities your account supports.\n","example":["Linodes","NodeBalancers","Block Storage","Object Storage"],"items":{"type":"string"},"readOnly":true,"type":"array"},"city":{"description":"The city for this Account's billing address.","example":"Philadelphia","maxLength":24,"type":"string"},"company":{"description":"The company name associated with this Account.","example":"Linode LLC","maxLength":128,"type":"string"},"country":{"description":"The two-letter ISO 3166 country code of this Account's billing address.\n","example":"US","type":"string"},"credit_card":{"description":"Credit Card information associated with this Account.","properties":{"expiry":{"description":"The expiration month and year of the credit card.","example":"11/2022","type":"string"},"last_four":{"description":"The last four digits of the credit card associated with this Account.\n","example":1111,"type":"string"}},"readOnly":true,"type":"object"},"email":{"description":"The email address of the person associated with this Account.","example":"john.smith@linode.com","maxLength":128,"type":"string","x-linode-cli-display":3},"euuid":{"description":"An external unique identifier for this account.\n","example":"E1AF5EEC-526F-487D-B317EBEB34C87D71","format":"uuid","readOnly":true,"type":"string"},"first_name":{"description":"The first name of the person associated with this Account.","example":"John","maxLength":50,"type":"string","x-linode-cli-display":1},"last_name":{"description":"The last name of the person associated with this Account.","example":"Smith","maxLength":50,"type":"string","x-linode-cli-display":2},"phone":{"description":"The phone number associated with this Account.","example":"215-555-1212","maxLength":32,"type":"string"},"state":{"description":"If billing address is in the United States (US) or Canada (CA), only the two-letter ISO 3166 State or Province code are accepted. If entering a US military address, state abbreviations (AA, AE, AP) should be entered. If the address is outside the US or CA, this is the Province associated with the Account's billing address.\n","example":"PA","maxLength":24,"type":"string"},"tax_id":{"description":"The tax identification number associated with this Account, for tax calculations in some countries. If you do not live in a country that collects tax, this should be an empty string (`\"\"`).\n","example":"ATU99999999","maxLength":25,"type":"string"},"zip":{"description":"The zip code of this Account's billing address. The following restrictions apply:\n\n- May only consist of letters, numbers, spaces, and hyphens.\n- Must not contain more than 9 letter or number characters.\n","example":"19102-1234","type":"string"}},"type":"object"},"AccountSettings":{"description":"Account Settings object","properties":{"backups_enabled":{"description":"Account-wide backups default. If `true`, all Linodes created will automatically be enrolled in the Backups service. If `false`, Linodes will not be enrolled by default, but may still be enrolled on creation or later.\n","example":true,"type":"boolean","x-linode-cli-display":4},"longview_subscription":{"description":"The Longview Pro tier you are currently subscribed to. The value must be a [Longview Subscription](/docs/api/longview/#longview-subscriptions-list) ID or `null` for Longview Free.\n","example":"longview-3","readOnly":true,"type":"string","x-linode-cli-display":2},"managed":{"description":"Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we'll monitor it for connectivity, response, and total request time.\n","example":true,"readOnly":true,"type":"boolean","x-linode-cli-display":3},"network_helper":{"description":"Enables network helper across all users by default for new Linodes and Linode Configs.\n","example":false,"type":"boolean","x-linode-cli-display":1},"object_storage":{"default":"disabled","description":"A string describing the status of this account's Object Storage service enrollment.\n","enum":["disabled","suspended","active"],"example":"active","readOnly":true,"type":"string","x-linode-cli-display":5}},"type":"object"},"AuthorizedApp":{"description":"An application you have authorized access to your Account through OAuth.\n","properties":{"created":{"description":"When this app was authorized.","example":"2025-08-15T13:51:51.401Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":5,"x-linode-filterable":true},"expiry":{"description":"When the app's access to your account expires. If `null`, the app's access must be revoked manually.\n","example":"2025-08-15T13:51:51.401Z","format":"date-time","nullable":true,"readOnly":true,"type":"string","x-linode-cli-display":6,"x-linode-filterable":true},"id":{"description":"This authorization's ID, used for revoking access.\n","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":1},"label":{"description":"The name of the application you've authorized.\n","example":"example-app","readOnly":true,"type":"string","x-linode-cli-display":2},"scopes":{"description":"The OAuth scopes this app was authorized with. This defines what parts of your Account the app is allowed to access.\n","example":"linodes:read_only","format":"oauth-scopes","readOnly":true,"type":"string","x-linode-cli-display":3},"thumbnail_url":{"description":"The URL at which this app's thumbnail may be accessed.\n","example":null,"format":"url","readOnly":true,"type":"string"},"website":{"description":"The website where you can get more information about this app.\n","example":"example.org","format":"url","readOnly":true,"type":"string","x-linode-cli-display":4}},"type":"object"},"Backup":{"description":"An object representing a Backup or snapshot for a Linode with Backup service enabled.\n","properties":{"available":{"description":"Whether this Backup is available for restoration.\n\nBackups undergoing maintenance are not available for restoration.\n","example":true,"readOnly":true,"type":"boolean"},"configs":{"description":"A list of the labels of the Configuration profiles that are part of the Backup.\n","items":{"example":"My Debian 9 Config","type":"string"},"readOnly":true,"type":"array"},"created":{"description":"The date the Backup was taken.","example":"2025-08-15T13:51:51.401Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":4},"disks":{"description":"A list of the disks that are part of the Backup.\n","items":{"properties":{"filesystem":{"$ref":"#/components/schemas/Disk/properties/filesystem"},"label":{"example":"My Debian 9 Disk","type":"string"},"size":{"example":9001,"type":"integer"}},"type":"object"},"readOnly":true,"type":"array"},"finished":{"description":"The date the Backup completed.","example":"2025-08-15T13:51:51.401Z","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"The unique ID of this Backup.","example":123456,"readOnly":true,"type":"integer","x-linode-cli-display":1},"label":{"description":"A label for Backups that are of type `snapshot`.","example":"Webserver-Backup-2018","nullable":true,"type":"string","x-linode-cli-display":5},"status":{"description":"The current state of a specific Backup.","enum":["paused","pending","running","needsPostProcessing","successful","failed","userAborted"],"example":"successful","readOnly":true,"type":"string","x-linode-cli-color":{"default_":"yellow","failed":"red","successful":"green","userAborted":"f"},"x-linode-cli-display":2},"type":{"description":"This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time.\n","enum":["auto","snapshot"],"example":"snapshot","readOnly":true,"type":"string","x-linode-cli-display":3},"updated":{"description":"The date the Backup was most recently updated.","example":"2025-08-15T13:51:51.401Z","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"CreditCard":{"description":"An object representing the credit card information you have on file with\nLinode to make Payments against your Account.\n","properties":{"card_number":{"description":"Your credit card number. No spaces or dashes allowed.","example":4111111111111111,"format":"digits","maxLength":24,"minLength":14,"type":"string"},"cvv":{"description":"CVV (Card Verification Value) of the credit card, typically found on the back of the card.\n","example":"123","format":"digits","maxLength":4,"minLength":3,"type":"string"},"expiry_month":{"description":"A value from 1-12 representing the expiration month of your credit card.\n\n * 1 = January\n * 2 = February\n * 3 = March\n * Etc.\n","example":12,"maximum":12,"minimum":1,"type":"integer"},"expiry_year":{"description":"A four-digit integer representing the expiration year of\nyour credit card.\n\nThe combination of `expiry_month` and `expiry_year`\nmust result in a month/year combination of the current month or in\nthe future. An expiration date set in the past is invalid.\n","example":2020,"maxLength":4,"minLength":4,"type":"integer"}},"required":["card_number","expiry_month","expiry_year","cvv"],"type":"object"},"CreditCardData":{"description":"Credit card information.","properties":{"card_type":{"description":"The type of credit card.","example":"Discover","readOnly":true,"type":"string"},"expiry":{"description":"The expiration month and year of the credit card.","example":"06/2022","format":"MM/YYYY","readOnly":true,"type":"string"},"last_four":{"description":"The last four digits of the credit card number.","example":"1234","readOnly":true,"type":"string"}},"type":"object"},"Database":{"description":"A general Managed Database instance object containing properties that are identical for all database types.","properties":{"allow_list":{"description":"A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.\n\nBy default, this is an empty array (`[]`), which blocks all connections (both public and private) to the Managed Database.\n\nIf `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.\n","example":["203.0.113.1/32","192.0.1.0/24"],"items":{"format":"ipv4/prefix_length","pattern":"^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$","type":"string"},"type":"array"},"cluster_size":{"default":1,"description":"The number of Linode Instance nodes deployed to the Managed Database.\n\nChoosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.\n","enum":[1,3],"example":3,"type":"integer","x-linode-cli-display":5},"created":{"description":"When this Managed Database was created.","example":"2025-08-15T13:51:51.401Z","format":"date-time","readOnly":true,"type":"string"},"encrypted":{"default":false,"description":"Whether the Managed Databases is encrypted.","example":false,"type":"boolean"},"engine":{"description":"The Managed Database engine type.","enum":["mongodb","mysql","postgresql"],"example":"mysql","readOnly":true,"type":"string","x-linode-cli-display":6,"x-linode-filterable":true},"hosts":{"description":"The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.","properties":{"primary":{"description":"The primary host for the Managed Database.","example":"lin-123-456-mysql-mysql-primary.servers.linodedb.net","nullable":true,"type":"string"},"secondary":{"description":"The secondary/private network host for the Managed Database.\n\nA private network host and a private IP can only be used to access a Database Cluster from Linodes in the same data center and will not incur transfer costs.\n\n**Note**: The secondary hostname is publicly viewable and accessible.\n","example":"lin-123-456-mysql-primary-private.servers.linodedb.net","nullable":true,"type":"string"}},"readOnly":true,"type":"object"},"id":{"description":"A unique ID that can be used to identify and reference the Managed Database.","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":1},"instance_uri":{"description":"Append this to `https://api.linode.com` to run commands for the Managed Database.\n","example":"/v4/databases/mysql/instances/123","readOnly":true,"type":"string"},"label":{"description":"A unique, user-defined string referring to the Managed Database.","example":"example-db","maxLength":32,"minLength":3,"type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"region":{"description":"The [Region](/docs/api/regions/) ID for the Managed Database.","example":"us-east","type":"string","x-linode-cli-display":3,"x-linode-filterable":true},"status":{"description":"The operating status of the Managed Database.","enum":["provisioning","active","suspending","suspended","resuming","restoring","failed","degraded","updating","backing_up"],"example":"active","readOnly":true,"type":"string","x-linode-cli-color":{"active":"green","default_":"white","degraded":"red","failed":"red","provisioning":"yellow","restoring":"yellow","resuming":"yellow","updating":"yellow"},"x-linode-cli-display":100,"x-linode-filterable":true},"type":{"description":"The Linode Instance type used by the Managed Database for its nodes.","example":"g6-dedicated-2","type":"string","x-linode-cli-display":4,"x-linode-filterable":true},"updated":{"description":"When this Managed Database was last updated.","example":"2025-08-15T13:51:51.401Z","format":"date-time","readOnly":true,"type":"string"},"updates":{"description":"Configuration settings for automated patch update maintenance for the Managed Database.","properties":{"day_of_week":{"description":"The day to perform maintenance. 1=Monday, 2=Tuesday, etc.","example":1,"maximum":7,"minimum":1,"type":"integer"},"duration":{"description":"The maximum maintenance window time in hours.","example":3,"maximum":3,"minimum":1,"type":"integer"},"frequency":{"default":"weekly","description":"Whether maintenance occurs on a weekly or monthly basis.","enum":["weekly","monthly"],"example":"weekly","type":"string"},"hour_of_day":{"description":"The hour to begin maintenance based in UTC time.","example":0,"maximum":23,"minimum":0,"type":"integer"},"week_of_month":{"description":"The week of the month to perform `monthly` frequency updates. Defaults to `null`.\n\n* Required for `monthly` frequency updates.\n\n* Must be `null` for `weekly` frequency updates.\n","example":null,"maximum":4,"minimum":1,"nullable":true,"type":"integer"}},"type":"object"},"version":{"description":"The Managed Database engine version.","example":"8.0.26","readOnly":true,"type":"string","x-linode-cli-display":7,"x-linode-filterable":true}},"type":"object"},"DatabaseBackup":{"description":"A database backup object.","properties":{"created":{"description":"A time value given in a combined date and time format that represents when the database backup was created.","example":"2025-08-15T13:51:51.401Z","format":"datetime","type":"string","x-linode-cli-display":4,"x-linode-filterable":true},"id":{"description":"The ID of the database backup object.","example":123,"type":"integer","x-linode-cli-display":1},"label":{"description":"The database backup's label, for display purposes only.\n\nMust include only ASCII letters or numbers.\n","example":"Scheduled - 02/04/22 11:11 UTC-XcCRmI","maxLength":30,"type":"string","x-linode-cli-display":2},"type":{"description":"The type of database backup, determined by how the backup was created.","enum":["snapshot","auto"],"example":"auto","type":"string","x-linode-cli-display":3,"x-linode-filterable":true}},"type":"object"},"DatabaseBackupSnapshot":{"description":"Managed Database request object for snapshot backup.","properties":{"label":{"description":"The label for the Database snapshot backup.\n\n* Must include only ASCII letters or numbers.\n* Must be unique among other backup labels for this Database.\n","example":"db-snapshot","maxLength":30,"minLength":1,"type":"string"},"target":{"default":"primary","description":"The Database cluster target.\nIf the Database is a high availability cluster, choosing `secondary` creates a snapshot backup of a replica node.\n","enum":["primary","secondary"],"example":"primary","type":"string"}},"required":["label"],"type":"object"},"DatabaseCredentials":{"description":"Managed Database object for database credentials.","properties":{"password":{"description":"The randomly-generated root password for the Managed Database instance.","example":"s3cur3P@ssw0rd","readOnly":true,"type":"string","x-linode-cli-display":2},"username":{"description":"The root username for the Managed Database instance.","example":"linroot","readOnly":true,"type":"string","x-linode-cli-display":1}},"type":"object"},"DatabaseEngine":{"description":"Managed Database engine object.","properties":{"engine":{"description":"The Managed Database engine type.","example":"mysql","type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"id":{"description":"The Managed Database engine ID in engine/version format.","example":"mysql/8.0.26","type":"string","x-linode-cli-display":1},"version":{"description":"The Managed Database engine version.","example":"8.0.26","type":"string","x-linode-cli-display":3,"x-linode-filterable":true}},"type":"object"},"DatabaseMongoDB":{"description":"Managed MongoDB Databases object.","properties":{"allow_list":{"$ref":"#/components/schemas/Database/properties/allow_list"},"cluster_size":{"$ref":"#/components/schemas/Database/properties/cluster_size","x-linode-cli-display":5},"compression_type":{"default":"none","description":"The type of data compression for this Database.\n\nSnappy has a lower comparative compression ratio and resource consumption rate.\n\nZlip has a higher comparative compression ratio and resource consumption rate.\n","enum":["none","snappy","zlip"],"example":"none","type":"string","x-linode-cli-display":99},"created":{"$ref":"#/components/schemas/Database/properties/created"},"encrypted":{"$ref":"#/components/schemas/Database/properties/encrypted"},"engine":{"description":"The Managed Database engine type.","example":"mongodb","readOnly":true,"type":"string","x-linode-cli-display":6,"x-linode-filterable":true},"hosts":{"description":"The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.","properties":{"primary":{"description":"The primary host for the Managed Database.","example":"lin-0000-0000.servers.linodedb.net","nullable":true,"type":"string"},"secondary":{"description":"The secondary/private network host for the Managed Database.\n\nA private network host and a private IP can only be used to access a Database Cluster from Linodes in the same data center and will not incur transfer costs.\n\n**Note**: The secondary hostname is publicly viewable and accessible.\n","example":null,"nullable":true,"type":"string"}},"readOnly":true,"type":"object"},"id":{"$ref":"#/components/schemas/Database/properties/id","x-linode-cli-display":1},"label":{"$ref":"#/components/schemas/Database/properties/label","x-linode-cli-display":2},"peers":{"description":"An array of peer addresses for this Database.\n","example":["lin-0000-0000.servers.linodedb.net","lin-0000-0001.servers.linodedb.net","lin-0000-0002.servers.linodedb.net"],"items":{"description":"The peer address of a Managed MongoDB Database cluster node. Each node in a cluster has its own unique peer address.\n","type":"string"},"type":"array"},"port":{"description":"The access port for this Managed Database.","example":27017,"type":"integer","x-linode-cli-display":98},"region":{"$ref":"#/components/schemas/Database/properties/region","x-linode-cli-display":3},"replica_set":{"default":null,"description":"Label for configuring a MongoDB [replica set](https://www.mongodb.com/docs/manual/replication/). Choose the same label on multiple Databases to include them in the same replica set.\n\nIf `null`, the Database is not included in any replica set.\n","example":null,"maxLength":64,"nullable":true,"type":"string"},"ssl_connection":{"default":true,"description":"Whether to require SSL credentials to establish a connection to the Managed Database.\n\nUse the **Managed MongoDB Database Credentials View** ([GET /databases/mongodb/instances/{instanceId}/credentials](/docs/api/databases/#managed-mongodb-database-credentials-view)) command for access information.\n","example":true,"type":"boolean"},"status":{"$ref":"#/components/schemas/Database/properties/status","x-linode-cli-color":{"active":"green","default_":"white","degraded":"red","failed":"red","provisioning":"yellow","restoring":"yellow","resuming":"yellow"},"x-linode-cli-display":100},"storage_engine":{"default":"wiredtiger","description":"The type of storage engine for this Database.\n\n**Note:** MMAPV1 is not available for MongoDB versions 4.0 and above.\n","enum":["mmapv1","wiredtiger"],"example":"wiredtiger","type":"string"},"type":{"$ref":"#/components/schemas/Database/properties/type","x-linode-cli-display":4},"updated":{"$ref":"#/components/schemas/Database/properties/updated"},"updates":{"$ref":"#/components/schemas/Database/properties/updates"},"version":{"description":"The Managed Database engine version.","example":"4.4.10","readOnly":true,"type":"string","x-linode-cli-display":7,"x-linode-filterable":true}},"type":"object"},"DatabaseMongoDBRequest":{"description":"Managed MongoDB Database request object.","properties":{"allow_list":{"$ref":"#/components/schemas/Database/properties/allow_list"},"cluster_size":{"$ref":"#/components/schemas/DatabaseMongoDB/properties/cluster_size"},"compression_type":{"$ref":"#/components/schemas/DatabaseMongoDB/properties/compression_type"},"encrypted":{"$ref":"#/components/schemas/Database/properties/encrypted"},"engine":{"description":"The Managed Database engine in engine/version format.","example":"mongodb/4.4.10","type":"string"},"label":{"$ref":"#/components/schemas/DatabaseMongoDB/properties/label"},"region":{"$ref":"#/components/schemas/DatabaseMongoDB/properties/region"},"replica_set":{"$ref":"#/components/schemas/DatabaseMongoDB/properties/replica_set"},"ssl_connection":{"$ref":"#/components/schemas/DatabaseMongoDB/properties/ssl_connection"},"storage_engine":{"$ref":"#/components/schemas/DatabaseMongoDB/properties/storage_engine"},"type":{"$ref":"#/components/schemas/DatabaseMongoDB/properties/type"}},"required":["label","type","engine","region"],"type":"object"},"DatabaseMySQL":{"description":"Managed MySQL Databases object.","properties":{"allow_list":{"$ref":"#/components/schemas/Database/properties/allow_list"},"cluster_size":{"$ref":"#/components/schemas/Database/properties/cluster_size","x-linode-cli-display":5},"created":{"$ref":"#/components/schemas/Database/properties/created"},"encrypted":{"$ref":"#/components/schemas/Database/properties/encrypted"},"engine":{"description":"The Managed Database engine type.","example":"mysql","readOnly":true,"type":"string","x-linode-cli-display":6,"x-linode-filterable":true},"hosts":{"$ref":"#/components/schemas/Database/properties/hosts"},"id":{"$ref":"#/components/schemas/Database/properties/id","x-linode-cli-display":1},"label":{"$ref":"#/components/schemas/Database/properties/label","x-linode-cli-display":2},"port":{"description":"The access port for this Managed Database.","example":3306,"type":"integer","x-linode-cli-display":98},"region":{"$ref":"#/components/schemas/Database/properties/region","x-linode-cli-display":3},"replication_type":{"description":"The replication method used for the Managed Database.\n\nDefaults to `none` for a single cluster and `semi_synch` for a high availability cluster.\n\nMust be `none` for a single node cluster.\n\nMust be `asynch` or `semi_synch` for a high availability cluster.\n","enum":["none","asynch","semi_synch"],"example":"semi_synch","type":"string","x-linode-cli-display":99},"ssl_connection":{"default":true,"description":"Whether to require SSL credentials to establish a connection to the Managed Database.\n\nUse the **Managed MySQL Database Credentials View** ([GET /databases/mysql/instances/{instanceId}/credentials](/docs/api/databases/#managed-mysql-database-credentials-view)) command for access information.\n","example":true,"type":"boolean"},"status":{"$ref":"#/components/schemas/Database/properties/status","x-linode-cli-color":{"active":"green","default_":"white","degraded":"red","failed":"red","provisioning":"yellow","restoring":"yellow","resuming":"yellow"},"x-linode-cli-display":100},"type":{"$ref":"#/components/schemas/Database/properties/type","x-linode-cli-display":4},"updated":{"$ref":"#/components/schemas/Database/properties/updated"},"updates":{"$ref":"#/components/schemas/Database/properties/updates"},"version":{"description":"The Managed Database engine version.","example":"8.0.26","readOnly":true,"type":"string","x-linode-cli-display":7,"x-linode-filterable":true}},"type":"object"},"DatabaseMySQLRequest":{"description":"Managed MySQL Database request object.","properties":{"allow_list":{"$ref":"#/components/schemas/Database/properties/allow_list"},"cluster_size":{"$ref":"#/components/schemas/DatabaseMySQL/properties/cluster_size"},"encrypted":{"$ref":"#/components/schemas/Database/properties/encrypted"},"engine":{"description":"The Managed Database engine in engine/version format.","example":"mysql/8.0.26","type":"string"},"label":{"$ref":"#/components/schemas/DatabaseMySQL/properties/label"},"region":{"$ref":"#/components/schemas/DatabaseMySQL/properties/region"},"replication_type":{"$ref":"#/components/schemas/DatabaseMySQL/properties/replication_type"},"ssl_connection":{"$ref":"#/components/schemas/DatabaseMySQL/properties/ssl_connection"},"type":{"$ref":"#/components/schemas/DatabaseMySQL/properties/type"}},"required":["label","type","engine","region"],"type":"object"},"DatabasePostgreSQL":{"description":"Managed PostgreSQL Databases object.","properties":{"allow_list":{"$ref":"#/components/schemas/Database/properties/allow_list"},"cluster_size":{"$ref":"#/components/schemas/Database/properties/cluster_size","x-linode-cli-display":5},"created":{"$ref":"#/components/schemas/Database/properties/created"},"encrypted":{"$ref":"#/components/schemas/Database/properties/encrypted"},"engine":{"description":"The Managed Database engine type.","example":"postgresql","readOnly":true,"type":"string","x-linode-cli-display":6,"x-linode-filterable":true},"hosts":{"description":"The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.","properties":{"primary":{"description":"The primary host for the Managed Database.","example":"lin-0000-000-pgsql-primary.servers.linodedb.net","nullable":true,"type":"string"},"secondary":{"description":"The secondary/private network host for the Managed Database.\n\nA private network host and a private IP can only be used to access a Database Cluster from Linodes in the same data center and will not incur transfer costs.\n\n**Note**: The secondary hostname is publicly viewable and accessible.\n","example":"lin-0000-000-pgsql-primary-private.servers.linodedb.net","nullable":true,"type":"string"}},"readOnly":true,"type":"object"},"id":{"$ref":"#/components/schemas/Database/properties/id","x-linode-cli-display":1},"label":{"$ref":"#/components/schemas/Database/properties/label","x-linode-cli-display":2},"port":{"description":"The access port for this Managed Database.","example":3306,"type":"integer","x-linode-cli-display":98},"region":{"$ref":"#/components/schemas/Database/properties/region","x-linode-cli-display":3},"replication_commit_type":{"default":"local","description":"The synchronization level of the replicating server.\n\nMust be `local` or `off` for the `asynch` replication type.\n\nMust be `on`, `remote_write`, or `remote_apply` for the `semi_synch` replication type.\n","enum":["on","local","remote_write","remote_apply","off"],"example":"local","type":"string","x-linode-cli-display":100},"replication_type":{"description":"The replication method used for the Managed Database.\n\nDefaults to `none` for a single cluster and `semi_synch` for a high availability cluster.\n\nMust be `none` for a single node cluster.\n\nMust be `asynch` or `semi_synch` for a high availability cluster.\n","enum":["none","asynch","semi_synch"],"example":"semi_synch","type":"string","x-linode-cli-display":99},"ssl_connection":{"default":true,"description":"Whether to require SSL credentials to establish a connection to the Managed Database.\n\nUse the **Managed PostgreSQL Database Credentials View** ([GET /databases/postgresql/instances/{instanceId}/credentials](/docs/api/databases/#managed-postgresql-database-credentials-view)) command for access information.\n","example":true,"type":"boolean"},"status":{"$ref":"#/components/schemas/Database/properties/status","x-linode-cli-color":{"active":"green","default_":"white","degraded":"red","failed":"red","provisioning":"yellow","restoring":"yellow","resuming":"yellow"},"x-linode-cli-display":100},"type":{"$ref":"#/components/schemas/Database/properties/type","x-linode-cli-display":4},"updated":{"$ref":"#/components/schemas/Database/properties/updated"},"updates":{"$ref":"#/components/schemas/Database/properties/updates"},"version":{"description":"The Managed Database engine version.","example":"13.2","readOnly":true,"type":"string","x-linode-cli-display":7,"x-linode-filterable":true}},"type":"object"},"DatabasePostgreSQLRequest":{"description":"Managed PostgreSQL Database request object.","properties":{"allow_list":{"$ref":"#/components/schemas/Database/properties/allow_list"},"cluster_size":{"$ref":"#/components/schemas/DatabasePostgreSQL/properties/cluster_size"},"encrypted":{"$ref":"#/components/schemas/Database/properties/encrypted"},"engine":{"description":"The Managed Database engine in engine/version format.","example":"postgresql/13.2","type":"string"},"label":{"$ref":"#/components/schemas/DatabasePostgreSQL/properties/label"},"region":{"$ref":"#/components/schemas/DatabasePostgreSQL/properties/region"},"replication_commit_type":{"$ref":"#/components/schemas/DatabasePostgreSQL/properties/replication_commit_type"},"replication_type":{"$ref":"#/components/schemas/DatabasePostgreSQL/properties/replication_type"},"ssl_connection":{"$ref":"#/components/schemas/DatabasePostgreSQL/properties/ssl_connection"},"type":{"$ref":"#/components/schemas/DatabasePostgreSQL/properties/type"}},"required":["label","type","engine","region"],"type":"object"},"DatabaseSSL":{"description":"Managed Database SSL object.","properties":{"ca_certificate":{"description":"The base64-encoded SSL CA certificate for the Managed Database instance.","example":"LS0tLS1CRUdJ...==","format":"base64","type":"string","x-linode-cli-display":1}},"type":"object"},"DatabaseType":{"description":"Managed Database plan type object.","properties":{"class":{"description":"The compute class category.","example":"nanode","type":"string"},"deprecated":{"description":"Whether this Database plan type has been deprecated and is no longer available.","example":false,"type":"boolean","x-linode-cli-display":6,"x-linode-filterable":true},"disk":{"description":"The amount of disk space set aside for Databases of this plan type. The value is represented in megabytes.","example":25600,"type":"integer","x-linode-cli-display":4},"engines":{"properties":{"mongodb":{"description":"Pricing details for MongoDB Managed Databases.","items":{"$ref":"#/components/schemas/DatabaseTypeEngine"},"type":"array"},"mysql":{"description":"Pricing details for MySQL Managed Databases.","items":{"$ref":"#/components/schemas/DatabaseTypeEngine"},"type":"array"},"postgresql":{"description":"Pricing details for PostgreSQL Managed Databases.","items":{"$ref":"#/components/schemas/DatabaseTypeEngine"},"type":"array"}},"type":"object"},"id":{"description":"The ID representing the Managed Database node plan type.","example":"g6-nanode-1","readOnly":true,"type":"string","x-linode-cli-display":1},"label":{"description":"A human-readable string that describes each plan type. For display purposes only.","example":"DBaaS - Nanode 1GB","readOnly":true,"type":"string","x-linode-cli-display":2},"memory":{"description":"The amount of RAM allocated to Database created of this plan type. The value is represented in megabytes.","example":1024,"type":"integer","x-linode-cli-display":3},"vcpus":{"description":"The integer of number CPUs allocated to databases of this plan type.","example":1,"type":"integer","x-linode-cli-display":5}},"type":"object"},"DatabaseTypeEngine":{"properties":{"price":{"description":"Cost in US dollars, broken down into hourly and monthly charges.","properties":{"hourly":{"description":"Cost (in US dollars) per hour for this subscription tier.","example":0.03,"type":"number"},"monthly":{"description":"Maximum cost (in US dollars) per month for this subscription tier.","example":20,"type":"number"}},"type":"object"},"quantity":{"description":"The number of nodes for the Managed Database cluster for this subscription tier.","enum":[1,2,3],"example":1,"type":"integer"}},"type":"object"},"Device":{"description":"Device can be either a Disk or Volume identified by `disk_id` or `volume_id`. Only one type per slot allowed. Can be null.\nDevices mapped from _sde_ through _sdh_ are unavailable in `fullvirt` virt_mode.\n","properties":{"disk_id":{"description":"The Disk ID, or `null` if a Volume is assigned to this slot.","example":124458,"type":"integer"},"volume_id":{"description":"The Volume ID, or `null` if a Disk is assigned to this slot.","example":null,"type":"integer"}},"type":"object"},"Devices":{"description":"A dictionary of device disks to use as a device map in a Linode's configuration profile.\n* An empty device disk dictionary or a dictionary with empty values for device slots is allowed.\n* If no devices are specified, booting from this configuration will hold until a device exists that allows the boot process to start.\n","properties":{"sda":{"$ref":"#/components/schemas/Device"},"sdb":{"$ref":"#/components/schemas/Device"},"sdc":{"$ref":"#/components/schemas/Device"},"sdd":{"$ref":"#/components/schemas/Device"},"sde":{"$ref":"#/components/schemas/Device"},"sdf":{"$ref":"#/components/schemas/Device"},"sdg":{"$ref":"#/components/schemas/Device"},"sdh":{"$ref":"#/components/schemas/Device"}},"type":"object"},"Disk":{"properties":{"created":{"description":"When this Disk was created.","example":"2025-08-15T13:51:51.401Z","format":"date-time","readOnly":true,"type":"string"},"filesystem":{"description":"The Disk filesystem can be one of:\n\n * raw - No filesystem, just a raw binary stream.\n * swap - Linux swap area.\n * ext3 - The ext3 journaling filesystem for Linux.\n * ext4 - The ext4 journaling filesystem for Linux.\n * initrd - initrd (uncompressed initrd, ext2, max 32 MB).\n","enum":["raw","swap","ext3","ext4","initrd"],"example":"ext4","type":"string","x-linode-cli-display":5},"id":{"description":"This Disk's ID which must be provided for all operations impacting this Disk.\n","example":25674,"readOnly":true,"type":"integer","x-linode-cli-display":1},"label":{"description":"The Disk's label is for display purposes only.\n","example":"Debian 9 Disk","maxLength":48,"minLength":1,"type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"size":{"description":"The size of the Disk in MB.","example":48640,"type":"integer","x-linode-cli-display":4,"x-linode-filterable":true},"status":{"description":"A brief description of this Disk's current state. This field may change without direct action from you, as a result of operations performed to the Disk or the Linode containing the Disk.\n","enum":["ready","not ready","deleting"],"example":"ready","readOnly":true,"type":"string","x-linode-cli-color":{"default_":"yellow","not ready":"red","ready":"green"},"x-linode-cli-display":3},"updated":{"description":"When this Disk was last updated.","example":"2025-08-15T13:51:51.401Z","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"DiskRequest":{"description":"Disk object request.","properties":{"authorized_keys":{"description":"A list of public SSH keys that will be automatically appended\nto the root user's `~/.ssh/authorized_keys` file when deploying from an Image.\n","example":["ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer"],"items":{"type":"string"},"type":"array","writeOnly":true},"authorized_users":{"description":"A list of usernames. If the usernames have associated SSH keys, the keys will be appended to the root users `~/.ssh/authorized_keys` file automatically when deploying from an Image.\n","example":["myUser","secondaryUser"],"items":{"type":"string"},"type":"array","writeOnly":true},"filesystem":{"$ref":"#/components/schemas/Disk/properties/filesystem"},"image":{"description":"An Image ID to deploy the Linode Disk from.\n\nAccess the Images List ([GET /images](/docs/api/images/#images-list)) endpoint with authentication to view\nall available Images. Official Linode Images start with `linode/`, while your Account's Images start with `private/`. Creating\na disk from a Private Image requires `read_only` or `read_write` permissions for that Image. Access the User's\nGrant Update ([PUT /account/users/{username}/grants](/docs/api/account/#users-grants-update)) endpoint to\nadjust permissions for an Account Image.\n","example":"linode/debian9","type":"string"},"label":{"$ref":"#/components/schemas/Disk/properties/label"},"root_pass":{"description":"This sets the root user's password on a newly-created Linode Disk when deploying from an Image.\n\n* **Required** when creating a Linode Disk from an Image, including when using a StackScript.\n\n* Must meet a password strength score requirement that is calculated internally by the API.\nIf the strength requirement is not met, you will receive a `Password does not meet strength requirement` error.\n","example":"aComplexP@ssword","format":"password","maxLength":128,"minLength":7,"type":"string","writeOnly":true},"size":{"description":"The size of the Disk in MB.\n\nImages require a minimum size. Access the Image View ([GET /images/{imageID}](/docs/api/images/#image-view)) endpoint to view its size.\n","example":48640,"type":"integer","x-linode-filterable":true},"stackscript_data":{"description":"This field is required only if the StackScript being deployed requires input data from the User for successful completion. See [User Defined Fields (UDFs)](/docs/guides/writing-scripts-for-use-with-linode-stackscripts-a-tutorial/#user-defined-fields-udfs) for more details.\n\nThis field is required to be valid JSON.\n\nTotal length cannot exceed 65,535 characters.\n","example":{"gh_username":"linode"},"maxLength":65535,"type":"object"},"stackscript_id":{"description":"A StackScript ID that will cause the referenced StackScript to be run during\ndeployment of this Linode. A compatible `image` is required to use a\nStackScript. To get a list of available StackScript and their permitted Images\nsee [/stackscripts](/docs/api/stackscripts/#stackscripts-list).\nThis field cannot be used when deploying from a Backup or a Private Image.\n","example":10079,"type":"integer"}},"type":"object"},"Domain":{"description":"A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.\n","properties":{"axfr_ips":{"description":"The list of IPs that may perform a zone transfer for this Domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n**Note**: This is potentially dangerous, and should be set to an empty list unless you intend to use it.\n","example":[],"items":{"format":"ip","type":"string"},"type":"array"},"description":{"description":"A description for this Domain. This is for display purposes only.\n","example":null,"maxLength":253,"minLength":1,"type":"string"},"domain":{"description":"The domain this Domain represents. Domain labels cannot be longer than 63 characters and must conform to [RFC1035](https://tools.ietf.org/html/rfc1035). Domains must be unique on Linode's platform, including across different Linode accounts; there cannot be two Domains representing the same domain.\n","example":"example.org","maxLength":253,"minLength":1,"pattern":"\\A(\\*\\.)?([a-zA-Z0-9-_]{1,63}\\.)+([a-zA-Z]{2,3}\\.)?([a-zA-Z]{2,16}|xn--[a-zA-Z0-9]+)\\Z","type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"expire_sec":{"default":0,"description":"The amount of time in seconds that may pass before this Domain is no longer\nauthoritative.\n\n* Valid values are\n0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.\n\n* Any other value is rounded up to the nearest valid value.\n\n* A value of 0 is equivalent to the default value of 1209600.\n","example":300,"type":"integer"},"group":{"deprecated":true,"description":"The group this Domain belongs to. This is for display purposes only.\n","example":null,"maxLength":50,"minLength":1,"type":"string","x-linode-filterable":true},"id":{"description":"This Domain's unique ID","example":1234,"readOnly":true,"type":"integer","x-linode-cli-display":1},"master_ips":{"description":"The IP addresses representing the master DNS for this Domain. At least one value is required for `type` slave Domains. The total combined length of all data within this array cannot exceed 1000 characters.\n","example":[],"items":{"format":"ip","type":"string"},"type":"array"},"refresh_sec":{"default":0,"description":"The amount of time in seconds before this Domain should be refreshed.\n\n* Valid values are\n0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.\n\n* Any other value is rounded up to the nearest valid value.\n\n* A value of 0 is equivalent to the default value of 14400.\n","example":300,"type":"integer"},"retry_sec":{"default":0,"description":"The interval, in seconds, at which a failed refresh should be retried.\n\n* Valid values are\n0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.\n\n* Any other value is rounded up to the nearest valid value.\n\n* A value of 0 is equivalent to the default value of 14400.\n","example":300,"type":"integer"},"soa_email":{"description":"Start of Authority email address. This is required for `type` master Domains.\n","example":"admin@example.org","format":"email","type":"string","x-linode-cli-display":5},"status":{"default":"active","description":"Used to control whether this Domain is currently being rendered.\n","enum":["disabled","active"],"example":"active","type":"string","x-linode-cli-color":{"active":"green","default_":"red","disabled":"yellow","edit_mode":"yellow"},"x-linode-cli-display":4},"tags":{"description":"An array of tags applied to this object. Tags are for organizational purposes only.\n","example":["example tag","another example"],"items":{"type":"string"},"type":"array","x-linode-filterable":true},"ttl_sec":{"default":0,"description":"\"Time to Live\" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.\n* Valid values are 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.\n* Any other value is rounded up to the nearest valid value.\n* A value of 0 is equivalent to the default value of 86400.\n","example":300,"type":"integer"},"type":{"description":"Whether this Domain represents the authoritative source of information for the domain it describes (\"master\"), or whether it is a read-only copy of a master (\"slave\").\n","enum":["master","slave"],"example":"master","type":"string","x-linode-cli-display":3}},"type":"object"},"DomainRecord":{"description":"A single record on a Domain.\n","properties":{"created":{"description":"When this Domain Record was created.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"This Record's unique ID.","example":123456,"readOnly":true,"type":"integer","x-linode-cli-display":1},"name":{"description":"The name of this Record. For requests, this property's actual usage and whether it is required depends\non the type of record this represents:\n\n`A` and `AAAA`: The hostname or FQDN of the Record.\n\n`NS`: The subdomain, if any, to use with the Domain of the Record. Wildcard NS records (`*`) are not supported.\n\n`MX`: The mail subdomain. For example, `sub` for the address `user@sub.example.com` under the `example.com`\nDomain. Must be an empty string (`\"\"`) for a Null MX Record.\n\n`CNAME`: The hostname. Must be unique. Required.\n\n`TXT`: The hostname.\n\n`SRV`: Unused. Use the `service` property to set the service name for this record.\n\n`CAA`: The subdomain. Omit or enter an empty string (`\"\"`) to apply to the entire Domain.\n\n`PTR`: See our guide on how to [Configure Your Linode for Reverse DNS\n(rDNS)](/docs/guides/configure-rdns/).\n","example":"test","maxLength":100,"minLength":1,"type":"string","x-linode-cli-display":3,"x-linode-filterable":true},"port":{"description":"The port this Record points to. Only valid and required for SRV record requests.\n","example":80,"maximum":65535,"minimum":0,"type":"integer"},"priority":{"description":"The priority of the target host for this Record. Lower values are preferred. Only valid for\nMX and SRV record requests. Required for SRV record requests.\n\nDefaults to `0` for MX record requests. Must be `0` for Null MX records.\n","example":50,"maximum":255,"minimum":0,"type":"integer","x-linode-cli-display":6},"protocol":{"description":"The protocol this Record's service communicates with. An underscore (`_`) is prepended automatically to the submitted value for this property. Only valid for SRV record requests.\n","example":null,"nullable":true,"type":"string"},"service":{"description":"The name of the service. An underscore (`_`) is prepended and a period (`.`) is appended automatically to the submitted value for this property. Only valid and required for SRV record requests.\n","example":null,"nullable":true,"type":"string"},"tag":{"description":"The tag portion of a CAA record. Only valid and required for CAA record requests.\n","enum":["issue","issuewild","iodef"],"example":null,"nullable":true,"type":"string","x-linode-filterable":true},"target":{"description":"The target for this Record. For requests, this property's actual usage and whether it is required depends\non the type of record this represents:\n\n`A` and `AAAA`: The IP address. Use `[remote_addr]` to submit the IPv4 address of the request. Required.\n\n`NS`: The name server. Must be a valid domain. Required.\n\n`MX`: The mail server. Must be a valid domain unless creating a Null MX Record. To create a\n[Null MX Record](https://datatracker.ietf.org/doc/html/rfc7505), first\n[remove](/docs/api/domains/#domain-record-delete) any additional MX records, create an MX record with empty strings\n(`\"\"`) for the `target` and `name`. If a Domain has a Null MX record, new MX records cannot be created. Required.\n\n`CNAME`: The alias. Must be a valid domain. Required.\n\n`TXT`: The value. Required.\n\n`SRV`: The target domain or subdomain. If a subdomain is entered, it is automatically used with the Domain.\nTo configure for a different domain, enter a valid FQDN. For example, the value `www` with a Domain for\n`example.com` results in a target set to `www.example.com`, whereas the value `sample.com` results in a\ntarget set to `sample.com`. Required.\n\n`CAA`: The value. For `issue` or `issuewild` tags, the domain of your certificate issuer. For the `iodef`\ntag, a contact or submission URL (domain, http, https, or mailto). Requirements depend on the tag for this record:\n * `issue`: The domain of your certificate issuer. Must be a valid domain.\n * `issuewild`: The domain of your wildcard certificate issuer. Must be a valid domain and must not start with an asterisk (`*`).\n * `iodef`: Must be either (1) a valid domain, (2) a valid domain prepended with `http://` or `https://`, or (3) a valid email address prepended with `mailto:`.\n\n`PTR`: Required. See our guide on how to [Configure Your Linode for Reverse DNS\n(rDNS)](/docs/guides/configure-rdns/).\n\nWith the exception of A, AAAA, and CAA records, this field accepts a trailing period.\n","example":"192.0.2.0","maxLength":65535,"type":"string","x-linode-cli-display":4,"x-linode-filterable":true},"ttl_sec":{"description":"\"Time to Live\" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.\n","example":604800,"type":"integer","x-linode-cli-display":5},"type":{"description":"The type of Record this is in the DNS system. For example, A records associate a domain name with an IPv4 address, and AAAA records associate a domain name with an IPv6 address. For more information, see the guides on [DNS Record Types](/docs/products/networking/dns-manager/guides/#dns-record-types).\n","enum":["A","AAAA","NS","MX","CNAME","TXT","SRV","PTR","CAA"],"example":"A","type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"updated":{"description":"When this Domain Record was last updated.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string"},"weight":{"description":"The relative weight of this Record used in the case of identical priority. Higher values are preferred. Only valid and required for SRV record requests.\n","example":50,"maximum":65535,"minimum":0,"type":"integer","x-linode-cli-display":7}},"type":"object"},"EntityTransfer":{"description":"An object representing an Entity Transfer.\n","properties":{"created":{"description":"When this transfer was created.\n","example":"2025-08-15T13:51:51.402Z","format":"date-time","type":"string"},"entities":{"description":"A collection of the entities to include in this transfer request, separated by type.\n","properties":{"linodes":{"description":"An array containing the IDs of each of the Linodes included in this transfer.\n","example":[111,222],"items":{"type":"integer"},"type":"array","x-linode-cli-display":5}},"type":"object"},"expiry":{"description":"When this transfer expires. Transfers will automatically expire 24 hours after creation.\n","example":"2025-08-15T13:51:51.402Z","format":"date-time","type":"string","x-linode-cli-display":3},"is_sender":{"description":"If the requesting account created this transfer.\n","example":true,"type":"boolean","x-linode-cli-display":4,"x-linode-filterable":true},"status":{"description":"The status of the transfer request.\n\n`accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.\n\n`cancelled`: The transfer has been cancelled by the sender.\n\n`completed`: The transfer has completed successfully.\n\n`failed`: The transfer has failed after initiation.\n\n`pending`: The transfer is ready to be accepted.\n\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or cancelled.\n","enum":["accepted","cancelled","completed","failed","pending","stale"],"example":"pending","type":"string","x-linode-cli-color":{"accepted":"yellow","cancelled":"red","completed":"green","default_":"white","failed":"red","pending":"yellow","stale":"red"},"x-linode-cli-display":2,"x-linode-filterable":true},"token":{"description":"The token used to identify and accept or cancel this transfer.\n","example":"123E4567-E89B-12D3-A456-426614174000","format":"uuid","type":"string","x-linode-cli-display":1},"updated":{"description":"When this transfer was last updated.\n","example":"2025-08-15T13:51:51.402Z","format":"date-time","type":"string"}},"type":"object"},"ErrorObject":{"description":"An object for describing a single error that occurred during the processing of a request.\n","properties":{"field":{"description":"The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as \"null\" if the error is not specific to any single element of the request.\n","example":"fieldname","type":"string"},"reason":{"description":"What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [open a Support Ticket](/docs/api/support/#support-ticket-open) or perform some other action before you can complete the request successfully.\n","example":"fieldname must be a valid value","type":"string"}},"type":"object"},"Event":{"description":"A collection of Event objects. An Event is an action taken against an entity related to your Account. For example, booting a Linode would create an Event.\nThe Events returned depends on your grants.\n","properties":{"action":{"description":"The action that caused this Event. New actions may be added in the future.\n","enum":["account_update","account_settings_update","backups_enable","backups_cancel","backups_restore","community_question_reply","community_like","credit_card_updated","disk_create","disk_delete","disk_update","disk_duplicate","disk_imagize","disk_resize","dns_record_create","dns_record_delete","dns_record_update","dns_zone_create","dns_zone_delete","dns_zone_import","dns_zone_update","entity_transfer_accept","entity_transfer_cancel","entity_transfer_create","entity_transfer_fail","entity_transfer_stale","firewall_create","firewall_delete","firewall_disable","firewall_enable","firewall_update","firewall_device_add","firewall_device_remove","host_reboot","image_delete","image_update","image_upload","ipaddress_update","lassie_reboot","lish_boot","linode_addip","linode_boot","linode_clone","linode_create","linode_delete","linode_update","linode_deleteip","linode_migrate","linode_migrate_datacenter","linode_migrate_datacenter_create","linode_mutate","linode_mutate_create","linode_reboot","linode_rebuild","linode_resize","linode_resize_create","linode_shutdown","linode_snapshot","linode_config_create","linode_config_delete","linode_config_update","lke_node_create","longviewclient_create","longviewclient_delete","longviewclient_update","managed_disabled","managed_enabled","managed_service_create","managed_service_delete","nodebalancer_create","nodebalancer_delete","nodebalancer_update","nodebalancer_config_create","nodebalancer_config_delete","nodebalancer_config_update","nodebalancer_node_create","nodebalancer_node_delete","nodebalancer_node_update","oauth_client_create","oauth_client_delete","oauth_client_secret_reset","oauth_client_update","password_reset","payment_method_add","payment_submitted","profile_update","stackscript_create","stackscript_delete","stackscript_update","stackscript_publicize","stackscript_revise","tag_create","tag_delete","tfa_disabled","tfa_enabled","ticket_attachment_upload","ticket_create","ticket_update","token_create","token_delete","token_update","user_create","user_update","user_delete","user_ssh_key_add","user_ssh_key_delete","user_ssh_key_update","vlan_attach","vlan_detach","volume_attach","volume_clone","volume_create","volume_delete","volume_update","volume_detach","volume_resize"],"example":"ticket_create","readOnly":true,"type":"string","x-linode-cli-display":3,"x-linode-filterable":true},"created":{"description":"When this Event was created.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":6,"x-linode-filterable":true},"duration":{"description":"The total duration in seconds that it takes for the Event to complete.\n","example":300.56,"readOnly":true,"type":"number","x-linode-cli-display":7},"entity":{"description":"Detailed information about the Event's entity, including ID, type, label, and URL used to access it.\n","properties":{"id":{"description":"The unique ID for an Event's entity.\n\n\nSome Event entities do not have IDs associated with them, so they\nwill not be returned when filtering by ID. These Events include:\n * `account`\n * `profile`\n\nEntities for some Events are assigned the ID of the Linode they correspond to.\nWhen filtering by ID for these Events, use the corresponding Linode's ID.\nThese Events include:\n * `disks`\n * `backups`\n\n\nTag Events use a tag's name for the entity ID field. When filtering by ID\nfor tag Events, supply the name of the tag.\n","example":11111,"type":"integer","x-linode-filterable":true},"label":{"description":"The current label of this object. The label may reflect changes that occur with this Event.\n","example":"Problem booting my Linode","type":"string","x-linode-cli-display":5},"type":{"description":"The type of entity that is being referenced by the Event.\n","enum":["account","backups","community","disks","domain","entity_transfer","firewall","image","ipaddress","linode","longview","managed_service","nodebalancer","oauth_client","profile","stackscript","tag","ticket","token","user","user_ssh_key","volume"],"example":"ticket","readOnly":true,"type":"string","x-linode-filterable":true},"url":{"description":"The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.\n","example":"/v4/support/tickets/11111","type":"string"}},"readOnly":true,"type":"object"},"id":{"description":"The unique ID of this Event.","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":1,"x-linode-filterable":true},"message":{"description":"Provides additional information about the event. Additional information may include, but is not limited to, a more detailed representation of events which can help diagnose non-obvious failures.\n","example":"None","nullable":true,"type":"string","x-linode-cli-display":9},"percent_complete":{"description":"A percentage estimating the amount of time remaining for an Event.\nReturns `null` for notification events.\n","example":null,"readOnly":true,"type":"integer"},"rate":{"description":"The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events.\n","example":null,"readOnly":true,"type":"string"},"read":{"description":"If this Event has been read.","example":true,"readOnly":true,"type":"boolean"},"secondary_entity":{"description":"Detailed information about the Event's secondary entity, which provides additional information\nfor events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions.\n","properties":{"id":{"description":"The ID of the object that is the secondary entity.\n","example":"linode/debian9","type":"string"},"label":{"description":"The label of this object.\n","example":"linode1234","type":"string"},"type":{"description":"The type of entity that is being referenced by the Event.\n","example":"linode","readOnly":true,"type":"string"},"url":{"description":"The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.\n","example":"/v4/linode/instances/1234","type":"string"}},"readOnly":true,"type":"object"},"seen":{"description":"If this Event has been seen.","example":true,"readOnly":true,"type":"boolean"},"status":{"description":"The current status of this Event.","enum":["failed","finished","notification","scheduled","started"],"readOnly":true,"type":"string","x-linode-cli-color":{"default_":"white","failed":"red","finished":"green","started":"yellow"},"x-linode-cli-display":8},"time_remaining":{"description":"The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done.\n","example":null,"nullable":true,"readOnly":true,"type":"string"},"username":{"description":"The username of the User who caused the Event.\n","example":"exampleUser","nullable":true,"readOnly":true,"type":"string","x-linode-cli-display":2}},"type":"object"},"Firewall":{"description":"A resource that controls incoming and outgoing network traffic to a Linode service. Only one Firewall can be attached to a Linode at any given time. [Create a Firewall Device](/docs/api/networking/#firewall-create) to assign a Firewall to a Linode service. Currently, Firewalls can only be assigned to Linode instances.\n","properties":{"created":{"description":"When this Firewall was created.\n","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":4,"x-linode-filterable":true},"id":{"description":"The Firewall's unique ID.\n","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":1,"x-linode-filterable":true},"label":{"description":"The Firewall's label, for display purposes only.\n\nFirewall labels have the following constraints:\n\n * Must begin and end with an alphanumeric character.\n * May only consist of alphanumeric characters, dashes (`-`), underscores (`_`) or periods (`.`).\n * Cannot have two dashes (`--`), underscores (`__`) or periods (`..`) in a row.\n * Must be between 3 and 32 characters.\n * Must be unique.\n","example":"firewall123","maxLength":32,"minLength":3,"pattern":"^[a-zA-Z]((?!--|__|..)[a-zA-Z0-9-_.])+$","type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"rules":{"description":"The inbound and outbound access rules to apply to the Firewall.\n\nA Firewall may have up to 25 rules across its inbound and outbound rulesets.\n","properties":{"inbound":{"description":"The inbound rules for the firewall, as a JSON array.\n","items":{"$ref":"#/components/schemas/FirewallRuleConfig"},"type":"array","x-linode-cli-format":"json"},"inbound_policy":{"description":"The default behavior for inbound traffic. This setting can be overridden by [updating](/docs/api/networking/#firewall-rules-update) the `inbound.action` property of the Firewall Rule.\n","enum":["ACCEPT","DROP"],"example":"DROP","type":"string"},"outbound":{"description":"The outbound rules for the firewall, as a JSON array.\n","items":{"$ref":"#/components/schemas/FirewallRuleConfig"},"type":"array","x-linode-cli-format":"json"},"outbound_policy":{"description":"The default behavior for outbound traffic. This setting can be overridden by [updating](/docs/api/networking/#firewall-rules-update) the `outbound.action` property of the Firewall Rule.\n","enum":["ACCEPT","DROP"],"example":"DROP","type":"string"}},"type":"object"},"status":{"description":"The status of this Firewall.\n\n * When a Firewall is first created its status is `enabled`.\n * Use the [Update Firewall](/docs/api/networking/#firewall-update) endpoint to set a Firewall's status to `enabled` or `disabled`.\n * Use the [Delete Firewall](/docs/api/networking/#firewall-delete) endpoint to delete a Firewall.\n","enum":["enabled","disabled","deleted"],"example":"enabled","readOnly":true,"type":"string","x-linode-cli-display":3},"tags":{"description":"An array of tags applied to this object. Tags are for organizational purposes only.\n","example":["example tag","another example"],"items":{"type":"string"},"type":"array","x-linode-filterable":true},"updated":{"description":"When this Firewall was last updated.\n","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":5,"x-linode-filterable":true}},"type":"object"},"FirewallDevices":{"description":"Associates a Firewall with a Linode service. A Firewall can be assigned to a single Linode service at a time. Additional disabled Firewalls can be assigned to a service, but they cannot be enabled if another active Firewall is already assigned to the same service.\n","properties":{"created":{"description":"When this Device was created.\n","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":3,"x-linode-filterable":true},"entity":{"description":"The Linode service that this Firewall has been applied to.\n","properties":{"id":{"description":"The entity's ID","example":123,"type":"integer"},"label":{"description":"The entity's label.","example":"my-linode","readOnly":true,"type":"string"},"type":{"description":"The entity's type.","enum":["linode"],"example":"linode","type":"string"},"url":{"description":"The URL you can use to access this entity.\n","example":"/v4/linode/instances/123","format":"url","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"id":{"description":"The Device's unique ID\n","example":123,"type":"integer","x-linode-cli-display":2,"x-linode-filterable":true},"updated":{"description":"When this Device was last updated.\n","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":4,"x-linode-filterable":true}},"type":"object"},"FirewallRuleConfig":{"description":"One of a Firewall's inbound or outbound access rules. The `ports` property can be used to allow traffic on a comma-separated list of different ports.\n","properties":{"action":{"description":"Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall's `inbound_policy` if this is an inbound rule, or the `outbound_policy` if this is an outbound rule.\n","enum":["ACCEPT","DROP"],"example":"ACCEPT","type":"string"},"addresses":{"description":"Allowed IPv4 or IPv6 addresses. A Rule can have up to 255 addresses or networks listed across its IPv4 and IPv6 arrays. A network and a single IP are treated as equivalent when accounting for this limit.\n","properties":{"ipv4":{"description":"A list of IPv4 addresses or networks. Must be in IP/mask format.","example":["192.0.2.0/24"],"items":{"type":"string"},"type":"array"},"ipv6":{"description":"A list of IPv6 addresses or networks. Must be in IP/mask format.","example":["2001:DB8::/32"],"items":{"type":"string"},"type":"array"}},"type":"object"},"description":{"description":"Used to describe this rule. For display purposes only.\n","example":"An example firewall rule description.","maxLength":100,"minLength":1,"type":"string"},"label":{"description":"Used to identify this rule. For display purposes only.\n","example":"firewallrule123","maxLength":32,"minLength":3,"type":"string"},"ports":{"description":"A string representing the port or ports on which traffic will be allowed:\n\n- The string may be a single port, a range of ports, or a comma-separated list of single ports and port ranges. A space is permitted following each comma.\n- A range of ports is inclusive of the start and end values for the range. The end value of the range must be greater than the start value.\n- Ports must be within 1 and 65535, and may not contain any leading zeroes. For example, port \"080\" is not allowed.\n- Ports may not be specified if a rule's protocol is `ICMP` or `IPENCAP`.\n- At least one port must be specified if a rule's protocol is `TCP` or `UDP`.\n- The ports string can have up to 15 *pieces*, where a single port is treated as one piece, and a port range is treated as two pieces. For example, the string \"22-24, 80, 443\" has four pieces.\n","example":"22-24, 80, 443","type":"string"},"protocol":{"description":"The type of network traffic to allow.\n","enum":["TCP","UDP","ICMP","IPENCAP"],"example":"TCP","type":"string"}},"type":"object"},"GooglePayData":{"description":"Google Pay information.","properties":{"card_type":{"description":"The type of credit card.","example":"Discover","readOnly":true,"type":"string"},"expiry":{"description":"The expiration month and year of the credit card.","example":"06/2022","format":"MM/YYYY","readOnly":true,"type":"string"},"last_four":{"description":"The last four digits of the credit card number.","example":"1234","readOnly":true,"type":"string"}},"type":"object"},"Grant":{"description":"Represents the level of access a restricted User has to a specific resource on the Account.\n","properties":{"id":{"description":"The ID of the entity this grant applies to.\n","example":123,"type":"integer"},"label":{"description":"The current label of the entity this grant applies to, for display purposes.\n","example":"example-entity","readOnly":true,"type":"string"},"permissions":{"description":"The level of access this User has to this entity. If null, this User has no access.\n","enum":["read_only","read_write"],"example":"read_only","nullable":true,"type":"string"}},"type":"object"},"GrantsResponse":{"description":"A structure representing all grants a restricted User has on the Account. Not available for unrestricted users, as they have access to everything without grants. If retrieved from the `/profile/grants` endpoint, entities to which a User has no access will be omitted.\n","properties":{"database":{"description":"The grants this User has for each Database that is owned by this Account.\n","items":{"$ref":"#/components/schemas/Grant"},"type":"array"},"domain":{"description":"The grants this User has for each Domain that is owned by this Account.\n","items":{"$ref":"#/components/schemas/Grant"},"type":"array"},"global":{"description":"A structure containing the Account-level grants a User has.\n","properties":{"account_access":{"description":"The level of access this User has to Account-level actions, like billing information. A restricted User will never be able to manage users.\n","enum":["read_only","read_write"],"example":"read_only","nullable":true,"type":"string"},"add_databases":{"description":"if true, this User may add Managed Databases.","example":true,"type":"boolean"},"add_domains":{"description":"If true, this User may add Domains.","example":true,"type":"boolean"},"add_firewalls":{"description":"If true, this User may add Firewalls.","example":true,"type":"boolean"},"add_images":{"description":"If true, this User may add Images.","example":true,"type":"boolean"},"add_linodes":{"description":"If true, this User may create Linodes.","example":true,"type":"boolean"},"add_longview":{"description":"If true, this User may create Longview clients and view the current plan.","example":true,"type":"boolean"},"add_nodebalancers":{"description":"If true, this User may add NodeBalancers.","example":true,"type":"boolean"},"add_stackscripts":{"description":"If true, this User may add StackScripts.","example":true,"type":"boolean"},"add_volumes":{"description":"If true, this User may add Volumes.","example":true,"type":"boolean"},"cancel_account":{"description":"If true, this User may cancel the entire Account.","example":false,"type":"boolean"},"longview_subscription":{"description":"If true, this User may manage the Account's Longview subscription.","example":true,"type":"boolean"}},"type":"object"},"image":{"description":"The grants this User has for each Image that is owned by this Account.\n","items":{"$ref":"#/components/schemas/Grant"},"type":"array"},"linode":{"description":"The grants this User has for each Linode that is owned by this Account.\n","items":{"$ref":"#/components/schemas/Grant"},"type":"array"},"longview":{"description":"The grants this User has for each Longview Client that is owned by this Account.\n","items":{"$ref":"#/components/schemas/Grant"},"type":"array"},"nodebalancer":{"description":"The grants this User has for each NodeBalancer that is owned by this Account.\n","items":{"$ref":"#/components/schemas/Grant"},"type":"array"},"stackscript":{"description":"The grants this User has for each StackScript that is owned by this Account.\n","items":{"$ref":"#/components/schemas/Grant"},"type":"array"},"volume":{"description":"The grants this User has for each Block Storage Volume that is owned by this Account.\n","items":{"$ref":"#/components/schemas/Grant"},"type":"array"}},"type":"object"},"IPAddress":{"description":"An IP address that exists in Linode's system, either IPv4 or IPv6.\n","properties":{"address":{"description":"The IP address.\n","example":"97.107.143.141","format":"ip","readOnly":true,"type":"string","x-linode-cli-display":1},"gateway":{"description":"The default gateway for this address.\n","example":"97.107.143.1","format":"ip","nullable":true,"readOnly":true,"type":"string"},"linode_id":{"description":"The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses my be moved using the [/networking/ipv4/assign](/docs/api/networking/#ips-to-linodes-assign) endpoint. For SLAAC and link-local addresses, this value may not be changed.\n","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":6},"prefix":{"description":"The number of bits set in the subnet mask.\n","example":24,"readOnly":true,"type":"integer"},"public":{"description":"Whether this is a public or private IP address.\n","example":true,"readOnly":true,"type":"boolean","x-linode-cli-display":3},"rdns":{"description":"The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set.\n","example":"test.example.org","nullable":true,"type":"string","x-linode-cli-display":4},"region":{"description":"The Region this IP address resides in.\n","example":"us-east","readOnly":true,"type":"string","x-linode-cli-display":5,"x-linode-filterable":true},"subnet_mask":{"description":"The mask that separates host bits from network bits for this address.\n","example":"255.255.255.0","format":"ip","readOnly":true,"type":"string"},"type":{"description":"The type of address this is.\n","enum":["ipv4","ipv6","ipv6/pool","ipv6/range"],"example":"ipv4","readOnly":true,"type":"string","x-linode-cli-display":2}},"type":"object"},"IPAddressPrivate":{"description":"A private IPv4 address that exists in Linode's system.\n","properties":{"address":{"description":"The private IPv4 address.\n","example":"192.168.133.234","format":"ip","readOnly":true,"type":"string","x-linode-cli-display":1},"gateway":{"description":"The default gateway for this address.\n","example":null,"format":"ip","readOnly":true,"type":"string"},"linode_id":{"description":"The ID of the Linode this address currently belongs to.\n","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":6},"prefix":{"description":"The number of bits set in the subnet mask.\n","example":17,"readOnly":true,"type":"integer"},"public":{"description":"Whether this is a public or private IP address.\n","example":false,"readOnly":true,"type":"boolean","x-linode-cli-display":3},"rdns":{"description":"The reverse DNS assigned to this address.\n","example":null,"type":"string","x-linode-cli-display":4},"region":{"description":"The Region this address resides in.\n","example":"us-east","readOnly":true,"type":"string","x-linode-cli-display":5,"x-linode-filterable":true},"subnet_mask":{"description":"The mask that separates host bits from network bits for this address.\n","example":"255.255.128.0","format":"ip","readOnly":true,"type":"string"},"type":{"description":"The type of address this is.\n","example":"ipv4","readOnly":true,"type":"string","x-linode-cli-display":2}},"type":"object"},"IPAddressV6LinkLocal":{"description":"A link-local IPv6 address that exists in Linode's system,.\n","properties":{"address":{"description":"The IPv6 link-local address.\n","example":"fe80::f03c:91ff:fe24:3a2f","format":"ip","readOnly":true,"type":"string","x-linode-cli-display":1},"gateway":{"description":"The default gateway for this address.\n","example":"fe80::1","readOnly":true,"type":"string"},"linode_id":{"description":"The ID of the Linode this address currently belongs to.\n","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":6},"prefix":{"description":"The network prefix.\n","example":64,"readOnly":true,"type":"integer"},"public":{"description":"Whether this is a public or private IP address.\n","example":false,"readOnly":true,"type":"boolean","x-linode-cli-display":3},"rdns":{"description":"The reverse DNS assigned to this address.\n","example":null,"type":"string","x-linode-cli-display":4},"region":{"description":"The Region this address resides in.\n","example":"us-east","readOnly":true,"type":"string","x-linode-cli-display":5,"x-linode-filterable":true},"subnet_mask":{"description":"The subnet mask.\n","example":"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff","format":"ip","readOnly":true,"type":"string"},"type":{"description":"The type of address this is.\n","example":"ipv6","readOnly":true,"type":"string","x-linode-cli-display":2}},"type":"object"},"IPAddressV6Slaac":{"description":"A SLAAC IPv6 address that exists in Linode's system.\n","properties":{"address":{"description":"The address.\n","example":"2600:3c03::f03c:91ff:fe24:3a2f","format":"ip","readOnly":true,"type":"string","x-linode-cli-display":1},"gateway":{"description":"The default gateway for this address.\n","example":"fe80::1","readOnly":true,"type":"string"},"linode_id":{"description":"The ID of the Linode this address currently belongs to.\n","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":6},"prefix":{"description":"The network prefix.\n","example":64,"readOnly":true,"type":"integer"},"public":{"description":"Whether this is a public or private IP address.\n","example":true,"readOnly":true,"type":"boolean","x-linode-cli-display":3},"rdns":{"description":"The reverse DNS assigned to this address.\n","example":null,"type":"string","x-linode-cli-display":4},"region":{"description":"The Region this address resides in.\n","example":"us-east","readOnly":true,"type":"string","x-linode-cli-display":5,"x-linode-filterable":true},"subnet_mask":{"description":"The subnet mask.\n","example":"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff","format":"ip","readOnly":true,"type":"string"},"type":{"description":"The type of address this is.\n","example":"ipv6","readOnly":true,"type":"string","x-linode-cli-display":2}},"type":"object"},"IPAddressesAssignRequest":{"description":"Request object for IP Addresses Assign (POST /networking/ips/assign).","properties":{"assignments":{"description":"The list of assignments to make. You must have read_write access to all IPs being assigned and all Linodes being assigned to in order for the assignments to succeed.\n","items":{"properties":{"address":{"description":"The IPv4 address or IPv6 range for this assignment.\n* Must be an IPv4 address or an IPv6 range you can access in the Region specified.\n* IPv6 ranges must include a prefix length of `/56` or `/64`, for example: `2001:db8:3c4d:15::/64`.\n* Assignment of an IPv6 range to a Linode updates the route target of the range to the assigned Linode's SLAAC address.\n* May be a public or private address.\n","example":"192.0.2.1","format":"ipv4|ipv6/prefix_length","type":"string"},"linode_id":{"description":"The ID of the Linode to assign this address to. The IP's previous Linode will lose this address, and must end up with at least one public address and no more than one private address once all assignments have been made.\n","example":123,"type":"integer"}},"type":"object"},"required":["address","linode_id"],"type":"array"},"region":{"description":"The ID of the Region in which these assignments are to take place. All IPs and Linodes must exist in this Region.\n","example":"us-east","type":"string"}},"required":["region","assignments"],"type":"object"},"IPAddressesShareRequest":{"description":"A request object IP Addresses Share (POST /networking/ips/share)","properties":{"ips":{"description":"A list of secondary Linode IPs to share with the primary Linode.\n* Can include both IPv4 addresses and IPv6 ranges (omit /56 and /64 prefix lengths)\n* Can include both private and public IPv4 addresses.\n* You must have access to all of these addresses and they must be in the same Region as the primary Linode.\n* Enter an empty array to remove all shared IP addresses.\n","example":["192.0.2.1","2001:db8:3c4d:15::"],"items":{"format":"ip","type":"string"},"type":"array"},"linode_id":{"description":"The ID of the primary Linode that the addresses will be shared with.\n","example":123,"type":"integer"}},"required":["linode_id","ips"],"type":"object"},"IPv6Pool":{"description":"An object representing an IPv6 pool.\n","properties":{"prefix":{"description":"The prefix length of the address, denoting how many addresses can be assigned from this pool calculated as 2 128-prefix.\n","example":124,"type":"integer","x-linode-cli-display":2},"range":{"description":"The IPv6 range of addresses in this pool.\n","example":"2600:3c01::2:5000:0","readOnly":true,"type":"string","x-linode-cli-display":1},"region":{"description":"The region for this pool of IPv6 addresses.\n","example":"us-east","readOnly":true,"type":"string","x-linode-cli-display":3,"x-linode-filterable":true},"route_target":{"description":"The last address in this block of IPv6 addresses.\n","example":"2600:3c01::2:5000:f","nullable":true,"type":"string"}},"type":"object"},"IPv6Range":{"description":"An object representing an IPv6 range.\n","properties":{"prefix":{"description":"The prefix length of the address, denoting how many addresses can be assigned from this range calculated as 2 128-prefix.\n","example":64,"type":"integer","x-linode-cli-display":2},"range":{"description":"The IPv6 range of addresses in this pool.\n","example":"2600:3c01::","readOnly":true,"type":"string","x-linode-cli-display":1},"region":{"description":"The region for this range of IPv6 addresses.\n","example":"us-east","readOnly":true,"type":"string","x-linode-cli-display":3},"route_target":{"description":"The last address in this block of IPv6 addresses.\n","example":"2600:3c01::ffff:ffff:ffff:ffff","nullable":true,"type":"string"}},"type":"object"},"IPv6RangeBGP":{"description":"An object representing an IPv6 range.\n","properties":{"is_bgp":{"description":"Whether this IPv6 range is shared.\n","example":false,"readOnly":true,"type":"boolean"},"linodes":{"description":"A list of Linodes targeted by this IPv6 range. Includes Linodes with IP sharing.\n","example":[123],"items":{"type":"integer"},"readOnly":true,"type":"array","x-linode-cli-display":4},"prefix":{"description":"The prefix length of the address, denoting how many addresses can be assigned from this range calculated as 2 128-prefix.\n","example":64,"type":"integer","x-linode-cli-display":2},"range":{"description":"The IPv6 range of addresses in this pool.\n","example":"2600:3c01::","readOnly":true,"type":"string","x-linode-cli-display":1},"region":{"description":"The region for this range of IPv6 addresses.\n","example":"us-east","readOnly":true,"type":"string","x-linode-cli-display":3}},"type":"object"},"Image":{"description":"Image object","properties":{"created":{"description":"When this Image was created.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string"},"created_by":{"description":"The name of the User who created this Image, or \"linode\" for public Images.\n","example":"linode","readOnly":true,"type":"string"},"deprecated":{"description":"Whether or not this Image is deprecated. Will only be true for deprecated public Images.\n","example":false,"readOnly":true,"type":"boolean","x-linode-filterable":true},"description":{"description":"A detailed description of this Image.","example":"Example Image description.","maxLength":65000,"minLength":1,"nullable":true,"type":"string","x-linode-cli-color":{"None":"black","default_":"white"},"x-linode-cli-display":4},"eol":{"description":"The date of the public Image's planned end of life. `None` for private Images.\n","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string"},"expiry":{"description":"Only Images created automatically from a deleted Linode (type=automatic) will expire.\n","example":null,"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"id":{"description":"The unique ID of this Image.","example":"linode/debian11","readOnly":true,"type":"string","x-linode-cli-display":1},"is_public":{"description":"True if the Image is a public distribution image. False if Image is private Account-specific Image.","example":true,"readOnly":true,"type":"boolean","x-linode-cli-display":5,"x-linode-filterable":true},"label":{"description":"A short description of the Image.\n","example":"Debian 11","type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"size":{"description":"The minimum size this Image needs to deploy. Size is in MB.\n","example":2500,"readOnly":true,"type":"integer","x-linode-cli-display":6,"x-linode-filterable":true},"status":{"description":"The current status of this Image.\n\nOnly Images in an \"available\" status can be deployed. Images in a \"creating\" status are being created from a Linode Disk, and will become \"available\" shortly. Images in a \"pending_upload\" status are waiting for data to be [uploaded](/docs/api/images/#image-upload), and become \"available\" after the upload and processing are complete.\n\nThe \"+order_by\" and \"+order\" operators are not available for [filtering](/docs/api/#filtering-and-sorting) on this key.\n","enum":["creating","pending_upload","available"],"example":"available","readOnly":true,"type":"string","x-linode-cli-display":7,"x-linode-filterable":true},"type":{"description":"How the Image was created.\n\n\"Manual\" Images can be created at any time.\n\n\"Automatic\" Images are created automatically from a deleted Linode.\n","enum":["manual","automatic"],"example":"manual","readOnly":true,"type":"string","x-linode-filterable":true},"updated":{"description":"When this Image was last updated.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string"},"vendor":{"description":"The upstream distribution vendor. `None` for private Images.\n","example":"Debian","readOnly":true,"type":"string","x-linode-cli-color":{"None":"black","default_":"white"},"x-linode-cli-display":3,"x-linode-filterable":true}},"type":"object"},"Invoice":{"description":"Account Invoice object","properties":{"date":{"description":"When this Invoice was generated.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":2},"id":{"description":"The Invoice's unique ID.","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":1},"label":{"description":"The Invoice's display label.","example":"Invoice","readOnly":true,"type":"string","x-linode-cli-display":3},"subtotal":{"description":"The amount of the Invoice before taxes in US Dollars.","example":120.25,"readOnly":true,"type":"number","x-linode-cli-display":4},"tax":{"description":"The amount of tax levied on the Invoice in US Dollars.","example":12.25,"readOnly":true,"type":"number","x-linode-cli-display":5},"tax_summary":{"description":"The amount of tax broken down into subtotals by source.","items":{"properties":{"name":{"description":"The source of this tax subtotal.","example":"PA STATE TAX","type":"string"},"tax":{"description":"The amount of tax subtotal attributable to this source.","example":12.25,"type":"number"}},"type":"object"},"readOnly":true,"type":"array"},"total":{"description":"The amount of the Invoice after taxes in US Dollars.","example":132.5,"readOnly":true,"type":"number","x-linode-cli-display":6}},"type":"object"},"InvoiceItem":{"description":"An InvoiceItem object.","properties":{"amount":{"description":"The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.","example":20.2,"readOnly":true,"type":"number","x-linode-cli-display":4},"from":{"description":"The date the Invoice Item started, based on month.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":2},"label":{"description":"The Invoice Item's display label.","example":"Linode 123","readOnly":true,"type":"string","x-linode-cli-display":1},"quantity":{"description":"The quantity of this Item for the specified Invoice.","example":4,"readOnly":true,"type":"integer"},"tax":{"description":"The amount of tax levied on this Item in US Dollars.","example":1.25,"readOnly":true,"type":"number","x-linode-cli-display":5},"to":{"description":"The date the Invoice Item ended, based on month.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":3},"total":{"description":"The price of this Item after taxes in US Dollars.","example":21.45,"readOnly":true,"type":"number","x-linode-cli-display":6},"type":{"description":"The type of service, ether `hourly` or `misc`.","enum":["hourly","misc"],"example":"hourly","readOnly":true,"type":"string"},"unit_price":{"description":"The monthly service fee in US Dollars for this Item.","example":5.05,"readOnly":true,"type":"string"}},"type":"object"},"Kernel":{"description":"Linux kernel object","properties":{"architecture":{"description":"The architecture of this Kernel.","enum":["x86_64","i386"],"example":"x86_64","readOnly":true,"type":"string","x-linode-cli-display":4,"x-linode-filterable":true},"built":{"description":"The date on which this Kernel was built.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string"},"deprecated":{"description":"If this Kernel is marked as deprecated, this field has a value of true; otherwise, this field is false.","example":false,"readOnly":true,"type":"boolean","x-linode-filterable":true},"id":{"description":"The unique ID of this Kernel.","example":"linode/latest-64bit","readOnly":true,"type":"string","x-linode-cli-display":1},"kvm":{"description":"If this Kernel is suitable for KVM Linodes.","example":true,"readOnly":true,"type":"boolean","x-linode-filterable":true},"label":{"description":"The friendly name of this Kernel.","example":"Latest 64 bit (4.15.7-x86_64-linode102)","readOnly":true,"type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"pvops":{"description":"If this Kernel is suitable for paravirtualized operations.","example":false,"readOnly":true,"type":"boolean","x-linode-filterable":true},"version":{"description":"Linux Kernel version.","example":"4.15.7","readOnly":true,"type":"string","x-linode-cli-display":3,"x-linode-filterable":true},"xen":{"description":"If this Kernel is suitable for Xen Linodes.","example":false,"readOnly":true,"type":"boolean","x-linode-filterable":true}},"type":"object"},"LKECluster":{"description":"A Kubernetes cluster.","properties":{"control_plane":{"description":"Defines settings for the Kubernetes Control Plane. Allows for the enabling of High Availability (HA) for Control Plane Components. Enabling High Avaialability for LKE is an **irreversible** change.\n","properties":{"high_availability":{"description":"Defines whether High Availability is enabled for the Control Plane Components of the cluster. Defaults to `false`.\n","example":true,"type":"boolean","x-linode-cli-display":5}},"type":"object"},"created":{"description":"When this Kubernetes cluster was created.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"This Kubernetes cluster's unique ID.","example":1234,"readOnly":true,"type":"integer","x-linode-cli-display":1},"k8s_version":{"description":"The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>, and the latest supported patch version will be deployed.\n","example":"1.25","type":"string","x-linode-cli-display":4,"x-linode-filterable":true},"label":{"description":"This Kubernetes cluster's unique label for display purposes only.\nLabels have the following constraints:\n\n * UTF-8 characters will be returned by the API using escape\n sequences of their Unicode code points. For example, the\n Japanese character *か* is 3 bytes in UTF-8 (`0xE382AB`). Its\n Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this\n character and the API will return it as the escape sequence\n using six 1 byte characters which represent 2 bytes of Unicode\n code point (`\"\\u30ab\"`).\n * 4 byte UTF-8 characters are not supported.\n * If the label is entirely composed of UTF-8 characters, the API\n response will return the code points using up to 193 1 byte\n characters.\n","example":"lkecluster12345","maxLength":32,"minLength":1,"type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"region":{"description":"This Kubernetes cluster's location.","example":"us-central","type":"string","x-linode-cli-display":3,"x-linode-filterable":true},"tags":{"description":"An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only.\n","example":["ecomm","blogs"],"items":{"type":"string"},"type":"array","x-linode-filterable":true},"updated":{"description":"When this Kubernetes cluster was updated.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"LKENodePool":{"description":"The set of Node Pools which are members of the Kubernetes cluster. Node Pools consist of a Linode type, the number of Linodes to deploy of that type, and additional status information.\n","properties":{"autoscaler":{"description":"When enabled, the number of nodes autoscales within the defined minimum and maximum values.\n","properties":{"enabled":{"description":"Whether autoscaling is enabled for this Node Pool. Defaults to `false`.","example":true,"type":"boolean"},"max":{"description":"The maximum number of nodes to autoscale to. Defaults to the Node Pool's `count`.","example":12,"maximum":100,"minimum":1,"type":"integer"},"min":{"description":"The minimum number of nodes to autoscale to. Defaults to the Node Pool's `count`.","example":3,"maximum":100,"minimum":1,"type":"integer"}},"type":"object"},"count":{"description":"The number of nodes in the Node Pool.","example":6,"maximum":100,"minimum":1,"type":"integer"},"disks":{"description":"This Node Pool's custom disk layout.\n","items":{"description":"The values to assign to each partition in this Node Pool's custom disk layout.\n","properties":{"size":{"description":"The size of this custom disk partition in MB.\n\n * The size of this disk partition must not exceed the capacity of the node's plan type.\n","example":1024,"type":"integer"},"type":{"description":"This custom disk partition's filesystem type.\n","enum":["raw","ext4"],"example":"ext-4","type":"string"}},"type":"object"},"type":"array","x-linode-cli-format":"json"},"id":{"description":"This Node Pool's unique ID.\n","example":456,"type":"integer","x-linode-filterable":true},"nodes":{"description":"Status information for the Nodes which are members of this Node Pool. If a Linode has not been provisioned for a given Node slot, the instance_id will be returned as null.\n","items":{"$ref":"#/components/schemas/LKENodeStatus"},"type":"array"},"tags":{"description":"An array of tags applied to this object. Tags are for organizational purposes only.\n","example":["example tag","another example"],"items":{"type":"string"},"type":"array","x-linode-filterable":true},"type":{"description":"The Linode Type for all of the nodes in the Node Pool.","example":"g6-standard-4","type":"string"}},"type":"object"},"LKENodePoolRequestBody":{"description":"Specifies a collection of Linodes which will be members of a Kubernetes cluster.\n","properties":{"autoscaler":{"description":"When enabled, the number of nodes autoscales within the defined minimum and maximum values.\n\nWhen making a request, `max` and `min` require each other.\n","properties":{"enabled":{"description":"Whether autoscaling is enabled for this Node Pool. Defaults to `false`.","example":true,"type":"boolean"},"max":{"description":"The maximum number of nodes to autoscale to. Defaults to the Node Pool's `count`. Defaults to the value provided by the `count` field.\n","example":12,"maximum":100,"minimum":1,"type":"integer"},"min":{"description":"The minimum number of nodes to autoscale to. Defaults to the Node Pool's `count`.","example":3,"maximum":100,"minimum":1,"type":"integer"}},"type":"object"},"count":{"$ref":"#/components/schemas/LKENodePool/properties/count"},"disks":{"description":"**Note**: This field should be omitted except for special use cases. The disks specified here are\npartitions in *addition* to the primary partition and reduce the size of the primary partition,\nwhich can lead to stability problems for the Node.\n\nThis Node Pool's custom disk layout. Each item in this array will create a new disk\npartition for each node in this Node Pool.\n\n * The custom disk layout is applied to each node in this Node Pool.\n * The maximum number of custom disk partitions that can be configured is 7.\n * Once the requested disk paritions are allocated, the remaining disk space is allocated to the node's boot disk.\n * A Node Pool's custom disk layout is immutable over the lifetime of the Node Pool.\n","items":{"$ref":"#/components/schemas/LKENodePool/properties/disks/items"},"type":"array","x-linode-cli-format":"json"},"tags":{"$ref":"#/components/schemas/LKENodePool/properties/tags"},"type":{"$ref":"#/components/schemas/LKENodePool/properties/type"}},"type":"object"},"LKENodeStatus":{"description":"Status information for a Node which is a member of a Kubernetes cluster.\n","properties":{"id":{"description":"The Node's ID.\n","example":"123456","type":"string"},"instance_id":{"description":"The Linode's ID. When no Linode is currently provisioned for this Node, this will be null.\n","example":123458,"type":"string"},"status":{"description":"The Node's status as it pertains to being a Kubernetes node.\n","enum":["ready","not_ready"],"example":"ready","type":"string"}},"readOnly":true,"type":"object"},"LKEVersion":{"description":"LKE versions\n","properties":{"id":{"description":"A Kubernetes version number available for deployment to a Kubernetes cluster in the format of <major>.<minor>, and the latest supported patch version.\n","example":"1.25","type":"string"}},"readOnly":true,"type":"object"},"Linode":{"properties":{"alerts":{"properties":{"cpu":{"description":"The percentage of CPU usage required to trigger an alert.\nIf the average CPU usage over two hours exceeds this value, we'll send you an alert.\nYour Linode's total CPU capacity is represented as 100%, multiplied by its number of\ncores.\n\nFor example, a two core Linode's CPU capacity is represented as 200%. If you want\nto be alerted at 90% of a two core Linode's CPU capacity, set the alert value to `180`.\n\nThe default value is 90% multiplied by the number of cores.\n\nIf the value is set to `0` (zero), the alert is disabled.\n","example":180,"type":"integer"},"io":{"description":"The amount of disk IO operation per second required to trigger an alert. If the average disk IO over two hours exceeds this value, we'll send you an alert. If set to `0` (zero), this alert is disabled.\n","example":10000,"type":"integer"},"network_in":{"description":"The amount of incoming traffic, in Mbit/s, required to trigger an alert. If the average incoming traffic over two hours exceeds this value, we'll send you an alert. If this is set to `0` (zero), the alert is disabled.\n","example":10,"type":"integer"},"network_out":{"description":"The amount of outbound traffic, in Mbit/s, required to trigger an alert. If the average outbound traffic over two hours exceeds this value, we'll send you an alert. If this is set to `0` (zero), the alert is disabled.\n","example":10,"type":"integer"},"transfer_quota":{"description":"The percentage of network transfer that may be used before an alert is triggered. When this value is exceeded, we'll alert you. If this is set to `0` (zero), the alert is disabled.\n","example":80,"type":"integer"}},"type":"object"},"backups":{"description":"Information about this Linode's backups status. For information about available backups, see [/linode/instances/{linodeId}/backups](/docs/api/linode-instances/#backups-list).\n","properties":{"available":{"description":"Whether Backups for this Linode are available for restoration.\n\nBackups undergoing maintenance are not available for restoration.\n","example":true,"readOnly":true,"type":"boolean"},"enabled":{"description":"If this Linode has the Backup service enabled. To enable backups, see [POST /linode/instances/{linodeId}/backups/enable](/docs/api/linode-instances/#backups-enable).\n","example":true,"readOnly":true,"type":"boolean"},"last_successful":{"description":"The last successful backup date. 'null' if there was no previous backup.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string"},"schedule":{"properties":{"day":{"description":"The day of the week that your Linode's weekly Backup is taken.\nIf not set manually, a day will be chosen for you. Backups\nare taken every day, but backups taken on this day are\npreferred when selecting backups to retain for a longer period.\n\n\nIf not set manually, then when backups are initially enabled, this\nmay come back as `Scheduling` until the `day` is automatically selected.\n","enum":["Scheduling","Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"example":"Saturday","nullable":true,"type":"string"},"window":{"description":"The window in which your backups will be taken, in UTC. A\nbackups window is a two-hour span of time in which the backup\nmay occur.\n\n\nFor example, `W10` indicates that your backups should be\ntaken between 10:00 and 12:00. If you do not choose a backup\nwindow, one will be selected for you automatically.\n\n\nIf not set manually, when backups are initially enabled this\nmay come back as `Scheduling` until the `window` is automatically selected.\n","enum":["Scheduling","W0","W2","W4","W6","W8","W10","W12","W14","W16","W18","W20","W22"],"example":"W22","nullable":true,"type":"string"}},"type":"object"}},"type":"object"},"created":{"description":"When this Linode was created.","example":"2025-08-15T13:51:51.402Z","format":"date-time","readOnly":true,"type":"string"},"group":{"deprecated":true,"description":"A deprecated property denoting a group label for this Linode.\n","example":"Linode-Group","type":"string","x-linode-filterable":true},"host_uuid":{"description":"The Linode's host machine, as a UUID.","example":"3a3ddd59d9a78bb8de041391075df44de62bfec8","format":"uuid","readOnly":true,"type":"string"},"hypervisor":{"description":"The virtualization software powering this Linode.\n","enum":["kvm"],"example":"kvm","readOnly":true,"type":"string"},"id":{"description":"This Linode's ID which must be provided for all operations impacting this Linode.\n","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":1,"x-linode-filterable":true},"image":{"allOf":[{"$ref":"#/components/schemas/DiskRequest/properties/image"}],"example":"linode/debian10","nullable":true,"readOnly":true,"x-linode-cli-display":5,"x-linode-filterable":true},"ipv4":{"description":"This Linode's IPv4 Addresses. Each Linode is assigned a single public IPv4 address\nupon creation, and may get a single private IPv4 address if needed. You may need to\n[open a support ticket](/docs/api/support/#support-ticket-open)\nto get additional IPv4 addresses.\n\nIPv4 addresses may be reassigned between your Linodes, or shared with other Linodes.\nSee the [/networking](/docs/api/networking/) endpoints for details.\n","example":["203.0.113.1","192.0.2.1"],"items":{"type":"string"},"readOnly":true,"type":"array","x-linode-cli-display":7,"x-linode-filterable":true},"ipv6":{"description":"This Linode's IPv6 SLAAC address. This address is specific to a Linode, and may not be shared. If the Linode has not been assigned an IPv6 address, the return value will be `null`.\n","example":"c001:d00d::1337/128","format":"ipv6/128","nullable":true,"readOnly":true,"type":"string"},"label":{"description":"The Linode's label is for display purposes only. If no label is provided for a Linode,\na default will be assigned.\n\nLinode labels have the following constraints:\n\n * Must begin and end with an alphanumeric character.\n * May only consist of alphanumeric characters, dashes (`-`), underscores (`_`) or periods (`.`).\n * Cannot have two dashes (`--`), underscores (`__`) or periods (`..`) in a row.\n","example":"linode123","maxLength":64,"minLength":3,"pattern":"^[a-zA-Z]((?!--|__|..)[a-zA-Z0-9-_.])+$","type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"region":{"description":"This is the [Region](/docs/api/regions/#regions-list) where the Linode was deployed. A Linode's region can only be changed by initiating a [cross data center migration](/docs/api/linode-instances/#dc-migrationpending-host-migration-initiate).\n","example":"us-east","readOnly":true,"type":"string","x-linode-cli-display":3,"x-linode-filterable":true},"specs":{"description":"Information about the resources available to this Linode.","properties":{"disk":{"description":"The amount of storage space, in MB, this Linode has access to. A typical Linode will divide this space between a primary disk with an `image` deployed to it, and a swap disk, usually 512 MB. This is the default configuration created when deploying a Linode with an `image` through [POST /linode/instances](/docs/api/linode-instances/#linode-create). While this configuration is suitable for 99% of use cases, if you need finer control over your Linode's disks, see the [/linode/instances/{linodeId}/disks](/docs/api/linode-instances/#disks-list) endpoints.\n","example":81920,"readOnly":true,"type":"integer"},"gpus":{"description":"The number of gpus this Linode has access to.\n","example":0,"readOnly":true,"type":"integer"},"memory":{"description":"The amount of RAM, in MB, this Linode has access to.\n\nTypically, a Linode boots with all of its available RAM, but this can be configured in a Config profile. See the [/linode/instances/{linodeId}/configs](/docs/api/linode-instances/#configuration-profiles-list) endpoints and the LinodeConfig object for more information.\n","example":4096,"readOnly":true,"type":"integer"},"transfer":{"description":"The amount of network transfer this Linode is allotted each month.","example":4000,"readOnly":true,"type":"integer"},"vcpus":{"description":"The number of vcpus this Linode has access to.\n","example":2,"readOnly":true,"type":"integer"}},"readOnly":true,"type":"object"},"status":{"description":"A brief description of this Linode's current state. This field may change without direct action from you. For example, when a Linode goes into maintenance mode its status will display \"stopped\".\n","enum":["running","offline","booting","rebooting","shutting_down","provisioning","deleting","migrating","rebuilding","cloning","restoring","stopped"],"example":"running","readOnly":true,"type":"string","x-linode-cli-color":{"default_":"yellow","offline":"red","running":"green"},"x-linode-cli-display":6},"tags":{"description":"An array of tags applied to this object. Tags are for organizational purposes only.\n","example":["example tag","another example"],"items":{"type":"string"},"type":"array","x-linode-filterable":true},"type":{"description":"This is the [Linode Type](/docs/api/linode-types/#types-list) that this Linode was deployed with.\nTo change a Linode's Type, use [POST /linode/instances/{linodeId}/resize](/docs/api/linode-instances/#linode-resize).\n","example":"g6-standard-1","readOnly":true,"type":"string","x-linode-cli-display":4},"updated":{"description":"When this Linode was last updated.","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string"},"watchdog_enabled":{"description":"The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. It works by issuing a boot job when your Linode powers off without a shutdown job being responsible.\nTo prevent a loop, Lassie will give up if there have been more than 5 boot jobs issued within 15 minutes.\n","example":true,"type":"boolean"}},"type":"object"},"LinodeConfig":{"properties":{"comments":{"description":"Optional field for arbitrary User comments on this Config.","example":"This is my main Config","nullable":true,"type":"string"},"devices":{"$ref":"#/components/schemas/Devices"},"helpers":{"description":"Helpers enabled when booting to this Linode Config.","properties":{"devtmpfs_automount":{"description":"Populates the /dev directory early during boot without udev. Defaults to false.\n","example":false,"type":"boolean"},"distro":{"description":"Helps maintain correct inittab/upstart console device.","example":true,"type":"boolean"},"modules_dep":{"description":"Creates a modules dependency file for the Kernel you run.","example":true,"type":"boolean"},"network":{"description":"Automatically configures static networking.","example":true,"type":"boolean"},"updatedb_disabled":{"description":"Disables updatedb cron job to avoid disk thrashing.","example":true,"type":"boolean"}},"type":"object"},"id":{"description":"The ID of this Config.","example":23456,"readOnly":true,"type":"integer","x-linode-cli-display":1},"interfaces":{"$ref":"#/components/schemas/LinodeConfigInterfaces"},"kernel":{"description":"A Kernel ID to boot a Linode with. Defaults to \"linode/latest-64bit\".","example":"linode/latest-64bit","type":"string","x-linode-cli-display":3},"label":{"description":"The Config's label is for display purposes only.\n","example":"My Config","maxLength":48,"minLength":1,"type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"memory_limit":{"description":"Defaults to the total RAM of the Linode.\n","example":2048,"type":"integer"},"root_device":{"description":"The root device to boot.\n* If no value or an invalid value is provided, root device will default to `/dev/sda`.\n* If the device specified at the root device location is not mounted, the Linode will not boot until a device is mounted.\n","example":"/dev/sda","pattern":"a-z, A-Z, 0-9, /, _, -","type":"string"},"run_level":{"description":"Defines the state of your Linode after booting. Defaults to `default`.\n","enum":["default","single","binbash"],"example":"default","type":"string"},"virt_mode":{"description":"Controls the virtualization mode. Defaults to `paravirt`.\n* `paravirt` is suitable for most cases. Linodes running in paravirt mode\n share some qualities with the host, ultimately making it run faster since\n there is less transition between it and the host.\n* `fullvirt` affords more customization, but is slower because 100% of the VM\n is virtualized.\n","enum":["paravirt","fullvirt"],"example":"paravirt","type":"string"}},"type":"object"},"LinodeConfigInterface":{"description":"The Network Interface to apply to this Linode's configuration profile.\n","properties":{"ipam_address":{"description":"This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation.\n\nOnly used for `vlan` purpose interfaces. Must be an empty string or `null` for `public` purpose interfaces.\n\nThe Linode is configured to use this address for the associated interface upon reboot if Network Helper is enabled. If Network Helper is disabled, the address can be enabled with [manual static IP configuration](/docs/guides/manual-network-configuration/).\n\nMust be unique among the Linode's interfaces.\n","example":"10.0.0.1/24","format":"ip/netmask","nullable":true,"type":"string"},"label":{"description":"The name of this interface.\n\nRequired for `vlan` purpose interfaces. Must be an empty string or `null` for `public` purpose interfaces.\n\nIf the VLAN label is new, a VLAN is created. Up to 10 VLANs can be created in each data center region. To view your active VLANs, use the [VLANs List](/docs/api/networking/#vlans-list) endpoint.\n\nMay only consist of ASCII letters, numbers, and dashes (`-`).\n\nMust be unique among the Linode's interfaces.\n","example":"example-interface","maxLength":64,"minLength":1,"nullable":true,"pattern":"/[a-z0-9-]+/","type":"string","x-linode-filterable":true},"purpose":{"description":"The type of interface.\n\n* `public`\n * Only one `public` interface per Linode can be defined.\n * The Linode's default public IPv4 address is assigned to the `public` interface.\n * A Linode must have a public interface in the first/eth0 position to be reachable via the public internet upon boot without additional system configuration. If no `public` interface is configured, the Linode is not directly reachable via the public internet. In this case, access can only be established via LISH or other Linodes connected to the same VLAN.\n\n* `vlan`\n * Configuring a `vlan` purpose interface attaches this Linode to the VLAN with the specified `label`.\n * The Linode is configured to use the specified `ipam_address`, if any.\n","enum":["public","vlan"],"example":"vlan","type":"string"}},"type":"object"},"LinodeConfigInterfaces":{"description":"An array of Network Interfaces to add to this Linode's Configuration Profile.\n\nUp to three interface objects can be entered in this array. The position in the array determines the interface to which the settings apply:\n\n- First/0: eth0\n- Second/1: eth1\n- Third/2: eth2\n\nWhen updating a Linode's interfaces, *each interface must be redefined*. An empty interfaces array results in a default public interface configuration only.\n\nIf no public interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n**Note:** Changes to Linode interface configurations can be enabled by rebooting the Linode.\n\n**Note:** Only Next Generation Network (NGN) data centers support VLANs. Use the Regions ([/regions](/docs/api/regions/)) endpoint to view the capabilities of data center regions.\nIf a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center,\nthe migration or cloning will not initiate. If a Linode cannot be migrated because of an incompatibility,\nyou will be prompted to select a different data center or contact support.\n\n**Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.\n","items":{"$ref":"#/components/schemas/LinodeConfigInterface"},"required":["purpose"],"type":"array"},"LinodeRequest":{"description":"Common properties for creating and rebuilding Linodes.","properties":{"authorized_keys":{"$ref":"#/components/schemas/DiskRequest/properties/authorized_keys"},"authorized_users":{"$ref":"#/components/schemas/DiskRequest/properties/authorized_users"},"booted":{"default":true,"description":"This field defaults to `true` if the Linode is created with an Image or from a Backup.\nIf it is deployed from an Image or a Backup and you wish it to remain `offline` after deployment, set this to `false`.\n","type":"boolean","writeOnly":true},"image":{"$ref":"#/components/schemas/DiskRequest/properties/image"},"root_pass":{"$ref":"#/components/schemas/DiskRequest/properties/root_pass"},"stackscript_data":{"$ref":"#/components/schemas/DiskRequest/properties/stackscript_data"},"stackscript_id":{"$ref":"#/components/schemas/DiskRequest/properties/stackscript_id"}},"type":"object"},"LinodeStats":{"description":"CPU, IO, IPv4, and IPv6 statistics. Graph data, if available, is in \"[timestamp, reading]\" array format. Timestamp is a UNIX timestamp in EST.\n","properties":{"cpu":{"description":"Percentage of CPU used.\n","items":{"items":{"example":[1521483600000,0.42],"type":"number"},"type":"array"},"type":"array"},"io":{"description":"Input/Output statistics.","properties":{"io":{"description":"Block/s written.","items":{"items":{"example":[1521484800000,0.19],"type":"number"},"type":"array"},"type":"array"},"swap":{"description":"Block/s written.","items":{"items":{"example":[1521484800000,0],"type":"number"},"type":"array"},"type":"array"}},"type":"object"},"netv4":{"description":"IPv4 statistics.","properties":{"in":{"description":"Input stats for IPv4, measured in bits/s (bits/second).","items":{"items":{"example":[1521484800000,2004.36],"type":"number"},"type":"array"},"type":"array"},"out":{"description":"Output stats for IPv4, measured in bits/s (bits/second).","items":{"items":{"example":[1521484800000,3928.91],"type":"number"},"type":"array"},"type":"array"},"private_in":{"description":"Private IPv4 input statistics, measured in bits/s (bits/second).","items":{"items":{"example":[1521484800000,0],"type":"number"},"type":"array"},"type":"array"},"private_out":{"description":"Private IPv4 output statistics, measured in bits/s (bits/second).","items":{"items":{"example":[1521484800000,5.6],"type":"number"},"type":"array"},"type":"array"}},"type":"object"},"netv6":{"description":"IPv6 statistics.","properties":{"in":{"description":"Input stats for IPv6, measured in bits/s (bits/second).","items":{"items":{"example":[1521484800000,0],"type":"number"},"type":"array"},"type":"array"},"out":{"description":"Output stats for IPv6, measured in bits/s (bits/second).","items":{"items":{"example":[1521484800000,0],"type":"number"},"type":"array"},"type":"array"},"private_in":{"description":"Private IPv6 input statistics, measured in bits/s (bits/second).","items":{"items":{"example":[1521484800000,195.18],"type":"number"},"type":"array"},"type":"array"},"private_out":{"description":"Private IPv6 output statistics, measured in bits/s (bits/second).","items":{"items":{"example":[1521484800000,5.6],"type":"number"},"type":"array"},"type":"array"}},"type":"object"},"title":{"description":"The title for this data set.","example":"linode.com - my-linode (linode123456) - day (5 min avg)","type":"string"}},"readOnly":true,"type":"object"},"LinodeType":{"description":"Returns collection of Linode types, including pricing and specifications for each type. These are used when [creating](/docs/api/linode-instances/#linode-create) or [resizing](/docs/api/linode-instances/#linode-resize) Linodes.\n","properties":{"addons":{"description":"A list of optional add-on services for Linodes and their associated costs.\n","properties":{"backups":{"description":"Information about the optional Backup service offered for Linodes.\n","properties":{"price":{"description":"Cost of enabling Backups for this Linode Type.","properties":{"hourly":{"description":"The cost (in US dollars) per hour to add Backups service.\n","example":0.008,"type":"number"},"monthly":{"description":"The cost (in US dollars) per month to add Backups service.\n","example":5,"type":"number"}},"type":"object"}},"readOnly":true,"type":"object"}},"readOnly":true,"type":"object"},"class":{"description":"The class of the Linode Type. We currently offer five classes of Linodes:\n\n * nanode - Nanode instances are good for low-duty workloads,\n where performance isn't critical. **Note:** As of June 16th, 2020, Nanodes became\n 1 GB Linodes in the Cloud Manager, however, the API, the CLI, and billing will\n continue to refer to these instances as Nanodes.\n * standard - Standard Shared instances are good for medium-duty workloads and\n are a good mix of performance, resources, and price. **Note:** As of June 16th, 2020,\n Standard Linodes in the Cloud Manager became Shared Linodes, however, the API, the CLI, and\n billing will continue to refer to these instances as Standard Linodes.\n * dedicated - Dedicated CPU instances are good for full-duty workloads\n where consistent performance is important.\n * gpu - Linodes with dedicated NVIDIA Quadro ® RTX 6000 GPUs accelerate highly\n specialized applications such as machine learning, AI, and video transcoding.\n * highmem - High Memory instances favor RAM over other resources, and can be\n good for memory hungry use cases like caching and in-memory databases.\n All High Memory plans contain dedicated CPU cores.\n","enum":["nanode","standard","dedicated","gpu","highmem"],"example":"standard","readOnly":true,"type":"string","x-linode-cli-display":3,"x-linode-filterable":true},"disk":{"description":"The Disk size, in MB, of the Linode Type.\n","example":81920,"readOnly":true,"type":"integer","x-linode-cli-display":4,"x-linode-filterable":true},"gpus":{"description":"The number of GPUs this Linode Type offers.\n","example":0,"readOnly":true,"type":"integer","x-linode-cli-display":11,"x-linode-filterable":true},"id":{"description":"The ID representing the Linode Type.","example":"g6-standard-2","readOnly":true,"type":"string","x-linode-cli-display":1},"label":{"description":"The Linode Type's label is for display purposes only.\n","example":"Linode 4GB","readOnly":true,"type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"memory":{"description":"Amount of RAM included in this Linode Type.\n","example":4096,"readOnly":true,"type":"integer","x-linode-cli-display":5,"x-linode-filterable":true},"network_out":{"description":"The Mbits outbound bandwidth allocation.\n","example":1000,"readOnly":true,"type":"integer","x-linode-cli-display":7,"x-linode-filterable":true},"price":{"description":"Cost in US dollars, broken down into hourly and monthly charges.\n","properties":{"hourly":{"description":"Cost (in US dollars) per hour.","example":0.03,"type":"number","x-linode-cli-display":9},"monthly":{"description":"Cost (in US dollars) per month.","example":20,"type":"number","x-linode-cli-display":10}},"readOnly":true,"type":"object"},"successor":{"description":"The Linode Type that a [mutate](/docs/api/linode-instances/#linode-upgrade) will upgrade to for a Linode of this type. If \"null\", a Linode of this type may not mutate.\n","example":null,"nullable":true,"readOnly":true,"type":"string"},"transfer":{"description":"The monthly outbound transfer amount, in MB.\n","example":4000,"readOnly":true,"type":"integer","x-linode-cli-display":8,"x-linode-filterable":true},"vcpus":{"description":"The number of VCPU cores this Linode Type offers.\n","example":2,"readOnly":true,"type":"integer","x-linode-cli-display":6,"x-linode-filterable":true}},"type":"object"},"Login":{"description":"An object representing a previous successful login for a User.\n","properties":{"datetime":{"description":"When the login was initiated.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":2},"id":{"description":"The unique ID of this login object.\n","example":1234,"readOnly":true,"type":"integer","x-linode-cli-display":1},"ip":{"description":"The remote IP address that requested the login.\n","example":"192.0.2.0","format":"ip","readOnly":true,"type":"string","x-linode-cli-display":3},"restricted":{"description":"True if the User that attempted the login was a restricted User, false otherwise.\n","example":true,"readOnly":true,"type":"boolean","x-linode-cli-display":6},"status":{"description":"Whether the login attempt succeeded or failed.\n","enum":["successful","failed"],"example":"successful","readOnly":true,"type":"string","x-linode-cli-display":5},"username":{"description":"The username of the User that attempted the login.\n","example":"example_user","readOnly":true,"type":"string","x-linode-cli-display":4}},"type":"object"},"LongviewClient":{"description":"A LongviewClient is a single monitor set up to track statistics about one of your servers.\n","properties":{"api_key":{"description":"The API key for this Client, used when configuring the Longview\nClient application on your Linode.\n\nReturns as `[REDACTED]` if you do not have read-write access to this client.\n","example":"BD1B4B54-D752-A76D-5A9BD8A17F39DB61","readOnly":true,"type":"string"},"apps":{"description":"The apps this Client is monitoring on your Linode. This is configured when you install the Longview Client application, and is present here for information purposes only.\n","properties":{"apache":{"description":"If True, the Apache Longview Client module is monitoring Apache on your server.\n","example":true,"readOnly":true,"type":"boolean"},"mysql":{"description":"If True, the MySQL Longview Client modules is monitoring MySQL on your server.\n","example":true,"readOnly":true,"type":"boolean"},"nginx":{"description":"If True, the Nginx Longview Client module is monitoring Nginx on your server.\n","example":false,"readOnly":true,"type":"boolean"}},"readOnly":true,"type":"object"},"created":{"description":"When this Longview Client was created.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":3},"id":{"description":"This Client's unique ID.\n","example":789,"readOnly":true,"type":"integer","x-linode-cli-display":1},"install_code":{"description":"The install code for this Client, used when configuring the Longview\nClient application on your Linode.\n\nReturns as `[REDACTED]` if you do not have read-write access to this client.\n","example":"BD1B5605-BF5E-D385-BA07AD518BE7F321","readOnly":true,"type":"string","x-linode-cli-display":4},"label":{"description":"This Client's unique label. This is for display purposes only.\n","example":"client789","maxLength":32,"minLength":3,"pattern":"[a-zA-Z0-9-_]{3,32}","type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"updated":{"description":"When this Longview Client was last updated.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"LongviewPlan":{"description":"Longview Plan object.\n","properties":{"longview_subscription":{"description":"The subscription ID for a particular Longview plan. A value of `null` corresponds to Longview Free.\n\nYou can send a request to the [List Longview Subscriptions](/docs/api/longview/#longview-subscriptions-list) endpoint to receive the details of each plan.\n","enum":["longview-3","longview-10","longview-40","longview-100"],"example":"longview-10","nullable":true,"type":"string","x-linode-cli-display":1}},"type":"object"},"LongviewSubscription":{"description":"A Longview Subscription represents a tier of Longview service you can subscribe to.\n","properties":{"clients_included":{"description":"The number of Longview Clients that may be created with this Subscription tier.\n","example":10,"readOnly":true,"type":"integer","x-linode-cli-display":3},"id":{"description":"The unique ID of this Subscription tier.\n","enum":["longview-3","longview-10","longview-40","longview-100"],"example":"longview-10","readOnly":true,"type":"string","x-linode-cli-display":1},"label":{"description":"A display name for this Subscription tier.\n","example":"Longview Pro 10 pack","readOnly":true,"type":"string","x-linode-cli-display":2},"price":{"description":"Pricing information about this Subscription tier.\n","properties":{"hourly":{"description":"The hourly price, in US dollars, for this Subscription tier.\n","example":0.06,"readOnly":true,"type":"number"},"monthly":{"description":"The maximum monthly price in US Dollars for this Subscription tier. You will never be charged more than this amount per month for this subscription.\n","example":40,"readOnly":true,"type":"number"}},"readOnly":true,"type":"object","x-linode-cli-display":4}},"type":"object"},"Maintenance":{"description":"Information about maintenance affecting an entity.\n","properties":{"entity":{"description":"The entity being affected by maintenance.\n","properties":{"id":{"description":"The id of the entity being affected by maintenance.\n","example":1234,"type":"number"},"label":{"description":"The label of the entity being affected by maintenance.\n","example":"demo-linode","type":"string"},"type":{"description":"The type of entity.\n","example":"Linode","type":"string"},"url":{"description":"The API endpoint prefix to use in combination with the entity id to find specific information about the entity.\n","example":"https://api.linode.com/v4/linode/instances/{linodeId}","type":"string"}},"type":"object"},"reason":{"description":"The reason maintenance is being performed.\n","example":"This maintenance will allow us to update the BIOS on the host's motherboard.","type":"string"},"status":{"description":"The maintenance status.\n\nMaintenance progresses in the following sequence: pending, started, then completed.\n","enum":["completed","pending","started"],"example":"started","type":"string","x-linode-filterable":true},"type":{"description":"The type of maintenance.\n","enum":["reboot","cold_migration","live_migration"],"example":"reboot","type":"string","x-linode-filterable":true},"when":{"description":"When the maintenance will begin.\n\n[Filterable](/docs/api/#filtering-and-sorting) with the following parameters:\n\n* A single value in date-time string format (\"%Y-%m-%dT%H:%M:%S\"), which returns only matches to that value.\n\n* A dictionary containing pairs of inequality operator string keys (\"+or\", \"+gt\", \"+gte\", \"+lt\", \"+lte\",\nor \"+neq\") and single date-time string format values (\"%Y-%m-%dT%H:%M:%S\"). \"+or\" accepts an array of values that\nmay consist of single date-time strings or dictionaries of inequality operator pairs.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","type":"string","x-linode-filterable":true}},"type":"object"},"ManagedContact":{"description":"Information about someone Linode's special forces may contact in case an issue is detected with a manager service.\n","properties":{"email":{"description":"The address to email this Contact to alert them of issues.\n","example":"john.doe@example.org","format":"email","type":"string","x-linode-cli-display":3},"group":{"description":"A grouping for this Contact. This is for display purposes only.\n","example":"on-call","maxLength":50,"minLength":2,"nullable":true,"type":"string","x-linode-cli-display":5,"x-linode-filterable":true},"id":{"description":"This Contact's unique ID.\n","example":567,"readOnly":true,"type":"integer","x-linode-cli-display":1},"name":{"description":"The name of this Contact.\n","example":"John Doe","maxLength":64,"minLength":2,"pattern":"[a-zA-Z0-9-_ ]{2,64}","type":"string","x-linode-cli-display":2},"phone":{"description":"Information about how to reach this Contact by phone.\n","properties":{"primary":{"description":"This Contact's primary phone number.\n","example":"123-456-7890","format":"phone","nullable":true,"type":"string"},"secondary":{"description":"This Contact's secondary phone number.\n","example":null,"format":"phone","nullable":true,"type":"string"}},"type":"object","x-linode-cli-display":4},"updated":{"description":"When this Contact was last updated.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"ManagedCredential":{"description":"A securely-stored Credential that allows Linode's special forces to access a Managed server to respond to Issues.\n","properties":{"id":{"description":"This Credential's unique ID.\n","example":9991,"readOnly":true,"type":"integer","x-linode-cli-display":1},"label":{"description":"The unique label for this Credential. This is for display purposes only.\n","example":"prod-password-1","maxLength":75,"minLength":2,"pattern":"[a-zA-Z0-9-_ \\.]{2,75}","type":"string","x-linode-cli-display":2},"last_decrypted":{"description":"The date this Credential was last decrypted by a member of Linode special forces.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":3}},"type":"object"},"ManagedIssue":{"description":"An Issue that was detected with a service Linode is managing.\n","properties":{"created":{"description":"When this Issue was created. Issues are created in response to issues detected with Managed Services, so this is also when the Issue was detected.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":2},"entity":{"description":"The ticket this Managed Issue opened.\n","properties":{"id":{"description":"This ticket's ID\n","example":98765,"readOnly":true,"type":"integer"},"label":{"description":"The summary for this Ticket.\n","example":"Managed Issue opened!","readOnly":true,"type":"string"},"type":{"description":"The type of entity this is. In this case, it is always a Ticket.\n","enum":["ticket"],"example":"ticket","readOnly":true,"type":"string"},"url":{"description":"The relative URL where you can access this Ticket.\n","example":"/support/tickets/98765","format":"url","readOnly":true,"type":"string"}},"readOnly":true,"type":"object","x-linode-cli-display":4},"id":{"description":"This Issue's unique ID.\n","example":823,"readOnly":true,"type":"integer","x-linode-cli-display":1},"services":{"description":"An array of Managed Service IDs that were affected by this Issue.\n","items":{"example":654,"type":"integer"},"readOnly":true,"type":"array","x-linode-cli-display":3}},"type":"object"},"ManagedLinodeSettings":{"description":"Settings for a specific Linode related to Managed Services. There is one ManagedLinodeSettings object for each Linode on your Account.\n","properties":{"group":{"deprecated":true,"description":"The group of the Linode these Settings are for. This is for display purposes only.\n","example":"linodes","readOnly":true,"type":"string","x-linode-cli-display":3},"id":{"description":"The ID of the Linode these Settings are for.\n","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":1},"label":{"description":"The label of the Linode these Settings are for.\n","example":"linode123","readOnly":true,"type":"string","x-linode-cli-display":2},"ssh":{"description":"The SSH settings for this Linode.\n","properties":{"access":{"default":true,"description":"If true, Linode special forces may access this Linode over ssh to respond to Issues.\n","example":true,"type":"boolean"},"ip":{"default":"any","description":"The IP Linode special forces should use to access this Linode\nwhen responding to an Issue.\n\nBy default, any of a Linode's IP addresses can be used for incident response access.\n","example":"203.0.113.1","format":"ip","type":"string"},"port":{"default":null,"description":"The port Linode special forces should use to access this Linode\nover ssh to respond to an Issue.\n\nThe default `null` value corresponds to port 22.\n","example":22,"maximum":65535,"minimum":1,"nullable":true,"type":"integer"},"user":{"default":null,"description":"The specific user, if any, Linode's special forces should use when accessing this\nLinode to respond to an issue.\n\nThe default `null` value corresponds to the root user.\n","example":"linode","maxLength":32,"minLength":0,"nullable":true,"type":"string"}},"type":"object","x-linode-cli-display":4}},"type":"object"},"ManagedService":{"description":"A service that Linode is monitoring as part of your Managed services. If issues are detected with this service, a ManagedIssue will be opened and, optionally, Linode special forces will attempt to resolve the Issue.\n","properties":{"address":{"description":"The URL at which this Service is monitored.\n\nURL parameters such as `?no-cache=1` are preserved.\n\nURL fragments/anchors such as `#monitor` are **not** preserved.\n","example":"https://example.org","format":"url","maxLength":100,"minLength":3,"type":"string","x-linode-cli-display":5},"body":{"description":"What to expect to find in the response body for the Service to be considered up.\n","example":"it worked","maxLength":100,"minLength":0,"nullable":true,"type":"string"},"consultation_group":{"description":"The group of ManagedContacts who should be notified or consulted with when an Issue is detected.\n","example":"on-call","maxLength":50,"minLength":0,"type":"string","x-linode-cli-display":6},"created":{"description":"When this Managed Service was created.","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string"},"credentials":{"description":"An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.\n","items":{"example":9991,"type":"integer"},"type":"array"},"id":{"description":"This Service's unique ID.\n","example":9944,"readOnly":true,"type":"integer","x-linode-cli-display":1},"label":{"description":"The label for this Service. This is for display purposes only.\n","example":"prod-1","maxLength":64,"minLength":3,"pattern":"[a-zA-Z0-9-_ \\.]{3,64}","type":"string","x-linode-cli-display":4},"notes":{"description":"Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.\n","example":"The service name is my-cool-application","nullable":true,"type":"string"},"region":{"description":"The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.\n","example":null,"type":"string"},"service_type":{"description":"How this Service is monitored.\n","enum":["url","tcp"],"example":"url","type":"string","x-linode-cli-display":3},"status":{"description":"The current status of this Service.\n","enum":["disabled","pending","ok","problem"],"example":"ok","readOnly":true,"type":"string","x-linode-cli-color":{"default_":"yellow","disabled":"red","ok":"green"},"x-linode-cli-display":2},"timeout":{"description":"How long to wait, in seconds, for a response before considering the Service to be down.\n","example":30,"maximum":255,"minimum":1,"type":"integer"},"updated":{"description":"When this Managed Service was last updated.","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"NodeBalancer":{"description":"Linode's load balancing solution. Can handle multiple ports, SSL termination, and any number of backends. NodeBalancer ports are configured with NodeBalancer Configs, and each config is given one or more NodeBalancer Node that accepts traffic. The traffic should be routed to the NodeBalancer's ip address, the NodeBalancer will handle routing individual requests to backends.\n","properties":{"client_conn_throttle":{"description":"Throttle connections per second. Set to 0 (zero) to disable throttling.\n","example":0,"maximum":20,"minimum":0,"type":"integer","x-linode-cli-display":6},"created":{"description":"When this NodeBalancer was created.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string"},"hostname":{"description":"This NodeBalancer's hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_.\n","example":"192.0.2.1.ip.linodeusercontent.com","readOnly":true,"type":"string","x-linode-cli-display":4},"id":{"description":"This NodeBalancer's unique ID.\n","example":12345,"readOnly":true,"type":"integer","x-linode-cli-display":1},"ipv4":{"description":"This NodeBalancer's public IPv4 address.\n","example":"203.0.113.1","format":"ip","readOnly":true,"type":"string","x-linode-cli-display":5,"x-linode-filterable":true},"ipv6":{"description":"This NodeBalancer's public IPv6 address.\n","example":null,"format":"ip","nullable":true,"readOnly":true,"type":"string","x-linode-cli-display":6},"label":{"description":"This NodeBalancer's label. These must be unique on your Account.\n","example":"balancer12345","maxLength":32,"minLength":3,"pattern":"[a-zA-Z0-9-_]{3,32}","type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"region":{"description":"The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.\n","example":"us-east","readOnly":true,"type":"string","x-linode-cli-display":3,"x-linode-filterable":true},"tags":{"description":"An array of Tags applied to this object. Tags are for organizational purposes only.\n","example":["example tag","another example"],"items":{"type":"string"},"type":"array","x-linode-filterable":true},"transfer":{"description":"Information about the amount of transfer this NodeBalancer has had so far this month.\n","properties":{"in":{"description":"The total outbound transfer, in MB, used for this NodeBalancer this month.\n","example":28.91200828552246,"nullable":true,"readOnly":true,"type":"number"},"out":{"description":"The total inbound transfer, in MB, used for this NodeBalancer this month.\n","example":3.5487728118896484,"nullable":true,"readOnly":true,"type":"number"},"total":{"description":"The total transfer, in MB, used by this NodeBalancer this month.\n","example":32.46078109741211,"nullable":true,"readOnly":true,"type":"number"}},"readOnly":true,"type":"object"},"updated":{"description":"When this NodeBalancer was last updated.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"NodeBalancerConfig":{"description":"A NodeBalancer config represents the configuration of this NodeBalancer on a single port. For example, a NodeBalancer Config on port 80 would typically represent how this NodeBalancer response to HTTP requests.\n\nNodeBalancer configs have a list of backends, called \"nodes,\" that they forward requests between based on their configuration.\n","properties":{"algorithm":{"default":"roundrobin","description":"What algorithm this NodeBalancer should use for routing traffic to backends.\n","enum":["roundrobin","leastconn","source"],"example":"roundrobin","type":"string","x-linode-cli-display":4},"check":{"default":"none","description":"The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down.\n* If `none` no check is performed.\n* `connection` requires only a connection to the backend to succeed.\n* `http` and `http_body` rely on the backend serving HTTP, and that\n the response returned matches what is expected.\n","enum":["none","connection","http","http_body"],"example":"http_body","type":"string"},"check_attempts":{"default":3,"description":"How many times to attempt a check before considering a backend to be down.\n","example":3,"maximum":30,"minimum":1,"type":"integer"},"check_body":{"description":"This value must be present in the response body of the check in order for it to pass. If this value is not present in the response body of a check request, the backend is considered to be down.\n","example":"it works","type":"string"},"check_interval":{"default":31,"description":"How often, in seconds, to check that backends are up and serving requests.\n\nMust be greater than `check_timeout`.\n","example":90,"type":"integer"},"check_passive":{"default":true,"description":"If true, any response from this backend with a `5xx` status code will be enough for it to be considered unhealthy and taken out of rotation.\n","example":true,"type":"boolean","x-linode-cli-display":6},"check_path":{"description":"The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.\n","example":"/test","pattern":"^[a-zA-Z0-9\\/\\-%?&=.]*$","type":"string"},"check_timeout":{"default":30,"description":"How long, in seconds, to wait for a check attempt before considering it failed.\n\nMust be less than `check_interval`.\n","example":10,"maximum":30,"minimum":1,"type":"integer"},"cipher_suite":{"default":"recommended","description":"What ciphers to use for SSL connections served by this NodeBalancer.\n\n* `legacy` is considered insecure and should only be used if necessary.\n","enum":["recommended","legacy"],"example":"recommended","type":"string","x-linode-cli-color":{"default_":"white","legacy":"red"},"x-linode-cli-display":7},"id":{"description":"This config's unique ID","example":4567,"readOnly":true,"type":"integer","x-linode-cli-display":1},"nodebalancer_id":{"description":"The ID for the NodeBalancer this config belongs to.\n","example":12345,"readOnly":true,"type":"integer"},"nodes_status":{"description":"A structure containing information about the health of the backends for this port. This information is updated periodically as checks are performed against backends.\n","properties":{"down":{"description":"The number of backends considered to be \"DOWN\" and unhealthy. These are not in rotation, and not serving requests.\n","example":0,"readOnly":true,"type":"integer"},"up":{"description":"The number of backends considered to be \"UP\" and healthy, and that are serving requests.\n","example":4,"readOnly":true,"type":"integer"}},"readOnly":true,"type":"object","x-linode-cli-display":10},"port":{"default":80,"description":"The port this Config is for. These values must be unique across configs on a single NodeBalancer (you can't have two configs for port 80, for example). While some ports imply some protocols, no enforcement is done and you may configure your NodeBalancer however is useful to you. For example, while port 443 is generally used for HTTPS, you do not need SSL configured to have a NodeBalancer listening on port 443.\n","example":80,"maximum":65535,"minimum":1,"type":"integer","x-linode-cli-display":2},"protocol":{"default":"http","description":"The protocol this port is configured to serve.\n\n* The `http` and `tcp` protocols do not support `ssl_cert` and `ssl_key`.\n\n* The `https` protocol is mutually required with `ssl_cert` and `ssl_key`.\n\nReview our guide on [Available Protocols](/docs/products/networking/nodebalancers/guides/protocols/) for information on protocol features.\n","enum":["http","https","tcp"],"example":"http","type":"string","x-linode-cli-display":3},"proxy_protocol":{"default":"none","description":"ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices. This information would be lost otherwise. Backend devices must be configured to work with ProxyProtocol if enabled.\n\n* If ommited, or set to `none`, the NodeBalancer doesn't send any auxilary data over TCP connections. This is the default.\n* If set to `v1`, the human-readable header format (Version 1) is used. Requires `tcp` protocol.\n* If set to `v2`, the binary header format (Version 2) is used. Requires `tcp` protocol.\n","enum":["none","v1","v2"],"example":"none","type":"string"},"ssl_cert":{"description":"The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL\ncertificate and Certificate Authority chain) that should be served on this\nNodeBalancerConfig's port.\n\nLine breaks must be represented as \"\\n\" in the string for requests (but not when using the Linode CLI).\n\n[Diffie-Hellman Parameters](/docs/products/networking/nodebalancers/guides/ssl-termination/#diffie-hellman-parameters) can be included in this value to enable forward secrecy.\n\nThe contents of this field will not be shown in any responses that display\nthe NodeBalancerConfig. Instead, `` will be printed where the field\nappears.\n\nThe read-only `ssl_commonname` and `ssl_fingerprint` fields in a NodeBalancerConfig\nresponse are automatically derived from your certificate. Please refer to these fields to\nverify that the appropriate certificate was assigned to your NodeBalancerConfig.\n","example":"","format":"ssl-cert","nullable":true,"type":"string"},"ssl_commonname":{"description":"The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.\n","example":"www.example.com","readOnly":true,"type":"string","x-linode-cli-display":8},"ssl_fingerprint":{"description":"The read-only SHA1-encoded fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.\n","example":"00:01:02:03:04:05:06:07:08:09:0A:0B:0C:0D:0E:0F:10:11:12:13","readOnly":true,"type":"string","x-linode-cli-display":9},"ssl_key":{"description":"The PEM-formatted private key for the SSL certificate set in the `ssl_cert` field.\n\nLine breaks must be represented as \"\\n\" in the string for requests (but not when using the Linode CLI).\n\nThe contents of this field will not be shown in any responses that display\nthe NodeBalancerConfig. Instead, `` will be printed where the field\nappears.\n\nThe read-only `ssl_commonname` and `ssl_fingerprint` fields in a NodeBalancerConfig\nresponse are automatically derived from your certificate. Please refer to these fields to\nverify that the appropriate certificate was assigned to your NodeBalancerConfig.\n","example":"","format":"ssl-key","nullable":true,"type":"string"},"stickiness":{"default":"none","description":"Controls how session stickiness is handled on this port.\n* If set to `none` connections will always be assigned a backend based on the algorithm configured.\n* If set to `table` sessions from the same remote address will be routed to the same\n backend.\n\n* For HTTP or HTTPS clients, `http_cookie` allows sessions to be\n routed to the same backend based on a cookie set by the NodeBalancer.\n","enum":["none","table","http_cookie"],"example":"http_cookie","type":"string","x-linode-cli-display":5}},"type":"object"},"NodeBalancerNode":{"description":"A NodeBalancerNode represents a single backend serving requests for a single port of a NodeBalancer. Nodes are specific to NodeBalancer Configs, and serve traffic over their private IP. If the same Linode is serving traffic for more than one port on the same NodeBalancer, one NodeBalancer Node is required for each config (port) it should serve requests on. For example, if you have four backends, and each should response to both HTTP and HTTPS requests, you will need two NodeBalancerConfigs (port 80 and port 443) and four backends each - one for each of the Linodes serving requests for that port.\n","properties":{"address":{"description":"The private IP Address where this backend can be reached. This _must_ be a private IP address.\n","example":"192.168.210.120:80","format":"ip","type":"string","x-linode-cli-display":3},"config_id":{"description":"The NodeBalancer Config ID that this Node belongs to.\n","example":4567,"readOnly":true,"type":"integer"},"id":{"description":"This node's unique ID.","example":54321,"readOnly":true,"type":"integer","x-linode-cli-display":1},"label":{"description":"The label for this node. This is for display purposes only.\n","example":"node54321","maxLength":32,"minLength":3,"pattern":"[a-zA-Z0-9-_.]{3,32}","type":"string","x-linode-cli-display":2},"mode":{"description":"The mode this NodeBalancer should use when sending traffic to this backend.\n* If set to `accept` this backend is accepting traffic.\n* If set to `reject` this backend will not receive traffic.\n* If set to `drain` this backend will not receive _new_ traffic, but connections already\n pinned to it will continue to be routed to it.\n\n* If set to `backup`, this backend will only receive traffic if all `accept` nodes\n are down.\n","enum":["accept","reject","drain","backup"],"example":"accept","type":"string","x-linode-cli-display":6},"nodebalancer_id":{"description":"The NodeBalancer ID that this Node belongs to.\n","example":12345,"readOnly":true,"type":"integer"},"status":{"description":"The current status of this node, based on the configured checks of its NodeBalancer Config.\n","enum":["unknown","UP","DOWN"],"example":"UP","readOnly":true,"type":"string","x-linode-cli-color":{"DOWN":"red","UP":"green","default_":"white","unknown":"yellow"},"x-linode-cli-display":4},"weight":{"description":"Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic.\n","example":50,"maximum":255,"minimum":1,"type":"integer","x-linode-cli-display":5}},"type":"object"},"NodeBalancerStats":{"description":"Stats for this NodeBalancer.\n","properties":{"data":{"description":"The data returned about this NodeBalancers.\n","properties":{"connections":{"description":"An array of key/value pairs representing unix timestamp and reading for connections to this NodeBalancer.\n","items":{"example":[1526391300000,0],"type":"number"},"type":"array"},"traffic":{"description":"Traffic statistics for this NodeBalancer.\n","properties":{"in":{"description":"An array of key/value pairs representing unix timestamp and reading for inbound traffic.\n","items":{"example":[1526391300000,631.21],"type":"number"},"type":"array"},"out":{"description":"An array of key/value pairs representing unix timestamp and reading for outbound traffic.\n","items":{"example":[1526391300000,103.44],"type":"number"},"type":"array"}},"type":"object"}},"type":"object"},"title":{"description":"The title for the statistics generated in this response.\n","example":"linode.com - balancer12345 (12345) - day (5 min avg)","type":"string"}},"type":"object"},"Notification":{"description":"An important, often time-sensitive item related to your Account.\n","properties":{"body":{"description":"A full description of this Notification, in markdown format. Not all Notifications include bodies.\n","example":null,"nullable":true,"readOnly":true,"type":"string"},"entity":{"description":"Detailed information about the Notification.","properties":{"id":{"description":"The unique ID of the Notification's entity, based on the entity type.\n","example":3456,"type":"integer"},"label":{"description":"The current label for this Notification's entity.\n","example":"Linode not booting.","type":"string"},"type":{"description":"The type of entity this is related to.","example":"ticket","type":"string"},"url":{"description":"The URL where you can access the object this Notification is for. If a relative URL, it is relative to the domain you retrieved the Notification from.\n","example":"/support/tickets/3456","type":"string"}},"readOnly":true,"type":"object"},"label":{"description":"A short description of this Notification.\n","example":"You have an important ticket open!","readOnly":true,"type":"string","x-linode-cli-display":1},"message":{"description":"A human-readable description of the Notification.","example":"You have an important ticket open!","readOnly":true,"type":"string","x-linode-cli-display":2},"severity":{"description":"The severity of this Notification. This field can be used to decide how prominently to display the Notification, what color to make the display text, etc.\n","enum":["minor","major","critical"],"example":"major","readOnly":true,"type":"string","x-linode-cli-color":{"critical":"b","default_":"white","minor":"blue"},"x-linode-cli-display":3},"type":{"description":"The type of Notification this is.","enum":["migration_scheduled","migration_imminent","migration_pending","reboot_scheduled","outage","payment_due","ticket_important","ticket_abuse","notice","maintenance","promotion"],"example":"ticket_important","readOnly":true,"type":"string"},"until":{"description":"If this Notification has a duration, this will be the ending time for the Event/action. For example, if there is scheduled maintenance for one of our systems, `until` would be set to the end of the maintenance window.\n","example":null,"format":"date-time","readOnly":true,"type":"string","x-linode-cli-color":{"None":"black","default_":"white"},"x-linode-cli-display":5},"when":{"description":"If this Notification is of an Event that will happen at a fixed, future time, this is when the named action will be taken. For example, if a Linode is to be migrated in response to a Security Advisory, this field will contain the approximate time the Linode will be taken offline for migration.\n","example":null,"format":"date-time","readOnly":true,"type":"string","x-linode-cli-color":{"None":"black","default_":"white"},"x-linode-cli-display":4}},"type":"object"},"OAuthClient":{"description":"A third-party application registered to Linode that users may log into with their Linode account through our authentication server at https://login.linode.com. Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application.\n","properties":{"id":{"description":"The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).\n","example":"2737bf16b39ab5d7b4a1","readOnly":true,"type":"string","x-linode-cli-display":1},"label":{"description":"The name of this application. This will be presented to users when they are asked to grant it access to their Account.\n","example":"Test_Client_1","maxLength":512,"minLength":1,"type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"public":{"default":false,"description":"If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the OAuth spec for more details.\n","example":false,"type":"boolean","x-linode-cli-display":4,"x-linode-filterable":true},"redirect_uri":{"description":"The location a successful log in from https://login.linode.com should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.\n","example":"https://example.org/oauth/callback","format":"url","type":"string","x-linode-cli-display":5},"secret":{"description":"The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.\n","example":"","readOnly":true,"type":"string"},"status":{"description":"The status of this application. `active` by default.\n","enum":["active","disabled","suspended"],"example":"active","readOnly":true,"type":"string","x-linode-cli-color":{"default_":"white","suspended":"red"},"x-linode-cli-display":3},"thumbnail_url":{"description":"The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.\n","example":"https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail","format":"url","nullable":true,"readOnly":true,"type":"string"}},"type":"object"},"ObjectStorageBucket":{"description":"An Object Storage Bucket. This should be accessed primarily through the S3 API; [click here for more information](https://docs.ceph.com/en/latest/radosgw/s3/#api).\n","properties":{"cluster":{"description":"The ID of the Object Storage Cluster this bucket is in.","example":"us-east-1","type":"string"},"created":{"description":"When this bucket was created.","example":"2025-08-15T13:51:51.403Z","format":"date-time","type":"string"},"hostname":{"description":"The hostname where this bucket can be accessed. This hostname can be accessed through a browser if the bucket is made public.\n","example":"example-bucket.us-east-1.linodeobjects.com","type":"string"},"label":{"description":"The name of this bucket.","example":"example-bucket","type":"string"},"objects":{"description":"The number of objects stored in this bucket.\n","example":4,"type":"integer"},"size":{"description":"The size of the bucket in bytes.","example":188318981,"type":"integer"}},"type":"object"},"ObjectStorageCluster":{"description":"An Object Storage Cluster","properties":{"domain":{"description":"The base URL for this cluster, used for connecting with third-party clients.","example":"us-east-1.linodeobjects.com","type":"string"},"id":{"description":"The unique ID for this cluster.","example":"us-east-1","type":"string"},"region":{"description":"The region where this cluster is located.","example":"us-east","type":"string"},"static_site_domain":{"description":"The base URL for this cluster used when hosting static sites.","example":"website-us-east-1.linodeobjects.com","type":"string"},"status":{"description":"This cluster's status.","enum":["available","unavailable"],"example":"available","type":"string"}},"type":"object"},"ObjectStorageKey":{"description":"A keypair used to communicate with the Object Storage S3 API.","properties":{"access_key":{"description":"This keypair's access key. This is not secret.","example":"KVAKUTGBA4WTR2NSJQ81","readOnly":true,"type":"string"},"bucket_access":{"description":"Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key's access to only the bucket(s) declared in this array and define their bucket-level permissions.\n\n\n Limited Access Keys can:\n\n * [list all buckets](/docs/api/object-storage/#object-storage-buckets-list) available on this Account, but cannot perform any actions on a bucket unless it has access to the bucket.\n\n\n * [create new buckets](/docs/api/object-storage/#object-storage-bucket-create), but do not have any access to the buckets it creates, unless explicitly given access to them.\n\n\n **Note:** You can create an Object Storage Limited Access Key without access to any buckets.\n This is achieved by sending a request with an empty `bucket_access` array.\n\n\n **Note:** If this field is omitted, a regular unlimited access key is issued.\n","items":{"properties":{"bucket_name":{"description":"The unique label of the bucket to which the key will grant limited access.","example":"example-bucket","type":"string"},"cluster":{"description":"The Object Storage cluster where a bucket to which the key is granting access is hosted.","example":"ap-south-1","type":"string"},"permissions":{"description":"This Limited Access Key's permissions for the selected bucket.","enum":["read_write","read_only"],"example":"read_only","type":"string"}},"type":"object"},"type":"array"},"id":{"description":"This keypair's unique ID","example":123,"readOnly":true,"type":"integer"},"label":{"description":"The label given to this key. For display purposes only.","example":"my-key","type":"string"},"limited":{"description":"Whether or not this key is a limited access key. Will return `false` if this key grants full access to all buckets on the user's account.","example":true,"readOnly":true,"type":"boolean"},"secret_key":{"description":"This keypair's secret key. Only returned on key creation.","example":"OiA6F5r0niLs3QA2stbyq7mY5VCV7KqOzcmitmHw","readOnly":true,"type":"string"}},"type":"object"},"ObjectStorageObject":{"description":"An Object in Object Storage, or a \"prefix\" that contains one or more objects when a `delimiter` is used.\n","properties":{"etag":{"description":"An MD-5 hash of the object. `null` if this object represents a prefix.\n","example":"9f254c71e28e033bf9e0e5262e3e72ab","type":"string"},"is_truncated":{"description":"Designates if there is another page of bucket objects.","example":true,"type":"boolean"},"last_modified":{"description":"The date and time this object was last modified. `null` if this object represents a prefix.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","type":"string"},"name":{"description":"The name of this object or prefix.\n","example":"example","type":"string"},"next_marker":{"description":"Returns the value you should pass to the `marker` query parameter to get the next page of objects. If there is no next page, `null` will be returned.\n","example":"bd021c21-e734-4823-97a4-58b41c2cd4c8.892602.184","nullable":true,"type":"string"},"owner":{"description":"The owner of this object, as a UUID. `null` if this object represents a prefix.\n","example":"bfc70ab2-e3d4-42a4-ad55-83921822270c","type":"string"},"size":{"description":"The size of this object, in bytes. `null` if this object represents a prefix.\n","example":123,"type":"integer"}},"type":"object"},"ObjectStorageSSL":{"description":"Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS.\n","properties":{"certificate":{"description":"Your Base64 encoded and PEM formatted SSL certificate.\n\nLine breaks must be represented as \"\\n\" in the string for requests (but not when using the Linode CLI)\n","example":"-----BEGIN CERTIFICATE-----\nCERTIFICATE_INFORMATION\n-----END CERTIFICATE-----","type":"string"},"private_key":{"description":"The private key associated with this TLS/SSL certificate.\n\nLine breaks must be represented as \"\\n\" in the string for requests (but not when using the Linode CLI)\n","example":"-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY_INFORMATION\n-----END PRIVATE KEY-----","type":"string"}},"required":["certificate","private_key"],"type":"object"},"ObjectStorageSSLResponse":{"description":"If this Object Storage bucket has a corresponding TLS/SSL Certificate.\n","properties":{"ssl":{"description":"A boolean indicating if this Bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user.\n","example":true,"readOnly":true,"type":"boolean"}},"type":"object"},"PaginationEnvelope":{"description":"An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](/docs/api/#pagination) for more information.\n","properties":{"page":{"description":"The current [page](/docs/api/#pagination).","example":1,"readOnly":true,"type":"integer"},"pages":{"description":"The total number of [pages](/docs/api/#pagination).","example":1,"readOnly":true,"type":"integer"},"results":{"description":"The total number of results.","example":1,"readOnly":true,"type":"integer"}},"type":"object"},"PayPal":{"description":"An object representing the staging of a Payment via PayPal.\n","properties":{"cancel_url":{"description":"The URL to have PayPal redirect to when Payment is cancelled.","example":"https://example.org","type":"string"},"redirect_url":{"description":"The URL to have PayPal redirect to when Payment is approved.","example":"https://example.org","type":"string"},"usd":{"description":"The payment amount in USD. Minimum accepted value of $5 USD. Maximum accepted value of $500 USD or credit card payment limit; whichever value is highest. PayPal's maximum transaction limit is $10,000 USD.","example":"120.50","type":"string"}},"required":["cancel_url","redirect_url","usd"],"type":"object"},"PayPalData":{"description":"PayPal information.","properties":{"email":{"description":"The email address associated with your PayPal account.","example":"example@linode.com","readOnly":true,"type":"string"},"paypal_id":{"description":"PayPal Merchant ID associated with your PayPal account.","example":"ABC1234567890","readOnly":true,"type":"string"}},"type":"object"},"PayPalExecute":{"description":"An object representing an execution of Payment to PayPal to capture the funds and credit your Linode Account.\n","properties":{"payer_id":{"description":"The PayerID returned by PayPal during the transaction authorization process.\n","example":"ABCDEFGHIJKLM","type":"string"},"payment_id":{"description":"The PaymentID returned from [POST /account/payments/paypal](/docs/api/account/#paypal-payment-stage) that has been approved with PayPal.\n","example":"PAY-1234567890ABCDEFGHIJKLMN","type":"string"}},"required":["payer_id","payment_id"],"type":"object"},"Payment":{"description":"Payment object response.","properties":{"date":{"description":"When the Payment was made.","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":2},"id":{"description":"The unique ID of the Payment.","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":1},"usd":{"description":"The amount, in US dollars, of the Payment.","example":"120.50","readOnly":true,"type":"integer","x-linode-cli-display":3}},"type":"object"},"PaymentMethod":{"description":"Payment Method Response Object.","properties":{"created":{"description":"When the Payment Method was added to the Account.","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string"},"data":{"discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/CreditCardData","x-linode-ref-name":"Credit Card"},{"$ref":"#/components/schemas/GooglePayData","x-linode-ref-name":"Google Pay"},{"$ref":"#/components/schemas/PayPalData","x-linode-ref-name":"Paypal"}],"x-linode-cli-display":4,"x-linode-cli-format":"json"},"id":{"description":"The unique ID of this Payment Method.","example":123,"type":"integer","x-linode-cli-display":1},"is_default":{"description":"Whether this Payment Method is the default method for automatically processing service charges.\n","example":true,"type":"boolean","x-linode-cli-display":3},"type":{"description":"The type of Payment Method.","enum":["credit_card","google_pay","paypal"],"example":"credit_card","type":"string","x-linode-cli-display":2}},"type":"object"},"PaymentRequest":{"description":"Payment object request.","properties":{"cvv":{"description":"CVV (Card Verification Value) of the credit card to be used for the Payment. Required if paying by credit card.\n","example":"123","type":"string"},"payment_method_id":{"description":"The ID of the Payment Method to apply to the Payment.\n","example":123,"type":"integer"},"usd":{"description":"The amount in US Dollars of the Payment.\n\n* Can begin with or without `$`.\n* Commas (`,`) are not accepted.\n* Must end with a decimal expression, such as `.00` or `.99`.\n* Minimum: `$5.00` or the Account balance, whichever is lower.\n* Maximum: `$2000.00` or the Account balance up to `$50000.00`, whichever is greater.\n","example":"$120.50","pattern":"^\\$?\\d+\\.\\d{2}$","type":"string"}},"required":["usd"],"type":"object"},"PersonalAccessToken":{"description":"A Personal Access Token is a token generated manually to access the API without going through an OAuth login. Personal Access Tokens can have scopes just like OAuth tokens do, and are commonly used to give access to command-line tools like the Linode CLI, or when writing your own integrations.\n","properties":{"created":{"description":"The date and time this token was created.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":4,"x-linode-filterable":true},"expiry":{"description":"When this token will expire. Personal Access Tokens cannot be renewed, so after this time the token will be completely unusable and a new token will need to be generated. Tokens may be created with \"null\" as their expiry and will never expire unless revoked.\n","example":"2025-08-15T13:51:51.403Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":6},"id":{"description":"This token's unique ID, which can be used to revoke it.\n","example":123,"readOnly":true,"type":"integer","x-linode-cli-display":1},"label":{"description":"This token's label. This is for display purposes only, but can be used to more easily track what you're using each token for.\n","example":"linode-cli","maxLength":100,"minLength":1,"type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"scopes":{"description":"The scopes this token was created with. These define what parts of the Account the token can be used to access. Many command-line tools, such as the Linode CLI, require tokens with access to `*`. Tokens with more restrictive scopes are generally more secure.\n","example":"*","format":"oauth-scopes","readOnly":true,"type":"string","x-linode-cli-display":3},"token":{"description":"The token used to access the API. When the token is created, the full token is returned here. Otherwise, only the first 16 characters are returned.\n","example":"abcdefghijklmnop","readOnly":true,"type":"string","x-linode-cli-display":5}},"type":"object"},"Profile":{"description":"A Profile represents your User in our system. This is where you can change information about your User. This information is available to any OAuth Client regardless of requested scopes, and can be used to populate User information in third-party applications.\n","properties":{"authentication_type":{"description":"This account's Cloud Manager authentication type. Authentication types are chosen through\nCloud Manager and authorized when logging into your account. These authentication types are either\nthe user's password (in conjunction with their username), or the name of their\nindentity provider such as GitHub. For example, if a user:\n\n- Has never used Third-Party Authentication, their authentication type will be `password`.\n- Is using Third-Party Authentication, their authentication type will be the name of their Identity Provider (eg. `github`).\n- Has used Third-Party Authentication and has since revoked it, their authentication type will be `password`.\n\n\n**Note:** This functionality may not yet be available in Cloud Manager.\nSee the [Cloud Manager Changelog](/changelog/cloud-manager/) for the latest updates.\n","enum":["password","github"],"example":"password","readOnly":true,"type":"string"},"authorized_keys":{"description":"The list of SSH Keys authorized to use Lish for your User. This value is ignored if `lish_auth_method` is \"disabled.\"\n","example":null,"items":{"format":"ssh-key","type":"string"},"nullable":true,"type":"array"},"email":{"description":"Your email address. This address will be used for communication with Linode as necessary.\n","example":"example-user@gmail.com","format":"email","type":"string","x-linode-cli-display":2},"email_notifications":{"description":"If true, you will receive email notifications about account activity. If false, you may still receive business-critical communications through email.\n","example":true,"type":"boolean"},"ip_whitelist_enabled":{"deprecated":true,"description":"If true, logins for your User will only be allowed from whitelisted IPs. This setting is currently deprecated, and cannot be enabled.\n\nIf you disable this setting, you will not be able to re-enable it.\n","example":false,"type":"boolean"},"lish_auth_method":{"description":"The authentication methods that are allowed when connecting to [the Linode Shell (Lish)](/docs/guides/lish/).\n* `keys_only` is the most secure if you intend to use Lish.\n* `disabled` is recommended if you do not intend to use Lish at all.\n* If this account's Cloud Manager authentication type is set to a Third-Party Authentication method, `password_keys` cannot be used as your Lish authentication method. To view this account's Cloud Manager `authentication_type` field, send a request to the [View Profile](/docs/api/profile/#profile-view) endpoint.\n","enum":["password_keys","keys_only","disabled"],"example":"keys_only","type":"string"},"referrals":{"description":"Information about your status in our referral program.\n\nThis information becomes accessible after this Profile's Account has established at least $25.00 USD of total payments.\n","properties":{"code":{"description":"Your referral code. If others use this when signing up for Linode, you will receive account credit.\n","example":"871be32f49c1411b14f29f618aaf0c14637fb8d3","readOnly":true,"type":"string"},"completed":{"description":"The number of completed signups with your referral code.\n","example":0,"readOnly":true,"type":"integer"},"credit":{"description":"The amount of account credit in US Dollars issued to you through the referral program.\n","example":0,"readOnly":true,"type":"integer"},"pending":{"description":"The number of pending signups with your referral code. You will not receive credit for these signups until they are completed.\n","example":0,"readOnly":true,"type":"integer"},"total":{"description":"The number of users who have signed up with your referral code.\n","example":0,"readOnly":true,"type":"integer"},"url":{"description":"Your referral url, used to direct others to sign up for Linode with your referral code.\n","example":"https://www.linode.com/?r=871be32f49c1411b14f29f618aaf0c14637fb8d3","format":"url","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"restricted":{"description":"If true, your User has restrictions on what can be accessed on your Account. To get details on what entities/actions you can access/perform, see [/profile/grants](/docs/api/profile/#grants-list).\n","example":false,"type":"boolean","x-linode-cli-display":3},"timezone":{"description":"The timezone you prefer to see times in. This is not used by the API directly. It is provided for the benefit of clients such as the Linode Cloud Manager and other clients built on the API. All times returned by the API are in UTC.\n","example":"US/Eastern","type":"string"},"two_factor_auth":{"description":"If true, logins from untrusted computers will require Two Factor Authentication. See [/profile/tfa-enable](/docs/api/profile/#two-factor-secret-create) to enable Two Factor Authentication.\n","example":true,"type":"boolean","x-linode-cli-display":4},"uid":{"description":"Your unique ID in our system. This value will never change, and can safely be used to identify your User.\n","example":1234,"readOnly":true,"type":"integer"},"username":{"description":"Your username, used for logging in to our system.\n","example":"exampleUser","readOnly":true,"type":"string","x-linode-cli-display":1},"verified_phone_number":{"description":"The phone number verified for this Profile with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.\n\n`null` if this Profile has no verified phone number.\n","example":"+5555555555","format":"phone","readOnly":true,"type":"string"}},"type":"object"},"Promotion":{"description":"Promotions generally\noffer a set amount of credit that can be used toward your Linode\nservices, and the promotion expires after a specified date. As well,\na monthly cap on the promotional offer is set.\n\nSimply put, a promotion offers a certain amount of credit every\nmonth, until either the expiration date is passed, or until the total\npromotional credit is used, whichever comes first.\n","properties":{"credit_monthly_cap":{"description":"The amount available to spend per month.\n","example":"10.00","type":"string","x-linode-cli-display":5},"credit_remaining":{"description":"The total amount of credit left for this promotion.\n","example":"50.00","type":"string","x-linode-cli-display":3},"description":{"description":"A detailed description of this promotion.\n","example":"Receive up to $10 off your services every month for 6 months! Unused credits will expire once this promotion period ends.","type":"string"},"expire_dt":{"description":"When this promotion's credits expire.\n","example":"2025-08-15T13:51:51.404Z","type":"string","x-linode-cli-display":2},"image_url":{"description":"The location of an image for this promotion.\n","example":"https://linode.com/10_a_month_promotion.svg","type":"string"},"service_type":{"description":"The service to which this promotion applies.\n","enum":["all","backup","blockstorage","db_mysql","ip_v4","linode","linode_disk","linode_memory","longview","managed","nodebalancer","objectstorage","transfer_tx"],"example":"all","type":"string","x-linode-cli-display":1},"summary":{"description":"Short details of this promotion.\n","example":"$10 off your Linode a month!","type":"string","x-linode-cli-display":10},"this_month_credit_remaining":{"description":"The amount of credit left for this month for this promotion.\n","example":"10.00","type":"string","x-linode-cli-display":4}},"readOnly":true,"type":"object"},"Region":{"description":"An area where Linode services are available.","properties":{"capabilities":{"description":"A list of capabilities of this region.\n","example":["Linodes","NodeBalancers","Block Storage","Object Storage"],"items":{"type":"string"},"readOnly":true,"type":"array","x-linode-cli-display":4},"country":{"description":"The country where this Region resides.","example":"us","readOnly":true,"type":"string","x-linode-cli-display":3},"id":{"description":"The unique ID of this Region.","example":"us-east","readOnly":true,"type":"string","x-linode-cli-display":1},"label":{"description":"Detailed location information for this Region, including city, state or region, and country.","example":"Newark, NJ, USA","readOnly":true,"type":"string","x-linode-cli-display":2},"resolvers":{"properties":{"ipv4":{"description":"The IPv4 addresses for this region's DNS resolvers, separated by commas.\n","example":"192.0.2.0,192.0.2.1","readOnly":true,"type":"string"},"ipv6":{"description":"The IPv6 addresses for this region's DNS resolvers, separated by commas.\n","example":"2001:0db8::,2001:0db8::1","readOnly":true,"type":"string"}},"readOnly":true,"type":"object","x-linode-cli-display":6},"status":{"description":"This region's current operational status.\n","enum":["ok","outage"],"example":"ok","readOnly":true,"type":"string","x-linode-cli-display":5}},"type":"object"},"RescueDevices":{"properties":{"sda":{"$ref":"#/components/schemas/Device"},"sdb":{"$ref":"#/components/schemas/Device"},"sdc":{"$ref":"#/components/schemas/Device"},"sdd":{"$ref":"#/components/schemas/Device"},"sde":{"$ref":"#/components/schemas/Device"},"sdf":{"$ref":"#/components/schemas/Device"},"sdg":{"$ref":"#/components/schemas/Device"}},"type":"object"},"SSHKey":{"description":"A credential object for authenticating a User's secure shell connection to a Linode.\n","properties":{"created":{"description":"The date this key was added.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an SSH Key object.\n","example":42,"readOnly":true,"type":"integer"},"label":{"description":"A label for the SSH Key.\n","example":"My SSH Key","maxLength":64,"minLength":0,"type":"string"},"ssh_key":{"description":"The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy.\n\nAccepted formats:\n* ssh-dss\n* ssh-rsa\n* ecdsa-sha2-nistp\n* ssh-ed25519\n* sk-ecdsa-sha2-nistp256 (Akamai-specific)\n","example":"ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer","format":"ssh-key","type":"string"}},"type":"object"},"SecurityQuestion":{"description":"Single security question and response object.","properties":{"id":{"description":"The ID representing the security question.","example":1,"type":"integer"},"question":{"description":"The security question.","example":"In what city were you born?","readOnly":true,"type":"string"},"response":{"description":"The security question response.\n","example":"Gotham City","maxLength":17,"minLength":3,"type":"string"}},"type":"object"},"SecurityQuestionsGet":{"description":"Security questions and responses object for GET operation.","properties":{"security_questions":{"items":{"description":"Single security question and response object for GET operation.","properties":{"id":{"$ref":"#/components/schemas/SecurityQuestion/properties/id"},"question":{"$ref":"#/components/schemas/SecurityQuestion/properties/question"},"response":{"$ref":"#/components/schemas/SecurityQuestion/properties/response"}},"type":"object"},"type":"array"}},"type":"object"},"SecurityQuestionsPost":{"description":"Security questions and responses object for POST operation.","properties":{"security_questions":{"items":{"description":"Single security question and response object for POST operation.","properties":{"question_id":{"$ref":"#/components/schemas/SecurityQuestion/properties/id"},"response":{"$ref":"#/components/schemas/SecurityQuestion/properties/response"},"security_question":{"$ref":"#/components/schemas/SecurityQuestion/properties/question"}},"type":"object"},"type":"array"}},"type":"object"},"ServiceTransfer":{"description":"An object representing a Service Transfer.\n","properties":{"created":{"description":"When this transfer was created.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","type":"string"},"entities":{"description":"A collection of the services to include in this transfer request, separated by type.\n","properties":{"linodes":{"description":"An array containing the IDs of each of the Linodes included in this transfer.\n","example":[111,222],"items":{"type":"integer"},"type":"array","x-linode-cli-display":5}},"type":"object"},"expiry":{"description":"When this transfer expires. Transfers will automatically expire 24 hours after creation.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","type":"string","x-linode-cli-display":3},"is_sender":{"description":"If the requesting account created this transfer.\n","example":true,"type":"boolean","x-linode-cli-display":4,"x-linode-filterable":true},"status":{"description":"The status of the transfer request.\n\n`accepted`: The transfer has been accepted by another user and is currently in progress.\nTransfers can take up to 3 hours to complete.\n\n`cancelled`: The transfer has been cancelled by the sender.\n\n`completed`: The transfer has completed successfully.\n\n`failed`: The transfer has failed after initiation.\n\n`pending`: The transfer is ready to be accepted.\n\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or\ncancelled.\n","enum":["accepted","cancelled","completed","failed","pending","stale"],"example":"pending","type":"string","x-linode-cli-color":{"accepted":"yellow","cancelled":"red","completed":"green","default_":"white","failed":"red","pending":"yellow","stale":"red"},"x-linode-cli-display":2,"x-linode-filterable":true},"token":{"description":"The token used to identify and accept or cancel this transfer.\n","example":"123E4567-E89B-12D3-A456-426614174000","format":"uuid","type":"string","x-linode-cli-display":1},"updated":{"description":"When this transfer was last updated.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","type":"string"}},"type":"object"},"StackScript":{"description":"A StackScript enables you to quickly deploy a fully-configured application in an automated manner.\n","properties":{"created":{"description":"The date this StackScript was created.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":6},"deployments_active":{"description":"Count of currently active, deployed Linodes created from this StackScript.\n","example":1,"readOnly":true,"type":"integer"},"deployments_total":{"description":"The total number of times this StackScript has been deployed.\n","example":12,"readOnly":true,"type":"integer","x-linode-filterable":true},"description":{"description":"A description for the StackScript.\n","example":"This StackScript installs and configures MySQL\n","type":"string","x-linode-filterable":true},"id":{"description":"The unique ID of this StackScript.","example":10079,"readOnly":true,"type":"integer","x-linode-cli-display":1},"images":{"description":"An array of Image IDs. These are the Images that can be deployed with this StackScript.\n\n`any/all` indicates that all available Images, including private Images, are accepted.\n","example":["linode/debian9","linode/debian8"],"items":{"type":"string"},"type":"array","x-linode-cli-display":4},"is_public":{"description":"This determines whether other users can use your StackScript. **Once a StackScript is made public, it cannot be made private.**\n","example":true,"type":"boolean","x-linode-cli-display":5,"x-linode-filterable":true},"label":{"description":"The StackScript's label is for display purposes only.\n","example":"a-stackscript","maxLength":128,"minLength":3,"type":"string","x-linode-cli-display":3,"x-linode-filterable":true},"mine":{"description":"Returns `true` if this StackScript is owned by the account of the user making the request, and the user\nmaking the request is unrestricted or has access to this StackScript.\n","example":true,"readOnly":true,"type":"boolean","x-linode-filterable":true},"rev_note":{"description":"This field allows you to add notes for the set of revisions made to this StackScript.\n","example":"Set up MySQL","type":"string","x-linode-filterable":true},"script":{"description":"The script to execute when provisioning a new Linode with this StackScript.\n","example":"\"#!/bin/bash\"\n","type":"string","x-linode-cli-format":"file"},"updated":{"description":"The date this StackScript was last updated.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":7},"user_defined_fields":{"description":"This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment. See [Declare User-Defined Fields (UDFs)](/docs/products/tools/stackscripts/guides/write-a-custom-script/#declare-user-defined-fields-udfs) for more information.\n","example":{"example":"hunter2","label":"Enter the DB password","name":"DB_PASSWORD"},"items":{"$ref":"#/components/schemas/UserDefinedField"},"readOnly":true,"type":"array"},"user_gravatar_id":{"description":"The Gravatar ID for the User who created the StackScript.\n","example":"a445b305abda30ebc766bc7fda037c37","readOnly":true,"type":"string"},"username":{"description":"The User who created the StackScript.\n","example":"myuser","readOnly":true,"type":"string","x-linode-cli-display":2}},"type":"object"},"StatsData":{"description":"A stat data point.\n","properties":{"x":{"description":"A stats graph data point.\n","example":11513761600000,"readOnly":true,"type":"integer"},"y":{"description":"A stats graph data point.\n","example":29.94,"readOnly":true,"type":"integer"}},"type":"object"},"StatsDataAvailable":{"description":"A collection of graph data returned for managed stats.\n","properties":{"cpu":{"description":"CPU usage stats from the last 24 hours.","items":{"$ref":"#/components/schemas/StatsData"},"type":"array"},"disk":{"description":"Disk usage stats from the last 24 hours.","items":{"$ref":"#/components/schemas/StatsData"},"type":"array"},"net_in":{"description":"Inbound network traffic stats from the last 24 hours.","items":{"$ref":"#/components/schemas/StatsData"},"type":"array"},"net_out":{"description":"Outbound network traffic stats from the last 24 hours.","items":{"$ref":"#/components/schemas/StatsData"},"type":"array"},"swap":{"description":"Swap usage stats from the last 24 hours.","items":{"$ref":"#/components/schemas/StatsData"},"type":"array"}},"type":"object"},"StatsDataUnavailable":{"description":"An array of error messages if managed stats are unavaliable.\n","items":{"example":"Graphs are not yet available.","type":"string"},"readOnly":true,"type":"array"},"SupportTicket":{"description":"A Support Ticket opened on your Account.\n","properties":{"attachments":{"description":"A list of filenames representing attached files associated with this Ticket.\n","items":{"example":["screenshot.jpg","screenshot.txt"],"type":"string"},"readOnly":true,"type":"array"},"closable":{"description":"Whether the Support Ticket may be closed.\n","example":false,"type":"boolean"},"closed":{"description":"The date and time this Ticket was closed.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","nullable":true,"readOnly":true,"type":"string","x-linode-filterable":true},"description":{"description":"The full details of the issue or question.\n","example":"I'm having trouble setting the root password on my Linode. I tried following the instructions but something is not working and I'm not sure what I'm doing wrong. Can you please help me figure out how I can reset it?\n","maxLength":65000,"minLength":1,"readOnly":true,"type":"string","x-linode-cli-display":5},"entity":{"description":"The entity this Ticket was opened for.\n","nullable":true,"properties":{"id":{"description":"The unique ID for this Ticket's entity.\n","example":10400,"readOnly":true,"type":"integer"},"label":{"description":"The current label of this entity.\n","example":"linode123456","readOnly":true,"type":"string"},"type":{"description":"The type of entity this is related to.\n","example":"linode","readOnly":true,"type":"string"},"url":{"description":"The URL where you can access the object this event is for. If a relative URL, it is relative to the domain you retrieved the entity from.\n","example":"/v4/linode/instances/123456","readOnly":true,"type":"string"}},"readOnly":true,"type":"object","x-linode-cli-display":6},"gravatar_id":{"description":"The Gravatar ID of the User who opened this Ticket.\n","example":"474a1b7373ae0be4132649e69c36ce30","readOnly":true,"type":"string"},"id":{"description":"The ID of the Support Ticket.\n","example":11223344,"readOnly":true,"type":"integer","x-linode-cli-display":1},"opened":{"description":"The date and time this Ticket was created.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":4,"x-linode-filterable":true},"opened_by":{"description":"The User who opened this Ticket.\n","example":"some_user","readOnly":true,"type":"string","x-linode-cli-display":3},"status":{"description":"The current status of this Ticket.","enum":["closed","new","open"],"example":"open","readOnly":true,"type":"string"},"summary":{"description":"The summary or title for this Ticket.\n","example":"Having trouble resetting root password on my Linode\n","maxLength":64,"minLength":1,"readOnly":true,"type":"string","x-linode-cli-display":2},"updated":{"description":"The date and time this Ticket was last updated.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string","x-linode-filterable":true},"updated_by":{"description":"The User who last updated this Ticket.\n","example":"some_other_user","nullable":true,"readOnly":true,"type":"string"}},"type":"object"},"SupportTicketReply":{"description":"An object representing a reply to a Support Ticket.\n","properties":{"created":{"description":"The date and time this Ticket reply was created.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string","x-linode-cli-display":3},"created_by":{"description":"The User who submitted this reply.\n","example":"John Q. Linode","readOnly":true,"type":"string","x-linode-cli-display":2},"description":{"description":"The body of this Support Ticket reply.\n","example":"Hello,\\nI'm sorry to hear that you are having trouble resetting the root password of your Linode. Just to be sure, have you tried to follow the instructions in our online documentation? The link is here:\\n \\nhttps://linode.com/docs/guides/reset-the-root-password-on-your-linode/ \\n\\nIf you have, please reply with any additional steps you have also taken.\\n\\nRegards, Linode Support Team\n","readOnly":true,"type":"string"},"from_linode":{"description":"If set to true, this reply came from a Linode employee.\n","example":true,"readOnly":true,"type":"boolean"},"gravatar_id":{"description":"The Gravatar ID of the User who created this reply.\n","example":"474a1b7373ae0be4132649e69c36ce30","readOnly":true,"type":"string"},"id":{"description":"The unique ID of this Support Ticket reply.\n","example":11223345,"readOnly":true,"type":"integer","x-linode-cli-display":1}},"type":"object"},"SupportTicketRequest":{"description":"An object representing a created Support Ticket - a question or issue and request for help from the Linode support team.\nOnly one of the ID attributes (`linode_id`, `domain_id`, etc.) can be set on a single Support Ticket.\n","properties":{"database_id":{"description":"The ID of the Managed Database this ticket is regarding, if relevant.\n","type":"integer"},"description":{"description":"The full details of the issue or question.\n","example":"I'm having trouble setting the root password on my Linode. I tried following the instructions but something is not working and I'm not sure what I'm doing wrong. Can you please help me figure out how I can reset it?\n","maxLength":65000,"minLength":1,"type":"string"},"domain_id":{"description":"The ID of the Domain this ticket is regarding, if relevant.\n","example":null,"type":"integer"},"firewall_id":{"description":"The ID of the Firewall this ticket is regarding, if relevant.\n","type":"integer"},"linode_id":{"description":"The ID of the Linode this ticket is regarding, if relevant.\n","example":123,"type":"integer"},"lkecluster_id":{"description":"The ID of the Kubernetes cluster this ticket is regarding, if relevant.\n","example":123,"type":"integer"},"longviewclient_id":{"description":"The ID of the Longview client this ticket is regarding, if relevant.\n","example":null,"type":"integer"},"managed_issue":{"description":"Designates if this ticket is related to a [Managed service](https://www.linode.com/products/managed/). If `true`, the following constraints will apply:\n* No ID attributes (i.e. `linode_id`, `domain_id`, etc.) should be provided with this request.\n* Your account must have a [Managed service enabled](/docs/api/managed/#managed-service-enable).\n","example":false,"type":"boolean"},"nodebalancer_id":{"description":"The ID of the NodeBalancer this ticket is regarding, if relevant.\n","example":null,"type":"integer"},"region":{"description":"The [Region](/docs/api/regions/) ID for the associated VLAN this ticket is regarding.\n\nOnly allowed when submitting a VLAN ticket.\n","example":null,"type":"string"},"summary":{"description":"The summary or title for this SupportTicket.\n","example":"Having trouble resetting root password on my Linode\n","maxLength":64,"minLength":1,"type":"string"},"vlan":{"description":"The label of the VLAN this ticket is regarding, if relevant. To view your VLANs, use the VLANs List ([GET /networking/vlans](/docs/api/networking/#vlans-list)) endpoint.\n\nRequires a specified `region` to identify the VLAN.\n","example":null,"type":"string"},"volume_id":{"description":"The ID of the Volume this ticket is regarding, if relevant.\n","example":null,"type":"integer"}},"required":["summary","description"],"type":"object"},"Tag":{"description":"A tag that has been applied to an object on your Account. Tags are currently for organizational purposes only.\n","properties":{"label":{"description":"A Label used for organization of objects on your Account.\n","example":"example tag","type":"string"}},"type":"object"},"Transfer":{"description":"An object representing your network utilization for the current month, in Gigabytes.\n","properties":{"billable":{"description":"The amount of your transfer pool that is billable this billing cycle.\n","example":0,"readOnly":true,"type":"integer","x-linode-cli-display":3},"quota":{"description":"The amount of network usage allowed this billing cycle.\n","example":9141,"readOnly":true,"type":"integer","x-linode-cli-display":1},"used":{"description":"The amount of network usage you have used this billing cycle.\n","example":2,"readOnly":true,"type":"integer","x-linode-cli-display":2}},"type":"object"},"TrustedDevice":{"description":"A trusted device object represents an active Remember Me session with login.linode.com.\n","properties":{"created":{"description":"When this Remember Me session was started. This corresponds to the time of login with the \"Remember Me\" box checked.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string"},"expiry":{"description":"When this TrustedDevice session expires. Sessions typically last 30 days.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"The unique ID for this TrustedDevice","example":123,"readOnly":true,"type":"integer"},"last_authenticated":{"description":"The last time this TrustedDevice was successfully used to authenticate to login.linode.com.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string"},"last_remote_addr":{"description":"The last IP Address to successfully authenticate with this TrustedDevice.\n","example":"203.0.113.1","readOnly":true,"type":"string"},"user_agent":{"description":"The User Agent of the browser that created this TrustedDevice session.\n","example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.77 Safari/537.36 Vivaldi/2.1.1337.36\n","readOnly":true,"type":"string"}},"type":"object"},"User":{"description":"A User on your Account. Unrestricted users can log in and access information about your Account, while restricted users may only access entities or perform actions they've been granted access to.\n","properties":{"email":{"description":"The email address for the User. Linode sends emails to this address for account management communications. May be used for other communications as configured.\n","example":"example_user@linode.com","format":"email","type":"string","x-linode-cli-display":2},"restricted":{"description":"If true, the User must be granted access to perform actions or access entities on this Account. See User Grants View ([GET /account/users/{username}/grants](/docs/api/account/#users-grants-view)) for details on how to configure grants for a restricted User.\n","example":true,"type":"boolean","x-linode-cli-display":3},"ssh_keys":{"description":"A list of SSH Key labels added by this User.\n\nUsers can add keys with the SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) command.\n\nThese keys are deployed when this User is included in the `authorized_users`\nfield of the following requests:\n- Linode Create ([POST /linode/instances](/docs/api/linode-instances/#linode-create))\n- Linode Rebuild ([POST /linode/instances/{linodeId}/rebuild](/docs/api/linode-instances/#linode-rebuild))\n- Disk Create ([POST /linode/instances/{linodeId}/disks](/docs/api/linode-instances/#disk-create))\n","example":["home-pc","laptop"],"items":{"type":"string"},"readOnly":true,"type":"array"},"tfa_enabled":{"description":"A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. See the Create Two Factor Secret ([POST /profile/tfa-enable](/docs/api/profile/#two-factor-secret-create)) endpoint to enable TFA.\n","readOnly":true,"type":"boolean"},"username":{"description":"The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts).\n","example":"example_user","maxLength":32,"minLength":3,"pattern":"^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$","type":"string","x-linode-cli-display":1,"x-linode-filterable":true}},"type":"object"},"UserDefinedField":{"description":"A custom field defined by the User with a special syntax within a StackScript. Derived from the contents of the script.\n","properties":{"default":{"description":"The default value. If not specified, this value will be used.\n","readOnly":true,"type":"string"},"example":{"description":"An example value for the field.\n","example":"hunter2","readOnly":true,"type":"string"},"label":{"description":"A human-readable label for the field that will serve as the input prompt for entering the value during deployment.\n","example":"Enter the password","readOnly":true,"type":"string"},"manyOf":{"description":"A list of acceptable values for the field in any quantity, combination or order.\n","example":"avalue,anothervalue,thirdvalue","readOnly":true,"type":"string"},"name":{"description":"The name of the field.\n","example":"DB_PASSWORD","readOnly":true,"type":"string"},"oneOf":{"description":"A list of acceptable single values for the field.\n","example":"avalue,anothervalue,thirdvalue","readOnly":true,"type":"string"}},"required":["label","name","example"],"type":"object"},"Vlans":{"description":"A virtual local area network (VLAN) associated with your Account.\n","properties":{"created":{"description":"The date this VLAN was created.\n","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string"},"label":{"description":"The name of this VLAN.","example":"vlan-example","readOnly":true,"type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"linodes":{"description":"An array of Linode IDs attached to this VLAN.\n","example":[111,222],"items":{"type":"integer"},"readOnly":true,"type":"array","x-linode-cli-display":3},"region":{"description":"This VLAN's data center region.\n\n**Note:** Currently, a VLAN can only be assigned to a Linode\nwithin the same data center region.\n","example":"ap-west","readOnly":true,"type":"string","x-linode-cli-display":1,"x-linode-filterable":true}},"type":"object"},"Volume":{"description":"A Block Storage Volume associated with your Account.\n","properties":{"created":{"description":"When this Volume was created.","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string"},"filesystem_path":{"description":"The full filesystem path for the Volume based on the Volume's label. Path is /dev/disk/by-id/scsi-0Linode_Volume_ + Volume label.\n","example":"/dev/disk/by-id/scsi-0Linode_Volume_my-volume","readOnly":true,"type":"string"},"hardware_type":{"description":"The storage type of this Volume.","enum":["hdd","nvme"],"example":"nvme","readOnly":true,"type":"string"},"id":{"description":"The unique ID of this Volume.","example":12345,"readOnly":true,"type":"integer","x-linode-cli-display":1},"label":{"description":"The Volume's label is for display purposes only.\n","example":"my-volume","maxLength":32,"minLength":1,"pattern":"^[a-zA-Z]((?!--|__)[a-zA-Z0-9-_])+$","type":"string","x-linode-cli-display":2,"x-linode-filterable":true},"linode_id":{"description":"If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.\n","example":12346,"nullable":true,"type":"integer","x-linode-cli-display":6},"linode_label":{"description":"If a Volume is attached to a specific Linode, the label of that Linode will be displayed here.\n","example":"linode123","nullable":true,"readOnly":true,"type":"string","x-linode-cli-display":7},"region":{"$ref":"#/components/schemas/Region/properties/id","x-linode-cli-display":5},"size":{"description":"The Volume's size, in GiB.\n","example":30,"maximum":10240,"type":"integer","x-linode-cli-display":4},"status":{"description":"The current status of the volume. Can be one of:\n\n * `creating` - the Volume is being created and is not yet available\n for use.\n * `active` - the Volume is online and available for use.\n * `resizing` - the Volume is in the process of upgrading\n its current capacity.\n","enum":["creating","active","resizing"],"example":"active","readOnly":true,"type":"string","x-linode-cli-color":{"active":"green","contact_support":"red","default_":"yellow"},"x-linode-cli-display":3},"tags":{"description":"An array of Tags applied to this object. Tags are for organizational purposes only.\n","example":["example tag","another example"],"items":{"type":"string"},"type":"array","x-linode-filterable":true},"updated":{"description":"When this Volume was last updated.","example":"2025-08-15T13:51:51.404Z","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"WarningObject":{"description":"An object for describing a single warning associated with a response.\n","properties":{"details":{"description":"Specific information related to the warning.\n","example":"Linode 123 could not be rebooted.","type":"string"},"title":{"description":"The general warning message.\n","example":"Unable to reboot Linode.","type":"string"}},"type":"object"}},"securitySchemes":{"oauth":{"flows":{"authorizationCode":{"authorizationUrl":"https://login.linode.com/oauth/authorize","scopes":{"account:read_only":"Allows access to GET information about your Account.","account:read_write":"Allows access to all endpoints related to your Account.","databases:read_only":"*Originally missing*","databases:read_write":"*Originally missing*","domains:read_only":"Allows access to GET Domains on your Account.","domains:read_write":"Allows access to all Domain endpoints.","events:read_only":"Allows access to GET your Events.","events:read_write":"Allows access to all endpoints related to your Events.","firewall:read_only":"Allows access to GET information about your Firewalls.","firewall:read_write":"Allows acces to all Firewall endpoints.","images:read_only":"Allows access to GET your Images.","images:read_write":"Allows access to all endpoints related to your Images.","ips:read":"*Originally missing*","ips:read_only":"Allows access to GET your ips.","ips:read_write":"Allows access to all endpoints related to your ips.","linodes:read_only":"Allows access to GET Linodes on your Account.","linodes:read_write":"Allow access to all endpoints related to your Linodes.","lke:read_only":"Allows access to GET LKE Clusters on your Account.","lke:read_write":"Allows access to all endpoints related to LKE Clusters on your Account.","longview:read_only":"Allows access to GET your Longview Clients.","longview:read_write":"Allows access to all endpoints related to your Longview Clients.","nodebalancers:read_only":"Allows access to GET NodeBalancers on your Account.","nodebalancers:read_write":"Allows access to all NodeBalancer endpoints.","object_storage:read_only":"Allows access to GET information related to your Object Storage.","object_storage:read_write":"Allows access to all Object Storage endpoints.","stackscripts:read_only":"Allows access to GET your StackScripts.","stackscripts:read_write":"Allows access to all endpoints related to your StackScripts.","volumes:read_only":"Allows access to GET your Volumes.","volumes:read_write":"Allows access to all endpoints related to your Volumes."},"tokenUrl":"https://login.linode.com/oauth/token"}},"type":"oauth2"},"personalAccessToken":{"scheme":"bearer","type":"http"}}}}