diff --git a/openapi.yaml b/openapi.yaml index 0609934d8..327b2b444 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -6,11 +6,12 @@ components: name: apiVersion required: true schema: - default: v4 enum: - v4 - v4beta type: string + x-akamai: + file-path: parameters/api-version-path.yaml beta-id: description: The ID of the Beta Program. in: path @@ -18,6 +19,8 @@ components: required: true schema: type: string + x-akamai: + file-path: parameters/beta-id.yaml client-id-path: description: The OAuth Client ID to look up. in: path @@ -25,6 +28,8 @@ components: required: true schema: type: string + x-akamai: + file-path: parameters/client-id-path.yaml client-id-path-ecf807fb: description: The OAuth Client ID to look up. in: path @@ -32,6 +37,8 @@ components: required: true schema: type: string + x-akamai: + file-path: parameters/client-id-path-ecf807fb.yaml eeuid: description: The child account to look up. You can run the [List child accounts](https://techdocs.akamai.com/linode-api/reference/get-child-accounts) operation to find the applicable account and store its `euuid`. in: path @@ -39,27 +46,38 @@ components: required: true schema: type: string + x-akamai: + file-path: parameters/eeuid.yaml event-id-path-214cd042: description: The ID of the Event to designate as seen. in: path name: eventId required: true schema: + example: 824 type: integer + x-akamai: + file-path: parameters/event-id-path-214cd042.yaml event-id-path-39255fcf: description: The ID of the Event. in: path name: eventId required: true schema: + example: 824 type: integer + x-akamai: + file-path: parameters/event-id-path-39255fcf.yaml event-id-path-625aa248: description: The ID of the Event to designate as read. in: path name: eventId required: true schema: + example: 824 type: integer + x-akamai: + file-path: parameters/event-id-path-625aa248.yaml id-path: description: The slug for the applicable data center. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the slug for each data center. in: path @@ -67,20 +85,28 @@ components: required: true schema: type: string + x-akamai: + file-path: parameters/id-path.yaml invoice-id-path: description: The ID of the Invoice. in: path name: invoiceId required: true schema: + example: 387 type: integer + x-akamai: + file-path: parameters/invoice-id-path.yaml login-id-path: description: The ID of the login object to access. in: path name: loginId required: true schema: + example: 863 type: integer + x-akamai: + file-path: parameters/login-id-path.yaml page-offset: description: The page of a collection to return. in: query @@ -88,38 +114,53 @@ components: required: false schema: default: 1 + example: 6 minimum: 1 type: integer + x-akamai: + file-path: parameters/page-offset.yaml page-size: description: The number of items to return per page. in: query name: page_size schema: default: 100 + example: 50 maximum: 500 minimum: 25 type: integer + x-akamai: + file-path: parameters/page-size.yaml payment-id-path: description: The ID of the Payment to look up. in: path name: paymentId required: true schema: + example: 627 type: integer + x-akamai: + file-path: parameters/payment-id-path.yaml payment-method-id-path-6078bc7b: description: The ID of the Payment Method to look up. in: path name: paymentMethodId required: true schema: + example: 267 type: integer + x-akamai: + file-path: parameters/payment-method-id-path-6078bc7b.yaml payment-method-id-path-fb39a844: description: The ID of the Payment Method to make default. in: path name: paymentMethodId required: true schema: + example: 267 type: integer + x-akamai: + file-path: parameters/payment-method-id-path-fb39a844.yaml token-path-f857f5a2: description: The UUID of the Service Transfer. in: path @@ -128,6 +169,8 @@ components: schema: format: uuid type: string + x-akamai: + file-path: parameters/token-path-f857f5a2.yaml token-path-faf66b58: description: The UUID of the Entity Transfer. in: path @@ -136,6 +179,8 @@ components: schema: format: uuid type: string + x-akamai: + file-path: parameters/token-path-faf66b58.yaml username-path: description: The username to look up. in: path @@ -143,6 +188,8 @@ components: required: true schema: type: string + x-akamai: + file-path: parameters/username-path.yaml responses: '409': content: @@ -161,9 +208,13 @@ components: type: object type: array type: object + x-akamai: + file-path: schemas/added-post-cancel-account-409.yaml x-example: x-ref: ../examples/tbd.json description: Could not charge the credit card on file. + x-akamai: + file-path: errors/409.yaml accepted-response: content: application/json: @@ -184,6 +235,8 @@ components: example: Unable to reboot Linode. type: string type: object + x-akamai: + file-path: schemas/warning-object.yaml type: array type: object description: |- @@ -210,6 +263,8 @@ components: example: Unable to reboot Linode. type: string type: object + x-akamai: + file-path: schemas/warning-object.yaml type: array type: object description: |- @@ -236,6 +291,8 @@ components: example: fieldname must be a valid value type: string type: object + x-akamai: + file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. @@ -248,7 +305,7 @@ components: items: additionalProperties: false description: |- - Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set. + __Read-only__ Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set. Simply put, a promotion offers a certain amount of credit month, until either the expiration date is passed, or until the total promotional credit is used, whichever comes first. properties: @@ -307,10 +364,12 @@ components: x-linode-cli-display: 4 readOnly: true type: object + x-akamai: + file-path: schemas/promotion.yaml readOnly: true type: array active_since: - description: The date and time the account was activated. + description: __Read-only__ The date and time the account was activated. example: '2018-01-01T00:01:01' format: date-time readOnly: true @@ -326,19 +385,19 @@ components: maxLength: 64 type: string balance: - description: This Account's balance, in US dollars. + description: __Read-only__ This Account's balance, in US dollars. example: 200 readOnly: true type: number x-linode-cli-display: 4 balance_uninvoiced: - description: This Account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate. + 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: The source of service charges for this Account, as determined by its relationship with Akamai. Accounts that are associated with Akamai-specific customers return a value of `akamai`. All other Accounts return a value of `linode`. + description: __Read-only__ The source of service charges for this Account, as determined by its relationship with Akamai. Accounts that are associated with Akamai-specific customers return a value of `akamai`. All other Accounts return a value of `linode`. enum: - akamai - linode @@ -346,7 +405,7 @@ components: readOnly: true type: string capabilities: - description: A list of capabilities your account supports. + description: __Read-only__ A list of capabilities your account supports. example: - Linodes - NodeBalancers @@ -377,7 +436,7 @@ components: type: string credit_card: additionalProperties: false - description: Credit Card information associated with this Account. + description: __Read-only__ Credit Card information associated with this Account. properties: expiry: description: The expiration month and year of the credit card. @@ -396,7 +455,7 @@ components: type: string x-linode-cli-display: 3 euuid: - description: An external unique identifier for this account. + description: __Read-only__ An external unique identifier for this account. example: E1AF5EEC-526F-487D-B317EBEB34C87D71 format: uuid readOnly: true @@ -443,12 +502,14 @@ components: example: 19102-1234 type: string type: object + x-akamai: + file-path: schemas/account.yaml account-availability: additionalProperties: false description: Account Service Availability object. properties: available: - description: A list of services _available_ to your account in the `region`. + description: __Read-only__ A list of services _available_ to your account in the `region`. example: - Linodes - NodeBalancers @@ -457,13 +518,13 @@ components: readOnly: true type: array region: - description: The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation. + 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: 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 @@ -473,6 +534,8 @@ components: type: array x-linode-cli-display: 3 type: object + x-akamai: + file-path: schemas/account-availability.yaml account-settings: additionalProperties: false description: Account Settings object. @@ -483,13 +546,13 @@ components: type: boolean x-linode-cli-display: 4 longview_subscription: - description: The Longview Pro tier you are currently subscribed to. The value must be a [Longview subscription](https://techdocs.akamai.com/linode-api/reference/get-longview-subscriptions) ID or `null` for Longview Free. + description: __Read-only__ The Longview Pro tier you are currently subscribed to. The value must be a [Longview subscription](https://techdocs.akamai.com/linode-api/reference/get-longview-subscriptions) ID or `null` for Longview Free. example: longview-3 readOnly: true type: string x-linode-cli-display: 2 managed: - description: Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we'll monitor it for connectivity, response, and total request time. + description: __Read-only__ Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we'll monitor it for connectivity, response, and total request time. example: true readOnly: true type: boolean @@ -501,7 +564,7 @@ components: x-linode-cli-display: 1 object_storage: default: disabled - description: A string describing the status of this account's Object Storage service enrollment. + description: __Read-only__ A string describing the status of this account's Object Storage service enrollment. enum: - disabled - suspended @@ -511,11 +574,14 @@ components: type: string x-linode-cli-display: 5 type: object + x-akamai: + file-path: schemas/account-settings.yaml added-empty-obj: - additionalProperties: false description: The API responds with an empty object. maxProperties: 0 type: object + x-akamai: + file-path: schemas/added-empty-obj.yaml added-get-account-logins-200: additionalProperties: false properties: @@ -525,33 +591,33 @@ components: description: An object representing a previous successful login for a User. properties: datetime: - description: When the login was initiated. + description: __Read-only__ When the login was initiated. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 id: - description: The unique ID of this login object. + description: __Read-only__ The unique ID of this login object. example: 1234 readOnly: true type: integer x-linode-cli-display: 1 ip: - description: The remote IP address that requested the login. + description: __Read-only__ The remote IP address that requested the login. example: 192.0.2.0 format: ip readOnly: true type: string x-linode-cli-display: 3 restricted: - description: True if the User that attempted the login was a restricted User, false otherwise. + description: __Read-only__ True if the User that attempted the login was a restricted User, false otherwise. example: true readOnly: true type: boolean x-linode-cli-display: 6 status: - description: Whether the login attempt succeeded or failed. + description: __Read-only__ Whether the login attempt succeeded or failed. enum: - successful - failed @@ -560,29 +626,33 @@ components: type: string x-linode-cli-display: 5 username: - description: The username of the User that attempted the login. + description: __Read-only__ The username of the User that attempted the login. example: example_user readOnly: true type: string x-linode-cli-display: 4 type: object + x-akamai: + file-path: schemas/login.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-account-logins-200.yaml added-get-availability-200: allOf: - additionalProperties: false @@ -593,7 +663,7 @@ components: description: Account Service Availability object. properties: available: - description: A list of services _available_ to your account in the `region`. + description: __Read-only__ A list of services _available_ to your account in the `region`. example: - Linodes - NodeBalancers @@ -602,13 +672,13 @@ components: readOnly: true type: array region: - description: The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation. + 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: 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 @@ -618,27 +688,33 @@ components: 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: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/pagination-envelope.yaml + x-akamai: + file-path: schemas/added-get-availability-200.yaml added-get-child-accounts-200: additionalProperties: false properties: @@ -648,13 +724,13 @@ components: description: Child account object. properties: active_since: - description: 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: 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 @@ -663,7 +739,7 @@ components: - Filterable x-linode-filterable: true address_2: - description: 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 @@ -672,26 +748,26 @@ components: - Filterable x-linode-filterable: true balance: - description: 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: 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: 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 example: external readOnly: true type: string capabilities: - description: A list of the capabilities the child account supports. + description: __Read-only__ A list of the capabilities the child account supports. example: - Linodes - NodeBalancers @@ -702,7 +778,7 @@ components: readOnly: true type: array city: - description: 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 @@ -711,7 +787,7 @@ components: - Filterable x-linode-filterable: true company: - description: 'The company name for the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`. You can''t change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.' + 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 @@ -720,7 +796,7 @@ components: - Filterable x-linode-filterable: true country: - description: 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: @@ -729,7 +805,7 @@ components: x-linode-filterable: true credit_card: additionalProperties: false - description: 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 card. @@ -742,7 +818,7 @@ components: readOnly: true type: object email: - description: 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 @@ -752,13 +828,13 @@ components: x-linode-cli-display: 3 x-linode-filterable: true euuid: - description: 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: '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 @@ -768,7 +844,7 @@ components: x-linode-cli-display: 1 x-linode-filterable: true last_name: - description: '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 @@ -778,7 +854,7 @@ components: x-linode-cli-display: 2 x-linode-filterable: true phone: - description: 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 @@ -788,7 +864,7 @@ components: x-linode-filterable: true state: description: |- - The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code. + __Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code. __Note__. If this is a US military address, use state abbreviations (AA, AE, AP). example: CA @@ -805,7 +881,7 @@ components: type: string zip: description: |- - The zip code of this Account's billing address. The following restrictions apply: + __Filterable__ The zip code of this Account's billing address. The following restrictions apply: - Can only contain ASCII letters, numbers, and hyphens (`-`). - Can't contain more than 9 letter or number characters. @@ -816,23 +892,27 @@ components: - Filterable x-linode-filterable: true type: object + x-akamai: + file-path: schemas/child-account.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-child-accounts-200.yaml added-get-clients-200: additionalProperties: false properties: @@ -842,13 +922,13 @@ components: description: A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](https://login.linode.com). Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application. properties: id: - description: The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret). + description: __Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret). example: 2737bf16b39ab5d7b4a1 readOnly: true type: string x-linode-cli-display: 1 label: - description: The name of this application. This will be presented to users when they are asked to grant it access to their Account. + description: __Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account. example: Test_Client_1 maxLength: 512 minLength: 1 @@ -860,7 +940,7 @@ components: x-linode-filterable: true public: default: false - description: If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. + description: __Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. example: false type: boolean x-akamai: @@ -875,12 +955,12 @@ components: type: string x-linode-cli-display: 5 secret: - description: The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. + description: __Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. example: readOnly: true type: string status: - description: The status of this application. `active` by default. + description: __Read-only__ The status of this application. `active` by default. enum: - active - disabled @@ -893,51 +973,57 @@ components: suspended: red x-linode-cli-display: 3 thumbnail_url: - description: The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set. + description: __Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set. example: https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail format: url nullable: true readOnly: true type: string type: object + x-akamai: + file-path: schemas/oauth-client.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-clients-200.yaml added-get-enrolled-beta-programs-200: allOf: - additionalProperties: false description: An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. properties: page: - description: 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: 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 results: - description: The total number of 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: @@ -945,7 +1031,7 @@ components: description: An object representing an enrolled Beta Program for the Account. properties: description: - description: Additional details regarding the Beta Program. + description: __Read-only__ Additional details regarding the Beta Program. example: This is an open public beta for an example feature. nullable: true readOnly: true @@ -953,7 +1039,7 @@ components: x-linode-cli-display: 3 ended: description: |- - The date-time that the Beta Program ended. + __Filterable__, __Read-only__ The date-time that the Beta Program ended. `null` indicates that the Beta Program is ongoing. example: null @@ -967,7 +1053,7 @@ components: x-linode-cli-display: 5 x-linode-filterable: true enrolled: - description: The date-time of Account enrollment to the Beta Program. + 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 @@ -983,7 +1069,7 @@ components: type: string x-linode-cli-display: 1 label: - description: The name of the Beta Program. + description: __Filterable__, __Read-only__ The name of the Beta Program. example: Example Open Beta readOnly: true type: string @@ -993,7 +1079,7 @@ components: x-linode-cli-display: 2 x-linode-filterable: true started: - description: 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 @@ -1004,29 +1090,35 @@ components: x-linode-cli-display: 4 x-linode-filterable: true type: object + x-akamai: + file-path: schemas/beta-program-enrolled.yaml type: array type: object + x-akamai: + file-path: schemas/added-get-enrolled-beta-programs-200.yaml added-get-entity-transfers-200: allOf: - additionalProperties: false description: An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. properties: page: - description: 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: 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 results: - description: The total number of 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: @@ -1059,7 +1151,7 @@ components: type: string x-linode-cli-display: 3 is_sender: - description: If the requesting account created this transfer. + description: __Filterable__ If the requesting account created this transfer. example: true type: boolean x-akamai: @@ -1069,7 +1161,7 @@ components: x-linode-filterable: true status: description: |- - The status of the transfer request: + __Filterable__ The status of the transfer request: `accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete. `canceled`: The transfer has been canceled by the sender. @@ -1111,7 +1203,11 @@ components: format: date-time type: string type: object + x-akamai: + file-path: schemas/entity-transfer.yaml type: array + x-akamai: + file-path: schemas/added-get-entity-transfers-200.yaml added-get-events-200: additionalProperties: false properties: @@ -1121,7 +1217,7 @@ components: description: A collection of Event objects. An Event is an action taken against an entity related to your Account. For example, booting a Linode would create an Event. The Events returned depends on your grants. properties: action: - description: The action that caused this Event. New actions may be added in the future. + description: __Filterable__, __Read-only__ The action that caused this Event. New actions may be added in the future. enum: - account_update - account_settings_update @@ -1277,7 +1373,7 @@ components: x-linode-cli-display: 3 x-linode-filterable: true created: - description: When this Event was created. + description: __Filterable__, __Read-only__ When this Event was created. example: '2018-01-01T00:01:01' format: date-time readOnly: true @@ -1288,18 +1384,18 @@ components: x-linode-cli-display: 6 x-linode-filterable: true duration: - description: The total duration in seconds that it takes for the Event to complete. + description: __Read-only__ The total duration in seconds that it takes for the Event to complete. example: 300.56 readOnly: true type: number x-linode-cli-display: 7 entity: additionalProperties: false - description: Detailed information about the Event's entity, including ID, type, label, and URL used to access it. + description: __Read-only__ Detailed information about the Event's entity, including ID, type, label, and URL used to access it. properties: id: description: |- - The unique ID for an Event's entity. + __Filterable__ The unique ID for an Event's entity. Some Event entities do not have IDs associated with them, so they will not be returned when filtering by ID. These Events include: @@ -1324,7 +1420,7 @@ components: type: string x-linode-cli-display: 5 type: - description: The type of entity that is being referenced by the Event. + description: __Filterable__, __Read-only__ The type of entity that is being referenced by the Event. enum: - account - backups @@ -1363,7 +1459,7 @@ components: readOnly: true type: object id: - description: The unique ID of this Event. + description: __Filterable__, __Read-only__ The unique ID of this Event. example: 123 readOnly: true type: integer @@ -1379,17 +1475,19 @@ components: type: string x-linode-cli-display: 9 percent_complete: - description: A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events. + description: __Read-only__ A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events. example: null + nullable: true readOnly: true type: integer rate: - description: The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events. + description: __Read-only__ The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events. example: null + nullable: true readOnly: true type: string read: - description: If this Event has been read. + description: __Filterable__, __Read-only__ If this Event has been read. example: true readOnly: true type: boolean @@ -1399,7 +1497,7 @@ components: x-linode-filterable: true secondary_entity: additionalProperties: false - description: Detailed information about the Event's secondary entity, which provides additional information for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions. + description: __Read-only__ Detailed information about the Event's secondary entity, which provides additional information for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions. properties: id: description: The ID of the object that is the secondary entity. @@ -1410,7 +1508,7 @@ components: example: linode1234 type: string type: - description: The type of entity that is being referenced by the Event. + description: __Read-only__ The type of entity that is being referenced by the Event. example: linode readOnly: true type: string @@ -1421,12 +1519,12 @@ components: readOnly: true type: object seen: - description: If this Event has been seen. + description: __Read-only__ If this Event has been seen. example: true readOnly: true type: boolean status: - description: The current status of this Event. + description: __Read-only__ The current status of this Event. enum: - failed - finished @@ -1442,36 +1540,40 @@ components: started: yellow x-linode-cli-display: 8 time_remaining: - description: The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done. + description: __Read-only__ The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done. example: null nullable: true readOnly: true type: string username: - description: The username of the User who caused the Event. + description: __Read-only__ The username of the User who caused the Event. example: exampleUser nullable: true readOnly: true type: string x-linode-cli-display: 2 type: object + x-akamai: + file-path: schemas/event.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-events-200.yaml added-get-invoice-items-200: additionalProperties: false properties: @@ -1481,32 +1583,32 @@ components: description: An InvoiceItem object. properties: amount: - description: The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity. + description: __Read-only__ The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity. example: 20.2 readOnly: true type: number x-linode-cli-display: 4 from: - description: The date the Invoice Item started, based on month. + description: __Read-only__ The date the Invoice Item started, based on month. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 label: - description: The Invoice Item's display label. + description: __Read-only__ The Invoice Item's display label. example: Linode 123 readOnly: true type: string x-linode-cli-display: 1 quantity: - description: The quantity of this Item for the specified Invoice. + description: __Read-only__ The quantity of this Item for the specified Invoice. example: 4 readOnly: true type: integer region: description: |- - The ID of the applicable Region associated with this Invoice Item. + __Read-only__ The ID of the applicable Region associated with this Invoice Item. `null` if there is no applicable Region. example: us-west @@ -1515,26 +1617,26 @@ components: type: string x-linode-cli-display: 7 tax: - description: The amount of tax levied on this Item in US Dollars. + description: __Read-only__ The amount of tax levied on this Item in US Dollars. example: 1.25 readOnly: true type: number x-linode-cli-display: 5 to: - description: The date the Invoice Item ended, based on month. + description: __Read-only__ The date the Invoice Item ended, based on month. example: '2018-01-31T11:59:59' format: date-time readOnly: true type: string x-linode-cli-display: 3 total: - description: The price of this Item after taxes in US Dollars. + description: __Read-only__ The price of this Item after taxes in US Dollars. example: 21.45 readOnly: true type: number x-linode-cli-display: 6 type: - description: The type of service, ether `hourly` or `misc`. + description: __Read-only__ The type of service, ether `hourly` or `misc`. enum: - hourly - misc @@ -1542,28 +1644,32 @@ components: readOnly: true type: string unit_price: - description: The monthly service fee in US Dollars for this Item. + description: __Read-only__ The monthly service fee in US Dollars for this Item. example: 5.05 readOnly: true type: string type: object + x-akamai: + file-path: schemas/invoice-item.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-invoice-items-200.yaml added-get-invoices-200: additionalProperties: false properties: @@ -1574,7 +1680,7 @@ components: properties: billing_source: description: |- - `akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai. + __Filterable__, __Read-only__ `akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai. `linode`: This Invoice was generated according to the default terms, prices, and discounts. enum: @@ -1589,7 +1695,7 @@ components: x-linode-cli-display: 3.5 x-linode-filterable: true date: - description: When this Invoice was generated. + description: __Filterable__, __Read-only__ When this Invoice was generated. example: '2018-01-01T00:01:01' format: date-time readOnly: true @@ -1600,13 +1706,13 @@ components: x-linode-cli-display: 2 x-linode-filterable: true id: - description: The Invoice's unique ID. + description: __Read-only__ The Invoice's unique ID. example: 123 readOnly: true type: integer x-linode-cli-display: 1 label: - description: The Invoice's display label. + description: __Filterable__, __Read-only__ The Invoice's display label. example: Invoice readOnly: true type: string @@ -1616,19 +1722,19 @@ components: x-linode-cli-display: 3 x-linode-filterable: true subtotal: - description: The amount of the Invoice before taxes in US Dollars. + description: __Read-only__ The amount of the Invoice before taxes in US Dollars. example: 120.25 readOnly: true type: number x-linode-cli-display: 4 tax: - description: The amount of tax levied on the Invoice in US Dollars. + description: __Read-only__ The amount of tax levied on the Invoice in US Dollars. example: 12.25 readOnly: true type: number x-linode-cli-display: 5 tax_summary: - description: The amount of tax broken down into subtotals by source. + description: __Read-only__ The amount of tax broken down into subtotals by source. items: additionalProperties: false properties: @@ -1644,7 +1750,7 @@ components: readOnly: true type: array total: - description: The amount of the Invoice after taxes in US Dollars. + description: __Filterable__, __Read-only__ The amount of the Invoice after taxes in US Dollars. example: 132.5 readOnly: true type: number @@ -1654,23 +1760,27 @@ components: x-linode-cli-display: 6 x-linode-filterable: true type: object + x-akamai: + file-path: schemas/invoice.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-invoices-200.yaml added-get-maintenance-200: additionalProperties: false properties: @@ -1706,7 +1816,7 @@ components: type: string status: description: |- - The maintenance status. + __Filterable__ The maintenance status. Maintenance progresses in the following sequence: pending, started, then completed. enum: @@ -1720,7 +1830,7 @@ components: - Filterable x-linode-filterable: true type: - description: The type of maintenance. + description: __Filterable__ The type of maintenance. enum: - reboot - cold_migration @@ -1733,7 +1843,7 @@ components: x-linode-filterable: true when: description: |- - When the maintenance will begin. + __Filterable__ When the maintenance will begin. [Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters: @@ -1748,23 +1858,27 @@ components: - Filterable x-linode-filterable: true type: object + x-akamai: + file-path: schemas/maintenance.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-maintenance-200.yaml added-get-notifications-200: additionalProperties: false properties: @@ -1774,14 +1888,14 @@ components: description: An important, often time-sensitive item related to your account. properties: body: - description: A full description of this notification, in markdown format. Not all notifications include a `body`. + description: __Read-only__ A full description of this notification, in markdown format. Not all notifications include a `body`. example: null nullable: true readOnly: true type: string entity: additionalProperties: false - description: Detailed information about the notification. + description: __Read-only__ Detailed information about the notification. properties: id: description: The unique ID of the notification's entity, based on the entity type. Returns `null` for an `account` or `promotion` entity. @@ -1822,19 +1936,19 @@ components: readOnly: true type: object label: - description: A short description of this notification. + description: __Read-only__ A short description of this notification. example: You have an important ticket open! readOnly: true type: string x-linode-cli-display: 1 message: - description: A human-readable description of the notification. + description: __Read-only__ A human-readable description of the notification. example: You have an important ticket open! readOnly: true type: string x-linode-cli-display: 2 severity: - description: The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. + description: __Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. enum: - minor - major @@ -1848,7 +1962,7 @@ components: minor: blue x-linode-cli-display: 3 type: - description: The type of notification. + description: __Read-only__ The type of notification. enum: - migration_scheduled - migration_imminent @@ -1865,9 +1979,10 @@ components: readOnly: true type: string until: - description: If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window. + description: __Read-only__ If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window. example: null format: date-time + nullable: true readOnly: true type: string x-linode-cli-color: @@ -1875,9 +1990,10 @@ components: default_: white x-linode-cli-display: 5 when: - description: If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration. + description: __Read-only__ If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration. example: null format: date-time + nullable: true readOnly: true type: string x-linode-cli-color: @@ -1885,23 +2001,27 @@ components: default_: white x-linode-cli-display: 4 type: object + x-akamai: + file-path: schemas/notification.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-notifications-200.yaml added-get-payment-methods-200: additionalProperties: false properties: @@ -1911,74 +2031,78 @@ components: description: Payment Method Response Object. properties: created: - description: When the Payment Method was added to the Account. + description: __Read-only__ When the Payment Method was added to the Account. example: '2018-01-15T00:01:01' format: date-time readOnly: true type: string data: - discriminator: - propertyName: type oneOf: - additionalProperties: false description: Credit card information. properties: card_type: - description: The type of credit card. + description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: - description: The expiration month and year of the credit card. + description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: - description: The last four digits of the credit card number. + description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Credit card type: object + x-akamai: + file-path: schemas/credit-card-data.yaml x-linode-ref-name: Credit Card - additionalProperties: false description: Google Pay information. properties: card_type: - description: The type of credit card. + description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: - description: The expiration month and year of the credit card. + description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: - description: The last four digits of the credit card number. + description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Google Pay type: object + x-akamai: + file-path: schemas/google-pay-data.yaml x-linode-ref-name: Google Pay - additionalProperties: false description: PayPal information. properties: email: - description: The email address associated with your PayPal account. + description: __Read-only__ The email address associated with your PayPal account. example: example@linode.com readOnly: true type: string paypal_id: - description: PayPal Merchant ID associated with your PayPal account. + description: __Read-only__ PayPal Merchant ID associated with your PayPal account. example: ABC1234567890 readOnly: true type: string title: Paypal type: object + x-akamai: + file-path: schemas/paypal-data.yaml x-linode-ref-name: Paypal x-linode-cli-display: 4 x-linode-cli-format: json @@ -2002,23 +2126,27 @@ components: type: string x-linode-cli-display: 2 type: object + x-akamai: + file-path: schemas/payment-method.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-payment-methods-200.yaml added-get-payments-200: additionalProperties: false properties: @@ -2028,42 +2156,46 @@ components: description: Payment object response. properties: date: - description: When the Payment was made. + description: __Read-only__ When the Payment was made. example: '2018-01-15T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 id: - description: The unique ID of the Payment. + description: __Read-only__ The unique ID of the Payment. example: 123 readOnly: true type: integer x-linode-cli-display: 1 usd: - description: The amount, in US dollars, of the Payment. + description: __Read-only__ The amount, in US dollars, of the Payment. example: '120.50' readOnly: true type: integer x-linode-cli-display: 3 type: object + x-akamai: + file-path: schemas/payment.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-payments-200.yaml added-get-service-transfers-200: additionalProperties: false properties: @@ -2098,7 +2230,7 @@ components: type: string x-linode-cli-display: 3 is_sender: - description: If the requesting account created this transfer. + description: __Filterable__ If the requesting account created this transfer. example: true type: boolean x-akamai: @@ -2108,7 +2240,7 @@ components: x-linode-filterable: true status: description: |- - The status of the transfer request. + __Filterable__ The status of the transfer request. `accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete. @@ -2157,23 +2289,27 @@ components: format: date-time type: string type: object + x-akamai: + file-path: schemas/service-transfer.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-service-transfers-200.yaml added-get-user-200: allOf: - additionalProperties: false @@ -2188,7 +2324,7 @@ components: last_login: additionalProperties: false description: |- - Information for the most recent login attempt for this User. + __Read-only__ Information for the most recent login attempt for this User. `null` if no login attempts have been made since creation of this User. @@ -2196,13 +2332,13 @@ components: nullable: true properties: login_datetime: - description: The date and time of this User's most recent login attempt. + description: __Read-only__ The date and time of this User's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: - description: The result of the most recent login attempt for this User. + description: __Read-only__ The result of the most recent login attempt for this User. enum: - successful - failed @@ -2213,7 +2349,7 @@ components: type: object password_created: description: |- - The date and time when this User's current password was created. + __Read-only__ The date and time when this User's current password was created. User passwords are first created during the Account sign-up process, and updated using the [Reset Password](https://login.linode.com/forgot/password) webpage. @@ -2224,13 +2360,13 @@ components: readOnly: true type: string restricted: - description: If true, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. + description: If `true`, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: |- - A list of SSH Key labels added by this User. + __Read-only__ A list of SSH Key labels added by this User. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. @@ -2247,12 +2383,12 @@ components: readOnly: true type: array tfa_enabled: - description: A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. + description: __Read-only__ A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: - description: The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). + description: __Filterable__ The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). example: example_user maxLength: 32 minLength: 3 @@ -2265,7 +2401,7 @@ components: x-linode-filterable: true verified_phone_number: description: |- - The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. + __Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number. example: '+5555555555' @@ -2274,12 +2410,14 @@ components: readOnly: true type: string type: object + x-akamai: + file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: user_type: description: |- - If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: + __Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: - `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user. @@ -2297,6 +2435,10 @@ components: readOnly: true type: string type: object + x-akamai: + file-path: schemas/user-type.yaml + x-akamai: + file-path: schemas/added-get-user-200.yaml added-get-users-200: additionalProperties: false properties: @@ -2315,7 +2457,7 @@ components: last_login: additionalProperties: false description: |- - Information for the most recent login attempt for this User. + __Read-only__ Information for the most recent login attempt for this User. `null` if no login attempts have been made since creation of this User. @@ -2323,13 +2465,13 @@ components: nullable: true properties: login_datetime: - description: The date and time of this User's most recent login attempt. + description: __Read-only__ The date and time of this User's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: - description: The result of the most recent login attempt for this User. + description: __Read-only__ The result of the most recent login attempt for this User. enum: - successful - failed @@ -2340,7 +2482,7 @@ components: type: object password_created: description: |- - The date and time when this User's current password was created. + __Read-only__ The date and time when this User's current password was created. User passwords are first created during the Account sign-up process, and updated using the [Reset Password](https://login.linode.com/forgot/password) webpage. @@ -2351,13 +2493,13 @@ components: readOnly: true type: string restricted: - description: If true, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. + description: If `true`, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: |- - A list of SSH Key labels added by this User. + __Read-only__ A list of SSH Key labels added by this User. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. @@ -2374,12 +2516,12 @@ components: readOnly: true type: array tfa_enabled: - description: A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. + description: __Read-only__ A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: - description: The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). + description: __Filterable__ The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). example: example_user maxLength: 32 minLength: 3 @@ -2392,7 +2534,7 @@ components: x-linode-filterable: true verified_phone_number: description: |- - The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. + __Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number. example: '+5555555555' @@ -2401,12 +2543,14 @@ components: readOnly: true type: string type: object + x-akamai: + file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: user_type: description: |- - If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: + __Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: - `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user. @@ -2424,23 +2568,27 @@ components: readOnly: true type: string type: object + x-akamai: + file-path: schemas/user-type.yaml type: array page: - description: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/added-get-users-200.yaml added-post-beta-program: additionalProperties: false description: The Beta Program ID to enroll in for your Account. @@ -2453,6 +2601,8 @@ components: required: - id type: object + x-akamai: + file-path: schemas/added-post-beta-program.yaml added-post-cancel-account: additionalProperties: false properties: @@ -2461,6 +2611,8 @@ components: example: I'm consolidating multiple accounts into one. type: string type: object + x-akamai: + file-path: schemas/added-post-cancel-account.yaml added-post-cancel-account-200: additionalProperties: false example: @@ -2470,6 +2622,8 @@ components: description: A link to Linode's exit survey. type: string type: object + x-akamai: + file-path: schemas/added-post-cancel-account-200.yaml added-post-cancel-account-409: additionalProperties: false properties: @@ -2484,19 +2638,21 @@ components: type: object type: array type: object + x-akamai: + file-path: schemas/added-post-cancel-account-409.yaml added-post-client: allOf: - additionalProperties: false description: A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](https://login.linode.com). Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application. properties: id: - description: The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret). + description: __Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret). example: 2737bf16b39ab5d7b4a1 readOnly: true type: string x-linode-cli-display: 1 label: - description: The name of this application. This will be presented to users when they are asked to grant it access to their Account. + description: __Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account. example: Test_Client_1 maxLength: 512 minLength: 1 @@ -2508,7 +2664,7 @@ components: x-linode-filterable: true public: default: false - description: If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. + description: __Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. example: false type: boolean x-akamai: @@ -2523,12 +2679,12 @@ components: type: string x-linode-cli-display: 5 secret: - description: The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. + description: __Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. example: readOnly: true type: string status: - description: The status of this application. `active` by default. + description: __Read-only__ The status of this application. `active` by default. enum: - active - disabled @@ -2541,16 +2697,20 @@ components: suspended: red x-linode-cli-display: 3 thumbnail_url: - description: The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set. + description: __Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set. example: https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail format: url nullable: true readOnly: true type: string type: object + x-akamai: + file-path: schemas/oauth-client.yaml required: - label - redirect_uri + x-akamai: + file-path: schemas/added-post-client.yaml added-post-entity-transfer: additionalProperties: false properties: @@ -2571,11 +2731,13 @@ components: required: - entities type: object + x-akamai: + file-path: schemas/added-post-entity-transfer.yaml added-post-pay-pal-payment-200: additionalProperties: false properties: checkout_token: - description: The checkout token generated for this Payment. + description: __Read-only__ The checkout token generated for this Payment. example: EC-1A2B3C4D5E6F7G8H9 readOnly: true type: string @@ -2584,6 +2746,8 @@ components: example: PAY-1234567890ABCDEFGHIJKLMN type: string type: object + x-akamai: + file-path: schemas/added-post-pay-pal-payment-200.yaml added-post-payment: additionalProperties: false properties: @@ -2604,6 +2768,8 @@ components: pattern: ^\$?\d+\.\d{2}$ type: string type: object + x-akamai: + file-path: schemas/added-post-payment.yaml added-post-payment-method: additionalProperties: false description: Payment Method Request Object. @@ -2653,6 +2819,8 @@ components: - expiry_year - cvv type: object + x-akamai: + file-path: schemas/credit-card.yaml is_default: description: Whether this Payment Method is the default method for automatically processing service charges. example: true @@ -2673,6 +2841,8 @@ components: - data - is_default type: object + x-akamai: + file-path: schemas/added-post-payment-method.yaml added-post-promo-credit: additionalProperties: false properties: @@ -2684,6 +2854,8 @@ components: required: - promo_code type: object + x-akamai: + file-path: schemas/added-post-promo-credit.yaml added-post-service-transfer: additionalProperties: false properties: @@ -2704,6 +2876,8 @@ components: required: - entities type: object + x-akamai: + file-path: schemas/added-post-service-transfer.yaml added-post-user: allOf: - additionalProperties: false @@ -2718,7 +2892,7 @@ components: last_login: additionalProperties: false description: |- - Information for the most recent login attempt for this User. + __Read-only__ Information for the most recent login attempt for this User. `null` if no login attempts have been made since creation of this User. @@ -2726,13 +2900,13 @@ components: nullable: true properties: login_datetime: - description: The date and time of this User's most recent login attempt. + description: __Read-only__ The date and time of this User's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: - description: The result of the most recent login attempt for this User. + description: __Read-only__ The result of the most recent login attempt for this User. enum: - successful - failed @@ -2743,7 +2917,7 @@ components: type: object password_created: description: |- - The date and time when this User's current password was created. + __Read-only__ The date and time when this User's current password was created. User passwords are first created during the Account sign-up process, and updated using the [Reset Password](https://login.linode.com/forgot/password) webpage. @@ -2754,13 +2928,13 @@ components: readOnly: true type: string restricted: - description: If true, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. + description: If `true`, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: |- - A list of SSH Key labels added by this User. + __Read-only__ A list of SSH Key labels added by this User. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. @@ -2777,12 +2951,12 @@ components: readOnly: true type: array tfa_enabled: - description: A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. + description: __Read-only__ A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: - description: The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). + description: __Filterable__ The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). example: example_user maxLength: 32 minLength: 3 @@ -2795,7 +2969,7 @@ components: x-linode-filterable: true verified_phone_number: description: |- - The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. + __Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number. example: '+5555555555' @@ -2804,9 +2978,13 @@ components: readOnly: true type: string type: object + x-akamai: + file-path: schemas/user.yaml required: - username - email + x-akamai: + file-path: schemas/added-post-user.yaml added-put-user-200: allOf: - additionalProperties: false @@ -2821,7 +2999,7 @@ components: last_login: additionalProperties: false description: |- - Information for the most recent login attempt for this User. + __Read-only__ Information for the most recent login attempt for this User. `null` if no login attempts have been made since creation of this User. @@ -2829,13 +3007,13 @@ components: nullable: true properties: login_datetime: - description: The date and time of this User's most recent login attempt. + description: __Read-only__ The date and time of this User's most recent login attempt. example: '2018-01-01T01:01:01' format: date-time readOnly: true type: string status: - description: The result of the most recent login attempt for this User. + description: __Read-only__ The result of the most recent login attempt for this User. enum: - successful - failed @@ -2846,7 +3024,7 @@ components: type: object password_created: description: |- - The date and time when this User's current password was created. + __Read-only__ The date and time when this User's current password was created. User passwords are first created during the Account sign-up process, and updated using the [Reset Password](https://login.linode.com/forgot/password) webpage. @@ -2857,13 +3035,13 @@ components: readOnly: true type: string restricted: - description: If true, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. + description: If `true`, the User must be granted access to perform actions or access entities on this Account. Run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User. example: true type: boolean x-linode-cli-display: 3 ssh_keys: description: |- - A list of SSH Key labels added by this User. + __Read-only__ A list of SSH Key labels added by this User. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. @@ -2880,12 +3058,12 @@ components: readOnly: true type: array tfa_enabled: - description: A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. + description: __Read-only__ A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA. example: true readOnly: true type: boolean username: - description: The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). + description: __Filterable__ The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). example: example_user maxLength: 32 minLength: 3 @@ -2898,7 +3076,7 @@ components: x-linode-filterable: true verified_phone_number: description: |- - The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. + __Read-only__ The phone number verified for this User Profile with the [Verify a phone number](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. `null` if this User Profile has no verified phone number. example: '+5555555555' @@ -2907,12 +3085,14 @@ components: readOnly: true type: string type: object + x-akamai: + file-path: schemas/user.yaml - additionalProperties: false description: The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality. properties: user_type: description: |- - If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: + __Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include: - `parent`. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user. @@ -2930,6 +3110,10 @@ components: readOnly: true type: string type: object + x-akamai: + file-path: schemas/user-type.yaml + x-akamai: + file-path: schemas/added-put-user-200.yaml agreements: additionalProperties: false description: Acknowledgment status for agreements on your account. When acknowledging any agreements, set them to `true` and omit any remainders. @@ -2947,12 +3131,14 @@ components: example: true type: boolean type: object + x-akamai: + file-path: schemas/agreements.yaml beta-program-enrolled: additionalProperties: false description: An object representing an enrolled Beta Program for the Account. properties: description: - description: Additional details regarding the Beta Program. + description: __Read-only__ Additional details regarding the Beta Program. example: This is an open public beta for an example feature. nullable: true readOnly: true @@ -2960,7 +3146,7 @@ components: x-linode-cli-display: 3 ended: description: |- - The date-time that the Beta Program ended. + __Filterable__, __Read-only__ The date-time that the Beta Program ended. `null` indicates that the Beta Program is ongoing. example: null @@ -2974,7 +3160,7 @@ components: x-linode-cli-display: 5 x-linode-filterable: true enrolled: - description: The date-time of Account enrollment to the Beta Program. + 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 @@ -2990,7 +3176,7 @@ components: type: string x-linode-cli-display: 1 label: - description: The name of the Beta Program. + description: __Filterable__, __Read-only__ The name of the Beta Program. example: Example Open Beta readOnly: true type: string @@ -3000,7 +3186,7 @@ components: x-linode-cli-display: 2 x-linode-filterable: true started: - description: 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 @@ -3011,18 +3197,20 @@ components: x-linode-cli-display: 4 x-linode-filterable: true type: object + x-akamai: + file-path: schemas/beta-program-enrolled.yaml child-account: additionalProperties: false description: Child account object. properties: active_since: - description: 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: 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 @@ -3031,7 +3219,7 @@ components: - Filterable x-linode-filterable: true address_2: - description: 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 @@ -3040,26 +3228,26 @@ components: - Filterable x-linode-filterable: true balance: - description: 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: 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: 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 example: external readOnly: true type: string capabilities: - description: A list of the capabilities the child account supports. + description: __Read-only__ A list of the capabilities the child account supports. example: - Linodes - NodeBalancers @@ -3070,7 +3258,7 @@ components: readOnly: true type: array city: - description: 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 @@ -3079,7 +3267,7 @@ components: - Filterable x-linode-filterable: true company: - description: 'The company name for the owner of this child account. It can''t include any of these characters: `<` `>` `(` `)` `"` `=`. You can''t change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.' + 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 @@ -3088,7 +3276,7 @@ components: - Filterable x-linode-filterable: true country: - description: 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: @@ -3097,7 +3285,7 @@ components: x-linode-filterable: true credit_card: additionalProperties: false - description: 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 card. @@ -3110,7 +3298,7 @@ components: readOnly: true type: object email: - description: 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 @@ -3120,13 +3308,13 @@ components: x-linode-cli-display: 3 x-linode-filterable: true euuid: - description: 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: '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 @@ -3136,7 +3324,7 @@ components: x-linode-cli-display: 1 x-linode-filterable: true last_name: - description: '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 @@ -3146,7 +3334,7 @@ components: x-linode-cli-display: 2 x-linode-filterable: true phone: - description: 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 @@ -3156,7 +3344,7 @@ components: x-linode-filterable: true state: description: |- - The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code. + __Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code. __Note__. If this is a US military address, use state abbreviations (AA, AE, AP). example: CA @@ -3173,7 +3361,7 @@ components: type: string zip: description: |- - The zip code of this Account's billing address. The following restrictions apply: + __Filterable__ The zip code of this Account's billing address. The following restrictions apply: - Can only contain ASCII letters, numbers, and hyphens (`-`). - Can't contain more than 9 letter or number characters. @@ -3184,6 +3372,8 @@ components: - Filterable x-linode-filterable: true type: object + x-akamai: + file-path: schemas/child-account.yaml credit-card: additionalProperties: false description: An object representing the credit card information you have on file with Linode to make Payments against your Account. @@ -3229,30 +3419,34 @@ components: - expiry_year - cvv type: object + x-akamai: + file-path: schemas/credit-card.yaml credit-card-data: additionalProperties: false description: Credit card information. properties: card_type: - description: The type of credit card. + description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: - description: The expiration month and year of the credit card. + description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: - description: The last four digits of the credit card number. + description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Credit card type: object + x-akamai: + file-path: schemas/credit-card-data.yaml description: - description: Additional details regarding the Beta Program. + description: __Read-only__ Additional details regarding the Beta Program. example: This is an open public beta for an example feature. nullable: true readOnly: true @@ -3260,7 +3454,7 @@ components: x-linode-cli-display: 3 ended: description: |- - The date-time that the Beta Program ended. + __Filterable__, __Read-only__ The date-time that the Beta Program ended. `null` indicates that the Beta Program is ongoing. example: null @@ -3317,7 +3511,7 @@ components: type: string x-linode-cli-display: 3 is_sender: - description: If the requesting account created this transfer. + description: __Filterable__ If the requesting account created this transfer. example: true type: boolean x-akamai: @@ -3327,7 +3521,7 @@ components: x-linode-filterable: true status: description: |- - The status of the transfer request: + __Filterable__ The status of the transfer request: `accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete. `canceled`: The transfer has been canceled by the sender. @@ -3369,6 +3563,8 @@ components: format: date-time type: string type: object + x-akamai: + file-path: schemas/entity-transfer.yaml error-object: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. @@ -3382,12 +3578,14 @@ components: example: fieldname must be a valid value type: string type: object + x-akamai: + file-path: schemas/error-object.yaml event: additionalProperties: false description: A collection of Event objects. An Event is an action taken against an entity related to your Account. For example, booting a Linode would create an Event. The Events returned depends on your grants. properties: action: - description: The action that caused this Event. New actions may be added in the future. + description: __Filterable__, __Read-only__ The action that caused this Event. New actions may be added in the future. enum: - account_update - account_settings_update @@ -3543,7 +3741,7 @@ components: x-linode-cli-display: 3 x-linode-filterable: true created: - description: When this Event was created. + description: __Filterable__, __Read-only__ When this Event was created. example: '2018-01-01T00:01:01' format: date-time readOnly: true @@ -3554,18 +3752,18 @@ components: x-linode-cli-display: 6 x-linode-filterable: true duration: - description: The total duration in seconds that it takes for the Event to complete. + description: __Read-only__ The total duration in seconds that it takes for the Event to complete. example: 300.56 readOnly: true type: number x-linode-cli-display: 7 entity: additionalProperties: false - description: Detailed information about the Event's entity, including ID, type, label, and URL used to access it. + description: __Read-only__ Detailed information about the Event's entity, including ID, type, label, and URL used to access it. properties: id: description: |- - The unique ID for an Event's entity. + __Filterable__ The unique ID for an Event's entity. Some Event entities do not have IDs associated with them, so they will not be returned when filtering by ID. These Events include: @@ -3590,7 +3788,7 @@ components: type: string x-linode-cli-display: 5 type: - description: The type of entity that is being referenced by the Event. + description: __Filterable__, __Read-only__ The type of entity that is being referenced by the Event. enum: - account - backups @@ -3629,7 +3827,7 @@ components: readOnly: true type: object id: - description: The unique ID of this Event. + description: __Filterable__, __Read-only__ The unique ID of this Event. example: 123 readOnly: true type: integer @@ -3645,17 +3843,19 @@ components: type: string x-linode-cli-display: 9 percent_complete: - description: A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events. + description: __Read-only__ A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events. example: null + nullable: true readOnly: true type: integer rate: - description: The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events. + description: __Read-only__ The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events. example: null + nullable: true readOnly: true type: string read: - description: If this Event has been read. + description: __Filterable__, __Read-only__ If this Event has been read. example: true readOnly: true type: boolean @@ -3665,7 +3865,7 @@ components: x-linode-filterable: true secondary_entity: additionalProperties: false - description: Detailed information about the Event's secondary entity, which provides additional information for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions. + description: __Read-only__ Detailed information about the Event's secondary entity, which provides additional information for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions. properties: id: description: The ID of the object that is the secondary entity. @@ -3676,7 +3876,7 @@ components: example: linode1234 type: string type: - description: The type of entity that is being referenced by the Event. + description: __Read-only__ The type of entity that is being referenced by the Event. example: linode readOnly: true type: string @@ -3687,12 +3887,12 @@ components: readOnly: true type: object seen: - description: If this Event has been seen. + description: __Read-only__ If this Event has been seen. example: true readOnly: true type: boolean status: - description: The current status of this Event. + description: __Read-only__ The current status of this Event. enum: - failed - finished @@ -3708,41 +3908,45 @@ components: started: yellow x-linode-cli-display: 8 time_remaining: - description: The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done. + description: __Read-only__ The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done. example: null nullable: true readOnly: true type: string username: - description: The username of the User who caused the Event. + description: __Read-only__ The username of the User who caused the Event. example: exampleUser nullable: true readOnly: true type: string x-linode-cli-display: 2 type: object + x-akamai: + file-path: schemas/event.yaml google-pay-data: additionalProperties: false description: Google Pay information. properties: card_type: - description: The type of credit card. + description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: - description: The expiration month and year of the credit card. + description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: - description: The last four digits of the credit card number. + description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Google Pay type: object + x-akamai: + file-path: schemas/google-pay-data.yaml grant: additionalProperties: false description: Represents the level of access a restricted User has to a specific resource on the Account. @@ -3752,12 +3956,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -3765,6 +3969,8 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml grants-response: additionalProperties: false description: A structure representing all grants a restricted User has on the Account. Not available for unrestricted users, as they have access to everything without grants. If retrieved from the `/profile/grants` endpoint, entities to which a User has no access will be omitted. @@ -3780,12 +3986,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -3793,6 +3999,8 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml type: array domain: description: The grants this User has for each Domain that is owned by this Account. @@ -3805,12 +4013,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -3818,6 +4026,8 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml type: array firewall: description: The grants this User has for each Firewall that is owned by this Account. @@ -3830,12 +4040,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -3843,6 +4053,8 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml type: array global: additionalProperties: false @@ -3862,56 +4074,50 @@ components: nullable: true type: string add_databases: - description: If true, this User may add Managed Databases. + description: If `true`, this User may add Managed Databases. example: true type: boolean add_domains: - description: If true, this User may add Domains. + description: If `true`, this User may add Domains. example: true type: boolean add_firewalls: - description: If true, this User may add Firewalls. + description: If `true`, this User may add Firewalls. example: true type: boolean add_images: - description: If true, this User may add Images. + description: If `true`, this User may add Images. example: true type: boolean add_linodes: - description: If true, this User may create Linodes. + description: If `true`, this User may create Linodes. example: true type: boolean - add_loadbalancers: - description: If true, this User may add Cloud Load Balancers. - example: true - type: boolean - x-akamai: - exclude-reason: PRE_RELEASE add_longview: - description: If true, this User may create Longview clients and view the current plan. + description: If `true`, this User may create Longview clients and view the current plan. example: true type: boolean add_nodebalancers: - description: If true, this User may add NodeBalancers. + description: If `true`, this User may add NodeBalancers. example: true type: boolean add_placement_groups: - description: If true, this User may add Placement Groups. + description: If `true`, this User may add Placement Groups. type: boolean add_stackscripts: - description: If true, this User may add StackScripts. + description: If `true`, this User may add StackScripts. example: true type: boolean add_volumes: - description: If true, this User may add Volumes. + description: If `true`, this User may add Volumes. example: true type: boolean add_vpcs: - description: If true, this User may add VPCs. + description: If `true`, this User may add VPCs. example: true type: boolean cancel_account: - description: If true, this User may cancel the entire Account. + description: If `true`, this User may cancel the entire Account. example: false type: boolean child_account_access: @@ -3920,7 +4126,7 @@ components: nullable: true type: boolean longview_subscription: - description: If true, this User may manage the Account's Longview subscription. + description: If `true`, this User may manage the Account's Longview subscription. example: true type: boolean type: object @@ -3935,12 +4141,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -3948,6 +4154,8 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml type: array linode: description: The grants this User has for each Linode that is owned by this Account. @@ -3960,12 +4168,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -3973,6 +4181,8 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml type: array longview: description: The grants this User has for each Longview Client that is owned by this Account. @@ -3985,12 +4195,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -3998,6 +4208,8 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml type: array nodebalancer: description: The grants this User has for each NodeBalancer that is owned by this Account. @@ -4010,12 +4222,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -4023,6 +4235,8 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml type: array placement_group: description: The grants this User has for each Placement Group that is owned by this Account. @@ -4035,12 +4249,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -4048,6 +4262,8 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml type: array stackscript: description: The grants this User has for each StackScript that is owned by this Account. @@ -4060,12 +4276,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -4073,6 +4289,8 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml type: array volume: description: The grants this User has for each Block Storage Volume that is owned by this Account. @@ -4085,12 +4303,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -4098,6 +4316,8 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml type: array vpc: description: The grants this User has for each VPC that is owned by this Account. @@ -4110,12 +4330,12 @@ components: example: 123 type: integer label: - description: The current label of the entity this grant applies to, for display purposes. + description: __Read-only__ The current label of the entity this grant applies to, for display purposes. example: example-entity readOnly: true type: string permissions: - description: The level of access this User has to this entity. If null, this User has no access. + description: The level of access this User has to this entity. If `null`, this User has no access. enum: - read_only - read_write @@ -4123,8 +4343,12 @@ components: nullable: true type: string type: object + x-akamai: + file-path: schemas/grant.yaml type: array type: object + x-akamai: + file-path: schemas/grants-response.yaml id: description: The unique identifier of the Beta Program. example: example_open @@ -4136,7 +4360,7 @@ components: properties: billing_source: description: |- - `akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai. + __Filterable__, __Read-only__ `akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai. `linode`: This Invoice was generated according to the default terms, prices, and discounts. enum: @@ -4151,7 +4375,7 @@ components: x-linode-cli-display: 3.5 x-linode-filterable: true date: - description: When this Invoice was generated. + description: __Filterable__, __Read-only__ When this Invoice was generated. example: '2018-01-01T00:01:01' format: date-time readOnly: true @@ -4162,13 +4386,13 @@ components: x-linode-cli-display: 2 x-linode-filterable: true id: - description: The Invoice's unique ID. + description: __Read-only__ The Invoice's unique ID. example: 123 readOnly: true type: integer x-linode-cli-display: 1 label: - description: The Invoice's display label. + description: __Filterable__, __Read-only__ The Invoice's display label. example: Invoice readOnly: true type: string @@ -4178,19 +4402,19 @@ components: x-linode-cli-display: 3 x-linode-filterable: true subtotal: - description: The amount of the Invoice before taxes in US Dollars. + description: __Read-only__ The amount of the Invoice before taxes in US Dollars. example: 120.25 readOnly: true type: number x-linode-cli-display: 4 tax: - description: The amount of tax levied on the Invoice in US Dollars. + description: __Read-only__ The amount of tax levied on the Invoice in US Dollars. example: 12.25 readOnly: true type: number x-linode-cli-display: 5 tax_summary: - description: The amount of tax broken down into subtotals by source. + description: __Read-only__ The amount of tax broken down into subtotals by source. items: additionalProperties: false properties: @@ -4206,7 +4430,7 @@ components: readOnly: true type: array total: - description: The amount of the Invoice after taxes in US Dollars. + description: __Filterable__, __Read-only__ The amount of the Invoice after taxes in US Dollars. example: 132.5 readOnly: true type: number @@ -4216,37 +4440,39 @@ components: x-linode-cli-display: 6 x-linode-filterable: true type: object + x-akamai: + file-path: schemas/invoice.yaml invoice-item: additionalProperties: false description: An InvoiceItem object. properties: amount: - description: The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity. + description: __Read-only__ The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity. example: 20.2 readOnly: true type: number x-linode-cli-display: 4 from: - description: The date the Invoice Item started, based on month. + description: __Read-only__ The date the Invoice Item started, based on month. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 label: - description: The Invoice Item's display label. + description: __Read-only__ The Invoice Item's display label. example: Linode 123 readOnly: true type: string x-linode-cli-display: 1 quantity: - description: The quantity of this Item for the specified Invoice. + description: __Read-only__ The quantity of this Item for the specified Invoice. example: 4 readOnly: true type: integer region: description: |- - The ID of the applicable Region associated with this Invoice Item. + __Read-only__ The ID of the applicable Region associated with this Invoice Item. `null` if there is no applicable Region. example: us-west @@ -4255,26 +4481,26 @@ components: type: string x-linode-cli-display: 7 tax: - description: The amount of tax levied on this Item in US Dollars. + description: __Read-only__ The amount of tax levied on this Item in US Dollars. example: 1.25 readOnly: true type: number x-linode-cli-display: 5 to: - description: The date the Invoice Item ended, based on month. + description: __Read-only__ The date the Invoice Item ended, based on month. example: '2018-01-31T11:59:59' format: date-time readOnly: true type: string x-linode-cli-display: 3 total: - description: The price of this Item after taxes in US Dollars. + description: __Read-only__ The price of this Item after taxes in US Dollars. example: 21.45 readOnly: true type: number x-linode-cli-display: 6 type: - description: The type of service, ether `hourly` or `misc`. + description: __Read-only__ The type of service, ether `hourly` or `misc`. enum: - hourly - misc @@ -4282,18 +4508,20 @@ components: readOnly: true type: string unit_price: - description: The monthly service fee in US Dollars for this Item. + description: __Read-only__ The monthly service fee in US Dollars for this Item. example: 5.05 readOnly: true type: string type: object + x-akamai: + file-path: schemas/invoice-item.yaml is_default: description: Whether this Payment Method is the default method for automatically processing service charges. example: true type: boolean x-linode-cli-display: 3 label: - description: The name of the Beta Program. + description: __Filterable__, __Read-only__ The name of the Beta Program. example: Example Open Beta readOnly: true type: string @@ -4307,33 +4535,33 @@ components: description: An object representing a previous successful login for a User. properties: datetime: - description: When the login was initiated. + description: __Read-only__ When the login was initiated. example: '2018-01-01T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 id: - description: The unique ID of this login object. + description: __Read-only__ The unique ID of this login object. example: 1234 readOnly: true type: integer x-linode-cli-display: 1 ip: - description: The remote IP address that requested the login. + description: __Read-only__ The remote IP address that requested the login. example: 192.0.2.0 format: ip readOnly: true type: string x-linode-cli-display: 3 restricted: - description: True if the User that attempted the login was a restricted User, false otherwise. + description: __Read-only__ True if the User that attempted the login was a restricted User, false otherwise. example: true readOnly: true type: boolean x-linode-cli-display: 6 status: - description: Whether the login attempt succeeded or failed. + description: __Read-only__ Whether the login attempt succeeded or failed. enum: - successful - failed @@ -4342,12 +4570,14 @@ components: type: string x-linode-cli-display: 5 username: - description: The username of the User that attempted the login. + description: __Read-only__ The username of the User that attempted the login. example: example_user readOnly: true type: string x-linode-cli-display: 4 type: object + x-akamai: + file-path: schemas/login.yaml maintenance: additionalProperties: false description: Information about maintenance affecting an entity. @@ -4379,7 +4609,7 @@ components: type: string status: description: |- - The maintenance status. + __Filterable__ The maintenance status. Maintenance progresses in the following sequence: pending, started, then completed. enum: @@ -4393,7 +4623,7 @@ components: - Filterable x-linode-filterable: true type: - description: The type of maintenance. + description: __Filterable__ The type of maintenance. enum: - reboot - cold_migration @@ -4406,7 +4636,7 @@ components: x-linode-filterable: true when: description: |- - When the maintenance will begin. + __Filterable__ When the maintenance will begin. [Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters: @@ -4421,19 +4651,21 @@ components: - Filterable x-linode-filterable: true type: object + x-akamai: + file-path: schemas/maintenance.yaml notification: additionalProperties: false description: An important, often time-sensitive item related to your account. properties: body: - description: A full description of this notification, in markdown format. Not all notifications include a `body`. + description: __Read-only__ A full description of this notification, in markdown format. Not all notifications include a `body`. example: null nullable: true readOnly: true type: string entity: additionalProperties: false - description: Detailed information about the notification. + description: __Read-only__ Detailed information about the notification. properties: id: description: The unique ID of the notification's entity, based on the entity type. Returns `null` for an `account` or `promotion` entity. @@ -4474,19 +4706,19 @@ components: readOnly: true type: object label: - description: A short description of this notification. + description: __Read-only__ A short description of this notification. example: You have an important ticket open! readOnly: true type: string x-linode-cli-display: 1 message: - description: A human-readable description of the notification. + description: __Read-only__ A human-readable description of the notification. example: You have an important ticket open! readOnly: true type: string x-linode-cli-display: 2 severity: - description: The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. + description: __Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text. enum: - minor - major @@ -4500,7 +4732,7 @@ components: minor: blue x-linode-cli-display: 3 type: - description: The type of notification. + description: __Read-only__ The type of notification. enum: - migration_scheduled - migration_imminent @@ -4517,9 +4749,10 @@ components: readOnly: true type: string until: - description: If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window. + description: __Read-only__ If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window. example: null format: date-time + nullable: true readOnly: true type: string x-linode-cli-color: @@ -4527,9 +4760,10 @@ components: default_: white x-linode-cli-display: 5 when: - description: If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration. + description: __Read-only__ If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration. example: null format: date-time + nullable: true readOnly: true type: string x-linode-cli-color: @@ -4537,18 +4771,20 @@ components: default_: white x-linode-cli-display: 4 type: object + x-akamai: + file-path: schemas/notification.yaml oauth-client: additionalProperties: false description: A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](https://login.linode.com). Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application. properties: id: - description: The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret). + description: __Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret). example: 2737bf16b39ab5d7b4a1 readOnly: true type: string x-linode-cli-display: 1 label: - description: The name of this application. This will be presented to users when they are asked to grant it access to their Account. + description: __Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account. example: Test_Client_1 maxLength: 512 minLength: 1 @@ -4560,7 +4796,7 @@ components: x-linode-filterable: true public: default: false - description: If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. + description: __Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details. example: false type: boolean x-akamai: @@ -4575,12 +4811,12 @@ components: type: string x-linode-cli-display: 5 secret: - description: The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. + description: __Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly. example: readOnly: true type: string status: - description: The status of this application. `active` by default. + description: __Read-only__ The status of this application. `active` by default. enum: - active - disabled @@ -4593,20 +4829,22 @@ components: suspended: red x-linode-cli-display: 3 thumbnail_url: - description: The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set. + description: __Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set. example: https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail format: url nullable: true readOnly: true type: string type: object + x-akamai: + file-path: schemas/oauth-client.yaml page: - description: 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: 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 @@ -4615,118 +4853,126 @@ components: 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: 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: 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 results: - description: The total number of results. + description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object + x-akamai: + file-path: schemas/pagination-envelope.yaml payment: additionalProperties: false description: Payment object response. properties: date: - description: When the Payment was made. + description: __Read-only__ When the Payment was made. example: '2018-01-15T00:01:01' format: date-time readOnly: true type: string x-linode-cli-display: 2 id: - description: The unique ID of the Payment. + description: __Read-only__ The unique ID of the Payment. example: 123 readOnly: true type: integer x-linode-cli-display: 1 usd: - description: The amount, in US dollars, of the Payment. + description: __Read-only__ The amount, in US dollars, of the Payment. example: '120.50' readOnly: true type: integer x-linode-cli-display: 3 type: object + x-akamai: + file-path: schemas/payment.yaml payment-method: additionalProperties: false description: Payment Method Response Object. properties: created: - description: When the Payment Method was added to the Account. + description: __Read-only__ When the Payment Method was added to the Account. example: '2018-01-15T00:01:01' format: date-time readOnly: true type: string data: - discriminator: - propertyName: type oneOf: - additionalProperties: false description: Credit card information. properties: card_type: - description: The type of credit card. + description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: - description: The expiration month and year of the credit card. + description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: - description: The last four digits of the credit card number. + description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Credit card type: object + x-akamai: + file-path: schemas/credit-card-data.yaml x-linode-ref-name: Credit Card - additionalProperties: false description: Google Pay information. properties: card_type: - description: The type of credit card. + description: __Read-only__ The type of credit card. example: Discover readOnly: true type: string expiry: - description: The expiration month and year of the credit card. + description: __Read-only__ The expiration month and year of the credit card. example: 06/2022 format: MM/YYYY readOnly: true type: string last_four: - description: The last four digits of the credit card number. + description: __Read-only__ The last four digits of the credit card number. example: '1234' readOnly: true type: string title: Google Pay type: object + x-akamai: + file-path: schemas/google-pay-data.yaml x-linode-ref-name: Google Pay - additionalProperties: false description: PayPal information. properties: email: - description: The email address associated with your PayPal account. + description: __Read-only__ The email address associated with your PayPal account. example: example@linode.com readOnly: true type: string paypal_id: - description: PayPal Merchant ID associated with your PayPal account. + description: __Read-only__ PayPal Merchant ID associated with your PayPal account. example: ABC1234567890 readOnly: true type: string title: Paypal type: object + x-akamai: + file-path: schemas/paypal-data.yaml x-linode-ref-name: Paypal x-linode-cli-display: 4 x-linode-cli-format: json @@ -4750,6 +4996,8 @@ components: type: string x-linode-cli-display: 2 type: object + x-akamai: + file-path: schemas/payment-method.yaml paypal: additionalProperties: false description: An object representing the staging of a Payment via PayPal. @@ -4771,22 +5019,26 @@ components: - redirect_url - usd type: object + x-akamai: + file-path: schemas/paypal.yaml paypal-data: additionalProperties: false description: PayPal information. properties: email: - description: The email address associated with your PayPal account. + description: __Read-only__ The email address associated with your PayPal account. example: example@linode.com readOnly: true type: string paypal_id: - description: PayPal Merchant ID associated with your PayPal account. + description: __Read-only__ PayPal Merchant ID associated with your PayPal account. example: ABC1234567890 readOnly: true type: string title: Paypal type: object + x-akamai: + file-path: schemas/paypal-data.yaml paypal-execute: additionalProperties: false description: An object representing an execution of Payment to PayPal to capture the funds and credit your Linode Account. @@ -4803,10 +5055,12 @@ components: - payer_id - payment_id type: object + x-akamai: + file-path: schemas/paypal-execute.yaml promotion: additionalProperties: false description: |- - Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set. + __Read-only__ Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set. Simply put, a promotion offers a certain amount of credit month, until either the expiration date is passed, or until the total promotional credit is used, whichever comes first. properties: @@ -4865,6 +5119,8 @@ components: x-linode-cli-display: 4 readOnly: true type: object + x-akamai: + file-path: schemas/promotion.yaml properties-entities: additionalProperties: false description: A collection of the services to include in this transfer request, separated by type. @@ -4884,7 +5140,7 @@ components: 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: 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 @@ -4895,20 +5151,20 @@ components: x-linode-cli-display: 4 x-linode-filterable: true expiry: - description: When this token expires. This is default set to 15 minutes from the time of creation. Proxy user tokens can't be renewed. After this time, Akamai revokes the token and you need to generate a new one. + 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: 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: The name of the token. The API automatically sets this to `__