diff --git a/providers/src/linode/v00.00.00000/provider.yaml b/providers/src/linode/v00.00.00000/provider.yaml index d7d70509..f80ad4f9 100644 --- a/providers/src/linode/v00.00.00000/provider.yaml +++ b/providers/src/linode/v00.00.00000/provider.yaml @@ -74,6 +74,15 @@ providerServices: title: longview API version: v00.00.00000 description: linode longview API + maintenance: + id: maintenance:v00.00.00000 + name: maintenance + preferred: true + service: + $ref: linode/v00.00.00000/services/maintenance.yaml + title: maintenance API + version: v00.00.00000 + description: linode maintenance API managed: id: managed:v00.00.00000 name: managed diff --git a/providers/src/linode/v00.00.00000/services/account.yaml b/providers/src/linode/v00.00.00000/services/account.yaml index 8e4645b5..d12fabf3 100644 --- a/providers/src/linode/v00.00.00000/services/account.yaml +++ b/providers/src/linode/v00.00.00000/services/account.yaml @@ -2,20 +2,17 @@ openapi: 3.0.1 info: title: account API description: linode account API - version: 4.208.1 + version: 4.215.0 paths: /account: get: - description: >- - Returns the contact and billing information related to your account. + description: 'Returns the contact and billing information related to your account. - [Learn - more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-account @@ -31,17 +28,15 @@ paths: active_promotions: items: additionalProperties: false - description: >- - __Read-only__ Promotions generally offer a set amount of - credit that can be used toward your Linode services, and - the promotion expires after a specified date. As well, a - monthly cap on the promotional offer is set. + description: '__Read-only__ Promotions generally offer a set + amount of credit that can be used toward your Linode services, + and the promotion expires after a specified date. As well, + a monthly cap on the promotional offer is set. - Simply put, a promotion offers a certain amount of - credit month, until either the expiration date is - passed, or until the total promotional credit is used, - whichever comes first. + Simply put, a promotion offers a certain amount of credit month, + until either the expiration date is passed, or until the total + promotional credit is used, whichever comes first.' properties: credit_monthly_cap: description: The amount available to spend per month. @@ -55,10 +50,9 @@ paths: 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. + example: Receive up to $10 off your services every month + for 6 months! Unused credits will expire once this promotion + period ends. type: string expire_dt: description: When this promotion's credits expire. @@ -72,20 +66,20 @@ paths: service_type: description: The service to which this promotion applies. enum: - - all - - backup - - blockstorage - - db_mysql - - ip_v4 - - linode - - linode_disk - - linode_memory - - longview - - managed - - nodebalancer - - objectstorage - - placement_group - - transfer_tx + - all + - backup + - blockstorage + - db_mysql + - ip_v4 + - linode + - linode_disk + - linode_memory + - longview + - managed + - nodebalancer + - objectstorage + - placement_group + - transfer_tx example: all type: string x-linode-cli-display: 1 @@ -95,9 +89,8 @@ paths: type: string x-linode-cli-display: 10 this_month_credit_remaining: - description: >- - The amount of credit left for this month for this - promotion. + description: The amount of credit left for this month for + this promotion. example: '10.00' type: string x-linode-cli-display: 4 @@ -130,37 +123,34 @@ paths: type: number x-linode-cli-display: 4 balance_uninvoiced: - description: >- - __Read-only__ This account's current estimated invoice in - US dollars. This is not your final invoice balance. - Transfer charges are not included in the estimate. + description: __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. Accounts that are associated with Akamai-specific - customers return a value of `akamai`. All other accounts - return a value of `linode`. + description: __Read-only__ The source of service charges for this + account. Accounts that are associated with Akamai-specific customers + return a value of `akamai`. All other accounts return a value + of `linode`. enum: - - akamai - - linode + - akamai + - linode example: akamai readOnly: true type: string capabilities: - description: >- - __Read-only__ The Akamai Cloud Computing services your - account supports. + description: __Read-only__ The Akamai Cloud Computing services + your account supports. example: - - Linodes - - NodeBalancers - - Block Storage - - Object Storage - - Placement Groups - - Block Storage Encryption + - Linodes + - NodeBalancers + - Block Storage + - Object Storage + - Placement Groups + - Block Storage Encryption items: type: string readOnly: true @@ -171,63 +161,57 @@ paths: maxLength: 24 type: string company: - description: >- - The company name assigned to this account. This value + description: The company name assigned to this account. This value can't include the characters, `<` `>` `(` `)` `"` `=`. example: Linode LLC maxLength: 128 type: string country: - description: >- - The two-letter ISO 3166 country code for this account's + description: The two-letter ISO 3166 country code for this account's `address`. example: US type: string credit_card: additionalProperties: false - description: >- - __Read-only__ The credit card information assigned to this - account. + description: __Read-only__ The credit card information assigned + to this account. properties: expiry: description: The expiration month and year of the `credit_card`. example: 11/2022 type: string last_four: - description: >- - The last four digits of the `credit_card` assigned to - this account. + description: The last four digits of the `credit_card` assigned + to this account. example: 1111 type: string readOnly: true type: object email: - description: The email address of the person assigned to this account. + description: The email address of the person assigned to this + account. example: john.smith@linode.com maxLength: 128 type: string x-linode-cli-display: 3 euuid: - description: >- - __Read-only__ An external unique identifier for this + description: __Read-only__ An external unique identifier for this account. example: E1AF5EEC-526F-487D-B317EBEB34C87D71 format: uuid readOnly: true type: string first_name: - description: >- - The first name of the person assigned to this account. - This value can't include the characters, `<` `>` `(` `)` - `"` `=`. + description: The first name of the person assigned to this account. + This value can't include the characters, `<` `>` `(` `)` `"` + `=`. example: John maxLength: 50 type: string x-linode-cli-display: 1 last_name: - description: >- - The last name of the person assigned to this account. This - value can't include the characters, `<` `>` `(` `)` `"` + description: The last name of the person assigned to this account. + This value can't include the characters, `<` `>` `(` `)` `"` `=`. example: Smith maxLength: 50 @@ -239,62 +223,54 @@ paths: maxLength: 32 type: string state: - description: >- - The state or province for the `address` set for your - account, if applicable. + description: 'The state or province for the `address` set for + your account, if applicable. - - If the `address` is in the United States (US) or Canada - (CA), this is the two-letter ISO 3166 code for the state - or province. + - If the `address` is in the United States (US) or Canada (CA), + this is the two-letter ISO 3166 code for the state or province. - - If it's a US military `address`, this is the - abbreviation for that territory. This includes `AA` for - Armed Forces Americas (excluding Canada), `AE` for Armed - Forces Africa, Europe, Middle East, and Canada, or `AP` - for Armed Forces Pacific. + - If it''s a US military `address`, this is the abbreviation + for that territory. This includes `AA` for Armed Forces Americas + (excluding Canada), `AE` for Armed Forces Africa, Europe, Middle + East, and Canada, or `AP` for Armed Forces Pacific. - - If outside the US or CA, this is the province associated - with the account's `address`. + - If outside the US or CA, this is the province associated with + the account''s `address`.' example: PA maxLength: 24 type: string tax_id: - description: >- - The tax identification number (TIN) assigned to this - account, used for tax calculations. A TIN is set by the - national authorities in your `country`, based on your - `address_1`, and it may be named differently between - countries. Set to an empty string (`""`) if a TIN doesn't - apply or for countries that don't collect tax. + description: 'The tax identification number (TIN) assigned to + this account, used for tax calculations. A TIN is set by the + national authorities in your `country`, based on your `address_1`, + and it may be named differently between countries. Set to an + empty string (`""`) if a TIN doesn''t apply or for countries + that don''t collect tax. > 📘 > - > This value is externally validated. If the validation is - successful, a `tax_id_valid` - [event](https://techdocs.akamai.com/linode-api/reference/get-events) - is triggered. If unsuccessful, a `tax_id_invalid` event is - triggered and an error response is issued for an operation - that included it. + > This value is externally validated. If the validation is successful, + a `tax_id_valid` [event](https://techdocs.akamai.com/linode-api/reference/get-events) + is triggered. If unsuccessful, a `tax_id_invalid` event is triggered + and an error response is issued for an operation that included + it.' example: ATU99999999 maxLength: 25 type: string zip: - description: >- - The zip code for this account's `address`. + description: 'The zip code for this account''s `address`. - - It can only contain ASCII letters, numbers, and dashes - (`-`). + - It can only contain ASCII letters, numbers, and dashes (`-`). - - It can't contain more than nine letter or number - characters. + - It can''t contain more than nine letter or number characters.' example: 19102-1234 type: string type: object @@ -312,28 +288,24 @@ paths: errors: items: additionalProperties: false - description: >- - An object for describing a single error that occurred + description: An object for describing a single error that occurred during the processing of a request. properties: field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. example: fieldname type: string reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. example: fieldname must be a valid value type: string type: object @@ -341,32 +313,28 @@ paths: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - account:read_only + - personalAccessToken: [] + - oauth: + - account:read_only summary: Get your account tags: - - Account + - Account x-akamai: tabs: - - syntax: linode-cli account view - title: CLI - url: >- - https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - - syntax: account:read_only - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: linode-cli account view + title: CLI + url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: view x-linode-grant: read_only put: - description: >- - Updates contact and billing information related to your account. If you - exclude any properties from the request, the operation leaves them + description: 'Updates contact and billing information related to your account. + If you exclude any properties from the request, the operation leaves them unchanged. @@ -374,33 +342,30 @@ paths: > - > When updating an account's `country` to `US`, you'll get an error if - the account's `zip` is not a valid US zip code. + > When updating an account''s `country` to `US`, you''ll get an error if the + account''s `zip` is not a valid US zip code. **Parent and child accounts** - In a [parent and child - account](https://www.linode.com/docs/guides/parent-child-accounts/) + In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - - You can't change the `company` for a parent account. Akamai uses this - value to set the name for a child account parent user (proxy user) on - any child account. + - You can''t change the `company` for a parent account. Akamai uses this value + to set the name for a child account parent user (proxy user) on any child + account. - - Child account users can't run this operation. These users don't have - access to billing-related operations. + - Child account users can''t run this operation. These users don''t have access + to billing-related operations. - [Learn - more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/put-account @@ -415,17 +380,15 @@ paths: active_promotions: items: additionalProperties: false - description: >- - __Read-only__ Promotions generally offer a set amount of - credit that can be used toward your Linode services, and - the promotion expires after a specified date. As well, a - monthly cap on the promotional offer is set. + description: '__Read-only__ Promotions generally offer a set amount + of credit that can be used toward your Linode services, and + the promotion expires after a specified date. As well, a monthly + cap on the promotional offer is set. - Simply put, a promotion offers a certain amount of credit - month, until either the expiration date is passed, or - until the total promotional credit is used, whichever - comes first. + Simply put, a promotion offers a certain amount of credit month, + until either the expiration date is passed, or until the total + promotional credit is used, whichever comes first.' properties: credit_monthly_cap: description: The amount available to spend per month. @@ -439,9 +402,8 @@ paths: 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 + example: Receive up to $10 off your services every month for + 6 months! Unused credits will expire once this promotion period ends. type: string expire_dt: @@ -456,20 +418,20 @@ paths: service_type: description: The service to which this promotion applies. enum: - - all - - backup - - blockstorage - - db_mysql - - ip_v4 - - linode - - linode_disk - - linode_memory - - longview - - managed - - nodebalancer - - objectstorage - - placement_group - - transfer_tx + - all + - backup + - blockstorage + - db_mysql + - ip_v4 + - linode + - linode_disk + - linode_memory + - longview + - managed + - nodebalancer + - objectstorage + - placement_group + - transfer_tx example: all type: string x-linode-cli-display: 1 @@ -479,9 +441,8 @@ paths: type: string x-linode-cli-display: 10 this_month_credit_remaining: - description: >- - The amount of credit left for this month for this - promotion. + description: The amount of credit left for this month for + this promotion. example: '10.00' type: string x-linode-cli-display: 4 @@ -514,37 +475,34 @@ paths: 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 + 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: '{{balance_uninvoiced}}' readOnly: true type: number x-linode-cli-display: 4 billing_source: - description: >- - __Read-only__ The source of service charges for this - account. Accounts that are associated with Akamai-specific - customers return a value of `akamai`. All other accounts - return a value of `linode`. + description: __Read-only__ The source of service charges for this + account. Accounts that are associated with Akamai-specific customers + return a value of `akamai`. All other accounts return a value + of `linode`. enum: - - akamai - - linode + - akamai + - linode example: '{{billing_source}}' readOnly: true type: string capabilities: - description: >- - __Read-only__ The Akamai Cloud Computing services your + description: __Read-only__ The Akamai Cloud Computing services your account supports. example: - - Linodes - - NodeBalancers - - Block Storage - - Object Storage - - Placement Groups - - Block Storage Encryption + - Linodes + - NodeBalancers + - Block Storage + - Object Storage + - Placement Groups + - Block Storage Encryption items: type: string readOnly: true @@ -555,32 +513,28 @@ paths: maxLength: 24 type: string company: - description: >- - The company name assigned to this account. This value can't - include the characters, `<` `>` `(` `)` `"` `=`. + description: The company name assigned to this account. This value + can't include the characters, `<` `>` `(` `)` `"` `=`. example: '{{company}}' maxLength: 128 type: string country: - description: >- - The two-letter ISO 3166 country code for this account's + description: The two-letter ISO 3166 country code for this account's `address`. example: '{{country}}' type: string credit_card: additionalProperties: false - description: >- - __Read-only__ The credit card information assigned to this - account. + description: __Read-only__ The credit card information assigned + to this account. properties: expiry: description: The expiration month and year of the `credit_card`. example: 11/2022 type: string last_four: - description: >- - The last four digits of the `credit_card` assigned to - this account. + description: The last four digits of the `credit_card` assigned + to this account. example: 1111 type: string readOnly: true @@ -592,25 +546,22 @@ paths: type: string x-linode-cli-display: 3 euuid: - description: >- - __Read-only__ An external unique identifier for this + description: __Read-only__ An external unique identifier for this account. example: '{{euuid}}' format: uuid readOnly: true type: string first_name: - description: >- - The first name of the person assigned to this account. This - value can't include the characters, `<` `>` `(` `)` `"` `=`. + description: The first name of the person assigned to this account. + This value can't include the characters, `<` `>` `(` `)` `"` `=`. example: '{{first_name}}' maxLength: 50 type: string x-linode-cli-display: 1 last_name: - description: >- - The last name of the person assigned to this account. This - value can't include the characters, `<` `>` `(` `)` `"` `=`. + description: The last name of the person assigned to this account. + This value can't include the characters, `<` `>` `(` `)` `"` `=`. example: '{{last_name}}' maxLength: 50 type: string @@ -621,62 +572,54 @@ paths: maxLength: 32 type: string state: - description: >- - The state or province for the `address` set for your + description: 'The state or province for the `address` set for your account, if applicable. - - If the `address` is in the United States (US) or Canada - (CA), this is the two-letter ISO 3166 code for the state or - province. + - If the `address` is in the United States (US) or Canada (CA), + this is the two-letter ISO 3166 code for the state or province. - - If it's a US military `address`, this is the abbreviation - for that territory. This includes `AA` for Armed Forces - Americas (excluding Canada), `AE` for Armed Forces Africa, - Europe, Middle East, and Canada, or `AP` for Armed Forces - Pacific. + - If it''s a US military `address`, this is the abbreviation for + that territory. This includes `AA` for Armed Forces Americas (excluding + Canada), `AE` for Armed Forces Africa, Europe, Middle East, and + Canada, or `AP` for Armed Forces Pacific. - - If outside the US or CA, this is the province associated - with the account's `address`. + - If outside the US or CA, this is the province associated with + the account''s `address`.' example: '{{state}}' maxLength: 24 type: string tax_id: - description: >- - The tax identification number (TIN) assigned to this - account, used for tax calculations. A TIN is set by the - national authorities in your `country`, based on your - `address_1`, and it may be named differently between - countries. Set to an empty string (`""`) if a TIN doesn't - apply or for countries that don't collect tax. + description: 'The tax identification number (TIN) assigned to this + account, used for tax calculations. A TIN is set by the national + authorities in your `country`, based on your `address_1`, and + it may be named differently between countries. Set to an empty + string (`""`) if a TIN doesn''t apply or for countries that don''t + collect tax. > 📘 > - > This value is externally validated. If the validation is - successful, a `tax_id_valid` - [event](https://techdocs.akamai.com/linode-api/reference/get-events) - is triggered. If unsuccessful, a `tax_id_invalid` event is - triggered and an error response is issued for an operation - that included it. + > This value is externally validated. If the validation is successful, + a `tax_id_valid` [event](https://techdocs.akamai.com/linode-api/reference/get-events) + is triggered. If unsuccessful, a `tax_id_invalid` event is triggered + and an error response is issued for an operation that included + it.' example: '{{tax_id}}' maxLength: 25 type: string zip: - description: >- - The zip code for this account's `address`. + description: 'The zip code for this account''s `address`. - - It can only contain ASCII letters, numbers, and dashes - (`-`). + - It can only contain ASCII letters, numbers, and dashes (`-`). - - It can't contain more than nine letter or number - characters. + - It can''t contain more than nine letter or number characters.' example: '{{zip}}' type: string type: object @@ -697,17 +640,15 @@ paths: active_promotions: items: additionalProperties: false - description: >- - __Read-only__ Promotions generally offer a set amount of - credit that can be used toward your Linode services, and - the promotion expires after a specified date. As well, a - monthly cap on the promotional offer is set. + description: '__Read-only__ Promotions generally offer a set + amount of credit that can be used toward your Linode services, + and the promotion expires after a specified date. As well, + a monthly cap on the promotional offer is set. - Simply put, a promotion offers a certain amount of - credit month, until either the expiration date is - passed, or until the total promotional credit is used, - whichever comes first. + Simply put, a promotion offers a certain amount of credit month, + until either the expiration date is passed, or until the total + promotional credit is used, whichever comes first.' properties: credit_monthly_cap: description: The amount available to spend per month. @@ -721,10 +662,9 @@ paths: 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. + example: Receive up to $10 off your services every month + for 6 months! Unused credits will expire once this promotion + period ends. type: string expire_dt: description: When this promotion's credits expire. @@ -738,20 +678,20 @@ paths: service_type: description: The service to which this promotion applies. enum: - - all - - backup - - blockstorage - - db_mysql - - ip_v4 - - linode - - linode_disk - - linode_memory - - longview - - managed - - nodebalancer - - objectstorage - - placement_group - - transfer_tx + - all + - backup + - blockstorage + - db_mysql + - ip_v4 + - linode + - linode_disk + - linode_memory + - longview + - managed + - nodebalancer + - objectstorage + - placement_group + - transfer_tx example: all type: string x-linode-cli-display: 1 @@ -761,9 +701,8 @@ paths: type: string x-linode-cli-display: 10 this_month_credit_remaining: - description: >- - The amount of credit left for this month for this - promotion. + description: The amount of credit left for this month for + this promotion. example: '10.00' type: string x-linode-cli-display: 4 @@ -796,37 +735,34 @@ paths: type: number x-linode-cli-display: 4 balance_uninvoiced: - description: >- - __Read-only__ This account's current estimated invoice in - US dollars. This is not your final invoice balance. - Transfer charges are not included in the estimate. + description: __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. Accounts that are associated with Akamai-specific - customers return a value of `akamai`. All other accounts - return a value of `linode`. + description: __Read-only__ The source of service charges for this + account. Accounts that are associated with Akamai-specific customers + return a value of `akamai`. All other accounts return a value + of `linode`. enum: - - akamai - - linode + - akamai + - linode example: akamai readOnly: true type: string capabilities: - description: >- - __Read-only__ The Akamai Cloud Computing services your - account supports. + description: __Read-only__ The Akamai Cloud Computing services + your account supports. example: - - Linodes - - NodeBalancers - - Block Storage - - Object Storage - - Placement Groups - - Block Storage Encryption + - Linodes + - NodeBalancers + - Block Storage + - Object Storage + - Placement Groups + - Block Storage Encryption items: type: string readOnly: true @@ -837,63 +773,57 @@ paths: maxLength: 24 type: string company: - description: >- - The company name assigned to this account. This value + description: The company name assigned to this account. This value can't include the characters, `<` `>` `(` `)` `"` `=`. example: Linode LLC maxLength: 128 type: string country: - description: >- - The two-letter ISO 3166 country code for this account's + description: The two-letter ISO 3166 country code for this account's `address`. example: US type: string credit_card: additionalProperties: false - description: >- - __Read-only__ The credit card information assigned to this - account. + description: __Read-only__ The credit card information assigned + to this account. properties: expiry: description: The expiration month and year of the `credit_card`. example: 11/2022 type: string last_four: - description: >- - The last four digits of the `credit_card` assigned to - this account. + description: The last four digits of the `credit_card` assigned + to this account. example: 1111 type: string readOnly: true type: object email: - description: The email address of the person assigned to this account. + description: The email address of the person assigned to this + account. example: john.smith@linode.com maxLength: 128 type: string x-linode-cli-display: 3 euuid: - description: >- - __Read-only__ An external unique identifier for this + description: __Read-only__ An external unique identifier for this account. example: E1AF5EEC-526F-487D-B317EBEB34C87D71 format: uuid readOnly: true type: string first_name: - description: >- - The first name of the person assigned to this account. - This value can't include the characters, `<` `>` `(` `)` - `"` `=`. + description: The first name of the person assigned to this account. + This value can't include the characters, `<` `>` `(` `)` `"` + `=`. example: John maxLength: 50 type: string x-linode-cli-display: 1 last_name: - description: >- - The last name of the person assigned to this account. This - value can't include the characters, `<` `>` `(` `)` `"` + description: The last name of the person assigned to this account. + This value can't include the characters, `<` `>` `(` `)` `"` `=`. example: Smith maxLength: 50 @@ -905,62 +835,54 @@ paths: maxLength: 32 type: string state: - description: >- - The state or province for the `address` set for your - account, if applicable. + description: 'The state or province for the `address` set for + your account, if applicable. - - If the `address` is in the United States (US) or Canada - (CA), this is the two-letter ISO 3166 code for the state - or province. + - If the `address` is in the United States (US) or Canada (CA), + this is the two-letter ISO 3166 code for the state or province. - - If it's a US military `address`, this is the - abbreviation for that territory. This includes `AA` for - Armed Forces Americas (excluding Canada), `AE` for Armed - Forces Africa, Europe, Middle East, and Canada, or `AP` - for Armed Forces Pacific. + - If it''s a US military `address`, this is the abbreviation + for that territory. This includes `AA` for Armed Forces Americas + (excluding Canada), `AE` for Armed Forces Africa, Europe, Middle + East, and Canada, or `AP` for Armed Forces Pacific. - - If outside the US or CA, this is the province associated - with the account's `address`. + - If outside the US or CA, this is the province associated with + the account''s `address`.' example: PA maxLength: 24 type: string tax_id: - description: >- - The tax identification number (TIN) assigned to this - account, used for tax calculations. A TIN is set by the - national authorities in your `country`, based on your - `address_1`, and it may be named differently between - countries. Set to an empty string (`""`) if a TIN doesn't - apply or for countries that don't collect tax. + description: 'The tax identification number (TIN) assigned to + this account, used for tax calculations. A TIN is set by the + national authorities in your `country`, based on your `address_1`, + and it may be named differently between countries. Set to an + empty string (`""`) if a TIN doesn''t apply or for countries + that don''t collect tax. > 📘 > - > This value is externally validated. If the validation is - successful, a `tax_id_valid` - [event](https://techdocs.akamai.com/linode-api/reference/get-events) - is triggered. If unsuccessful, a `tax_id_invalid` event is - triggered and an error response is issued for an operation - that included it. + > This value is externally validated. If the validation is successful, + a `tax_id_valid` [event](https://techdocs.akamai.com/linode-api/reference/get-events) + is triggered. If unsuccessful, a `tax_id_invalid` event is triggered + and an error response is issued for an operation that included + it.' example: ATU99999999 maxLength: 25 type: string zip: - description: >- - The zip code for this account's `address`. + description: 'The zip code for this account''s `address`. - - It can only contain ASCII letters, numbers, and dashes - (`-`). + - It can only contain ASCII letters, numbers, and dashes (`-`). - - It can't contain more than nine letter or number - characters. + - It can''t contain more than nine letter or number characters.' example: 19102-1234 type: string type: object @@ -978,28 +900,24 @@ paths: errors: items: additionalProperties: false - description: >- - An object for describing a single error that occurred + description: An object for describing a single error that occurred during the processing of a request. properties: field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. example: fieldname type: string reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. example: fieldname must be a valid value type: string type: object @@ -1007,39 +925,27 @@ paths: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - account:read_write + - personalAccessToken: [] + - oauth: + - account:read_write summary: Update your account tags: - - Account + - Account x-akamai: tabs: - - syntax: |- - linode-cli account update \ - --address_1 "123 Main St." \ - --address_2 "Suite 101" \ - --city Philadelphia \ - --company My Company \ LLC \ - --country US \ - --email jsmith@mycompany.com \ - --first_name John \ - --last_name Smith \ - --phone 555-555-1212 \ - --state PA \ - --tax_id ATU99999999 \ - --zip 19102 - title: CLI - url: >- - https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - - syntax: account:read_write - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: "linode-cli account update \\\n --address_1 \"123 Main St.\" \\\ + \n --address_2 \"Suite 101\" \\\n --city Philadelphia \\\n --company\ + \ My Company \\ LLC \\\n --country US \\\n --email jsmith@mycompany.com\ + \ \\\n --first_name John \\\n --last_name Smith \\\n --phone 555-555-1212\ + \ \\\n --state PA \\\n --tax_id ATU99999999 \\\n --zip 19102" + title: CLI + url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_write + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: update x-linode-grant: read_write parameters: [] @@ -1049,63 +955,45 @@ paths: x-linode-cli-command: account /account/agreements: post: - description: >- - Accept required agreements by setting them to `true`. This remains until - the content of the agreement changes. If it does, you need to run this - operation again to accept it. If you set this to `false`, the API - rejects the request and you need to open a [support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) to - reset the agreement. Omitted agreements are left unchanged. __OAuth - scopes__. - - ``` - account:read_write - ``` - - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + description: "Accept required agreements by setting them to `true`. This remains\ + \ until the content of the agreement changes. If it does, you need to run\ + \ this operation again to accept it. If you set this to `false`, the API rejects\ + \ the request and you need to open a [support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket)\ + \ to reset the agreement. Omitted agreements are left unchanged. __OAuth scopes__.\n\ + \n ```\n account:read_write\n ```\n\n[Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)" externalDocs: description: See documentation for this operation in Akamai's Linode API - url: >- - https://techdocs.akamai.com/linode-api/reference/post-account-agreements + url: https://techdocs.akamai.com/linode-api/reference/post-account-agreements operationId: post-account-agreements requestBody: content: application/json: schema: additionalProperties: false - description: >- - Acknowledgment status for agreements on your account. When - acknowledging any agreements, set them to `true` and omit any - remainders. + description: Acknowledgment status for agreements on your account. When + acknowledging any agreements, set them to `true` and omit any remainders. properties: billing_agreement: - description: >- - Certain regions require that you share your tax - identification number (TIN) with Akamai. When you do, you - need to acknowledge Akamai's [privacy - statement](https://www.akamai.com/legal/privacy-statement) - agreement, in regards to its protection. When set to `true`, - you've acknowledged this agreement. + description: Certain regions require that you share your tax identification + number (TIN) with Akamai. When you do, you need to acknowledge + Akamai's [privacy statement](https://www.akamai.com/legal/privacy-statement) + agreement, in regards to its protection. When set to `true`, you've + acknowledged this agreement. example: '{{billing_agreement}}' type: boolean eu_model: - description: >- - The acknowledgement status for the [cross-border data + description: The acknowledgement status for the [cross-border data transfer](https://www.akamai.com/legal/compliance/privacy-trust-center/cross-border-data-transfer-statement) agreement. example: '{{eu_model}}' type: boolean master_service_agreement: - description: >- - The acknowledgement status for Akamai's [master service + description: The acknowledgement status for Akamai's [master service agreement](https://www.linode.com/legal-msa/). example: '{{master_service_agreement}}' type: boolean privacy_policy: - description: >- - The acknowledgement status for Akamai's [privacy - statement](https://www.akamai.com/legal/privacy-statement). + description: The acknowledgement status for Akamai's [privacy statement](https://www.akamai.com/legal/privacy-statement). example: '{{privacy_policy}}' type: boolean type: object @@ -1119,11 +1007,12 @@ paths: content: application/json: schema: - description: The API responds with an empty object. - maxProperties: 0 type: object - x-akamai: - file-path: schemas/added-empty-obj.yaml + properties: + message: + type: string + description: Always null - the API returns an empty object on + success. x-example: x-ref: ../examples/post-account-agreements-200.json description: Agreements updated successfully. @@ -1136,28 +1025,24 @@ paths: errors: items: additionalProperties: false - description: >- - An object for describing a single error that occurred + description: An object for describing a single error that occurred during the processing of a request. properties: field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. example: fieldname type: string reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. example: fieldname must be a valid value type: string type: object @@ -1165,40 +1050,29 @@ paths: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - account:read_write + - personalAccessToken: [] + - oauth: + - account:read_write summary: Acknowledge agreements tags: - - Account agreements + - Account agreements x-akamai: tabs: - - syntax: account:read_write - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: account:read_write + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: post-agreements x-linode-cli-skip: true x-linode-grant: unrestricted only get: - description: >- - Returns all agreements and their acceptance status for your account. - __OAuth scopes__. - - ``` - account:read_only - ``` - - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + description: "Returns all agreements and their acceptance status for your account.\ + \ __OAuth scopes__.\n\n ```\n account:read_only\n ```\n\n[Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)" externalDocs: description: See documentation for this operation in Akamai's Linode API - url: >- - https://techdocs.akamai.com/linode-api/reference/get-account-agreements + url: https://techdocs.akamai.com/linode-api/reference/get-account-agreements operationId: get-account-agreements responses: '200': @@ -1206,36 +1080,30 @@ paths: application/json: schema: additionalProperties: false - description: >- - Acknowledgment status for agreements on your account. When - acknowledging any agreements, set them to `true` and omit any + description: Acknowledgment status for agreements on your account. + When acknowledging any agreements, set them to `true` and omit any remainders. properties: billing_agreement: - description: >- - Certain regions require that you share your tax - identification number (TIN) with Akamai. When you do, you - need to acknowledge Akamai's [privacy - statement](https://www.akamai.com/legal/privacy-statement) - agreement, in regards to its protection. When set to - `true`, you've acknowledged this agreement. + description: Certain regions require that you share your tax identification + number (TIN) with Akamai. When you do, you need to acknowledge + Akamai's [privacy statement](https://www.akamai.com/legal/privacy-statement) + agreement, in regards to its protection. When set to `true`, + you've acknowledged this agreement. type: boolean eu_model: - description: >- - The acknowledgement status for the [cross-border data - transfer](https://www.akamai.com/legal/compliance/privacy-trust-center/cross-border-data-transfer-statement) + description: The acknowledgement status for the [cross-border + data transfer](https://www.akamai.com/legal/compliance/privacy-trust-center/cross-border-data-transfer-statement) agreement. example: true type: boolean master_service_agreement: - description: >- - The acknowledgement status for Akamai's [master service + description: The acknowledgement status for Akamai's [master service agreement](https://www.linode.com/legal-msa/). example: true type: boolean privacy_policy: - description: >- - The acknowledgement status for Akamai's [privacy + description: The acknowledgement status for Akamai's [privacy statement](https://www.akamai.com/legal/privacy-statement). example: true type: boolean @@ -1254,28 +1122,24 @@ paths: errors: items: additionalProperties: false - description: >- - An object for describing a single error that occurred + description: An object for describing a single error that occurred during the processing of a request. properties: field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. example: fieldname type: string reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. example: fieldname must be a valid value type: string type: object @@ -1283,22 +1147,20 @@ paths: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - account:read_only + - personalAccessToken: [] + - oauth: + - account:read_only summary: List agreements tags: - - Account agreements + - Account agreements x-akamai: tabs: - - syntax: account:read_only - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: agreements x-linode-cli-skip: true x-linode-grant: unrestricted only @@ -1309,9 +1171,8 @@ paths: x-linode-cli-command: agreements /account/availability: get: - description: >- - Returns a paginated list of the services available to you, for all - Linode regions. + description: 'Returns a paginated list of the services available to you, for + all Linode regions. > 📘 @@ -1321,127 +1182,109 @@ paths: > Only authorized users can run this operation. - [Learn - more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-availability operationId: get-availability parameters: - - description: The page of a collection to return. - example: '{{page}}' - in: query - name: page - required: false - schema: - default: 1 - example: 6 - minimum: 1 - type: integer - x-akamai: - file-path: parameters/page-offset.yaml - - description: The number of items to return per page. - example: '{{page_size}}' - in: query - name: page_size - schema: - default: 100 - example: 50 - maximum: 500 - minimum: 25 - type: integer - x-akamai: - file-path: parameters/page-size.yaml + - description: The page of a collection to return. + example: '{{page}}' + in: query + name: page + required: false + schema: + default: 1 + example: 6 + minimum: 1 + type: integer + x-akamai: + file-path: parameters/page-offset.yaml + - description: The number of items to return per page. + example: '{{page_size}}' + in: query + name: page_size + schema: + default: 100 + example: 50 + maximum: 500 + minimum: 25 + type: integer + x-akamai: + file-path: parameters/page-size.yaml responses: '200': content: application/json: schema: - allOf: - - additionalProperties: false - properties: - data: - items: - additionalProperties: false - description: Account Service Availability object. - properties: - available: - description: >- - __Read-only__ A list of services _available_ to - your account in the `region`. - example: - - Linodes - - NodeBalancers - items: - type: string - readOnly: true - type: array - region: - description: >- - __Read-only__ The Akamai cloud computing data - center (region), represented by a slug value. - You can view a full list of regions and their - associated slugs with the [List - regions](https://techdocs.akamai.com/linode-api/reference/get-regions) - operation. - example: us-east - readOnly: true - type: string - x-linode-cli-display: 1 - unavailable: - description: >- - __Read-only__ A list of services _unavailable_ - to your account in the `region`. - example: - - Kubernetes - - Block Storage - items: - type: string - readOnly: true - type: array - x-linode-cli-display: 3 - type: object - x-akamai: - file-path: schemas/account-availability.yaml - type: array - type: object - - additionalProperties: false - description: >- - An envelope for paginated response. When accessing a - collection through a GET endpoint, the results are wrapped - in this envelope which includes metadata about those - results. Results are presented within a `data` array. See - [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) - for more information. - properties: - page: - description: >- - __Read-only__ The current - [page](https://techdocs.akamai.com/linode-api/reference/pagination). - example: 1 - readOnly: true - type: integer - pages: - description: >- - __Read-only__ The total number of - [pages](https://techdocs.akamai.com/linode-api/reference/pagination). - example: 1 - readOnly: true - type: integer - results: - description: __Read-only__ The total number of results. - example: 1 - readOnly: true - type: integer - type: object - x-akamai: - file-path: schemas/pagination-envelope.yaml x-akamai: file-path: schemas/added-get-availability-200.yaml + additionalProperties: false + properties: + data: + items: + additionalProperties: false + description: Account Service Availability object. + properties: + available: + description: __Read-only__ A list of services _available_ + to your account in the `region`. + example: + - Linodes + - NodeBalancers + items: + type: string + readOnly: true + type: array + region: + description: __Read-only__ The Akamai cloud computing data + center (region), represented by a slug value. You can + view a full list of regions and their associated slugs + with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) + operation. + example: us-east + readOnly: true + type: string + x-linode-cli-display: 1 + unavailable: + description: __Read-only__ A list of services _unavailable_ + to your account in the `region`. + example: + - Kubernetes + - Block Storage + items: + type: string + readOnly: true + type: array + x-linode-cli-display: 3 + type: object + x-akamai: + file-path: schemas/account-availability.yaml + type: array + page: + description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + example: 1 + readOnly: true + type: integer + pages: + description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + example: 1 + readOnly: true + type: integer + results: + description: __Read-only__ The total number of results. + example: 1 + readOnly: true + type: integer + type: object + 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. x-example: x-ref: ../examples/get-availability-200.json description: List of regions and the services available in each. @@ -1454,28 +1297,24 @@ paths: errors: items: additionalProperties: false - description: >- - An object for describing a single error that occurred + description: An object for describing a single error that occurred during the processing of a request. properties: field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. example: fieldname type: string reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. example: fieldname must be a valid value type: string type: object @@ -1483,26 +1322,23 @@ paths: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - account:read_only + - personalAccessToken: [] + - oauth: + - account:read_only summary: List available services tags: - - Account availability + - Account availability x-akamai: tabs: - - syntax: linode-cli account get-availability - title: CLI - url: >- - https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - - syntax: account:read_only - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: linode-cli account get-availability + title: CLI + url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: get-availability x-linode-grant: read_only parameters: [] @@ -1510,10 +1346,9 @@ paths: file-path: paths/account-availability.yaml path-info: /{apiVersion}/account/availability x-linode-cli-command: account - /account/availability/{id}: + /account/availability/{regionId}: get: - description: >- - View the available services for your account, in a specific region. + description: 'View the available services for your account, in a specific region. > 📘 @@ -1523,16 +1358,13 @@ paths: > Only account users with _unrestricted_ access can run this operation. - [Learn - more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)' externalDocs: description: See documentation for this operation in Akamai's Linode API - url: >- - https://techdocs.akamai.com/linode-api/reference/get-account-availability + url: https://techdocs.akamai.com/linode-api/reference/get-account-availability operationId: get-account-availability responses: '200': @@ -1543,34 +1375,30 @@ paths: description: Account Service Availability object. properties: available: - description: >- - __Read-only__ A list of services _available_ to your + description: __Read-only__ A list of services _available_ to your account in the `region`. example: - - Linodes - - NodeBalancers + - Linodes + - NodeBalancers items: type: string readOnly: true type: array region: - description: >- - __Read-only__ The Akamai cloud computing data center - (region), represented by a slug value. You can view a full - list of regions and their associated slugs with the [List - regions](https://techdocs.akamai.com/linode-api/reference/get-regions) + description: __Read-only__ The Akamai cloud computing data center + (region), represented by a slug value. You can view a full list + of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation. example: us-east readOnly: true type: string x-linode-cli-display: 1 unavailable: - description: >- - __Read-only__ A list of services _unavailable_ to your - account in the `region`. + description: __Read-only__ A list of services _unavailable_ to + your account in the `region`. example: - - Kubernetes - - Block Storage + - Kubernetes + - Block Storage items: type: string readOnly: true @@ -1591,28 +1419,24 @@ paths: errors: items: additionalProperties: false - description: >- - An object for describing a single error that occurred + description: An object for describing a single error that occurred during the processing of a request. properties: field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. example: fieldname type: string reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. example: fieldname must be a valid value type: string type: object @@ -1620,75 +1444,68 @@ paths: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - account:read_only - summary: Get a region's service availability + - personalAccessToken: [] + - oauth: + - account:read_only + summary: Get available services for a region tags: - - Account + - Account availability x-akamai: tabs: - - syntax: linode-cli account get-account-availability us-east - title: CLI - url: >- - https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - - syntax: account:read_only - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: linode-cli account get-account-availability us-east + title: CLI + url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: get-account-availability x-linode-grant: read_only - parameters: - - description: >- - The slug for the applicable data center. Run the [List - regions](https://techdocs.akamai.com/linode-api/reference/get-regions) + parameters: + - description: The abbreviated value ("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. - example: '{{id}}' + example: '{{regionId}}' in: path - name: id + name: regionId required: true schema: + example: us-iad type: string x-akamai: - file-path: parameters/id-path.yaml + file-path: parameters/region-id-path.yaml x-akamai: file-path: paths/data-center.yaml - path-info: /{apiVersion}/account/availability/{id} + path-info: /{apiVersion}/account/availability/{regionId} x-linode-cli-command: account /account/betas: post: - description: >- - Enroll your Account in an active Beta Program. + description: 'Enroll your Account in an active Beta Program. Only unrestricted Users can access this operation. - To view active Beta Programs, run the [List beta - programs](https://techdocs.akamai.com/linode-api/reference/get-beta-programs) + To view active Beta Programs, run the [List beta programs](https://techdocs.akamai.com/linode-api/reference/get-beta-programs) operation. - Active Beta Programs may have a limited number of enrollments. If a Beta - Program has reached is maximum number of enrollments, an error is - returned even though the request is successful. + Active Beta Programs may have a limited number of enrollments. If a Beta Program + has reached is maximum number of enrollments, an error is returned even though + the request is successful. - Beta Programs with `"greenlight_only": true` can only be enrolled by - Accounts that participate in the - [Greenlight](https://www.linode.com/green-light/) program. + Beta Programs with `"greenlight_only": true` can only be enrolled by Accounts + that participate in the [Greenlight](https://www.linode.com/green-light/) + program. - [Learn - more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/post-beta-program @@ -1706,7 +1523,7 @@ paths: type: string x-linode-cli-display: 1 required: - - id + - id type: object x-akamai: file-path: schemas/added-post-beta-program.yaml @@ -1719,11 +1536,12 @@ paths: content: application/json: schema: - description: The API responds with an empty object. - maxProperties: 0 type: object - x-akamai: - file-path: schemas/added-empty-obj.yaml + properties: + message: + type: string + description: Always null - the API returns an empty object on + success. x-example: x-ref: ../examples/post-beta-program-200.json description: Enrollment request successful. @@ -1736,28 +1554,24 @@ paths: errors: items: additionalProperties: false - description: >- - An object for describing a single error that occurred + description: An object for describing a single error that occurred during the processing of a request. properties: field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. example: fieldname type: string reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. example: fieldname must be a valid value type: string type: object @@ -1765,269 +1579,234 @@ paths: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - account:read_write + - personalAccessToken: [] + - oauth: + - account:read_write summary: Enroll in a Beta program tags: - - Beta programs + - Beta programs x-akamai: tabs: - - syntax: linode-cli betas enroll --id example_open - title: CLI - url: >- - https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - - syntax: account:read_write - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: linode-cli betas enroll --id example_open + title: CLI + url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_write + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: enroll x-linode-grant: unrestricted only get: - description: >- - Display all enrolled Beta Programs for your Account. Includes inactive - as well as active Beta Programs. + description: 'Display all enrolled Beta Programs for your Account. Includes + inactive as well as active Beta Programs. Only unrestricted Users can access this operation. - [Learn - more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)' externalDocs: description: See documentation for this operation in Akamai's Linode API - url: >- - https://techdocs.akamai.com/linode-api/reference/get-enrolled-beta-programs + url: https://techdocs.akamai.com/linode-api/reference/get-enrolled-beta-programs operationId: get-enrolled-beta-programs parameters: - - description: The page of a collection to return. - example: '{{page}}' - in: query - name: page - required: false - schema: - default: 1 - example: 6 - minimum: 1 - type: integer - x-akamai: - file-path: parameters/page-offset.yaml - - description: The number of items to return per page. - example: '{{page_size}}' - in: query - name: page_size - schema: - default: 100 - example: 50 - maximum: 500 - minimum: 25 - type: integer - x-akamai: - file-path: parameters/page-size.yaml + - description: The page of a collection to return. + example: '{{page}}' + in: query + name: page + required: false + schema: + default: 1 + example: 6 + minimum: 1 + type: integer + x-akamai: + file-path: parameters/page-offset.yaml + - description: The number of items to return per page. + example: '{{page_size}}' + in: query + name: page_size + schema: + default: 100 + example: 50 + maximum: 500 + minimum: 25 + type: integer + x-akamai: + file-path: parameters/page-size.yaml responses: '200': content: application/json: example: data: - - description: This is an open public beta for an example feature. - ended: null - enrolled: '2023-09-11T00:00:00' - id: example_open - label: Example Open Beta - started: '2023-07-11T00:00:00' + - description: This is an open public beta for an example feature. + ended: null + enrolled: '2023-09-11T00:00:00' + id: example_open + label: Example Open Beta + started: '2023-07-11T00:00:00' page: 1 pages: 1 results: 1 schema: - allOf: - - additionalProperties: false - description: >- - An envelope for paginated response. When accessing a - collection through a GET endpoint, the results are wrapped - in this envelope which includes metadata about those - results. Results are presented within a `data` array. See - [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) - for more information. - properties: - page: - description: >- - __Read-only__ The current - [page](https://techdocs.akamai.com/linode-api/reference/pagination). - example: 1 - readOnly: true - type: integer - pages: - description: >- - __Read-only__ The total number of - [pages](https://techdocs.akamai.com/linode-api/reference/pagination). - example: 1 - readOnly: true - type: integer - results: - description: __Read-only__ The total number of results. - example: 1 - readOnly: true - type: integer - type: object - x-akamai: - file-path: schemas/pagination-envelope.yaml - - properties: - data: - items: - additionalProperties: false - description: >- - An object representing an enrolled Beta Program for - the Account. - properties: - description: - description: >- - __Read-only__ Additional details regarding the - Beta Program. - example: >- - This is an open public beta for an example - feature. - nullable: true - readOnly: true - type: string - x-linode-cli-display: 3 - ended: - description: >- - __Filterable__, __Read-only__ The date-time that - the Beta Program ended. - - - `null` indicates that the Beta Program is - ongoing. - example: null - format: date-time - nullable: true - readOnly: true - type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 5 - x-linode-filterable: true - enrolled: - description: >- - __Filterable__, __Read-only__ The date-time of - Account enrollment to the Beta Program. - example: '2023-09-11T00:00:00' - format: date-time - readOnly: true - type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 6 - x-linode-filterable: true - id: - description: The unique identifier of the Beta Program. - example: example_open - type: string - x-linode-cli-display: 1 - label: - description: >- - __Filterable__, __Read-only__ The name of the - Beta Program. - example: Example Open Beta - readOnly: true - type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 2 - x-linode-filterable: true - started: - description: >- - __Filterable__, __Read-only__ The start - date-time of the Beta Program. - example: '2023-07-11T00:00:00' - format: date-time - readOnly: true - type: string - x-akamai: - labels: - - Filterable - x-linode-cli-display: 4 - x-linode-filterable: true - type: object - x-akamai: - file-path: schemas/beta-program-enrolled.yaml - type: array - type: object x-akamai: file-path: schemas/added-get-enrolled-beta-programs-200.yaml - description: >- - Returns a paginated list of all enrolled Beta Program objects for - the Account. - default: - content: - application/json: - schema: additionalProperties: false + description: An envelope for paginated response. When accessing a + collection through a GET endpoint, the results are wrapped in this + envelope which includes metadata about those results. Results are + presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) + for more information. properties: - errors: + page: + description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). + example: 1 + readOnly: true + type: integer + pages: + description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + example: 1 + readOnly: true + type: integer + results: + description: __Read-only__ The total number of results. + example: 1 + readOnly: true + type: integer + data: items: additionalProperties: false - description: >- - An object for describing a single error that occurred - during the processing of a request. + description: An object representing an enrolled Beta Program + for the Account. properties: - field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. - example: fieldname - type: string - reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. - example: fieldname must be a valid value + 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 - type: object + x-linode-cli-display: 3 + ended: + description: '__Filterable__, __Read-only__ The date-time + that the Beta Program ended. + + + `null` indicates that the Beta Program is ongoing.' + example: null + format: date-time + nullable: true + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 5 + x-linode-filterable: true + enrolled: + description: __Filterable__, __Read-only__ The date-time + of Account enrollment to the Beta Program. + example: '2023-09-11T00:00:00' + format: date-time + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 6 + x-linode-filterable: true + id: + description: The unique identifier of the Beta Program. + example: example_open + type: string + x-linode-cli-display: 1 + label: + description: __Filterable__, __Read-only__ The name of the + Beta Program. + example: Example Open Beta + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 2 + x-linode-filterable: true + started: + description: __Filterable__, __Read-only__ The start date-time + of the Beta Program. + example: '2023-07-11T00:00:00' + format: date-time + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 4 + x-linode-filterable: true + type: object + x-akamai: + file-path: schemas/beta-program-enrolled.yaml + type: array + type: object + description: Returns a paginated list of all enrolled Beta Program objects + for the Account. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. + example: fieldname + type: string + reason: + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. + example: fieldname must be a valid value + type: string + type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - account:read_only + - personalAccessToken: [] + - oauth: + - account:read_only summary: List enrolled Beta programs tags: - - Beta programs + - Beta programs x-akamai: tabs: - - syntax: linode-cli betas enrolled - title: CLI - url: >- - https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - - syntax: account:read_only - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: linode-cli betas enrolled + title: CLI + url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: enrolled x-linode-grant: unrestricted only parameters: [] @@ -2037,24 +1816,20 @@ paths: x-linode-cli-command: betas /account/betas/{betaId}: get: - description: >- - Display an enrolled Beta Program for your Account. The Beta Program may - be inactive. + description: 'Display an enrolled Beta Program for your Account. The Beta Program + may be inactive. Only unrestricted Users can access this operation. - [Learn - more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)' externalDocs: description: See documentation for this operation in Akamai's Linode API - url: >- - https://techdocs.akamai.com/linode-api/reference/get-enrolled-beta-program + url: https://techdocs.akamai.com/linode-api/reference/get-enrolled-beta-program operationId: get-enrolled-beta-program responses: '200': @@ -2062,13 +1837,11 @@ paths: application/json: schema: additionalProperties: false - description: >- - An object representing an enrolled Beta Program for the + description: An object representing an enrolled Beta Program for the Account. properties: description: - description: >- - __Read-only__ Additional details regarding the Beta + description: __Read-only__ Additional details regarding the Beta Program. example: This is an open public beta for an example feature. nullable: true @@ -2076,12 +1849,11 @@ paths: type: string x-linode-cli-display: 3 ended: - description: >- - __Filterable__, __Read-only__ The date-time that the Beta - Program ended. + description: '__Filterable__, __Read-only__ The date-time that + the Beta Program ended. - `null` indicates that the Beta Program is ongoing. + `null` indicates that the Beta Program is ongoing.' example: null format: date-time nullable: true @@ -2089,12 +1861,11 @@ paths: type: string x-akamai: labels: - - Filterable + - Filterable x-linode-cli-display: 5 x-linode-filterable: true enrolled: - description: >- - __Filterable__, __Read-only__ The date-time of Account + description: __Filterable__, __Read-only__ The date-time of Account enrollment to the Beta Program. example: '2023-09-11T00:00:00' format: date-time @@ -2102,7 +1873,7 @@ paths: type: string x-akamai: labels: - - Filterable + - Filterable x-linode-cli-display: 6 x-linode-filterable: true id: @@ -2111,28 +1882,26 @@ paths: type: string x-linode-cli-display: 1 label: - description: >- - __Filterable__, __Read-only__ The name of the Beta + description: __Filterable__, __Read-only__ The name of the Beta Program. example: Example Open Beta readOnly: true type: string x-akamai: labels: - - Filterable + - Filterable x-linode-cli-display: 2 x-linode-filterable: true started: - description: >- - __Filterable__, __Read-only__ The start date-time of the - Beta Program. + 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 + - Filterable x-linode-cli-display: 4 x-linode-filterable: true type: object @@ -2150,28 +1919,24 @@ paths: errors: items: additionalProperties: false - description: >- - An object for describing a single error that occurred + description: An object for describing a single error that occurred during the processing of a request. properties: field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. example: fieldname type: string reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. example: fieldname must be a valid value type: string type: object @@ -2179,29 +1944,26 @@ paths: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - account:read_only + - personalAccessToken: [] + - oauth: + - account:read_only summary: Get an enrolled Beta program tags: - - Beta programs + - Beta programs x-akamai: tabs: - - syntax: linode-cli betas enrolled-view $betaId - title: CLI - url: >- - https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - - syntax: account:read_only - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: linode-cli betas enrolled-view $betaId + title: CLI + url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: enrolled-view x-linode-grant: unrestricted only - parameters: + parameters: - description: The ID of the Beta Program. example: '{{betaId}}' in: path @@ -2217,50 +1979,43 @@ paths: x-linode-cli-command: betas /account/cancel: post: - description: >- - Deletes an active account. Akamai attempts to charge the credit card on - file for any remaining balance. An error occurs if this charge fails. + description: 'Deletes an active account. Akamai attempts to charge the credit + card on file for any remaining balance. An error occurs if this charge fails. > 🚧 > - > - This operation permanently deletes your account and it _can't_ be - recovered. Also, there is no warning prompt after you execute this - operation. + > - This operation permanently deletes your account and it _can''t_ be recovered. + Also, there is no warning prompt after you execute this operation. > - > - Only account users with _unrestricted_ access can run this - operation. + > - Only account users with _unrestricted_ access can run this operation. __Parent and child accounts__ - In a [parent and child - account](https://www.linode.com/docs/guides/parent-child-accounts/) + In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - - A child account user can't remove a child account. + - A child account user can''t remove a child account. - - You can't remove a parent account if it has an active child account. + - You can''t remove a parent account if it has an active child account. - - You need to work with your Akamai account team to dissolve any - parent-child account relationships before you can fully remove a child - or parent account. + - You need to work with your Akamai account team to dissolve any parent-child + account relationships before you can fully remove a child or parent account. - [Learn - more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/post-cancel-account @@ -2272,8 +2027,7 @@ paths: additionalProperties: false properties: comments: - description: >- - Any reason for cancelling the account, and any other + description: Any reason for cancelling the account, and any other comments you might have about your Linode service. example: '{{comments}}' type: string @@ -2282,8 +2036,7 @@ paths: file-path: schemas/added-post-cancel-account.yaml x-example: x-ref: ../examples/post-cancel-account.json - description: >- - Supply a comment stating the reason that you are cancelling your + description: Supply a comment stating the reason that you are cancelling your account. required: true responses: @@ -2315,14 +2068,12 @@ paths: additionalProperties: false properties: reason: - description: >- - A string explaining that the account could not be - canceled because there is an outstanding balance on - the account that must be paid first. - example: >- - We were unable to charge your credit card for - services rendered. We cannot cancel this account - until the balance has been paid. + description: A string explaining that the account could + not be canceled because there is an outstanding balance + on the account that must be paid first. + example: We were unable to charge your credit card for services + rendered. We cannot cancel this account until the balance + has been paid. type: string type: object type: array @@ -2345,12 +2096,10 @@ paths: additionalProperties: false properties: reason: - description: >- - A string explaining that the account is taking + description: A string explaining that the account is taking longer to close than expected. - example: >- - Cancellation is taking longer than expected. It may - have been successful. Contact customer support to + example: Cancellation is taking longer than expected. It + may have been successful. Contact customer support to confirm. type: string type: object @@ -2372,28 +2121,24 @@ paths: errors: items: additionalProperties: false - description: >- - An object for describing a single error that occurred + description: An object for describing a single error that occurred during the processing of a request. properties: field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. example: fieldname type: string reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. example: fieldname must be a valid value type: string type: object @@ -2401,28 +2146,24 @@ paths: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - account:read_write + - personalAccessToken: [] + - oauth: + - account:read_write summary: Delete your account tags: - - Account + - Account x-akamai: tabs: - - syntax: |- - linode-cli account cancel \ - --comments "I'm consolidating my accounts" - title: CLI - url: >- - https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - - syntax: account:read_write - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: "linode-cli account cancel \\\n --comments \"I'm consolidating\ + \ my accounts\"" + title: CLI + url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_write + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: cancel x-linode-grant: read_write parameters: [] @@ -2432,57 +2173,53 @@ paths: x-linode-cli-command: account /account/child-accounts: get: - description: >- - Returns a paginated list of basic information for the child accounts - that exist for your parent account. See [Parent and Child Accounts for - Akamai - Partners](https://www.linode.com/docs/guides/parent-child-accounts/) for - details on these accounts. + description: 'Returns a paginated list of basic information for the child accounts + that exist for your parent account. See [Parent and Child Accounts for Akamai + Partners](https://www.linode.com/docs/guides/parent-child-accounts/) for details + on these accounts. > 📘 > - > This operation can only be accessed by an unrestricted parent user, or - restricted parent user with the `child_account_access` grant. + > This operation can only be accessed by an unrestricted parent user, or restricted + parent user with the `child_account_access` grant. - [Learn - more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-child-accounts operationId: get-child-accounts parameters: - - description: The page of a collection to return. - example: '{{page}}' - in: query - name: page - required: false - schema: - default: 1 - example: 6 - minimum: 1 - type: integer - x-akamai: - file-path: parameters/page-offset.yaml - - description: The number of items to return per page. - example: '{{page_size}}' - in: query - name: page_size - schema: - default: 100 - example: 50 - maximum: 500 - minimum: 25 - type: integer - x-akamai: - file-path: parameters/page-size.yaml + - description: The page of a collection to return. + example: '{{page}}' + in: query + name: page + required: false + schema: + default: 1 + example: 6 + minimum: 1 + type: integer + x-akamai: + file-path: parameters/page-offset.yaml + - description: The number of items to return per page. + example: '{{page_size}}' + in: query + name: page_size + schema: + default: 100 + example: 50 + maximum: 500 + minimum: 25 + type: integer + x-akamai: + file-path: parameters/page-size.yaml responses: '200': content: @@ -2496,124 +2233,110 @@ paths: description: Child account object. properties: active_since: - description: >- - __Read-only__ The activation date and time for the - child account. + description: __Read-only__ The activation date and time + for the child account. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string address_1: - description: >- - __Filterable__ First line of this child account's + description: __Filterable__ First line of this child account's billing address. example: 123 Main Street maxLength: 64 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-filterable: true address_2: - description: >- - __Filterable__ Second line of this child account's + description: __Filterable__ Second line of this child account's billing address, if applicable. example: Suite A maxLength: 64 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-filterable: true balance: - description: >- - __Read-only__ This child account's balance, in US - dollars. + 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. + 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. + description: __Read-only__ The source of service charges + for this account, as determined by its relationship with + Akamai. The API returns a value of `external` to describe + a child account in a parent-child account environment. enum: - - external + - external example: external readOnly: true type: string capabilities: - description: >- - __Read-only__ A list of the capabilities the child - account supports. + description: __Read-only__ A list of the capabilities the + child account supports. example: - - Linodes - - NodeBalancers - - Block Storage - - Object Storage + - Linodes + - NodeBalancers + - Block Storage + - Object Storage items: type: string readOnly: true type: array city: - description: >- - __Filterable__ The city for this child account's + description: __Filterable__ The city for this child account's billing address. example: San Diego maxLength: 24 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-filterable: true company: - description: >- - __Filterable__ The company name for the owner of - this child account. It can't include any of these - characters: `<` `>` `(` `)` `"` `=`. You can't - change this value yourself. We use it to create the - proxy users that a parent account uses to access a - child account. Talk to your account team if you need - to change this value. + description: '__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 + - Filterable x-linode-filterable: true country: - description: >- - __Filterable__ The two-letter ISO 3166 country code - for this child account's billing address. + description: __Filterable__ The two-letter ISO 3166 country + code for this child account's billing address. example: US type: string x-akamai: labels: - - Filterable + - Filterable x-linode-filterable: true credit_card: additionalProperties: false - description: >- - __Read-only__ Information for the credit card you've - assigned to this child account. + description: __Read-only__ Information for the credit card + you've assigned to this child account. properties: expiry: - description: >- - The expiration month and year of the credit + description: The expiration month and year of the credit card. example: 11/2024 type: string @@ -2624,126 +2347,111 @@ paths: readOnly: true type: object email: - description: >- - __Filterable__ The email address of the owner of - this child account. + description: __Filterable__ The email address of the owner + of this child account. example: john.smith@linode.com maxLength: 128 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-cli-display: 3 x-linode-filterable: true euuid: - description: >- - __Read-only__ An external, unique identifier that - Akamai assigned to the child account. + description: __Read-only__ An external, unique identifier + that Akamai assigned to the child account. example: A1BC2DEF-34GH-567I-J890KLMN12O34P56 format: uuid readOnly: true type: string first_name: - description: >- - __Filterable__ The first name of the owner of this - child account. It can't include any of these - characters: `<` `>` `(` `)` `"` `=`. + description: '__Filterable__ The first name of the owner + of this child account. It can''t include any of these + characters: `<` `>` `(` `)` `"` `=`.' example: John maxLength: 50 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-cli-display: 1 x-linode-filterable: true last_name: - description: >- - __Filterable__ The last name of the owner of this - child account. It can't include any of these - characters: `<` `>` `(` `)` `"` `=`. + description: '__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 + - Filterable x-linode-cli-display: 2 x-linode-filterable: true phone: - description: >- - __Filterable__ The phone number for the owner of - this child account. + description: __Filterable__ The phone number for the owner + of this child account. example: 858-555-1212 maxLength: 32 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-filterable: true state: - description: >- - __Filterable__ The state or province for the billing - address (`address_1` and `address_2, if - applicable`). If in the United States (US) or Canada - (CA), this is the two-letter ISO 3166 State or - Province code. + description: '__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. > 📘 > - > If this is a US military address, use state - abbreviations (AA, AE, AP). + > If this is a US military address, use state abbreviations + (AA, AE, AP).' example: CA maxLength: 24 type: string x-akamai: labels: - - Filterable + - 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 - (`""`). + description: The tax identification number for this child + account. Use this for tax calculations in some countries. + If you live in a country that doesn't collect taxes, ensure + this is an empty string (`""`). example: ATU99999999 maxLength: 25 type: string zip: - description: >- - __Filterable__ The zip code of this Account's + description: '__Filterable__ The zip code of this Account''s billing address. The following restrictions apply: - - Can only contain ASCII letters, numbers, and - hyphens (`-`). + - Can only contain ASCII letters, numbers, and hyphens + (`-`). - - Can't contain more than 9 letter or number - characters. + - Can''t contain more than 9 letter or number characters.' example: 92111-1234 type: string x-akamai: labels: - - Filterable + - 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](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: - description: >- - __Read-only__ The total number of - [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer @@ -2767,28 +2475,24 @@ paths: errors: items: additionalProperties: false - description: >- - An object for describing a single error that occurred + description: An object for describing a single error that occurred during the processing of a request. properties: field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. example: fieldname type: string reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. example: fieldname must be a valid value type: string type: object @@ -2796,58 +2500,51 @@ paths: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - child_account:read_only + - personalAccessToken: [] + - oauth: + - child_account:read_only summary: List child accounts tags: - - Child accounts + - Child accounts x-akamai: tabs: - - syntax: linode-cli child-account list - title: CLI - url: >- - https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - - syntax: child_account:read_only - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: linode-cli child-account list + title: CLI + url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: child_account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: - - list - - ls + - list + - ls x-linode-grant: child_account_access parameters: [] x-akamai: file-path: paths/child-accounts.yaml path-info: /{apiVersion}/account/child-accounts x-linode-cli-command: child-account - /account/child-accounts/{euuid}: + /account/child-accounts/{euuId}: get: - description: >- - View a specific child account based on its `euuid`. See [Parent and - Child Accounts for Akamai - Partners](https://www.linode.com/docs/guides/parent-child-accounts/) for - details on these accounts. + description: 'View a specific child account. See [Parent and Child Accounts + for Akamai Partners](https://www.linode.com/docs/guides/parent-child-accounts/) + for details on these accounts. > 📘 > - > This operation can only be accessed by an unrestricted user, or - restricted user with the `child_account_access` grant. + > This operation can only be accessed by an unrestricted user, or restricted + user with the `child_account_access` grant. - [Learn - more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-child-account @@ -2861,115 +2558,105 @@ paths: description: Child account object. properties: active_since: - description: >- - __Read-only__ The activation date and time for the child - account. + description: __Read-only__ The activation date and time for the + child account. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string address_1: - description: >- - __Filterable__ First line of this child account's billing - address. + description: __Filterable__ First line of this child account's + billing address. example: 123 Main Street maxLength: 64 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-filterable: true address_2: - description: >- - __Filterable__ Second line of this child account's billing - address, if applicable. + description: __Filterable__ Second line of this child account's + billing address, if applicable. example: Suite A maxLength: 64 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-filterable: true balance: - description: __Read-only__ This child account's balance, in US dollars. + 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. + 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. + description: __Read-only__ The source of service charges for this + account, as determined by its relationship with Akamai. The + API returns a value of `external` to describe a child account + in a parent-child account environment. enum: - - external + - external example: external readOnly: true type: string capabilities: - description: >- - __Read-only__ A list of the capabilities the child account - supports. + description: __Read-only__ A list of the capabilities the child + account supports. example: - - Linodes - - NodeBalancers - - Block Storage - - Object Storage + - Linodes + - NodeBalancers + - Block Storage + - Object Storage items: type: string readOnly: true type: array city: - description: >- - __Filterable__ The city for this child account's billing - address. + description: __Filterable__ The city for this child account's + billing address. example: San Diego maxLength: 24 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-filterable: true company: - description: >- - __Filterable__ The company name for the owner of this - child account. It can't include any of these characters: - `<` `>` `(` `)` `"` `=`. You can't change this value - yourself. We use it to create the proxy users that a - parent account uses to access a child account. Talk to - your account team if you need to change this value. + description: '__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 + - Filterable x-linode-filterable: true country: - description: >- - __Filterable__ The two-letter ISO 3166 country code for - this child account's billing address. + description: __Filterable__ The two-letter ISO 3166 country code + for this child account's billing address. example: US type: string x-akamai: labels: - - Filterable + - Filterable x-linode-filterable: true credit_card: additionalProperties: false - description: >- - __Read-only__ Information for the credit card you've + description: __Read-only__ Information for the credit card you've assigned to this child account. properties: expiry: @@ -2983,114 +2670,105 @@ paths: readOnly: true type: object email: - description: >- - __Filterable__ The email address of the owner of this - child account. + description: __Filterable__ The email address of the owner of + this child account. example: john.smith@linode.com maxLength: 128 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-cli-display: 3 x-linode-filterable: true euuid: - description: >- - __Read-only__ An external, unique identifier that Akamai - assigned to the child account. + description: __Read-only__ An external, unique identifier that + Akamai assigned to the child account. example: A1BC2DEF-34GH-567I-J890KLMN12O34P56 format: uuid readOnly: true type: string first_name: - description: >- - __Filterable__ The first name of the owner of this child - account. It can't include any of these characters: `<` `>` - `(` `)` `"` `=`. + description: '__Filterable__ The first name of the owner of this + child account. It can''t include any of these characters: `<` + `>` `(` `)` `"` `=`.' example: John maxLength: 50 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-cli-display: 1 x-linode-filterable: true last_name: - description: >- - __Filterable__ The last name of the owner of this child - account. It can't include any of these characters: `<` `>` - `(` `)` `"` `=`. + description: '__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 + - Filterable x-linode-cli-display: 2 x-linode-filterable: true phone: - description: >- - __Filterable__ The phone number for the owner of this - child account. + description: __Filterable__ The phone number for the owner of + this child account. example: 858-555-1212 maxLength: 32 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-filterable: true state: - description: >- - __Filterable__ The state or province for the billing - address (`address_1` and `address_2, if applicable`). If - in the United States (US) or Canada (CA), this is the - two-letter ISO 3166 State or Province code. + description: '__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. > 📘 > - > If this is a US military address, use state - abbreviations (AA, AE, AP). + > If this is a US military address, use state abbreviations + (AA, AE, AP).' example: CA maxLength: 24 type: string x-akamai: labels: - - Filterable + - 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 (`""`). + description: The tax identification number for this child account. + Use this for tax calculations in some countries. If you live + in a country that doesn't collect taxes, ensure this is an empty + string (`""`). example: ATU99999999 maxLength: 25 type: string zip: - description: >- - __Filterable__ The zip code of this Account's billing + description: '__Filterable__ The zip code of this Account''s billing address. The following restrictions apply: - - Can only contain ASCII letters, numbers, and hyphens - (`-`). + - Can only contain ASCII letters, numbers, and hyphens (`-`). - - Can't contain more than 9 letter or number characters. + - Can''t contain more than 9 letter or number characters.' example: 92111-1234 type: string x-akamai: labels: - - Filterable + - Filterable x-linode-filterable: true type: object x-akamai: file-path: schemas/child-account.yaml x-example: x-ref: ../examples/get-child-account-200.json - description: Returns the child-level account for a specified `euuid`. + description: Returns the specified child-level account. default: content: application/json: @@ -3100,28 +2778,24 @@ paths: errors: items: additionalProperties: false - description: >- - An object for describing a single error that occurred + description: An object for describing a single error that occurred during the processing of a request. properties: field: - description: >- - The field in the request that caused this error. - This may be a path, separated by periods in the case - of nested fields. In some cases this may come back - as `null` if the error is not specific to any single - element of the request. + description: The field in the request that caused this error. + This may be a path, separated by periods in the case of + nested fields. In some cases this may come back as `null` + if the error is not specific to any single element of + the request. example: fieldname type: string reason: - description: >- - What happened to cause this error. In most cases, - this can be fixed immediately by changing the data - you sent in the request, but in some cases you will - be instructed to [Open a support - ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) - or perform some other action before you can complete - the request successfully. + description: What happened to cause this error. In most + cases, this can be fixed immediately by changing the data + you sent in the request, but in some cases you will be + instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete the + request successfully. example: fieldname must be a valid value type: string type: object @@ -3129,37 +2803,32 @@ paths: file-path: schemas/error-object.yaml type: array type: object - description: >- - See - [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - - personalAccessToken: [] - - oauth: - - child_account:read_only + - personalAccessToken: [] + - oauth: + - child_account:read_only summary: Get a child account tags: - - Child accounts + - Child accounts x-akamai: tabs: - - syntax: linode-cli child-account view A1BC2DEF-34GH-567I-J890KLMN12O34P56 - title: CLI - url: >- - https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - - syntax: child_account:read_only - title: OAuth scopes - url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + - syntax: linode-cli child-account view A1BC2DEF-34GH-567I-J890KLMN12O34P56 + title: CLI + url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: child_account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: - - view + - view x-linode-grant: child_account_access - parameters: - - 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`. - example: '{{euuid}}' + parameters: + - 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` as your `euuId`. + example: '{{euuId}}' in: path - name: euuid + name: euuId required: true schema: type: string @@ -3167,78 +2836,37 @@ paths: file-path: parameters/eeuid.yaml x-akamai: file-path: paths/child-account.yaml - path-info: /{apiVersion}/account/child-accounts/{euuid} + path-info: /{apiVersion}/account/child-accounts/{euuId} x-linode-cli-command: child-account - /account/child-accounts/{euuid}/token: + /account/child-accounts/{euuId}/token: post: - description: >- - Create a short-lived bearer token for a parent user on a child account, - using the `euuid` of that child account. In the context of the API, a - parent user on a child account is referred to as a "proxy user." When - Akamai provisions your parent-child account environment, a proxy user is - automatically set in the child account. It follows a specific naming - convention: - - _ - - > 📘 - - > - - > These variables only use the first 15 and 16 characters of these - values, respectively. - - - The token lets a parent account run API operations through the proxy - user, as if they are a child user in the child account. - - - These points apply to the use of this operation: - - - - To create a token, a parent account user needs the - `child_account_access` grant. This lets them use the proxy user on the - child account. You can run [List a user's - grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) - on a parent account user to check its `child_account_access` setting. To - add this access, you can - [update](https://techdocs.akamai.com/linode-api/reference/put-user-grants) - the parent account user. - - - - The created token inherits the permissions of the proxy user. It will - never have less. - - - - The API returns the raw token in the response. You can't get it again, - so be sure to store it. - - - Example workflow: - - - 1. [List child - accounts](https://techdocs.akamai.com/linode-api/reference/get-child-accounts) - and store the `euuid` for the applicable one. - - 2. Run this operation and store the `token` that's created for the proxy - user. - - 3. As a parent account user with access to the proxy user in the child - account, use this `token` to authenticate API operations, as if you were - a child user. - - - [Learn - more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - - - [Learn - more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + description: "Create a short-lived bearer token for a parent user on a specific\ + \ child account. In the context of the API, a parent user on a child account\ + \ is referred to as a \"proxy user.\" When Akamai provisions your parent-child\ + \ account environment, a proxy user is automatically set in the child account.\ + \ It follows a specific naming convention:\n\n _\n\ + \n> \U0001F4D8\n>\n> These variables only use the first 15 and 16 characters\ + \ of these values, respectively.\n\nThe token lets a parent account run API\ + \ operations through the proxy user, as if they are a child user in the child\ + \ account.\n\nThese points apply to the use of this operation:\n\n- To create\ + \ a token, a parent account user needs the `child_account_access` grant. This\ + \ lets them use the proxy user on the child account. You can run [List a user's\ + \ grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants)\ + \ on a parent account user to check its `child_account_access` setting. To\ + \ add this access, you can [update](https://techdocs.akamai.com/linode-api/reference/put-user-grants)\ + \ the parent account user.\n\n- The created token inherits the permissions\ + \ of the proxy user. It will never have less.\n\n- The API returns the raw\ + \ token in the response. You can't get it again, so be sure to store it.\n\ + \nExample workflow:\n\n1. [List child accounts](https://techdocs.akamai.com/linode-api/reference/get-child-accounts)\ + \ and store the `euuid` for the applicable one.\n2. Run this operation and\ + \ store the `token` that's created for the proxy user.\n3. As a parent account\ + \ user with access to the proxy user in the child account, use this `token`\ + \ to authenticate API operations, as if you were a child user.\n\n[Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\ + \n[Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)" externalDocs: description: See documentation for this operation in Akamai's Linode API - url: >- - https://techdocs.akamai.com/linode-api/reference/post-child-account-token + url: https://techdocs.akamai.com/linode-api/reference/post-child-account-token operationId: post-child-account-token responses: '200': @@ -3246,79 +2874,70 @@ paths: application/json: schema: additionalProperties: false - description: >- - The token generated manually for a child account so its proxy - user can access the API and CLI without going through an OAuth + description: The token generated manually for a child account so its + proxy user can access the API and CLI without going through an OAuth login. properties: created: - description: >- - __Filterable__, __Read-only__ The date and time this token - was created. + description: __Filterable__, __Read-only__ The date and time this + token was created. example: '2024-05-01T00:01:01' format: date-time readOnly: true type: string x-akamai: labels: - - Filterable + - Filterable x-linode-cli-display: 4 x-linode-filterable: true expiry: - description: >- - __Read-only__ When this token expires. This is default set - to 15 minutes from the time of creation. Proxy user tokens - can't be renewed. After this time, Akamai revokes the - token and you need to generate a new one. + description: __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. + 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 `__