components: parameters: api-version-path: description: Call either the `v4` URL, or `v4beta` for operations still in Beta. in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml beta-id: description: The ID of the Beta Program. in: path name: betaId required: true schema: type: string x-akamai: file-path: parameters/beta-id.yaml client-id-path: description: The OAuth Client ID to look up. in: path name: clientId required: true schema: type: string x-akamai: file-path: parameters/client-id-path.yaml client-id-path-ecf807fb: description: The OAuth Client ID to look up. in: path name: clientId required: true schema: type: string x-akamai: file-path: parameters/client-id-path-ecf807fb.yaml eeuid: description: The child account to look up. You can run the [List child accounts](https://techdocs.akamai.com/linode-api/reference/get-child-accounts) operation to find the applicable account and store its `euuid`. in: path name: euuid required: true schema: type: string x-akamai: file-path: parameters/eeuid.yaml event-id-path-214cd042: description: The ID of the Event to designate as seen. in: path name: eventId required: true schema: example: 824 type: integer x-akamai: file-path: parameters/event-id-path-214cd042.yaml event-id-path-39255fcf: description: The ID of the Event. in: path name: eventId required: true schema: example: 824 type: integer x-akamai: file-path: parameters/event-id-path-39255fcf.yaml event-id-path-625aa248: description: The ID of the Event to designate as read. in: path name: eventId required: true schema: example: 824 type: integer x-akamai: file-path: parameters/event-id-path-625aa248.yaml id-path: description: The slug for the applicable data center. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the slug for each data center. in: path name: id required: true schema: type: string x-akamai: file-path: parameters/id-path.yaml invoice-id-path: description: The ID of the Invoice. in: path name: invoiceId required: true schema: example: 387 type: integer x-akamai: file-path: parameters/invoice-id-path.yaml login-id-path: description: The ID of the login object to access. in: path name: loginId required: true schema: example: 863 type: integer x-akamai: file-path: parameters/login-id-path.yaml page-offset: description: The page of a collection to return. in: query name: page required: false schema: default: 1 example: 6 minimum: 1 type: integer x-akamai: file-path: parameters/page-offset.yaml page-size: description: The number of items to return per page. in: query name: page_size schema: default: 100 example: 50 maximum: 500 minimum: 25 type: integer x-akamai: file-path: parameters/page-size.yaml payment-id-path: description: The ID of the Payment to look up. in: path name: paymentId required: true schema: example: 627 type: integer x-akamai: file-path: parameters/payment-id-path.yaml payment-method-id-path-6078bc7b: description: The ID of the Payment Method to look up. in: path name: paymentMethodId required: true schema: example: 267 type: integer x-akamai: file-path: parameters/payment-method-id-path-6078bc7b.yaml payment-method-id-path-fb39a844: description: The ID of the Payment Method to make default. in: path name: paymentMethodId required: true schema: example: 267 type: integer x-akamai: file-path: parameters/payment-method-id-path-fb39a844.yaml token-path-f857f5a2: description: The UUID of the Service Transfer. in: path name: token required: true schema: format: uuid type: string x-akamai: file-path: parameters/token-path-f857f5a2.yaml token-path-faf66b58: description: The UUID of the Entity Transfer. in: path name: token required: true schema: format: uuid type: string x-akamai: file-path: parameters/token-path-faf66b58.yaml username-path: description: The username to look up. in: path name: username required: true schema: type: string x-akamai: file-path: parameters/username-path.yaml responses: '409': content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: reason: description: A string explaining that the account could not be canceled because there is an outstanding balance on the account that must be paid first. example: We were unable to charge your credit card for services rendered. We cannot cancel this account until the balance has been paid. type: string type: object type: array type: object x-akamai: file-path: schemas/added-post-cancel-account-409.yaml x-example: x-ref: ../examples/tbd.json description: Could not charge the credit card on file. x-akamai: file-path: errors/409.yaml accepted-response: content: application/json: schema: additionalProperties: false properties: warnings: items: additionalProperties: false description: An object for describing a single warning associated with a response. properties: details: description: Specific information related to the warning. example: Linode 123 could not be rebooted. type: string title: description: The general warning message. example: Unable to reboot Linode. type: string type: object x-akamai: file-path: schemas/warning-object.yaml type: array type: object description: |- Accepted with warning. A warnings array is included with the standard 200 response body. deprecated-response: content: application/json: schema: additionalProperties: false properties: warnings: items: additionalProperties: false description: An object for describing a single warning associated with a response. properties: details: description: Specific information related to the warning. example: Linode 123 could not be rebooted. type: string title: description: The general warning message. example: Unable to reboot Linode. type: string type: object x-akamai: file-path: schemas/warning-object.yaml type: array type: object description: |- Request successful. This operation is deprecated and may be removed in a future release. A warnings array is included with the standard 200 response body. error-response: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. 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. 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](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. schemas: account: additionalProperties: false description: Account object. properties: active_promotions: items: additionalProperties: false description: |- __Read-only__ Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set. Simply put, a promotion offers a certain amount of credit month, until either the expiration date is passed, or until the total promotional credit is used, whichever comes first. properties: credit_monthly_cap: description: The amount available to spend per month. example: '10.00' type: string x-linode-cli-display: 5 credit_remaining: description: The total amount of credit left for this promotion. example: '50.00' type: string x-linode-cli-display: 3 description: description: A detailed description of this promotion. 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. example: '2018-01-31T23:59:59' type: string x-linode-cli-display: 2 image_url: description: The location of an image for this promotion. example: https://linode.com/10_a_month_promotion.svg type: string service_type: description: The service to which this promotion applies. enum: - all - backup - blockstorage - db_mysql - ip_v4 - linode - linode_disk - linode_memory - longview - managed - nodebalancer - objectstorage - placement_group - transfer_tx example: all type: string x-linode-cli-display: 1 summary: description: Short details of this promotion. 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. example: '10.00' type: string x-linode-cli-display: 4 readOnly: true type: object x-akamai: file-path: schemas/promotion.yaml readOnly: true type: array active_since: description: __Read-only__ The date and time the account was activated. example: '2018-01-01T00:01:01' 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: __Read-only__ This Account's balance, in US dollars. example: 200 readOnly: true type: number x-linode-cli-display: 4 balance_uninvoiced: description: __Read-only__ This Account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate. example: 145 readOnly: true type: number x-linode-cli-display: 4 billing_source: description: __Read-only__ The source of service charges for this Account, as determined by its relationship with Akamai. Accounts that are associated with Akamai-specific customers return a value of `akamai`. All other Accounts return a value of `linode`. enum: - akamai - linode example: akamai readOnly: true type: string capabilities: description: __Read-only__ A list of capabilities your account supports. example: - Linodes - NodeBalancers - Block Storage - Object Storage - Placement Groups - Block Storage Encryption 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. Must not include any of the following characters: `<` `>` `(` `)` `"` `=` example: Linode LLC maxLength: 128 type: string country: description: The two-letter ISO 3166 country code of this Account's billing address. example: US type: string credit_card: additionalProperties: false description: __Read-only__ 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. 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: __Read-only__ An external unique identifier for this account. example: E1AF5EEC-526F-487D-B317EBEB34C87D71 format: uuid readOnly: true type: string first_name: description: |- The first name of the person associated with this Account. Must not include any of the following characters: `<` `>` `(` `)` `"` `=` example: John maxLength: 50 type: string x-linode-cli-display: 1 last_name: description: |- The last name of the person associated with this Account. Must not include any of the following characters: `<` `>` `(` `)` `"` `=` 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. 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 (`""`). example: ATU99999999 maxLength: 25 type: string zip: description: |- The zip code of this Account's billing address. The following restrictions apply: - Can only contain ASCII letters, numbers, and hyphens (`-`). - Must not contain more than 9 letter or number characters. example: 19102-1234 type: string type: object x-akamai: file-path: schemas/account.yaml account-availability: additionalProperties: false description: Account Service Availability object. properties: available: description: __Read-only__ A list of services _available_ to your account in the `region`. example: - Linodes - NodeBalancers items: type: string readOnly: true type: array region: description: __Read-only__ The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation. example: us-east readOnly: true type: string x-linode-cli-display: 1 unavailable: description: __Read-only__ A list of services _unavailable_ to your account in the `region`. example: - Kubernetes - Block Storage items: type: string readOnly: true type: array x-linode-cli-display: 3 type: object x-akamai: file-path: schemas/account-availability.yaml account-settings: additionalProperties: false 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. example: true type: boolean x-linode-cli-display: 4 longview_subscription: description: __Read-only__ The Longview Pro tier you are currently subscribed to. The value must be a [Longview subscription](https://techdocs.akamai.com/linode-api/reference/get-longview-subscriptions) ID or `null` for Longview Free. example: longview-3 readOnly: true type: string x-linode-cli-display: 2 managed: description: __Read-only__ 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. 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. example: false type: boolean x-linode-cli-display: 1 object_storage: default: disabled description: __Read-only__ A string describing the status of this account's Object Storage service enrollment. enum: - disabled - suspended - active example: active readOnly: true type: string x-linode-cli-display: 5 type: object x-akamai: file-path: schemas/account-settings.yaml added-empty-obj: description: The API responds with an empty object. maxProperties: 0 type: object x-akamai: file-path: schemas/added-empty-obj.yaml added-get-account-logins-200: additionalProperties: false properties: data: items: additionalProperties: false description: An object representing a previous successful login for a User. properties: datetime: description: __Read-only__ When the login was initiated. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 id: description: __Read-only__ The unique ID of this login object. example: 1234 readOnly: true type: integer x-linode-cli-display: 1 ip: description: __Read-only__ The remote IP address that requested the login. example: 192.0.2.0 format: ip readOnly: true type: string x-linode-cli-display: 3 restricted: description: __Read-only__ True if the User that attempted the login was a restricted User, false otherwise. example: true readOnly: true type: boolean x-linode-cli-display: 6 status: description: __Read-only__ Whether the login attempt succeeded or failed. enum: - successful - failed example: successful readOnly: true type: string x-linode-cli-display: 5 username: description: __Read-only__ The username of the User that attempted the login. example: example_user readOnly: true type: string x-linode-cli-display: 4 type: object x-akamai: file-path: schemas/login.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-account-logins-200.yaml added-get-availability-200: allOf: - additionalProperties: false properties: data: items: additionalProperties: false description: Account Service Availability object. properties: available: description: __Read-only__ A list of services _available_ to your account in the `region`. example: - Linodes - NodeBalancers items: type: string readOnly: true type: array region: description: __Read-only__ The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation. example: us-east readOnly: true type: string x-linode-cli-display: 1 unavailable: description: __Read-only__ A list of services _unavailable_ to your account in the `region`. example: - Kubernetes - Block Storage items: type: string readOnly: true type: array x-linode-cli-display: 3 type: object x-akamai: file-path: schemas/account-availability.yaml type: array type: object - additionalProperties: false 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](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. properties: page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/pagination-envelope.yaml x-akamai: file-path: schemas/added-get-availability-200.yaml added-get-child-accounts-200: additionalProperties: false properties: data: items: additionalProperties: false description: Child account object. properties: active_since: description: __Read-only__ The activation date and time for the child account. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string address_1: description: __Filterable__ First line of this child account's billing address. example: 123 Main Street maxLength: 64 type: string x-akamai: labels: - Filterable x-linode-filterable: true address_2: description: __Filterable__ Second line of this child account's billing address, if applicable. example: Suite A maxLength: 64 type: string x-akamai: labels: - Filterable x-linode-filterable: true balance: description: __Read-only__ This child account's balance, in US dollars. example: 200 readOnly: true type: number x-linode-cli-display: 4 balance_uninvoiced: description: __Read-only__ This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate. example: 145 readOnly: true type: number x-linode-cli-display: 4 billing_source: description: __Read-only__ The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment. enum: - external example: external readOnly: true type: string capabilities: description: __Read-only__ A list of the capabilities the child account supports. example: - Linodes - NodeBalancers - Block Storage - Object Storage items: type: string readOnly: true type: array city: description: __Filterable__ The city for this child account's billing address. example: San Diego maxLength: 24 type: string x-akamai: labels: - Filterable x-linode-filterable: true company: description: '__Filterable__ The company name for the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`. You can''t change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.' example: Acme maxLength: 128 type: string x-akamai: labels: - Filterable x-linode-filterable: true country: description: __Filterable__ The two-letter ISO 3166 country code for this child account's billing address. example: US type: string x-akamai: labels: - Filterable x-linode-filterable: true credit_card: additionalProperties: false description: __Read-only__ Information for the credit card you've assigned to this child account. properties: expiry: description: The expiration month and year of the credit card. example: 11/2024 type: string last_four: description: The last four digits of the credit card. example: 1111 type: string readOnly: true type: object email: description: __Filterable__ The email address of the owner of this child account. example: john.smith@linode.com maxLength: 128 type: string x-akamai: labels: - Filterable x-linode-cli-display: 3 x-linode-filterable: true euuid: description: __Read-only__ An external, unique identifier that Akamai assigned to the child account. example: A1BC2DEF-34GH-567I-J890KLMN12O34P56 format: uuid readOnly: true type: string first_name: description: '__Filterable__ The first name of the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`.' example: John maxLength: 50 type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true last_name: description: '__Filterable__ The last name of the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`.' example: Smith maxLength: 50 type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true phone: description: __Filterable__ The phone number for the owner of this child account. example: 858-555-1212 maxLength: 32 type: string x-akamai: labels: - Filterable x-linode-filterable: true state: description: |- __Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code. __Note__. If this is a US military address, use state abbreviations (AA, AE, AP). example: CA maxLength: 24 type: string x-akamai: labels: - Filterable x-linode-filterable: true tax_id: description: The tax identification number for this child account. Use this for tax calculations in some countries. If you live in a country that doesn't collect taxes, ensure this is an empty string (`""`). example: ATU99999999 maxLength: 25 type: string zip: description: |- __Filterable__ The zip code of this Account's billing address. The following restrictions apply: - Can only contain ASCII letters, numbers, and hyphens (`-`). - Can't contain more than 9 letter or number characters. example: 92111-1234 type: string x-akamai: labels: - Filterable x-linode-filterable: true type: object x-akamai: file-path: schemas/child-account.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-child-accounts-200.yaml added-get-clients-200: additionalProperties: false properties: data: items: additionalProperties: false description: A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](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. properties: id: description: __Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret). example: 2737bf16b39ab5d7b4a1 readOnly: true type: string x-linode-cli-display: 1 label: description: __Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account. example: Test_Client_1 maxLength: 512 minLength: 1 type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true public: default: false description: __Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. example: false type: boolean x-akamai: labels: - Filterable x-linode-cli-display: 4 x-linode-filterable: true redirect_uri: description: The location a successful log in from [login.linode.com](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. example: https://example.org/oauth/callback format: url type: string x-linode-cli-display: 5 secret: description: __Read-only__ 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. example: readOnly: true type: string status: description: __Read-only__ The status of this application. `active` by default. 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: __Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set. example: https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail format: url nullable: true readOnly: true type: string type: object x-akamai: file-path: schemas/oauth-client.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-clients-200.yaml added-get-enrolled-beta-programs-200: allOf: - additionalProperties: false 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](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. properties: page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/pagination-envelope.yaml - properties: data: items: additionalProperties: false description: An object representing an enrolled Beta Program for the Account. properties: description: description: __Read-only__ Additional details regarding the Beta Program. example: This is an open public beta for an example feature. nullable: true readOnly: true type: string x-linode-cli-display: 3 ended: description: |- __Filterable__, __Read-only__ The date-time that the Beta Program ended. `null` indicates that the Beta Program is ongoing. example: null format: date-time nullable: true readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 5 x-linode-filterable: true enrolled: description: __Filterable__, __Read-only__ The date-time of Account enrollment to the Beta Program. example: '2023-09-11T00:00:00' format: date-time readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 6 x-linode-filterable: true id: description: The unique identifier of the Beta Program. example: example_open type: string x-linode-cli-display: 1 label: description: __Filterable__, __Read-only__ The name of the Beta Program. example: Example Open Beta readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true started: description: __Filterable__, __Read-only__ The start date-time of the Beta Program. example: '2023-07-11T00:00:00' format: date-time readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 4 x-linode-filterable: true type: object x-akamai: file-path: schemas/beta-program-enrolled.yaml type: array type: object x-akamai: file-path: schemas/added-get-enrolled-beta-programs-200.yaml added-get-entity-transfers-200: allOf: - additionalProperties: false 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](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. properties: page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/pagination-envelope.yaml - properties: data: items: additionalProperties: false description: An object representing an Entity Transfer. properties: created: description: When this transfer was created. example: '2021-02-11T16:37:03' format: date-time type: string entities: additionalProperties: false description: A collection of the entities to include in this transfer request, separated by type. properties: linodes: description: An array containing the IDs of each of the Linodes included in this transfer. 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. example: '2021-02-12T16:37:03' format: date-time type: string x-linode-cli-display: 3 is_sender: description: __Filterable__ If the requesting account created this transfer. example: true type: boolean x-akamai: labels: - Filterable x-linode-cli-display: 4 x-linode-filterable: true status: description: |- __Filterable__ The status of the transfer request: `accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete. `canceled`: The transfer has been canceled by the sender. `completed`: The transfer has completed successfully. `failed`: The transfer has failed after initiation. `pending`: The transfer is ready to be accepted. `stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled. enum: - accepted - canceled - completed - failed - pending - stale example: pending type: string x-akamai: labels: - Filterable x-linode-cli-color: accepted: yellow canceled: 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. example: 123E4567-E89B-12D3-A456-426614174000 format: uuid type: string x-linode-cli-display: 1 updated: description: When this transfer was last updated. example: '2021-02-11T16:37:03' format: date-time type: string type: object x-akamai: file-path: schemas/entity-transfer.yaml type: array x-akamai: file-path: schemas/added-get-entity-transfers-200.yaml added-get-events-200: additionalProperties: false properties: data: items: additionalProperties: false 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. The Events returned depends on your grants. properties: action: description: __Filterable__, __Read-only__ The action that caused this Event. New actions may be added in the future. 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_apply - 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_cluster_create - lke_cluster_update - lke_cluster_delete - lke_cluster_recycle - lke_cluster_regenerate - lke_node_create - lke_node_delete - lke_node_recycle - lke_pool_create - lke_pool_delete - lke_pool_recycle - lke_kubeconfig_regenerate - lke_token_rotate - 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 - obj_access_key_create - obj_access_key_delete - obj_access_key_update - password_reset - payment_method_add - payment_submitted - placement_group_assign - placement_group_became_compliant - placement_group_became_non_compliant - placement_group_create - placement_group_delete - placement_group_unassign - placement_group_update - profile_update - stackscript_create - stackscript_delete - stackscript_update - stackscript_publicize - stackscript_revise - subnet_create - subnet_delete - subnet_update - 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 - vpc_create - vpc_delete - vpc_update example: ticket_create readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 3 x-linode-filterable: true created: description: __Filterable__, __Read-only__ When this Event was created. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 6 x-linode-filterable: true duration: description: __Read-only__ The total duration in seconds that it takes for the Event to complete. example: 300.56 readOnly: true type: number x-linode-cli-display: 7 entity: additionalProperties: false description: __Read-only__ Detailed information about the Event's entity, including ID, type, label, and URL used to access it. properties: id: description: |- __Filterable__ The unique ID for an Event's entity. Some Event entities do not have IDs associated with them, so they will not be returned when filtering by ID. These Events include: - `account` - `profile` Entities for some Events are assigned the ID of the Linode they correspond to. When filtering by ID for these Events, use the corresponding Linode's ID. These Events include: - `disks` - `backups` Tag Events use a tag's name for the entity ID field. When filtering by ID for tag Events, supply the name of the tag. example: 11111 type: integer x-akamai: labels: - Filterable x-linode-filterable: true label: description: The current label of this object. The label may reflect changes that occur with this Event. example: Problem booting my Linode type: string x-linode-cli-display: 5 type: description: __Filterable__, __Read-only__ The type of entity that is being referenced by the Event. enum: - account - backups - community - disks - domain - entity_transfer - firewall - image - ipaddress - linode - longview - loadbalancer - managed_service - nodebalancer - oauth_client - profile - stackscript - tag - ticket - token - user - user_ssh_key - volume example: ticket readOnly: true type: string x-akamai: labels: - Filterable 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. example: /v4/support/tickets/11111 type: string readOnly: true type: object id: description: __Filterable__, __Read-only__ The unique ID of this Event. example: 123 readOnly: true type: integer x-akamai: labels: - Filterable 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. example: None nullable: true type: string x-linode-cli-display: 9 percent_complete: description: __Read-only__ A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events. example: null nullable: true readOnly: true type: integer rate: description: __Read-only__ The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events. example: null nullable: true readOnly: true type: string read: description: __Filterable__, __Read-only__ If this Event has been read. example: true readOnly: true type: boolean x-akamai: labels: - Filterable x-linode-filterable: true secondary_entity: additionalProperties: false description: __Read-only__ Detailed information about the Event's secondary entity, which provides additional information for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions. properties: id: description: The ID of the object that is the secondary entity. example: linode/debian9 type: string label: description: The label of this object. example: linode1234 type: string type: description: __Read-only__ The type of entity that is being referenced by the Event. 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. example: /v4/linode/instances/1234 type: string readOnly: true type: object seen: description: __Read-only__ If this Event has been seen. example: true readOnly: true type: boolean status: description: __Read-only__ 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: __Read-only__ 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. example: null nullable: true readOnly: true type: string username: description: __Read-only__ The username of the User who caused the Event. example: exampleUser nullable: true readOnly: true type: string x-linode-cli-display: 2 type: object x-akamai: file-path: schemas/event.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-events-200.yaml added-get-invoice-items-200: additionalProperties: false properties: data: items: additionalProperties: false description: An InvoiceItem object. properties: amount: description: __Read-only__ 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: __Read-only__ The date the Invoice Item started, based on month. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 label: description: __Read-only__ The Invoice Item's display label. example: Linode 123 readOnly: true type: string x-linode-cli-display: 1 quantity: description: __Read-only__ The quantity of this Item for the specified Invoice. example: 4 readOnly: true type: integer region: description: |- __Read-only__ The ID of the applicable Region associated with this Invoice Item. `null` if there is no applicable Region. example: us-west nullable: true readOnly: true type: string x-linode-cli-display: 7 tax: description: __Read-only__ 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: __Read-only__ The date the Invoice Item ended, based on month. example: '2018-01-31T11:59:59' format: date-time readOnly: true type: string x-linode-cli-display: 3 total: description: __Read-only__ The price of this Item after taxes in US Dollars. example: 21.45 readOnly: true type: number x-linode-cli-display: 6 type: description: __Read-only__ The type of service, ether `hourly` or `misc`. enum: - hourly - misc example: hourly readOnly: true type: string unit_price: description: __Read-only__ The monthly service fee in US Dollars for this Item. example: 5.05 readOnly: true type: string type: object x-akamai: file-path: schemas/invoice-item.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-invoice-items-200.yaml added-get-invoices-200: additionalProperties: false properties: data: items: additionalProperties: false description: Account Invoice object. properties: billing_source: description: |- __Filterable__, __Read-only__ `akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai. `linode`: This Invoice was generated according to the default terms, prices, and discounts. enum: - akamai - linode example: linode readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 3.5 x-linode-filterable: true date: description: __Filterable__, __Read-only__ When this Invoice was generated. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true id: description: __Read-only__ The Invoice's unique ID. example: 123 readOnly: true type: integer x-linode-cli-display: 1 label: description: __Filterable__, __Read-only__ The Invoice's display label. example: Invoice readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 3 x-linode-filterable: true subtotal: description: __Read-only__ The amount of the Invoice before taxes in US Dollars. example: 120.25 readOnly: true type: number x-linode-cli-display: 4 tax: description: __Read-only__ 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: __Read-only__ The amount of tax broken down into subtotals by source. items: additionalProperties: false 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: __Filterable__, __Read-only__ The amount of the Invoice after taxes in US Dollars. example: 132.5 readOnly: true type: number x-akamai: labels: - Filterable x-linode-cli-display: 6 x-linode-filterable: true type: object x-akamai: file-path: schemas/invoice.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-invoices-200.yaml added-get-maintenance-200: additionalProperties: false properties: data: items: additionalProperties: false description: Information about maintenance affecting an entity. properties: entity: additionalProperties: false description: The entity being affected by maintenance. properties: id: description: The id of the entity being affected by maintenance. example: 1234 type: number label: description: The label of the entity being affected by maintenance. example: demo-linode type: string type: description: The type of entity. 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. example: https://api.linode.com/v4/linode/instances/{linodeId} type: string type: object reason: description: The reason maintenance is being performed. example: This maintenance will allow us to update the BIOS on the host's motherboard. type: string status: description: |- __Filterable__ The maintenance status. Maintenance progresses in the following sequence: pending, started, then completed. enum: - completed - pending - started example: started type: string x-akamai: labels: - Filterable x-linode-filterable: true type: description: __Filterable__ The type of maintenance. enum: - reboot - cold_migration - live_migration example: reboot type: string x-akamai: labels: - Filterable x-linode-filterable: true when: description: |- __Filterable__ When the maintenance will begin. [Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters: - A single value in date-time string format (`%Y-%m-%dT%H:%M:%S`), which returns only matches to that value. - A dictionary containing pairs of inequality operator string keys (`+or`, `+gt`, `+gte`, `+lt`, `+lte`, or `+neq`) and single date-time string format values (`%Y-%m-%dT%H:%M:%S`). `+or` accepts an array of values that may consist of single date-time strings or dictionaries of inequality operator pairs. example: '2020-07-09T00:01:01' format: date-time type: string x-akamai: labels: - Filterable x-linode-filterable: true type: object x-akamai: file-path: schemas/maintenance.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-maintenance-200.yaml added-get-notifications-200: additionalProperties: false properties: data: items: additionalProperties: false description: An important, often time-sensitive item related to your account. properties: body: description: __Read-only__ A full description of this notification, in markdown format. Not all notifications include a `body`. example: null nullable: true readOnly: true type: string entity: additionalProperties: false description: __Read-only__ Detailed information about the notification. properties: id: description: The unique ID of the notification's entity, based on the entity type. Returns `null` for an `account` or `promotion` entity. example: 3456 nullable: true type: integer label: description: |- The current label for this notification's entity. Returns `null` for the following entity types: - `entity_transfer` - `promotion` - `region` example: Linode not booting. nullable: true type: string type: description: The type of entity this is related to. enum: - account - entity_transfer - linode - loadbalancers - nodebalancer - promotion - region - ticket - volume example: ticket type: string url: description: The URL where you can access the notification's object. The URL is relative to the domain where you retrieved the notification. This value is `null` for the `promotion` entity type. example: /support/tickets/3456 nullable: true type: string readOnly: true type: object label: description: __Read-only__ A short description of this notification. example: You have an important ticket open! readOnly: true type: string x-linode-cli-display: 1 message: description: __Read-only__ 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: __Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. 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: __Read-only__ The type of notification. 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: __Read-only__ If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window. example: null format: date-time nullable: true readOnly: true type: string x-linode-cli-color: None: black default_: white x-linode-cli-display: 5 when: description: __Read-only__ If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration. example: null format: date-time nullable: true readOnly: true type: string x-linode-cli-color: None: black default_: white x-linode-cli-display: 4 type: object x-akamai: file-path: schemas/notification.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-notifications-200.yaml added-get-payment-methods-200: additionalProperties: false properties: data: items: additionalProperties: false description: Payment Method Response Object. properties: created: description: __Read-only__ When the Payment Method was added to the Account. example: '2018-01-15T00:01:01' format: date-time readOnly: true type: string data: oneOf: - additionalProperties: false description: Credit card information. properties: card_type: description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Credit card type: object x-akamai: file-path: schemas/credit-card-data.yaml x-linode-ref-name: Credit Card - additionalProperties: false description: Google Pay information. properties: card_type: description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Google Pay type: object x-akamai: file-path: schemas/google-pay-data.yaml x-linode-ref-name: Google Pay - additionalProperties: false description: PayPal information. properties: email: description: __Read-only__ The email address associated with your PayPal account. example: example@linode.com readOnly: true type: string paypal_id: description: __Read-only__ PayPal Merchant ID associated with your PayPal account. example: ABC1234567890 readOnly: true type: string title: Paypal type: object x-akamai: file-path: schemas/paypal-data.yaml 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. 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 x-akamai: file-path: schemas/payment-method.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-payment-methods-200.yaml added-get-payments-200: additionalProperties: false properties: data: items: additionalProperties: false description: Payment object response. properties: date: description: __Read-only__ When the Payment was made. example: '2018-01-15T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 id: description: __Read-only__ The unique ID of the Payment. example: 123 readOnly: true type: integer x-linode-cli-display: 1 usd: description: __Read-only__ The amount, in US dollars, of the Payment. example: '120.50' readOnly: true type: integer x-linode-cli-display: 3 type: object x-akamai: file-path: schemas/payment.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-payments-200.yaml added-get-service-transfers-200: additionalProperties: false properties: data: items: additionalProperties: false description: An object representing a Service Transfer. properties: created: description: When this transfer was created. example: '2021-02-11T16:37:03' format: date-time type: string entities: additionalProperties: false description: A collection of the services to include in this transfer request, separated by type. properties: linodes: description: An array containing the IDs of each of the Linodes included in this transfer. 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. example: '2021-02-12T16:37:03' format: date-time type: string x-linode-cli-display: 3 is_sender: description: __Filterable__ If the requesting account created this transfer. example: true type: boolean x-akamai: labels: - Filterable x-linode-cli-display: 4 x-linode-filterable: true status: description: |- __Filterable__ The status of the transfer request. `accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete. `canceled`: The transfer has been canceled by the sender. `completed`: The transfer has completed successfully. `failed`: The transfer has failed after initiation. `pending`: The transfer is ready to be accepted. `stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled. enum: - accepted - canceled - completed - failed - pending - stale example: pending type: string x-akamai: labels: - Filterable x-linode-cli-color: accepted: yellow canceled: 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. example: 123E4567-E89B-12D3-A456-426614174000 format: uuid type: string x-linode-cli-display: 1 updated: description: When this transfer was last updated. example: '2021-02-11T16:37:03' format: date-time type: string type: object x-akamai: file-path: schemas/service-transfer.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-service-transfers-200.yaml added-get-user-200: allOf: - additionalProperties: false 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. 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. example: example_user@linode.com format: email type: string x-linode-cli-display: 2 last_login: additionalProperties: false description: |- __Read-only__ Information for the most recent login attempt for this User. `null` if no login attempts have been made since creation of this User. Run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information. nullable: true properties: login_datetime: description: __Read-only__ The date and time of this User's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: description: __Read-only__ The result of the most recent login attempt for this User. enum: - successful - failed example: successful readOnly: true type: string readOnly: true type: object password_created: description: |- __Read-only__ The date and time when this User's current password was created. User passwords are first created during the Account sign-up process, and updated using the [Reset Password](https://login.linode.com/forgot/password) webpage. `null` if this User has not created a password yet. example: '2018-01-01T01:01:01' format: date-time nullable: true readOnly: true type: string restricted: description: If `true`, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: |- __Read-only__ A list of SSH Key labels added by this User. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this User is included in the `authorized_users` field of the following requests: - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk) example: - home-pc - laptop items: type: string readOnly: true type: array tfa_enabled: description: __Read-only__ A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: description: __Filterable__ 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). example: example_user maxLength: 32 minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true verified_phone_number: description: |- __Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number. example: '+5555555555' format: phone nullable: true readOnly: true type: string type: object x-akamai: file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: user_type: description: |- __Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: - `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user. - `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account. - `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user. - `default`. This applies to all regular, non-parent-child account users. enum: - parent - child - proxy - default example: parent readOnly: true type: string type: object x-akamai: file-path: schemas/user-type.yaml x-akamai: file-path: schemas/added-get-user-200.yaml added-get-users-200: additionalProperties: false properties: data: items: allOf: - additionalProperties: false 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. 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. example: example_user@linode.com format: email type: string x-linode-cli-display: 2 last_login: additionalProperties: false description: |- __Read-only__ Information for the most recent login attempt for this User. `null` if no login attempts have been made since creation of this User. Run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information. nullable: true properties: login_datetime: description: __Read-only__ The date and time of this User's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: description: __Read-only__ The result of the most recent login attempt for this User. enum: - successful - failed example: successful readOnly: true type: string readOnly: true type: object password_created: description: |- __Read-only__ The date and time when this User's current password was created. User passwords are first created during the Account sign-up process, and updated using the [Reset Password](https://login.linode.com/forgot/password) webpage. `null` if this User has not created a password yet. example: '2018-01-01T01:01:01' format: date-time nullable: true readOnly: true type: string restricted: description: If `true`, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: |- __Read-only__ A list of SSH Key labels added by this User. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this User is included in the `authorized_users` field of the following requests: - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk) example: - home-pc - laptop items: type: string readOnly: true type: array tfa_enabled: description: __Read-only__ A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: description: __Filterable__ 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). example: example_user maxLength: 32 minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true verified_phone_number: description: |- __Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number. example: '+5555555555' format: phone nullable: true readOnly: true type: string type: object x-akamai: file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: user_type: description: |- __Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: - `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user. - `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account. - `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user. - `default`. This applies to all regular, non-parent-child account users. enum: - parent - child - proxy - default example: parent readOnly: true type: string type: object x-akamai: file-path: schemas/user-type.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/added-get-users-200.yaml added-post-beta-program: additionalProperties: false description: The Beta Program ID to enroll in for your Account. properties: id: description: The unique identifier of the Beta Program. example: example_open type: string x-linode-cli-display: 1 required: - id type: object x-akamai: file-path: schemas/added-post-beta-program.yaml added-post-cancel-account: additionalProperties: false properties: comments: description: Any reason for cancelling the account, and any other comments you might have about your Linode service. example: I'm consolidating multiple accounts into one. type: string type: object x-akamai: file-path: schemas/added-post-cancel-account.yaml added-post-cancel-account-200: additionalProperties: false example: survey_link: https://alinktothesurvey.com properties: survey_link: description: A link to Linode's exit survey. type: string type: object x-akamai: file-path: schemas/added-post-cancel-account-200.yaml added-post-cancel-account-409: additionalProperties: false properties: errors: items: additionalProperties: false properties: reason: description: A string explaining that the account could not be canceled because there is an outstanding balance on the account that must be paid first. example: We were unable to charge your credit card for services rendered. We cannot cancel this account until the balance has been paid. type: string type: object type: array type: object x-akamai: file-path: schemas/added-post-cancel-account-409.yaml added-post-client: allOf: - additionalProperties: false description: A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](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. properties: id: description: __Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret). example: 2737bf16b39ab5d7b4a1 readOnly: true type: string x-linode-cli-display: 1 label: description: __Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account. example: Test_Client_1 maxLength: 512 minLength: 1 type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true public: default: false description: __Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. example: false type: boolean x-akamai: labels: - Filterable x-linode-cli-display: 4 x-linode-filterable: true redirect_uri: description: The location a successful log in from [login.linode.com](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. example: https://example.org/oauth/callback format: url type: string x-linode-cli-display: 5 secret: description: __Read-only__ 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. example: readOnly: true type: string status: description: __Read-only__ The status of this application. `active` by default. 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: __Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set. example: https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail format: url nullable: true readOnly: true type: string type: object x-akamai: file-path: schemas/oauth-client.yaml required: - label - redirect_uri x-akamai: file-path: schemas/added-post-client.yaml added-post-entity-transfer: additionalProperties: false properties: entities: additionalProperties: false description: A collection of the entities to include in this transfer request, separated by type. properties: linodes: description: An array containing the IDs of each of the Linodes included in this transfer. example: - 111 - 222 items: type: integer type: array x-linode-cli-display: 5 type: object required: - entities type: object x-akamai: file-path: schemas/added-post-entity-transfer.yaml added-post-pay-pal-payment-200: additionalProperties: false properties: checkout_token: description: __Read-only__ The checkout token generated for this Payment. 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. example: PAY-1234567890ABCDEFGHIJKLMN type: string type: object x-akamai: file-path: schemas/added-post-pay-pal-payment-200.yaml added-post-payment: additionalProperties: false properties: payment_method_id: description: The ID of the Payment Method to apply to the Payment. example: 123 type: integer usd: description: |- The amount in US Dollars of the Payment. - Can begin with or without `$`. - Commas (`,`) are not accepted. - Must end with a decimal expression, such as `.00` or `.99`. - Minimum: `$5.00` or the Account balance, whichever is lower. - Maximum: `$2000.00` or the Account balance up to `$50000.00`, whichever is greater. example: $120.50 pattern: ^\$?\d+\.\d{2}$ type: string type: object x-akamai: file-path: schemas/added-post-payment.yaml added-post-payment-method: additionalProperties: false description: Payment Method Request Object. properties: data: additionalProperties: false description: An object representing the credit card information you have on file with Linode to make Payments against your Account. properties: card_number: description: Your credit card number. No spaces or hyphens (`-`) 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. 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. - 1 = January - 2 = February - 3 = March - Etc. example: 12 maximum: 12 minimum: 1 type: integer expiry_year: description: |- A four-digit integer representing the expiration year of your credit card. The combination of `expiry_month` and `expiry_year` must result in a month/year combination of the current month or in the future. An expiration date set in the past is invalid. example: 2020 maxLength: 4 minLength: 4 type: integer required: - card_number - expiry_month - expiry_year - cvv type: object x-akamai: file-path: schemas/credit-card.yaml is_default: description: Whether this Payment Method is the default method for automatically processing service charges. example: true type: boolean x-linode-cli-display: 3 type: description: |- The type of Payment Method. Alternative Payment Methods including Google Pay and PayPal can be added using the Cloud Manager. See the [Manage Payment Methods](https://www.linode.com/docs/products/platform/billing/guides/payment-methods/) guide for details and instructions. enum: - credit_card example: credit_card type: string required: - type - data - is_default type: object x-akamai: file-path: schemas/added-post-payment-method.yaml added-post-promo-credit: additionalProperties: false properties: promo_code: description: The Promo Code. maxLength: 32 minLength: 1 type: string required: - promo_code type: object x-akamai: file-path: schemas/added-post-promo-credit.yaml added-post-service-transfer: additionalProperties: false properties: entities: additionalProperties: false description: A collection of the services to include in this transfer request, separated by type. properties: linodes: description: An array containing the IDs of each of the Linodes included in this transfer. example: - 111 - 222 items: type: integer type: array x-linode-cli-display: 5 type: object required: - entities type: object x-akamai: file-path: schemas/added-post-service-transfer.yaml added-post-user: allOf: - additionalProperties: false 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. 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. example: example_user@linode.com format: email type: string x-linode-cli-display: 2 last_login: additionalProperties: false description: |- __Read-only__ Information for the most recent login attempt for this User. `null` if no login attempts have been made since creation of this User. Run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information. nullable: true properties: login_datetime: description: __Read-only__ The date and time of this User's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: description: __Read-only__ The result of the most recent login attempt for this User. enum: - successful - failed example: successful readOnly: true type: string readOnly: true type: object password_created: description: |- __Read-only__ The date and time when this User's current password was created. User passwords are first created during the Account sign-up process, and updated using the [Reset Password](https://login.linode.com/forgot/password) webpage. `null` if this User has not created a password yet. example: '2018-01-01T01:01:01' format: date-time nullable: true readOnly: true type: string restricted: description: If `true`, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: |- __Read-only__ A list of SSH Key labels added by this User. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this User is included in the `authorized_users` field of the following requests: - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk) example: - home-pc - laptop items: type: string readOnly: true type: array tfa_enabled: description: __Read-only__ A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: description: __Filterable__ 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). example: example_user maxLength: 32 minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true verified_phone_number: description: |- __Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number. example: '+5555555555' format: phone nullable: true readOnly: true type: string type: object x-akamai: file-path: schemas/user.yaml required: - username - email x-akamai: file-path: schemas/added-post-user.yaml added-put-user-200: allOf: - additionalProperties: false 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. 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. example: example_user@linode.com format: email type: string x-linode-cli-display: 2 last_login: additionalProperties: false description: |- __Read-only__ Information for the most recent login attempt for this User. `null` if no login attempts have been made since creation of this User. Run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information. nullable: true properties: login_datetime: description: __Read-only__ The date and time of this User's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: description: __Read-only__ The result of the most recent login attempt for this User. enum: - successful - failed example: successful readOnly: true type: string readOnly: true type: object password_created: description: |- __Read-only__ The date and time when this User's current password was created. User passwords are first created during the Account sign-up process, and updated using the [Reset Password](https://login.linode.com/forgot/password) webpage. `null` if this User has not created a password yet. example: '2018-01-01T01:01:01' format: date-time nullable: true readOnly: true type: string restricted: description: If `true`, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: |- __Read-only__ A list of SSH Key labels added by this User. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this User is included in the `authorized_users` field of the following requests: - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk) example: - home-pc - laptop items: type: string readOnly: true type: array tfa_enabled: description: __Read-only__ A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: description: __Filterable__ 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). example: example_user maxLength: 32 minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true verified_phone_number: description: |- __Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number. example: '+5555555555' format: phone nullable: true readOnly: true type: string type: object x-akamai: file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: user_type: description: |- __Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: - `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user. - `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account. - `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user. - `default`. This applies to all regular, non-parent-child account users. enum: - parent - child - proxy - default example: parent readOnly: true type: string type: object x-akamai: file-path: schemas/user-type.yaml x-akamai: file-path: schemas/added-put-user-200.yaml agreements: additionalProperties: false description: Acknowledgment status for agreements on your account. When acknowledging any agreements, set them to `true` and omit any remainders. properties: eu_model: description: The acknowledgement status for the [cross-border data transfer](https://www.akamai.com/legal/compliance/privacy-trust-center/cross-border-data-transfer-statement) agreement. example: true type: boolean master_service_agreement: description: The acknowledgement status for Akamai's [master service agreement](https://www.linode.com/legal-msa/). example: true type: boolean privacy_policy: description: The acknowledgement status for Akamai's [privacy statement](https://www.akamai.com/legal/privacy-statement). example: true type: boolean type: object x-akamai: file-path: schemas/agreements.yaml beta-program-enrolled: additionalProperties: false description: An object representing an enrolled Beta Program for the Account. properties: description: description: __Read-only__ Additional details regarding the Beta Program. example: This is an open public beta for an example feature. nullable: true readOnly: true type: string x-linode-cli-display: 3 ended: description: |- __Filterable__, __Read-only__ The date-time that the Beta Program ended. `null` indicates that the Beta Program is ongoing. example: null format: date-time nullable: true readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 5 x-linode-filterable: true enrolled: description: __Filterable__, __Read-only__ The date-time of Account enrollment to the Beta Program. example: '2023-09-11T00:00:00' format: date-time readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 6 x-linode-filterable: true id: description: The unique identifier of the Beta Program. example: example_open type: string x-linode-cli-display: 1 label: description: __Filterable__, __Read-only__ The name of the Beta Program. example: Example Open Beta readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true started: description: __Filterable__, __Read-only__ The start date-time of the Beta Program. example: '2023-07-11T00:00:00' format: date-time readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 4 x-linode-filterable: true type: object x-akamai: file-path: schemas/beta-program-enrolled.yaml child-account: additionalProperties: false description: Child account object. properties: active_since: description: __Read-only__ The activation date and time for the child account. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string address_1: description: __Filterable__ First line of this child account's billing address. example: 123 Main Street maxLength: 64 type: string x-akamai: labels: - Filterable x-linode-filterable: true address_2: description: __Filterable__ Second line of this child account's billing address, if applicable. example: Suite A maxLength: 64 type: string x-akamai: labels: - Filterable x-linode-filterable: true balance: description: __Read-only__ This child account's balance, in US dollars. example: 200 readOnly: true type: number x-linode-cli-display: 4 balance_uninvoiced: description: __Read-only__ This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate. example: 145 readOnly: true type: number x-linode-cli-display: 4 billing_source: description: __Read-only__ The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment. enum: - external example: external readOnly: true type: string capabilities: description: __Read-only__ A list of the capabilities the child account supports. example: - Linodes - NodeBalancers - Block Storage - Object Storage items: type: string readOnly: true type: array city: description: __Filterable__ The city for this child account's billing address. example: San Diego maxLength: 24 type: string x-akamai: labels: - Filterable x-linode-filterable: true company: description: '__Filterable__ The company name for the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`. You can''t change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.' example: Acme maxLength: 128 type: string x-akamai: labels: - Filterable x-linode-filterable: true country: description: __Filterable__ The two-letter ISO 3166 country code for this child account's billing address. example: US type: string x-akamai: labels: - Filterable x-linode-filterable: true credit_card: additionalProperties: false description: __Read-only__ Information for the credit card you've assigned to this child account. properties: expiry: description: The expiration month and year of the credit card. example: 11/2024 type: string last_four: description: The last four digits of the credit card. example: 1111 type: string readOnly: true type: object email: description: __Filterable__ The email address of the owner of this child account. example: john.smith@linode.com maxLength: 128 type: string x-akamai: labels: - Filterable x-linode-cli-display: 3 x-linode-filterable: true euuid: description: __Read-only__ An external, unique identifier that Akamai assigned to the child account. example: A1BC2DEF-34GH-567I-J890KLMN12O34P56 format: uuid readOnly: true type: string first_name: description: '__Filterable__ The first name of the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`.' example: John maxLength: 50 type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true last_name: description: '__Filterable__ The last name of the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`.' example: Smith maxLength: 50 type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true phone: description: __Filterable__ The phone number for the owner of this child account. example: 858-555-1212 maxLength: 32 type: string x-akamai: labels: - Filterable x-linode-filterable: true state: description: |- __Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code. __Note__. If this is a US military address, use state abbreviations (AA, AE, AP). example: CA maxLength: 24 type: string x-akamai: labels: - Filterable x-linode-filterable: true tax_id: description: The tax identification number for this child account. Use this for tax calculations in some countries. If you live in a country that doesn't collect taxes, ensure this is an empty string (`""`). example: ATU99999999 maxLength: 25 type: string zip: description: |- __Filterable__ The zip code of this Account's billing address. The following restrictions apply: - Can only contain ASCII letters, numbers, and hyphens (`-`). - Can't contain more than 9 letter or number characters. example: 92111-1234 type: string x-akamai: labels: - Filterable x-linode-filterable: true type: object x-akamai: file-path: schemas/child-account.yaml credit-card: additionalProperties: false description: An object representing the credit card information you have on file with Linode to make Payments against your Account. properties: card_number: description: Your credit card number. No spaces or hyphens (`-`) 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. 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. - 1 = January - 2 = February - 3 = March - Etc. example: 12 maximum: 12 minimum: 1 type: integer expiry_year: description: |- A four-digit integer representing the expiration year of your credit card. The combination of `expiry_month` and `expiry_year` must result in a month/year combination of the current month or in the future. An expiration date set in the past is invalid. example: 2020 maxLength: 4 minLength: 4 type: integer required: - card_number - expiry_month - expiry_year - cvv type: object x-akamai: file-path: schemas/credit-card.yaml credit-card-data: additionalProperties: false description: Credit card information. properties: card_type: description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Credit card type: object x-akamai: file-path: schemas/credit-card-data.yaml description: description: __Read-only__ Additional details regarding the Beta Program. example: This is an open public beta for an example feature. nullable: true readOnly: true type: string x-linode-cli-display: 3 ended: description: |- __Filterable__, __Read-only__ The date-time that the Beta Program ended. `null` indicates that the Beta Program is ongoing. example: null format: date-time nullable: true readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 6 x-linode-filterable: true entities: additionalProperties: false description: A collection of the entities to include in this transfer request, separated by type. properties: linodes: description: An array containing the IDs of each of the Linodes included in this transfer. example: - 111 - 222 items: type: integer type: array x-linode-cli-display: 5 type: object entity-transfer: additionalProperties: false description: An object representing an Entity Transfer. properties: created: description: When this transfer was created. example: '2021-02-11T16:37:03' format: date-time type: string entities: additionalProperties: false description: A collection of the entities to include in this transfer request, separated by type. properties: linodes: description: An array containing the IDs of each of the Linodes included in this transfer. 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. example: '2021-02-12T16:37:03' format: date-time type: string x-linode-cli-display: 3 is_sender: description: __Filterable__ If the requesting account created this transfer. example: true type: boolean x-akamai: labels: - Filterable x-linode-cli-display: 4 x-linode-filterable: true status: description: |- __Filterable__ The status of the transfer request: `accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete. `canceled`: The transfer has been canceled by the sender. `completed`: The transfer has completed successfully. `failed`: The transfer has failed after initiation. `pending`: The transfer is ready to be accepted. `stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled. enum: - accepted - canceled - completed - failed - pending - stale example: pending type: string x-akamai: labels: - Filterable x-linode-cli-color: accepted: yellow canceled: 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. example: 123E4567-E89B-12D3-A456-426614174000 format: uuid type: string x-linode-cli-display: 1 updated: description: When this transfer was last updated. example: '2021-02-11T16:37:03' format: date-time type: string type: object x-akamai: file-path: schemas/entity-transfer.yaml error-object: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. 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. 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](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml event: additionalProperties: false 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. The Events returned depends on your grants. properties: action: description: __Filterable__, __Read-only__ The action that caused this Event. New actions may be added in the future. 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_apply - 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_cluster_create - lke_cluster_update - lke_cluster_delete - lke_cluster_recycle - lke_cluster_regenerate - lke_node_create - lke_node_delete - lke_node_recycle - lke_pool_create - lke_pool_delete - lke_pool_recycle - lke_kubeconfig_regenerate - lke_token_rotate - 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 - obj_access_key_create - obj_access_key_delete - obj_access_key_update - password_reset - payment_method_add - payment_submitted - placement_group_assign - placement_group_became_compliant - placement_group_became_non_compliant - placement_group_create - placement_group_delete - placement_group_unassign - placement_group_update - profile_update - stackscript_create - stackscript_delete - stackscript_update - stackscript_publicize - stackscript_revise - subnet_create - subnet_delete - subnet_update - 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 - vpc_create - vpc_delete - vpc_update example: ticket_create readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 3 x-linode-filterable: true created: description: __Filterable__, __Read-only__ When this Event was created. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 6 x-linode-filterable: true duration: description: __Read-only__ The total duration in seconds that it takes for the Event to complete. example: 300.56 readOnly: true type: number x-linode-cli-display: 7 entity: additionalProperties: false description: __Read-only__ Detailed information about the Event's entity, including ID, type, label, and URL used to access it. properties: id: description: |- __Filterable__ The unique ID for an Event's entity. Some Event entities do not have IDs associated with them, so they will not be returned when filtering by ID. These Events include: - `account` - `profile` Entities for some Events are assigned the ID of the Linode they correspond to. When filtering by ID for these Events, use the corresponding Linode's ID. These Events include: - `disks` - `backups` Tag Events use a tag's name for the entity ID field. When filtering by ID for tag Events, supply the name of the tag. example: 11111 type: integer x-akamai: labels: - Filterable x-linode-filterable: true label: description: The current label of this object. The label may reflect changes that occur with this Event. example: Problem booting my Linode type: string x-linode-cli-display: 5 type: description: __Filterable__, __Read-only__ The type of entity that is being referenced by the Event. enum: - account - backups - community - disks - domain - entity_transfer - firewall - image - ipaddress - linode - longview - loadbalancer - managed_service - nodebalancer - oauth_client - profile - stackscript - tag - ticket - token - user - user_ssh_key - volume example: ticket readOnly: true type: string x-akamai: labels: - Filterable 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. example: /v4/support/tickets/11111 type: string readOnly: true type: object id: description: __Filterable__, __Read-only__ The unique ID of this Event. example: 123 readOnly: true type: integer x-akamai: labels: - Filterable 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. example: None nullable: true type: string x-linode-cli-display: 9 percent_complete: description: __Read-only__ A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events. example: null nullable: true readOnly: true type: integer rate: description: __Read-only__ The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events. example: null nullable: true readOnly: true type: string read: description: __Filterable__, __Read-only__ If this Event has been read. example: true readOnly: true type: boolean x-akamai: labels: - Filterable x-linode-filterable: true secondary_entity: additionalProperties: false description: __Read-only__ Detailed information about the Event's secondary entity, which provides additional information for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions. properties: id: description: The ID of the object that is the secondary entity. example: linode/debian9 type: string label: description: The label of this object. example: linode1234 type: string type: description: __Read-only__ The type of entity that is being referenced by the Event. 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. example: /v4/linode/instances/1234 type: string readOnly: true type: object seen: description: __Read-only__ If this Event has been seen. example: true readOnly: true type: boolean status: description: __Read-only__ 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: __Read-only__ 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. example: null nullable: true readOnly: true type: string username: description: __Read-only__ The username of the User who caused the Event. example: exampleUser nullable: true readOnly: true type: string x-linode-cli-display: 2 type: object x-akamai: file-path: schemas/event.yaml google-pay-data: additionalProperties: false description: Google Pay information. properties: card_type: description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Google Pay type: object x-akamai: file-path: schemas/google-pay-data.yaml grant: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml grants-response: additionalProperties: false 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. properties: database: description: The grants this User has for each Database that is owned by this Account. items: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml type: array domain: description: The grants this User has for each Domain that is owned by this Account. items: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml type: array firewall: description: The grants this User has for each Firewall that is owned by this Account. items: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml type: array global: additionalProperties: false description: A structure containing the Account-level grants a User has. 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. __Parent and child accounts__ In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this grant can be added to a child account user, to give the user `read-write` access. This gives the child user unrestricted access to expected management operations, such as creating other child users. However, child users don't have write access to billing operations. The API issues a specific error message if a write operation is attempted by a child user. 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_placement_groups: description: If `true`, this User may add Placement Groups. 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 add_vpcs: description: If `true`, this User may add VPCs. example: true type: boolean cancel_account: description: If `true`, this User may cancel the entire Account. example: false type: boolean child_account_access: description: In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this gives a parent account access to endpoints that can be used to manage child accounts. Unrestricted parent account users have access to this grant, while restricted parent users don't. An unrestricted parent user can set this to `true` to add this grant to a restricted parent user. Displayed as `null` for all non-parent accounts. example: true nullable: true 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. items: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml type: array linode: description: The grants this User has for each Linode that is owned by this Account. items: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml type: array longview: description: The grants this User has for each Longview Client that is owned by this Account. items: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml type: array nodebalancer: description: The grants this User has for each NodeBalancer that is owned by this Account. items: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml type: array placement_group: description: The grants this User has for each Placement Group that is owned by this Account. items: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml type: array stackscript: description: The grants this User has for each StackScript that is owned by this Account. items: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml type: array volume: description: The grants this User has for each Block Storage Volume that is owned by this Account. items: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml type: array vpc: description: The grants this User has for each VPC that is owned by this Account. items: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. properties: id: description: The ID of the entity this grant applies to. example: 123 type: integer label: description: __Read-only__ The current label of the entity this grant applies to, for display purposes. 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. enum: - read_only - read_write example: read_only nullable: true type: string type: object x-akamai: file-path: schemas/grant.yaml type: array type: object x-akamai: file-path: schemas/grants-response.yaml id: description: The unique identifier of the Beta Program. example: example_open type: string x-linode-cli-display: 1 invoice: additionalProperties: false description: Account Invoice object. properties: billing_source: description: |- __Filterable__, __Read-only__ `akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai. `linode`: This Invoice was generated according to the default terms, prices, and discounts. enum: - akamai - linode example: linode readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 3.5 x-linode-filterable: true date: description: __Filterable__, __Read-only__ When this Invoice was generated. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true id: description: __Read-only__ The Invoice's unique ID. example: 123 readOnly: true type: integer x-linode-cli-display: 1 label: description: __Filterable__, __Read-only__ The Invoice's display label. example: Invoice readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 3 x-linode-filterable: true subtotal: description: __Read-only__ The amount of the Invoice before taxes in US Dollars. example: 120.25 readOnly: true type: number x-linode-cli-display: 4 tax: description: __Read-only__ 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: __Read-only__ The amount of tax broken down into subtotals by source. items: additionalProperties: false 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: __Filterable__, __Read-only__ The amount of the Invoice after taxes in US Dollars. example: 132.5 readOnly: true type: number x-akamai: labels: - Filterable x-linode-cli-display: 6 x-linode-filterable: true type: object x-akamai: file-path: schemas/invoice.yaml invoice-item: additionalProperties: false description: An InvoiceItem object. properties: amount: description: __Read-only__ 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: __Read-only__ The date the Invoice Item started, based on month. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 label: description: __Read-only__ The Invoice Item's display label. example: Linode 123 readOnly: true type: string x-linode-cli-display: 1 quantity: description: __Read-only__ The quantity of this Item for the specified Invoice. example: 4 readOnly: true type: integer region: description: |- __Read-only__ The ID of the applicable Region associated with this Invoice Item. `null` if there is no applicable Region. example: us-west nullable: true readOnly: true type: string x-linode-cli-display: 7 tax: description: __Read-only__ 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: __Read-only__ The date the Invoice Item ended, based on month. example: '2018-01-31T11:59:59' format: date-time readOnly: true type: string x-linode-cli-display: 3 total: description: __Read-only__ The price of this Item after taxes in US Dollars. example: 21.45 readOnly: true type: number x-linode-cli-display: 6 type: description: __Read-only__ The type of service, ether `hourly` or `misc`. enum: - hourly - misc example: hourly readOnly: true type: string unit_price: description: __Read-only__ The monthly service fee in US Dollars for this Item. example: 5.05 readOnly: true type: string type: object x-akamai: file-path: schemas/invoice-item.yaml is_default: description: Whether this Payment Method is the default method for automatically processing service charges. example: true type: boolean x-linode-cli-display: 3 label: description: __Filterable__, __Read-only__ The name of the Beta Program. example: Example Open Beta readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true login: additionalProperties: false description: An object representing a previous successful login for a User. properties: datetime: description: __Read-only__ When the login was initiated. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 id: description: __Read-only__ The unique ID of this login object. example: 1234 readOnly: true type: integer x-linode-cli-display: 1 ip: description: __Read-only__ The remote IP address that requested the login. example: 192.0.2.0 format: ip readOnly: true type: string x-linode-cli-display: 3 restricted: description: __Read-only__ True if the User that attempted the login was a restricted User, false otherwise. example: true readOnly: true type: boolean x-linode-cli-display: 6 status: description: __Read-only__ Whether the login attempt succeeded or failed. enum: - successful - failed example: successful readOnly: true type: string x-linode-cli-display: 5 username: description: __Read-only__ The username of the User that attempted the login. example: example_user readOnly: true type: string x-linode-cli-display: 4 type: object x-akamai: file-path: schemas/login.yaml maintenance: additionalProperties: false description: Information about maintenance affecting an entity. properties: entity: additionalProperties: false description: The entity being affected by maintenance. properties: id: description: The id of the entity being affected by maintenance. example: 1234 type: number label: description: The label of the entity being affected by maintenance. example: demo-linode type: string type: description: The type of entity. 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. example: https://api.linode.com/v4/linode/instances/{linodeId} type: string type: object reason: description: The reason maintenance is being performed. example: This maintenance will allow us to update the BIOS on the host's motherboard. type: string status: description: |- __Filterable__ The maintenance status. Maintenance progresses in the following sequence: pending, started, then completed. enum: - completed - pending - started example: started type: string x-akamai: labels: - Filterable x-linode-filterable: true type: description: __Filterable__ The type of maintenance. enum: - reboot - cold_migration - live_migration example: reboot type: string x-akamai: labels: - Filterable x-linode-filterable: true when: description: |- __Filterable__ When the maintenance will begin. [Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters: - A single value in date-time string format (`%Y-%m-%dT%H:%M:%S`), which returns only matches to that value. - A dictionary containing pairs of inequality operator string keys (`+or`, `+gt`, `+gte`, `+lt`, `+lte`, or `+neq`) and single date-time string format values (`%Y-%m-%dT%H:%M:%S`). `+or` accepts an array of values that may consist of single date-time strings or dictionaries of inequality operator pairs. example: '2020-07-09T00:01:01' format: date-time type: string x-akamai: labels: - Filterable x-linode-filterable: true type: object x-akamai: file-path: schemas/maintenance.yaml notification: additionalProperties: false description: An important, often time-sensitive item related to your account. properties: body: description: __Read-only__ A full description of this notification, in markdown format. Not all notifications include a `body`. example: null nullable: true readOnly: true type: string entity: additionalProperties: false description: __Read-only__ Detailed information about the notification. properties: id: description: The unique ID of the notification's entity, based on the entity type. Returns `null` for an `account` or `promotion` entity. example: 3456 nullable: true type: integer label: description: |- The current label for this notification's entity. Returns `null` for the following entity types: - `entity_transfer` - `promotion` - `region` example: Linode not booting. nullable: true type: string type: description: The type of entity this is related to. enum: - account - entity_transfer - linode - loadbalancers - nodebalancer - promotion - region - ticket - volume example: ticket type: string url: description: The URL where you can access the notification's object. The URL is relative to the domain where you retrieved the notification. This value is `null` for the `promotion` entity type. example: /support/tickets/3456 nullable: true type: string readOnly: true type: object label: description: __Read-only__ A short description of this notification. example: You have an important ticket open! readOnly: true type: string x-linode-cli-display: 1 message: description: __Read-only__ 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: __Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. 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: __Read-only__ The type of notification. 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: __Read-only__ If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window. example: null format: date-time nullable: true readOnly: true type: string x-linode-cli-color: None: black default_: white x-linode-cli-display: 5 when: description: __Read-only__ If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration. example: null format: date-time nullable: true readOnly: true type: string x-linode-cli-color: None: black default_: white x-linode-cli-display: 4 type: object x-akamai: file-path: schemas/notification.yaml oauth-client: additionalProperties: false description: A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](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. properties: id: description: __Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret). example: 2737bf16b39ab5d7b4a1 readOnly: true type: string x-linode-cli-display: 1 label: description: __Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account. example: Test_Client_1 maxLength: 512 minLength: 1 type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true public: default: false description: __Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. example: false type: boolean x-akamai: labels: - Filterable x-linode-cli-display: 4 x-linode-filterable: true redirect_uri: description: The location a successful log in from [login.linode.com](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. example: https://example.org/oauth/callback format: url type: string x-linode-cli-display: 5 secret: description: __Read-only__ 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. example: readOnly: true type: string status: description: __Read-only__ The status of this application. `active` by default. 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: __Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set. example: https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail format: url nullable: true readOnly: true type: string type: object x-akamai: file-path: schemas/oauth-client.yaml page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pagination-envelope: additionalProperties: false 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](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. properties: page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/pagination-envelope.yaml payment: additionalProperties: false description: Payment object response. properties: date: description: __Read-only__ When the Payment was made. example: '2018-01-15T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 id: description: __Read-only__ The unique ID of the Payment. example: 123 readOnly: true type: integer x-linode-cli-display: 1 usd: description: __Read-only__ The amount, in US dollars, of the Payment. example: '120.50' readOnly: true type: integer x-linode-cli-display: 3 type: object x-akamai: file-path: schemas/payment.yaml payment-method: additionalProperties: false description: Payment Method Response Object. properties: created: description: __Read-only__ When the Payment Method was added to the Account. example: '2018-01-15T00:01:01' format: date-time readOnly: true type: string data: oneOf: - additionalProperties: false description: Credit card information. properties: card_type: description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Credit card type: object x-akamai: file-path: schemas/credit-card-data.yaml x-linode-ref-name: Credit Card - additionalProperties: false description: Google Pay information. properties: card_type: description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Google Pay type: object x-akamai: file-path: schemas/google-pay-data.yaml x-linode-ref-name: Google Pay - additionalProperties: false description: PayPal information. properties: email: description: __Read-only__ The email address associated with your PayPal account. example: example@linode.com readOnly: true type: string paypal_id: description: __Read-only__ PayPal Merchant ID associated with your PayPal account. example: ABC1234567890 readOnly: true type: string title: Paypal type: object x-akamai: file-path: schemas/paypal-data.yaml 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. 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 x-akamai: file-path: schemas/payment-method.yaml paypal: additionalProperties: false description: An object representing the staging of a Payment via PayPal. properties: cancel_url: description: The URL to have PayPal redirect to when Payment is canceled. 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 x-akamai: file-path: schemas/paypal.yaml paypal-data: additionalProperties: false description: PayPal information. properties: email: description: __Read-only__ The email address associated with your PayPal account. example: example@linode.com readOnly: true type: string paypal_id: description: __Read-only__ PayPal Merchant ID associated with your PayPal account. example: ABC1234567890 readOnly: true type: string title: Paypal type: object x-akamai: file-path: schemas/paypal-data.yaml paypal-execute: additionalProperties: false description: An object representing an execution of Payment to PayPal to capture the funds and credit your Linode Account. properties: payer_id: description: The PayerID returned by PayPal during the transaction authorization process. example: ABCDEFGHIJKLM type: string payment_id: description: The PaymentID returned from [Stage a PayPal payment](https://techdocs.akamai.com/linode-api/reference/post-pay-pal-payment) that has been approved with PayPal. example: PAY-1234567890ABCDEFGHIJKLMN type: string required: - payer_id - payment_id type: object x-akamai: file-path: schemas/paypal-execute.yaml promotion: additionalProperties: false description: |- __Read-only__ Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set. Simply put, a promotion offers a certain amount of credit month, until either the expiration date is passed, or until the total promotional credit is used, whichever comes first. properties: credit_monthly_cap: description: The amount available to spend per month. example: '10.00' type: string x-linode-cli-display: 5 credit_remaining: description: The total amount of credit left for this promotion. example: '50.00' type: string x-linode-cli-display: 3 description: description: A detailed description of this promotion. 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. example: '2018-01-31T23:59:59' type: string x-linode-cli-display: 2 image_url: description: The location of an image for this promotion. example: https://linode.com/10_a_month_promotion.svg type: string service_type: description: The service to which this promotion applies. enum: - all - backup - blockstorage - db_mysql - ip_v4 - linode - linode_disk - linode_memory - longview - managed - nodebalancer - objectstorage - placement_group - transfer_tx example: all type: string x-linode-cli-display: 1 summary: description: Short details of this promotion. 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. example: '10.00' type: string x-linode-cli-display: 4 readOnly: true type: object x-akamai: file-path: schemas/promotion.yaml properties-entities: additionalProperties: false description: A collection of the services to include in this transfer request, separated by type. properties: linodes: description: An array containing the IDs of each of the Linodes included in this transfer. example: - 111 - 222 items: type: integer type: array x-linode-cli-display: 5 type: object proxy-user-token: additionalProperties: false description: The token generated manually for a child account so its proxy user can access the API and CLI without going through an OAuth login. properties: created: description: __Filterable__, __Read-only__ The date and time this token was created. example: '2024-05-01T00:01:01' format: date-time readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 4 x-linode-filterable: true expiry: description: __Read-only__ When this token expires. This is default set to 15 minutes from the time of creation. Proxy user tokens can't be renewed. After this time, Akamai revokes the token and you need to generate a new one. example: '2024-05-01T00:16:01' format: date-time readOnly: true type: string x-linode-cli-display: 6 id: description: __Read-only__ The proxy user token's unique ID, which can be used to revoke it. example: 918 readOnly: true type: integer x-linode-cli-display: 1 label: description: __Filterable__ The name of the token. The API automatically sets this to `__