From 1b8caaa8ea2ed3dd05084d5eaaf3a6eafd5e851c Mon Sep 17 00:00:00 2001 From: Chris Verner Date: Thu, 26 Sep 2024 10:14:21 -0700 Subject: [PATCH 1/2] Bump version to 4.186.0 --- openapi.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index ff4289a34..aca21001a 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -18188,7 +18188,7 @@ paths: id: mysql/8.0.26 total_disk_size_gb: 15 used_disk_size_gb: 2 - version: 8.0.26 + version: 4.186.06 page: 1 pages: 1 results: 1 @@ -18524,7 +18524,7 @@ paths: frequency: weekly hour_of_day: 0 week_of_month: null - version: 8.0.26 + version: 4.186.06 page: 1 pages: 1 results: 1 @@ -18901,7 +18901,7 @@ paths: hour_of_day: 0 week_of_month: null used_disk_size_gb: 2 - version: 8.0.26 + version: 4.186.06 page: 1 pages: 1 results: 1 From c5fe45915a418fe6d90ca929983ae252b49b2a1a Mon Sep 17 00:00:00 2001 From: Chris Verner Date: Tue, 15 Oct 2024 14:24:37 -0700 Subject: [PATCH 2/2] New openapi.yaml for API v4.189.0 --- openapi.yaml | 32753 +++++++++++++++++-------------------------------- 1 file changed, 11091 insertions(+), 21662 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index aca21001a..32f9d0ca4 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -11,8 +11,6 @@ components: - v4 - v4beta type: string - x-akamai: - file-path: parameters/api-version-path.yaml beta-id: description: The ID of the Beta Program. in: path @@ -20,8 +18,6 @@ components: required: true schema: type: string - x-akamai: - file-path: parameters/beta-id.yaml client-id-path: description: The OAuth Client ID to look up. in: path @@ -29,8 +25,6 @@ components: required: true schema: type: string - x-akamai: - file-path: parameters/client-id-path.yaml client-id-path-ecf807fb: description: The OAuth Client ID to look up. in: path @@ -38,17 +32,13 @@ components: required: true schema: type: string - x-akamai: - file-path: parameters/client-id-path-ecf807fb.yaml eeuid: - description: The child account to look up. You can run the [List child accounts](https://techdocs.akamai.com/linode-api/reference/get-child-accounts) operation to find the applicable account and store its `euuid`. + 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`. in: path name: euuid required: true schema: type: string - x-akamai: - file-path: parameters/eeuid.yaml event-id-path-214cd042: description: The ID of the Event to designate as seen. in: path @@ -56,8 +46,6 @@ components: required: true schema: type: integer - x-akamai: - file-path: parameters/event-id-path-214cd042.yaml event-id-path-39255fcf: description: The ID of the Event. in: path @@ -65,8 +53,6 @@ components: required: true schema: type: integer - x-akamai: - file-path: parameters/event-id-path-39255fcf.yaml event-id-path-625aa248: description: The ID of the Event to designate as read. in: path @@ -74,17 +60,13 @@ components: required: true schema: type: integer - x-akamai: - file-path: parameters/event-id-path-625aa248.yaml id-path: - description: The slug for the applicable data center. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the slug for each data center. + description: The slug for the applicable data center. Run the [List regions](ref:get-regions) operation to view the slug for each data center. in: path name: id required: true schema: type: string - x-akamai: - file-path: parameters/id-path.yaml invoice-id-path: description: The ID of the Invoice. in: path @@ -92,8 +74,6 @@ components: required: true schema: type: integer - x-akamai: - file-path: parameters/invoice-id-path.yaml login-id-path: description: The ID of the login object to access. in: path @@ -101,8 +81,6 @@ components: required: true schema: type: integer - x-akamai: - file-path: parameters/login-id-path.yaml page-offset: description: The page of a collection to return. in: query @@ -112,8 +90,6 @@ components: default: 1 minimum: 1 type: integer - x-akamai: - file-path: parameters/page-offset.yaml page-size: description: The number of items to return per page. in: query @@ -123,8 +99,6 @@ components: maximum: 500 minimum: 25 type: integer - x-akamai: - file-path: parameters/page-size.yaml payment-id-path: description: The ID of the Payment to look up. in: path @@ -132,8 +106,6 @@ components: required: true schema: type: integer - x-akamai: - file-path: parameters/payment-id-path.yaml payment-method-id-path-6078bc7b: description: The ID of the Payment Method to look up. in: path @@ -141,8 +113,6 @@ components: required: true schema: type: integer - x-akamai: - file-path: parameters/payment-method-id-path-6078bc7b.yaml payment-method-id-path-fb39a844: description: The ID of the Payment Method to make default. in: path @@ -150,8 +120,6 @@ components: required: true schema: type: integer - x-akamai: - file-path: parameters/payment-method-id-path-fb39a844.yaml token-path-f857f5a2: description: The UUID of the Service Transfer. in: path @@ -160,8 +128,6 @@ components: schema: format: uuid type: string - x-akamai: - file-path: parameters/token-path-f857f5a2.yaml token-path-faf66b58: description: The UUID of the Entity Transfer. in: path @@ -170,8 +136,6 @@ components: schema: format: uuid type: string - x-akamai: - file-path: parameters/token-path-faf66b58.yaml username-path: description: The username to look up. in: path @@ -179,8 +143,6 @@ components: required: true schema: type: string - x-akamai: - file-path: parameters/username-path.yaml responses: '409': content: @@ -199,13 +161,7 @@ components: type: object type: array type: object - x-akamai: - file-path: schemas/added-post-cancel-account-409.yaml - x-example: - x-ref: ../examples/tbd.json description: Could not charge the credit card on file. - x-akamai: - file-path: errors/409.yaml accepted-response: content: application/json: @@ -226,8 +182,6 @@ components: example: Unable to reboot Linode. type: string type: object - x-akamai: - file-path: schemas/warning-object.yaml type: array type: object description: 'Accepted with warning. @@ -254,8 +208,6 @@ components: example: Unable to reboot Linode. type: string type: object - x-akamai: - file-path: schemas/warning-object.yaml type: array type: object description: 'Request successful. This operation is deprecated and may be removed in a future release. @@ -278,15 +230,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](https://techdocs.akamai.com/linode-api/reference/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](ref:post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object - x-akamai: - file-path: schemas/error-object.yaml type: array type: object - description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. + description: See [Errors](ref:errors) for the range of possible error response codes. schemas: account: additionalProperties: false @@ -304,12 +254,10 @@ components: 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. @@ -318,7 +266,6 @@ 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 @@ -342,21 +289,16 @@ 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 - x-akamai: - file-path: schemas/promotion.yaml readOnly: true type: array active_since: @@ -380,13 +322,11 @@ components: example: 200 readOnly: true type: number - x-linode-cli-display: 4 balance_uninvoiced: description: __Read-only__ This Account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate. example: 145 readOnly: true type: number - x-linode-cli-display: 4 billing_source: description: __Read-only__ The source of service charges for this Account, as determined by its relationship with Akamai. Accounts that are associated with Akamai-specific customers return a value of `akamai`. All other Accounts return a value of `linode`. enum: @@ -403,6 +343,7 @@ components: - Block Storage - Object Storage - Placement Groups + - Block Storage Encryption items: type: string readOnly: true @@ -443,7 +384,6 @@ 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. example: E1AF5EEC-526F-487D-B317EBEB34C87D71 @@ -458,7 +398,6 @@ components: example: John maxLength: 50 type: string - x-linode-cli-display: 1 last_name: description: 'The last name of the person associated with this Account. @@ -467,7 +406,6 @@ components: example: Smith maxLength: 50 type: string - x-linode-cli-display: 2 phone: description: The phone number associated with this Account. example: 215-555-1212 @@ -493,8 +431,6 @@ components: example: 19102-1234 type: string type: object - x-akamai: - file-path: schemas/account.yaml account-availability: additionalProperties: false description: Account Service Availability object. @@ -509,11 +445,10 @@ 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](https://techdocs.akamai.com/linode-api/reference/get-regions) operation. + 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. example: us-east readOnly: true type: string - x-linode-cli-display: 1 unavailable: description: __Read-only__ A list of services _unavailable_ to your account in the `region`. example: @@ -523,10 +458,7 @@ components: type: string readOnly: true type: array - x-linode-cli-display: 3 type: object - x-akamai: - file-path: schemas/account-availability.yaml account-settings: additionalProperties: false description: Account Settings object. @@ -535,24 +467,20 @@ 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](https://techdocs.akamai.com/linode-api/reference/get-longview-subscriptions) ID or `null` for Longview Free. + 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. example: longview-3 readOnly: true type: string - x-linode-cli-display: 2 managed: description: __Read-only__ Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we'll monitor it for connectivity, response, and total request time. example: true readOnly: true type: boolean - x-linode-cli-display: 3 network_helper: description: Enables network helper across all users by default for new Linodes and Linode Configs. example: false type: boolean - x-linode-cli-display: 1 object_storage: default: disabled description: __Read-only__ A string describing the status of this account's Object Storage service enrollment. @@ -563,17 +491,12 @@ components: example: active readOnly: true type: string - x-linode-cli-display: 5 type: object - x-akamai: - file-path: schemas/account-settings.yaml added-empty-obj: additionalProperties: false description: The API responds with an empty object. maxProperties: 0 type: object - x-akamai: - file-path: schemas/added-empty-obj.yaml added-get-account-logins-200: additionalProperties: false properties: @@ -588,26 +511,22 @@ components: format: date-time readOnly: true type: string - x-linode-cli-display: 2 id: description: __Read-only__ The unique ID of this login object. example: 1234 readOnly: true type: integer - x-linode-cli-display: 1 ip: description: __Read-only__ The remote IP address that requested the login. example: 192.0.2.0 format: ip readOnly: true type: string - x-linode-cli-display: 3 restricted: description: __Read-only__ True if the User that attempted the login was a restricted User, false otherwise. example: true readOnly: true type: boolean - x-linode-cli-display: 6 status: description: __Read-only__ Whether the login attempt succeeded or failed. enum: @@ -616,24 +535,20 @@ components: example: successful readOnly: true type: string - x-linode-cli-display: 5 username: description: __Read-only__ The username of the User that attempted the login. example: example_user readOnly: true type: string - x-linode-cli-display: 4 type: object - x-akamai: - file-path: schemas/login.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -643,8 +558,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-account-logins-200.yaml added-get-availability-200: allOf: - additionalProperties: false @@ -664,11 +577,10 @@ 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](https://techdocs.akamai.com/linode-api/reference/get-regions) operation. + 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. example: us-east readOnly: true type: string - x-linode-cli-display: 1 unavailable: description: __Read-only__ A list of services _unavailable_ to your account in the `region`. example: @@ -678,22 +590,19 @@ components: type: string readOnly: true type: array - x-linode-cli-display: 3 type: object - x-akamai: - file-path: schemas/account-availability.yaml type: array type: object - additionalProperties: false - description: An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. + 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. properties: page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -703,10 +612,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/pagination-envelope.yaml - x-akamai: - file-path: schemas/added-get-availability-200.yaml added-get-child-accounts-200: additionalProperties: false properties: @@ -726,31 +631,21 @@ components: example: 123 Main Street maxLength: 64 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true address_2: description: __Filterable__ Second line of this child account's billing address, if applicable. example: Suite A maxLength: 64 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true balance: description: __Read-only__ This child account's balance, in US dollars. example: 200 readOnly: true type: number - x-linode-cli-display: 4 balance_uninvoiced: description: __Read-only__ This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate. example: 145 readOnly: true type: number - x-linode-cli-display: 4 billing_source: description: __Read-only__ The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment. enum: @@ -774,27 +669,15 @@ components: example: San Diego maxLength: 24 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true company: description: '__Filterable__ The company name for the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`. You can''t change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.' example: Acme maxLength: 128 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true country: description: __Filterable__ The two-letter ISO 3166 country code for this child account's billing address. example: US type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true credit_card: additionalProperties: false description: __Read-only__ Information for the credit card you've assigned to this child account. @@ -814,11 +697,6 @@ components: example: john.smith@linode.com maxLength: 128 type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 3 - x-linode-filterable: true euuid: description: __Read-only__ An external, unique identifier that Akamai assigned to the child account. example: A1BC2DEF-34GH-567I-J890KLMN12O34P56 @@ -830,30 +708,16 @@ components: example: John maxLength: 50 type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 1 - x-linode-filterable: true last_name: description: '__Filterable__ The last name of the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`.' example: Smith maxLength: 50 type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 2 - x-linode-filterable: true phone: description: __Filterable__ The phone number for the owner of this child account. example: 858-555-1212 maxLength: 32 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true state: description: '__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code. @@ -862,10 +726,6 @@ components: 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 @@ -880,21 +740,15 @@ components: - Can''t contain more than 9 letter or number characters.' example: 92111-1234 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true type: object - x-akamai: - file-path: schemas/child-account.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -904,8 +758,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-child-accounts-200.yaml added-get-clients-200: additionalProperties: false properties: @@ -919,34 +771,22 @@ components: example: 2737bf16b39ab5d7b4a1 readOnly: true type: string - x-linode-cli-display: 1 label: description: __Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account. example: Test_Client_1 maxLength: 512 minLength: 1 type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 2 - x-linode-filterable: true public: default: false description: __Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. example: false type: boolean - x-akamai: - labels: - - Filterable - x-linode-cli-display: 4 - x-linode-filterable: true redirect_uri: description: The location a successful log in from [login.linode.com](https://login.linode.com) should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange. example: https://example.org/oauth/callback format: url type: string - x-linode-cli-display: 5 secret: description: __Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. example: @@ -961,10 +801,6 @@ 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. example: https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail @@ -973,16 +809,14 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/oauth-client.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -992,20 +826,18 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-clients-200.yaml added-get-enrolled-beta-programs-200: allOf: - additionalProperties: false - description: An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. + 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. properties: page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -1015,8 +847,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/pagination-envelope.yaml - properties: data: items: @@ -1029,7 +859,6 @@ components: nullable: true readOnly: true type: string - x-linode-cli-display: 3 ended: description: '__Filterable__, __Read-only__ The date-time that the Beta Program ended. @@ -1040,67 +869,42 @@ components: nullable: true readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 5 - x-linode-filterable: true enrolled: description: __Filterable__, __Read-only__ The date-time of Account enrollment to the Beta Program. example: '2023-09-11T00:00:00' format: date-time readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 6 - x-linode-filterable: true id: description: The unique identifier of the Beta Program. example: example_open type: string - x-linode-cli-display: 1 label: description: __Filterable__, __Read-only__ The name of the Beta Program. example: Example Open Beta readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 2 - x-linode-filterable: true started: description: __Filterable__, __Read-only__ The start date-time of the Beta Program. example: '2023-07-11T00:00:00' format: date-time readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 4 - x-linode-filterable: true type: object - x-akamai: - file-path: schemas/beta-program-enrolled.yaml type: array type: object - x-akamai: - file-path: schemas/added-get-enrolled-beta-programs-200.yaml added-get-entity-transfers-200: allOf: - additionalProperties: false - description: An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. + 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. properties: page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -1110,8 +914,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/pagination-envelope.yaml - properties: data: items: @@ -1135,23 +937,16 @@ 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. 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: @@ -1176,36 +971,18 @@ 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' format: date-time type: string type: object - x-akamai: - file-path: schemas/entity-transfer.yaml type: array - x-akamai: - file-path: schemas/added-get-entity-transfers-200.yaml added-get-events-200: additionalProperties: false properties: @@ -1243,6 +1020,7 @@ components: - entity_transfer_create - entity_transfer_fail - entity_transfer_stale + - firewall_apply - firewall_create - firewall_delete - firewall_disable @@ -1364,28 +1142,17 @@ 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. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 6 - x-linode-filterable: true duration: description: __Read-only__ The total duration in seconds that it takes for the Event to complete. example: 300.56 readOnly: true type: number - x-linode-cli-display: 7 entity: additionalProperties: false description: __Read-only__ Detailed information about the Event's entity, including ID, type, label, and URL used to access it. @@ -1394,15 +1161,10 @@ components: 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." example: 11111 type: integer - x-akamai: - labels: - - Filterable - x-linode-filterable: true label: description: The current label of this object. The label may reflect changes that occur with this Event. example: Problem booting my Linode type: string - x-linode-cli-display: 5 type: description: __Filterable__, __Read-only__ The type of entity that is being referenced by the Event. enum: @@ -1432,10 +1194,6 @@ 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 @@ -1447,17 +1205,11 @@ components: example: 123 readOnly: true type: integer - x-akamai: - labels: - - Filterable - x-linode-cli-display: 1 - x-linode-filterable: true message: description: Provides additional information about the event. Additional information may include, but is not limited to, a more detailed representation of events which can help diagnose non-obvious failures. example: None nullable: true type: string - x-linode-cli-display: 9 percent_complete: description: __Read-only__ A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events. example: null @@ -1473,10 +1225,6 @@ components: 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. @@ -1515,12 +1263,6 @@ 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. example: null @@ -1533,18 +1275,15 @@ components: nullable: true readOnly: true type: string - x-linode-cli-display: 2 type: object - x-akamai: - file-path: schemas/event.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -1554,8 +1293,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-events-200.yaml added-get-invoice-items-200: additionalProperties: false properties: @@ -1569,20 +1306,17 @@ components: example: 20.2 readOnly: true type: number - x-linode-cli-display: 4 from: description: __Read-only__ The date the Invoice Item started, based on month. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string - x-linode-cli-display: 2 label: description: __Read-only__ The Invoice Item's display label. example: Linode 123 readOnly: true type: string - x-linode-cli-display: 1 quantity: description: __Read-only__ The quantity of this Item for the specified Invoice. example: 4 @@ -1597,26 +1331,22 @@ components: nullable: true readOnly: true type: string - x-linode-cli-display: 7 tax: description: __Read-only__ The amount of tax levied on this Item in US Dollars. example: 1.25 readOnly: true type: number - x-linode-cli-display: 5 to: description: __Read-only__ The date the Invoice Item ended, based on month. example: '2018-01-31T11:59:59' format: date-time readOnly: true type: string - x-linode-cli-display: 3 total: description: __Read-only__ The price of this Item after taxes in US Dollars. example: 21.45 readOnly: true type: number - x-linode-cli-display: 6 type: description: __Read-only__ The type of service, ether `hourly` or `misc`. enum: @@ -1631,16 +1361,14 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/invoice-item.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -1650,8 +1378,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-invoice-items-200.yaml added-get-invoices-200: additionalProperties: false properties: @@ -1671,50 +1397,32 @@ components: example: linode readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 3.5 - x-linode-filterable: true date: description: __Filterable__, __Read-only__ When this Invoice was generated. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 2 - x-linode-filterable: true id: description: __Read-only__ The Invoice's unique ID. example: 123 readOnly: true type: integer - x-linode-cli-display: 1 label: description: __Filterable__, __Read-only__ The Invoice's display label. example: Invoice readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 3 - x-linode-filterable: true subtotal: description: __Read-only__ The amount of the Invoice before taxes in US Dollars. example: 120.25 readOnly: true type: number - x-linode-cli-display: 4 tax: description: __Read-only__ The amount of tax levied on the Invoice in US Dollars. example: 12.25 readOnly: true type: number - x-linode-cli-display: 5 tax_summary: description: __Read-only__ The amount of tax broken down into subtotals by source. items: @@ -1736,22 +1444,15 @@ components: example: 132.5 readOnly: true type: number - x-akamai: - labels: - - Filterable - x-linode-cli-display: 6 - x-linode-filterable: true type: object - x-akamai: - file-path: schemas/invoice.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -1761,8 +1462,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-invoices-200.yaml added-get-maintenance-200: additionalProperties: false properties: @@ -1807,10 +1506,6 @@ components: - started example: started type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true type: description: __Filterable__ The type of maintenance. enum: @@ -1819,15 +1514,11 @@ components: - live_migration example: reboot type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true when: description: '__Filterable__ When the maintenance will begin. - [Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters: + [Filterable](ref: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. @@ -1837,21 +1528,15 @@ components: example: '2020-07-09T00:01:01' format: date-time type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true type: object - x-akamai: - file-path: schemas/maintenance.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -1861,8 +1546,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-maintenance-200.yaml added-get-notifications-200: additionalProperties: false properties: @@ -1927,13 +1610,11 @@ components: example: You have an important ticket open! readOnly: true type: string - x-linode-cli-display: 1 message: description: __Read-only__ A human-readable description of the notification. example: You have an important ticket open! readOnly: true type: string - x-linode-cli-display: 2 severity: description: __Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. enum: @@ -1943,11 +1624,6 @@ 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. enum: @@ -1971,31 +1647,21 @@ components: 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. example: null format: date-time readOnly: true type: string - x-linode-cli-color: - None: black - default_: white - x-linode-cli-display: 4 type: object - x-akamai: - file-path: schemas/notification.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -2005,8 +1671,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-notifications-200.yaml added-get-payment-methods-200: additionalProperties: false properties: @@ -2044,9 +1708,6 @@ components: type: string title: Credit card type: object - x-akamai: - file-path: schemas/credit-card-data.yaml - x-linode-ref-name: Credit Card - additionalProperties: false description: Google Pay information. properties: @@ -2068,9 +1729,6 @@ components: type: string title: Google Pay type: object - x-akamai: - file-path: schemas/google-pay-data.yaml - x-linode-ref-name: Google Pay - additionalProperties: false description: PayPal information. properties: @@ -2086,21 +1744,14 @@ components: type: string title: Paypal type: object - x-akamai: - file-path: schemas/paypal-data.yaml - x-linode-ref-name: Paypal - x-linode-cli-display: 4 - x-linode-cli-format: json id: description: The unique ID of this Payment Method. example: 123 type: integer - x-linode-cli-display: 1 is_default: description: Whether this Payment Method is the default method for automatically processing service charges. example: true type: boolean - x-linode-cli-display: 3 type: description: The type of Payment Method. enum: @@ -2109,18 +1760,15 @@ components: - paypal example: credit_card type: string - x-linode-cli-display: 2 type: object - x-akamai: - file-path: schemas/payment-method.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -2130,8 +1778,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-payment-methods-200.yaml added-get-payments-200: additionalProperties: false properties: @@ -2146,30 +1792,25 @@ components: format: date-time readOnly: true type: string - x-linode-cli-display: 2 id: description: __Read-only__ The unique ID of the Payment. example: 123 readOnly: true type: integer - x-linode-cli-display: 1 usd: description: __Read-only__ The amount, in US dollars, of the Payment. example: '120.50' readOnly: true type: integer - x-linode-cli-display: 3 type: object - x-akamai: - file-path: schemas/payment.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -2179,8 +1820,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-payments-200.yaml added-get-service-transfers-200: additionalProperties: false properties: @@ -2206,23 +1845,16 @@ 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. 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. @@ -2256,41 +1888,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' format: date-time type: string type: object - x-akamai: - file-path: schemas/service-transfer.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -2300,8 +1916,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-service-transfers-200.yaml added-get-user-200: allOf: - additionalProperties: false @@ -2312,7 +1926,6 @@ 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. @@ -2321,7 +1934,7 @@ components: `null` if no login attempts have been made since creation of this User. - Run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.' + Run the [List user logins](ref:get-account-logins) operation for additional login information.' nullable: true properties: login_datetime: @@ -2354,25 +1967,24 @@ components: readOnly: true type: string restricted: - description: If true, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. + 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. example: true type: boolean - x-linode-cli-display: 3 ssh_keys: description: '__Read-only__ A list of SSH Key labels added by this User. - Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. + Users can add keys with the [Add an SSH key](ref:post-add-ssh-key) operation. These keys are deployed when this User is included in the `authorized_users` field of the following requests: - - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) + - [Create a Linode](ref:post-linode-instance) - - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) + - [Rebuild a Linode](ref:post-rebuild-linode-instance) - - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)' + - [Create a disk](ref:post-add-linode-disk)' example: - home-pc - laptop @@ -2381,7 +1993,7 @@ 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](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. + 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. example: true readOnly: true type: boolean @@ -2392,13 +2004,8 @@ components: minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 1 - x-linode-filterable: true verified_phone_number: - description: '__Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. + description: '__Read-only__ The phone number verified for this User Profile with the [Verify a phone number](ref:post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number.' @@ -2408,8 +2015,6 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: @@ -2423,7 +2028,7 @@ components: - `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.' @@ -2436,10 +2041,6 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/user-type.yaml - x-akamai: - file-path: schemas/added-get-user-200.yaml added-get-users-200: additionalProperties: false properties: @@ -2454,7 +2055,6 @@ 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. @@ -2463,7 +2063,7 @@ components: `null` if no login attempts have been made since creation of this User. - Run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.' + Run the [List user logins](ref:get-account-logins) operation for additional login information.' nullable: true properties: login_datetime: @@ -2496,25 +2096,24 @@ components: readOnly: true type: string restricted: - description: If true, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. + 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. example: true type: boolean - x-linode-cli-display: 3 ssh_keys: description: '__Read-only__ A list of SSH Key labels added by this User. - Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. + Users can add keys with the [Add an SSH key](ref:post-add-ssh-key) operation. These keys are deployed when this User is included in the `authorized_users` field of the following requests: - - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) + - [Create a Linode](ref:post-linode-instance) - - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) + - [Rebuild a Linode](ref:post-rebuild-linode-instance) - - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)' + - [Create a disk](ref:post-add-linode-disk)' example: - home-pc - laptop @@ -2523,7 +2122,7 @@ 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](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. + 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. example: true readOnly: true type: boolean @@ -2534,13 +2133,8 @@ components: minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 1 - x-linode-filterable: true verified_phone_number: - description: '__Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. + description: '__Read-only__ The phone number verified for this User Profile with the [Verify a phone number](ref:post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number.' @@ -2550,8 +2144,6 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: @@ -2565,7 +2157,7 @@ components: - `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.' @@ -2578,16 +2170,14 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/user-type.yaml type: array page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -2597,8 +2187,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/added-get-users-200.yaml added-post-beta-program: additionalProperties: false description: The Beta Program ID to enroll in for your Account. @@ -2607,12 +2195,9 @@ components: description: The unique identifier of the Beta Program. example: example_open type: string - x-linode-cli-display: 1 required: - id type: object - x-akamai: - file-path: schemas/added-post-beta-program.yaml added-post-cancel-account: additionalProperties: false properties: @@ -2621,8 +2206,6 @@ components: example: I'm consolidating multiple accounts into one. type: string type: object - x-akamai: - file-path: schemas/added-post-cancel-account.yaml added-post-cancel-account-200: additionalProperties: false example: @@ -2632,8 +2215,6 @@ components: description: A link to Linode's exit survey. type: string type: object - x-akamai: - file-path: schemas/added-post-cancel-account-200.yaml added-post-cancel-account-409: additionalProperties: false properties: @@ -2648,8 +2229,6 @@ components: type: object type: array type: object - x-akamai: - file-path: schemas/added-post-cancel-account-409.yaml added-post-client: allOf: - additionalProperties: false @@ -2660,34 +2239,22 @@ components: example: 2737bf16b39ab5d7b4a1 readOnly: true type: string - x-linode-cli-display: 1 label: description: __Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account. example: Test_Client_1 maxLength: 512 minLength: 1 type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 2 - x-linode-filterable: true public: default: false description: __Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. example: false type: boolean - x-akamai: - labels: - - Filterable - x-linode-cli-display: 4 - x-linode-filterable: true redirect_uri: description: The location a successful log in from [login.linode.com](https://login.linode.com) should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange. example: https://example.org/oauth/callback format: url type: string - x-linode-cli-display: 5 secret: description: __Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. example: @@ -2702,10 +2269,6 @@ 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. example: https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail @@ -2714,13 +2277,9 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/oauth-client.yaml required: - label - redirect_uri - x-akamai: - file-path: schemas/added-post-client.yaml added-post-entity-transfer: additionalProperties: false properties: @@ -2736,13 +2295,10 @@ components: items: type: integer type: array - x-linode-cli-display: 5 type: object required: - entities type: object - x-akamai: - file-path: schemas/added-post-entity-transfer.yaml added-post-pay-pal-payment-200: additionalProperties: false properties: @@ -2756,8 +2312,6 @@ components: example: PAY-1234567890ABCDEFGHIJKLMN type: string type: object - x-akamai: - file-path: schemas/added-post-pay-pal-payment-200.yaml added-post-payment: additionalProperties: false properties: @@ -2782,8 +2336,6 @@ components: pattern: ^\$?\d+\.\d{2}$ type: string type: object - x-akamai: - file-path: schemas/added-post-payment.yaml added-post-payment-method: additionalProperties: false description: Payment Method Request Object. @@ -2827,13 +2379,10 @@ components: - expiry_year - cvv type: object - x-akamai: - file-path: schemas/credit-card.yaml is_default: description: Whether this Payment Method is the default method for automatically processing service charges. example: true type: boolean - x-linode-cli-display: 3 type: description: 'The type of Payment Method. @@ -2850,8 +2399,6 @@ components: - data - is_default type: object - x-akamai: - file-path: schemas/added-post-payment-method.yaml added-post-promo-credit: additionalProperties: false properties: @@ -2863,8 +2410,6 @@ components: required: - promo_code type: object - x-akamai: - file-path: schemas/added-post-promo-credit.yaml added-post-service-transfer: additionalProperties: false properties: @@ -2880,13 +2425,10 @@ components: items: type: integer type: array - x-linode-cli-display: 5 type: object required: - entities type: object - x-akamai: - file-path: schemas/added-post-service-transfer.yaml added-post-user: allOf: - additionalProperties: false @@ -2897,7 +2439,6 @@ 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. @@ -2906,7 +2447,7 @@ components: `null` if no login attempts have been made since creation of this User. - Run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.' + Run the [List user logins](ref:get-account-logins) operation for additional login information.' nullable: true properties: login_datetime: @@ -2939,25 +2480,24 @@ components: readOnly: true type: string restricted: - description: If true, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. + 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. example: true type: boolean - x-linode-cli-display: 3 ssh_keys: description: '__Read-only__ A list of SSH Key labels added by this User. - Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. + Users can add keys with the [Add an SSH key](ref:post-add-ssh-key) operation. These keys are deployed when this User is included in the `authorized_users` field of the following requests: - - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) + - [Create a Linode](ref:post-linode-instance) - - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) + - [Rebuild a Linode](ref:post-rebuild-linode-instance) - - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)' + - [Create a disk](ref:post-add-linode-disk)' example: - home-pc - laptop @@ -2966,7 +2506,7 @@ 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](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. + 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. example: true readOnly: true type: boolean @@ -2977,13 +2517,8 @@ components: minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 1 - x-linode-filterable: true verified_phone_number: - description: '__Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. + description: '__Read-only__ The phone number verified for this User Profile with the [Verify a phone number](ref:post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number.' @@ -2993,13 +2528,9 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/user.yaml required: - username - email - x-akamai: - file-path: schemas/added-post-user.yaml added-put-user-200: allOf: - additionalProperties: false @@ -3010,7 +2541,6 @@ 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. @@ -3019,7 +2549,7 @@ components: `null` if no login attempts have been made since creation of this User. - Run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.' + Run the [List user logins](ref:get-account-logins) operation for additional login information.' nullable: true properties: login_datetime: @@ -3052,25 +2582,24 @@ components: readOnly: true type: string restricted: - description: If true, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. + 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. example: true type: boolean - x-linode-cli-display: 3 ssh_keys: description: '__Read-only__ A list of SSH Key labels added by this User. - Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. + Users can add keys with the [Add an SSH key](ref:post-add-ssh-key) operation. These keys are deployed when this User is included in the `authorized_users` field of the following requests: - - [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) + - [Create a Linode](ref:post-linode-instance) - - [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) + - [Rebuild a Linode](ref:post-rebuild-linode-instance) - - [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)' + - [Create a disk](ref:post-add-linode-disk)' example: - home-pc - laptop @@ -3079,7 +2608,7 @@ 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](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. + 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. example: true readOnly: true type: boolean @@ -3090,13 +2619,8 @@ components: minLength: 3 pattern: ^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$ type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 1 - x-linode-filterable: true verified_phone_number: - description: '__Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. + description: '__Read-only__ The phone number verified for this User Profile with the [Verify a phone number](ref:post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number.' @@ -3106,8 +2630,6 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: @@ -3121,7 +2643,7 @@ components: - `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.' @@ -3134,10 +2656,6 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/user-type.yaml - x-akamai: - file-path: schemas/added-put-user-200.yaml agreements: additionalProperties: false description: Acknowledgment status for agreements on your account. When acknowledging any agreements, set them to `true` and omit any remainders. @@ -3155,8 +2673,6 @@ components: example: true type: boolean type: object - x-akamai: - file-path: schemas/agreements.yaml beta-program-enrolled: additionalProperties: false description: An object representing an enrolled Beta Program for the Account. @@ -3167,7 +2683,6 @@ components: nullable: true readOnly: true type: string - x-linode-cli-display: 3 ended: description: '__Filterable__, __Read-only__ The date-time that the Beta Program ended. @@ -3178,51 +2693,28 @@ components: nullable: true readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 5 - x-linode-filterable: true enrolled: description: __Filterable__, __Read-only__ The date-time of Account enrollment to the Beta Program. example: '2023-09-11T00:00:00' format: date-time readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 6 - x-linode-filterable: true id: description: The unique identifier of the Beta Program. example: example_open type: string - x-linode-cli-display: 1 label: description: __Filterable__, __Read-only__ The name of the Beta Program. example: Example Open Beta readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 2 - x-linode-filterable: true started: description: __Filterable__, __Read-only__ The start date-time of the Beta Program. example: '2023-07-11T00:00:00' format: date-time readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 4 - x-linode-filterable: true type: object - x-akamai: - file-path: schemas/beta-program-enrolled.yaml child-account: additionalProperties: false description: Child account object. @@ -3238,31 +2730,21 @@ components: example: 123 Main Street maxLength: 64 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true address_2: description: __Filterable__ Second line of this child account's billing address, if applicable. example: Suite A maxLength: 64 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true balance: description: __Read-only__ This child account's balance, in US dollars. example: 200 readOnly: true type: number - x-linode-cli-display: 4 balance_uninvoiced: description: __Read-only__ This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate. example: 145 readOnly: true type: number - x-linode-cli-display: 4 billing_source: description: __Read-only__ The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment. enum: @@ -3286,27 +2768,15 @@ components: example: San Diego maxLength: 24 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true company: description: '__Filterable__ The company name for the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`. You can''t change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.' example: Acme maxLength: 128 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true country: description: __Filterable__ The two-letter ISO 3166 country code for this child account's billing address. example: US type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true credit_card: additionalProperties: false description: __Read-only__ Information for the credit card you've assigned to this child account. @@ -3326,11 +2796,6 @@ components: example: john.smith@linode.com maxLength: 128 type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 3 - x-linode-filterable: true euuid: description: __Read-only__ An external, unique identifier that Akamai assigned to the child account. example: A1BC2DEF-34GH-567I-J890KLMN12O34P56 @@ -3342,30 +2807,16 @@ components: example: John maxLength: 50 type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 1 - x-linode-filterable: true last_name: description: '__Filterable__ The last name of the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`.' example: Smith maxLength: 50 type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 2 - x-linode-filterable: true phone: description: __Filterable__ The phone number for the owner of this child account. example: 858-555-1212 maxLength: 32 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true state: description: '__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code. @@ -3374,10 +2825,6 @@ components: 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 @@ -3392,13 +2839,7 @@ components: - Can''t contain more than 9 letter or number characters.' example: 92111-1234 type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true type: object - x-akamai: - file-path: schemas/child-account.yaml credit-card: additionalProperties: false description: An object representing the credit card information you have on file with Linode to make Payments against your Account. @@ -3438,8 +2879,6 @@ components: - expiry_year - cvv type: object - x-akamai: - file-path: schemas/credit-card.yaml credit-card-data: additionalProperties: false description: Credit card information. @@ -3462,15 +2901,12 @@ components: type: string title: Credit card type: object - x-akamai: - file-path: schemas/credit-card-data.yaml description: description: __Read-only__ Additional details regarding the Beta Program. example: This is an open public beta for an example feature. nullable: true readOnly: true type: string - x-linode-cli-display: 3 ended: description: '__Filterable__, __Read-only__ The date-time that the Beta Program ended. @@ -3481,11 +2917,6 @@ components: 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. @@ -3498,7 +2929,6 @@ components: items: type: integer type: array - x-linode-cli-display: 5 type: object entity-transfer: additionalProperties: false @@ -3521,23 +2951,16 @@ 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. 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: @@ -3562,33 +2985,17 @@ 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' format: date-time type: string type: object - x-akamai: - file-path: schemas/entity-transfer.yaml error-object: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. @@ -3598,12 +3005,10 @@ 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](https://techdocs.akamai.com/linode-api/reference/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](ref:post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object - x-akamai: - file-path: schemas/error-object.yaml event: additionalProperties: false description: A collection of Event objects. An Event is an action taken against an entity related to your Account. For example, booting a Linode would create an Event. The Events returned depends on your grants. @@ -3637,6 +3042,7 @@ components: - entity_transfer_create - entity_transfer_fail - entity_transfer_stale + - firewall_apply - firewall_create - firewall_delete - firewall_disable @@ -3758,28 +3164,17 @@ 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. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 6 - x-linode-filterable: true duration: description: __Read-only__ The total duration in seconds that it takes for the Event to complete. example: 300.56 readOnly: true type: number - x-linode-cli-display: 7 entity: additionalProperties: false description: __Read-only__ Detailed information about the Event's entity, including ID, type, label, and URL used to access it. @@ -3788,15 +3183,10 @@ components: 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." example: 11111 type: integer - x-akamai: - labels: - - Filterable - x-linode-filterable: true label: description: The current label of this object. The label may reflect changes that occur with this Event. example: Problem booting my Linode type: string - x-linode-cli-display: 5 type: description: __Filterable__, __Read-only__ The type of entity that is being referenced by the Event. enum: @@ -3826,10 +3216,6 @@ 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 @@ -3841,17 +3227,11 @@ components: example: 123 readOnly: true type: integer - x-akamai: - labels: - - Filterable - x-linode-cli-display: 1 - x-linode-filterable: true message: description: Provides additional information about the event. Additional information may include, but is not limited to, a more detailed representation of events which can help diagnose non-obvious failures. example: None nullable: true type: string - x-linode-cli-display: 9 percent_complete: description: __Read-only__ A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events. example: null @@ -3867,10 +3247,6 @@ components: 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. @@ -3909,12 +3285,6 @@ 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. example: null @@ -3927,10 +3297,7 @@ components: nullable: true readOnly: true type: string - x-linode-cli-display: 2 type: object - x-akamai: - file-path: schemas/event.yaml google-pay-data: additionalProperties: false description: Google Pay information. @@ -3953,8 +3320,6 @@ components: type: string title: Google Pay type: object - x-akamai: - file-path: schemas/google-pay-data.yaml grant: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. @@ -3977,8 +3342,6 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml grants-response: additionalProperties: false description: A structure representing all grants a restricted User has on the Account. Not available for unrestricted users, as they have access to everything without grants. If retrieved from the `/profile/grants` endpoint, entities to which a User has no access will be omitted. @@ -4007,8 +3370,6 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml type: array domain: description: The grants this User has for each Domain that is owned by this Account. @@ -4034,8 +3395,6 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml type: array firewall: description: The grants this User has for each Firewall that is owned by this Account. @@ -4061,8 +3420,6 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml type: array global: additionalProperties: false @@ -4163,8 +3520,6 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml type: array linode: description: The grants this User has for each Linode that is owned by this Account. @@ -4190,8 +3545,6 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml type: array longview: description: The grants this User has for each Longview Client that is owned by this Account. @@ -4217,8 +3570,6 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml type: array nodebalancer: description: The grants this User has for each NodeBalancer that is owned by this Account. @@ -4244,8 +3595,6 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml type: array placement_group: description: The grants this User has for each Placement Group that is owned by this Account. @@ -4271,8 +3620,6 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml type: array stackscript: description: The grants this User has for each StackScript that is owned by this Account. @@ -4298,8 +3645,6 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml type: array volume: description: The grants this User has for each Block Storage Volume that is owned by this Account. @@ -4325,8 +3670,6 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml type: array vpc: description: The grants this User has for each VPC that is owned by this Account. @@ -4352,17 +3695,12 @@ components: nullable: true type: string type: object - x-akamai: - file-path: schemas/grant.yaml type: array type: object - x-akamai: - file-path: schemas/grants-response.yaml id: description: The unique identifier of the Beta Program. example: example_open type: string - x-linode-cli-display: 1 invoice: additionalProperties: false description: Account Invoice object. @@ -4378,50 +3716,32 @@ components: example: linode readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 3.5 - x-linode-filterable: true date: description: __Filterable__, __Read-only__ When this Invoice was generated. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 2 - x-linode-filterable: true id: description: __Read-only__ The Invoice's unique ID. example: 123 readOnly: true type: integer - x-linode-cli-display: 1 label: description: __Filterable__, __Read-only__ The Invoice's display label. example: Invoice readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 3 - x-linode-filterable: true subtotal: description: __Read-only__ The amount of the Invoice before taxes in US Dollars. example: 120.25 readOnly: true type: number - x-linode-cli-display: 4 tax: description: __Read-only__ The amount of tax levied on the Invoice in US Dollars. example: 12.25 readOnly: true type: number - x-linode-cli-display: 5 tax_summary: description: __Read-only__ The amount of tax broken down into subtotals by source. items: @@ -4443,14 +3763,7 @@ components: example: 132.5 readOnly: true type: number - x-akamai: - labels: - - Filterable - x-linode-cli-display: 6 - x-linode-filterable: true type: object - x-akamai: - file-path: schemas/invoice.yaml invoice-item: additionalProperties: false description: An InvoiceItem object. @@ -4460,20 +3773,17 @@ components: example: 20.2 readOnly: true type: number - x-linode-cli-display: 4 from: description: __Read-only__ The date the Invoice Item started, based on month. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string - x-linode-cli-display: 2 label: description: __Read-only__ The Invoice Item's display label. example: Linode 123 readOnly: true type: string - x-linode-cli-display: 1 quantity: description: __Read-only__ The quantity of this Item for the specified Invoice. example: 4 @@ -4488,26 +3798,22 @@ components: nullable: true readOnly: true type: string - x-linode-cli-display: 7 tax: description: __Read-only__ The amount of tax levied on this Item in US Dollars. example: 1.25 readOnly: true type: number - x-linode-cli-display: 5 to: description: __Read-only__ The date the Invoice Item ended, based on month. example: '2018-01-31T11:59:59' format: date-time readOnly: true type: string - x-linode-cli-display: 3 total: description: __Read-only__ The price of this Item after taxes in US Dollars. example: 21.45 readOnly: true type: number - x-linode-cli-display: 6 type: description: __Read-only__ The type of service, ether `hourly` or `misc`. enum: @@ -4522,23 +3828,15 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/invoice-item.yaml is_default: description: Whether this Payment Method is the default method for automatically processing service charges. example: true type: boolean - x-linode-cli-display: 3 label: description: __Filterable__, __Read-only__ The name of the Beta Program. example: Example Open Beta readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 2 - x-linode-filterable: true login: additionalProperties: false description: An object representing a previous successful login for a User. @@ -4549,26 +3847,22 @@ components: format: date-time readOnly: true type: string - x-linode-cli-display: 2 id: description: __Read-only__ The unique ID of this login object. example: 1234 readOnly: true type: integer - x-linode-cli-display: 1 ip: description: __Read-only__ The remote IP address that requested the login. example: 192.0.2.0 format: ip readOnly: true type: string - x-linode-cli-display: 3 restricted: description: __Read-only__ True if the User that attempted the login was a restricted User, false otherwise. example: true readOnly: true type: boolean - x-linode-cli-display: 6 status: description: __Read-only__ Whether the login attempt succeeded or failed. enum: @@ -4577,16 +3871,12 @@ components: example: successful readOnly: true type: string - x-linode-cli-display: 5 username: description: __Read-only__ The username of the User that attempted the login. example: example_user readOnly: true type: string - x-linode-cli-display: 4 type: object - x-akamai: - file-path: schemas/login.yaml maintenance: additionalProperties: false description: Information about maintenance affecting an entity. @@ -4627,10 +3917,6 @@ components: - started example: started type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true type: description: __Filterable__ The type of maintenance. enum: @@ -4639,15 +3925,11 @@ components: - live_migration example: reboot type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true when: description: '__Filterable__ When the maintenance will begin. - [Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters: + [Filterable](ref: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. @@ -4657,13 +3939,7 @@ components: example: '2020-07-09T00:01:01' format: date-time type: string - x-akamai: - labels: - - Filterable - x-linode-filterable: true type: object - x-akamai: - file-path: schemas/maintenance.yaml notification: additionalProperties: false description: An important, often time-sensitive item related to your account. @@ -4724,13 +4000,11 @@ components: example: You have an important ticket open! readOnly: true type: string - x-linode-cli-display: 1 message: description: __Read-only__ A human-readable description of the notification. example: You have an important ticket open! readOnly: true type: string - x-linode-cli-display: 2 severity: description: __Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. enum: @@ -4740,11 +4014,6 @@ 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. enum: @@ -4768,23 +4037,13 @@ components: 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. example: null format: date-time readOnly: true type: string - x-linode-cli-color: - None: black - default_: white - x-linode-cli-display: 4 type: object - x-akamai: - file-path: schemas/notification.yaml oauth-client: additionalProperties: false description: A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](https://login.linode.com). Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application. @@ -4794,34 +4053,22 @@ components: example: 2737bf16b39ab5d7b4a1 readOnly: true type: string - x-linode-cli-display: 1 label: description: __Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account. example: Test_Client_1 maxLength: 512 minLength: 1 type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 2 - x-linode-filterable: true public: default: false description: __Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. example: false type: boolean - x-akamai: - labels: - - Filterable - x-linode-cli-display: 4 - x-linode-filterable: true redirect_uri: description: The location a successful log in from [login.linode.com](https://login.linode.com) should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange. example: https://example.org/oauth/callback format: url type: string - x-linode-cli-display: 5 secret: description: __Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. example: @@ -4836,10 +4083,6 @@ 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. example: https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail @@ -4848,29 +4091,27 @@ components: readOnly: true type: string type: object - x-akamai: - file-path: schemas/oauth-client.yaml page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer pagination-envelope: additionalProperties: false - description: An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. + 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. properties: page: - description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The current [page](ref:pagination). example: 1 readOnly: true type: integer pages: - description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](ref:pagination). example: 1 readOnly: true type: integer @@ -4880,8 +4121,6 @@ components: readOnly: true type: integer type: object - x-akamai: - file-path: schemas/pagination-envelope.yaml payment: additionalProperties: false description: Payment object response. @@ -4892,22 +4131,17 @@ components: format: date-time readOnly: true type: string - x-linode-cli-display: 2 id: description: __Read-only__ The unique ID of the Payment. example: 123 readOnly: true type: integer - x-linode-cli-display: 1 usd: description: __Read-only__ The amount, in US dollars, of the Payment. example: '120.50' readOnly: true type: integer - x-linode-cli-display: 3 type: object - x-akamai: - file-path: schemas/payment.yaml payment-method: additionalProperties: false description: Payment Method Response Object. @@ -4941,9 +4175,6 @@ components: type: string title: Credit card type: object - x-akamai: - file-path: schemas/credit-card-data.yaml - x-linode-ref-name: Credit Card - additionalProperties: false description: Google Pay information. properties: @@ -4965,9 +4196,6 @@ components: type: string title: Google Pay type: object - x-akamai: - file-path: schemas/google-pay-data.yaml - x-linode-ref-name: Google Pay - additionalProperties: false description: PayPal information. properties: @@ -4983,21 +4211,14 @@ components: type: string title: Paypal type: object - x-akamai: - file-path: schemas/paypal-data.yaml - x-linode-ref-name: Paypal - x-linode-cli-display: 4 - x-linode-cli-format: json id: description: The unique ID of this Payment Method. example: 123 type: integer - x-linode-cli-display: 1 is_default: description: Whether this Payment Method is the default method for automatically processing service charges. example: true type: boolean - x-linode-cli-display: 3 type: description: The type of Payment Method. enum: @@ -5006,10 +4227,7 @@ components: - paypal example: credit_card type: string - x-linode-cli-display: 2 type: object - x-akamai: - file-path: schemas/payment-method.yaml paypal: additionalProperties: false description: An object representing the staging of a Payment via PayPal. @@ -5031,8 +4249,6 @@ components: - redirect_url - usd type: object - x-akamai: - file-path: schemas/paypal.yaml paypal-data: additionalProperties: false description: PayPal information. @@ -5049,8 +4265,6 @@ components: type: string title: Paypal type: object - x-akamai: - file-path: schemas/paypal-data.yaml paypal-execute: additionalProperties: false description: An object representing an execution of Payment to PayPal to capture the funds and credit your Linode Account. @@ -5060,15 +4274,13 @@ components: example: ABCDEFGHIJKLM type: string payment_id: - description: The PaymentID returned from [Stage a PayPal payment](https://techdocs.akamai.com/linode-api/reference/post-pay-pal-payment) that has been approved with PayPal. + description: The PaymentID returned from [Stage a PayPal payment](ref:post-pay-pal-payment) that has been approved with PayPal. example: PAY-1234567890ABCDEFGHIJKLMN type: string required: - payer_id - payment_id type: object - x-akamai: - file-path: schemas/paypal-execute.yaml promotion: additionalProperties: false description: '__Read-only__ Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set. @@ -5080,12 +4292,10 @@ components: 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. @@ -5094,7 +4304,6 @@ 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 @@ -5118,21 +4327,16 @@ 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 - x-akamai: - file-path: schemas/promotion.yaml properties-entities: additionalProperties: false description: A collection of the services to include in this transfer request, separated by type. @@ -5145,7 +4349,6 @@ components: items: type: integer type: array - x-linode-cli-display: 5 type: object proxy-user-token: additionalProperties: false @@ -5157,51 +4360,35 @@ components: format: date-time readOnly: true type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 4 - x-linode-filterable: true expiry: description: __Read-only__ When this token expires. This is default set to 15 minutes from the time of creation. Proxy user tokens can't be renewed. After this time, Akamai revokes the token and you need to generate a new one. example: '2024-05-01T00:16:01' format: date-time readOnly: true type: string - x-linode-cli-display: 6 id: description: __Read-only__ The proxy user token's unique ID, which can be used to revoke it. example: 918 readOnly: true type: integer - x-linode-cli-display: 1 label: description: __Filterable__ The name of the token. The API automatically sets this to `__