Linode API

Entity Transfer Accept **DEPRECATED**. Please use [Service Transfer Accept](/docs/api/account/#service-transfer-accept).

Service Transfer Accept Accept a Service Transfer for the provided token to receive the services included in the transfer to your account. At this time, only Linodes can be transferred. When accepted, email confirmations are sent to the accounts that created and accepted the transfer. A transfer can take up to three hours to complete once accepted. Once a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account. This command can only be accessed by the unrestricted users of the account that receives the transfer. Users of the same account that created a transfer cannot accept the transfer. There are several conditions that must be met in order to accept a transfer request: 1. Only transfers with a `pending` status can be accepted. 1. The account accepting the transfer must have a registered payment method and must not have a past due balance or other account limitations for the services to be transferred. 1. Both the account that created the transfer and the account that is accepting the transfer must not have any active Terms of Service violations. 1. The service must still be owned by the account that created the transfer. 1. Linodes must not: * be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service. * have any attached Block Storage Volumes. * have any shared IP addresses. * have any assigned /56, /64, or /116 IPv6 ranges. Any and all of the above conditions must be cured and maintained by the relevant account prior to the transfer's expiration to allow the transfer to be accepted by the receiving account.

Configuration Profile Create Adds a new Configuration profile to a Linode.

Disk Create Adds a new Disk to a Linode. * You can optionally create a Disk from an Image or an Empty Disk if no Image is provided with a request. * When creating an Empty Disk, providing a `label` is required. * If no `label` is provided, an `image` is required instead. * When creating a Disk from an Image, `root_pass` is required. * The default filesystem for new Disks is `ext4`. If creating a Disk from an Image, the filesystem of the Image is used unless otherwise specified. * When deploying a StackScript on a Disk: * See StackScripts List ([GET /linode/stackscripts](/docs/api/stackscripts/#stackscripts-list)) for a list of available StackScripts. * Requires a compatible Image to be supplied. * See StackScript View ([GET /linode/stackscript/{stackscriptId}](/docs/api/stackscripts/#stackscript-view)) for compatible Images. * It is recommended to supply SSH keys for the root User using the `authorized_keys` field. * You may also supply a list of usernames via the `authorized_users` field. * These users must have an SSH Key associated with their Profiles first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information.

IPv4 Address Allocate Allocates a public or private IPv4 address to a Linode. Public IP Addresses, after the one included with each Linode, incur an additional monthly charge. If you need an additional public IP Address you must request one - please [open a support ticket](/docs/api/support/#support-ticket-open). You may not add more than one private IPv4 address to a single Linode.

SSH Key Add Adds an SSH Key to your Account profile.

StackScript Create Creates a StackScript in your Account.

IP Address Allocate Allocates a new IPv4 Address on your Account. The Linode must be configured to support additional addresses - please [open a support ticket](/docs/api/support/#support-ticket-open) requesting additional addresses before attempting allocation.

IP Addresses Assign Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes. The following restrictions apply: * All Linodes involved must have at least one public IPv4 address after assignment. * Linodes may have no more than one assigned private IPv4 address. * Linodes may have no more than one assigned IPv6 range. [Open a Support Ticket](/docs/api/support/#support-ticket-open) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits. **Note**: Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following commands: * **Linode's Managed Settings View** ([GET /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-view)) * **Linode's Managed Settings Update** ([PUT /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-update))

Linodes Assign IPv4s This command is equivalent to **IP Addresses Assign** ([POST /networking/ips/assign](#ip-addresses-assign)). Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes. The following restrictions apply: * All Linodes involved must have at least one public IPv4 address after assignment. * Linodes may have no more than one assigned private IPv4 address. * Linodes may have no more than one assigned IPv6 range. [Open a Support Ticket](/docs/api/support/#support-ticket-open) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits. **Note**: Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following commands: * **Linode's Managed Settings View** ([GET /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-view)) * **Linode's Managed Settings Update** ([PUT /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-update))

Volume Attach Attaches a Volume on your Account to an existing Linode on your Account. In order for this request to complete successfully, your User must have `read_only` or `read_write` permission to the Volume and `read_write` permission to the Linode. Additionally, the Volume and Linode must be located in the same Region.

Linode Boot Boots a Linode you have permission to modify. If no parameters are given, a Config profile will be chosen for this boot based on the following criteria: * If there is only one Config profile for this Linode, it will be used. * If there is more than one Config profile, the last booted config will be used. * If there is more than one Config profile and none were the last to be booted (because the Linode was never booted or the last booted config was deleted) an error will be returned.

Account Cancel Cancels an active Linode account. This action will cause Linode to attempt to charge the credit card on file for the remaining balance. An error will occur if Linode fails to charge the credit card on file. Restricted users will not be able to cancel an account.

Backups Cancel Cancels the Backup service on the given Linode. Deletes all of this Linode's existing backups forever.

Object Storage Cancel Cancel Object Storage on an Account. **Warning**: Removes all buckets and their contents from your Account. This data is irretrievable once removed.

Domain Clone Clones a Domain and all associated DNS records from a Domain that is registered in Linode's DNS manager.

Disk Clone Copies a disk, byte-for-byte, into a new Disk belonging to the same Linode. The Linode must have enough storage space available to accept a new Disk of the same size as this one or this operation will fail.

Linode Clone You can clone your Linode's existing Disks or Configuration profiles to another Linode on your Account. In order for this request to complete successfully, your User must have the `add_linodes` grant. Cloning to a new Linode will incur a charge on your Account. If cloning to an existing Linode, any actions currently running or queued must be completed first before you can clone to it. Up to five clone operations from any given source Linode can be run concurrently. If more concurrent clones are attempted, an HTTP 400 error will be returned by this endpoint. Any [tags](/docs/api/tags/#tags-list) existing on the source Linode will be cloned to the target Linode.

Volume Clone Creates a Volume on your Account. In order for this request to complete successfully, your User must have the `add_volumes` grant. The new Volume will have the same size and data as the source Volume. Creating a new Volume will incur a charge on your Account. * Only Volumes with a `status` of "active" can be cloned.

Support Ticket Close Closes a Support Ticket you have access to modify.

OAuth Client Create Creates an OAuth Client, which can be used to allow users (using their Linode account) to log in to your own application, and optionally grant your application some amount of access to their Linodes or other entities.

Credit Card Add/Edit **DEPRECATED**. Please use Payment Method Add ([POST /account/payment-methods](/docs/api/account/#payment-method-add)). Adds a credit card Payment Method to your account and sets it as the default method.

Domain Create Adds a new Domain to Linode's DNS Manager. Linode is not a registrar, and you must own the domain before adding it here. Be sure to point your registrar to Linode's nameservers so that the records hosted here are used.

Domain Record Create Adds a new Domain Record to the zonefile this Domain represents. Each domain can have up to 12,000 active records.

Entity Transfer Create **DEPRECATED**. Please use [Service Transfer Create](/docs/api/account/#service-transfer-create).

Firewall Device Create Creates a Firewall Device, which assigns a Firewall to a service (referred to as the Device's `entity`) and applies the Firewall's Rules to the device. * Currently, only Devices with an entity of type `linode` are accepted. * A Firewall can be assigned to multiple Linode instances at a time. * A Linode instance can have one active, assigned Firewall at a time. Additional disabled Firewalls can be assigned to a service, but they cannot be enabled if another active Firewall is already assigned to the same service. * A `firewall_device_add` Event is generated when the Firewall Device is added successfully.

Firewall Create Creates a Firewall to filter network traffic. * Use the `rules` property to create inbound and outbound access rules. * Use the `devices` property to assign the Firewall to a service and apply its Rules to the device. Requires `read_write` [User's Grants](/docs/api/account/#users-grants-view) to the device. Currently, Firewalls can only be assigned to Linode instances. * A Firewall can be assigned to multiple Linode instances at a time. * A Linode instance can have one active, assigned Firewall at a time. Additional disabled Firewalls can be assigned to a service, but they cannot be enabled if another active Firewall is already assigned to the same service. * A `firewall_create` Event is generated when this endpoint returns successfully.

Image Create Captures a private gold-master Image from a Linode Disk.

Kubernetes Cluster Create Creates a Kubernetes cluster. The Kubernetes cluster will be created asynchronously. You can use the events system to determine when the Kubernetes cluster is ready to use. Please note that it often takes 2-5 minutes before the [Kubernetes API server endpoint](/docs/api/linode-kubernetes-engine-lke/#kubernetes-api-endpoints-list) and the [Kubeconfig file](/docs/api/linode-kubernetes-engine-lke/#kubeconfig-view) for the new cluster are ready.

Linode Create Creates a Linode Instance on your Account. In order for this request to complete successfully, your User must have the `add_linodes` grant. Creating a new Linode will incur a charge on your Account. Linodes can be created using one of the available Types. See Types List ([GET /linode/types](/docs/api/linode-types/#types-list)) to get more information about each Type's specs and cost. Linodes can be created in any one of our available Regions, which are accessible from the Regions List ([GET /regions](/docs/api/regions/#regions-list)) endpoint. In an effort to fight spam, Linode restricts outbound connections on ports 25, 465, and 587 on all Linodes for new accounts created after November 5th, 2019. For more information, see [Sending Email on Linode](/docs/guides/running-a-mail-server/#sending-email-on-linode). Linodes can be created in a number of ways: * Using a Linode Public Image distribution or a Private Image you created based on another Linode. * Access the Images List ([GET /images](/docs/api/images/#images-list)) endpoint with authentication to view all available Images. * The Linode will be `running` after it completes `provisioning`. * A default config with two Disks, one being a 512 swap disk, is created. * `swap_size` can be used to customize the swap disk size. * Requires a `root_pass` be supplied to use for the root User's Account. * It is recommended to supply SSH keys for the root User using the `authorized_keys` field. * You may also supply a list of usernames via the `authorized_users` field. * These users must have an SSH Key associated with your Profile first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information. * Using a StackScript. * See StackScripts List ([GET /linode/stackscripts](/docs/api/stackscripts/#stackscripts-list)) for a list of available StackScripts. * The Linode will be `running` after it completes `provisioning`. * Requires a compatible Image to be supplied. * See StackScript View ([GET /linode/stackscript/{stackscriptId}](/docs/api/stackscripts/#stackscript-view)) for compatible Images. * Requires a `root_pass` be supplied to use for the root User's Account. * It is recommended to supply SSH keys for the root User using the `authorized_keys` field. * You may also supply a list of usernames via the `authorized_users` field. * These users must have an SSH Key associated with your Profile first. See SSH Key Add ([POST /profile/sshkeys](/docs/api/profile/#ssh-key-add)) for more information. * Using one of your other Linode's backups. * You must create a Linode large enough to accommodate the Backup's size. * The Disks and Config will match that of the Linode that was backed up. * The `root_pass` will match that of the Linode that was backed up. * Attached to a private VLAN. * Review the `interfaces` property of the [Request Body Schema](/docs/api/linode-instances/#linode-create__request-body-schema) for details. * For more information, see our guide on [Getting Started with VLANs](/docs/products/networking/vlans/get-started/). * Create an empty Linode. * The Linode will remain `offline` and must be manually started. * See Linode Boot ([POST /linode/instances/{linodeId}/boot](/docs/api/linode-instances/#linode-boot)). * Disks and Configs must be created manually. * This is only recommended for advanced use cases. **Important**: You must be an unrestricted User in order to add or modify tags on Linodes.

Longview Client Create Creates a Longview Client. This Client will not begin monitoring the status of your server until you configure the Longview Client application on your Linode using the returning `install_code` and `api_key`.

Managed Contact Create Creates a Managed Contact. A Managed Contact is someone Linode special forces can contact in the course of attempting to resolve an issue with a Managed Service. This command can only be accessed by the unrestricted users of an account.

Managed Credential Create Creates a Managed Credential. A Managed Credential is stored securely to allow Linode special forces to access your Managed Services and resolve issues. This command can only be accessed by the unrestricted users of an account.

Managed Service Create Creates a Managed Service. Linode Managed will begin monitoring this service and reporting and attempting to resolve any Issues. This command can only be accessed by the unrestricted users of an account.

NodeBalancer Create Creates a NodeBalancer in the requested Region. NodeBalancers require a port Config with at least one backend Node to start serving requests. When using the Linode CLI to create a NodeBalancer, first create a NodeBalancer without any Configs. Then, create Configs and Nodes for that NodeBalancer with the respective [Config Create](/docs/api/nodebalancers/#config-create) and [Node Create](/docs/api/nodebalancers/#node-create) commands.

Config Create Creates a NodeBalancer Config, which allows the NodeBalancer to accept traffic on a new port. You will need to add NodeBalancer Nodes to the new Config before it can actually serve requests.

Node Create Creates a NodeBalancer Node, a backend that can accept traffic for this NodeBalancer Config. Nodes are routed requests on the configured port based on their status.

Object Storage Bucket Create Creates an Object Storage Bucket in the specified cluster. Accounts with negative balances cannot access this command. If the bucket already exists and is owned by you, this endpoint returns a `200` response with that bucket as if it had just been created. This endpoint is available for convenience. It is recommended that instead you use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket) directly.

Object Storage Key Create Provisions a new Object Storage Key on your account. Accounts with negative balances cannot access this command. * To create a Limited Access Key with specific permissions, send a `bucket_access` array. * To create a Limited Access Key without access to any buckets, send an empty `bucket_access` array. * To create an Access Key with unlimited access to all clusters and all buckets, omit the `bucket_access` array.

Object Storage Object URL Create Creates a pre-signed URL to access a single Object in a bucket. This can be used to share objects, and also to create/delete objects by using the appropriate HTTP method in your request body's `method` parameter. This endpoint is available for convenience. It is recommended that instead you use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/) directly.

Object Storage TLS/SSL Cert Upload Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS. Your TLS/SSL certificate and private key are stored encrypted at rest. To replace an expired certificate, [delete your current certificate](/docs/api/object-storage/#object-storage-tlsssl-cert-delete) and upload a new one.

PayPal Payment Stage **Note**: This endpoint is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](/docs/products/platform/billing/guides/payment-methods/).

Payment Make Makes a Payment to your Account. * The requested amount is charged to the default Payment Method if no `payment_method_id` is specified. * A `payment_submitted` event is generated when a payment is successfully submitted.

Payment Method Add Adds a Payment Method to your Account with the option to set it as the default method. * Adding a default Payment Method removes the default status from any other Payment Method. * An Account can have up to 6 active Payment Methods. * Up to 60 Payment Methods can be added each day. * Prior to adding a Payment Method, ensure that your billing address information is up-to-date with a valid `zip` by using the Account Update ([PUT /account](/docs/api/account/#account-update)) endpoint. * A `payment_method_add` event is generated when a payment is successfully submitted.

Personal Access Token Create Creates a Personal Access Token for your User. The raw token will be returned in the response, but will never be returned again afterward so be sure to take note of it. You may create a token with _at most_ the scopes of your current token. The created token will be able to access your Account until the given expiry, or until it is revoked.

Promo Credit Add Adds an expiring Promo Credit to your account. The following restrictions apply: * Your account must be less than 90 days old. * There must not be an existing Promo Credit already on your account. * The requesting User must be unrestricted. Use the User Update ([PUT /account/users/{username}](/docs/api/account/#user-update)) to change a User's restricted status. * The `promo_code` must be valid and unexpired.

Service Transfer Create Creates a transfer request for the specified services. A request can contain any of the specified service types and any number of each service type. At this time, only Linodes can be transferred. When created successfully, a confirmation email is sent to the account that created this transfer containing a transfer token and instructions on completing the transfer. When a transfer is [accepted](/docs/api/account/#service-transfer-accept), the requested services are moved to the receiving account. Linode services will not experience interruptions due to the transfer process. Backups for Linodes are transferred as well. DNS records that are associated with requested services will not be transferred or updated. Please ensure that associated DNS records have been updated or communicated to the recipient prior to the transfer. A transfer can take up to three hours to complete once accepted. When a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account. This command can only be accessed by the unrestricted users of an account. There are several conditions that must be met in order to successfully create a transfer request: 1. The account creating the transfer must not have a past due balance or active Terms of Service violation. 1. The service must be owned by the account that is creating the transfer. 1. The service must not be assigned to another Service Transfer that is pending or that has been accepted and is incomplete. 1. Linodes must not: * be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service. * have any attached Block Storage Volumes. * have any shared IP addresses. * have any assigned /56, /64, or /116 IPv6 ranges.

Snapshot Create Creates a snapshot Backup of a Linode. **Important:** If you already have a snapshot of this Linode, this is a destructive action. The previous snapshot will be deleted.

New Tag Create Creates a new Tag and optionally tags requested objects with it immediately. **Important**: You must be an unrestricted User in order to add or modify Tags.

Support Ticket Open Open a Support Ticket. Only one of the ID attributes (`linode_id`, `domain_id`, etc.) can be set on a single Support Ticket.