diff --git a/providers/src/linode/v00.00.00000/provider.yaml b/providers/src/linode/v00.00.00000/provider.yaml index 74ab27cb..d7d70509 100644 --- a/providers/src/linode/v00.00.00000/provider.yaml +++ b/providers/src/linode/v00.00.00000/provider.yaml @@ -3,159 +3,186 @@ name: linode version: v00.00.00000 providerServices: account: - description: Account - id: 'account:v00.00.00000' + id: account:v00.00.00000 name: account preferred: true service: $ref: linode/v00.00.00000/services/account.yaml - title: Linode API - Account + title: account API version: v00.00.00000 + description: linode account API + betas: + id: betas:v00.00.00000 + name: betas + preferred: true + service: + $ref: linode/v00.00.00000/services/betas.yaml + title: betas API + version: v00.00.00000 + description: linode betas API databases: - description: Databases - id: 'databases:v00.00.00000' + id: databases:v00.00.00000 name: databases preferred: true service: $ref: linode/v00.00.00000/services/databases.yaml - title: Linode API - Databases + title: databases API version: v00.00.00000 + description: linode databases API domains: - description: Domains - id: 'domains:v00.00.00000' + id: domains:v00.00.00000 name: domains preferred: true service: $ref: linode/v00.00.00000/services/domains.yaml - title: Linode API - Domains + title: domains API version: v00.00.00000 + description: linode domains API images: - description: Images - id: 'images:v00.00.00000' + id: images:v00.00.00000 name: images preferred: true service: $ref: linode/v00.00.00000/services/images.yaml - title: Linode API - Images + title: images API version: v00.00.00000 - instances: - description: Linode - id: 'instances:v00.00.00000' - name: instances + description: linode images API + linode: + id: linode:v00.00.00000 + name: linode preferred: true service: - $ref: linode/v00.00.00000/services/instances.yaml - title: Linode API - Instances + $ref: linode/v00.00.00000/services/linode.yaml + title: linode API version: v00.00.00000 + description: linode linode API lke: - description: Lke - id: 'lke:v00.00.00000' + id: lke:v00.00.00000 name: lke preferred: true service: $ref: linode/v00.00.00000/services/lke.yaml - title: Linode API - Lke + title: lke API version: v00.00.00000 + description: linode lke API longview: - description: Longview - id: 'longview:v00.00.00000' + id: longview:v00.00.00000 name: longview preferred: true service: $ref: linode/v00.00.00000/services/longview.yaml - title: Linode API - Longview + title: longview API version: v00.00.00000 + description: linode longview API managed: - description: Managed - id: 'managed:v00.00.00000' + id: managed:v00.00.00000 name: managed preferred: true service: $ref: linode/v00.00.00000/services/managed.yaml - title: Linode API - Managed + title: managed API version: v00.00.00000 + description: linode managed API + monitor: + id: monitor:v00.00.00000 + name: monitor + preferred: true + service: + $ref: linode/v00.00.00000/services/monitor.yaml + title: monitor API + version: v00.00.00000 + description: linode monitor API networking: - description: Networking - id: 'networking:v00.00.00000' + id: networking:v00.00.00000 name: networking preferred: true service: $ref: linode/v00.00.00000/services/networking.yaml - title: Linode API - Networking + title: networking API version: v00.00.00000 + description: linode networking API nodebalancers: - description: Nodebalancers - id: 'nodebalancers:v00.00.00000' + id: nodebalancers:v00.00.00000 name: nodebalancers preferred: true service: $ref: linode/v00.00.00000/services/nodebalancers.yaml - title: Linode API - Nodebalancers + title: nodebalancers API version: v00.00.00000 + description: linode nodebalancers API object_storage: - description: Object Storage - id: 'object_storage:v00.00.00000' + id: object_storage:v00.00.00000 name: object_storage preferred: true service: $ref: linode/v00.00.00000/services/object_storage.yaml - title: Linode API - Object Storage + title: object_storage API + version: v00.00.00000 + description: linode object_storage API + placement: + id: placement:v00.00.00000 + name: placement + preferred: true + service: + $ref: linode/v00.00.00000/services/placement.yaml + title: placement API version: v00.00.00000 + description: linode placement API profile: - description: Profile - id: 'profile:v00.00.00000' + id: profile:v00.00.00000 name: profile preferred: true service: $ref: linode/v00.00.00000/services/profile.yaml - title: Linode API - Profile + title: profile API version: v00.00.00000 + description: linode profile API regions: - description: Regions - id: 'regions:v00.00.00000' + id: regions:v00.00.00000 name: regions preferred: true service: $ref: linode/v00.00.00000/services/regions.yaml - title: Linode API - Regions + title: regions API version: v00.00.00000 + description: linode regions API support: - description: Support - id: 'support:v00.00.00000' + id: support:v00.00.00000 name: support preferred: true service: $ref: linode/v00.00.00000/services/support.yaml - title: Linode API - Support + title: support API version: v00.00.00000 + description: linode support API tags: - description: Tags - id: 'tags:v00.00.00000' + id: tags:v00.00.00000 name: tags preferred: true service: $ref: linode/v00.00.00000/services/tags.yaml - title: Linode API - Tags - version: v00.00.00000 - view: - description: View - id: 'view:v00.00.00000' - name: view - preferred: true - service: - $ref: linode/v00.00.00000/services/view.yaml - title: Linode API - View + title: tags API version: v00.00.00000 + description: linode tags API volumes: - description: Volumes - id: 'volumes:v00.00.00000' + id: volumes:v00.00.00000 name: volumes preferred: true service: $ref: linode/v00.00.00000/services/volumes.yaml - title: Linode API - Volumes + title: volumes API + version: v00.00.00000 + description: linode volumes API + vpcs: + id: vpcs:v00.00.00000 + name: vpcs + preferred: true + service: + $ref: linode/v00.00.00000/services/vpcs.yaml + title: vpcs API version: v00.00.00000 + description: linode vpcs API config: auth: - type: bearer credentialsenvvar: LINODE_TOKEN + type: bearer diff --git a/providers/src/linode/v00.00.00000/services/account.yaml b/providers/src/linode/v00.00.00000/services/account.yaml index 0f16e6f1..8e4645b5 100644 --- a/providers/src/linode/v00.00.00000/services/account.yaml +++ b/providers/src/linode/v00.00.00000/services/account.yaml @@ -1,5250 +1,16499 @@ openapi: 3.0.1 -servers: - - url: 'https://api.linode.com/v4' - - url: 'https://api.linode.com/v4beta' info: - version: 4.147.0 - title: Linode API - account - description: account - contact: - name: Linode - url: 'https://linode.com' - email: support@linode.com -tags: - - name: Account - description: 'Use the Account endpoints to manage user settings, billing, and payments. You can also initiate and maintain OAuth client application authentication, enable the Linode Managed service, and create new users on your account.' - - name: Databases - description: 'Managed Databases is Linode''s fully-managed, high-performance database service. Use the Managed Databases endpoints to create and manage database clusters.' - - name: Domains - description: Use the Domains endpoints to create and manage domains and domain records on your account. - - name: Images - description: 'Use the Images endpoints to capture, store, and manage custom Linode images.' - - name: Linode Instances - description: 'Use the Linode Instances endpoints to create, configure, and manage your Linode instances. You can also manage the Linode Backup service; maintain and manage configuration profiles; create and maintain disks, intiate a host migration; view Linode Instance statistics; and more.' - - name: Linode Types - description: 'Use the Linode Types endpoints to retrieve information about Linode plan types, including pricing information, hardware resources, and network transfer allotment.' - - name: Linode Kubernetes Engine (LKE) - description: Linode Kubernetes Engine (LKE) is Linode's managed Kubernetes service. Use the LKE endpoints to create and manage Kubernetes clusters and their associated Node Pools. - - name: Longview - description: Longview is Linode's system-level monitoring and graphing service. Use the Longview endpoints to manage your Longview subscription and plan and to create and maintain Longview clients. - - name: Managed - description: 'Managed is Linode''s incident response service. Use the Managed endpoints to register a service to be monitored by the Managed Service team, provide secure access to your managed services, view information about detected issues, and more.' - - name: Networking - description: 'Use the Networking endpoints to view all IP addresses on your account, reorganize assigned IPv4 addresses, update RDNS, and configure IP sharing.' - - name: NodeBalancers - description: 'NodeBalancers is Linode''s load balancing service. Use the NodeBalancers endpoints to create and manage NodeBalancers. You can also create and maintain configurations; create and maintain nodes, and view statistics.' - - name: Object Storage - description: 'Object Storage is Linode''s S3-compatible data storage service. Use the Object Storage endpoints to create and maintaining buckets, add and remove objects from buckets, create and maintain Object Storage keys, and cancel the Object Storage service.' - - name: Profile - description: 'Use the Profile endpoints to manage your Linode user profile preferences and security settings. This includes creating and maintaining personal access tokens, creating and maintaining SSH keys, confirming and enabling two-factor authentication, and updating user and profile preferences.' - - name: Regions - description: 'Use the Regions endpoints to view information about the various Linode data center regions, including the service capabilities for each region, country, status, and more.' - - name: StackScripts - description: Linode StackScripts allow you to create reusable scripts to configure new Linode instances. Use the StackScripts endpoints to create and manage StackScripts on your account. - - name: Support - description: 'Use the Support endpoints to open, view, and close Linode Support tickets. You can also create and manage your Support ticket replies.' - - name: Tags - description: 'Tags allow you to organize and group your various Linode services. Use the Tags endpoints to create, assign, and delete your account tags.' - - name: Volumes - description: 'Volumes is Linode''s block storage service. Use the Volumes endpoints to create, attach, and manage your account Volumes.' -components: - schemas: - Account: - type: object - description: Account object - properties: - active_promotions: - type: array - readOnly: true - items: - $ref: '#/components/schemas/Promotion' - active_since: - type: string - format: date-time - description: The datetime of when the account was activated. - example: '2018-01-01T00:01:01' - readOnly: true - address_1: - type: string - description: First line of this Account's billing address. - maxLength: 64 - example: 123 Main Street - address_2: - type: string - description: Second line of this Account's billing address. - maxLength: 64 - example: Suite A - balance: - type: number - readOnly: true - description: 'This Account''s balance, in US dollars.' - example: 200 - x-linode-cli-display: 4 - balance_uninvoiced: - type: number - readOnly: true - 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 - x-linode-cli-display: 4 - billing_source: - type: string - readOnly: true - enum: - - akamai - - linode - description: | - The source of service charges for this Account, as determined by its relationship with Akamai. - Accounts that are associated with Akamai-specific customers return a value of `akamai`. - All other Accounts return a value of `linode`. - example: akamai - capabilities: - type: array - items: - type: string - description: | - A list of capabilities your account supports. - example: - - Linodes - - NodeBalancers - - Block Storage - - Object Storage - readOnly: true - city: - type: string - description: The city for this Account's billing address. - maxLength: 24 - example: Philadelphia - credit_card: - type: object - readOnly: true - description: Credit Card information associated with this Account. - properties: - last_four: - type: string - description: | - The last four digits of the credit card associated with this Account. - example: 1111 - expiry: - type: string - description: The expiration month and year of the credit card. - example: 11/2022 - company: - type: string - description: The company name associated with this Account. - maxLength: 128 - example: Linode LLC - country: - type: string - description: | - The two-letter ISO 3166 country code of this Account's billing address. - example: US - email: - type: string - description: The email address of the person associated with this Account. - maxLength: 128 - example: john.smith@linode.com - x-linode-cli-display: 3 - first_name: - type: string - description: The first name of the person associated with this Account. - maxLength: 50 - example: John - x-linode-cli-display: 1 - last_name: - type: string - description: The last name of the person associated with this Account. - maxLength: 50 - example: Smith - x-linode-cli-display: 2 - phone: - type: string - description: The phone number associated with this Account. - maxLength: 32 - example: 215-555-1212 - state: - type: string - description: | - If billing address is in the United States (US) or Canada (CA), only the two-letter ISO 3166 State or Province code are accepted. If entering a US military address, state abbreviations (AA, AE, AP) should be entered. If the address is outside the US or CA, this is the Province associated with the Account's billing address. - maxLength: 24 - example: PA - tax_id: - type: string - description: | - The tax identification number associated with this Account, for tax calculations in some countries. If you do not live in a country that collects tax, this should be an empty string (`""`). - maxLength: 25 - example: ATU99999999 - euuid: - type: string - description: | - An external unique identifier for this account. - format: uuid - readOnly: true - example: E1AF5EEC-526F-487D-B317EBEB34C87D71 - zip: - type: string - description: | - The zip code of this Account's billing address. The following restrictions apply: - - - May only consist of letters, numbers, spaces, and hyphens. - - Must not contain more than 9 letter or number characters. - example: 19102-1234 - Promotion: - type: object - readOnly: true - description: | - Promotions generally - offer a set amount of credit that can be used toward your Linode - services, and the promotion expires after a specified date. As well, - a monthly cap on the promotional offer is set. - - Simply put, a promotion offers a certain amount of credit every - month, until either the expiration date is passed, or until the total - promotional credit is used, whichever comes first. - properties: - credit_monthly_cap: - x-linode-cli-display: 5 - type: string - description: | - The amount available to spend per month. - example: '10.00' - credit_remaining: - x-linode-cli-display: 3 - type: string - description: | - The total amount of credit left for this promotion. - example: '50.00' - description: - type: string - description: | - A detailed description of this promotion. - example: Receive up to $10 off your services every month for 6 months! Unused credits will expire once this promotion period ends. - expire_dt: - x-linode-cli-display: 2 - type: string - description: | - When this promotion's credits expire. - example: '2018-01-31T23:59:59' - image_url: - type: string - description: | - The location of an image for this promotion. - example: 'https://linode.com/10_a_month_promotion.svg' - summary: - x-linode-cli-display: 10 - type: string - description: | - Short details of this promotion. - example: $10 off your Linode a month! - this_month_credit_remaining: - x-linode-cli-display: 4 - type: string - description: | - The amount of credit left for this month for this promotion. - example: '10.00' - service_type: - x-linode-cli-display: 1 - type: string - enum: - - all - - backup - - blockstorage - - db_mysql - - ip_v4 - - linode - - linode_disk - - linode_memory - - longview - - managed - - nodebalancer - - objectstorage - - transfer_tx - description: | - The service to which this promotion applies. - example: all - ErrorObject: - type: object - description: | - An object for describing a single error that occurred during the processing of a request. - properties: - reason: - type: string - description: | - What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [open a Support Ticket](/docs/api/support/#support-ticket-open) or perform some other action before you can complete the request successfully. - example: fieldname must be a valid value - field: - type: string - description: | - The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request. - example: fieldname - CreditCard: - type: object - description: | - An object representing the credit card information you have on file with - Linode to make Payments against your Account. - required: - - card_number - - expiry_month - - expiry_year - - cvv - properties: - card_number: - type: string - description: Your credit card number. No spaces or dashes allowed. - minLength: 14 - maxLength: 24 - format: digits - example: 4111111111111111 - expiry_month: - type: integer - minimum: 1 - maximum: 12 - description: | - A value from 1-12 representing the expiration month of your credit card. - - * 1 = January - * 2 = February - * 3 = March - * Etc. - example: 12 - expiry_year: - type: integer - minLength: 4 - maxLength: 4 - description: | - A four-digit integer representing the expiration year of - your credit card. - - The combination of `expiry_month` and `expiry_year` - must result in a month/year combination of the current month or in - the future. An expiration date set in the past is invalid. - example: 2020 - cvv: - type: string - minLength: 3 - maxLength: 4 - format: digits - description: | - CVV (Card Verification Value) of the credit card, typically found on the back of the card. - example: '123' - PaginationEnvelope: - type: object - description: | - An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](/docs/api/#pagination) for more information. - properties: - pages: - type: integer - readOnly: true - description: 'The total number of [pages](/docs/api/#pagination).' - example: 1 - page: - type: integer - readOnly: true - description: 'The current [page](/docs/api/#pagination).' - example: 1 - results: - type: integer - readOnly: true - description: The total number of results. - example: 1 - EntityTransfer: - type: object - description: | - An object representing an Entity Transfer. - properties: - token: - x-linode-cli-display: 1 - type: string - format: uuid - description: | - The token used to identify and accept or cancel this transfer. - example: 123E4567-E89B-12D3-A456-426614174000 - status: - x-linode-cli-display: 2 - x-linode-filterable: true - x-linode-cli-color: - accepted: yellow - cancelled: red - completed: green - failed: red - pending: yellow - stale: red - default_: white - type: string - enum: - - accepted - - cancelled - - completed - - failed - - pending - - stale - description: | - The status of the transfer request. + title: account API + description: linode account API + version: 4.208.1 +paths: + /account: + get: + description: >- + Returns the contact and billing information related to your account. - `accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete. - `cancelled`: The transfer has been cancelled by the sender. + [Learn + more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) - `completed`: The transfer has completed successfully. - `failed`: The transfer has failed after initiation. + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: https://techdocs.akamai.com/linode-api/reference/get-account + operationId: get-account + responses: + '200': + content: + application/json: + schema: + additionalProperties: false + description: Account object. + properties: + 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. - `pending`: The transfer is ready to be accepted. - `stale`: The transfer has exceeded its expiration date. It can no longer be accepted or cancelled. - example: pending - created: - type: string - format: date-time - description: | - When this transfer was created. - example: '2021-02-11T16:37:03' - updated: - type: string - format: date-time - description: | - When this transfer was last updated. - example: '2021-02-11T16:37:03' - is_sender: - x-linode-cli-display: 4 - x-linode-filterable: true - type: boolean - description: | - If the requesting account created this transfer. - example: true - expiry: - x-linode-cli-display: 3 - type: string - format: date-time - description: | - When this transfer expires. Transfers will automatically expire 24 hours after creation. - example: '2021-02-12T16:37:03' - entities: - type: object - description: | - A collection of the entities to include in this transfer request, separated by type. - properties: - linodes: - x-linode-cli-display: 5 - type: array - items: - type: integer - description: | - An array containing the IDs of each of the Linodes included in this transfer. - example: - - 111 - - 222 - Event: - type: object - 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: - id: - type: integer - readOnly: true - description: The unique ID of this Event. - example: 123 - x-linode-cli-display: 1 - x-linode-filterable: true - action: - type: string - enum: - - account_update - - account_settings_update - - backups_enable - - backups_cancel - - backups_restore - - community_question_reply - - community_like - - credit_card_updated - - 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_create - - firewall_delete - - firewall_disable - - firewall_enable - - firewall_update - - firewall_device_add - - firewall_device_remove - - host_reboot - - image_delete - - image_update - - image_upload - - 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_node_create - - 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 - - password_reset - - payment_method_add - - payment_submitted - - profile_update - - stackscript_create - - stackscript_delete - - stackscript_update - - stackscript_publicize - - stackscript_revise - - tag_create - - tag_delete - - 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 - readOnly: true - description: | - The action that caused this Event. New actions may be added in the future. - example: ticket_create - x-linode-cli-display: 3 - x-linode-filterable: true - created: - type: string - readOnly: true - format: date-time - description: When this Event was created. - example: '2018-01-01T00:01:01' - x-linode-cli-display: 6 - x-linode-filterable: true - duration: - type: number - readOnly: true - description: | - The total duration in seconds that it takes for the Event to complete. - example: 300.56 - x-linode-cli-display: 7 - entity: - type: object - readOnly: true - description: | - Detailed information about the Event's entity, including ID, type, label, and URL used to access it. - properties: - id: - type: integer - description: | - The unique ID for an Event's entity. - - - Some Event entities do not have IDs associated with them, so they - will not be returned when filtering by ID. These Events include: - * `account` - * `profile` - - Entities for some Events are assigned the ID of the Linode they correspond to. - When filtering by ID for these Events, use the corresponding Linode's ID. - These Events include: - * `disks` - * `backups` - - - Tag Events use a tag's name for the entity ID field. When filtering by ID - for tag Events, supply the name of the tag. - example: 11111 - x-linode-filterable: true - label: - type: string - description: | - The current label of this object. The label may reflect changes that occur with this Event. - example: Problem booting my Linode - x-linode-cli-display: 5 - type: - type: string - enum: - - account - - backups - - community - - disks - - domain - - entity_transfer - - firewall - - image - - ipaddress - - linode - - longview - - managed_service - - nodebalancer - - oauth_client - - profile - - stackscript - - tag - - ticket - - token - - user - - user_ssh_key - - volume - readOnly: true - description: | - The type of entity that is being referenced by the Event. - example: ticket - x-linode-filterable: true - url: - type: string - 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 - secondary_entity: - type: object - readOnly: true - description: | - Detailed information about the Event's secondary entity, which provides additional information - for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions. - properties: - id: - type: string - description: | - The ID of the object that is the secondary entity. - example: linode/debian9 - label: - type: string - description: | - The label of this object. - example: linode1234 - type: - type: string - readOnly: true - description: | - The type of entity that is being referenced by the Event. - example: linode - url: - type: string - 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 - percent_complete: - type: integer - readOnly: true - description: | - A percentage estimating the amount of time remaining for an Event. - Returns `null` for notification events. - example: null - rate: - type: string - readOnly: true - description: | - The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events. - example: null - read: - type: boolean - readOnly: true - description: If this Event has been read. - example: true - seen: - type: boolean - readOnly: true - description: If this Event has been seen. - example: true - status: - type: string - readOnly: true - description: The current status of this Event. - enum: - - failed - - finished - - notification - - scheduled - - started - x-linode-cli-display: 8 - x-linode-cli-color: - failed: red - finished: green - started: yellow - default_: white - time_remaining: - type: string - readOnly: true - nullable: true - description: | - The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the `percent_complete` attribute will indicate about how much more work is to be done. - example: null - username: - type: string - readOnly: true - nullable: true - description: | - The username of the User who caused the Event. - example: exampleUser - x-linode-cli-display: 2 - message: - type: string - nullable: true - 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 - x-linode-cli-display: 9 - Invoice: - type: object - description: Account Invoice object - properties: - id: - type: integer - readOnly: true - description: The Invoice's unique ID. - example: 123 - x-linode-cli-display: 1 - date: - type: string - readOnly: true - format: date-time - description: When this Invoice was generated. - example: '2018-01-01T00:01:01' - x-linode-cli-display: 2 - label: - type: string - readOnly: true - description: The Invoice's display label. - example: Invoice - x-linode-cli-display: 3 - subtotal: - type: number - readOnly: true - description: The amount of the Invoice before taxes in US Dollars. - example: 120.25 - x-linode-cli-display: 4 - tax: - type: number - readOnly: true - description: The amount of tax levied on the Invoice in US Dollars. - example: 12.25 - x-linode-cli-display: 5 - tax_summary: - type: array - readOnly: true - description: The amount of tax broken down into subtotals by source. - items: - type: object - properties: - tax: - type: number - description: The amount of tax subtotal attributable to this source. - example: 12.25 - name: - type: string - description: The source of this tax subtotal. - example: PA STATE TAX - total: - type: number - readOnly: true - description: The amount of the Invoice after taxes in US Dollars. - example: 132.5 - x-linode-cli-display: 6 - InvoiceItem: - type: object - description: An InvoiceItem object. - properties: - amount: - type: number - readOnly: true - description: 'The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.' - example: 20.2 - x-linode-cli-display: 4 - tax: - type: number - readOnly: true - description: The amount of tax levied on this Item in US Dollars. - example: 1.25 - x-linode-cli-display: 5 - total: - type: number - readOnly: true - description: The price of this Item after taxes in US Dollars. - example: 21.45 - x-linode-cli-display: 6 - from: - type: string - readOnly: true - format: date-time - description: 'The date the Invoice Item started, based on month.' - example: '2018-01-01T00:01:01' - x-linode-cli-display: 2 - label: - type: string - readOnly: true - description: The Invoice Item's display label. - example: Linode 123 - x-linode-cli-display: 1 - quantity: - type: integer - readOnly: true - description: The quantity of this Item for the specified Invoice. - example: 4 - to: - type: string - readOnly: true - format: date-time - description: 'The date the Invoice Item ended, based on month.' - example: '2018-01-31T11:59:59' - x-linode-cli-display: 3 - type: - type: string - readOnly: true - description: 'The type of service, ether `hourly` or `misc`.' - enum: - - hourly - - misc - example: hourly - unit_price: - type: string - readOnly: true - description: The monthly service fee in US Dollars for this Item. - example: 5.05 - Login: - type: object - description: | - An object representing a previous successful login for a User. - properties: - id: - type: integer - description: | - The unique ID of this login object. - example: 1234 - readOnly: true - x-linode-cli-display: 1 - datetime: - type: string - format: date-time - description: | - When the login was initiated. - example: '2018-01-01T00:01:01' - readOnly: true - x-linode-cli-display: 2 - ip: - type: string - format: ip - description: | - The remote IP address that requested the login. - example: 192.0.2.0 - readOnly: true - x-linode-cli-display: 3 - username: - type: string - description: | - The username of the User that attempted the login. - example: example_user - readOnly: true - x-linode-cli-display: 4 - status: - type: string - enum: - - successful - - failed - description: | - Whether the login attempt succeeded or failed. - example: successful - readOnly: true - x-linode-cli-display: 5 - restricted: - type: boolean - description: | - True if the User that attempted the login was a restricted User, false otherwise. - example: true - readOnly: true - x-linode-cli-display: 6 - Maintenance: - type: object - description: | - Information about maintenance affecting an entity. - properties: - type: - x-linode-filterable: true - type: string - enum: - - reboot - - cold_migration - - live_migration - description: | - The type of maintenance. - example: reboot - status: - x-linode-filterable: true - type: string - enum: - - completed - - pending - - started - description: | - The maintenance status. - - Maintenance progresses in the following sequence: pending, started, then completed. - example: started - reason: - type: string - description: | - The reason maintenance is being performed. - example: This maintenance will allow us to update the BIOS on the host's motherboard. - when: - x-linode-filterable: true - type: string - description: | - When the maintenance will begin. - - [Filterable](/docs/api/#filtering-and-sorting) with the following parameters: - - * A single value in date-time string format ("%Y-%m-%dT%H:%M:%S"), which returns only matches to that value. - - * A dictionary containing pairs of inequality operator string keys ("+or", "+gt", "+gte", "+lt", "+lte", - or "+neq") and single date-time string format values ("%Y-%m-%dT%H:%M:%S"). "+or" accepts an array of values that - may consist of single date-time strings or dictionaries of inequality operator pairs. - format: date-time - example: 2020-07-09T00:01:01.000Z - entity: - type: object - description: | - The entity being affected by maintenance. - properties: - label: - type: string - description: | - The label of the entity being affected by maintenance. - example: demo-linode - id: - type: number - description: | - The id of the entity being affected by maintenance. - example: 1234 - type: - type: string - description: | - The type of entity. - example: Linode - url: - type: string - description: | - The API endpoint prefix to use in combination with the entity id to find specific information about the entity. - example: 'https://api.linode.com/v4/linode/instances/{linodeId}' - Notification: - type: object - description: | - An important, often time-sensitive item related to your Account. - properties: - entity: - type: object - readOnly: true - description: Detailed information about the Notification. - properties: - id: - type: integer - description: | - The unique ID of the Notification's entity, based on the entity type. - example: 3456 - label: - type: string - description: | - The current label for this Notification's entity. - example: Linode not booting. - type: - type: string - description: The type of entity this is related to. - example: ticket - url: - type: string - description: | - The URL where you can access the object this Notification is for. If a relative URL, it is relative to the domain you retrieved the Notification from. - example: /support/tickets/3456 - label: - type: string - description: | - A short description of this Notification. - example: You have an important ticket open! - readOnly: true - x-linode-cli-display: 1 - message: - type: string - readOnly: true - description: A human-readable description of the Notification. - example: You have an important ticket open! - x-linode-cli-display: 2 - body: - type: string - readOnly: true - description: | - A full description of this Notification, in markdown format. Not all Notifications include bodies. - nullable: true - example: null - type: - type: string - enum: - - migration_scheduled - - migration_imminent - - migration_pending - - reboot_scheduled - - outage - - payment_due - - ticket_important - - ticket_abuse - - notice - - maintenance - - promotion - readOnly: true - description: The type of Notification this is. - example: ticket_important - severity: - type: string - enum: - - minor - - major - - critical - description: | - The severity of this Notification. This field can be used to decide how prominently to display the Notification, what color to make the display text, etc. - example: major - readOnly: true - x-linode-cli-display: 3 - x-linode-cli-color: - critical: b - minor: blue - default_: white - when: - type: string - readOnly: true - format: date-time - description: | - If this Notification is of an Event that will happen at a fixed, future time, this is when the named action will be taken. For example, if a Linode is to be migrated in response to a Security Advisory, this field will contain the approximate time the Linode will be taken offline for migration. - example: null - x-linode-cli-display: 4 - x-linode-cli-color: - None: black - default_: white - until: - type: string - format: date-time - description: | - If this Notification has a duration, this will be the ending time for the Event/action. For example, if there is scheduled maintenance for one of our systems, `until` would be set to the end of the maintenance window. - example: null - readOnly: true - x-linode-cli-display: 5 - x-linode-cli-color: - None: black - default_: white - OAuthClient: - type: object - description: | - A third-party application registered to Linode that users may log into with their Linode account through our authentication server at 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: - type: string - 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 - x-linode-cli-display: 1 - redirect_uri: - type: string - format: url - description: | - The location a successful log in from https://login.linode.com should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange. - example: 'https://example.org/oauth/callback' - x-linode-cli-display: 5 - label: - x-linode-filterable: true - type: string - minLength: 1 - maxLength: 512 - 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 - x-linode-cli-display: 2 - status: - type: string - enum: - - active - - disabled - - suspended - description: | - The status of this application. `active` by default. - example: active - readOnly: true - x-linode-cli-display: 3 - x-linode-cli-color: - suspended: red - default_: white - secret: - type: string - 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 - thumbnail_url: - type: string - nullable: true - format: url - 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' - readOnly: true - public: - x-linode-filterable: true - type: boolean - default: false - description: | - If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the OAuth spec for more details. - example: false - x-linode-cli-display: 4 - PaymentMethod: - type: object - description: Payment Method Response Object. - properties: - id: - type: integer - description: The unique ID of this Payment Method. - example: 123 - x-linode-cli-display: 1 - type: - type: string - enum: - - credit_card - - google_pay - - paypal - description: The type of Payment Method. - example: credit_card - x-linode-cli-display: 2 - is_default: - type: boolean - description: | - Whether this Payment Method is the default method for automatically processing service charges. - example: true - x-linode-cli-display: 3 - created: - type: string - readOnly: true - format: date-time - description: When the Payment Method was added to the Account. - example: '2018-01-15T00:01:01' - data: - x-linode-cli-format: json - x-linode-cli-display: 4 - oneOf: - - x-linode-ref-name: Credit Card - $ref: '#/components/schemas/CreditCardData' - - x-linode-ref-name: Google Pay - $ref: '#/components/schemas/GooglePayData' - - x-linode-ref-name: Paypal - $ref: '#/components/schemas/PayPalData' - discriminator: - propertyName: type - CreditCardData: - type: object - description: Credit card information. - properties: - card_type: - type: string - readOnly: true - description: The type of credit card. - example: Discover - last_four: - type: string - readOnly: true - description: The last four digits of the credit card number. - example: '1234' - expiry: - type: string - readOnly: true - format: MM/YYYY - description: The expiration month and year of the credit card. - example: 06/2022 - GooglePayData: - type: object - description: Google Pay information. - properties: - card_type: - type: string - readOnly: true - description: The type of credit card. - example: Discover - last_four: - type: string - readOnly: true - description: The last four digits of the credit card number. - example: '1234' - expiry: - type: string - readOnly: true - format: MM/YYYY - description: The expiration month and year of the credit card. - example: 06/2022 - PayPalData: - type: object - description: PayPal information. - properties: - email: - type: string - readOnly: true - description: The email address associated with your PayPal account. - example: example@linode.com - paypal_id: - type: string - readOnly: true - description: PayPal Merchant ID associated with your PayPal account. - example: ABC1234567890 - Payment: - type: object - description: Payment object response. - properties: - id: - type: integer - readOnly: true - description: The unique ID of the Payment. - example: 123 - x-linode-cli-display: 1 - date: - type: string - readOnly: true - format: date-time - description: When the Payment was made. - example: '2018-01-15T00:01:01' - x-linode-cli-display: 2 - usd: - type: integer - readOnly: true - description: 'The amount, in US dollars, of the Payment.' - example: '120.50' - x-linode-cli-display: 3 - PaymentRequest: - type: object - required: - - usd - description: Payment object request. - properties: - cvv: - type: string - description: | - CVV (Card Verification Value) of the credit card to be used for the Payment. Required if paying by credit card. - example: '123' - usd: - type: string - pattern: '^\$?\d+\.\d{2}$' - description: | - The amount in US Dollars of the Payment. - - * Can begin with or without `$`. - * Commas (`,`) are not accepted. - * Must end with a decimal expression, such as `.00` or `.99`. - * Minimum: `$5.00` or the Account balance, whichever is lower. - * Maximum: `$2000.00` or the Account balance up to `$50000.00`, whichever is greater. - example: $120.50 - payment_method_id: - type: integer - description: | - The ID of the Payment Method to apply to the Payment. - example: 123 - WarningObject: - type: object - description: | - An object for describing a single warning associated with a response. - properties: - title: - type: string - description: | - The general warning message. - example: Unable to reboot Linode. - details: - type: string - description: | - Specific information related to the warning. - example: Linode 123 could not be rebooted. - PayPal: - type: object - required: - - cancel_url - - redirect_url - - usd - description: | - An object representing the staging of a Payment via PayPal. - properties: - cancel_url: - type: string - description: The URL to have PayPal redirect to when Payment is cancelled. - example: 'https://example.org' - redirect_url: - type: string - description: The URL to have PayPal redirect to when Payment is approved. - example: 'https://example.org' - usd: - type: string - description: 'The payment amount in USD. Minimum accepted value of $5 USD. Maximum accepted value of $500 USD or credit card payment limit; whichever value is highest. PayPal''s maximum transaction limit is $10,000 USD.' - example: '120.50' - PayPalExecute: - type: object - required: - - payer_id - - payment_id - description: | - An object representing an execution of Payment to PayPal to capture the funds and credit your Linode Account. - properties: - payer_id: - type: string - description: | - The PayerID returned by PayPal during the transaction authorization process. - example: ABCDEFGHIJKLM - payment_id: - type: string - description: | - The PaymentID returned from [POST /account/payments/paypal](/docs/api/account/#paypal-payment-stage) that has been approved with PayPal. - example: PAY-1234567890ABCDEFGHIJKLMN - ServiceTransfer: - type: object - description: | - An object representing a Service Transfer. - properties: - token: - x-linode-cli-display: 1 - type: string - format: uuid - description: | - The token used to identify and accept or cancel this transfer. - example: 123E4567-E89B-12D3-A456-426614174000 - status: - x-linode-cli-display: 2 - x-linode-filterable: true - x-linode-cli-color: - accepted: yellow - cancelled: red - completed: green - failed: red - pending: yellow - stale: red - default_: white - type: string - enum: - - accepted - - cancelled - - completed - - failed - - pending - - stale - description: | - The status of the transfer request. + Simply put, a promotion offers a certain amount of + credit month, until either the expiration date is + passed, or until the total promotional credit is used, + whichever comes first. + properties: + credit_monthly_cap: + description: The amount available to spend per month. + example: '10.00' + type: string + x-linode-cli-display: 5 + credit_remaining: + description: The total amount of credit left for this promotion. + example: '50.00' + type: string + x-linode-cli-display: 3 + description: + description: A detailed description of this promotion. + example: >- + Receive up to $10 off your services every month for + 6 months! Unused credits will expire once this + promotion period ends. + type: string + expire_dt: + description: When this promotion's credits expire. + example: '2018-01-31T23:59:59' + type: string + x-linode-cli-display: 2 + image_url: + description: The location of an image for this promotion. + example: https://linode.com/10_a_month_promotion.svg + type: string + service_type: + description: The service to which this promotion applies. + enum: + - all + - backup + - blockstorage + - db_mysql + - ip_v4 + - linode + - linode_disk + - linode_memory + - longview + - managed + - nodebalancer + - objectstorage + - placement_group + - transfer_tx + example: all + type: string + x-linode-cli-display: 1 + summary: + description: Short details of this promotion. + example: $10 off your Linode a month! + type: string + x-linode-cli-display: 10 + this_month_credit_remaining: + description: >- + The amount of credit left for this month for this + promotion. + example: '10.00' + type: string + x-linode-cli-display: 4 + readOnly: true + type: object + x-akamai: + file-path: schemas/promotion.yaml + readOnly: true + type: array + active_since: + description: __Read-only__ The date and time the account was activated. + example: '2018-01-01T00:01:01' + format: date-time + readOnly: true + type: string + address_1: + description: The first line of this account's billing address. + example: 123 Main Street + maxLength: 64 + type: string + address_2: + description: The second line of this account's billing address. + example: Suite A + maxLength: 64 + type: string + balance: + description: __Read-only__ 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. + 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`. + enum: + - akamai + - linode + example: akamai + readOnly: true + type: string + capabilities: + description: >- + __Read-only__ The Akamai Cloud Computing services your + account supports. + example: + - Linodes + - NodeBalancers + - Block Storage + - Object Storage + - Placement Groups + - Block Storage Encryption + items: + type: string + readOnly: true + type: array + city: + description: The city for this account's `address`. + example: Philadelphia + maxLength: 24 + type: string + company: + description: >- + The company name assigned to this account. This value + can't include the characters, `<` `>` `(` `)` `"` `=`. + example: Linode LLC + maxLength: 128 + type: string + country: + description: >- + The two-letter ISO 3166 country code for this account's + `address`. + example: US + type: string + credit_card: + additionalProperties: false + description: >- + __Read-only__ The credit card information assigned to this + account. + properties: + expiry: + description: The expiration month and year of the `credit_card`. + example: 11/2022 + type: string + last_four: + description: >- + The last four digits of the `credit_card` assigned to + this account. + example: 1111 + type: string + readOnly: true + type: object + email: + description: The email address of the person assigned to this account. + example: john.smith@linode.com + maxLength: 128 + type: string + x-linode-cli-display: 3 + euuid: + description: >- + __Read-only__ An external unique identifier for this + account. + example: E1AF5EEC-526F-487D-B317EBEB34C87D71 + format: uuid + readOnly: true + type: string + first_name: + description: >- + The first name of the person assigned to this account. + This value can't include the characters, `<` `>` `(` `)` + `"` `=`. + example: John + maxLength: 50 + type: string + x-linode-cli-display: 1 + last_name: + description: >- + The last name of the person assigned to this account. This + value can't include the characters, `<` `>` `(` `)` `"` + `=`. + example: Smith + maxLength: 50 + type: string + x-linode-cli-display: 2 + phone: + description: The phone number assigned to this account. + example: 215-555-1212 + maxLength: 32 + type: string + state: + description: >- + The state or province for the `address` set for your + account, if applicable. - `accepted`: The transfer has been accepted by another user and is currently in progress. - Transfers can take up to 3 hours to complete. - `cancelled`: The transfer has been cancelled by the sender. + - If the `address` is in the United States (US) or Canada + (CA), this is the two-letter ISO 3166 code for the state + or province. - `completed`: The transfer has completed successfully. - `failed`: The transfer has failed after initiation. + - If it's a US military `address`, this is the + abbreviation for that territory. This includes `AA` for + Armed Forces Americas (excluding Canada), `AE` for Armed + Forces Africa, Europe, Middle East, and Canada, or `AP` + for Armed Forces Pacific. - `pending`: The transfer is ready to be accepted. - `stale`: The transfer has exceeded its expiration date. It can no longer be accepted or - cancelled. - example: pending - created: - type: string - format: date-time - description: | - When this transfer was created. - example: '2021-02-11T16:37:03' - updated: - type: string - format: date-time - description: | - When this transfer was last updated. - example: '2021-02-11T16:37:03' - is_sender: - x-linode-cli-display: 4 - x-linode-filterable: true - type: boolean - description: | - If the requesting account created this transfer. - example: true - expiry: - x-linode-cli-display: 3 - type: string - format: date-time - description: | - When this transfer expires. Transfers will automatically expire 24 hours after creation. - example: '2021-02-12T16:37:03' - entities: - type: object - description: | - A collection of the services to include in this transfer request, separated by type. - properties: - linodes: - x-linode-cli-display: 5 - type: array - items: - type: integer - description: | - An array containing the IDs of each of the Linodes included in this transfer. - example: - - 111 - - 222 - AccountSettings: - type: object - description: Account Settings object - properties: - managed: - type: boolean - readOnly: true - 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 - x-linode-cli-display: 3 - longview_subscription: - type: string - readOnly: true - description: | - The Longview Pro tier you are currently subscribed to. The value must be a [Longview Subscription](/docs/api/longview/#longview-subscriptions-list) ID or `null` for Longview Free. - example: longview-3 - x-linode-cli-display: 2 - network_helper: - type: boolean - description: | - Enables network helper across all users by default for new Linodes and Linode Configs. - example: false - x-linode-cli-display: 1 - backups_enabled: - type: boolean - description: | - Account-wide backups default. If `true`, all Linodes created will automatically be enrolled in the Backups service. If `false`, Linodes will not be enrolled by default, but may still be enrolled on creation or later. - example: true - x-linode-cli-display: 4 - object_storage: - type: string - readOnly: true - enum: - - disabled - - suspended - - active - description: | - A string describing the status of this account's Object Storage service enrollment. - default: disabled - example: active - x-linode-cli-display: 5 - Transfer: - type: object - description: | - An object representing your network utilization for the current month, in Gigabytes. - properties: - billable: - type: integer - readOnly: true - description: | - The amount of your transfer pool that is billable this billing cycle. - example: 0 - x-linode-cli-display: 3 - quota: - type: integer - readOnly: true - description: | - The amount of network usage allowed this billing cycle. - example: 9141 - x-linode-cli-display: 1 - used: - type: integer - readOnly: true - description: | - The amount of network usage you have used this billing cycle. - example: 2 - x-linode-cli-display: 2 - User: - type: object - description: | - A User on your Account. Unrestricted users can log in and access information about your Account, while restricted users may only access entities or perform actions they've been granted access to. - properties: - username: - type: string - pattern: '^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$' - minLength: 3 - maxLength: 32 - description: | - The User's username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts). - x-linode-filterable: true - example: example_user - x-linode-cli-display: 1 - email: - type: string - format: email - description: | - The email address for the User. Linode sends emails to this address for account management communications. May be used for other communications as configured. - example: example_user@linode.com - x-linode-cli-display: 2 - restricted: - type: boolean - description: | - If true, the User must be granted access to perform actions or access entities on this Account. See User Grants View ([GET /account/users/{username}/grants](/docs/api/account/#users-grants-view)) for details on how to configure grants for a restricted User. - example: true - x-linode-cli-display: 3 - ssh_keys: - type: array - readOnly: true - items: - type: string - description: | - A list of SSH Key labels added by this User. - - Users can add keys with the SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) command. - - These keys are deployed when this User is included in the `authorized_users` - field of the following requests: - - Linode Create ([POST /linode/instances](/docs/api/linode-instances/#linode-create)) - - Linode Rebuild ([POST /linode/instances/{linodeId}/rebuild](/docs/api/linode-instances/#linode-rebuild)) - - Disk Create ([POST /linode/instances/{linodeId}/disks](/docs/api/linode-instances/#disk-create)) - example: - - home-pc - - laptop - tfa_enabled: - type: boolean - readOnly: true - description: | - A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. See the Create Two Factor Secret ([POST /profile/tfa-enable](/docs/api/profile/#two-factor-secret-create)) endpoint to enable TFA. - GrantsResponse: - type: object - 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: - global: - type: object - description: | - A structure containing the Account-level grants a User has. - properties: - add_linodes: - type: boolean - description: 'If true, this User may create Linodes.' - example: true - add_longview: - type: boolean - description: 'If true, this User may create Longview clients and view the current plan.' - example: true - longview_subscription: - type: boolean - description: 'If true, this User may manage the Account''s Longview subscription.' - example: true - account_access: - type: string - nullable: true - enum: - - read_only - - read_write - 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. - example: read_only - cancel_account: - type: boolean - description: 'If true, this User may cancel the entire Account.' - example: false - add_domains: - type: boolean - description: 'If true, this User may add Domains.' - example: true - add_stackscripts: - type: boolean - description: 'If true, this User may add StackScripts.' - example: true - add_nodebalancers: - type: boolean - description: 'If true, this User may add NodeBalancers.' - example: true - add_images: - type: boolean - description: 'If true, this User may add Images.' - example: true - add_volumes: - type: boolean - description: 'If true, this User may add Volumes.' - example: true - add_firewalls: - type: boolean - description: 'If true, this User may add Firewalls.' - example: true - add_databases: - type: boolean - description: 'if true, this User may add Managed Databases.' - example: true - linode: - type: array - items: - $ref: '#/components/schemas/Grant' - description: | - The grants this User has for each Linode that is owned by this Account. - database: - type: array - items: - $ref: '#/components/schemas/Grant' - description: | - The grants this User has for each Database that is owned by this Account. - domain: - type: array - items: - $ref: '#/components/schemas/Grant' - description: | - The grants this User has for each Domain that is owned by this Account. - nodebalancer: - type: array - items: - $ref: '#/components/schemas/Grant' - description: | - The grants this User has for each NodeBalancer that is owned by this Account. - image: - type: array - items: - $ref: '#/components/schemas/Grant' - description: | - The grants this User has for each Image that is owned by this Account. - longview: - type: array - items: - $ref: '#/components/schemas/Grant' - description: | - The grants this User has for each Longview Client that is owned by this Account. - stackscript: - type: array - items: - $ref: '#/components/schemas/Grant' - description: | - The grants this User has for each StackScript that is owned by this Account. - volume: - type: array - items: - $ref: '#/components/schemas/Grant' - description: | - The grants this User has for each Block Storage Volume that is owned by this Account. - Grant: - type: object - description: | - Represents the level of access a restricted User has to a specific resource on the Account. - properties: - id: - type: integer - description: | - The ID of the entity this grant applies to. - example: 123 - permissions: - type: string - nullable: true - enum: - - read_only - - read_write - description: | - The level of access this User has to this entity. If null, this User has no access. - example: read_only - label: - type: string - description: | - The current label of the entity this grant applies to, for display purposes. - example: example-entity - readOnly: true - parameters: - pageOffset: - name: page - in: query - description: The page of a collection to return. - required: false - schema: - type: integer - minimum: 1 - default: 1 - pageSize: - name: page_size - in: query - description: The number of items to return per page. - schema: - type: integer - minimum: 25 - maximum: 500 - default: 100 - responses: - ErrorResponse: - description: Error - content: - application/json: - schema: - type: object - properties: - errors: - type: array - items: - $ref: '#/components/schemas/ErrorObject' - AcceptedResponse: - description: | - Accepted with warning. - - A warnings array is included with the standard 200 response body. - content: - application/json: - schema: - type: object - properties: - warnings: - type: array - items: - $ref: '#/components/schemas/WarningObject' - DeprecatedResponse: - description: | - Request successful. This endpoint is deprecated and may be removed in a future release. - - A warnings array is included with the standard 200 response body. - content: - application/json: - schema: - type: object - properties: - warnings: - type: array - items: - $ref: '#/components/schemas/WarningObject' - securitySchemes: - personalAccessToken: - type: http - scheme: bearer - oauth: - type: oauth2 - flows: - authorizationCode: - authorizationUrl: 'https://login.linode.com/oauth/authorize' - tokenUrl: 'https://login.linode.com/oauth/token' - scopes: - 'account:read_only': Allows access to GET information about your Account. - 'account:read_write': Allows access to all endpoints related to your Account. - 'domains:read_only': Allows access to GET Domains on your Account. - 'domains:read_write': Allows access to all Domain endpoints. - 'events:read_only': Allows access to GET your Events. - 'events:read_write': Allows access to all endpoints related to your Events. - 'firewall:read_only': Allows access to GET information about your Firewalls. - 'firewall:read_write': Allows acces to all Firewall endpoints. - 'images:read_only': Allows access to GET your Images. - 'images:read_write': Allows access to all endpoints related to your Images. - 'ips:read_only': Allows access to GET your ips. - 'ips:read_write': Allows access to all endpoints related to your ips. - 'linodes:read_only': Allows access to GET Linodes on your Account. - 'linodes:read_write': Allow access to all endpoints related to your Linodes. - 'lke:read_only': Allows access to GET LKE Clusters on your Account. - 'lke:read_write': Allows access to all endpoints related to LKE Clusters on your Account. - 'longview:read_only': Allows access to GET your Longview Clients. - 'longview:read_write': Allows access to all endpoints related to your Longview Clients. - 'nodebalancers:read_only': Allows access to GET NodeBalancers on your Account. - 'nodebalancers:read_write': Allows access to all NodeBalancer endpoints. - 'object_storage:read_only': Allows access to GET information related to your Object Storage. - 'object_storage:read_write': Allows access to all Object Storage endpoints. - 'stackscripts:read_only': Allows access to GET your StackScripts. - 'stackscripts:read_write': Allows access to all endpoints related to your StackScripts. - 'volumes:read_only': Allows access to GET your Volumes. - 'volumes:read_write': Allows access to all endpoints related to your Volumes. - links: - bootLinode: - operationId: bootLinodeInstance - parameters: - linodeId: $request.body#/id - rebootLinode: - operationId: rebootLinodeInstance - parameters: - linodeId: $request.body#/id - shutdownLinode: - operationId: shutdownLinodeInstance - parameters: - linodeId: $request.body#/id - updateLinode: - operationId: updateLinodeInstance - parameters: - linodeId: $request.body#/id - deleteLinode: - operationId: deleteLinodeInstance - parameters: - linodeId: $request.body#/id - rebuildLinode: - operationId: rebuildLinodeInstance - parameters: - linodeId: $request.body#/id - mutateLinode: - operationId: mutateLinodeInstance - parameters: - linodeId: $request.body#/id - resizeLinode: - operationId: resizeLinodeInstance - parameters: - linodeId: $request.body#/id - rescueLinode: - operationId: rescueLinodeInstance - parameters: - linodeId: $request.body#/id - cloneLinode: - operationId: cloneLinodeInstance - parameters: - linodeId: $request.body#/id - attachVolume: - operationId: attachVolume - parameters: - volumeID: $request.body#/id - cloneVolume: - operationId: cloneVolume - parameters: - volumeId: $request.body#/id - detachVolume: - operationId: detachVolume - parameters: - volumeId: $request.body#/id - resizeVolume: - operationId: resizeVolume - parameters: - volumeId: $request.body#/id - x-stackQL-resources: - account: - id: linode.account.account - name: account - title: Account - methods: - getAccount: - operation: - $ref: '#/paths/~1account/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _getAccount: - operation: - $ref: '#/paths/~1account/get' - response: - mediaType: application/json - openAPIDocKey: '200' - updateAccount: - operation: - $ref: '#/paths/~1account/put' - response: - mediaType: application/json - openAPIDocKey: '200' - cancelAccount: - operation: - $ref: '#/paths/~1account~1cancel/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/account/methods/getAccount' - insert: [] - update: [] - delete: [] - credit_card: - id: linode.account.credit_card - name: credit_card - title: Credit Card - methods: - createCreditCard: - operation: - $ref: '#/paths/~1account~1credit-card/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/credit_card/methods/createCreditCard' - update: [] - delete: [] - entity_transfers: - id: linode.account.entity_transfers - name: entity_transfers - title: Entity Transfers - methods: - getEntityTransfers: - operation: - $ref: '#/paths/~1account~1entity-transfers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getEntityTransfers: - operation: - $ref: '#/paths/~1account~1entity-transfers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - createEntityTransfer: - operation: - $ref: '#/paths/~1account~1entity-transfers/post' - response: - mediaType: application/json - openAPIDocKey: '200' - getEntityTransfer: - operation: - $ref: '#/paths/~1account~1entity-transfers~1{token}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getEntityTransfer: - operation: - $ref: '#/paths/~1account~1entity-transfers~1{token}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - deleteEntityTransfer: - operation: - $ref: '#/paths/~1account~1entity-transfers~1{token}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - acceptEntityTransfer: - operation: - $ref: '#/paths/~1account~1entity-transfers~1{token}~1accept/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/entity_transfers/methods/getEntityTransfers' - - $ref: '#/components/x-stackQL-resources/entity_transfers/methods/getEntityTransfer' - insert: - - $ref: '#/components/x-stackQL-resources/entity_transfers/methods/createEntityTransfer' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/entity_transfers/methods/deleteEntityTransfer' - events: - id: linode.account.events - name: events - title: Events - methods: - getEvents: - operation: - $ref: '#/paths/~1account~1events/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getEvents: - operation: - $ref: '#/paths/~1account~1events/get' - response: - mediaType: application/json - openAPIDocKey: '200' - getEvent: - operation: - $ref: '#/paths/~1account~1events~1{eventId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getEvent: - operation: - $ref: '#/paths/~1account~1events~1{eventId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - eventRead: - operation: - $ref: '#/paths/~1account~1events~1{eventId}~1read/post' - response: - mediaType: application/json - openAPIDocKey: '200' - eventSeen: - operation: - $ref: '#/paths/~1account~1events~1{eventId}~1seen/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/events/methods/getEvents' - - $ref: '#/components/x-stackQL-resources/events/methods/getEvent' - insert: [] - update: [] - delete: [] - invoices: - id: linode.account.invoices - name: invoices - title: Invoices - methods: - getInvoices: - operation: - $ref: '#/paths/~1account~1invoices/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getInvoices: - operation: - $ref: '#/paths/~1account~1invoices/get' - response: - mediaType: application/json - openAPIDocKey: '200' - getInvoice: - operation: - $ref: '#/paths/~1account~1invoices~1{invoiceId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getInvoice: - operation: - $ref: '#/paths/~1account~1invoices~1{invoiceId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/invoices/methods/getInvoices' - - $ref: '#/components/x-stackQL-resources/invoices/methods/getInvoice' - insert: [] - update: [] - delete: [] - invoices_items: - id: linode.account.invoices_items - name: invoices_items - title: Invoices Items - methods: - getInvoiceItems: - operation: - $ref: '#/paths/~1account~1invoices~1{invoiceId}~1items/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getInvoiceItems: - operation: - $ref: '#/paths/~1account~1invoices~1{invoiceId}~1items/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/invoices_items/methods/getInvoiceItems' - insert: [] - update: [] - delete: [] - logins: - id: linode.account.logins - name: logins - title: Logins - methods: - getAccountLogins: - operation: - $ref: '#/paths/~1account~1logins/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getAccountLogins: - operation: - $ref: '#/paths/~1account~1logins/get' - response: - mediaType: application/json - openAPIDocKey: '200' - getAccountLogin: - operation: - $ref: '#/paths/~1account~1logins~1{loginId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getAccountLogin: - operation: - $ref: '#/paths/~1account~1logins~1{loginId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/logins/methods/getAccountLogins' - - $ref: '#/components/x-stackQL-resources/logins/methods/getAccountLogin' - insert: [] - update: [] - delete: [] - maintenance: - id: linode.account.maintenance - name: maintenance - title: Maintenance - methods: - getMaintenance: - operation: - $ref: '#/paths/~1account~1maintenance/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getMaintenance: - operation: - $ref: '#/paths/~1account~1maintenance/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/maintenance/methods/getMaintenance' - insert: [] - update: [] - delete: [] - notifications: - id: linode.account.notifications - name: notifications - title: Notifications - methods: - getNotifications: - operation: - $ref: '#/paths/~1account~1notifications/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getNotifications: - operation: - $ref: '#/paths/~1account~1notifications/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/notifications/methods/getNotifications' - insert: [] - update: [] - delete: [] - oauth_clients: - id: linode.account.oauth_clients - name: oauth_clients - title: Oauth Clients - methods: - getClients: - operation: - $ref: '#/paths/~1account~1oauth-clients/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getClients: - operation: - $ref: '#/paths/~1account~1oauth-clients/get' - response: - mediaType: application/json - openAPIDocKey: '200' - createClient: - operation: - $ref: '#/paths/~1account~1oauth-clients/post' - response: - mediaType: application/json - openAPIDocKey: '200' - getClient: - operation: - $ref: '#/paths/~1account~1oauth-clients~1{clientId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getClient: - operation: - $ref: '#/paths/~1account~1oauth-clients~1{clientId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - updateClient: - operation: - $ref: '#/paths/~1account~1oauth-clients~1{clientId}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - deleteClient: - operation: - $ref: '#/paths/~1account~1oauth-clients~1{clientId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - getClientThumbnail: - operation: - $ref: '#/paths/~1account~1oauth-clients~1{clientId}~1thumbnail/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getClientThumbnail: - operation: - $ref: '#/paths/~1account~1oauth-clients~1{clientId}~1thumbnail/get' - response: - mediaType: application/json - openAPIDocKey: '200' - setClientThumbnail: - operation: - $ref: '#/paths/~1account~1oauth-clients~1{clientId}~1thumbnail/put' - response: - mediaType: application/json - openAPIDocKey: '200' - resetClientSecret: - operation: - $ref: '#/paths/~1account~1oauth-clients~1{clientId}~1reset-secret/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/getClients' - - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/getClient' - insert: - - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/createClient' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/deleteClient' - payment_methods: - id: linode.account.payment_methods - name: payment_methods - title: Payment Methods - methods: - getPaymentMethods: - operation: - $ref: '#/paths/~1account~1payment-methods/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getPaymentMethods: - operation: - $ref: '#/paths/~1account~1payment-methods/get' - response: - mediaType: application/json - openAPIDocKey: '200' - createPaymentMethod: - operation: - $ref: '#/paths/~1account~1payment-methods/post' - response: - mediaType: application/json - openAPIDocKey: '200' - getPaymentMethod: - operation: - $ref: '#/paths/~1account~1payment-methods~1{paymentMethodId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getPaymentMethod: - operation: - $ref: '#/paths/~1account~1payment-methods~1{paymentMethodId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - deletePaymentMethod: - operation: - $ref: '#/paths/~1account~1payment-methods~1{paymentMethodId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - makePaymentMethodDefault: - operation: - $ref: '#/paths/~1account~1payment-methods~1{paymentMethodId}~1make-default/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/payment_methods/methods/getPaymentMethods' - - $ref: '#/components/x-stackQL-resources/payment_methods/methods/getPaymentMethod' - insert: - - $ref: '#/components/x-stackQL-resources/payment_methods/methods/createPaymentMethod' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/payment_methods/methods/deletePaymentMethod' - payments: - id: linode.account.payments - name: payments - title: Payments - methods: - getPayments: - operation: - $ref: '#/paths/~1account~1payments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getPayments: - operation: - $ref: '#/paths/~1account~1payments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - createPayment: - operation: - $ref: '#/paths/~1account~1payments/post' - response: - mediaType: application/json - openAPIDocKey: '202' - getPayment: - operation: - $ref: '#/paths/~1account~1payments~1{paymentId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getPayment: - operation: - $ref: '#/paths/~1account~1payments~1{paymentId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/payments/methods/getPayments' - - $ref: '#/components/x-stackQL-resources/payments/methods/getPayment' - insert: - - $ref: '#/components/x-stackQL-resources/payments/methods/createPayment' - update: [] - delete: [] - payments_paypal: - id: linode.account.payments_paypal - name: payments_paypal - title: Payments Paypal - methods: - createPayPalPayment: - operation: - $ref: '#/paths/~1account~1payments~1paypal/post' - response: - mediaType: application/json - openAPIDocKey: '299' - executePayPalPayment: - operation: - $ref: '#/paths/~1account~1payments~1paypal~1execute/post' - response: - mediaType: application/json - openAPIDocKey: '299' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/payments_paypal/methods/createPayPalPayment' - update: [] - delete: [] - promo_codes: - id: linode.account.promo_codes - name: promo_codes - title: Promo Codes - methods: - createPromoCredit: - operation: - $ref: '#/paths/~1account~1promo-codes/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/promo_codes/methods/createPromoCredit' - update: [] - delete: [] - service_transfers: - id: linode.account.service_transfers - name: service_transfers - title: Service Transfers - methods: - getServiceTransfers: - operation: - $ref: '#/paths/~1account~1service-transfers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getServiceTransfers: - operation: - $ref: '#/paths/~1account~1service-transfers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - createServiceTransfer: - operation: - $ref: '#/paths/~1account~1service-transfers/post' - response: - mediaType: application/json - openAPIDocKey: '200' - getServiceTransfer: - operation: - $ref: '#/paths/~1account~1service-transfers~1{token}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getServiceTransfer: - operation: - $ref: '#/paths/~1account~1service-transfers~1{token}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - deleteServiceTransfer: - operation: - $ref: '#/paths/~1account~1service-transfers~1{token}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - acceptServiceTransfer: - operation: - $ref: '#/paths/~1account~1service-transfers~1{token}~1accept/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/service_transfers/methods/getServiceTransfers' - - $ref: '#/components/x-stackQL-resources/service_transfers/methods/getServiceTransfer' - insert: - - $ref: '#/components/x-stackQL-resources/service_transfers/methods/createServiceTransfer' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/service_transfers/methods/deleteServiceTransfer' - settings: - id: linode.account.settings - name: settings - title: Settings - methods: - getAccountSettings: - operation: - $ref: '#/paths/~1account~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _getAccountSettings: - operation: - $ref: '#/paths/~1account~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - updateAccountSettings: - operation: - $ref: '#/paths/~1account~1settings/put' - response: - mediaType: application/json - openAPIDocKey: '200' - enableAccountManaged: - operation: - $ref: '#/paths/~1account~1settings~1managed-enable/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings/methods/getAccountSettings' - insert: [] - update: [] - delete: [] - transfer: - id: linode.account.transfer - name: transfer - title: Transfer - methods: - getTransfer: - operation: - $ref: '#/paths/~1account~1transfer/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $ - _getTransfer: - operation: - $ref: '#/paths/~1account~1transfer/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/transfer/methods/getTransfer' - insert: [] - update: [] - delete: [] - users: - id: linode.account.users - name: users - title: Users - methods: - getUsers: - operation: - $ref: '#/paths/~1account~1users/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getUsers: - operation: - $ref: '#/paths/~1account~1users/get' - response: - mediaType: application/json - openAPIDocKey: '200' - createUser: - operation: - $ref: '#/paths/~1account~1users/post' - response: - mediaType: application/json - openAPIDocKey: '200' - getUser: - operation: - $ref: '#/paths/~1account~1users~1{username}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.data - _getUser: - operation: - $ref: '#/paths/~1account~1users~1{username}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - updateUser: - operation: - $ref: '#/paths/~1account~1users~1{username}/put' - response: - mediaType: application/json - openAPIDocKey: '200' - deleteUser: - operation: - $ref: '#/paths/~1account~1users~1{username}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - getUserGrants: - operation: - $ref: '#/paths/~1account~1users~1{username}~1grants/get' - response: - mediaType: application/json - openAPIDocKey: '204' - objectKey: $.data - _getUserGrants: - operation: - $ref: '#/paths/~1account~1users~1{username}~1grants/get' - response: - mediaType: application/json - openAPIDocKey: '204' - updateUserGrants: - operation: - $ref: '#/paths/~1account~1users~1{username}~1grants/put' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/users/methods/getUsers' - - $ref: '#/components/x-stackQL-resources/users/methods/getUser' - insert: - - $ref: '#/components/x-stackQL-resources/users/methods/createUser' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/users/methods/deleteUser' -paths: - /account: + - If outside the US or CA, this is the province associated + with the account's `address`. + example: PA + maxLength: 24 + type: string + tax_id: + description: >- + The tax identification number (TIN) assigned to this + account, used for tax calculations. A TIN is set by the + national authorities in your `country`, based on your + `address_1`, and it may be named differently between + countries. Set to an empty string (`""`) if a TIN doesn't + apply or for countries that don't collect tax. + + + > 📘 + + > + + > This value is externally validated. If the validation is + successful, a `tax_id_valid` + [event](https://techdocs.akamai.com/linode-api/reference/get-events) + is triggered. If unsuccessful, a `tax_id_invalid` event is + triggered and an error response is issued for an operation + that included it. + example: ATU99999999 + maxLength: 25 + type: string + zip: + description: >- + The zip code for this account's `address`. + + + - It can only contain ASCII letters, numbers, and dashes + (`-`). + + + - It can't contain more than nine letter or number + characters. + example: 19102-1234 + type: string + type: object + x-akamai: + file-path: schemas/account.yaml + x-example: + x-ref: ../examples/get-account-200.json + description: Returns a single account object. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - account:read_only + summary: Get your account + tags: + - Account + x-akamai: + tabs: + - syntax: linode-cli account view + title: CLI + url: >- + https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: view + x-linode-grant: read_only + put: + description: >- + Updates contact and billing information related to your account. If you + exclude any properties from the request, the operation leaves them + unchanged. + + + > 📘 + + > + + > When updating an account's `country` to `US`, you'll get an error if + the account's `zip` is not a valid US zip code. + + + **Parent and child accounts** + + + In a [parent and child + account](https://www.linode.com/docs/guides/parent-child-accounts/) + environment, the following apply: + + + - You can't change the `company` for a parent account. Akamai uses this + value to set the name for a child account parent user (proxy user) on + any child account. + + + - Child account users can't run this operation. These users don't have + access to billing-related operations. + + + [Learn + more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: https://techdocs.akamai.com/linode-api/reference/put-account + operationId: put-account + requestBody: + content: + application/json: + schema: + additionalProperties: false + description: Account object. + properties: + 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. + + + Simply put, a promotion offers a certain amount of credit + month, until either the expiration date is passed, or + until the total promotional credit is used, whichever + comes first. + properties: + credit_monthly_cap: + description: The amount available to spend per month. + example: '10.00' + type: string + x-linode-cli-display: 5 + credit_remaining: + description: The total amount of credit left for this promotion. + example: '50.00' + type: string + x-linode-cli-display: 3 + description: + description: A detailed description of this promotion. + example: >- + Receive up to $10 off your services every month for 6 + months! Unused credits will expire once this promotion + period ends. + type: string + expire_dt: + description: When this promotion's credits expire. + example: '2018-01-31T23:59:59' + type: string + x-linode-cli-display: 2 + image_url: + description: The location of an image for this promotion. + example: https://linode.com/10_a_month_promotion.svg + type: string + service_type: + description: The service to which this promotion applies. + enum: + - all + - backup + - blockstorage + - db_mysql + - ip_v4 + - linode + - linode_disk + - linode_memory + - longview + - managed + - nodebalancer + - objectstorage + - placement_group + - transfer_tx + example: all + type: string + x-linode-cli-display: 1 + summary: + description: Short details of this promotion. + example: $10 off your Linode a month! + type: string + x-linode-cli-display: 10 + this_month_credit_remaining: + description: >- + The amount of credit left for this month for this + promotion. + example: '10.00' + type: string + x-linode-cli-display: 4 + readOnly: true + type: object + x-akamai: + file-path: schemas/promotion.yaml + readOnly: true + type: array + active_since: + description: __Read-only__ The date and time the account was activated. + example: '{{active_since}}' + format: date-time + readOnly: true + type: string + address_1: + description: The first line of this account's billing address. + example: '{{address_1}}' + maxLength: 64 + type: string + address_2: + description: The second line of this account's billing address. + example: '{{address_2}}' + maxLength: 64 + type: string + balance: + description: __Read-only__ This account's balance, in US dollars. + example: '{{balance}}' + readOnly: true + type: number + x-linode-cli-display: 4 + balance_uninvoiced: + description: >- + __Read-only__ This account's current estimated invoice in US + dollars. This is not your final invoice balance. Transfer + charges are not included in the estimate. + example: '{{balance_uninvoiced}}' + readOnly: true + type: number + x-linode-cli-display: 4 + billing_source: + description: >- + __Read-only__ The source of service charges for this + account. Accounts that are associated with Akamai-specific + customers return a value of `akamai`. All other accounts + return a value of `linode`. + enum: + - akamai + - linode + example: '{{billing_source}}' + readOnly: true + type: string + capabilities: + description: >- + __Read-only__ The Akamai Cloud Computing services your + account supports. + example: + - Linodes + - NodeBalancers + - Block Storage + - Object Storage + - Placement Groups + - Block Storage Encryption + items: + type: string + readOnly: true + type: array + city: + description: The city for this account's `address`. + example: '{{city}}' + maxLength: 24 + type: string + company: + description: >- + The company name assigned to this account. This value can't + include the characters, `<` `>` `(` `)` `"` `=`. + example: '{{company}}' + maxLength: 128 + type: string + country: + description: >- + The two-letter ISO 3166 country code for this account's + `address`. + example: '{{country}}' + type: string + credit_card: + additionalProperties: false + description: >- + __Read-only__ The credit card information assigned to this + account. + properties: + expiry: + description: The expiration month and year of the `credit_card`. + example: 11/2022 + type: string + last_four: + description: >- + The last four digits of the `credit_card` assigned to + this account. + example: 1111 + type: string + readOnly: true + type: object + email: + description: The email address of the person assigned to this account. + example: '{{email}}' + maxLength: 128 + type: string + x-linode-cli-display: 3 + euuid: + description: >- + __Read-only__ An external unique identifier for this + account. + example: '{{euuid}}' + format: uuid + readOnly: true + type: string + first_name: + description: >- + The first name of the person assigned to this account. This + value can't include the characters, `<` `>` `(` `)` `"` `=`. + example: '{{first_name}}' + maxLength: 50 + type: string + x-linode-cli-display: 1 + last_name: + description: >- + The last name of the person assigned to this account. This + value can't include the characters, `<` `>` `(` `)` `"` `=`. + example: '{{last_name}}' + maxLength: 50 + type: string + x-linode-cli-display: 2 + phone: + description: The phone number assigned to this account. + example: '{{phone}}' + maxLength: 32 + type: string + state: + description: >- + The state or province for the `address` set for your + account, if applicable. + + + - If the `address` is in the United States (US) or Canada + (CA), this is the two-letter ISO 3166 code for the state or + province. + + + - If it's a US military `address`, this is the abbreviation + for that territory. This includes `AA` for Armed Forces + Americas (excluding Canada), `AE` for Armed Forces Africa, + Europe, Middle East, and Canada, or `AP` for Armed Forces + Pacific. + + + - If outside the US or CA, this is the province associated + with the account's `address`. + example: '{{state}}' + maxLength: 24 + type: string + tax_id: + description: >- + The tax identification number (TIN) assigned to this + account, used for tax calculations. A TIN is set by the + national authorities in your `country`, based on your + `address_1`, and it may be named differently between + countries. Set to an empty string (`""`) if a TIN doesn't + apply or for countries that don't collect tax. + + + > 📘 + + > + + > This value is externally validated. If the validation is + successful, a `tax_id_valid` + [event](https://techdocs.akamai.com/linode-api/reference/get-events) + is triggered. If unsuccessful, a `tax_id_invalid` event is + triggered and an error response is issued for an operation + that included it. + example: '{{tax_id}}' + maxLength: 25 + type: string + zip: + description: >- + The zip code for this account's `address`. + + + - It can only contain ASCII letters, numbers, and dashes + (`-`). + + + - It can't contain more than nine letter or number + characters. + example: '{{zip}}' + type: string + type: object + x-akamai: + file-path: schemas/account.yaml + x-example: + x-ref: ../examples/put-account.json + description: Updated contact and billing information. + required: true + responses: + '200': + content: + application/json: + schema: + additionalProperties: false + description: Account object. + properties: + 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. + + + Simply put, a promotion offers a certain amount of + credit month, until either the expiration date is + passed, or until the total promotional credit is used, + whichever comes first. + properties: + credit_monthly_cap: + description: The amount available to spend per month. + example: '10.00' + type: string + x-linode-cli-display: 5 + credit_remaining: + description: The total amount of credit left for this promotion. + example: '50.00' + type: string + x-linode-cli-display: 3 + description: + description: A detailed description of this promotion. + example: >- + Receive up to $10 off your services every month for + 6 months! Unused credits will expire once this + promotion period ends. + type: string + expire_dt: + description: When this promotion's credits expire. + example: '2018-01-31T23:59:59' + type: string + x-linode-cli-display: 2 + image_url: + description: The location of an image for this promotion. + example: https://linode.com/10_a_month_promotion.svg + type: string + service_type: + description: The service to which this promotion applies. + enum: + - all + - backup + - blockstorage + - db_mysql + - ip_v4 + - linode + - linode_disk + - linode_memory + - longview + - managed + - nodebalancer + - objectstorage + - placement_group + - transfer_tx + example: all + type: string + x-linode-cli-display: 1 + summary: + description: Short details of this promotion. + example: $10 off your Linode a month! + type: string + x-linode-cli-display: 10 + this_month_credit_remaining: + description: >- + The amount of credit left for this month for this + promotion. + example: '10.00' + type: string + x-linode-cli-display: 4 + readOnly: true + type: object + x-akamai: + file-path: schemas/promotion.yaml + readOnly: true + type: array + active_since: + description: __Read-only__ The date and time the account was activated. + example: '2018-01-01T00:01:01' + format: date-time + readOnly: true + type: string + address_1: + description: The first line of this account's billing address. + example: 123 Main Street + maxLength: 64 + type: string + address_2: + description: The second line of this account's billing address. + example: Suite A + maxLength: 64 + type: string + balance: + description: __Read-only__ 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. + 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`. + enum: + - akamai + - linode + example: akamai + readOnly: true + type: string + capabilities: + description: >- + __Read-only__ The Akamai Cloud Computing services your + account supports. + example: + - Linodes + - NodeBalancers + - Block Storage + - Object Storage + - Placement Groups + - Block Storage Encryption + items: + type: string + readOnly: true + type: array + city: + description: The city for this account's `address`. + example: Philadelphia + maxLength: 24 + type: string + company: + description: >- + The company name assigned to this account. This value + can't include the characters, `<` `>` `(` `)` `"` `=`. + example: Linode LLC + maxLength: 128 + type: string + country: + description: >- + The two-letter ISO 3166 country code for this account's + `address`. + example: US + type: string + credit_card: + additionalProperties: false + description: >- + __Read-only__ The credit card information assigned to this + account. + properties: + expiry: + description: The expiration month and year of the `credit_card`. + example: 11/2022 + type: string + last_four: + description: >- + The last four digits of the `credit_card` assigned to + this account. + example: 1111 + type: string + readOnly: true + type: object + email: + description: The email address of the person assigned to this account. + example: john.smith@linode.com + maxLength: 128 + type: string + x-linode-cli-display: 3 + euuid: + description: >- + __Read-only__ An external unique identifier for this + account. + example: E1AF5EEC-526F-487D-B317EBEB34C87D71 + format: uuid + readOnly: true + type: string + first_name: + description: >- + The first name of the person assigned to this account. + This value can't include the characters, `<` `>` `(` `)` + `"` `=`. + example: John + maxLength: 50 + type: string + x-linode-cli-display: 1 + last_name: + description: >- + The last name of the person assigned to this account. This + value can't include the characters, `<` `>` `(` `)` `"` + `=`. + example: Smith + maxLength: 50 + type: string + x-linode-cli-display: 2 + phone: + description: The phone number assigned to this account. + example: 215-555-1212 + maxLength: 32 + type: string + state: + description: >- + The state or province for the `address` set for your + account, if applicable. + + + - If the `address` is in the United States (US) or Canada + (CA), this is the two-letter ISO 3166 code for the state + or province. + + + - If it's a US military `address`, this is the + abbreviation for that territory. This includes `AA` for + Armed Forces Americas (excluding Canada), `AE` for Armed + Forces Africa, Europe, Middle East, and Canada, or `AP` + for Armed Forces Pacific. + + + - If outside the US or CA, this is the province associated + with the account's `address`. + example: PA + maxLength: 24 + type: string + tax_id: + description: >- + The tax identification number (TIN) assigned to this + account, used for tax calculations. A TIN is set by the + national authorities in your `country`, based on your + `address_1`, and it may be named differently between + countries. Set to an empty string (`""`) if a TIN doesn't + apply or for countries that don't collect tax. + + + > 📘 + + > + + > This value is externally validated. If the validation is + successful, a `tax_id_valid` + [event](https://techdocs.akamai.com/linode-api/reference/get-events) + is triggered. If unsuccessful, a `tax_id_invalid` event is + triggered and an error response is issued for an operation + that included it. + example: ATU99999999 + maxLength: 25 + type: string + zip: + description: >- + The zip code for this account's `address`. + + + - It can only contain ASCII letters, numbers, and dashes + (`-`). + + + - It can't contain more than nine letter or number + characters. + example: 19102-1234 + type: string + type: object + x-akamai: + file-path: schemas/account.yaml + x-example: + x-ref: ../examples/get-account-200.json + description: The updated account. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - account:read_write + summary: Update your account + tags: + - Account + x-akamai: + tabs: + - syntax: |- + linode-cli account update \ + --address_1 "123 Main St." \ + --address_2 "Suite 101" \ + --city Philadelphia \ + --company My Company \ LLC \ + --country US \ + --email jsmith@mycompany.com \ + --first_name John \ + --last_name Smith \ + --phone 555-555-1212 \ + --state PA \ + --tax_id ATU99999999 \ + --zip 19102 + title: CLI + url: >- + https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_write + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: update + x-linode-grant: read_write + parameters: [] + x-akamai: + file-path: paths/account.yaml + path-info: /{apiVersion}/account + x-linode-cli-command: account + /account/agreements: + post: + description: >- + Accept required agreements by setting them to `true`. This remains until + the content of the agreement changes. If it does, you need to run this + operation again to accept it. If you set this to `false`, the API + rejects the request and you need to open a [support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) to + reset the agreement. Omitted agreements are left unchanged. __OAuth + scopes__. + + ``` + account:read_write + ``` + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: >- + https://techdocs.akamai.com/linode-api/reference/post-account-agreements + operationId: post-account-agreements + requestBody: + content: + application/json: + schema: + additionalProperties: false + description: >- + Acknowledgment status for agreements on your account. When + acknowledging any agreements, set them to `true` and omit any + remainders. + properties: + billing_agreement: + description: >- + Certain regions require that you share your tax + identification number (TIN) with Akamai. When you do, you + need to acknowledge Akamai's [privacy + statement](https://www.akamai.com/legal/privacy-statement) + agreement, in regards to its protection. When set to `true`, + you've acknowledged this agreement. + example: '{{billing_agreement}}' + type: boolean + eu_model: + description: >- + The acknowledgement status for the [cross-border data + transfer](https://www.akamai.com/legal/compliance/privacy-trust-center/cross-border-data-transfer-statement) + agreement. + example: '{{eu_model}}' + type: boolean + master_service_agreement: + description: >- + The acknowledgement status for Akamai's [master service + agreement](https://www.linode.com/legal-msa/). + example: '{{master_service_agreement}}' + type: boolean + privacy_policy: + description: >- + The acknowledgement status for Akamai's [privacy + statement](https://www.akamai.com/legal/privacy-statement). + example: '{{privacy_policy}}' + type: boolean + type: object + x-akamai: + file-path: schemas/agreements.yaml + x-example: + x-ref: ../examples/post-agreements.json + required: true + responses: + '200': + content: + application/json: + schema: + description: The API responds with an empty object. + maxProperties: 0 + type: object + x-akamai: + file-path: schemas/added-empty-obj.yaml + x-example: + x-ref: ../examples/post-account-agreements-200.json + description: Agreements updated successfully. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - account:read_write + summary: Acknowledge agreements + tags: + - Account agreements + x-akamai: + tabs: + - syntax: account:read_write + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: post-agreements + x-linode-cli-skip: true + x-linode-grant: unrestricted only + get: + description: >- + Returns all agreements and their acceptance status for your account. + __OAuth scopes__. + + ``` + account:read_only + ``` + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: >- + https://techdocs.akamai.com/linode-api/reference/get-account-agreements + operationId: get-account-agreements + responses: + '200': + content: + application/json: + schema: + additionalProperties: false + description: >- + Acknowledgment status for agreements on your account. When + acknowledging any agreements, set them to `true` and omit any + remainders. + properties: + billing_agreement: + description: >- + Certain regions require that you share your tax + identification number (TIN) with Akamai. When you do, you + need to acknowledge Akamai's [privacy + statement](https://www.akamai.com/legal/privacy-statement) + agreement, in regards to its protection. When set to + `true`, you've acknowledged this agreement. + type: boolean + eu_model: + description: >- + The acknowledgement status for the [cross-border data + transfer](https://www.akamai.com/legal/compliance/privacy-trust-center/cross-border-data-transfer-statement) + agreement. + example: true + type: boolean + master_service_agreement: + description: >- + The acknowledgement status for Akamai's [master service + agreement](https://www.linode.com/legal-msa/). + example: true + type: boolean + privacy_policy: + description: >- + The acknowledgement status for Akamai's [privacy + statement](https://www.akamai.com/legal/privacy-statement). + example: true + type: boolean + type: object + x-akamai: + file-path: schemas/agreements.yaml + x-example: + x-ref: ../examples/get-acceptance-agreement-200.json + description: The status of each acceptance agreement for your account. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - account:read_only + summary: List agreements + tags: + - Account agreements + x-akamai: + tabs: + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: agreements + x-linode-cli-skip: true + x-linode-grant: unrestricted only + parameters: [] + x-akamai: + file-path: paths/account-agreements.yaml + path-info: /{apiVersion}/account/agreements + x-linode-cli-command: agreements + /account/availability: + get: + description: >- + Returns a paginated list of the services available to you, for all + Linode regions. + + + > 📘 + + > + + > Only authorized users can run this operation. + + + [Learn + more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: https://techdocs.akamai.com/linode-api/reference/get-availability + operationId: get-availability + parameters: + - description: The page of a collection to return. + example: '{{page}}' + in: query + name: page + required: false + schema: + default: 1 + example: 6 + minimum: 1 + type: integer + x-akamai: + file-path: parameters/page-offset.yaml + - description: The number of items to return per page. + example: '{{page_size}}' + in: query + name: page_size + schema: + default: 100 + example: 50 + maximum: 500 + minimum: 25 + type: integer + x-akamai: + file-path: parameters/page-size.yaml + responses: + '200': + content: + application/json: + schema: + allOf: + - additionalProperties: false + properties: + data: + items: + additionalProperties: false + description: Account Service Availability object. + properties: + available: + description: >- + __Read-only__ A list of services _available_ to + your account in the `region`. + example: + - Linodes + - NodeBalancers + items: + type: string + readOnly: true + type: array + region: + description: >- + __Read-only__ The Akamai cloud computing data + center (region), represented by a slug value. + You can view a full list of regions and their + associated slugs with the [List + regions](https://techdocs.akamai.com/linode-api/reference/get-regions) + operation. + example: us-east + readOnly: true + type: string + x-linode-cli-display: 1 + unavailable: + description: >- + __Read-only__ A list of services _unavailable_ + to your account in the `region`. + example: + - Kubernetes + - Block Storage + items: + type: string + readOnly: true + type: array + x-linode-cli-display: 3 + type: object + x-akamai: + file-path: schemas/account-availability.yaml + type: array + type: object + - additionalProperties: false + description: >- + An envelope for paginated response. When accessing a + collection through a GET endpoint, the results are wrapped + in this envelope which includes metadata about those + results. Results are presented within a `data` array. See + [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) + for more information. + properties: + page: + description: >- + __Read-only__ The current + [page](https://techdocs.akamai.com/linode-api/reference/pagination). + example: 1 + readOnly: true + type: integer + pages: + description: >- + __Read-only__ The total number of + [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + example: 1 + readOnly: true + type: integer + results: + description: __Read-only__ The total number of results. + example: 1 + readOnly: true + type: integer + type: object + x-akamai: + file-path: schemas/pagination-envelope.yaml + x-akamai: + file-path: schemas/added-get-availability-200.yaml + x-example: + x-ref: ../examples/get-availability-200.json + description: List of regions and the services available in each. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - account:read_only + summary: List available services + tags: + - Account availability + x-akamai: + tabs: + - syntax: linode-cli account get-availability + title: CLI + url: >- + https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: get-availability + x-linode-grant: read_only + parameters: [] + x-akamai: + file-path: paths/account-availability.yaml + path-info: /{apiVersion}/account/availability + x-linode-cli-command: account + /account/availability/{id}: + get: + description: >- + View the available services for your account, in a specific region. + + + > 📘 + + > + + > Only account users with _unrestricted_ access can run this operation. + + + [Learn + more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: >- + https://techdocs.akamai.com/linode-api/reference/get-account-availability + operationId: get-account-availability + responses: + '200': + content: + application/json: + schema: + additionalProperties: false + description: Account Service Availability object. + properties: + available: + description: >- + __Read-only__ A list of services _available_ to your + account in the `region`. + example: + - Linodes + - NodeBalancers + items: + type: string + readOnly: true + type: array + region: + description: >- + __Read-only__ The Akamai cloud computing data center + (region), represented by a slug value. You can view a full + list of regions and their associated slugs with the [List + regions](https://techdocs.akamai.com/linode-api/reference/get-regions) + operation. + example: us-east + readOnly: true + type: string + x-linode-cli-display: 1 + unavailable: + description: >- + __Read-only__ A list of services _unavailable_ to your + account in the `region`. + example: + - Kubernetes + - Block Storage + items: + type: string + readOnly: true + type: array + x-linode-cli-display: 3 + type: object + x-akamai: + file-path: schemas/account-availability.yaml + x-example: + x-ref: ../examples/get-account-availability-200.json + description: The services available in the specified region. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - account:read_only + summary: Get a region's service availability + tags: + - Account + x-akamai: + tabs: + - syntax: linode-cli account get-account-availability us-east + title: CLI + url: >- + https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: get-account-availability + x-linode-grant: read_only + parameters: + - description: >- + The slug for the applicable data center. Run the [List + regions](https://techdocs.akamai.com/linode-api/reference/get-regions) + operation to view the slug for each data center. + example: '{{id}}' + in: path + name: id + required: true + schema: + type: string + x-akamai: + file-path: parameters/id-path.yaml + x-akamai: + file-path: paths/data-center.yaml + path-info: /{apiVersion}/account/availability/{id} + x-linode-cli-command: account + /account/betas: + post: + description: >- + Enroll your Account in an active Beta Program. + + + Only unrestricted Users can access this operation. + + + To view active Beta Programs, run the [List beta + programs](https://techdocs.akamai.com/linode-api/reference/get-beta-programs) + operation. + + + Active Beta Programs may have a limited number of enrollments. If a Beta + Program has reached is maximum number of enrollments, an error is + returned even though the request is successful. + + + Beta Programs with `"greenlight_only": true` can only be enrolled by + Accounts that participate in the + [Greenlight](https://www.linode.com/green-light/) program. + + + [Learn + more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: https://techdocs.akamai.com/linode-api/reference/post-beta-program + operationId: post-beta-program + requestBody: + content: + application/json: + schema: + additionalProperties: false + description: The Beta Program ID to enroll in for your Account. + properties: + id: + description: The unique identifier of the Beta Program. + example: '{{id}}' + type: string + x-linode-cli-display: 1 + required: + - id + type: object + x-akamai: + file-path: schemas/added-post-beta-program.yaml + x-example: + x-ref: ../examples/post-beta-program.json + description: Updated information for the Managed MySQL Database. + required: true + responses: + '200': + content: + application/json: + schema: + description: The API responds with an empty object. + maxProperties: 0 + type: object + x-akamai: + file-path: schemas/added-empty-obj.yaml + x-example: + x-ref: ../examples/post-beta-program-200.json + description: Enrollment request successful. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - account:read_write + summary: Enroll in a Beta program + tags: + - Beta programs + x-akamai: + tabs: + - syntax: linode-cli betas enroll --id example_open + title: CLI + url: >- + https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_write + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: enroll + x-linode-grant: unrestricted only + get: + description: >- + Display all enrolled Beta Programs for your Account. Includes inactive + as well as active Beta Programs. + + + Only unrestricted Users can access this operation. + + + [Learn + more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: >- + https://techdocs.akamai.com/linode-api/reference/get-enrolled-beta-programs + operationId: get-enrolled-beta-programs + parameters: + - description: The page of a collection to return. + example: '{{page}}' + in: query + name: page + required: false + schema: + default: 1 + example: 6 + minimum: 1 + type: integer + x-akamai: + file-path: parameters/page-offset.yaml + - description: The number of items to return per page. + example: '{{page_size}}' + in: query + name: page_size + schema: + default: 100 + example: 50 + maximum: 500 + minimum: 25 + type: integer + x-akamai: + file-path: parameters/page-size.yaml + responses: + '200': + content: + application/json: + example: + data: + - description: This is an open public beta for an example feature. + ended: null + enrolled: '2023-09-11T00:00:00' + id: example_open + label: Example Open Beta + started: '2023-07-11T00:00:00' + page: 1 + pages: 1 + results: 1 + schema: + allOf: + - additionalProperties: false + description: >- + An envelope for paginated response. When accessing a + collection through a GET endpoint, the results are wrapped + in this envelope which includes metadata about those + results. Results are presented within a `data` array. See + [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) + for more information. + properties: + page: + description: >- + __Read-only__ The current + [page](https://techdocs.akamai.com/linode-api/reference/pagination). + example: 1 + readOnly: true + type: integer + pages: + description: >- + __Read-only__ The total number of + [pages](https://techdocs.akamai.com/linode-api/reference/pagination). + example: 1 + readOnly: true + type: integer + results: + description: __Read-only__ The total number of results. + example: 1 + readOnly: true + type: integer + type: object + x-akamai: + file-path: schemas/pagination-envelope.yaml + - properties: + data: + items: + additionalProperties: false + description: >- + An object representing an enrolled Beta Program for + the Account. + properties: + description: + description: >- + __Read-only__ Additional details regarding the + Beta Program. + example: >- + This is an open public beta for an example + feature. + nullable: true + readOnly: true + type: string + x-linode-cli-display: 3 + ended: + description: >- + __Filterable__, __Read-only__ The date-time that + the Beta Program ended. + + + `null` indicates that the Beta Program is + ongoing. + example: null + format: date-time + nullable: true + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 5 + x-linode-filterable: true + enrolled: + description: >- + __Filterable__, __Read-only__ The date-time of + Account enrollment to the Beta Program. + example: '2023-09-11T00:00:00' + format: date-time + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 6 + x-linode-filterable: true + id: + description: The unique identifier of the Beta Program. + example: example_open + type: string + x-linode-cli-display: 1 + label: + description: >- + __Filterable__, __Read-only__ The name of the + Beta Program. + example: Example Open Beta + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 2 + x-linode-filterable: true + started: + description: >- + __Filterable__, __Read-only__ The start + date-time of the Beta Program. + example: '2023-07-11T00:00:00' + format: date-time + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 4 + x-linode-filterable: true + type: object + x-akamai: + file-path: schemas/beta-program-enrolled.yaml + type: array + type: object + x-akamai: + file-path: schemas/added-get-enrolled-beta-programs-200.yaml + description: >- + Returns a paginated list of all enrolled Beta Program objects for + the Account. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - account:read_only + summary: List enrolled Beta programs + tags: + - Beta programs + x-akamai: + tabs: + - syntax: linode-cli betas enrolled + title: CLI + url: >- + https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: enrolled + x-linode-grant: unrestricted only + parameters: [] + x-akamai: + file-path: paths/account-betas.yaml + path-info: /{apiVersion}/account/betas + x-linode-cli-command: betas + /account/betas/{betaId}: + get: + description: >- + Display an enrolled Beta Program for your Account. The Beta Program may + be inactive. + + + Only unrestricted Users can access this operation. + + + [Learn + more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: >- + https://techdocs.akamai.com/linode-api/reference/get-enrolled-beta-program + operationId: get-enrolled-beta-program + responses: + '200': + content: + application/json: + schema: + additionalProperties: false + description: >- + An object representing an enrolled Beta Program for the + Account. + properties: + description: + description: >- + __Read-only__ Additional details regarding the Beta + Program. + example: This is an open public beta for an example feature. + nullable: true + readOnly: true + type: string + x-linode-cli-display: 3 + ended: + description: >- + __Filterable__, __Read-only__ The date-time that the Beta + Program ended. + + + `null` indicates that the Beta Program is ongoing. + example: null + format: date-time + nullable: true + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 5 + x-linode-filterable: true + enrolled: + description: >- + __Filterable__, __Read-only__ The date-time of Account + enrollment to the Beta Program. + example: '2023-09-11T00:00:00' + format: date-time + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 6 + x-linode-filterable: true + id: + description: The unique identifier of the Beta Program. + example: example_open + type: string + x-linode-cli-display: 1 + label: + description: >- + __Filterable__, __Read-only__ The name of the Beta + Program. + example: Example Open Beta + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 2 + x-linode-filterable: true + started: + description: >- + __Filterable__, __Read-only__ The start date-time of the + Beta Program. + example: '2023-07-11T00:00:00' + format: date-time + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 4 + x-linode-filterable: true + type: object + x-akamai: + file-path: schemas/beta-program-enrolled.yaml + x-example: + x-ref: ../examples/get-enrolled-beta-program-200.json + description: Returns an enrolled Beta Program object for the Account. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - account:read_only + summary: Get an enrolled Beta program + tags: + - Beta programs + x-akamai: + tabs: + - syntax: linode-cli betas enrolled-view $betaId + title: CLI + url: >- + https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: enrolled-view + x-linode-grant: unrestricted only + parameters: + - description: The ID of the Beta Program. + example: '{{betaId}}' + in: path + name: betaId + required: true + schema: + type: string + x-akamai: + file-path: parameters/beta-id.yaml + x-akamai: + file-path: paths/account-beta.yaml + path-info: /{apiVersion}/account/betas/{betaId} + x-linode-cli-command: betas + /account/cancel: + post: + description: >- + Deletes an active account. Akamai attempts to charge the credit card on + file for any remaining balance. An error occurs if this charge fails. + + + > 🚧 + + > + + > - This operation permanently deletes your account and it _can't_ be + recovered. Also, there is no warning prompt after you execute this + operation. + + > + + > - Only account users with _unrestricted_ access can run this + operation. + + + __Parent and child accounts__ + + + In a [parent and child + account](https://www.linode.com/docs/guides/parent-child-accounts/) + environment, the following apply: + + + - A child account user can't remove a child account. + + + - You can't remove a parent account if it has an active child account. + + + - You need to work with your Akamai account team to dissolve any + parent-child account relationships before you can fully remove a child + or parent account. + + + [Learn + more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: https://techdocs.akamai.com/linode-api/reference/post-cancel-account + operationId: post-cancel-account + requestBody: + content: + application/json: + schema: + additionalProperties: false + properties: + comments: + description: >- + Any reason for cancelling the account, and any other + comments you might have about your Linode service. + example: '{{comments}}' + type: string + type: object + x-akamai: + file-path: schemas/added-post-cancel-account.yaml + x-example: + x-ref: ../examples/post-cancel-account.json + description: >- + Supply a comment stating the reason that you are cancelling your + account. + required: true + responses: + '200': + content: + application/json: + schema: + additionalProperties: false + example: + survey_link: https://alinktothesurvey.com + properties: + survey_link: + description: A link to Linode's exit survey. + type: string + type: object + x-akamai: + file-path: schemas/added-post-cancel-account-200.yaml + x-example: + x-ref: ../examples/post-cancel-account-200.json + description: Account canceled. + '409': + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + properties: + reason: + description: >- + A string explaining that the account could not be + canceled because there is an outstanding balance on + the account that must be paid first. + example: >- + We were unable to charge your credit card for + services rendered. We cannot cancel this account + until the balance has been paid. + type: string + type: object + type: array + type: object + x-akamai: + file-path: schemas/added-post-cancel-account-409.yaml + x-example: + x-ref: ../examples/tbd.json + description: Could not charge the credit card on file. + x-akamai: + file-path: errors/409.yaml + '504': + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + properties: + reason: + description: >- + A string explaining that the account is taking + longer to close than expected. + example: >- + Cancellation is taking longer than expected. It may + have been successful. Contact customer support to + confirm. + type: string + type: object + type: array + type: object + x-akamai: + file-path: schemas/added-post-cancel-account-504.yaml + 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 + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - account:read_write + summary: Delete your account + tags: + - Account + x-akamai: + tabs: + - syntax: |- + linode-cli account cancel \ + --comments "I'm consolidating my accounts" + title: CLI + url: >- + https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: account:read_write + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: cancel + x-linode-grant: read_write + parameters: [] + x-akamai: + file-path: paths/account-cancel.yaml + path-info: /{apiVersion}/account/cancel + x-linode-cli-command: account + /account/child-accounts: + get: + description: >- + Returns a paginated list of basic information for the child accounts + that exist for your parent account. See [Parent and Child Accounts for + Akamai + Partners](https://www.linode.com/docs/guides/parent-child-accounts/) for + details on these accounts. + + + > 📘 + + > + + > This operation can only be accessed by an unrestricted parent user, or + restricted parent user with the `child_account_access` grant. + + + [Learn + more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: https://techdocs.akamai.com/linode-api/reference/get-child-accounts + operationId: get-child-accounts + parameters: + - description: The page of a collection to return. + example: '{{page}}' + in: query + name: page + required: false + schema: + default: 1 + example: 6 + minimum: 1 + type: integer + x-akamai: + file-path: parameters/page-offset.yaml + - description: The number of items to return per page. + example: '{{page_size}}' + in: query + name: page_size + schema: + default: 100 + example: 50 + maximum: 500 + minimum: 25 + type: integer + x-akamai: + file-path: parameters/page-size.yaml + responses: + '200': + content: + application/json: + schema: + additionalProperties: false + properties: + data: + items: + additionalProperties: false + description: Child account object. + properties: + active_since: + description: >- + __Read-only__ The activation date and time for the + child account. + example: '2018-01-01T00:01:01' + format: date-time + readOnly: true + type: string + address_1: + description: >- + __Filterable__ First line of this child account's + billing address. + example: 123 Main Street + maxLength: 64 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + address_2: + description: >- + __Filterable__ Second line of this child account's + billing address, if applicable. + example: Suite A + maxLength: 64 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + balance: + description: >- + __Read-only__ This child account's balance, in US + dollars. + example: 200 + readOnly: true + type: number + x-linode-cli-display: 4 + balance_uninvoiced: + description: >- + __Read-only__ This child account's current estimated + invoice in US dollars. This is not your final + invoice balance. Transfer charges are not included + in the estimate. + example: 145 + readOnly: true + type: number + x-linode-cli-display: 4 + billing_source: + description: >- + __Read-only__ The source of service charges for this + account, as determined by its relationship with + Akamai. The API returns a value of `external` to + describe a child account in a parent-child account + environment. + enum: + - external + example: external + readOnly: true + type: string + capabilities: + description: >- + __Read-only__ A list of the capabilities the child + account supports. + example: + - Linodes + - NodeBalancers + - Block Storage + - Object Storage + items: + type: string + readOnly: true + type: array + city: + description: >- + __Filterable__ The city for this child account's + billing address. + example: San Diego + maxLength: 24 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + company: + description: >- + __Filterable__ The company name for the owner of + this child account. It can't include any of these + characters: `<` `>` `(` `)` `"` `=`. You can't + change this value yourself. We use it to create the + proxy users that a parent account uses to access a + child account. Talk to your account team if you need + to change this value. + example: Acme + maxLength: 128 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + country: + description: >- + __Filterable__ The two-letter ISO 3166 country code + for this child account's billing address. + example: US + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + credit_card: + additionalProperties: false + description: >- + __Read-only__ Information for the credit card you've + assigned to this child account. + properties: + expiry: + description: >- + The expiration month and year of the credit + card. + example: 11/2024 + type: string + last_four: + description: The last four digits of the credit card. + example: 1111 + type: string + readOnly: true + type: object + email: + description: >- + __Filterable__ The email address of the owner of + this child account. + example: john.smith@linode.com + maxLength: 128 + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 3 + x-linode-filterable: true + euuid: + description: >- + __Read-only__ An external, unique identifier that + Akamai assigned to the child account. + example: A1BC2DEF-34GH-567I-J890KLMN12O34P56 + 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: `<` `>` `(` `)` `"` `=`. + example: John + maxLength: 50 + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 1 + x-linode-filterable: true + last_name: + description: >- + __Filterable__ The last name of the owner of this + child account. It can't include any of these + characters: `<` `>` `(` `)` `"` `=`. + example: Smith + maxLength: 50 + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 2 + x-linode-filterable: true + phone: + description: >- + __Filterable__ The phone number for the owner of + this child account. + example: 858-555-1212 + maxLength: 32 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + state: + description: >- + __Filterable__ The state or province for the billing + address (`address_1` and `address_2, if + applicable`). If in the United States (US) or Canada + (CA), this is the two-letter ISO 3166 State or + Province code. + + + > 📘 + + > + + > If this is a US military address, use state + abbreviations (AA, AE, AP). + example: CA + maxLength: 24 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + tax_id: + description: >- + The tax identification number for this child + account. Use this for tax calculations in some + countries. If you live in a country that doesn't + collect taxes, ensure this is an empty string + (`""`). + example: ATU99999999 + maxLength: 25 + type: string + zip: + description: >- + __Filterable__ The zip code of this Account's + billing address. The following restrictions apply: + + + - Can only contain ASCII letters, numbers, and + hyphens (`-`). + + - Can't contain more than 9 letter or number + characters. + example: 92111-1234 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + type: object + x-akamai: + file-path: schemas/child-account.yaml + type: array + page: + description: >- + __Read-only__ The current + [page](https://techdocs.akamai.com/linode-api/reference/pagination). + 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-child-accounts-200.yaml + x-example: + x-ref: ../examples/get-child-accounts-200.json + description: Returns child-level accounts. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - child_account:read_only + summary: List child accounts + tags: + - Child accounts + x-akamai: + tabs: + - syntax: linode-cli child-account list + title: CLI + url: >- + https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: child_account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: + - list + - ls + x-linode-grant: child_account_access + parameters: [] + x-akamai: + file-path: paths/child-accounts.yaml + path-info: /{apiVersion}/account/child-accounts + x-linode-cli-command: child-account + /account/child-accounts/{euuid}: + get: + description: >- + View a specific child account based on its `euuid`. See [Parent and + Child Accounts for Akamai + Partners](https://www.linode.com/docs/guides/parent-child-accounts/) for + details on these accounts. + + + > 📘 + + > + + > This operation can only be accessed by an unrestricted user, or + restricted user with the `child_account_access` grant. + + + [Learn + more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: https://techdocs.akamai.com/linode-api/reference/get-child-account + operationId: get-child-account + responses: + '200': + content: + application/json: + schema: + additionalProperties: false + description: Child account object. + properties: + active_since: + description: >- + __Read-only__ The activation date and time for the child + account. + example: '2018-01-01T00:01:01' + format: date-time + readOnly: true + type: string + address_1: + description: >- + __Filterable__ First line of this child account's billing + address. + example: 123 Main Street + maxLength: 64 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + address_2: + description: >- + __Filterable__ Second line of this child account's billing + address, if applicable. + example: Suite A + maxLength: 64 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + balance: + description: __Read-only__ This child account's balance, in US dollars. + example: 200 + readOnly: true + type: number + x-linode-cli-display: 4 + balance_uninvoiced: + description: >- + __Read-only__ This child account's current estimated + invoice in US dollars. This is not your final invoice + balance. Transfer charges are not included in the + estimate. + example: 145 + readOnly: true + type: number + x-linode-cli-display: 4 + billing_source: + description: >- + __Read-only__ The source of service charges for this + account, as determined by its relationship with Akamai. + The API returns a value of `external` to describe a child + account in a parent-child account environment. + enum: + - external + example: external + readOnly: true + type: string + capabilities: + description: >- + __Read-only__ A list of the capabilities the child account + supports. + example: + - Linodes + - NodeBalancers + - Block Storage + - Object Storage + items: + type: string + readOnly: true + type: array + city: + description: >- + __Filterable__ The city for this child account's billing + address. + example: San Diego + maxLength: 24 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + company: + description: >- + __Filterable__ The company name for the owner of this + child account. It can't include any of these characters: + `<` `>` `(` `)` `"` `=`. You can't change this value + yourself. We use it to create the proxy users that a + parent account uses to access a child account. Talk to + your account team if you need to change this value. + example: Acme + maxLength: 128 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + country: + description: >- + __Filterable__ The two-letter ISO 3166 country code for + this child account's billing address. + example: US + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + credit_card: + additionalProperties: false + description: >- + __Read-only__ Information for the credit card you've + assigned to this child account. + properties: + expiry: + description: The expiration month and year of the credit card. + example: 11/2024 + type: string + last_four: + description: The last four digits of the credit card. + example: 1111 + type: string + readOnly: true + type: object + email: + description: >- + __Filterable__ The email address of the owner of this + child account. + example: john.smith@linode.com + maxLength: 128 + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 3 + x-linode-filterable: true + euuid: + description: >- + __Read-only__ An external, unique identifier that Akamai + assigned to the child account. + example: A1BC2DEF-34GH-567I-J890KLMN12O34P56 + 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: `<` `>` + `(` `)` `"` `=`. + example: John + maxLength: 50 + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 1 + x-linode-filterable: true + last_name: + description: >- + __Filterable__ The last name of the owner of this child + account. It can't include any of these characters: `<` `>` + `(` `)` `"` `=`. + example: Smith + maxLength: 50 + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 2 + x-linode-filterable: true + phone: + description: >- + __Filterable__ The phone number for the owner of this + child account. + example: 858-555-1212 + maxLength: 32 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + state: + description: >- + __Filterable__ The state or province for the billing + address (`address_1` and `address_2, if applicable`). If + in the United States (US) or Canada (CA), this is the + two-letter ISO 3166 State or Province code. + + + > 📘 + + > + + > If this is a US military address, use state + abbreviations (AA, AE, AP). + example: CA + maxLength: 24 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + tax_id: + description: >- + The tax identification number for this child account. Use + this for tax calculations in some countries. If you live + in a country that doesn't collect taxes, ensure this is an + empty string (`""`). + example: ATU99999999 + maxLength: 25 + type: string + zip: + description: >- + __Filterable__ The zip code of this Account's billing + address. The following restrictions apply: + + + - Can only contain ASCII letters, numbers, and hyphens + (`-`). + + - Can't contain more than 9 letter or number characters. + example: 92111-1234 + type: string + x-akamai: + labels: + - Filterable + x-linode-filterable: true + type: object + x-akamai: + file-path: schemas/child-account.yaml + x-example: + x-ref: ../examples/get-child-account-200.json + description: Returns the child-level account for a specified `euuid`. + default: + content: + application/json: + schema: + additionalProperties: false + properties: + errors: + items: + additionalProperties: false + description: >- + An object for describing a single error that occurred + during the processing of a request. + properties: + field: + description: >- + The field in the request that caused this error. + This may be a path, separated by periods in the case + of nested fields. In some cases this may come back + as `null` if the error is not specific to any single + element of the request. + example: fieldname + type: string + reason: + description: >- + What happened to cause this error. In most cases, + this can be fixed immediately by changing the data + you sent in the request, but in some cases you will + be instructed to [Open a support + ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) + or perform some other action before you can complete + the request successfully. + example: fieldname must be a valid value + type: string + type: object + x-akamai: + file-path: schemas/error-object.yaml + type: array + type: object + description: >- + See + [Errors](https://techdocs.akamai.com/linode-api/reference/errors) + for the range of possible error response codes. + security: + - personalAccessToken: [] + - oauth: + - child_account:read_only + summary: Get a child account + tags: + - Child accounts + x-akamai: + tabs: + - syntax: linode-cli child-account view A1BC2DEF-34GH-567I-J890KLMN12O34P56 + title: CLI + url: >- + https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli + - syntax: child_account:read_only + title: OAuth scopes + url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth + x-linode-cli-action: + - view + x-linode-grant: child_account_access + parameters: + - description: >- + The child account to look up. You can run the [List child + accounts](https://techdocs.akamai.com/linode-api/reference/get-child-accounts) + operation to find the applicable account and store its `euuid`. + example: '{{euuid}}' + in: path + name: euuid + required: true + schema: + type: string + x-akamai: + file-path: parameters/eeuid.yaml + x-akamai: + file-path: paths/child-account.yaml + path-info: /{apiVersion}/account/child-accounts/{euuid} + x-linode-cli-command: child-account + /account/child-accounts/{euuid}/token: + post: + description: >- + Create a short-lived bearer token for a parent user on a child account, + using the `euuid` of that child account. In the context of the API, a + parent user on a child account is referred to as a "proxy user." When + Akamai provisions your parent-child account environment, a proxy user is + automatically set in the child account. It follows a specific naming + convention: + + _ + + > 📘 + + > + + > These variables only use the first 15 and 16 characters of these + values, respectively. + + + The token lets a parent account run API operations through the proxy + user, as if they are a child user in the child account. + + + These points apply to the use of this operation: + + + - To create a token, a parent account user needs the + `child_account_access` grant. This lets them use the proxy user on the + child account. You can run [List a user's + grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) + on a parent account user to check its `child_account_access` setting. To + add this access, you can + [update](https://techdocs.akamai.com/linode-api/reference/put-user-grants) + the parent account user. + + + - The created token inherits the permissions of the proxy user. It will + never have less. + + + - The API returns the raw token in the response. You can't get it again, + so be sure to store it. + + + Example workflow: + + + 1. [List child + accounts](https://techdocs.akamai.com/linode-api/reference/get-child-accounts) + and store the `euuid` for the applicable one. + + 2. Run this operation and store the `token` that's created for the proxy + user. + + 3. As a parent account user with access to the proxy user in the child + account, use this `token` to authenticate API operations, as if you were + a child user. + + + [Learn + more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) + + + [Learn + more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth) + externalDocs: + description: See documentation for this operation in Akamai's Linode API + url: >- + https://techdocs.akamai.com/linode-api/reference/post-child-account-token + operationId: post-child-account-token + responses: + '200': + content: + application/json: + schema: + additionalProperties: false + description: >- + The token generated manually for a child account so its proxy + user can access the API and CLI without going through an OAuth + login. + properties: + created: + description: >- + __Filterable__, __Read-only__ The date and time this token + was created. + example: '2024-05-01T00:01:01' + format: date-time + readOnly: true + type: string + x-akamai: + labels: + - Filterable + x-linode-cli-display: 4 + x-linode-filterable: true + expiry: + description: >- + __Read-only__ When this token expires. This is default set + to 15 minutes from the time of creation. Proxy user tokens + can't be renewed. After this time, Akamai revokes the + token and you need to generate a new one. + example: '2024-05-01T00:16:01' + format: date-time + readOnly: true + type: string + x-linode-cli-display: 6 + id: + description: >- + __Read-only__ The proxy user token's unique ID, which can + be used to revoke it. + example: 918 + readOnly: true + type: integer + x-linode-cli-display: 1 + label: + description: >- + __Filterable__ The name of the token. The API + automatically sets this to `__