diff --git a/openapi.yaml b/openapi.yaml index 32f9d0ca4..69b66429c 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -33,7 +33,7 @@ components: schema: type: string eeuid: - description: The child account to look up. You can run the [List child accounts](ref:get-child-accounts) operation to find the applicable account and store its `euuid`. + 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 @@ -61,7 +61,7 @@ components: schema: type: integer id-path: - description: The slug for the applicable data center. Run the [List regions](ref:get-regions) operation to view the slug for each data center. + 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 @@ -161,6 +161,8 @@ components: type: object type: array type: object + x-example: + x-ref: ../examples/tbd.json description: Could not charge the credit card on file. accepted-response: content: @@ -184,10 +186,10 @@ components: type: object type: array type: object - description: 'Accepted with warning. + description: |- + Accepted with warning. - - A warnings array is included with the standard 200 response body.' + A warnings array is included with the standard 200 response body. deprecated-response: content: application/json: @@ -210,10 +212,10 @@ components: type: object type: array type: object - description: 'Request successful. This operation is deprecated and may be removed in a future release. - + 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.' + A warnings array is included with the standard 200 response body. error-response: content: application/json: @@ -230,13 +232,13 @@ components: 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](ref:post-ticket) or perform some other action before you can complete the request successfully. + 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 type: array type: object - description: See [Errors](ref:errors) for the range of possible error response codes. + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. schemas: account: additionalProperties: false @@ -245,19 +247,21 @@ components: 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. - + description: |- + 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.' + 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. @@ -266,6 +270,7 @@ components: 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 @@ -289,20 +294,23 @@ components: - 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 readOnly: true type: array active_since: - description: __Read-only__ The date and time the account was activated. + description: The date and time the account was activated. example: '2018-01-01T00:01:01' format: date-time readOnly: true @@ -318,17 +326,19 @@ components: maxLength: 64 type: string balance: - description: __Read-only__ This Account's balance, in US dollars. + description: 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. + description: This Account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate. 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`. + description: 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 @@ -336,7 +346,7 @@ components: readOnly: true type: string capabilities: - description: __Read-only__ A list of capabilities your account supports. + description: A list of capabilities your account supports. example: - Linodes - NodeBalancers @@ -354,10 +364,10 @@ components: maxLength: 24 type: string company: - description: 'The company name associated with this Account. + description: |- + The company name associated with this Account. - - Must not include any of the following characters: `<` `>` `(` `)` `"` `=`' + Must not include any of the following characters: `<` `>` `(` `)` `"` `=` example: Linode LLC maxLength: 128 type: string @@ -367,7 +377,7 @@ components: type: string credit_card: additionalProperties: false - description: __Read-only__ Credit Card information associated with this Account. + description: Credit Card information associated with this Account. properties: expiry: description: The expiration month and year of the credit card. @@ -384,28 +394,31 @@ components: 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. + description: 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. - + description: |- + The first name of the person associated with this Account. - Must not include any of the following characters: `<` `>` `(` `)` `"` `=`' + 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. + description: |- + The last name of the person associated with this Account. - - Must not include any of the following characters: `<` `>` `(` `)` `"` `=`' + 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 @@ -422,12 +435,11 @@ components: maxLength: 25 type: string zip: - description: 'The zip code of this Account''s billing address. The following restrictions apply: - + 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.' + - Must not contain more than 9 letter or number characters. example: 19102-1234 type: string type: object @@ -436,7 +448,7 @@ components: description: Account Service Availability object. properties: available: - description: __Read-only__ A list of services _available_ to your account in the `region`. + description: A list of services _available_ to your account in the `region`. example: - Linodes - NodeBalancers @@ -445,12 +457,13 @@ components: 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](ref:get-regions) operation. + description: 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`. + description: A list of services _unavailable_ to your account in the `region`. example: - Kubernetes - Block Storage @@ -458,6 +471,7 @@ components: type: string readOnly: true type: array + x-linode-cli-display: 3 type: object account-settings: additionalProperties: false @@ -467,23 +481,27 @@ components: 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](ref:get-longview-subscriptions) ID or `null` for Longview Free. + description: 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. + description: Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we'll monitor it for connectivity, response, and total request time. 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. + description: A string describing the status of this account's Object Storage service enrollment. enum: - disabled - suspended @@ -491,6 +509,7 @@ components: example: active readOnly: true type: string + x-linode-cli-display: 5 type: object added-empty-obj: additionalProperties: false @@ -506,54 +525,60 @@ components: description: An object representing a previous successful login for a User. properties: datetime: - description: __Read-only__ When the login was initiated. + description: 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. + description: 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. + description: 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. + description: 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. + description: 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. + description: The username of the User that attempted the login. example: example_user readOnly: true type: string + x-linode-cli-display: 4 type: object type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -568,7 +593,7 @@ components: description: Account Service Availability object. properties: available: - description: __Read-only__ A list of services _available_ to your account in the `region`. + description: A list of services _available_ to your account in the `region`. example: - Linodes - NodeBalancers @@ -577,12 +602,13 @@ components: 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](ref:get-regions) operation. + description: 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`. + description: A list of services _unavailable_ to your account in the `region`. example: - Kubernetes - Block Storage @@ -590,24 +616,25 @@ components: type: string readOnly: true type: array + x-linode-cli-display: 3 type: object 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](ref:pagination) for more information. + 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](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -621,40 +648,50 @@ components: description: Child account object. properties: active_since: - description: __Read-only__ The activation date and time for the child account. + description: 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. + description: 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. + description: 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. + description: 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. + description: 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. + description: 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. + description: A list of the capabilities the child account supports. example: - Linodes - NodeBalancers @@ -665,22 +702,34 @@ components: readOnly: true type: array city: - description: __Filterable__ The city for this child account's billing address. + description: 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.' + description: '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. + description: 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. + description: Information for the credit card you've assigned to this child account. properties: expiry: description: The expiration month and year of the credit card. @@ -693,67 +742,93 @@ components: readOnly: true type: object email: - description: __Filterable__ The email address of the owner of this child account. + description: 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. + description: 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: `<` `>` `(` `)` `"` `=`.' + description: '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: `<` `>` `(` `)` `"` `=`.' + description: '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. + description: 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. + description: |- + 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).' + __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: - + description: |- + 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.' + - 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 type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -767,33 +842,45 @@ components: 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). + description: 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. + description: 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. + description: If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](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. + description: The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. example: readOnly: true type: string status: - description: __Read-only__ The status of this application. `active` by default. + description: The status of this application. `active` by default. enum: - active - disabled @@ -801,8 +888,12 @@ components: 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. + description: 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 @@ -811,17 +902,17 @@ components: type: object type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -829,20 +920,20 @@ components: 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](ref:pagination) for more information. + 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](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -854,62 +945,84 @@ components: description: An object representing an enrolled Beta Program for the Account. properties: description: - description: __Read-only__ Additional details regarding the Beta Program. + description: 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. - + description: |- + The date-time that the Beta Program ended. - `null` indicates that the Beta Program is ongoing.' + `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. + description: 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. + description: 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. + description: 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 type: array type: object 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](ref:pagination) for more information. + 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](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -937,31 +1050,33 @@ components: 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. + description: 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: - + description: |- + 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.' + `stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled. enum: - accepted - canceled @@ -971,11 +1086,25 @@ components: - 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' @@ -992,7 +1121,7 @@ components: 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. + description: The action that caused this Event. New actions may be added in the future. enum: - account_update - account_settings_update @@ -1142,31 +1271,60 @@ components: 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. + description: 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. + description: 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. + description: 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.\n\nSome Event entities do not have IDs associated with them, so they will not be returned when filtering by ID. These Events include:\n\n - `account`\n - `profile`\n\nEntities 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:\n\n - `disks`\n - `backups`\n\nTag Events use a tag's name for the entity ID field. When filtering by ID for tag Events, supply the name of the tag." + description: |- + 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. + description: The type of entity that is being referenced by the Event. enum: - account - backups @@ -1194,6 +1352,10 @@ components: 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 @@ -1201,33 +1363,43 @@ components: readOnly: true type: object id: - description: __Filterable__, __Read-only__ The unique ID of this Event. + description: 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. + description: A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events. example: null 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. + description: The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events. example: null readOnly: true type: string read: - description: __Filterable__, __Read-only__ If this Event has been read. + description: 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. + description: 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. @@ -1238,7 +1410,7 @@ components: example: linode1234 type: string type: - description: __Read-only__ The type of entity that is being referenced by the Event. + description: The type of entity that is being referenced by the Event. example: linode readOnly: true type: string @@ -1249,12 +1421,12 @@ components: readOnly: true type: object seen: - description: __Read-only__ If this Event has been seen. + description: If this Event has been seen. example: true readOnly: true type: boolean status: - description: __Read-only__ The current status of this Event. + description: The current status of this Event. enum: - failed - finished @@ -1263,32 +1435,39 @@ components: - 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. + description: The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done. example: null nullable: true readOnly: true type: string username: - description: __Read-only__ The username of the User who caused the Event. + description: The username of the User who caused the Event. example: exampleUser nullable: true readOnly: true type: string + x-linode-cli-display: 2 type: object type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -1302,53 +1481,60 @@ components: 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. + description: The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity. example: 20.2 readOnly: true type: number + x-linode-cli-display: 4 from: - description: __Read-only__ The date the Invoice Item started, based on month. + description: 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. + description: 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. + description: 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. - + description: |- + The ID of the applicable Region associated with this Invoice Item. - `null` if there is no applicable Region.' + `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. + description: The amount of tax levied on this Item in US Dollars. example: 1.25 readOnly: true type: number + x-linode-cli-display: 5 to: - description: __Read-only__ The date the Invoice Item ended, based on month. + description: 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. + description: The price of this Item after taxes in US Dollars. example: 21.45 readOnly: true type: number + x-linode-cli-display: 6 type: - description: __Read-only__ The type of service, ether `hourly` or `misc`. + description: The type of service, ether `hourly` or `misc`. enum: - hourly - misc @@ -1356,24 +1542,24 @@ components: readOnly: true type: string unit_price: - description: __Read-only__ The monthly service fee in US Dollars for this Item. + description: The monthly service fee in US Dollars for this Item. example: 5.05 readOnly: true type: string type: object type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -1387,44 +1573,62 @@ components: 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. + description: |- + `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.' + `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. + description: 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. + description: 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. + description: 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. + description: The amount of the Invoice before taxes in US Dollars. example: 120.25 readOnly: true type: number + x-linode-cli-display: 4 tax: - description: __Read-only__ The amount of tax levied on the Invoice in US Dollars. + description: The amount of tax levied on the Invoice in US Dollars. example: 12.25 readOnly: true type: number + x-linode-cli-display: 5 tax_summary: - description: __Read-only__ The amount of tax broken down into subtotals by source. + description: The amount of tax broken down into subtotals by source. items: additionalProperties: false properties: @@ -1440,24 +1644,29 @@ components: readOnly: true type: array total: - description: __Filterable__, __Read-only__ The amount of the Invoice after taxes in US Dollars. + description: 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 type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -1496,52 +1705,62 @@ components: example: This maintenance will allow us to update the BIOS on the host's motherboard. type: string status: - description: '__Filterable__ The maintenance status. - + description: |- + The maintenance status. - Maintenance progresses in the following sequence: pending, started, then completed.' + 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. + description: 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](ref:filtering-and-sorting) with the following parameters: + description: |- + 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.' + - 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 type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -1555,14 +1774,14 @@ components: 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`. + description: 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. + description: 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. @@ -1570,17 +1789,14 @@ components: nullable: true type: integer label: - description: 'The current label for this notification''s entity. - + description: |- + The current label for this notification's entity. Returns `null` for the following entity types: - - `entity_transfer` - - `promotion` - - - `region`' + - `region` example: Linode not booting. nullable: true type: string @@ -1606,17 +1822,19 @@ components: readOnly: true type: object label: - description: __Read-only__ A short description of this notification. + description: 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. + description: A human-readable description of the notification. example: You have an important ticket open! readOnly: true type: string + x-linode-cli-display: 2 severity: - description: __Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. + description: The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. enum: - minor - major @@ -1624,8 +1842,13 @@ components: 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. + description: The type of notification. enum: - migration_scheduled - migration_imminent @@ -1642,31 +1865,39 @@ components: 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. + description: 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 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. + description: 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 readOnly: true type: string + x-linode-cli-color: + None: black + default_: white + x-linode-cli-display: 4 type: object type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -1680,78 +1911,87 @@ components: description: Payment Method Response Object. properties: created: - description: __Read-only__ When the Payment Method was added to the Account. + description: When the Payment Method was added to the Account. example: '2018-01-15T00:01:01' format: date-time readOnly: true type: string data: + discriminator: + propertyName: type oneOf: - additionalProperties: false description: Credit card information. properties: card_type: - description: __Read-only__ The type of credit card. + description: The type of credit card. example: Discover readOnly: true type: string expiry: - description: __Read-only__ The expiration month and year of the credit card. + description: 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. + description: The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Credit card type: object + x-linode-ref-name: Credit Card - additionalProperties: false description: Google Pay information. properties: card_type: - description: __Read-only__ The type of credit card. + description: The type of credit card. example: Discover readOnly: true type: string expiry: - description: __Read-only__ The expiration month and year of the credit card. + description: 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. + description: The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Google Pay type: object + x-linode-ref-name: Google Pay - additionalProperties: false description: PayPal information. properties: email: - description: __Read-only__ The email address associated with your PayPal account. + description: 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. + description: PayPal Merchant ID associated with your PayPal account. example: ABC1234567890 readOnly: true type: string title: Paypal type: object + 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: @@ -1760,20 +2000,21 @@ components: - paypal example: credit_card type: string + x-linode-cli-display: 2 type: object type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -1787,35 +2028,38 @@ components: description: Payment object response. properties: date: - description: __Read-only__ When the Payment was made. + description: 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. + description: 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. + description: The amount, in US dollars, of the Payment. example: '120.50' readOnly: true type: integer + x-linode-cli-display: 3 type: object type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -1845,40 +2089,40 @@ components: 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. + description: 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. - + description: |- + 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.' + canceled. enum: - accepted - canceled @@ -1888,11 +2132,25 @@ components: - 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' @@ -1901,17 +2159,17 @@ components: type: object type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -1926,25 +2184,25 @@ components: 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. - + description: |- + 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](ref:get-account-logins) operation for additional login information.' + 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. + description: 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. + description: The result of the most recent login attempt for this User. enum: - successful - failed @@ -1954,37 +2212,33 @@ components: readOnly: true type: object password_created: - description: '__Read-only__ The date and time when this User''s current password was created. - + description: |- + 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.' + `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](ref:get-user-grants) for details on how to configure grants for a restricted User. + 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](ref:post-add-ssh-key) operation. + description: |- + 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](ref:post-linode-instance) - - - [Rebuild a Linode](ref:post-rebuild-linode-instance) - - - [Create a disk](ref:post-add-linode-disk)' + - [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 @@ -1993,22 +2247,27 @@ components: 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](ref:post-tfa-enable) operation to enable TFA. + description: 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). + description: The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). 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](ref:post-profile-phone-number-verify) operation. - + description: |- + 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.' + `null` if this User Profile has no verified phone number. example: '+5555555555' format: phone nullable: true @@ -2019,19 +2278,16 @@ components: 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: + description: |- + 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. - - `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. - - `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](ref: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.' + - `default`. This applies to all regular, non-parent-child account users. enum: - parent - child @@ -2055,25 +2311,25 @@ components: 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. - + description: |- + 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](ref:get-account-logins) operation for additional login information.' + 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. + description: 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. + description: The result of the most recent login attempt for this User. enum: - successful - failed @@ -2083,37 +2339,33 @@ components: readOnly: true type: object password_created: - description: '__Read-only__ The date and time when this User''s current password was created. - + description: |- + 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.' + `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](ref:get-user-grants) for details on how to configure grants for a restricted User. + 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](ref:post-add-ssh-key) operation. + description: |- + 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](ref:post-linode-instance) - - - [Rebuild a Linode](ref:post-rebuild-linode-instance) - - - [Create a disk](ref:post-add-linode-disk)' + - [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 @@ -2122,22 +2374,27 @@ components: 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](ref:post-tfa-enable) operation to enable TFA. + description: 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). + description: The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). 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](ref:post-profile-phone-number-verify) operation. - + description: |- + 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.' + `null` if this User Profile has no verified phone number. example: '+5555555555' format: phone nullable: true @@ -2148,19 +2405,16 @@ components: 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. + description: |- + 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. + - `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. - - `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](ref: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.' + - `default`. This applies to all regular, non-parent-child account users. enum: - parent - child @@ -2172,17 +2426,17 @@ components: type: object type: array page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -2195,6 +2449,7 @@ components: description: The unique identifier of the Beta Program. example: example_open type: string + x-linode-cli-display: 1 required: - id type: object @@ -2235,33 +2490,45 @@ components: 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). + description: 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. + description: 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. + description: If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](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. + description: The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. example: readOnly: true type: string status: - description: __Read-only__ The status of this application. `active` by default. + description: The status of this application. `active` by default. enum: - active - disabled @@ -2269,8 +2536,12 @@ components: 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. + description: 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 @@ -2295,6 +2566,7 @@ components: items: type: integer type: array + x-linode-cli-display: 5 type: object required: - entities @@ -2303,7 +2575,7 @@ components: additionalProperties: false properties: checkout_token: - description: __Read-only__ The checkout token generated for this Payment. + description: The checkout token generated for this Payment. example: EC-1A2B3C4D5E6F7G8H9 readOnly: true type: string @@ -2320,18 +2592,14 @@ components: example: 123 type: integer usd: - description: 'The amount in US Dollars of the Payment. - + 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.' + - Maximum: `$2000.00` or the Account balance up to `$50000.00`, whichever is greater. example: $120.50 pattern: ^\$?\d+\.\d{2}$ type: string @@ -2359,16 +2627,22 @@ components: minLength: 3 type: string expiry_month: - description: "A value from 1-12 representing the expiration month of your credit card.\n\n - 1 = January\n - 2 = February\n - 3 = March\n - Etc." + 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. + 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.' + 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 @@ -2383,13 +2657,13 @@ components: 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. - + 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.' + for details and instructions. enum: - credit_card example: credit_card @@ -2425,6 +2699,7 @@ components: items: type: integer type: array + x-linode-cli-display: 5 type: object required: - entities @@ -2439,25 +2714,25 @@ components: 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. - + description: |- + 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](ref:get-account-logins) operation for additional login information.' + 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. + description: 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. + description: The result of the most recent login attempt for this User. enum: - successful - failed @@ -2467,37 +2742,33 @@ components: readOnly: true type: object password_created: - description: '__Read-only__ The date and time when this User''s current password was created. - + description: |- + 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.' + `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](ref:get-user-grants) for details on how to configure grants for a restricted User. + 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](ref:post-add-ssh-key) operation. + description: |- + 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](ref:post-linode-instance) - - - [Rebuild a Linode](ref:post-rebuild-linode-instance) - - - [Create a disk](ref:post-add-linode-disk)' + - [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 @@ -2506,22 +2777,27 @@ components: 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](ref:post-tfa-enable) operation to enable TFA. + description: 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). + description: The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). 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](ref:post-profile-phone-number-verify) operation. + description: |- + 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.' + `null` if this User Profile has no verified phone number. example: '+5555555555' format: phone nullable: true @@ -2541,25 +2817,25 @@ components: 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. - + description: |- + 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](ref:get-account-logins) operation for additional login information.' + 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. + description: 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. + description: The result of the most recent login attempt for this User. enum: - successful - failed @@ -2569,37 +2845,33 @@ components: readOnly: true type: object password_created: - description: '__Read-only__ The date and time when this User''s current password was created. - + description: |- + 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.' + `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](ref:get-user-grants) for details on how to configure grants for a restricted User. + 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](ref:post-add-ssh-key) operation. + description: |- + 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](ref:post-linode-instance) - - - [Rebuild a Linode](ref:post-rebuild-linode-instance) - - - [Create a disk](ref:post-add-linode-disk)' + - [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 @@ -2608,22 +2880,27 @@ components: 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](ref:post-tfa-enable) operation to enable TFA. + description: 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). + description: The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). 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](ref:post-profile-phone-number-verify) operation. + description: |- + 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.' + `null` if this User Profile has no verified phone number. example: '+5555555555' format: phone nullable: true @@ -2634,19 +2911,16 @@ components: 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: - + description: |- + 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. + - `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. - - `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. - - - `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](ref: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.' + - `default`. This applies to all regular, non-parent-child account users. enum: - parent - child @@ -2678,82 +2952,114 @@ components: description: An object representing an enrolled Beta Program for the Account. properties: description: - description: __Read-only__ Additional details regarding the Beta Program. + description: 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. + description: |- + The date-time that the Beta Program ended. - - `null` indicates that the Beta Program is ongoing.' + `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. + description: 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. + description: 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. + description: 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 child-account: additionalProperties: false description: Child account object. properties: active_since: - description: __Read-only__ The activation date and time for the child account. + description: 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. + description: 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. + description: 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. + description: 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. + description: 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. + description: 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. + description: A list of the capabilities the child account supports. example: - Linodes - NodeBalancers @@ -2764,22 +3070,34 @@ components: readOnly: true type: array city: - description: __Filterable__ The city for this child account's billing address. + description: 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.' + description: '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. + description: 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. + description: Information for the credit card you've assigned to this child account. properties: expiry: description: The expiration month and year of the credit card. @@ -2792,53 +3110,79 @@ components: readOnly: true type: object email: - description: __Filterable__ The email address of the owner of this child account. + description: 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. + description: 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: `<` `>` `(` `)` `"` `=`.' + description: '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: `<` `>` `(` `)` `"` `=`.' + description: '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. + description: 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. - + description: |- + 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).' + __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: - + description: |- + 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.' + - 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 credit-card: additionalProperties: false @@ -2859,16 +3203,22 @@ components: minLength: 3 type: string expiry_month: - description: "A value from 1-12 representing the expiration month of your credit card.\n\n - 1 = January\n - 2 = February\n - 3 = March\n - Etc." + 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. - + 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.' + 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 @@ -2884,39 +3234,45 @@ components: description: Credit card information. properties: card_type: - description: __Read-only__ The type of credit card. + description: The type of credit card. example: Discover readOnly: true type: string expiry: - description: __Read-only__ The expiration month and year of the credit card. + description: 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. + description: The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Credit card type: object description: - description: __Read-only__ Additional details regarding the Beta Program. + description: 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. + description: |- + The date-time that the Beta Program ended. - - `null` indicates that the Beta Program is ongoing.' + `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. @@ -2929,6 +3285,7 @@ components: items: type: integer type: array + x-linode-cli-display: 5 type: object entity-transfer: additionalProperties: false @@ -2951,31 +3308,33 @@ components: 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. + description: 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: - + description: |- + 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.' + `stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled. enum: - accepted - canceled @@ -2985,11 +3344,25 @@ components: - 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' @@ -3005,7 +3378,7 @@ components: 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](ref:post-ticket) or perform some other action before you can complete the request successfully. + 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 @@ -3014,7 +3387,7 @@ components: 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. + description: The action that caused this Event. New actions may be added in the future. enum: - account_update - account_settings_update @@ -3164,31 +3537,60 @@ components: 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. + description: 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. + description: 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. + description: 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.\n\nSome Event entities do not have IDs associated with them, so they will not be returned when filtering by ID. These Events include:\n\n - `account`\n - `profile`\n\nEntities 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:\n\n - `disks`\n - `backups`\n\nTag Events use a tag's name for the entity ID field. When filtering by ID for tag Events, supply the name of the tag." + description: |- + 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. + description: The type of entity that is being referenced by the Event. enum: - account - backups @@ -3216,6 +3618,10 @@ components: 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 @@ -3223,33 +3629,43 @@ components: readOnly: true type: object id: - description: __Filterable__, __Read-only__ The unique ID of this Event. + description: 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. + description: A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events. example: null 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. + description: The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events. example: null readOnly: true type: string read: - description: __Filterable__, __Read-only__ If this Event has been read. + description: 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. + description: 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. @@ -3260,7 +3676,7 @@ components: example: linode1234 type: string type: - description: __Read-only__ The type of entity that is being referenced by the Event. + description: The type of entity that is being referenced by the Event. example: linode readOnly: true type: string @@ -3271,12 +3687,12 @@ components: readOnly: true type: object seen: - description: __Read-only__ If this Event has been seen. + description: If this Event has been seen. example: true readOnly: true type: boolean status: - description: __Read-only__ The current status of this Event. + description: The current status of this Event. enum: - failed - finished @@ -3285,36 +3701,43 @@ components: - 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. + description: The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done. example: null nullable: true readOnly: true type: string username: - description: __Read-only__ The username of the User who caused the Event. + description: The username of the User who caused the Event. example: exampleUser nullable: true readOnly: true type: string + x-linode-cli-display: 2 type: object google-pay-data: additionalProperties: false description: Google Pay information. properties: card_type: - description: __Read-only__ The type of credit card. + description: The type of credit card. example: Discover readOnly: true type: string expiry: - description: __Read-only__ The expiration month and year of the credit card. + description: 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. + description: The last four digits of the credit card number. example: '1234' readOnly: true type: string @@ -3329,7 +3752,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3357,7 +3780,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3382,7 +3805,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3407,7 +3830,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3426,13 +3849,12 @@ components: 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. - + 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.' + 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 @@ -3459,6 +3881,12 @@ components: description: If true, this User may create Linodes. example: true type: boolean + add_loadbalancers: + description: If true, this User may add Cloud Load Balancers. + example: true + type: boolean + x-akamai: + exclude-reason: PRE_RELEASE add_longview: description: If true, this User may create Longview clients and view the current plan. example: true @@ -3507,7 +3935,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3532,7 +3960,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3557,7 +3985,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3582,7 +4010,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3607,7 +4035,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3632,7 +4060,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3657,7 +4085,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3682,7 +4110,7 @@ components: example: 123 type: integer label: - description: __Read-only__ The current label of the entity this grant applies to, for display purposes. + description: The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string @@ -3701,49 +4129,68 @@ components: 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. + description: |- + `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.' + `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. + description: 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. + description: 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. + description: 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. + description: The amount of the Invoice before taxes in US Dollars. example: 120.25 readOnly: true type: number + x-linode-cli-display: 4 tax: - description: __Read-only__ The amount of tax levied on the Invoice in US Dollars. + description: The amount of tax levied on the Invoice in US Dollars. example: 12.25 readOnly: true type: number + x-linode-cli-display: 5 tax_summary: - description: __Read-only__ The amount of tax broken down into subtotals by source. + description: The amount of tax broken down into subtotals by source. items: additionalProperties: false properties: @@ -3759,63 +4206,75 @@ components: readOnly: true type: array total: - description: __Filterable__, __Read-only__ The amount of the Invoice after taxes in US Dollars. + description: 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 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. + description: The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity. example: 20.2 readOnly: true type: number + x-linode-cli-display: 4 from: - description: __Read-only__ The date the Invoice Item started, based on month. + description: 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. + description: 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. + description: 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. - + description: |- + The ID of the applicable Region associated with this Invoice Item. - `null` if there is no applicable Region.' + `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. + description: The amount of tax levied on this Item in US Dollars. example: 1.25 readOnly: true type: number + x-linode-cli-display: 5 to: - description: __Read-only__ The date the Invoice Item ended, based on month. + description: 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. + description: The price of this Item after taxes in US Dollars. example: 21.45 readOnly: true type: number + x-linode-cli-display: 6 type: - description: __Read-only__ The type of service, ether `hourly` or `misc`. + description: The type of service, ether `hourly` or `misc`. enum: - hourly - misc @@ -3823,7 +4282,7 @@ components: readOnly: true type: string unit_price: - description: __Read-only__ The monthly service fee in US Dollars for this Item. + description: The monthly service fee in US Dollars for this Item. example: 5.05 readOnly: true type: string @@ -3832,50 +4291,62 @@ components: 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. + description: 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. + description: 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. + description: 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. + description: 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. + description: 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. + description: 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. + description: The username of the User that attempted the login. example: example_user readOnly: true type: string + x-linode-cli-display: 4 type: object maintenance: additionalProperties: false @@ -3907,52 +4378,62 @@ components: example: This maintenance will allow us to update the BIOS on the host's motherboard. type: string status: - description: '__Filterable__ The maintenance status. + description: |- + The maintenance status. - - Maintenance progresses in the following sequence: pending, started, then completed.' + 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. + description: 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](ref:filtering-and-sorting) with the following parameters: + description: |- + 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.' + - 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 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`. + description: 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. + description: 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. @@ -3960,17 +4441,14 @@ components: nullable: true type: integer label: - description: 'The current label for this notification''s entity. - + description: |- + The current label for this notification's entity. Returns `null` for the following entity types: - - `entity_transfer` - - `promotion` - - - `region`' + - `region` example: Linode not booting. nullable: true type: string @@ -3996,17 +4474,19 @@ components: readOnly: true type: object label: - description: __Read-only__ A short description of this notification. + description: 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. + description: A human-readable description of the notification. example: You have an important ticket open! readOnly: true type: string + x-linode-cli-display: 2 severity: - description: __Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. + description: The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. enum: - minor - major @@ -4014,8 +4494,13 @@ components: 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. + description: The type of notification. enum: - migration_scheduled - migration_imminent @@ -4032,50 +4517,70 @@ components: 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. + description: 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 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. + description: 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 readOnly: true type: string + x-linode-cli-color: + None: black + default_: white + x-linode-cli-display: 4 type: object 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). + description: 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. + description: 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. + description: If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](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. + description: The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. example: readOnly: true type: string status: - description: __Read-only__ The status of this application. `active` by default. + description: The status of this application. `active` by default. enum: - active - disabled @@ -4083,8 +4588,12 @@ components: 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. + description: 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 @@ -4092,31 +4601,31 @@ components: type: string type: object page: - description: __Read-only__ The current [page](ref:pagination). + description: 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](ref:pagination). + description: 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](ref:pagination) for more information. + 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](ref:pagination). + description: 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](ref:pagination). + description: 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. + description: The total number of results. example: 1 readOnly: true type: integer @@ -4126,99 +4635,111 @@ components: description: Payment object response. properties: date: - description: __Read-only__ When the Payment was made. + description: 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. + description: 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. + description: The amount, in US dollars, of the Payment. example: '120.50' readOnly: true type: integer + x-linode-cli-display: 3 type: object payment-method: additionalProperties: false description: Payment Method Response Object. properties: created: - description: __Read-only__ When the Payment Method was added to the Account. + description: When the Payment Method was added to the Account. example: '2018-01-15T00:01:01' format: date-time readOnly: true type: string data: + discriminator: + propertyName: type oneOf: - additionalProperties: false description: Credit card information. properties: card_type: - description: __Read-only__ The type of credit card. + description: The type of credit card. example: Discover readOnly: true type: string expiry: - description: __Read-only__ The expiration month and year of the credit card. + description: 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. + description: The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Credit card type: object + x-linode-ref-name: Credit Card - additionalProperties: false description: Google Pay information. properties: card_type: - description: __Read-only__ The type of credit card. + description: The type of credit card. example: Discover readOnly: true type: string expiry: - description: __Read-only__ The expiration month and year of the credit card. + description: 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. + description: The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Google Pay type: object + x-linode-ref-name: Google Pay - additionalProperties: false description: PayPal information. properties: email: - description: __Read-only__ The email address associated with your PayPal account. + description: 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. + description: PayPal Merchant ID associated with your PayPal account. example: ABC1234567890 readOnly: true type: string title: Paypal type: object + 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: @@ -4227,6 +4748,7 @@ components: - paypal example: credit_card type: string + x-linode-cli-display: 2 type: object paypal: additionalProperties: false @@ -4254,12 +4776,12 @@ components: description: PayPal information. properties: email: - description: __Read-only__ The email address associated with your PayPal account. + description: 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. + description: PayPal Merchant ID associated with your PayPal account. example: ABC1234567890 readOnly: true type: string @@ -4274,7 +4796,7 @@ components: example: ABCDEFGHIJKLM type: string payment_id: - description: The PaymentID returned from [Stage a PayPal payment](ref:post-pay-pal-payment) that has been approved with PayPal. + 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: @@ -4283,19 +4805,21 @@ components: type: object 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. + description: |- + 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.' + 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. @@ -4304,6 +4828,7 @@ components: 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 @@ -4327,14 +4852,17 @@ components: - 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 properties-entities: @@ -4349,48 +4877,63 @@ components: 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. + description: 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. + description: 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. + description: 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 `__