diff --git a/openapi.json b/openapi.json index 39d786ab5..43d548c12 100644 --- a/openapi.json +++ b/openapi.json @@ -12,9 +12,6 @@ "v4beta" ], "type": "string" - }, - "x-akamai": { - "file-path": "parameters/api-version-path.yaml" } }, "beta-id": { @@ -24,9 +21,6 @@ "required": true, "schema": { "type": "string" - }, - "x-akamai": { - "file-path": "parameters/beta-id.yaml" } }, "client-id-path": { @@ -36,9 +30,6 @@ "required": true, "schema": { "type": "string" - }, - "x-akamai": { - "file-path": "parameters/client-id-path.yaml" } }, "client-id-path-ecf807fb": { @@ -48,9 +39,6 @@ "required": true, "schema": { "type": "string" - }, - "x-akamai": { - "file-path": "parameters/client-id-path-ecf807fb.yaml" } }, "eeuid": { @@ -60,9 +48,6 @@ "required": true, "schema": { "type": "string" - }, - "x-akamai": { - "file-path": "parameters/eeuid.yaml" } }, "event-id-path-214cd042": { @@ -73,9 +58,6 @@ "schema": { "example": 824, "type": "integer" - }, - "x-akamai": { - "file-path": "parameters/event-id-path-214cd042.yaml" } }, "event-id-path-39255fcf": { @@ -86,22 +68,6 @@ "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": { @@ -111,9 +77,6 @@ "required": true, "schema": { "type": "string" - }, - "x-akamai": { - "file-path": "parameters/id-path.yaml" } }, "invoice-id-path": { @@ -124,9 +87,6 @@ "schema": { "example": 387, "type": "integer" - }, - "x-akamai": { - "file-path": "parameters/invoice-id-path.yaml" } }, "login-id-path": { @@ -137,9 +97,6 @@ "schema": { "example": 863, "type": "integer" - }, - "x-akamai": { - "file-path": "parameters/login-id-path.yaml" } }, "page-offset": { @@ -152,9 +109,6 @@ "example": 6, "minimum": 1, "type": "integer" - }, - "x-akamai": { - "file-path": "parameters/page-offset.yaml" } }, "page-size": { @@ -167,9 +121,6 @@ "maximum": 500, "minimum": 25, "type": "integer" - }, - "x-akamai": { - "file-path": "parameters/page-size.yaml" } }, "payment-id-path": { @@ -180,9 +131,6 @@ "schema": { "example": 627, "type": "integer" - }, - "x-akamai": { - "file-path": "parameters/payment-id-path.yaml" } }, "payment-method-id-path-6078bc7b": { @@ -193,9 +141,6 @@ "schema": { "example": 267, "type": "integer" - }, - "x-akamai": { - "file-path": "parameters/payment-method-id-path-6078bc7b.yaml" } }, "payment-method-id-path-fb39a844": { @@ -206,9 +151,6 @@ "schema": { "example": 267, "type": "integer" - }, - "x-akamai": { - "file-path": "parameters/payment-method-id-path-fb39a844.yaml" } }, "token-path-f857f5a2": { @@ -219,9 +161,6 @@ "schema": { "format": "uuid", "type": "string" - }, - "x-akamai": { - "file-path": "parameters/token-path-f857f5a2.yaml" } }, "token-path-faf66b58": { @@ -232,9 +171,6 @@ "schema": { "format": "uuid", "type": "string" - }, - "x-akamai": { - "file-path": "parameters/token-path-faf66b58.yaml" } }, "username-path": { @@ -244,9 +180,6 @@ "required": true, "schema": { "type": "string" - }, - "x-akamai": { - "file-path": "parameters/username-path.yaml" } } }, @@ -272,20 +205,14 @@ "type": "array" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-cancel-account-409.yaml" - } + "type": "object" }, "x-example": { "x-ref": "../examples/tbd.json" } } }, - "description": "Could not charge the credit card on file.", - "x-akamai": { - "file-path": "errors/409.yaml" - } + "description": "Could not charge the credit card on file." }, "504-account-cancel": { "content": { @@ -308,20 +235,14 @@ "type": "array" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-cancel-account-504.yaml" - } + "type": "object" }, "x-example": { "x-ref": "../examples/tbd.json" } } }, - "description": "Account is taking longer than expected to cancel.", - "x-akamai": { - "file-path": "errors/504-account-cancel.yaml" - } + "description": "Account is taking longer than expected to cancel." }, "accepted-response": { "content": { @@ -345,10 +266,7 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/warning-object.yaml" - } + "type": "object" }, "type": "array" } @@ -381,10 +299,7 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/warning-object.yaml" - } + "type": "object" }, "type": "array" } @@ -417,10 +332,7 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/error-object.yaml" - } + "type": "object" }, "type": "array" } @@ -440,7 +352,7 @@ "active_promotions": { "items": { "additionalProperties": false, - "description": "__Read-only__ Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set.\n\nSimply 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.", + "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.\n\nSimply put, a promotion offers a certain amount of credit month, until either the expiration date is passed, or until the total promotional credit is used, whichever comes first.", "properties": { "credit_monthly_cap": { "description": "The amount available to spend per month.", @@ -506,16 +418,13 @@ } }, "readOnly": true, - "type": "object", - "x-akamai": { - "file-path": "schemas/promotion.yaml" - } + "type": "object" }, "readOnly": true, "type": "array" }, "active_since": { - "description": "__Read-only__ The date and time the account was activated.", + "description": "The date and time the account was activated.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -534,21 +443,21 @@ "type": "string" }, "balance": { - "description": "__Read-only__ This account's balance, in US dollars.", + "description": "This account's balance, in US dollars.", "example": 200, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "balance_uninvoiced": { - "description": "__Read-only__ This account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", + "description": "This account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", "example": 145, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "billing_source": { - "description": "__Read-only__ The source of service charges for this account. Accounts that are associated with Akamai-specific customers return a value of `akamai`. All other accounts return a value of `linode`.", + "description": "The source of service charges for this account. Accounts that are associated with Akamai-specific customers return a value of `akamai`. All other accounts return a value of `linode`.", "enum": [ "akamai", "linode" @@ -558,7 +467,7 @@ "type": "string" }, "capabilities": { - "description": "__Read-only__ The Akamai Cloud Computing services your account supports.", + "description": "The Akamai Cloud Computing services your account supports.", "example": [ "Linodes", "NodeBalancers", @@ -592,7 +501,7 @@ }, "credit_card": { "additionalProperties": false, - "description": "__Read-only__ The credit card information assigned to this account.", + "description": "The credit card information assigned to this account.", "properties": { "expiry": { "description": "The expiration month and year of the `credit_card`.", @@ -616,7 +525,7 @@ "x-linode-cli-display": 3 }, "euuid": { - "description": "__Read-only__ An external unique identifier for this account.", + "description": "An external unique identifier for this account.", "example": "E1AF5EEC-526F-487D-B317EBEB34C87D71", "format": "uuid", "readOnly": true, @@ -660,17 +569,14 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/account.yaml" - } + "type": "object" }, "account-availability": { "additionalProperties": false, "description": "Account Service Availability object.", "properties": { "available": { - "description": "__Read-only__ A list of services _available_ to your account in the `region`.", + "description": "A list of services _available_ to your account in the `region`.", "example": [ "Linodes", "NodeBalancers" @@ -682,14 +588,14 @@ "type": "array" }, "region": { - "description": "__Read-only__ The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation.", + "description": "The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation.", "example": "us-east", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "unavailable": { - "description": "__Read-only__ A list of services _unavailable_ to your account in the `region`.", + "description": "A list of services _unavailable_ to your account in the `region`.", "example": [ "Kubernetes", "Block Storage" @@ -702,10 +608,7 @@ "x-linode-cli-display": 3 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/account-availability.yaml" - } + "type": "object" }, "account-settings": { "additionalProperties": false, @@ -718,7 +621,7 @@ "x-linode-cli-display": 4 }, "interfaces_for_new_linodes": { - "description": "__Beta__ Defines if new Linodes can use legacy configuration interfaces:\n- `legacy_config_only`. All new Linodes need to use legacy configuration interfaces. Prevously created Linodes with Linode Interfaces can still exist. Linodes using legacy configuration interfaces can't be upgraded to use Linode Interfaces.\n- `legacy_config_default_but_linode_allowed`. New Linodes can use legacy configuration interfaces or Linode Interfaces, depending on the `interface_generation` setting specified when creating the Linode. By default, new Linodes use legacy configuration interfaces unless otherwise specified. Linodes that use legacy configuration interfaces can upgrade to Linode Interfaces. This is the default setting for existing accounts.\n- `linode_default_but_legacy_config_allowed`. New Linodes can use legacy configuration interfaces or Linode Interfaces, depending on the `interface_generation` setting specified when creating the Linode. By default, new Linodes use Linode Interfaces unless otherwise specified. Linodes that use legacy configuration interfaces can upgrade to Linode interfaces. This is the default setting for new accounts.\n- `linode_only`. All new Linodes need to use Linode Interfaces. Prevously created Linodes with legacy configuration profile interfaces can still exist if they were created under a previous setting. Linodes using legacy configuration interfaces can be upgraded to Linode Interfaces.", + "description": "Defines if new Linodes can use legacy configuration interfaces:\n- `legacy_config_only`. All new Linodes need to use legacy configuration interfaces. Prevously created Linodes with Linode Interfaces can still exist. Linodes using legacy configuration interfaces can't be upgraded to use Linode Interfaces.\n- `legacy_config_default_but_linode_allowed`. New Linodes can use legacy configuration interfaces or Linode Interfaces, depending on the `interface_generation` setting specified when creating the Linode. By default, new Linodes use legacy configuration interfaces unless otherwise specified. Linodes that use legacy configuration interfaces can upgrade to Linode Interfaces. This is the default setting for existing accounts.\n- `linode_default_but_legacy_config_allowed`. New Linodes can use legacy configuration interfaces or Linode Interfaces, depending on the `interface_generation` setting specified when creating the Linode. By default, new Linodes use Linode Interfaces unless otherwise specified. Linodes that use legacy configuration interfaces can upgrade to Linode interfaces. This is the default setting for new accounts.\n- `linode_only`. All new Linodes need to use Linode Interfaces. Prevously created Linodes with legacy configuration profile interfaces can still exist if they were created under a previous setting. Linodes using legacy configuration interfaces can be upgraded to Linode Interfaces.", "enum": [ "legacy_config_only", "legacy_config_default_but_linode_allowed", @@ -733,14 +636,14 @@ "x-linode-cli-display": 6 }, "longview_subscription": { - "description": "__Read-only__ The Longview Pro tier you are currently subscribed to. The value must be a [Longview subscription](https://techdocs.akamai.com/linode-api/reference/get-longview-subscriptions) ID or `null` for Longview Free.", + "description": "The Longview Pro tier you are currently subscribed to. The value must be a [Longview subscription](https://techdocs.akamai.com/linode-api/reference/get-longview-subscriptions) ID or `null` for Longview Free.", "example": "longview-3", "readOnly": true, "type": "string", "x-linode-cli-display": 2 }, "managed": { - "description": "__Read-only__ Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we'll monitor it for connectivity, response, and total request time.", + "description": "Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we'll monitor it for connectivity, response, and total request time.", "example": true, "readOnly": true, "type": "boolean", @@ -754,7 +657,7 @@ }, "object_storage": { "default": "disabled", - "description": "__Read-only__ A string describing the status of this account's Object Storage service enrollment.", + "description": "A string describing the status of this account's Object Storage service enrollment.", "enum": [ "disabled", "suspended", @@ -766,18 +669,12 @@ "x-linode-cli-display": 5 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/account-settings.yaml" - } + "type": "object" }, "added-empty-obj": { "description": "The API responds with an empty object.", "maxProperties": 0, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-empty-obj.yaml" - } + "type": "object" }, "added-get-account-logins-200": { "additionalProperties": false, @@ -788,7 +685,7 @@ "description": "An object representing a previous successful login for a User.", "properties": { "datetime": { - "description": "__Read-only__ When the login was initiated.", + "description": "When the login was initiated.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -796,14 +693,14 @@ "x-linode-cli-display": 2 }, "id": { - "description": "__Read-only__ The unique ID of this login object.", + "description": "The unique ID of this login object.", "example": 1234, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "ip": { - "description": "__Read-only__ The remote IP address that requested the login.", + "description": "The remote IP address that requested the login.", "example": "192.0.2.0", "format": "ip", "readOnly": true, @@ -811,14 +708,14 @@ "x-linode-cli-display": 3 }, "restricted": { - "description": "__Read-only__ True if the User that attempted the login was a restricted User, false otherwise.", + "description": "True if the User that attempted the login was a restricted User, false otherwise.", "example": true, "readOnly": true, "type": "boolean", "x-linode-cli-display": 6 }, "status": { - "description": "__Read-only__ Whether the login attempt succeeded or failed.", + "description": "Whether the login attempt succeeded or failed.", "enum": [ "successful", "failed" @@ -829,43 +726,37 @@ "x-linode-cli-display": 5 }, "username": { - "description": "__Read-only__ The username of the User that attempted the login.", + "description": "The username of the User that attempted the login.", "example": "example_user", "readOnly": true, "type": "string", "x-linode-cli-display": 4 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/login.yaml" - } + "type": "object" }, "type": "array" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-account-logins-200.yaml" - } + "type": "object" }, "added-get-availability-200": { "allOf": [ @@ -878,7 +769,7 @@ "description": "Account Service Availability object.", "properties": { "available": { - "description": "__Read-only__ A list of services _available_ to your account in the `region`.", + "description": "A list of services _available_ to your account in the `region`.", "example": [ "Linodes", "NodeBalancers" @@ -890,14 +781,14 @@ "type": "array" }, "region": { - "description": "__Read-only__ The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation.", + "description": "The Akamai cloud computing data center (region), represented by a slug value. You can view a full list of regions and their associated slugs with the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation.", "example": "us-east", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "unavailable": { - "description": "__Read-only__ A list of services _unavailable_ to your account in the `region`.", + "description": "A list of services _unavailable_ to your account in the `region`.", "example": [ "Kubernetes", "Block Storage" @@ -910,10 +801,7 @@ "x-linode-cli-display": 3 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/account-availability.yaml" - } + "type": "object" }, "type": "array" } @@ -925,33 +813,27 @@ "description": "An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information.", "properties": { "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/pagination-envelope.yaml" - } + "type": "object" } - ], - "x-akamai": { - "file-path": "schemas/added-get-availability-200.yaml" - } + ] }, "added-get-child-accounts-200": { "additionalProperties": false, @@ -962,14 +844,14 @@ "description": "Child account object.", "properties": { "active_since": { - "description": "__Read-only__ The activation date and time for the child account.", + "description": "The activation date and time for the child account.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "address_1": { - "description": "__Filterable__ First line of this child account's billing address.", + "description": "First line of this child account's billing address.", "example": "123 Main Street", "maxLength": 64, "type": "string", @@ -981,7 +863,7 @@ "x-linode-filterable": true }, "address_2": { - "description": "__Filterable__ Second line of this child account's billing address, if applicable.", + "description": "Second line of this child account's billing address, if applicable.", "example": "Suite A", "maxLength": 64, "type": "string", @@ -993,21 +875,21 @@ "x-linode-filterable": true }, "balance": { - "description": "__Read-only__ This child account's balance, in US dollars.", + "description": "This child account's balance, in US dollars.", "example": 200, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "balance_uninvoiced": { - "description": "__Read-only__ This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", + "description": "This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", "example": 145, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "billing_source": { - "description": "__Read-only__ The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment.", + "description": "The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment.", "enum": [ "external" ], @@ -1016,7 +898,7 @@ "type": "string" }, "capabilities": { - "description": "__Read-only__ A list of the capabilities the child account supports.", + "description": "A list of the capabilities the child account supports.", "example": [ "Linodes", "NodeBalancers", @@ -1030,7 +912,7 @@ "type": "array" }, "city": { - "description": "__Filterable__ The city for this child account's billing address.", + "description": "The city for this child account's billing address.", "example": "San Diego", "maxLength": 24, "type": "string", @@ -1042,7 +924,7 @@ "x-linode-filterable": true }, "company": { - "description": "__Filterable__ The company name for the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`. You can't change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.", + "description": "The company name for the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`. You can't change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.", "example": "Acme", "maxLength": 128, "type": "string", @@ -1054,7 +936,7 @@ "x-linode-filterable": true }, "country": { - "description": "__Filterable__ The two-letter ISO 3166 country code for this child account's billing address.", + "description": "The two-letter ISO 3166 country code for this child account's billing address.", "example": "US", "type": "string", "x-akamai": { @@ -1066,7 +948,7 @@ }, "credit_card": { "additionalProperties": false, - "description": "__Read-only__ Information for the credit card you've assigned to this child account.", + "description": "Information for the credit card you've assigned to this child account.", "properties": { "expiry": { "description": "The expiration month and year of the credit card.", @@ -1083,7 +965,7 @@ "type": "object" }, "email": { - "description": "__Filterable__ The email address of the owner of this child account.", + "description": "The email address of the owner of this child account.", "example": "john.smith@linode.com", "maxLength": 128, "type": "string", @@ -1096,14 +978,14 @@ "x-linode-filterable": true }, "euuid": { - "description": "__Read-only__ An external, unique identifier that Akamai assigned to the child account.", + "description": "An external, unique identifier that Akamai assigned to the child account.", "example": "A1BC2DEF-34GH-567I-J890KLMN12O34P56", "format": "uuid", "readOnly": true, "type": "string" }, "first_name": { - "description": "__Filterable__ The first name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", + "description": "The first name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", "example": "John", "maxLength": 50, "type": "string", @@ -1116,7 +998,7 @@ "x-linode-filterable": true }, "last_name": { - "description": "__Filterable__ The last name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", + "description": "The last name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", "example": "Smith", "maxLength": 50, "type": "string", @@ -1129,7 +1011,7 @@ "x-linode-filterable": true }, "phone": { - "description": "__Filterable__ The phone number for the owner of this child account.", + "description": "The phone number for the owner of this child account.", "example": "858-555-1212", "maxLength": 32, "type": "string", @@ -1141,7 +1023,7 @@ "x-linode-filterable": true }, "state": { - "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", + "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.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", "example": "CA", "maxLength": 24, "type": "string", @@ -1159,7 +1041,7 @@ "type": "string" }, "zip": { - "description": "__Filterable__ The zip code of this Account's billing address. The following restrictions apply:\n\n- Can only contain ASCII letters, numbers, and hyphens (`-`).\n- Can't contain more than 9 letter or number characters.", + "description": "The zip code of this Account's billing address. The following restrictions apply:\n\n- Can only contain ASCII letters, numbers, and hyphens (`-`).\n- Can't contain more than 9 letter or number characters.", "example": "92111-1234", "type": "string", "x-akamai": { @@ -1170,36 +1052,30 @@ "x-linode-filterable": true } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/child-account.yaml" - } + "type": "object" }, "type": "array" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-child-accounts-200.yaml" - } + "type": "object" }, "added-get-clients-200": { "additionalProperties": false, @@ -1210,14 +1086,14 @@ "description": "A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](https://login.linode.com). Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application.", "properties": { "id": { - "description": "__Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", + "description": "The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", "example": "2737bf16b39ab5d7b4a1", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "label": { - "description": "__Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account.", + "description": "The name of this application. This will be presented to users when they are asked to grant it access to their Account.", "example": "Test_Client_1", "maxLength": 512, "minLength": 1, @@ -1232,7 +1108,7 @@ }, "public": { "default": false, - "description": "__Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", + "description": "If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", "example": false, "type": "boolean", "x-akamai": { @@ -1251,13 +1127,13 @@ "x-linode-cli-display": 5 }, "secret": { - "description": "__Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", + "description": "The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", "example": "", "readOnly": true, "type": "string" }, "status": { - "description": "__Read-only__ The status of this application. `active` by default.", + "description": "The status of this application. `active` by default.", "enum": [ "active", "disabled", @@ -1273,7 +1149,7 @@ "x-linode-cli-display": 3 }, "thumbnail_url": { - "description": "__Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", + "description": "The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", "example": "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail", "format": "url", "nullable": true, @@ -1281,36 +1157,30 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/oauth-client.yaml" - } + "type": "object" }, "type": "array" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-clients-200.yaml" - } + "type": "object" }, "added-get-enrolled-beta-programs-200": { "allOf": [ @@ -1319,28 +1189,25 @@ "description": "An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information.", "properties": { "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/pagination-envelope.yaml" - } + "type": "object" }, { "properties": { @@ -1350,7 +1217,7 @@ "description": "An object representing an enrolled Beta Program for the Account.", "properties": { "description": { - "description": "__Read-only__ Additional details regarding the Beta Program.", + "description": "Additional details regarding the Beta Program.", "example": "This is an open public beta for an example feature.", "nullable": true, "readOnly": true, @@ -1358,7 +1225,7 @@ "x-linode-cli-display": 3 }, "ended": { - "description": "__Filterable__, __Read-only__ The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", + "description": "The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", "example": null, "format": "date-time", "nullable": true, @@ -1373,7 +1240,7 @@ "x-linode-filterable": true }, "enrolled": { - "description": "__Filterable__, __Read-only__ The date-time of Account enrollment to the Beta Program.", + "description": "The date-time of Account enrollment to the Beta Program.", "example": "2023-09-11T00:00:00", "format": "date-time", "readOnly": true, @@ -1393,7 +1260,7 @@ "x-linode-cli-display": 1 }, "label": { - "description": "__Filterable__, __Read-only__ The name of the Beta Program.", + "description": "The name of the Beta Program.", "example": "Example Open Beta", "readOnly": true, "type": "string", @@ -1406,7 +1273,7 @@ "x-linode-filterable": true }, "started": { - "description": "__Filterable__, __Read-only__ The start date-time of the Beta Program.", + "description": "The start date-time of the Beta Program.", "example": "2023-07-11T00:00:00", "format": "date-time", "readOnly": true, @@ -1420,20 +1287,14 @@ "x-linode-filterable": true } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/beta-program-enrolled.yaml" - } + "type": "object" }, "type": "array" } }, "type": "object" } - ], - "x-akamai": { - "file-path": "schemas/added-get-enrolled-beta-programs-200.yaml" - } + ] }, "added-get-entity-transfers-200": { "allOf": [ @@ -1442,28 +1303,25 @@ "description": "An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information.", "properties": { "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/pagination-envelope.yaml" - } + "type": "object" }, { "properties": { @@ -1505,7 +1363,7 @@ "x-linode-cli-display": 3 }, "is_sender": { - "description": "__Filterable__ If the requesting account created this transfer.", + "description": "If the requesting account created this transfer.", "example": true, "type": "boolean", "x-akamai": { @@ -1517,7 +1375,7 @@ "x-linode-filterable": true }, "status": { - "description": "__Filterable__ The status of the transfer request:\n\n`accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.\n`canceled`: The transfer has been canceled by the sender.\n`completed`: The transfer has completed successfully.\n`failed`: The transfer has failed after initiation.\n`pending`: The transfer is ready to be accepted.\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.", + "description": "The status of the transfer request:\n\n`accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.\n`canceled`: The transfer has been canceled by the sender.\n`completed`: The transfer has completed successfully.\n`failed`: The transfer has failed after initiation.\n`pending`: The transfer is ready to be accepted.\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.", "enum": [ "accepted", "canceled", @@ -1559,435 +1417,13 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/entity-transfer.yaml" - } + "type": "object" }, "type": "array" } } } - ], - "x-akamai": { - "file-path": "schemas/added-get-entity-transfers-200.yaml" - } - }, - "added-get-events-200": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "additionalProperties": false, - "description": "A collection of Event objects. An Event is an action taken against an entity related to your Account. For example, booting a Linode would create an Event. The Events returned depends on your grants.", - "properties": { - "action": { - "description": "__Filterable__, __Read-only__ The action that caused this Event. New actions may be added in the future.", - "enum": [ - "account_update", - "account_settings_update", - "backups_enable", - "backups_cancel", - "backups_restore", - "community_question_reply", - "community_like", - "credit_card_updated", - "database_create", - "database_delete", - "database_update", - "database_resize", - "database_resize_create", - "database_upgrade", - "database_suspend", - "database_resume", - "disk_create", - "disk_delete", - "disk_update", - "disk_duplicate", - "disk_imagize", - "disk_resize", - "dns_record_create", - "dns_record_delete", - "dns_record_update", - "dns_zone_create", - "dns_zone_delete", - "dns_zone_import", - "dns_zone_update", - "entity_transfer_accept", - "entity_transfer_cancel", - "entity_transfer_create", - "entity_transfer_fail", - "entity_transfer_stale", - "firewall_apply", - "firewall_create", - "firewall_delete", - "firewall_disable", - "firewall_enable", - "firewall_update", - "firewall_device_add", - "firewall_device_remove", - "host_reboot", - "image_delete", - "image_update", - "image_upload", - "interface_create", - "interface_delete", - "interface_update", - "ipaddress_update", - "lassie_reboot", - "lish_boot", - "linode_addip", - "linode_boot", - "linode_clone", - "linode_create", - "linode_delete", - "linode_update", - "linode_deleteip", - "linode_migrate", - "linode_migrate_datacenter", - "linode_migrate_datacenter_create", - "linode_mutate", - "linode_mutate_create", - "linode_reboot", - "linode_rebuild", - "linode_resize", - "linode_resize_create", - "linode_shutdown", - "linode_snapshot", - "linode_config_create", - "linode_config_delete", - "linode_config_update", - "lke_cluster_create", - "lke_cluster_update", - "lke_cluster_delete", - "lke_cluster_recycle", - "lke_cluster_regenerate", - "lke_node_create", - "lke_node_delete", - "lke_node_recycle", - "lke_pool_create", - "lke_pool_delete", - "lke_pool_recycle", - "lke_kubeconfig_regenerate", - "lke_token_rotate", - "longviewclient_create", - "longviewclient_delete", - "longviewclient_update", - "managed_disabled", - "managed_enabled", - "managed_service_create", - "managed_service_delete", - "nodebalancer_create", - "nodebalancer_delete", - "nodebalancer_update", - "nodebalancer_config_create", - "nodebalancer_config_delete", - "nodebalancer_config_update", - "nodebalancer_node_create", - "nodebalancer_node_delete", - "nodebalancer_node_update", - "oauth_client_create", - "oauth_client_delete", - "oauth_client_secret_reset", - "oauth_client_update", - "obj_access_key_create", - "obj_access_key_delete", - "obj_access_key_update", - "password_reset", - "payment_method_add", - "payment_submitted", - "placement_group_assign", - "placement_group_became_compliant", - "placement_group_became_non_compliant", - "placement_group_create", - "placement_group_delete", - "placement_group_unassign", - "placement_group_update", - "profile_update", - "stackscript_create", - "stackscript_delete", - "stackscript_update", - "stackscript_publicize", - "stackscript_revise", - "subnet_create", - "subnet_delete", - "subnet_update", - "tag_create", - "tag_delete", - "tax_id_valid", - "tax_id_invalid", - "tfa_disabled", - "tfa_enabled", - "ticket_attachment_upload", - "ticket_create", - "ticket_update", - "token_create", - "token_delete", - "token_update", - "user_create", - "user_update", - "user_delete", - "user_ssh_key_add", - "user_ssh_key_delete", - "user_ssh_key_update", - "vlan_attach", - "vlan_detach", - "volume_attach", - "volume_clone", - "volume_create", - "volume_delete", - "volume_update", - "volume_detach", - "volume_resize", - "vpc_create", - "vpc_delete", - "vpc_update" - ], - "example": "ticket_create", - "readOnly": true, - "type": "string", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-cli-display": 3, - "x-linode-filterable": true - }, - "created": { - "description": "__Filterable__, __Read-only__ When this Event was created.", - "example": "2018-01-01T00:01:01", - "format": "date-time", - "readOnly": true, - "type": "string", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-cli-display": 6, - "x-linode-filterable": true - }, - "duration": { - "description": "__Read-only__ The total duration in seconds that it takes for the Event to complete.", - "example": 300.56, - "readOnly": true, - "type": "number", - "x-linode-cli-display": 7 - }, - "entity": { - "additionalProperties": false, - "description": "__Read-only__ Detailed information about the Event's entity, including ID, type, label, and URL used to access it.", - "properties": { - "id": { - "description": "__Filterable__ The unique ID for an Event's entity.\n\nSome Event entities do not have IDs associated with them, so they will not be returned when filtering by ID. These Events include:\n\n - `account`\n - `profile`\n\nEntities for some Events are assigned the ID of the Linode they correspond to. When filtering by ID for these Events, use the corresponding Linode's ID. These Events include:\n\n - `disks`\n - `backups`\n\nTag Events use a tag's name for the entity ID field. When filtering by ID for tag Events, supply the name of the tag.", - "example": 11111, - "type": "integer", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-filterable": true - }, - "label": { - "description": "The current label of this object. The label may reflect changes that occur with this Event.", - "example": "Problem booting my Linode", - "type": "string", - "x-linode-cli-display": 5 - }, - "type": { - "description": "__Filterable__, __Read-only__ The type of entity that is being referenced by the Event.", - "enum": [ - "account", - "backups", - "community", - "disks", - "domain", - "entity_transfer", - "firewall", - "image", - "ipaddress", - "linode", - "longview", - "loadbalancer", - "managed_service", - "nodebalancer", - "oauth_client", - "profile", - "stackscript", - "tag", - "ticket", - "token", - "user", - "user_ssh_key", - "volume" - ], - "example": "ticket", - "readOnly": true, - "type": "string", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-filterable": true - }, - "url": { - "description": "The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.", - "example": "/v4/support/tickets/11111", - "type": "string" - } - }, - "readOnly": true, - "type": "object" - }, - "id": { - "description": "__Filterable__, __Read-only__ The unique ID of this Event.", - "example": 123, - "readOnly": true, - "type": "integer", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-cli-display": 1, - "x-linode-filterable": true - }, - "message": { - "description": "Provides additional information about the event. Additional information may include, but is not limited to, a more detailed representation of events which can help diagnose non-obvious failures.", - "example": "None", - "nullable": true, - "type": "string", - "x-linode-cli-display": 9 - }, - "percent_complete": { - "description": "__Read-only__ A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events.", - "example": null, - "nullable": true, - "readOnly": true, - "type": "integer" - }, - "rate": { - "description": "__Read-only__ The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events.", - "example": null, - "nullable": true, - "readOnly": true, - "type": "string" - }, - "read": { - "description": "__Filterable__, __Read-only__ If this Event has been read.", - "example": true, - "readOnly": true, - "type": "boolean", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-filterable": true - }, - "secondary_entity": { - "additionalProperties": false, - "description": "__Read-only__ Detailed information about the Event's secondary entity, which provides additional information for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions.", - "properties": { - "id": { - "description": "The ID of the object that is the secondary entity.", - "example": "linode/debian9", - "type": "string" - }, - "label": { - "description": "The label of this object.", - "example": "linode1234", - "type": "string" - }, - "type": { - "description": "__Read-only__ The type of entity that is being referenced by the Event.", - "example": "linode", - "readOnly": true, - "type": "string" - }, - "url": { - "description": "The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.", - "example": "/v4/linode/instances/1234", - "type": "string" - } - }, - "readOnly": true, - "type": "object" - }, - "seen": { - "description": "__Read-only__ If this Event has been seen.", - "example": true, - "readOnly": true, - "type": "boolean" - }, - "status": { - "description": "__Read-only__ The current status of this Event.", - "enum": [ - "failed", - "finished", - "notification", - "scheduled", - "started" - ], - "readOnly": true, - "type": "string", - "x-linode-cli-color": { - "default_": "white", - "failed": "red", - "finished": "green", - "started": "yellow" - }, - "x-linode-cli-display": 8 - }, - "time_remaining": { - "description": "__Read-only__ The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done.", - "example": null, - "nullable": true, - "readOnly": true, - "type": "string" - }, - "username": { - "description": "__Read-only__ The username of the User who caused the Event.", - "example": "exampleUser", - "nullable": true, - "readOnly": true, - "type": "string", - "x-linode-cli-display": 2 - } - }, - "type": "object", - "x-akamai": { - "file-path": "schemas/event.yaml" - } - }, - "type": "array" - }, - "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", - "example": 1, - "readOnly": true, - "type": "integer" - }, - "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", - "example": 1, - "readOnly": true, - "type": "integer" - }, - "results": { - "description": "__Read-only__ The total number of results.", - "example": 1, - "readOnly": true, - "type": "integer" - } - }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-events-200.yaml" - } + ] }, "added-get-invoice-items-200": { "additionalProperties": false, @@ -1998,14 +1434,14 @@ "description": "An InvoiceItem object.", "properties": { "amount": { - "description": "__Read-only__ The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.", + "description": "The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.", "example": 20.2, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "from": { - "description": "__Read-only__ The date the Invoice Item started, based on month.", + "description": "The date the Invoice Item started, based on month.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -2013,20 +1449,20 @@ "x-linode-cli-display": 2 }, "label": { - "description": "__Read-only__ The Invoice Item's display label.", + "description": "The Invoice Item's display label.", "example": "Linode 123", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "quantity": { - "description": "__Read-only__ The quantity of this Item for the specified Invoice.", + "description": "The quantity of this Item for the specified Invoice.", "example": 4, "readOnly": true, "type": "integer" }, "region": { - "description": "__Read-only__ The ID of the applicable Region associated with this Invoice Item.\n\n`null` if there is no applicable Region.", + "description": "The ID of the applicable Region associated with this Invoice Item.\n\n`null` if there is no applicable Region.", "example": "us-west", "nullable": true, "readOnly": true, @@ -2034,14 +1470,14 @@ "x-linode-cli-display": 7 }, "tax": { - "description": "__Read-only__ The amount of tax levied on this Item in US Dollars.", + "description": "The amount of tax levied on this Item in US Dollars.", "example": 1.25, "readOnly": true, "type": "number", "x-linode-cli-display": 5 }, "to": { - "description": "__Read-only__ The date the Invoice Item ended, based on month.", + "description": "The date the Invoice Item ended, based on month.", "example": "2018-01-31T11:59:59", "format": "date-time", "readOnly": true, @@ -2049,14 +1485,14 @@ "x-linode-cli-display": 3 }, "total": { - "description": "__Read-only__ The price of this Item after taxes in US Dollars.", + "description": "The price of this Item after taxes in US Dollars.", "example": 21.45, "readOnly": true, "type": "number", "x-linode-cli-display": 6 }, "type": { - "description": "__Read-only__ The type of service, ether `hourly` or `misc`.", + "description": "The type of service, ether `hourly` or `misc`.", "enum": [ "hourly", "misc" @@ -2066,42 +1502,36 @@ "type": "string" }, "unit_price": { - "description": "__Read-only__ The monthly service fee in US Dollars for this Item.", + "description": "The monthly service fee in US Dollars for this Item.", "example": 5.05, "readOnly": true, "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/invoice-item.yaml" - } + "type": "object" }, "type": "array" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-invoice-items-200.yaml" - } + "type": "object" }, "added-get-invoices-200": { "additionalProperties": false, @@ -2112,7 +1542,7 @@ "description": "Account Invoice object.", "properties": { "billing_source": { - "description": "__Filterable__, __Read-only__ `akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai.\n\n`linode`: This Invoice was generated according to the default terms, prices, and discounts.", + "description": "`akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai.\n\n`linode`: This Invoice was generated according to the default terms, prices, and discounts.", "enum": [ "akamai", "linode" @@ -2129,7 +1559,7 @@ "x-linode-filterable": true }, "date": { - "description": "__Filterable__, __Read-only__ When this Invoice was generated.", + "description": "When this Invoice was generated.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -2143,14 +1573,14 @@ "x-linode-filterable": true }, "id": { - "description": "__Read-only__ The Invoice's unique ID.", + "description": "The Invoice's unique ID.", "example": 123, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "label": { - "description": "__Filterable__, __Read-only__ The Invoice's display label.", + "description": "The Invoice's display label.", "example": "Invoice", "readOnly": true, "type": "string", @@ -2163,21 +1593,21 @@ "x-linode-filterable": true }, "subtotal": { - "description": "__Read-only__ The amount of the Invoice before taxes in US Dollars.", + "description": "The amount of the Invoice before taxes in US Dollars.", "example": 120.25, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "tax": { - "description": "__Read-only__ The amount of tax levied on the Invoice in US Dollars.", + "description": "The amount of tax levied on the Invoice in US Dollars.", "example": 12.25, "readOnly": true, "type": "number", "x-linode-cli-display": 5 }, "tax_summary": { - "description": "__Read-only__ The amount of tax broken down into subtotals by source.", + "description": "The amount of tax broken down into subtotals by source.", "items": { "additionalProperties": false, "properties": { @@ -2198,7 +1628,7 @@ "type": "array" }, "total": { - "description": "__Filterable__, __Read-only__ The amount of the Invoice after taxes in US Dollars.", + "description": "The amount of the Invoice after taxes in US Dollars.", "example": 132.5, "readOnly": true, "type": "number", @@ -2211,36 +1641,30 @@ "x-linode-filterable": true } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/invoice.yaml" - } + "type": "object" }, "type": "array" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-invoices-200.yaml" - } + "type": "object" }, "added-get-maintenance-200": { "additionalProperties": false, @@ -2283,7 +1707,7 @@ "type": "string" }, "status": { - "description": "__Filterable__ The maintenance status.\n\nMaintenance progresses in the following sequence: pending, started, then completed.", + "description": "The maintenance status.\n\nMaintenance progresses in the following sequence: pending, started, then completed.", "enum": [ "completed", "pending", @@ -2299,7 +1723,7 @@ "x-linode-filterable": true }, "type": { - "description": "__Filterable__ The type of maintenance.", + "description": "The type of maintenance.", "enum": [ "reboot", "cold_migration", @@ -2315,7 +1739,7 @@ "x-linode-filterable": true }, "when": { - "description": "__Filterable__ When the maintenance will begin.\n\n[Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters:\n\n- A single value in date-time string format (`%Y-%m-%dT%H:%M:%S`), which returns only matches to that value.\n\n- A dictionary containing pairs of inequality operator string keys (`+or`, `+gt`, `+gte`, `+lt`, `+lte`, or `+neq`) and single date-time string format values (`%Y-%m-%dT%H:%M:%S`). `+or` accepts an array of values that may consist of single date-time strings or dictionaries of inequality operator pairs.", + "description": "When the maintenance will begin.\n\n[Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters:\n\n- A single value in date-time string format (`%Y-%m-%dT%H:%M:%S`), which returns only matches to that value.\n\n- A dictionary containing pairs of inequality operator string keys (`+or`, `+gt`, `+gte`, `+lt`, `+lte`, or `+neq`) and single date-time string format values (`%Y-%m-%dT%H:%M:%S`). `+or` accepts an array of values that may consist of single date-time strings or dictionaries of inequality operator pairs.", "example": "2020-07-09T00:01:01", "format": "date-time", "type": "string", @@ -2327,36 +1751,30 @@ "x-linode-filterable": true } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/maintenance.yaml" - } + "type": "object" }, "type": "array" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-maintenance-200.yaml" - } + "type": "object" }, "added-get-notifications-200": { "additionalProperties": false, @@ -2367,7 +1785,7 @@ "description": "An important, often time-sensitive item related to your account.", "properties": { "body": { - "description": "__Read-only__ A full description of this notification, in markdown format. Not all notifications include a `body`.", + "description": "A full description of this notification, in markdown format. Not all notifications include a `body`.", "example": null, "nullable": true, "readOnly": true, @@ -2375,7 +1793,7 @@ }, "entity": { "additionalProperties": false, - "description": "__Read-only__ Detailed information about the notification.", + "description": "Detailed information about the notification.", "properties": { "id": { "description": "The unique ID of the notification's entity, based on the entity type. Returns `null` for an `account` or `promotion` entity.", @@ -2416,21 +1834,21 @@ "type": "object" }, "label": { - "description": "__Read-only__ A short description of this notification.", + "description": "A short description of this notification.", "example": "You have an important ticket open!", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "message": { - "description": "__Read-only__ A human-readable description of the notification.", + "description": "A human-readable description of the notification.", "example": "You have an important ticket open!", "readOnly": true, "type": "string", "x-linode-cli-display": 2 }, "severity": { - "description": "__Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text.", + "description": "The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text.", "enum": [ "minor", "major", @@ -2447,7 +1865,7 @@ "x-linode-cli-display": 3 }, "type": { - "description": "__Read-only__ The type of notification.", + "description": "The type of notification.", "enum": [ "migration_scheduled", "migration_imminent", @@ -2467,7 +1885,7 @@ "type": "string" }, "until": { - "description": "__Read-only__ If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window.", + "description": "If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window.", "example": null, "format": "date-time", "nullable": true, @@ -2480,7 +1898,7 @@ "x-linode-cli-display": 5 }, "when": { - "description": "__Read-only__ If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration.", + "description": "If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration.", "example": null, "format": "date-time", "nullable": true, @@ -2493,36 +1911,30 @@ "x-linode-cli-display": 4 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/notification.yaml" - } + "type": "object" }, "type": "array" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-notifications-200.yaml" - } + "type": "object" }, "added-get-payment-methods-200": { "additionalProperties": false, @@ -2533,33 +1945,36 @@ "description": "Payment Method Response Object.", "properties": { "created": { - "description": "__Read-only__ When the Payment Method was added to the Account.", + "description": "When the Payment Method was added to the Account.", "example": "2018-01-15T00:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "data": { + "discriminator": { + "propertyName": "type" + }, "oneOf": [ { "additionalProperties": false, "description": "Credit card information.", "properties": { "card_type": { - "description": "__Read-only__ The type of credit card.", + "description": "The type of credit card.", "example": "Discover", "readOnly": true, "type": "string" }, "expiry": { - "description": "__Read-only__ The expiration month and year of the credit card.", + "description": "The expiration month and year of the credit card.", "example": "06/2022", "format": "MM/YYYY", "readOnly": true, "type": "string" }, "last_four": { - "description": "__Read-only__ The last four digits of the credit card number.", + "description": "The last four digits of the credit card number.", "example": "1234", "readOnly": true, "type": "string" @@ -2567,9 +1982,6 @@ }, "title": "Credit card", "type": "object", - "x-akamai": { - "file-path": "schemas/credit-card-data.yaml" - }, "x-linode-ref-name": "Credit Card" }, { @@ -2577,20 +1989,20 @@ "description": "Google Pay information.", "properties": { "card_type": { - "description": "__Read-only__ The type of credit card.", + "description": "The type of credit card.", "example": "Discover", "readOnly": true, "type": "string" }, "expiry": { - "description": "__Read-only__ The expiration month and year of the credit card.", + "description": "The expiration month and year of the credit card.", "example": "06/2022", "format": "MM/YYYY", "readOnly": true, "type": "string" }, "last_four": { - "description": "__Read-only__ The last four digits of the credit card number.", + "description": "The last four digits of the credit card number.", "example": "1234", "readOnly": true, "type": "string" @@ -2598,9 +2010,6 @@ }, "title": "Google Pay", "type": "object", - "x-akamai": { - "file-path": "schemas/google-pay-data.yaml" - }, "x-linode-ref-name": "Google Pay" }, { @@ -2608,13 +2017,13 @@ "description": "PayPal information.", "properties": { "email": { - "description": "__Read-only__ The email address associated with your PayPal account.", + "description": "The email address associated with your PayPal account.", "example": "example@linode.com", "readOnly": true, "type": "string" }, "paypal_id": { - "description": "__Read-only__ PayPal Merchant ID associated with your PayPal account.", + "description": "PayPal Merchant ID associated with your PayPal account.", "example": "ABC1234567890", "readOnly": true, "type": "string" @@ -2622,9 +2031,6 @@ }, "title": "Paypal", "type": "object", - "x-akamai": { - "file-path": "schemas/paypal-data.yaml" - }, "x-linode-ref-name": "Paypal" } ], @@ -2655,36 +2061,30 @@ "x-linode-cli-display": 2 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/payment-method.yaml" - } + "type": "object" }, "type": "array" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-payment-methods-200.yaml" - } + "type": "object" }, "added-get-payments-200": { "additionalProperties": false, @@ -2695,7 +2095,7 @@ "description": "Payment object response.", "properties": { "date": { - "description": "__Read-only__ When the Payment was made.", + "description": "When the Payment was made.", "example": "2018-01-15T00:01:01", "format": "date-time", "readOnly": true, @@ -2703,50 +2103,44 @@ "x-linode-cli-display": 2 }, "id": { - "description": "__Read-only__ The unique ID of the Payment.", + "description": "The unique ID of the Payment.", "example": 123, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "usd": { - "description": "__Read-only__ The amount, in US dollars, of the Payment.", + "description": "The amount, in US dollars, of the Payment.", "example": "120.50", "readOnly": true, "type": "integer", "x-linode-cli-display": 3 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/payment.yaml" - } + "type": "object" }, "type": "array" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-payments-200.yaml" - } + "type": "object" }, "added-get-service-transfers-200": { "additionalProperties": false, @@ -2789,7 +2183,7 @@ "x-linode-cli-display": 3 }, "is_sender": { - "description": "__Filterable__ If the requesting account created this transfer.", + "description": "If the requesting account created this transfer.", "example": true, "type": "boolean", "x-akamai": { @@ -2801,7 +2195,7 @@ "x-linode-filterable": true }, "status": { - "description": "__Filterable__ The status of the transfer request.\n\n`accepted`: The transfer has been accepted by another user and is currently in progress.\nTransfers can take up to 3 hours to complete.\n\n`canceled`: The transfer has been canceled by the sender.\n\n`completed`: The transfer has completed successfully.\n\n`failed`: The transfer has failed after initiation.\n\n`pending`: The transfer is ready to be accepted.\n\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or\ncanceled.", + "description": "The status of the transfer request.\n\n`accepted`: The transfer has been accepted by another user and is currently in progress.\nTransfers can take up to 3 hours to complete.\n\n`canceled`: The transfer has been canceled by the sender.\n\n`completed`: The transfer has completed successfully.\n\n`failed`: The transfer has failed after initiation.\n\n`pending`: The transfer is ready to be accepted.\n\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or\ncanceled.", "enum": [ "accepted", "canceled", @@ -2843,36 +2237,30 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/service-transfer.yaml" - } + "type": "object" }, "type": "array" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-service-transfers-200.yaml" - } + "type": "object" }, "added-get-user-200": { "allOf": [ @@ -2889,18 +2277,18 @@ }, "last_login": { "additionalProperties": false, - "description": "__Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", + "description": "Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", "nullable": true, "properties": { "login_datetime": { - "description": "__Read-only__ The date and time of this user's most recent login attempt.", + "description": "The date and time of this user's most recent login attempt.", "example": "2018-01-01T01:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "status": { - "description": "__Read-only__ The result of this user's most recent login attempt.", + "description": "The result of this user's most recent login attempt.", "enum": [ "successful", "failed" @@ -2914,7 +2302,7 @@ "type": "object" }, "password_created": { - "description": "__Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", + "description": "When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", "example": "2018-01-01T01:01:01", "format": "date-time", "nullable": true, @@ -2928,7 +2316,7 @@ "x-linode-cli-display": 3 }, "ssh_keys": { - "description": "__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", + "description": "A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", "example": [ "home-pc", "laptop" @@ -2940,13 +2328,13 @@ "type": "array" }, "tfa_enabled": { - "description": "__Read-only__ Whether this 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": "Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", "example": true, "readOnly": true, "type": "boolean" }, "username": { - "description": "__Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", + "description": "The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", "example": "example_user", "maxLength": 32, "minLength": 3, @@ -2961,7 +2349,7 @@ "x-linode-filterable": true }, "verified_phone_number": { - "description": "__Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", + "description": "The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", "example": "+5555555555", "format": "phone", "nullable": true, @@ -2969,17 +2357,14 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/user.yaml" - } + "type": "object" }, { "additionalProperties": false, "description": "The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality.", "properties": { "user_type": { - "description": "__Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include:\n\n- `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.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", + "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:\n\n- `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.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", "enum": [ "parent", "child", @@ -2991,15 +2376,9 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/user-type.yaml" - } + "type": "object" } - ], - "x-akamai": { - "file-path": "schemas/added-get-user-200.yaml" - } + ] }, "added-get-users-200": { "additionalProperties": false, @@ -3020,18 +2399,18 @@ }, "last_login": { "additionalProperties": false, - "description": "__Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", + "description": "Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", "nullable": true, "properties": { "login_datetime": { - "description": "__Read-only__ The date and time of this user's most recent login attempt.", + "description": "The date and time of this user's most recent login attempt.", "example": "2018-01-01T01:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "status": { - "description": "__Read-only__ The result of this user's most recent login attempt.", + "description": "The result of this user's most recent login attempt.", "enum": [ "successful", "failed" @@ -3045,7 +2424,7 @@ "type": "object" }, "password_created": { - "description": "__Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", + "description": "When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", "example": "2018-01-01T01:01:01", "format": "date-time", "nullable": true, @@ -3059,7 +2438,7 @@ "x-linode-cli-display": 3 }, "ssh_keys": { - "description": "__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", + "description": "A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", "example": [ "home-pc", "laptop" @@ -3071,13 +2450,13 @@ "type": "array" }, "tfa_enabled": { - "description": "__Read-only__ Whether this 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": "Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", "example": true, "readOnly": true, "type": "boolean" }, "username": { - "description": "__Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", + "description": "The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", "example": "example_user", "maxLength": 32, "minLength": 3, @@ -3092,7 +2471,7 @@ "x-linode-filterable": true }, "verified_phone_number": { - "description": "__Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", + "description": "The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", "example": "+5555555555", "format": "phone", "nullable": true, @@ -3100,17 +2479,14 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/user.yaml" - } + "type": "object" }, { "additionalProperties": false, "description": "The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality.", "properties": { "user_type": { - "description": "__Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include:\n\n- `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.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", + "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:\n\n- `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.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", "enum": [ "parent", "child", @@ -3122,38 +2498,32 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/user-type.yaml" - } + "type": "object" } ] }, "type": "array" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-get-users-200.yaml" - } + "type": "object" }, "added-post-beta-program": { "additionalProperties": false, @@ -3169,10 +2539,7 @@ "required": [ "id" ], - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-beta-program.yaml" - } + "type": "object" }, "added-post-cancel-account": { "additionalProperties": false, @@ -3183,10 +2550,7 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-cancel-account.yaml" - } + "type": "object" }, "added-post-cancel-account-200": { "additionalProperties": false, @@ -3199,10 +2563,7 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-cancel-account-200.yaml" - } + "type": "object" }, "added-post-cancel-account-409": { "additionalProperties": false, @@ -3222,10 +2583,7 @@ "type": "array" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-cancel-account-409.yaml" - } + "type": "object" }, "added-post-cancel-account-504": { "additionalProperties": false, @@ -3245,10 +2603,7 @@ "type": "array" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-cancel-account-504.yaml" - } + "type": "object" }, "added-post-client": { "allOf": [ @@ -3257,14 +2612,14 @@ "description": "A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](https://login.linode.com). Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application.", "properties": { "id": { - "description": "__Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", + "description": "The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", "example": "2737bf16b39ab5d7b4a1", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "label": { - "description": "__Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account.", + "description": "The name of this application. This will be presented to users when they are asked to grant it access to their Account.", "example": "Test_Client_1", "maxLength": 512, "minLength": 1, @@ -3279,7 +2634,7 @@ }, "public": { "default": false, - "description": "__Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", + "description": "If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", "example": false, "type": "boolean", "x-akamai": { @@ -3298,13 +2653,13 @@ "x-linode-cli-display": 5 }, "secret": { - "description": "__Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", + "description": "The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", "example": "", "readOnly": true, "type": "string" }, "status": { - "description": "__Read-only__ The status of this application. `active` by default.", + "description": "The status of this application. `active` by default.", "enum": [ "active", "disabled", @@ -3320,7 +2675,7 @@ "x-linode-cli-display": 3 }, "thumbnail_url": { - "description": "__Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", + "description": "The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", "example": "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail", "format": "url", "nullable": true, @@ -3328,19 +2683,13 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/oauth-client.yaml" - } + "type": "object" } ], "required": [ "label", "redirect_uri" - ], - "x-akamai": { - "file-path": "schemas/added-post-client.yaml" - } + ] }, "added-post-entity-transfer": { "additionalProperties": false, @@ -3368,16 +2717,13 @@ "required": [ "entities" ], - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-entity-transfer.yaml" - } + "type": "object" }, "added-post-pay-pal-payment-200": { "additionalProperties": false, "properties": { "checkout_token": { - "description": "__Read-only__ The checkout token generated for this Payment.", + "description": "The checkout token generated for this Payment.", "example": "EC-1A2B3C4D5E6F7G8H9", "readOnly": true, "type": "string" @@ -3388,10 +2734,7 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-pay-pal-payment-200.yaml" - } + "type": "object" }, "added-post-payment": { "additionalProperties": false, @@ -3408,10 +2751,7 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-payment.yaml" - } + "type": "object" }, "added-post-payment-method": { "additionalProperties": false, @@ -3458,10 +2798,7 @@ "expiry_year", "cvv" ], - "type": "object", - "x-akamai": { - "file-path": "schemas/credit-card.yaml" - } + "type": "object" }, "is_default": { "description": "Whether this Payment Method is the default method for automatically processing service charges.", @@ -3483,10 +2820,7 @@ "data", "is_default" ], - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-payment-method.yaml" - } + "type": "object" }, "added-post-promo-credit": { "additionalProperties": false, @@ -3501,10 +2835,7 @@ "required": [ "promo_code" ], - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-promo-credit.yaml" - } + "type": "object" }, "added-post-service-transfer": { "additionalProperties": false, @@ -3532,10 +2863,7 @@ "required": [ "entities" ], - "type": "object", - "x-akamai": { - "file-path": "schemas/added-post-service-transfer.yaml" - } + "type": "object" }, "added-post-user": { "allOf": [ @@ -3552,18 +2880,18 @@ }, "last_login": { "additionalProperties": false, - "description": "__Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", + "description": "Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", "nullable": true, "properties": { "login_datetime": { - "description": "__Read-only__ The date and time of this user's most recent login attempt.", + "description": "The date and time of this user's most recent login attempt.", "example": "2018-01-01T01:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "status": { - "description": "__Read-only__ The result of this user's most recent login attempt.", + "description": "The result of this user's most recent login attempt.", "enum": [ "successful", "failed" @@ -3577,7 +2905,7 @@ "type": "object" }, "password_created": { - "description": "__Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", + "description": "When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", "example": "2018-01-01T01:01:01", "format": "date-time", "nullable": true, @@ -3591,7 +2919,7 @@ "x-linode-cli-display": 3 }, "ssh_keys": { - "description": "__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", + "description": "A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", "example": [ "home-pc", "laptop" @@ -3603,13 +2931,13 @@ "type": "array" }, "tfa_enabled": { - "description": "__Read-only__ Whether this 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": "Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", "example": true, "readOnly": true, "type": "boolean" }, "username": { - "description": "__Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", + "description": "The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", "example": "example_user", "maxLength": 32, "minLength": 3, @@ -3624,7 +2952,7 @@ "x-linode-filterable": true }, "verified_phone_number": { - "description": "__Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", + "description": "The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", "example": "+5555555555", "format": "phone", "nullable": true, @@ -3632,19 +2960,13 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/user.yaml" - } + "type": "object" } ], "required": [ "username", "email" - ], - "x-akamai": { - "file-path": "schemas/added-post-user.yaml" - } + ] }, "added-put-user-200": { "allOf": [ @@ -3661,18 +2983,18 @@ }, "last_login": { "additionalProperties": false, - "description": "__Read-only__ Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", + "description": "Details on this user's last login attempt. Returned as `null` if this user hasn't attempted a login since it was created. You can run the [List user logins](https://techdocs.akamai.com/linode-api/reference/get-account-logins) operation for additional login information.", "nullable": true, "properties": { "login_datetime": { - "description": "__Read-only__ The date and time of this user's most recent login attempt.", + "description": "The date and time of this user's most recent login attempt.", "example": "2018-01-01T01:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "status": { - "description": "__Read-only__ The result of this user's most recent login attempt.", + "description": "The result of this user's most recent login attempt.", "enum": [ "successful", "failed" @@ -3686,7 +3008,7 @@ "type": "object" }, "password_created": { - "description": "__Read-only__ When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", + "description": "When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the [Reset Password](https://login.linode.com/forgot/password) webpage. Returned as `null` if this user doesn't have a password set.", "example": "2018-01-01T01:01:01", "format": "date-time", "nullable": true, @@ -3700,7 +3022,7 @@ "x-linode-cli-display": 3 }, "ssh_keys": { - "description": "__Read-only__ A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", + "description": "A list of the labels for SSH keys added by this user. Users can add keys with the [Add an SSH key](https://techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this user is included in the `authorized_users` field of the following requests:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n\n- [Rebuild a Linode](https://techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance)\n\n- [Create a disk](https://techdocs.akamai.com/linode-api/reference/post-add-linode-disk)", "example": [ "home-pc", "laptop" @@ -3712,13 +3034,13 @@ "type": "array" }, "tfa_enabled": { - "description": "__Read-only__ Whether this 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": "Whether this user has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.", "example": true, "readOnly": true, "type": "boolean" }, "username": { - "description": "__Filterable__ The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", + "description": "The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.", "example": "example_user", "maxLength": 32, "minLength": 3, @@ -3733,7 +3055,7 @@ "x-linode-filterable": true }, "verified_phone_number": { - "description": "__Read-only__ The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", + "description": "The [verified](https://techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) phone number for this user profile. Returned as `null` if the user doesn't have a verified phone number.", "example": "+5555555555", "format": "phone", "nullable": true, @@ -3741,17 +3063,14 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/user.yaml" - } + "type": "object" }, { "additionalProperties": false, "description": "The type of user on an account. Mostly applies to the use of the parent and child accounts for Akamai partners functionality.", "properties": { "user_type": { - "description": "__Read-only__ If the user belongs to a [parent or child account](https://www.linode.com/docs/guides/parent-child-accounts/) relationship, this defines the user type in the respective account. Possible values include:\n\n- `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.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", + "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:\n\n- `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.\n\n- `child`. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.\n\n- `proxy`. This is a user on a child account that gives parent account users access to that child account. A parent account user with the `child_account_access` grant can [Create a proxy user token](https://techdocs.akamai.com/linode-api/reference/post-child-account-token) from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.\n\n- `default`. This applies to all regular, non-parent-child account users.", "enum": [ "parent", "child", @@ -3763,15 +3082,9 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/user-type.yaml" - } + "type": "object" } - ], - "x-akamai": { - "file-path": "schemas/added-put-user-200.yaml" - } + ] }, "agreements": { "additionalProperties": false, @@ -3797,17 +3110,14 @@ "type": "boolean" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/agreements.yaml" - } + "type": "object" }, "beta-program-enrolled": { "additionalProperties": false, "description": "An object representing an enrolled Beta Program for the Account.", "properties": { "description": { - "description": "__Read-only__ Additional details regarding the Beta Program.", + "description": "Additional details regarding the Beta Program.", "example": "This is an open public beta for an example feature.", "nullable": true, "readOnly": true, @@ -3815,7 +3125,7 @@ "x-linode-cli-display": 3 }, "ended": { - "description": "__Filterable__, __Read-only__ The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", + "description": "The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", "example": null, "format": "date-time", "nullable": true, @@ -3830,7 +3140,7 @@ "x-linode-filterable": true }, "enrolled": { - "description": "__Filterable__, __Read-only__ The date-time of Account enrollment to the Beta Program.", + "description": "The date-time of Account enrollment to the Beta Program.", "example": "2023-09-11T00:00:00", "format": "date-time", "readOnly": true, @@ -3850,7 +3160,7 @@ "x-linode-cli-display": 1 }, "label": { - "description": "__Filterable__, __Read-only__ The name of the Beta Program.", + "description": "The name of the Beta Program.", "example": "Example Open Beta", "readOnly": true, "type": "string", @@ -3863,7 +3173,7 @@ "x-linode-filterable": true }, "started": { - "description": "__Filterable__, __Read-only__ The start date-time of the Beta Program.", + "description": "The start date-time of the Beta Program.", "example": "2023-07-11T00:00:00", "format": "date-time", "readOnly": true, @@ -3877,24 +3187,21 @@ "x-linode-filterable": true } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/beta-program-enrolled.yaml" - } + "type": "object" }, "child-account": { "additionalProperties": false, "description": "Child account object.", "properties": { "active_since": { - "description": "__Read-only__ The activation date and time for the child account.", + "description": "The activation date and time for the child account.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "address_1": { - "description": "__Filterable__ First line of this child account's billing address.", + "description": "First line of this child account's billing address.", "example": "123 Main Street", "maxLength": 64, "type": "string", @@ -3906,7 +3213,7 @@ "x-linode-filterable": true }, "address_2": { - "description": "__Filterable__ Second line of this child account's billing address, if applicable.", + "description": "Second line of this child account's billing address, if applicable.", "example": "Suite A", "maxLength": 64, "type": "string", @@ -3918,21 +3225,21 @@ "x-linode-filterable": true }, "balance": { - "description": "__Read-only__ This child account's balance, in US dollars.", + "description": "This child account's balance, in US dollars.", "example": 200, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "balance_uninvoiced": { - "description": "__Read-only__ This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", + "description": "This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.", "example": 145, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "billing_source": { - "description": "__Read-only__ The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment.", + "description": "The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of `external` to describe a child account in a parent-child account environment.", "enum": [ "external" ], @@ -3941,7 +3248,7 @@ "type": "string" }, "capabilities": { - "description": "__Read-only__ A list of the capabilities the child account supports.", + "description": "A list of the capabilities the child account supports.", "example": [ "Linodes", "NodeBalancers", @@ -3955,7 +3262,7 @@ "type": "array" }, "city": { - "description": "__Filterable__ The city for this child account's billing address.", + "description": "The city for this child account's billing address.", "example": "San Diego", "maxLength": 24, "type": "string", @@ -3967,7 +3274,7 @@ "x-linode-filterable": true }, "company": { - "description": "__Filterable__ The company name for the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`. You can't change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.", + "description": "The company name for the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`. You can't change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.", "example": "Acme", "maxLength": 128, "type": "string", @@ -3979,7 +3286,7 @@ "x-linode-filterable": true }, "country": { - "description": "__Filterable__ The two-letter ISO 3166 country code for this child account's billing address.", + "description": "The two-letter ISO 3166 country code for this child account's billing address.", "example": "US", "type": "string", "x-akamai": { @@ -3991,7 +3298,7 @@ }, "credit_card": { "additionalProperties": false, - "description": "__Read-only__ Information for the credit card you've assigned to this child account.", + "description": "Information for the credit card you've assigned to this child account.", "properties": { "expiry": { "description": "The expiration month and year of the credit card.", @@ -4008,7 +3315,7 @@ "type": "object" }, "email": { - "description": "__Filterable__ The email address of the owner of this child account.", + "description": "The email address of the owner of this child account.", "example": "john.smith@linode.com", "maxLength": 128, "type": "string", @@ -4021,14 +3328,14 @@ "x-linode-filterable": true }, "euuid": { - "description": "__Read-only__ An external, unique identifier that Akamai assigned to the child account.", + "description": "An external, unique identifier that Akamai assigned to the child account.", "example": "A1BC2DEF-34GH-567I-J890KLMN12O34P56", "format": "uuid", "readOnly": true, "type": "string" }, "first_name": { - "description": "__Filterable__ The first name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", + "description": "The first name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", "example": "John", "maxLength": 50, "type": "string", @@ -4041,7 +3348,7 @@ "x-linode-filterable": true }, "last_name": { - "description": "__Filterable__ The last name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", + "description": "The last name of the owner of this child account. It can't include any of these characters: `<` `>` `(` `)` `\"` `=`.", "example": "Smith", "maxLength": 50, "type": "string", @@ -4054,7 +3361,7 @@ "x-linode-filterable": true }, "phone": { - "description": "__Filterable__ The phone number for the owner of this child account.", + "description": "The phone number for the owner of this child account.", "example": "858-555-1212", "maxLength": 32, "type": "string", @@ -4066,7 +3373,7 @@ "x-linode-filterable": true }, "state": { - "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", + "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.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", "example": "CA", "maxLength": 24, "type": "string", @@ -4084,7 +3391,7 @@ "type": "string" }, "zip": { - "description": "__Filterable__ The zip code of this Account's billing address. The following restrictions apply:\n\n- Can only contain ASCII letters, numbers, and hyphens (`-`).\n- Can't contain more than 9 letter or number characters.", + "description": "The zip code of this Account's billing address. The following restrictions apply:\n\n- Can only contain ASCII letters, numbers, and hyphens (`-`).\n- Can't contain more than 9 letter or number characters.", "example": "92111-1234", "type": "string", "x-akamai": { @@ -4095,10 +3402,7 @@ "x-linode-filterable": true } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/child-account.yaml" - } + "type": "object" }, "credit-card": { "additionalProperties": false, @@ -4141,43 +3445,37 @@ "expiry_year", "cvv" ], - "type": "object", - "x-akamai": { - "file-path": "schemas/credit-card.yaml" - } + "type": "object" }, "credit-card-data": { "additionalProperties": false, "description": "Credit card information.", "properties": { "card_type": { - "description": "__Read-only__ The type of credit card.", + "description": "The type of credit card.", "example": "Discover", "readOnly": true, "type": "string" }, "expiry": { - "description": "__Read-only__ The expiration month and year of the credit card.", + "description": "The expiration month and year of the credit card.", "example": "06/2022", "format": "MM/YYYY", "readOnly": true, "type": "string" }, "last_four": { - "description": "__Read-only__ The last four digits of the credit card number.", + "description": "The last four digits of the credit card number.", "example": "1234", "readOnly": true, "type": "string" } }, "title": "Credit card", - "type": "object", - "x-akamai": { - "file-path": "schemas/credit-card-data.yaml" - } + "type": "object" }, "description": { - "description": "__Read-only__ Additional details regarding the Beta Program.", + "description": "Additional details regarding the Beta Program.", "example": "This is an open public beta for an example feature.", "nullable": true, "readOnly": true, @@ -4185,7 +3483,7 @@ "x-linode-cli-display": 3 }, "ended": { - "description": "__Filterable__, __Read-only__ The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", + "description": "The date-time that the Beta Program ended.\n\n`null` indicates that the Beta Program is ongoing.", "example": null, "format": "date-time", "nullable": true, @@ -4255,7 +3553,7 @@ "x-linode-cli-display": 3 }, "is_sender": { - "description": "__Filterable__ If the requesting account created this transfer.", + "description": "If the requesting account created this transfer.", "example": true, "type": "boolean", "x-akamai": { @@ -4267,7 +3565,7 @@ "x-linode-filterable": true }, "status": { - "description": "__Filterable__ The status of the transfer request:\n\n`accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.\n`canceled`: The transfer has been canceled by the sender.\n`completed`: The transfer has completed successfully.\n`failed`: The transfer has failed after initiation.\n`pending`: The transfer is ready to be accepted.\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.", + "description": "The status of the transfer request:\n\n`accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.\n`canceled`: The transfer has been canceled by the sender.\n`completed`: The transfer has completed successfully.\n`failed`: The transfer has failed after initiation.\n`pending`: The transfer is ready to be accepted.\n`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.", "enum": [ "accepted", "canceled", @@ -4309,10 +3607,7 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/entity-transfer.yaml" - } + "type": "object" }, "error-object": { "additionalProperties": false, @@ -4329,18 +3624,17 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/error-object.yaml" - } + "type": "object" }, "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.", + "description": "A specific event object. An event is an action taken against an entity related to your account. For example, if you boot a Linode, the system creates an event. The events returned depend on your user grants.", "properties": { "action": { - "description": "__Filterable__, __Read-only__ The action that caused this Event. New actions may be added in the future.", + "description": "The action that caused this event. New actions may be added in the future.", "enum": [ + "account_agreement_eu_model", + "account_promo_apply", "account_update", "account_settings_update", "backups_enable", @@ -4348,12 +3642,24 @@ "backups_restore", "community_question_reply", "community_like", + "community_mention", "credit_card_updated", "database_create", "database_delete", "database_update", + "database_failed", + "database_degraded", + "database_create_failed", + "database_update_failed", + "database_backup_create", + "database_backup_restore", + "database_backup_delete", + "database_credentials_reset", + "database_low_disk_space", + "database_scale", "database_resize", "database_resize_create", + "database_migrate", "database_upgrade", "database_suspend", "database_resume", @@ -4371,6 +3677,7 @@ "dns_zone_import", "dns_zone_update", "entity_transfer_accept", + "entity_transfer_accept_recipient", "entity_transfer_cancel", "entity_transfer_create", "entity_transfer_fail", @@ -4383,6 +3690,7 @@ "firewall_update", "firewall_device_add", "firewall_device_remove", + "firewall_rules_update", "host_reboot", "image_delete", "image_update", @@ -4391,6 +3699,8 @@ "interface_delete", "interface_update", "ipaddress_update", + "ipv6pool_add", + "ipv6pool_delete", "lassie_reboot", "lish_boot", "linode_addip", @@ -4400,6 +3710,7 @@ "linode_delete", "linode_update", "linode_deleteip", + "linode_kvmify", "linode_migrate", "linode_migrate_datacenter", "linode_migrate_datacenter_create", @@ -4409,11 +3720,15 @@ "linode_rebuild", "linode_resize", "linode_resize_create", + "linode_resize_warm_create", "linode_shutdown", "linode_snapshot", "linode_config_create", "linode_config_delete", "linode_config_update", + "lke_control_plane_acl_create", + "lke_control_plane_acl_update", + "lke_control_plane_acl_delete", "lke_cluster_create", "lke_cluster_update", "lke_cluster_delete", @@ -4471,6 +3786,7 @@ "subnet_update", "tag_create", "tag_delete", + "tag_update", "tax_id_valid", "tax_id_invalid", "tfa_disabled", @@ -4496,6 +3812,8 @@ "volume_update", "volume_detach", "volume_resize", + "volume_migrate", + "volume_migrate_scheduled", "vpc_create", "vpc_delete", "vpc_update" @@ -4503,30 +3821,18 @@ "example": "ticket_create", "readOnly": true, "type": "string", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-cli-display": 3, - "x-linode-filterable": true + "x-linode-cli-display": 3 }, "created": { - "description": "__Filterable__, __Read-only__ When this Event was created.", + "description": "When the system created this event.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, "type": "string", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-cli-display": 6, - "x-linode-filterable": true + "x-linode-cli-display": 6 }, "duration": { - "description": "__Read-only__ The total duration in seconds that it takes for the Event to complete.", + "description": "The number of seconds that it takes for the event to complete.", "example": 300.56, "readOnly": true, "type": "number", @@ -4534,27 +3840,21 @@ }, "entity": { "additionalProperties": false, - "description": "__Read-only__ Detailed information about the Event's entity, including ID, type, label, and URL used to access it.", + "description": "Detailed information about the entity that triggered this event.", "properties": { "id": { - "description": "__Filterable__ The unique ID for an Event's entity.\n\nSome Event entities do not have IDs associated with them, so they will not be returned when filtering by ID. These Events include:\n\n - `account`\n - `profile`\n\nEntities for some Events are assigned the ID of the Linode they correspond to. When filtering by ID for these Events, use the corresponding Linode's ID. These Events include:\n\n - `disks`\n - `backups`\n\nTag Events use a tag's name for the entity ID field. When filtering by ID for tag Events, supply the name of the tag.", + "description": "The unique identifier assigned to the entity.", "example": 11111, - "type": "integer", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-filterable": true + "type": "integer" }, "label": { - "description": "The current label of this object. The label may reflect changes that occur with this Event.", + "description": "The name of the entity. The label may reflect changes that occur with this event.", "example": "Problem booting my Linode", "type": "string", "x-linode-cli-display": 5 }, "type": { - "description": "__Filterable__, __Read-only__ The type of entity that is being referenced by the Event.", + "description": "The type of entity that is being referenced by the event.", "enum": [ "account", "backups", @@ -4582,16 +3882,10 @@ ], "example": "ticket", "readOnly": true, - "type": "string", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-filterable": true + "type": "string" }, "url": { - "description": "The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.", + "description": "The URL where you can access this event's entity. If it's a relative URL, it's relative to the domain where you retrieved the event.", "example": "/v4/support/tickets/11111", "type": "string" } @@ -4600,73 +3894,61 @@ "type": "object" }, "id": { - "description": "__Filterable__, __Read-only__ The unique ID of this Event.", + "description": "The unique ID of this event.", "example": 123, "readOnly": true, "type": "integer", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-cli-display": 1, - "x-linode-filterable": true + "x-linode-cli-display": 1 }, "message": { - "description": "Provides additional information about the event. Additional information may include, but is not limited to, a more detailed representation of events which can help diagnose non-obvious failures.", + "description": "Additional information about the event. This can be a more detailed representation of an event that can help you diagnose non-obvious failures.", "example": "None", "nullable": true, "type": "string", "x-linode-cli-display": 9 }, "percent_complete": { - "description": "__Read-only__ A percentage estimating the amount of time remaining for an Event. Returns `null` for notification events.", + "description": "A percentage estimating the amount of time remaining for an event. Returned as `null` for notification events.", "example": null, "nullable": true, "readOnly": true, "type": "integer" }, "rate": { - "description": "__Read-only__ The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events.", + "description": "The rate of completion of the event. Only some events return a `rate`, such as the `migration` and `resize` events.", "example": null, "nullable": true, "readOnly": true, "type": "string" }, "read": { - "description": "__Filterable__, __Read-only__ If this Event has been read.", + "description": "If a user on your account has [marked an event as read](https://techdocs.akamai.com/linode-api/reference/post-event-read).", "example": true, "readOnly": true, - "type": "boolean", - "x-akamai": { - "labels": [ - "Filterable" - ] - }, - "x-linode-filterable": true + "type": "boolean" }, "secondary_entity": { "additionalProperties": false, - "description": "__Read-only__ Detailed information about the Event's secondary entity, which provides additional information for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions.", + "description": "Detailed information about the event's secondary entity, if applicable.", "properties": { "id": { - "description": "The ID of the object that is the secondary entity.", + "description": "The identifier for the secondary entity object.", "example": "linode/debian9", "type": "string" }, "label": { - "description": "The label of this object.", + "description": "The name of the secondary entity object.", "example": "linode1234", "type": "string" }, "type": { - "description": "__Read-only__ The type of entity that is being referenced by the Event.", + "description": "The type of secondary entity object that's being referenced by the event.", "example": "linode", "readOnly": true, "type": "string" }, "url": { - "description": "The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.", + "description": "The URL where you can access this event's secondary entity object. If it's a relative URL, it's relative to the domain where you retrieved the event.", "example": "/v4/linode/instances/1234", "type": "string" } @@ -4675,13 +3957,13 @@ "type": "object" }, "seen": { - "description": "__Read-only__ If this Event has been seen.", + "description": "If a user on your account has [marked an event as seen](https://techdocs.akamai.com/linode-api/reference/post-event-seen).", "example": true, "readOnly": true, "type": "boolean" }, "status": { - "description": "__Read-only__ The current status of this Event.", + "description": "The current status of this event.", "enum": [ "failed", "finished", @@ -4700,14 +3982,14 @@ "x-linode-cli-display": 8 }, "time_remaining": { - "description": "__Read-only__ The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done.", + "description": "The estimated time remaining until the event completes. This is only returned for some in-progress migration events. Otherwise, `percent_complete` indicates how long until completion.", "example": null, "nullable": true, "readOnly": true, "type": "string" }, "username": { - "description": "__Read-only__ The username of the User who caused the Event.", + "description": "The name of the user whose action caused the event.", "example": "exampleUser", "nullable": true, "readOnly": true, @@ -4715,258 +3997,656 @@ "x-linode-cli-display": 2 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/event.yaml" - } - }, - "google-pay-data": { - "additionalProperties": false, - "description": "Google Pay information.", - "properties": { - "card_type": { - "description": "__Read-only__ The type of credit card.", - "example": "Discover", - "readOnly": true, - "type": "string" - }, - "expiry": { - "description": "__Read-only__ The expiration month and year of the credit card.", - "example": "06/2022", - "format": "MM/YYYY", - "readOnly": true, - "type": "string" - }, - "last_four": { - "description": "__Read-only__ The last four digits of the credit card number.", - "example": "1234", - "readOnly": true, - "type": "string" - } - }, - "title": "Google Pay", - "type": "object", - "x-akamai": { - "file-path": "schemas/google-pay-data.yaml" - } - }, - "grant": { - "additionalProperties": false, - "description": "Represents the level of access a restricted User has to a specific resource on the Account.", - "properties": { - "id": { - "description": "The ID of the entity this grant applies to.", - "example": 123, - "type": "integer" - }, - "label": { - "description": "__Read-only__ The current label of the entity this grant applies to, for display purposes.", - "example": "example-entity", - "readOnly": true, - "type": "string" - }, - "permissions": { - "description": "The level of access this User has to this entity. If `null`, this User has no access.", - "enum": [ - "read_only", - "read_write" - ], - "example": "read_only", - "nullable": true, - "type": "string" - } - }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grant.yaml" - } + "type": "object" }, - "grants-response": { + "events": { "additionalProperties": false, - "description": "A structure representing all grants a restricted User has on the Account. Not available for unrestricted users, as they have access to everything without grants. If retrieved from the `/profile/grants` endpoint, entities to which a User has no access will be omitted.", "properties": { - "database": { - "description": "The grants this User has for each Database that is owned by this Account.", + "data": { "items": { "additionalProperties": false, - "description": "Represents the level of access a restricted User has to a specific resource on the Account.", "properties": { - "id": { - "description": "The ID of the entity this grant applies to.", - "example": 123, - "type": "integer" - }, - "label": { - "description": "__Read-only__ The current label of the entity this grant applies to, for display purposes.", - "example": "example-entity", - "readOnly": true, - "type": "string" - }, - "permissions": { - "description": "The level of access this User has to this entity. If `null`, this User has no access.", + "action": { + "description": "The action that caused this event. New actions may be added in the future.", "enum": [ - "read_only", - "read_write" + "account_agreement_eu_model", + "account_promo_apply", + "account_update", + "account_settings_update", + "backups_enable", + "backups_cancel", + "backups_restore", + "community_question_reply", + "community_like", + "community_mention", + "credit_card_updated", + "database_create", + "database_delete", + "database_update", + "database_failed", + "database_degraded", + "database_create_failed", + "database_update_failed", + "database_backup_create", + "database_backup_restore", + "database_backup_delete", + "database_credentials_reset", + "database_low_disk_space", + "database_scale", + "database_resize", + "database_resize_create", + "database_migrate", + "database_upgrade", + "database_suspend", + "database_resume", + "disk_create", + "disk_delete", + "disk_update", + "disk_duplicate", + "disk_imagize", + "disk_resize", + "dns_record_create", + "dns_record_delete", + "dns_record_update", + "dns_zone_create", + "dns_zone_delete", + "dns_zone_import", + "dns_zone_update", + "entity_transfer_accept", + "entity_transfer_accept_recipient", + "entity_transfer_cancel", + "entity_transfer_create", + "entity_transfer_fail", + "entity_transfer_stale", + "firewall_apply", + "firewall_create", + "firewall_delete", + "firewall_disable", + "firewall_enable", + "firewall_update", + "firewall_device_add", + "firewall_device_remove", + "firewall_rules_update", + "host_reboot", + "image_delete", + "image_update", + "image_upload", + "interface_create", + "interface_delete", + "interface_update", + "ipaddress_update", + "ipv6pool_add", + "ipv6pool_delete", + "lassie_reboot", + "lish_boot", + "linode_addip", + "linode_boot", + "linode_clone", + "linode_create", + "linode_delete", + "linode_update", + "linode_deleteip", + "linode_kvmify", + "linode_migrate", + "linode_migrate_datacenter", + "linode_migrate_datacenter_create", + "linode_mutate", + "linode_mutate_create", + "linode_reboot", + "linode_rebuild", + "linode_resize", + "linode_resize_create", + "linode_resize_warm_create", + "linode_shutdown", + "linode_snapshot", + "linode_config_create", + "linode_config_delete", + "linode_config_update", + "lke_cluster_create", + "lke_cluster_update", + "lke_cluster_delete", + "lke_cluster_recycle", + "lke_cluster_regenerate", + "lke_control_plane_acl_create", + "lke_control_plane_acl_update", + "lke_control_plane_acl_delete", + "lke_node_create", + "lke_node_delete", + "lke_node_recycle", + "lke_pool_create", + "lke_pool_delete", + "lke_pool_recycle", + "lke_kubeconfig_regenerate", + "lke_token_rotate", + "longviewclient_create", + "longviewclient_delete", + "longviewclient_update", + "managed_disabled", + "managed_enabled", + "managed_service_create", + "managed_service_delete", + "nodebalancer_create", + "nodebalancer_delete", + "nodebalancer_update", + "nodebalancer_config_create", + "nodebalancer_config_delete", + "nodebalancer_config_update", + "nodebalancer_node_create", + "nodebalancer_node_delete", + "nodebalancer_node_update", + "oauth_client_create", + "oauth_client_delete", + "oauth_client_secret_reset", + "oauth_client_update", + "obj_access_key_create", + "obj_access_key_delete", + "obj_access_key_update", + "password_reset", + "payment_method_add", + "payment_submitted", + "placement_group_assign", + "placement_group_became_compliant", + "placement_group_became_non_compliant", + "placement_group_create", + "placement_group_delete", + "placement_group_unassign", + "placement_group_update", + "profile_update", + "stackscript_create", + "stackscript_delete", + "stackscript_update", + "stackscript_publicize", + "stackscript_revise", + "subnet_create", + "subnet_delete", + "subnet_update", + "tag_create", + "tag_delete", + "tag_update", + "tax_id_valid", + "tax_id_invalid", + "tfa_disabled", + "tfa_enabled", + "ticket_attachment_upload", + "ticket_create", + "ticket_update", + "token_create", + "token_delete", + "token_update", + "user_create", + "user_update", + "user_delete", + "user_ssh_key_add", + "user_ssh_key_delete", + "user_ssh_key_update", + "vlan_attach", + "vlan_detach", + "volume_attach", + "volume_clone", + "volume_create", + "volume_delete", + "volume_update", + "volume_detach", + "volume_resize", + "volume_migrate", + "volume_migrate_scheduled", + "vpc_create", + "vpc_delete", + "vpc_update" ], - "example": "read_only", - "nullable": true, - "type": "string" - } - }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grant.yaml" - } - }, - "type": "array" - }, - "domain": { - "description": "The grants this User has for each Domain that is owned by this Account.", - "items": { - "additionalProperties": false, - "description": "Represents the level of access a restricted User has to a specific resource on the Account.", - "properties": { - "id": { - "description": "The ID of the entity this grant applies to.", - "example": 123, - "type": "integer" - }, - "label": { - "description": "__Read-only__ The current label of the entity this grant applies to, for display purposes.", - "example": "example-entity", - "readOnly": true, - "type": "string" + "example": "ticket_create", + "type": "string", + "x-akamai": { + "labels": [ + "Filterable" + ] + }, + "x-linode-cli-display": 3, + "x-linode-filterable": true }, - "permissions": { - "description": "The level of access this User has to this entity. If `null`, this User has no access.", - "enum": [ - "read_only", - "read_write" - ], - "example": "read_only", - "nullable": true, - "type": "string" - } - }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grant.yaml" - } - }, - "type": "array" - }, - "firewall": { - "description": "The grants this User has for each Firewall that is owned by this Account.", - "items": { - "additionalProperties": false, - "description": "Represents the level of access a restricted User has to a specific resource on the Account.", - "properties": { - "id": { - "description": "The ID of the entity this grant applies to.", - "example": 123, - "type": "integer" + "created": { + "description": "When the system created this event.", + "example": "2018-01-01T00:01:01", + "format": "date-time", + "type": "string", + "x-akamai": { + "labels": [ + "Filterable" + ] + }, + "x-linode-cli-display": 6, + "x-linode-filterable": true }, - "label": { - "description": "__Read-only__ The current label of the entity this grant applies to, for display purposes.", - "example": "example-entity", - "readOnly": true, - "type": "string" + "duration": { + "description": "The number of seconds that it takes for the event to complete.", + "example": 300.56, + "type": "number", + "x-linode-cli-display": 7 }, - "permissions": { - "description": "The level of access this User has to this entity. If `null`, this User has no access.", - "enum": [ - "read_only", - "read_write" - ], - "example": "read_only", - "nullable": true, - "type": "string" - } - }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grant.yaml" - } - }, - "type": "array" - }, - "global": { - "additionalProperties": false, - "description": "A structure containing the Account-level grants a User has.", - "properties": { - "account_access": { - "description": "The level of access this User has to Account-level actions, like billing information. A restricted User will never be able to manage users.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this grant can be added to a child account user, to give the user `read-write` access. This gives the child user unrestricted access to expected management operations, such as creating other child users. However, child users don't have write access to billing operations. The API issues a specific error message if a write operation is attempted by a child user.", - "enum": [ - "read_only", - "read_write" - ], + "entity": { + "additionalProperties": false, + "description": "Detailed information about the entity that triggered this event.", + "properties": { + "id": { + "description": "The unique identifier assigned to the entity.\n\n> \ud83d\udcd8\n>\n> Consider these points when filtering by `id`:\n>\n> - The `disks` and `backups` entities use the `id` of their parent Linode when filtering for events.\n>\n> - The `account` and `profile` entities don't have an `id`. To filter these entities, use the `type` object instead.\n>\n> - The `tag` entity uses the tag's name as its `id`. Set this value to the tag's name to filter.", + "example": 11111, + "type": "integer", + "x-akamai": { + "labels": [ + "Filterable" + ] + }, + "x-linode-filterable": true + }, + "label": { + "description": "The name of the entity. The label may reflect changes that occur with this event.", + "example": "Problem booting my Linode", + "type": "string", + "x-linode-cli-display": 5 + }, + "type": { + "description": "The type of entity that is being referenced by the event.", + "enum": [ + "account", + "backups", + "community", + "disks", + "domain", + "entity_transfer", + "firewall", + "image", + "ipaddress", + "linode", + "longview", + "loadbalancer", + "managed_service", + "nodebalancer", + "oauth_client", + "profile", + "stackscript", + "tag", + "ticket", + "token", + "user", + "user_ssh_key", + "volume" + ], + "example": "ticket", + "type": "string", + "x-akamai": { + "labels": [ + "Filterable" + ] + }, + "x-linode-filterable": true + }, + "url": { + "description": "The URL where you can access this event's entity. If it's a relative URL, it's relative to the domain where you retrieved the event.", + "example": "/v4/support/tickets/11111", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique ID of this event.", + "example": 123, + "type": "integer", + "x-akamai": { + "labels": [ + "Filterable" + ] + }, + "x-linode-cli-display": 1, + "x-linode-filterable": true + }, + "message": { + "description": "Additional information about the event. This can be a more detailed representation of an event that can help you diagnose non-obvious failures.", + "example": "None", + "nullable": true, + "type": "string", + "x-linode-cli-display": 9 + }, + "percent_complete": { + "description": "A percentage estimating the amount of time remaining for an event. Returned as `null` for notification events.", + "example": null, + "nullable": true, + "type": "integer" + }, + "rate": { + "description": "The rate of completion of the event. Only some events return a `rate`, such as the `migration` and `resize` events.", + "example": null, + "nullable": true, + "type": "string" + }, + "read": { + "description": "If a user on your account has [marked an event as read](https://techdocs.akamai.com/linode-api/reference/post-event-read).", + "example": true, + "type": "boolean", + "x-akamai": { + "labels": [ + "Filterable" + ] + }, + "x-linode-filterable": true + }, + "secondary_entity": { + "additionalProperties": false, + "description": "Detailed information about the event's secondary entity, if applicable.", + "properties": { + "id": { + "description": "The identifier for the secondary entity object.", + "example": "linode/debian9", + "type": "string" + }, + "label": { + "description": "The name of the secondary entity object.", + "example": "linode1234", + "type": "string" + }, + "type": { + "description": "The type of secondary entity object that's being referenced by the event.", + "example": "linode", + "type": "string" + }, + "url": { + "description": "The URL where you can access this event's secondary entity object. If it's a relative URL, it's relative to the domain where you retrieved the event.", + "example": "/v4/linode/instances/1234", + "type": "string" + } + }, + "type": "object" + }, + "seen": { + "description": "If a user on your account has [marked an event as seen](https://techdocs.akamai.com/linode-api/reference/post-event-seen).", + "example": true, + "type": "boolean" + }, + "status": { + "description": "The current status of this event.", + "enum": [ + "failed", + "finished", + "notification", + "scheduled", + "started" + ], + "type": "string", + "x-linode-cli-color": { + "default_": "white", + "failed": "red", + "finished": "green", + "started": "yellow" + }, + "x-linode-cli-display": 8 + }, + "time_remaining": { + "description": "The estimated time remaining until the event completes. This is only returned for some in-progress migration events. Otherwise, the `percent_complete` attribute indicates how long until completion.", + "example": null, + "nullable": true, + "type": "string" + }, + "username": { + "description": "The name of the user whose action caused the event.", + "example": "exampleUser", + "nullable": true, + "type": "string", + "x-linode-cli-display": 2 + } + }, + "type": "object" + }, + "type": "array" + }, + "page": { + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "example": 1, + "type": "integer" + }, + "pages": { + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "example": 1, + "type": "integer" + }, + "results": { + "description": "The total number of results.", + "example": 1, + "type": "integer" + } + }, + "type": "object" + }, + "google-pay-data": { + "additionalProperties": false, + "description": "Google Pay information.", + "properties": { + "card_type": { + "description": "The type of credit card.", + "example": "Discover", + "readOnly": true, + "type": "string" + }, + "expiry": { + "description": "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.", + "example": "1234", + "readOnly": true, + "type": "string" + } + }, + "title": "Google Pay", + "type": "object" + }, + "grant": { + "additionalProperties": false, + "description": "Represents the level of access a restricted user has to a specific resource on the account.", + "properties": { + "id": { + "description": "The unique identifier of the resource this grant applies to.", + "example": 123, + "type": "integer" + }, + "label": { + "description": "The name of the entity this grant applies to. This is only for display purposes.", + "example": "example-entity", + "readOnly": true, + "type": "string" + }, + "permissions": { + "description": "The level of access this user has to this entity. If `null`, this user has no access.", + "enum": [ + "read_only", + "read_write" + ], + "example": "read_only", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "grants-response": { + "additionalProperties": false, + "properties": { + "database": { + "description": "The grants this user has for individual Managed Databases on this account.", + "items": { + "additionalProperties": false, + "description": "Represents the level of access a restricted user has to a specific resource on the account.", + "properties": { + "id": { + "description": "The unique identifier of the resource this grant applies to.", + "example": 123, + "type": "integer" + }, + "label": { + "description": "The name of the entity this grant applies to. This is only for display purposes.", + "example": "example-entity", + "readOnly": true, + "type": "string" + }, + "permissions": { + "description": "The level of access this user has to this entity. If `null`, this user has no access.", + "enum": [ + "read_only", + "read_write" + ], + "example": "read_only", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "domain": { + "description": "The grants this user has for individual domains on this account.", + "items": { + "additionalProperties": false, + "description": "Represents the level of access a restricted user has to a specific resource on the account.", + "properties": { + "id": { + "description": "The unique identifier of the resource this grant applies to.", + "example": 123, + "type": "integer" + }, + "label": { + "description": "The name of the entity this grant applies to. This is only for display purposes.", + "example": "example-entity", + "readOnly": true, + "type": "string" + }, + "permissions": { + "description": "The level of access this user has to this entity. If `null`, this user has no access.", + "enum": [ + "read_only", + "read_write" + ], + "example": "read_only", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "firewall": { + "description": "The grants this user has for individual firewalls on this account.", + "items": { + "additionalProperties": false, + "description": "Represents the level of access a restricted user has to a specific resource on the account.", + "properties": { + "id": { + "description": "The unique identifier of the resource this grant applies to.", + "example": 123, + "type": "integer" + }, + "label": { + "description": "The name of the entity this grant applies to. This is only for display purposes.", + "example": "example-entity", + "readOnly": true, + "type": "string" + }, + "permissions": { + "description": "The level of access this user has to this entity. If `null`, this user has no access.", + "enum": [ + "read_only", + "read_write" + ], + "example": "read_only", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "global": { + "additionalProperties": false, + "description": "The grants the user has to all resources on your account.", + "properties": { + "account_access": { + "description": "The level of access this user has to account-level actions, like billing information and user management.\n\n> \ud83d\udcd8\n>\n> A `restricted` user can't be used to manage users, even if this is set to `read-write`. Only unrestricted users can manage other users on an account.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this grant can be added to a child account user, to give the user `read-write` access. This gives the child user unrestricted access to expected management operations, such as creating other child users. However, child users don't have write access to billing operations. The API issues a specific error message if a write operation is attempted by a child user.", + "enum": [ + "read_only", + "read_write" + ], "example": "read_only", "nullable": true, "type": "string" }, "add_databases": { - "description": "If `true`, this User may add Managed Databases.", + "description": "Whether this user can add Managed Databases on the account.", "example": true, "type": "boolean" }, "add_domains": { - "description": "If `true`, this User may add Domains.", + "description": "Whether this user can add domains on the account.", "example": true, "type": "boolean" }, "add_firewalls": { - "description": "If `true`, this User may add Firewalls.", + "description": "Whether this user can add Firewalls on the account.", "example": true, "type": "boolean" }, "add_images": { - "description": "If `true`, this User may add Images.", + "description": "Whether this user can create images from disks on your Linodes, on the account.", "example": true, "type": "boolean" }, "add_linodes": { - "description": "If `true`, this User may create Linodes.", + "description": "Whether this user can create Linodes.", "example": true, "type": "boolean" }, "add_longview": { - "description": "If `true`, this User may create Longview clients and view the current plan.", + "description": "Whether this user can create Longview clients and view the current plan.", "example": true, "type": "boolean" }, "add_nodebalancers": { - "description": "If `true`, this User may add NodeBalancers.", + "description": "Whether this user can add NodeBalancers on the account.", "example": true, "type": "boolean" }, "add_stackscripts": { - "description": "If `true`, this User may add StackScripts.", + "description": "Whether this user can add StackScripts on the account.", "example": true, "type": "boolean" }, "add_volumes": { - "description": "If `true`, this User may add Volumes.", + "description": "Whether this user can add volumes on the account.", "example": true, "type": "boolean" }, "add_vpcs": { - "description": "If `true`, this User may add VPCs.", + "description": "Whether this user can add Virtual Private Clouds (VPCs) on the account.", "example": true, "type": "boolean" }, "cancel_account": { - "description": "If `true`, this User may cancel the entire Account.", + "description": "Whether this user can cancel the entire account.", "example": false, "type": "boolean" }, "child_account_access": { - "description": "In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this gives a parent account access to endpoints that can be used to manage child accounts. Unrestricted parent account users have access to this grant, while restricted parent users don't. An unrestricted parent user can set this to `true` to add this grant to a restricted parent user. Displayed as `null` for all non-parent accounts.", + "description": "In a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, this gives a parent account access to operations that can be used to manage child accounts. Unrestricted parent account users have access to this grant, while restricted parent users don't. An unrestricted parent user can set this to `true` to add this grant to a restricted parent user. Displayed as `null` for all non-parent accounts.", "example": true, "nullable": true, "type": "boolean" }, "longview_subscription": { - "description": "If `true`, this User may manage the Account's Longview subscription.", + "description": "Whether this user can manage your account's Longview subscription.", "example": true, "type": "boolean" } @@ -4974,24 +4654,24 @@ "type": "object" }, "image": { - "description": "The grants this User has for each Image that is owned by this Account.", + "description": "The grants this user has for individual images on this account.", "items": { "additionalProperties": false, - "description": "Represents the level of access a restricted User has to a specific resource on the Account.", + "description": "Represents the level of access a restricted user has to a specific resource on the account.", "properties": { "id": { - "description": "The ID of the entity this grant applies to.", + "description": "The unique identifier of the resource this grant applies to.", "example": 123, "type": "integer" }, "label": { - "description": "__Read-only__ The current label of the entity this grant applies to, for display purposes.", + "description": "The name of the entity this grant applies to. This is only 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" @@ -5001,32 +4681,29 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grant.yaml" - } + "type": "object" }, "type": "array" }, "linode": { - "description": "The grants this User has for each Linode that is owned by this Account.", + "description": "The grants this user has for individual Linodes on this account.", "items": { "additionalProperties": false, - "description": "Represents the level of access a restricted User has to a specific resource on the Account.", + "description": "Represents the level of access a restricted user has to a specific resource on the account.", "properties": { "id": { - "description": "The ID of the entity this grant applies to.", + "description": "The unique identifier of the resource this grant applies to.", "example": 123, "type": "integer" }, "label": { - "description": "__Read-only__ The current label of the entity this grant applies to, for display purposes.", + "description": "The name of the entity this grant applies to. This is only 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" @@ -5036,32 +4713,29 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grant.yaml" - } + "type": "object" }, "type": "array" }, "longview": { - "description": "The grants this User has for each Longview Client that is owned by this Account.", + "description": "The grants this user has for individual Longview Clients on this account.", "items": { "additionalProperties": false, - "description": "Represents the level of access a restricted User has to a specific resource on the Account.", + "description": "Represents the level of access a restricted user has to a specific resource on the account.", "properties": { "id": { - "description": "The ID of the entity this grant applies to.", + "description": "The unique identifier of the resource this grant applies to.", "example": 123, "type": "integer" }, "label": { - "description": "__Read-only__ The current label of the entity this grant applies to, for display purposes.", + "description": "The name of the entity this grant applies to. This is only 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" @@ -5071,32 +4745,29 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grant.yaml" - } + "type": "object" }, "type": "array" }, "nodebalancer": { - "description": "The grants this User has for each NodeBalancer that is owned by this Account.", + "description": "The grants this user has for individual NodeBalancers on this account.", "items": { "additionalProperties": false, - "description": "Represents the level of access a restricted User has to a specific resource on the Account.", + "description": "Represents the level of access a restricted user has to a specific resource on the account.", "properties": { "id": { - "description": "The ID of the entity this grant applies to.", + "description": "The unique identifier of the resource this grant applies to.", "example": 123, "type": "integer" }, "label": { - "description": "__Read-only__ The current label of the entity this grant applies to, for display purposes.", + "description": "The name of the entity this grant applies to. This is only 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" @@ -5106,32 +4777,29 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grant.yaml" - } + "type": "object" }, "type": "array" }, "stackscript": { - "description": "The grants this User has for each StackScript that is owned by this Account.", + "description": "The grants this User has for individual StackScripts on this account.", "items": { "additionalProperties": false, - "description": "Represents the level of access a restricted User has to a specific resource on the Account.", + "description": "Represents the level of access a restricted user has to a specific resource on the account.", "properties": { "id": { - "description": "The ID of the entity this grant applies to.", + "description": "The unique identifier of the resource this grant applies to.", "example": 123, "type": "integer" }, "label": { - "description": "__Read-only__ The current label of the entity this grant applies to, for display purposes.", + "description": "The name of the entity this grant applies to. This is only 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" @@ -5141,32 +4809,29 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grant.yaml" - } + "type": "object" }, "type": "array" }, "volume": { - "description": "The grants this User has for each Block Storage Volume that is owned by this Account.", + "description": "The grants this user has individual Block Storage Volumes on this account.", "items": { "additionalProperties": false, - "description": "Represents the level of access a restricted User has to a specific resource on the Account.", + "description": "Represents the level of access a restricted user has to a specific resource on the account.", "properties": { "id": { - "description": "The ID of the entity this grant applies to.", + "description": "The unique identifier of the resource this grant applies to.", "example": 123, "type": "integer" }, "label": { - "description": "__Read-only__ The current label of the entity this grant applies to, for display purposes.", + "description": "The name of the entity this grant applies to. This is only 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" @@ -5176,32 +4841,29 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grant.yaml" - } + "type": "object" }, "type": "array" }, "vpc": { - "description": "The grants this User has for each VPC that is owned by this Account.", + "description": "The grants this user has individual Virtual Private Clouds (VPCs) on this account.", "items": { "additionalProperties": false, - "description": "Represents the level of access a restricted User has to a specific resource on the Account.", + "description": "Represents the level of access a restricted user has to a specific resource on the account.", "properties": { "id": { - "description": "The ID of the entity this grant applies to.", + "description": "The unique identifier of the resource this grant applies to.", "example": 123, "type": "integer" }, "label": { - "description": "__Read-only__ The current label of the entity this grant applies to, for display purposes.", + "description": "The name of the entity this grant applies to. This is only 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" @@ -5211,18 +4873,12 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grant.yaml" - } + "type": "object" }, "type": "array" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/grants-response.yaml" - } + "type": "object" }, "id": { "description": "The unique identifier of the Beta Program.", @@ -5235,7 +4891,7 @@ "description": "Account Invoice object.", "properties": { "billing_source": { - "description": "__Filterable__, __Read-only__ `akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai.\n\n`linode`: This Invoice was generated according to the default terms, prices, and discounts.", + "description": "`akamai`: This Invoice was generated according to the terms of an agreement between the customer and Akamai.\n\n`linode`: This Invoice was generated according to the default terms, prices, and discounts.", "enum": [ "akamai", "linode" @@ -5252,7 +4908,7 @@ "x-linode-filterable": true }, "date": { - "description": "__Filterable__, __Read-only__ When this Invoice was generated.", + "description": "When this Invoice was generated.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -5266,14 +4922,14 @@ "x-linode-filterable": true }, "id": { - "description": "__Read-only__ The Invoice's unique ID.", + "description": "The Invoice's unique ID.", "example": 123, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "label": { - "description": "__Filterable__, __Read-only__ The Invoice's display label.", + "description": "The Invoice's display label.", "example": "Invoice", "readOnly": true, "type": "string", @@ -5286,21 +4942,21 @@ "x-linode-filterable": true }, "subtotal": { - "description": "__Read-only__ The amount of the Invoice before taxes in US Dollars.", + "description": "The amount of the Invoice before taxes in US Dollars.", "example": 120.25, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "tax": { - "description": "__Read-only__ The amount of tax levied on the Invoice in US Dollars.", + "description": "The amount of tax levied on the Invoice in US Dollars.", "example": 12.25, "readOnly": true, "type": "number", "x-linode-cli-display": 5 }, "tax_summary": { - "description": "__Read-only__ The amount of tax broken down into subtotals by source.", + "description": "The amount of tax broken down into subtotals by source.", "items": { "additionalProperties": false, "properties": { @@ -5321,7 +4977,7 @@ "type": "array" }, "total": { - "description": "__Filterable__, __Read-only__ The amount of the Invoice after taxes in US Dollars.", + "description": "The amount of the Invoice after taxes in US Dollars.", "example": 132.5, "readOnly": true, "type": "number", @@ -5334,24 +4990,21 @@ "x-linode-filterable": true } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/invoice.yaml" - } + "type": "object" }, "invoice-item": { "additionalProperties": false, "description": "An InvoiceItem object.", "properties": { "amount": { - "description": "__Read-only__ The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.", + "description": "The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.", "example": 20.2, "readOnly": true, "type": "number", "x-linode-cli-display": 4 }, "from": { - "description": "__Read-only__ The date the Invoice Item started, based on month.", + "description": "The date the Invoice Item started, based on month.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -5359,20 +5012,20 @@ "x-linode-cli-display": 2 }, "label": { - "description": "__Read-only__ The Invoice Item's display label.", + "description": "The Invoice Item's display label.", "example": "Linode 123", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "quantity": { - "description": "__Read-only__ The quantity of this Item for the specified Invoice.", + "description": "The quantity of this Item for the specified Invoice.", "example": 4, "readOnly": true, "type": "integer" }, "region": { - "description": "__Read-only__ The ID of the applicable Region associated with this Invoice Item.\n\n`null` if there is no applicable Region.", + "description": "The ID of the applicable Region associated with this Invoice Item.\n\n`null` if there is no applicable Region.", "example": "us-west", "nullable": true, "readOnly": true, @@ -5380,14 +5033,14 @@ "x-linode-cli-display": 7 }, "tax": { - "description": "__Read-only__ The amount of tax levied on this Item in US Dollars.", + "description": "The amount of tax levied on this Item in US Dollars.", "example": 1.25, "readOnly": true, "type": "number", "x-linode-cli-display": 5 }, "to": { - "description": "__Read-only__ The date the Invoice Item ended, based on month.", + "description": "The date the Invoice Item ended, based on month.", "example": "2018-01-31T11:59:59", "format": "date-time", "readOnly": true, @@ -5395,14 +5048,14 @@ "x-linode-cli-display": 3 }, "total": { - "description": "__Read-only__ The price of this Item after taxes in US Dollars.", + "description": "The price of this Item after taxes in US Dollars.", "example": 21.45, "readOnly": true, "type": "number", "x-linode-cli-display": 6 }, "type": { - "description": "__Read-only__ The type of service, ether `hourly` or `misc`.", + "description": "The type of service, ether `hourly` or `misc`.", "enum": [ "hourly", "misc" @@ -5412,16 +5065,13 @@ "type": "string" }, "unit_price": { - "description": "__Read-only__ The monthly service fee in US Dollars for this Item.", + "description": "The monthly service fee in US Dollars for this Item.", "example": 5.05, "readOnly": true, "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/invoice-item.yaml" - } + "type": "object" }, "is_default": { "description": "Whether this Payment Method is the default method for automatically processing service charges.", @@ -5430,7 +5080,7 @@ "x-linode-cli-display": 3 }, "label": { - "description": "__Filterable__, __Read-only__ The name of the Beta Program.", + "description": "The name of the Beta Program.", "example": "Example Open Beta", "readOnly": true, "type": "string", @@ -5447,7 +5097,7 @@ "description": "An object representing a previous successful login for a User.", "properties": { "datetime": { - "description": "__Read-only__ When the login was initiated.", + "description": "When the login was initiated.", "example": "2018-01-01T00:01:01", "format": "date-time", "readOnly": true, @@ -5455,14 +5105,14 @@ "x-linode-cli-display": 2 }, "id": { - "description": "__Read-only__ The unique ID of this login object.", + "description": "The unique ID of this login object.", "example": 1234, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "ip": { - "description": "__Read-only__ The remote IP address that requested the login.", + "description": "The remote IP address that requested the login.", "example": "192.0.2.0", "format": "ip", "readOnly": true, @@ -5470,14 +5120,14 @@ "x-linode-cli-display": 3 }, "restricted": { - "description": "__Read-only__ True if the User that attempted the login was a restricted User, false otherwise.", + "description": "True if the User that attempted the login was a restricted User, false otherwise.", "example": true, "readOnly": true, "type": "boolean", "x-linode-cli-display": 6 }, "status": { - "description": "__Read-only__ Whether the login attempt succeeded or failed.", + "description": "Whether the login attempt succeeded or failed.", "enum": [ "successful", "failed" @@ -5488,17 +5138,14 @@ "x-linode-cli-display": 5 }, "username": { - "description": "__Read-only__ The username of the User that attempted the login.", + "description": "The username of the User that attempted the login.", "example": "example_user", "readOnly": true, "type": "string", "x-linode-cli-display": 4 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/login.yaml" - } + "type": "object" }, "maintenance": { "additionalProperties": false, @@ -5537,7 +5184,7 @@ "type": "string" }, "status": { - "description": "__Filterable__ The maintenance status.\n\nMaintenance progresses in the following sequence: pending, started, then completed.", + "description": "The maintenance status.\n\nMaintenance progresses in the following sequence: pending, started, then completed.", "enum": [ "completed", "pending", @@ -5553,7 +5200,7 @@ "x-linode-filterable": true }, "type": { - "description": "__Filterable__ The type of maintenance.", + "description": "The type of maintenance.", "enum": [ "reboot", "cold_migration", @@ -5569,7 +5216,7 @@ "x-linode-filterable": true }, "when": { - "description": "__Filterable__ When the maintenance will begin.\n\n[Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters:\n\n- A single value in date-time string format (`%Y-%m-%dT%H:%M:%S`), which returns only matches to that value.\n\n- A dictionary containing pairs of inequality operator string keys (`+or`, `+gt`, `+gte`, `+lt`, `+lte`, or `+neq`) and single date-time string format values (`%Y-%m-%dT%H:%M:%S`). `+or` accepts an array of values that may consist of single date-time strings or dictionaries of inequality operator pairs.", + "description": "When the maintenance will begin.\n\n[Filterable](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) with the following parameters:\n\n- A single value in date-time string format (`%Y-%m-%dT%H:%M:%S`), which returns only matches to that value.\n\n- A dictionary containing pairs of inequality operator string keys (`+or`, `+gt`, `+gte`, `+lt`, `+lte`, or `+neq`) and single date-time string format values (`%Y-%m-%dT%H:%M:%S`). `+or` accepts an array of values that may consist of single date-time strings or dictionaries of inequality operator pairs.", "example": "2020-07-09T00:01:01", "format": "date-time", "type": "string", @@ -5581,17 +5228,14 @@ "x-linode-filterable": true } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/maintenance.yaml" - } + "type": "object" }, "notification": { "additionalProperties": false, "description": "An important, often time-sensitive item related to your account.", "properties": { "body": { - "description": "__Read-only__ A full description of this notification, in markdown format. Not all notifications include a `body`.", + "description": "A full description of this notification, in markdown format. Not all notifications include a `body`.", "example": null, "nullable": true, "readOnly": true, @@ -5599,7 +5243,7 @@ }, "entity": { "additionalProperties": false, - "description": "__Read-only__ Detailed information about the notification.", + "description": "Detailed information about the notification.", "properties": { "id": { "description": "The unique ID of the notification's entity, based on the entity type. Returns `null` for an `account` or `promotion` entity.", @@ -5640,21 +5284,21 @@ "type": "object" }, "label": { - "description": "__Read-only__ A short description of this notification.", + "description": "A short description of this notification.", "example": "You have an important ticket open!", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "message": { - "description": "__Read-only__ A human-readable description of the notification.", + "description": "A human-readable description of the notification.", "example": "You have an important ticket open!", "readOnly": true, "type": "string", "x-linode-cli-display": 2 }, "severity": { - "description": "__Read-only__ The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text.", + "description": "The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text.", "enum": [ "minor", "major", @@ -5671,7 +5315,7 @@ "x-linode-cli-display": 3 }, "type": { - "description": "__Read-only__ The type of notification.", + "description": "The type of notification.", "enum": [ "migration_scheduled", "migration_imminent", @@ -5691,7 +5335,7 @@ "type": "string" }, "until": { - "description": "__Read-only__ If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window.", + "description": "If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, `until` represents the end of the maintenance window.", "example": null, "format": "date-time", "nullable": true, @@ -5704,7 +5348,7 @@ "x-linode-cli-display": 5 }, "when": { - "description": "__Read-only__ If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration.", + "description": "If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration.", "example": null, "format": "date-time", "nullable": true, @@ -5717,24 +5361,21 @@ "x-linode-cli-display": 4 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/notification.yaml" - } + "type": "object" }, "oauth-client": { "additionalProperties": false, "description": "A third-party application registered to Linode that users may log into with their Linode account through our authentication server at [login.linode.com](https://login.linode.com). Using an OAuth Client, a third-party developer may be given access to some, or all, of a User's account for the purposes of their application.", "properties": { "id": { - "description": "__Read-only__ The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", + "description": "The OAuth Client ID. This is used to identify the client, and is a publicly known value (it is not a secret).", "example": "2737bf16b39ab5d7b4a1", "readOnly": true, "type": "string", "x-linode-cli-display": 1 }, "label": { - "description": "__Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account.", + "description": "The name of this application. This will be presented to users when they are asked to grant it access to their Account.", "example": "Test_Client_1", "maxLength": 512, "minLength": 1, @@ -5749,7 +5390,7 @@ }, "public": { "default": false, - "description": "__Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", + "description": "If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](https://oauth.net/2/) for more details.", "example": false, "type": "boolean", "x-akamai": { @@ -5768,13 +5409,13 @@ "x-linode-cli-display": 5 }, "secret": { - "description": "__Read-only__ The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", + "description": "The OAuth Client secret, used in the OAuth exchange. This is returned as `` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.", "example": "", "readOnly": true, "type": "string" }, "status": { - "description": "__Read-only__ The status of this application. `active` by default.", + "description": "The status of this application. `active` by default.", "enum": [ "active", "disabled", @@ -5790,7 +5431,7 @@ "x-linode-cli-display": 3 }, "thumbnail_url": { - "description": "__Read-only__ The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", + "description": "The URL where this client's thumbnail may be viewed, or `null` if this client does not have a thumbnail set.", "example": "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail", "format": "url", "nullable": true, @@ -5798,19 +5439,16 @@ "type": "string" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/oauth-client.yaml" - } + "type": "object" }, "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" @@ -5820,35 +5458,32 @@ "description": "An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information.", "properties": { "page": { - "description": "__Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The current [page](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "pages": { - "description": "__Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", + "description": "The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination).", "example": 1, "readOnly": true, "type": "integer" }, "results": { - "description": "__Read-only__ The total number of results.", + "description": "The total number of results.", "example": 1, "readOnly": true, "type": "integer" } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/pagination-envelope.yaml" - } + "type": "object" }, "payment": { "additionalProperties": false, "description": "Payment object response.", "properties": { "date": { - "description": "__Read-only__ When the Payment was made.", + "description": "When the Payment was made.", "example": "2018-01-15T00:01:01", "format": "date-time", "readOnly": true, @@ -5856,57 +5491,57 @@ "x-linode-cli-display": 2 }, "id": { - "description": "__Read-only__ The unique ID of the Payment.", + "description": "The unique ID of the Payment.", "example": 123, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "usd": { - "description": "__Read-only__ The amount, in US dollars, of the Payment.", + "description": "The amount, in US dollars, of the Payment.", "example": "120.50", "readOnly": true, "type": "integer", "x-linode-cli-display": 3 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/payment.yaml" - } + "type": "object" }, "payment-method": { "additionalProperties": false, "description": "Payment Method Response Object.", "properties": { "created": { - "description": "__Read-only__ When the Payment Method was added to the Account.", + "description": "When the Payment Method was added to the Account.", "example": "2018-01-15T00:01:01", "format": "date-time", "readOnly": true, "type": "string" }, "data": { + "discriminator": { + "propertyName": "type" + }, "oneOf": [ { "additionalProperties": false, "description": "Credit card information.", "properties": { "card_type": { - "description": "__Read-only__ The type of credit card.", + "description": "The type of credit card.", "example": "Discover", "readOnly": true, "type": "string" }, "expiry": { - "description": "__Read-only__ The expiration month and year of the credit card.", + "description": "The expiration month and year of the credit card.", "example": "06/2022", "format": "MM/YYYY", "readOnly": true, "type": "string" }, "last_four": { - "description": "__Read-only__ The last four digits of the credit card number.", + "description": "The last four digits of the credit card number.", "example": "1234", "readOnly": true, "type": "string" @@ -5914,9 +5549,6 @@ }, "title": "Credit card", "type": "object", - "x-akamai": { - "file-path": "schemas/credit-card-data.yaml" - }, "x-linode-ref-name": "Credit Card" }, { @@ -5924,20 +5556,20 @@ "description": "Google Pay information.", "properties": { "card_type": { - "description": "__Read-only__ The type of credit card.", + "description": "The type of credit card.", "example": "Discover", "readOnly": true, "type": "string" }, "expiry": { - "description": "__Read-only__ The expiration month and year of the credit card.", + "description": "The expiration month and year of the credit card.", "example": "06/2022", "format": "MM/YYYY", "readOnly": true, "type": "string" }, "last_four": { - "description": "__Read-only__ The last four digits of the credit card number.", + "description": "The last four digits of the credit card number.", "example": "1234", "readOnly": true, "type": "string" @@ -5945,9 +5577,6 @@ }, "title": "Google Pay", "type": "object", - "x-akamai": { - "file-path": "schemas/google-pay-data.yaml" - }, "x-linode-ref-name": "Google Pay" }, { @@ -5955,13 +5584,13 @@ "description": "PayPal information.", "properties": { "email": { - "description": "__Read-only__ The email address associated with your PayPal account.", + "description": "The email address associated with your PayPal account.", "example": "example@linode.com", "readOnly": true, "type": "string" }, "paypal_id": { - "description": "__Read-only__ PayPal Merchant ID associated with your PayPal account.", + "description": "PayPal Merchant ID associated with your PayPal account.", "example": "ABC1234567890", "readOnly": true, "type": "string" @@ -5969,9 +5598,6 @@ }, "title": "Paypal", "type": "object", - "x-akamai": { - "file-path": "schemas/paypal-data.yaml" - }, "x-linode-ref-name": "Paypal" } ], @@ -6002,10 +5628,7 @@ "x-linode-cli-display": 2 } }, - "type": "object", - "x-akamai": { - "file-path": "schemas/payment-method.yaml" - } + "type": "object" }, "paypal": { "additionalProperties": false, @@ -6032,33 +5655,27 @@ "redirect_url", "usd" ], - "type": "object", - "x-akamai": { - "file-path": "schemas/paypal.yaml" - } + "type": "object" }, "paypal-data": { "additionalProperties": false, "description": "PayPal information.", "properties": { "email": { - "description": "__Read-only__ The email address associated with your PayPal account.", + "description": "The email address associated with your PayPal account.", "example": "example@linode.com", "readOnly": true, "type": "string" }, "paypal_id": { - "description": "__Read-only__ PayPal Merchant ID associated with your PayPal account.", + "description": "PayPal Merchant ID associated with your PayPal account.", "example": "ABC1234567890", "readOnly": true, "type": "string" } }, "title": "Paypal", - "type": "object", - "x-akamai": { - "file-path": "schemas/paypal-data.yaml" - } + "type": "object" }, "paypal-execute": { "additionalProperties": false, @@ -6079,14 +5696,11 @@ "payer_id", "payment_id" ], - "type": "object", - "x-akamai": { - "file-path": "schemas/paypal-execute.yaml" - } + "type": "object" }, "promotion": { "additionalProperties": false, - "description": "__Read-only__ Promotions generally offer a set amount of credit that can be used toward your Linode services, and the promotion expires after a specified date. As well, a monthly cap on the promotional offer is set.\n\nSimply 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.", + "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.\n\nSimply put, a promotion offers a certain amount of credit month, until either the expiration date is passed, or until the total promotional credit is used, whichever comes first.", "properties": { "credit_monthly_cap": { "description": "The amount available to spend per month.", @@ -6152,10 +5766,7 @@ } }, "readOnly": true, - "type": "object", - "x-akamai": { - "file-path": "schemas/promotion.yaml" - } + "type": "object" }, "properties-entities": { "additionalProperties": false, @@ -6181,7 +5792,7 @@ "description": "The token generated manually for a child account so its proxy user can access the API and CLI without going through an OAuth login.", "properties": { "created": { - "description": "__Filterable__, __Read-only__ The date and time this token was created.", + "description": "The date and time this token was created.", "example": "2024-05-01T00:01:01", "format": "date-time", "readOnly": true, @@ -6195,7 +5806,7 @@ "x-linode-filterable": true }, "expiry": { - "description": "__Read-only__ When this token expires. This is default set to 15 minutes from the time of creation. Proxy user tokens can't be renewed. After this time, Akamai revokes the token and you need to generate a new one.", + "description": "When this token expires. This is default set to 15 minutes from the time of creation. Proxy user tokens can't be renewed. After this time, Akamai revokes the token and you need to generate a new one.", "example": "2024-05-01T00:16:01", "format": "date-time", "readOnly": true, @@ -6203,14 +5814,14 @@ "x-linode-cli-display": 6 }, "id": { - "description": "__Read-only__ The proxy user token's unique ID, which can be used to revoke it.", + "description": "The proxy user token's unique ID, which can be used to revoke it.", "example": 918, "readOnly": true, "type": "integer", "x-linode-cli-display": 1 }, "label": { - "description": "__Filterable__ The name of the token. The API automatically sets this to `__