Linode

Akamai: Linode API

Add a Cloud Computing instance so you can build, release, and scale applications faster with virtual machines.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Add a Cloud Computing instance so you can build, release, and scale applications faster with virtual machines.

Endpoints 400

Account

  • GETGet your account/:apiVersion/accountReturns the contact and billing information related to your account. <<LB>> __CLI__. linode-cli account view Learn more... __OAuth scopes__. account:read_only…
  • PUTUpdate your account/:apiVersion/accountUpdates contact and billing information related to your account. If you exclude any properties from the request, the operation leaves them unchanged. > 📘 > >…
  • POSTDelete your account/:apiVersion/account/cancelDeletes an active account. Akamai attempts to charge the credit card on file for any remaining balance. An error occurs if this charge fails. > 🚧 > > - This…

Account availability

  • GETList available services/:apiVersion/account/availability?page={{page}}&page_size={{page_size}}Returns a paginated list of the services available to you, for all Linode regions. > 📘 > > Only authorized users can run this operation. <<LB>> __CLI__.…
  • GETGet available services for a region/:apiVersion/account/availability/:regionIdView the available services for your account, in a specific region. > 📘 > > Only account users with _unrestricted_ access can run this operation. <<LB>>…

Account settings

  • GETGet account settings/:apiVersion/account/settingsReturns information related to your Account settings: Managed service subscription, interface settings for new Linodes, Longview subscription, and Network…
  • PUTUpdate account settings/:apiVersion/account/settingsUpdates your account settings. For a Longview subscription plan, see Update a Longview plan. <<LB>> __CLI__. linode-cli account settings-update \…
  • POSTEnable Linode Managed/:apiVersion/account/settings/managed-enableEnables Linode Managed for the entire account and sends a welcome email to the account's associated email address. Linode Managed can monitor any service or…

Account agreements

  • GETList agreements/:apiVersion/account/agreementsReturns all agreements and their acceptance status for your account. <<LB>> __OAuth scopes__. account:read_only Learn more...
  • POSTAcknowledge agreements/:apiVersion/account/agreementsAccept 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…

Account transfer

  • GETGet network usage/:apiVersion/account/transferReturns a Transfer object showing your network utilization, in GB, for the current month. <<LB>> __CLI__. linode-cli account transfer Learn more... __OAuth…

Beta programs

  • GETList enrolled Beta programs/:apiVersion/account/betas?page={{page}}&page_size={{page_size}}Display all enrolled Beta Programs for your Account. Includes inactive as well as active Beta Programs. Only unrestricted Users can access this operation.…
  • POSTEnroll in a Beta program/:apiVersion/account/betasEnroll your Account in an active Beta Program. Only unrestricted Users can access this operation. To view active Beta Programs, run the List beta programs…
  • GETGet an enrolled Beta program/:apiVersion/account/betas/:betaIdDisplay an enrolled Beta Program for your Account. The Beta Program may be inactive. Only unrestricted Users can access this operation. <<LB>> __CLI__.…
  • GETList Beta programs/:apiVersion/betas?page={{page}}&page_size={{page_size}}Display all active Beta Programs. Only unrestricted Users can access this operation. <<LB>> __CLI__. linode-cli betas list Learn more...
  • GETGet a Beta program/:apiVersion/betas/:betaIdDisplay information about a Beta Program. This operation can be used to access inactive as well as active Beta Programs. Only unrestricted Users can access…

Child accounts

  • GETList child accounts/:apiVersion/account/child-accounts?page={{page}}&page_size={{page_size}}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 for…
  • GETGet a child account/:apiVersion/account/child-accounts/:euuIdView a specific child account. See Parent and Child Accounts for Akamai Partners for details on these accounts. > 📘 > > This operation can only be accessed by…
  • POSTCreate a proxy user token/:apiVersion/account/child-accounts/:euuId/tokenCreate a short-lived bearer token for a parent user on a specific child account. In the context of the API, a parent user on a child account is referred to as…

Entity transfers

  • GETList entity transfers/:apiVersion/account/entity-transfers?page={{page}}&page_size={{page_size}}Deprecated. __Deprecated__ Please run List service transfers. <<LB>> __OAuth scopes__. account:read_only Learn more...
  • POSTCreate an entity transfer/:apiVersion/account/entity-transfersDeprecated. __Deprecated__ Please run Request a service transfer. <<LB>> __OAuth scopes__. account:read_write Learn more...
  • GETGet an entity transfer/:apiVersion/account/entity-transfers/:tokenDeprecated. __Deprecated__ Please run Get a service transfer request. <<LB>> __OAuth scopes__. account:read_only Learn more...
  • DELETECancel an entity transfer/:apiVersion/account/entity-transfers/:tokenDeprecated. __Deprecated__ Please run Cancel a service transfer. <<LB>> __OAuth scopes__. account:read_write Learn more...
  • POSTAccept an entity transfer/:apiVersion/account/entity-transfers/:token/acceptDeprecated. __Deprecated__ Please run Accept a service transfer. <<LB>> __OAuth scopes__. account:read_write Learn more...

Events

  • GETList events/:apiVersion/account/events?page={{page}}&page_size={{page_size}}Returns a collection of event objects that represent actions you've taken on your account, over the last 90 days. The events returned depend on your user…
  • GETGet an event/:apiVersion/account/events/:eventIdReturns a single event object. <<LB>> __CLI__. linode-cli events view 123 Learn more... __OAuth scopes__. events:read_only Learn more...
  • POSTMark an event as seen/:apiVersion/account/events/:eventId/seenAcknowledge an event by marking it as seen. > 📘 > > On June 17, 2025, the "Mark an event as read" operation was sunset. Attempts to call it will return a 404.…

Invoices

  • GETList invoices/:apiVersion/account/invoices?page={{page}}&page_size={{page_size}}Returns a paginated list of invoices against your account. <<LB>> __CLI__. linode-cli account invoices-list Learn more... __OAuth scopes__. account:read_only…
  • GETGet an invoice/:apiVersion/account/invoices/:invoiceIdReturns a single Invoice object. <<LB>> __CLI__. linode-cli account invoice-view 123 Learn more... __OAuth scopes__. account:read_only Learn more...
  • GETList invoice items/:apiVersion/account/invoices/:invoiceId/items?page={{page}}&page_size={{page_size}}Returns a paginated list of Invoice items. <<LB>> __CLI__. linode-cli account invoice-items 123 Learn more... __OAuth scopes__. account:read_only Learn more...

Logins

  • GETList user logins/:apiVersion/account/loginsReturns a collection of successful logins for all users on the account during the last 90 days. This operation can only be accessed by the unrestricted users…
  • GETGet an account login/:apiVersion/account/logins/:loginIdReturns a Login object that displays information about a successful login. The logins that can be viewed can be for any user on the account, and are not…
  • GETList logins/:apiVersion/profile/loginsReturns a collection of successful account logins from this user during the last 90 days. <<LB>> __CLI__. linode-cli profile logins-list Learn more... __OAuth…
  • GETGet a profile's login/:apiVersion/profile/logins/:loginIdReturns a login object displaying information about a successful account login from this user. <<LB>> __CLI__. linode-cli profile login-view 1234 Learn…

Maintenances

  • GETList maintenances/:apiVersion/account/maintenanceReturns maintenance information for any entity your user has permissions to view. If a maintenance object has been canceled, it's not returned. > 📘 > >…

Notifications

  • GETList notifications/:apiVersion/account/notificationsReturns notifications that represent important, often time-sensitive details about your account. You can't interact directly with notifications, and a…

OAuth clients

  • GETList OAuth clients/:apiVersion/account/oauth-clients?page={{page}}&page_size={{page_size}}Returns a paginated list of OAuth Clients registered to your Account. OAuth Clients allow users to log into applications you write or host using their Linode…
  • POSTCreate an OAuth client/:apiVersion/account/oauth-clientsCreates 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…
  • GETGet an OAuth client/:apiVersion/account/oauth-clients/:clientIdReturns information about a single OAuth client. <<LB>> __CLI__. linode-cli account client-view \ edc6790ea9db4d224c5c Learn more... __OAuth scopes__.…
  • PUTUpdate an OAuth client/:apiVersion/account/oauth-clients/:clientIdUpdate information about an OAuth Client on your Account. This can be especially useful to update the redirect_uri of your client in the event that the…
  • DELETEDelete an OAuth client/:apiVersion/account/oauth-clients/:clientIdDeletes an OAuth Client registered with Linode. The Client ID and Client secret will no longer be accepted by login.linode.com, and all tokens issued to this…
  • POSTReset an OAuth client secret/:apiVersion/account/oauth-clients/:clientId/reset-secretResets the OAuth Client secret for a client you own, and returns the OAuth Client with the plaintext secret. This secret is not supposed to be publicly known…

Payment methods

  • GETList payment methods/:apiVersion/account/payment-methods?page={{page}}&page_size={{page_size}}Returns a paginated list of Payment Methods for this Account. <<LB>> __CLI__. linode-cli payment-methods list Learn more... __OAuth scopes__.…
  • POSTAdd a payment method/:apiVersion/account/payment-methodsAdds 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…
  • GETGet a payment method/:apiVersion/account/payment-methods/:paymentMethodIdView the details of the specified Payment Method. <<LB>> __CLI__. linode-cli payment-methods view 123 Learn more... __OAuth scopes__. account:read_only Learn…
  • DELETEDelete a payment method/:apiVersion/account/payment-methods/:paymentMethodIdDeactivate the specified Payment Method. The default Payment Method can not be deleted. To add a new default Payment Method, run the Add a payment method…
  • POSTSet a default payment method/:apiVersion/account/payment-methods/:paymentMethodId/make-defaultMake the specified Payment Method the default method for automatically processing payments. Removes the default status from any other Payment Method. __Parent…

Payments

  • POSTAdd or edit a credit card/:apiVersion/account/credit-cardDeprecated. __Deprecated__ Please run Add a payment method. Adds a credit card Payment Method to your account and sets it as the default method. <<LB>>…
  • GETList payments/:apiVersion/account/payments?page={{page}}&page_size={{page_size}}Returns a paginated list of payments made on this Account. <<LB>> __CLI__. linode-cli account payments-list Learn more... __OAuth scopes__. account:read_only…
  • POSTMake a payment/:apiVersion/account/paymentsMakes 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…
  • POSTStage a PayPal payment/:apiVersion/account/payments/paypalDeprecated. __Deprecated__ This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the…
  • POSTExecute a PayPal payment/:apiVersion/account/payments/paypal/executeDeprecated. __Deprecated__ This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the…
  • GETGet a payment/:apiVersion/account/payments/:paymentIdReturns information about a specific Payment. <<LB>> __CLI__. linode-cli account payment-view 123 Learn more... __OAuth scopes__. account:read_only Learn…

Promo credits

  • POSTAdd a promo credit/:apiVersion/account/promo-codesAdds an expiring Promo Credit to your account. The following restrictions apply: Your account needs to be less than 90 days old. You can't already have a…

Service transfers

  • GETList service transfers/:apiVersion/account/service-transfers?page={{page}}&page_size={{page_size}}Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer. This…
  • POSTRequest a service transfer/:apiVersion/account/service-transfersCreates 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…
  • GETGet a service transfer request/:apiVersion/account/service-transfers/:tokenReturns the details of the Service Transfer for the provided token. While a transfer is pending, any unrestricted user _of any account_ can access this…
  • DELETECancel a service transfer/:apiVersion/account/service-transfers/:tokenCancels the Service Transfer for the provided token. Once canceled, a transfer cannot be accepted or otherwise acted on in any way. If canceled in error, the…
  • POSTAccept a service transfer/:apiVersion/account/service-transfers/:token/acceptAccept 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…

Users

  • GETList users/:apiVersion/account/users?page={{page}}&page_size={{page_size}}Returns a paginated list of all users on your account. > 📘 > > This operation can only be accessed by account users with _unrestricted_ access. Talk to your…
  • POSTCreate a user/:apiVersion/account/usersCreates a user on your account. You determine the new user's account access by setting it to restricted or unrestricted and by defining its grants. After…
  • GETGet a user/:apiVersion/account/users/:usernameReturns information about a single user on your account. > 📘 > > This operation can only be accessed by account users with _unrestricted_ access. Talk to your…
  • PUTUpdate a user/:apiVersion/account/users/:usernameUpdate information about a user on your account, including its restricted status. When setting a user to restricted, the API sets no grants for it. You need…
  • DELETEDelete a user/:apiVersion/account/users/:usernameDeletes a user. The API immediately logs the user out and removes all of its grants. > 📘 > > This operation can only be accessed by account users with…
  • GETList a user's grants/:apiVersion/account/users/:username/grantsReturns the full grants structure for an account username you specify. This includes all entities on the account, and the level of access this user has to…
  • PUTUpdate a user's grants/:apiVersion/account/users/:username/grantsUpdate the grants for a restricted user. This can be used to give a user access to new entities or actions, or take access away. Omit a grant object from the…

Databases

  • GETList Managed Databases/:apiVersion/databases/instances?page={{page}}&page_size={{page_size}}Display all Managed Databases accessible to your user, regardless of engine type. For more detailed information on a particular database instance, make a…
  • GETList MySQL Managed Databases/:apiVersion/databases/mysql/instances?page={{page}}&page_size={{page_size}}Display all accessible MySQL Managed Databases. <<LB>> __CLI__. linode-cli databases mysql-list Learn more... __OAuth scopes__. databases:read_only Learn…
  • POSTCreate or restore a MySQL Managed Database/:apiVersion/databases/mysql/instancesProvision a MySQL Managed Database Use this operation to create a new MySQL Managed Database. Restricted users need the add_databases user grant. New…
  • GETGet a MySQL Managed Database/:apiVersion/databases/mysql/instances/:instanceIdDisplay information for a single, accessible MySQL Managed Database. <<LB>> __CLI__. linode-cli databases mysql-view 123 Learn more... __OAuth scopes__.…
  • PUTUpdate a MySQL Managed Database/:apiVersion/databases/mysql/instances/:instanceIdMake changes to an existing MySQL Managed Database. The user needs read_write user grant access to the database. The database's status needs to be active. New…
  • DELETEDelete a MySQL Managed Database/:apiVersion/databases/mysql/instances/:instanceIdRemove a MySQL Managed Database from your account. The user needs read_write user grant access to the database. The database's status can be active, failed,…
  • POSTPatch a MySQL Managed Database/:apiVersion/databases/mysql/instances/:instanceId/patchApply security patches and updates to the underlying operating system of the MySQL Managed Database. This function runs during regular maintenance windows,…
  • POSTResume a MySQL Managed Database/:apiVersion/databases/mysql/instances/:instanceId/resumeResume a suspended MySQL Managed Database from your account. This resumes billing for the cluster. The user needs read_write user grant access to the…
  • POSTSuspend a MySQL Managed Database/:apiVersion/databases/mysql/instances/:instanceId/suspendSuspend a MySQL Managed Database from your account, releasing idle resources and keeping only necessary data. All service data is lost if there are no backups…
  • GETList PostgreSQL Managed Databases/:apiVersion/databases/postgresql/instances?page={{page}}&page_size={{page_size}}Display all accessible PostgreSQL Managed Databases. <<LB>> __CLI__. linode-cli databases postgresql-list Learn more... __OAuth scopes__. databases:read_only…
  • POSTCreate or restore a PostgreSQL Managed Database/:apiVersion/databases/postgresql/instancesProvision a PostgreSQL Managed Database Use this operation to create a new PostgreSQL Managed Database. Restricted users need the add_databases user grant.…
  • GETGet a PostgreSQL Managed Database/:apiVersion/databases/postgresql/instances/:instanceIdDisplay information for a single, accessible PostgreSQL Managed Database. <<LB>> __CLI__. linode-cli databases postgresql-view 123 Learn more... __OAuth…
  • PUTUpdate a PostgreSQL Managed Database/:apiVersion/databases/postgresql/instances/:instanceIdMake changes to an existing PostgreSQL Managed Database. The user needs read_write user grant access to the database. The database's status needs to be…
  • DELETEDelete a PostgreSQL Managed Database/:apiVersion/databases/postgresql/instances/:instanceIdRemove a PostgreSQL Managed Database from your account. The user needs read_write user grant access to the database. The database's status can be active,…
  • POSTPatch a PostgreSQL Managed Database/:apiVersion/databases/postgresql/instances/:instanceId/patchApply security patches and updates to the underlying operating system of the PostgreSQL Managed Database. This function runs during regular maintenance…
  • POSTResume a PostgreSQL Managed Database/:apiVersion/databases/postgresql/instances/:instanceId/resumeResume a suspended PostgreSQL Managed Database from your account. This resumes billing for the cluster. The user needs read_write user grant access to the…
  • POSTSuspend a PostgreSQL Managed Database/:apiVersion/databases/postgresql/instances/:instanceId/suspendSuspend a PostgreSQL Managed Database from your account, releasing idle resources and keeping only necessary data. All service data is lost if there are no…

Engines

  • GETList Managed Databases engines/:apiVersion/databases/engines?page={{page}}&page_size={{page_size}}Display all available Managed Databases engine types and versions. Use an engine's id to create a new Managed Databases instance. <<LB>> __CLI__. linode-cli…
  • GETGet a Managed Databases engine/:apiVersion/databases/engines/:engineId?page={{page}}&page_size={{page_size}}Display information for a single Managed Databases engine type and version. Run the List Managed Databases engines operation and store the id for the…

Advanced parameters

  • GETList MySQL Managed Database advanced parameters/:apiVersion/databases/mysql/configAll advanced parameters you can apply to a MySQL Managed Database, via our partner Aiven. > 📘 > > Aiven may offer other parameters, but Akamai Managed…
  • GETList PostgreSQL Managed Database advanced parameters/:apiVersion/databases/postgresql/configAll advanced parameters you can apply to a PostgreSQL Managed Database, via our partner Aiven. > 📘 > > Aiven may offer other parameters, but Akamai Managed…

Credentials

  • GETGet MySQL Managed Database credentials/:apiVersion/databases/mysql/instances/:instanceId/credentialsDisplay the root username and password for an accessible MySQL Managed Database. The database's status needs to be active. <<LB>> __CLI__. linode-cli…
  • POSTReset MySQL Managed Database credentials/:apiVersion/databases/mysql/instances/:instanceId/credentials/resetReset the root password for a MySQL Managed Database. A new root password is randomly generated and accessible with the Get MySQL Managed Database credentials…
  • GETGet PostgreSQL Managed Database credentials/:apiVersion/databases/postgresql/instances/:instanceId/credentialsDisplay the root username and password for an accessible PostgreSQL Managed Database. The database's status needs to be active. <<LB>> __CLI__. linode-cli…
  • POSTReset PostgreSQL Managed Database credentials/:apiVersion/databases/postgresql/instances/:instanceId/credentials/resetReset the root password for a PostgreSQL Managed Database. A new root password is randomly generated and accessible with the Get PostgreSQL Managed Database…

SSL certificates

  • GETGet a MySQL Managed Database SSL certificate/:apiVersion/databases/mysql/instances/:instanceId/sslDisplay the SSL CA certificate for an accessible MySQL Managed Database. The database's status needs to be active. <<LB>> __CLI__. linode-cli databases…
  • GETGet a PostgreSQL Managed Database SSL certificate/:apiVersion/databases/postgresql/instances/:instanceId/sslDisplay the SSL CA certificate for an accessible PostgreSQL Managed Database. The database's status needs to be active. <<LB>> __CLI__. linode-cli databases…

Types

  • GETList Managed Databases types/:apiVersion/databases/types?page={{page}}&page_size={{page_size}}Display all Managed Databases node types. The type and number of nodes determine the resources and price of a Managed Databases instance. Each database can…
  • GETGet a Managed Databases type/:apiVersion/databases/types/:typeId?page={{page}}&page_size={{page_size}}Display the details of a single Managed Databases node type. The type and number of nodes determine the resources and price of a Managed Databases instance.…

Domains

  • GETList domains/:apiVersion/domains?page={{page}}&page_size={{page_size}}This is a collection of Domains that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for these to work you must own the…
  • POSTCreate a domain/:apiVersion/domainsAdds 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…
  • POSTImport a domain/:apiVersion/domains/importImports a domain zone from a remote nameserver. Your nameserver must allow zone transfers (AXFR) from the following IPs: 96.126.114.97 96.126.114.98…
  • GETGet a domain/:apiVersion/domains/:domainIdThis is a single Domain that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for this Domain record to work you must own…
  • PUTUpdate a domain/:apiVersion/domains/:domainIdUpdate information about a Domain in Linode's DNS Manager. <<LB>> __CLI__. linode-cli domains update 1234 \ --retry_sec 7200 \ --ttl_sec 300 Learn more...…
  • DELETEDelete a domain/:apiVersion/domains/:domainIdDeletes a Domain from Linode's DNS Manager. The Domain will be removed from Linode's nameservers shortly after this operation completes. This also deletes all…
  • POSTClone a domain/:apiVersion/domains/:domainId/cloneClones a Domain and all associated DNS records from a Domain that is registered in Linode's DNS manager. <<LB>> __CLI__. linode-cli domains clone 123 --domain…

Images

  • GETList images/:apiVersion/images?page={{page}}&page_size={{page_size}}Returns a paginated list of images. An image can be one of two types: Public image. The id for these images begins with linode/. These images are generally…
  • POSTCreate an image/:apiVersion/imagesCaptures a private, gold-master image from a Linode disk and stores it for later use. > 👍 There's a tutorial > > This operation has specific requirements for…
  • POSTUpload an image/:apiVersion/images/uploadCreates a new private image container and returns a URL as the upload_to object in the response. Use this URL to upload your own disk image to the container.…
  • GETGet an image/:apiVersion/images/:imageIdGet information about a single image. An image can be one of two types: Public image. The id for these images begins with linode/. These images are generally…
  • PUTUpdate an image/:apiVersion/images/:imageIdUpdates a private image that you have permission to read_write. > 📘 > > You can't update the regions with this operation. Use the Replicate an image operation…
  • DELETEDelete an image/:apiVersion/images/:imageIdDeletes a private image you have permission to read_write. > 🚧 > > - You can't undo this delete action. > > - When you delete an image, all replicated…
  • POSTReplicate an image/:apiVersion/images/:imageId/regionsTarget an existing image and replicate it to another compute region. > 📘 > > As part of our limited promotional period, image replicas are free of charge…

Linode instances

  • GETList Linodes/:apiVersion/linode/instances?page={{page}}&page_size={{page_size}}Returns a paginated list of Linodes you have permission to view. <<LB>> __CLI__. linode-cli linodes list Learn more... __OAuth scopes__. linodes:read_only…
  • POSTCreate a Linode/:apiVersion/linode/instancesCreates 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…
  • GETGet a Linode/:apiVersion/linode/instances/:linodeIdGet a specific Linode by ID. <<LB>> __CLI__. linode-cli linodes view 123 Learn more... __OAuth scopes__. linodes:read_only Learn more...
  • PUTUpdate a Linode/:apiVersion/linode/instances/:linodeIdUpdates a Linode that you have permission to read_write. Only unrestricted users can add or modify tags on Linodes. <<LB>> > 🚧 > > All tags for the instance…
  • DELETEDelete a Linode/:apiVersion/linode/instances/:linodeIdDeletes a Linode you have permission to read_write. __Deleting a Linode is a destructive action and cannot be undone.__ Additionally, deleting a Linode: Gives…
  • POSTBoot a Linode/:apiVersion/linode/instances/:linodeId/bootBoots a Linode you have permission to modify. If the Linode is using config profiles, and no parameters are given, a config profile is chosen for this boot…
  • POSTClone a Linode/:apiVersion/linode/instances/:linodeId/cloneYou can clone your Linode's existing disks, configuration profiles and interfaces to another Linode on your account. In order for this request to complete…
  • POSTLaunch a DC migration/pending host migration/:apiVersion/linode/instances/:linodeId/migrateInitiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration. A list of pending migrations, if any, can…
  • POSTUpgrade a Linode/:apiVersion/linode/instances/:linodeId/mutateLinodes created with now-deprecated Types are entitled to a free upgrade to the next generation. A mutating Linode will be allocated any new resources the…
  • POSTReset a Linode's root password/:apiVersion/linode/instances/:linodeId/passwordResets the root password for this Linode. Your Linode must be shut down for a password reset to complete. If your Linode has more than one disk (not counting…
  • POSTReboot a Linode/:apiVersion/linode/instances/:linodeId/rebootReboots a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate…
  • POSTRebuild a Linode/:apiVersion/linode/instances/:linodeId/rebuildRebuilds a Linode you have the read_write permission to modify. A rebuild first shuts down the Linode, deletes all disks and configuration profiles on the…
  • POSTBoot a Linode into rescue mode/:apiVersion/linode/instances/:linodeId/rescueRescue Mode is a safe environment for performing many system recovery and disk management tasks. Rescue Mode is based on the Finnix recovery distribution, a…
  • POSTResize a Linode/:apiVersion/linode/instances/:linodeId/resizeResizes a Linode you have the read_write permission to a different Type. If any actions are currently running or queued, those actions must be completed first…
  • POSTShut down a Linode/:apiVersion/linode/instances/:linodeId/shutdownShuts down a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can…

Linode types

  • GETList types/:apiVersion/linode/typesReturns Linode Types, including pricing and specifications for each Type. Use these when creating or resizing Linodes. <<LB>> __CLI__. linode-cli linodes…
  • GETGet a type/:apiVersion/linode/types/:typeIdReturns information about a specific Linode Type, including pricing and specifications. This is used when creating or resizing Linodes. <<LB>> __CLI__.…

Network transfer prices

  • GETList network transfer prices/:apiVersion/network-transfer/pricesReturns collection of network transfer prices, including any region-specific rates. <<LB>> __CLI__. linode-cli network-transfer prices Learn more...

NodeBalancers

  • GETList Linode NodeBalancers/:apiVersion/linode/instances/:linodeId/nodebalancersReturns a list of NodeBalancers that are assigned to this Linode and readable by the requesting User. Read permission to a NodeBalancer can be given to a User…
  • GETList NodeBalancers/:apiVersion/nodebalancers?page={{page}}&page_size={{page_size}}Returns a paginated list of NodeBalancers you have access to. <<LB>> __CLI__. linode-cli nodebalancers list Learn more... __OAuth scopes__.…
  • POSTCreate a NodeBalancer/:apiVersion/nodebalancersCreates a NodeBalancer in the requested Region. Only available in regions with "NodeBalancers" in their capabilities. NodeBalancers require a port config with…
  • GETGet a NodeBalancer/:apiVersion/nodebalancers/:nodeBalancerIdReturns a single NodeBalancer you can access. <<LB>> __CLI__. linode-cli nodebalancers view 12345 Learn more... __OAuth scopes__. nodebalancers:read_only…
  • PUTUpdate a NodeBalancer/:apiVersion/nodebalancers/:nodeBalancerIdUpdates information about a NodeBalancer you can access. > 🚧 > > You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only…
  • DELETEDelete a NodeBalancer/:apiVersion/nodebalancers/:nodeBalancerIdDeletes a NodeBalancer. __This is a destructive action and cannot be undone.__ Deleting a NodeBalancer will also delete all associated Configs and Nodes,…

Object Storage

  • POSTCancel Object Storage/:apiVersion/object-storage/cancelCancel Object Storage on an Account. > 🚧 > > This removes all buckets and their contents from your Account. This data is irretrievable once removed. <<LB>>…
  • GETList Object Storage quotas/:apiVersion/object-storage/quotasReturns the active Object Storage-related quotas applied to your account. For example, you may have a quota maximum for the number of buckets you can have on…
  • GETGet an Object Storage quota/:apiVersion/object-storage/quotas/:objQuotaIdReturns information about a specific Object Storage-related quota on your account. The operation includes any quota overrides in the response. <<LB>> __CLI__.…
  • GETGet Object Storage quota usage data/:apiVersion/object-storage/quotas/:objQuotaId/usageReturns usage data for a specific objQuotaId. This includes the maximum number of objQuotaId resources you can have for a single endpoint and the current…
  • GETGet Object Storage transfer data/:apiVersion/object-storage/transferThe amount of outbound data transfer used by your account's Object Storage buckets. Object Storage adds 1 terabyte of outbound data transfer to your data…
  • GETList Object Storage types/:apiVersion/object-storage/typesReturns Object Storage types and prices, including any region-specific rates. <<LB>> __CLI__. linode-cli object-storage types Learn more...

Placement groups

  • GETList placement groups/:apiVersion/placement/groups?page={{page}}&page_size={{page_size}}Returns a paginated list of placement groups you have permission to view. > 📘 > > Your user needs at least read-only permission to all Linodes included in a…
  • POSTCreate a placement group/:apiVersion/placement/groupsCreates a placement group on your account. Placement groups disperse your Linodes across physical machines (hosts) in one of our compute regions. Depending on…
  • GETGet a placement group/:apiVersion/placement/groups/:groupIdView a specific placement group by ID. > 📘 > > Your user needs at least read-only permission to all Linodes included in a placement group to view it. If you…
  • PUTUpdate a placement group/:apiVersion/placement/groups/:groupIdChange the label for a specific placement group. This is the only value you can update. However, you can add more Linodes or remove existing ones. > 📘 > > To…
  • DELETEDelete a placement group/:apiVersion/placement/groups/:groupIdDeletes a placement group you have permission to read_write. Deleting a placement group can't be undone. All Linodes need to be removed before you can delete…
  • POSTAssign a placement group/:apiVersion/placement/groups/:groupId/assignAdd a Linode to your placement group. Check out our example API workflow to create a placement group and add Linodes. > 📘 > > Your user needs the add_linodes…
  • POSTUnassign a placement group/:apiVersion/placement/groups/:groupId/unassignRemove a Linode from your placement group. > 📘 > > To run this operation, your user needs the add_linodes grant and read-write permission to the Linodes you…

Profile

  • GETGet a profile/:apiVersion/profileReturns information about the current user. Use this to see who is acting in applications where more than one token is managed, such as a third-party OAuth…
  • PUTUpdate a profile/:apiVersion/profileUpdate information in your profile. You need the account:read_write OAuth scope to use this operation. Parent and child accounts In a parent and child account…

Regions

  • GETList regions/:apiVersion/regionsLists the regions available for Linode services. Not all services are guaranteed to be available in all regions. <<LB>> __CLI__. linode-cli regions list Learn…
  • GETList regions' availability/:apiVersion/regions/availabilityReturns availability data for all regions. <<LB>> __CLI__. linode-cli regions list-avail Learn more...
  • GETGet a region/:apiVersion/regions/:regionIdReturns a single Region. <<LB>> __CLI__. linode-cli regions view us-east Learn more...
  • GETGet a region's availability/:apiVersion/regions/:regionId/availabilityReturns availability data for a single Region. <<LB>> __CLI__. linode-cli regions view-avail us-east Learn more...

StackScripts

  • GETList StackScripts/:apiVersion/linode/stackscripts?page={{page}}&page_size={{page_size}}If the request is not authenticated, only public StackScripts are returned. For more information on StackScripts, please read our StackScripts documentation.…
  • POSTCreate a StackScript/:apiVersion/linode/stackscriptsCreates a StackScript in your Account. <<LB>> __CLI__. linode-cli stackscripts create \ --label a-stackscript \ --description "This StackScript install and…
  • GETGet a StackScript/:apiVersion/linode/stackscripts/:stackscriptIdReturns all of the information about a specified StackScript, including the contents of the script. <<LB>> __CLI__. linode-cli stackscripts view 10079 Learn…
  • PUTUpdate a StackScript/:apiVersion/linode/stackscripts/:stackscriptIdUpdates a StackScript. __Once a StackScript is made public, it cannot be made private.__ <<LB>> __CLI__. linode-cli stackscripts update 10079 \ --label…
  • DELETEDelete a StackScript/:apiVersion/linode/stackscripts/:stackscriptIdDeletes a private StackScript you have permission to read_write. You cannot delete a public StackScript. <<LB>> __CLI__. linode-cli stackscripts delete 10079…

Tags

  • GETList tags/:apiVersion/tags?page={{page}}&page_size={{page_size}}Returns a paginated list of tags you've created on your account. > 📘 > > This operation can only be accessed by account users with _unrestricted_ access. Talk…
  • POSTCreate a tag/:apiVersion/tagsCreates a new tag and lets you optionally add it to specific objects. Tags are labels you can attach to objects in your account. Use them to specify and group…
  • GETList tagged objects/:apiVersion/tags/:tagLabel?page={{page}}&page_size={{page_size}}Returns a paginated list of all objects you've tagged with the specified tag. The response includes a mixed collection of all object types. > 📘 > > This…
  • DELETEDelete a tag/:apiVersion/tags/:tagLabelRemoves a tag from all objects and deletes it. > 📘 > > This operation can only be accessed by account users with _unrestricted_ access. Talk to your local…

Volumes

  • GETList a Linode's volumes/:apiVersion/linode/instances/:linodeId/volumes?page={{page}}&page_size={{page_size}}View the Block Storage volumes attached to this Linode. <<LB>> __CLI__. linode-cli linodes volumes 123 Learn more... __OAuth scopes__. linodes:read_only Learn…
  • GETList volumes/:apiVersion/volumes?page={{page}}&page_size={{page_size}}Returns a paginated list of the Block Storage volumes that you have permission to view. <<LB>> __CLI__. linode-cli volumes list Learn more... __OAuth…
  • POSTCreate a volume/:apiVersion/volumesCreates a Block Storage volume on your account. Creating a new volume accrues additional charges on your account. > 📘 > > To run this operation, your user…
  • GETGet a volume/:apiVersion/volumes/:volumeId?page={{page}}&page_size={{page_size}}Get information about a specific Block Storage volume. <<LB>> __CLI__. linode-cli volumes view 12345 Learn more... __OAuth scopes__. volumes:read_only Learn…
  • PUTUpdate a volume/:apiVersion/volumes/:volumeIdUpdate a Block Storage volume that you have permission to read_write. <<LB>> __CLI__. linode-cli volumes update 12345 \ --label my_volume Learn more...…
  • DELETEDelete a volume/:apiVersion/volumes/:volumeIdDeletes a specified Block Storage volume that you have permission to read_write. Deleting a volume can't be undone. Deleting stops billing for the volume.…
  • POSTAttach a volume/:apiVersion/volumes/:volumeId/attachAttach a Block Storage volume to an existing Linode. > 📘 > > - To run this operation, your user needs the read-write permission to both the volume and the…
  • POSTClone a volume/:apiVersion/volumes/:volumeId/cloneTarget an existing Block Storage volume to create a new one, that's the same size and includes the same data. A new volume will incur a charge on your…
  • POSTDetach a volume/:apiVersion/volumes/:volumeId/detachDetach a Block Storage volume from a Linode. When you delete a Linode, any volumes attached to it are automatically detached. > 📘 > > To run this operation,…
  • POSTResize a volume/:apiVersion/volumes/:volumeId/resizeIncrease the size of an existing Block Storage volume on your account. > 📘 > > - To run this operation, your user needs the add_volume grant. > > - You can't…

VPCs

  • GETList VPC configurations/:apiVersion/nodebalancers/:nodeBalancerId/vpcs?page={{page}}&page_size={{page_size}}Returns a paginated list of VPC configurations for the NodeBalancer. <<LB>> __CLI__. linode-cli nodebalancers vpcs-list 12345 Learn more... __OAuth scopes__.…
  • GETGet a VPC configuration/:apiVersion/nodebalancers/:nodeBalancerId/vpcs/:nodeBalancerVpcConfigIdReturns a single VPC configuration for the NodeBalancer ID. <<LB>> __CLI__. linode-cli nodebalancers vpcs-view \ 12345 7 Learn more... __OAuth scopes__.…
  • GETList VPCs/:apiVersion/vpcs?page={{page}}&page_size={{page_size}}Display all VPCs on your account. <<LB>> __CLI__. linode-cli vpcs list Learn more...
  • POSTCreate a VPC/:apiVersion/vpcsCreate a new VPC and optionally associated VPC Subnets. Users must have the add_vpc grant to access this operation. A successful request triggers a vpc_create…
  • GETGet a VPC/:apiVersion/vpcs/:vpcIdGet information about a single VPC. <<LB>> __CLI__. linode-cli vpcs view $vpcId Learn more...
  • PUTUpdate a VPC/:apiVersion/vpcs/:vpcIdUpdate an existing VPC. The User accessing this operation must have read_write grants to the VPC. A successful request triggers a vpc_update event. To update…
  • DELETEDelete a VPC/:apiVersion/vpcs/:vpcIdDelete a single VPC and all of its Subnets. The User accessing this operation must have read_write grants to the VPC. A successful request triggers a…

Backups

  • GETList backups/:apiVersion/linode/instances/:linodeId/backupsReturns information about this Linode's available backups. <<LB>> __CLI__. linode-cli linodes backups-list 123 Learn more... __OAuth scopes__.…
  • POSTCreate a snapshot/:apiVersion/linode/instances/:linodeId/backupsCreates a snapshot backup of a Linode. > 📘 > > - Backups aren't encrypted even when they're taken from an encrypted disk. When a backup is restored, and if…
  • POSTCancel backups/:apiVersion/linode/instances/:linodeId/backups/cancelCancels the Backup service on the given Linode. Deletes all of this Linode's existing backups forever. <<LB>> __CLI__. linode-cli linodes backups-cancel 123…
  • POSTEnable backups/:apiVersion/linode/instances/:linodeId/backups/enableEnables backups for the specified Linode. > 📘 > > Backups aren't encrypted even when they're taken from an encrypted disk. When a backup is restored, and if…
  • GETGet a backup/:apiVersion/linode/instances/:linodeId/backups/:backupIdReturns information about a Backup. <<LB>> __CLI__. linode-cli linodes backup-view 123 123456 Learn more... __OAuth scopes__. linodes:read_only Learn more...
  • POSTRestore a backup/:apiVersion/linode/instances/:linodeId/backups/:backupId/restoreRestores a Linode's backup to the specified Linode. Backups may not be restored across regions. Only successfully completed backups that are not undergoing…

Configuration profiles

  • GETList configuration profiles/:apiVersion/linode/instances/:linodeId/configs?page={{page}}&page_size={{page_size}}Lists configuration profiles associated with a Linode. <<LB>> __CLI__. linode-cli linodes configs-list 123 Learn more... __OAuth scopes__. linodes:read_only…
  • POSTCreate a configuration profile/:apiVersion/linode/instances/:linodeId/configsAdds a new configuration profile to a Linode. > 📘 > > This operation is for legacy configuration profiles only, and not Linode interfaces. <<LB>> __CLI__.…
  • GETGet a configuration profile/:apiVersion/linode/instances/:linodeId/configs/:configIdReturns information about a specific configuration profile. <<LB>> __CLI__. linode-cli linodes config-view 123 23456 Learn more... __OAuth scopes__.…
  • PUTUpdate a configuration profile/:apiVersion/linode/instances/:linodeId/configs/:configIdUpdates a configuration profile. <<LB>> __CLI__. linode-cli linodes config-update 123 23456 \ --kernel "linode/latest-64bit" \ --comments "This is my main…
  • DELETEDelete a configuration profile/:apiVersion/linode/instances/:linodeId/configs/:configIdDeletes the specified configuration profile from the specified Linode. <<LB>> __CLI__. linode-cli linodes config-delete 123 23456 Learn more... __OAuth…

Configuration profile interfaces

  • GETList configuration profile interfaces/:apiVersion/linode/instances/:linodeId/configs/:configId/interfacesReturns all configuration profile interfaces assigned to a specific configuration profile, on a specific Linode. To access this operation, your user needs the…
  • POSTAdd a configuration profile interface/:apiVersion/linode/instances/:linodeId/configs/:configId/interfacesCreates and appends a single interface to the end of the interfaces array for an existing configuration profile. After you add the interface, you need to…
  • POSTReorder configuration profile interfaces/:apiVersion/linode/instances/:linodeId/configs/:configId/interfaces/orderReorders the existing Interfaces of a Configuration Profile. The User accessing this operation must have read_write grants to the Linode. <<LB>> __CLI__.…
  • GETGet a configuration profile interface/:apiVersion/linode/instances/:linodeId/configs/:configId/interfaces/:interfaceIdReturns a single configuration profile interface. To access this operation, your user needs at least the read_only grant for the Linode. <<LB>> __CLI__.…
  • PUTUpdate a configuration profile interface/:apiVersion/linode/instances/:linodeId/configs/:configId/interfaces/:interfaceIdUpdate a vpc or public configuration profile interface for a specific configuration profile, on a specific Linode. To access this operation, your user needs…
  • DELETEDelete a configuration profile interface/:apiVersion/linode/instances/:linodeId/configs/:configId/interfaces/:interfaceIdDeletes a configuration profile interface from a specific configuration profile, on a specific Linode. To access this operation, your user needs the…

Disks

  • GETList disks/:apiVersion/linode/instances/:linodeId/disks?page={{page}}&page_size={{page_size}}View Disk information for Disks associated with this Linode. <<LB>> __CLI__. linode-cli linodes disks-list 123 Learn more... __OAuth scopes__.…
  • POSTCreate a disk/:apiVersion/linode/instances/:linodeId/disksAdd a new disk to an existing Linode. You can create an empty disk to manually configure it later. You can also target a stored image to build the disk using…
  • GETGet a disk/:apiVersion/linode/instances/:linodeId/disks/:diskIdView Disk information for a Disk associated with this Linode. <<LB>> __CLI__. linode-cli linodes disk-view 123 25674 Learn more... __OAuth scopes__.…
  • PUTUpdate a disk/:apiVersion/linode/instances/:linodeId/disks/:diskIdUpdates a Disk that you have permission to read_write. <<LB>> __CLI__. linode-cli linodes disk-update 123 25674 \ --label "Debian 9 Disk" Learn more...…
  • DELETEDelete a disk/:apiVersion/linode/instances/:linodeId/disks/:diskIdDeletes a Disk you have permission to read_write. __Deleting a Disk is a destructive action and cannot be undone.__ <<LB>> __CLI__. linode-cli linodes…
  • POSTClone a disk/:apiVersion/linode/instances/:linodeId/disks/:diskId/cloneCopies a disk, byte-for-byte, into a new disk on the same Linode. The operation fails if the target doesn't have enough storage space. A Linode can have up to…
  • POSTReset a disk root password/:apiVersion/linode/instances/:linodeId/disks/:diskId/passwordResets the password of a Disk you have permission to read_write. <<LB>> __CLI__. linode-cli linodes disk-reset-password \ 123 25674 \ --password…
  • POSTResize a disk/:apiVersion/linode/instances/:linodeId/disks/:diskId/resizeResizes a Disk you have permission to read_write. The Disk must not be in use. If the Disk is in use, the request will succeed but the resize will ultimately…

Firewalls

  • GETList a Linode's firewalls/:apiVersion/linode/instances/:linodeId/firewalls?page={{page}}&page_size={{page_size}}View Firewall information for Firewalls assigned to this Linode. <<LB>> __CLI__. linode-cli linodes firewalls-list 123 Learn more... __OAuth scopes__.…
  • PUTUpdate a Linode's firewalls/:apiVersion/linode/instances/:linodeId/firewalls?page={{page}}&page_size={{page_size}}Replace the current list of assigned firewalls with a new list, or provide an empty list to remove all firewalls from this Linode. <<LB>> __CLI__. linode-cli…
  • POSTApply a Linode's firewalls/:apiVersion/linode/instances/:linodeId/firewalls/applyReapply assigned firewalls to a Linode in case they were not applied successfully. The firewall_apply event indicates if the firewalls were applied. <<LB>>…
  • GETList firewalls/:apiVersion/networking/firewalls?page={{page}}&page_size={{page_size}}Returns a paginated list of accessible Firewalls. <<LB>> __CLI__. linode-cli firewalls list Learn more... __OAuth scopes__. firewall:read_only Learn more...
  • POSTCreate a firewall/:apiVersion/networking/firewallsCreates a Firewall to filter network traffic. Use rules to create inbound and outbound access rules. Rule versions increment from 1 whenever the firewall's…
  • GETGet a firewall/:apiVersion/networking/firewalls/:firewallIdGet a specific Firewall resource by its ID. The Firewall's Devices will not be returned in the response. Instead, run the List firewall devices operation to…
  • PUTUpdate a firewall/:apiVersion/networking/firewalls/:firewallIdUpdates information for a firewall. Assigned Linodes must not have any ongoing live migrations. If this operation changes a firewall's status, it generates a…
  • DELETEDelete a firewall/:apiVersion/networking/firewalls/:firewallIdDelete a firewall. This also removes all of the firewall's rules from any services the firewall was assigned to. Assigned Linodes must not have any ongoing…
  • GETList firewall rule versions/:apiVersion/networking/firewalls/:firewallId/historyLists the current and historical rules of the firewall (that is not deleted), using version. Whenever rules update, the version increments from 1. <<LB>>…
  • GETGet a firewall rule version/:apiVersion/networking/firewalls/:firewallId/history/rules/:versionGet a specific firewall rule version for an enabled or disabled firewall. <<LB>> __CLI__. linode-cli firewalls version-view \ 123 2 Learn more... __OAuth…
  • GETList firewall rules/:apiVersion/networking/firewalls/:firewallId/rulesReturns the inbound and outbound Rules for a Firewall. <<LB>> __CLI__. linode-cli firewalls rules-list 123 Learn more... __OAuth scopes__. firewall:read_only…
  • PUTUpdate firewall rules/:apiVersion/networking/firewalls/:firewallId/rulesUpdates the inbound and outbound Rules for a Firewall. Assigned Linodes must not have any ongoing live migrations. __Note__. This operation replaces all of a…
  • GETList NodeBalancer firewalls/:apiVersion/nodebalancers/:nodeBalancerId/firewallsView information for Firewalls assigned to this NodeBalancer. <<LB>> __CLI__. linode-cli nodebalancers firewalls $nodeBalancerId Learn more... __OAuth…
  • PUTUpdate a NodeBalancer's firewalls/:apiVersion/nodebalancers/:nodeBalancerId/firewalls?page={{page}}&page_size={{page_size}}Replace the current list of assigned firewalls with a new list, or provide an empty list to remove all firewalls from this NodeBalancer. <<LB>> __CLI__.…

Linode interfaces

  • GETList Linode interfaces/:apiVersion/linode/instances/:linodeId/interfaces__Beta__ This operation returns all interfaces assigned to a specific Linode. They list in the order they were created. On the Linode, interfaces also list in…
  • POSTAdd a Linode interface/:apiVersion/linode/instances/:linodeId/interfaces__Beta__ Creates an interface for the Linode. This interface links to the Linode, rather than to a configuration profile. You can create, delete, or update…
  • GETList a Linode's network interface history/:apiVersion/linode/instances/:linodeId/interfaces/history__Beta__ Lists the history of network interfaces by version for a Linode. This operation is for Linode interfaces, and not for legacy configuration profile…
  • GETList Linode interface settings/:apiVersion/linode/instances/:linodeId/interfaces/settings__Beta__ Lists a Linode's interface settings, including Network Helper and default route settings. This operation is for Linode interfaces, not for legacy…
  • PUTUpdate Linode interface settings/:apiVersion/linode/instances/:linodeId/interfaces/settings__Beta__ Updates Network Helper and default route settings on the Linode. <<LB>> __CLI: Public interface__. linode-cli linodes interface-settings-update…
  • GETGet a Linode interface/:apiVersion/linode/instances/:linodeId/interfaces/:interfaceId__Beta__ Returns an interface assigned to a specific Linode. This operation requires the read_only grant for the Linode. <<LB>> __CLI__. linode-cli linodes…
  • PUTUpdate a Linode interface/:apiVersion/linode/instances/:linodeId/interfaces/:interfaceId__Beta__ Update the configuration of a Linode interface. <<LB>> __CLI: Public interface__. linode-cli linodes interface-update $linodeId $interfaceId \…
  • DELETEDelete a Linode interface/:apiVersion/linode/instances/:linodeId/interfaces/:interfaceId__Beta__ Deletes a Linode interface on a specific Linode. To access this operation, you need the read_write grant for the Linode. You can't delete an active…
  • GETList Linode interface firewalls/:apiVersion/linode/instances/:linodeId/interfaces/:interfaceId/firewalls__Beta__ Lists firewalls assigned to an interface. <<LB>> __CLI__. linode-cli linodes interface-firewalls-list $linodeId $interfaceId Learn more... __OAuth…
  • POSTUpgrade to Linode interfaces/:apiVersion/linode/instances/:linodeId/upgrade-interfaces__Beta__ Automatically upgrades all legacy config interfaces of a single configuration profile to Linode interfaces. A Linode interface is directly associated…

IP addresses

  • GETGet networking information/:apiVersion/linode/instances/:linodeId/ipsReturns networking information for a single Linode. > 📘 > > If the target Linode has several configuration profiles that include a Virtual Private Cloud (VPC)…
  • POSTAllocate an IPv4 address/:apiVersion/linode/instances/:linodeId/ipsAllocates 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…
  • GETGet a Linode's IP address/:apiVersion/linode/instances/:linodeId/ips/:addressView information for a Linode's set of IPs, its Linode interfaces and VPC IPs and ranges. <<LB>> __CLI__. linode-cli linodes ip-view 123 97.107.143.141 Learn…
  • PUTUpdate an IP address's RDNS for a Linode/:apiVersion/linode/instances/:linodeId/ips/:addressUpdates the reverse DNS (RDNS) for a Linode's IP Address. This may be done for both IPv4 and IPv6 addresses. Setting the RDNS to null for a public IPv4…
  • DELETEDelete an IPv4 address/:apiVersion/linode/instances/:linodeId/ips/:addressDeletes a public or private IPv4 address associated with this Linode. This will fail if it is the Linode's last remaining public IPv4 address, or if the…
  • GETList IP addresses/:apiVersion/networking/ips?skip_ipv6_rdns={{skip_ipv6_rdns}}Returns a paginated list of IP addresses on your account for Linodes or Linode interfaces, excluding private addresses. > 👍 > > if your application frequently…
  • POSTAllocate an IP address/:apiVersion/networking/ipsAllocates a new IPv4 Address on your Account. The Linode must be configured to support additional addresses - please Open a support ticket requesting…
  • POSTAssign IP addresses/:apiVersion/networking/ips/assignAssign any set of IPv4 addresses and IPv6 ranges to Linodes in one region. This allows swapping, shuffling, or otherwise reorganizing IPs among your Linodes.…
  • POSTShare IP addresses/:apiVersion/networking/ips/shareConfigure shared IPs. IP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes…
  • GETGet an IP address/:apiVersion/networking/ips/:addressReturns information about a single IP Address on your Account. <<LB>> __CLI__. linode-cli networking ip-view 97.107.143.141 Learn more... __OAuth scopes__.…
  • PUTUpdate an IP address's RDNS/:apiVersion/networking/ips/:addressSets RDNS on an IP Address. Forward DNS must already be set up for reverse DNS to be applied. If you set the RDNS to null for public IPv4 addresses, it will…
  • GETList VPC IP addresses/:apiVersion/vpcs/ips?page={{page}}&page_size={{page_size}}Returns a paginated list of all VPC IP addresses and address ranges on your account. > 📘 > > If a Linode has several configuration profiles that include a VPC…
  • GETList a VPC's IP addresses/:apiVersion/vpcs/:vpcId/ips?page={{page}}&page_size={{page_size}}Returns a paginated list of IP addresses for a single VPC. <<LB>> __CLI__. linode-cli vpcs ip-list 123 Learn more... __OAuth scopes__. ips:read_only Learn…

Statistics

  • GETGet daily Linode statistics/:apiVersion/linode/instances/:linodeId/statsReturns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours. <<LB>> __OAuth scopes__. linodes:read_only Learn more...
  • GETGet a month's Linode statistics/:apiVersion/linode/instances/:linodeId/stats/:year/:monthReturns CPU, IO, IPv4, and IPv6 statistics for your Linode for a specific month. If the {year} and {month} are set to the current month, the API returns…
  • GETGet this month's network transfer stats/:apiVersion/linode/instances/:linodeId/transferReturns a Linode's network transfer pool statistics for the current month. <<LB>> __CLI__. linode-cli linodes transfer-view 123 Learn more... __OAuth…
  • GETGet monthly network transfer stats/:apiVersion/linode/instances/:linodeId/transfer/:year/:monthReturns a Linode's network transfer pool statistics for a specific month. If the {year} and {month} are set to the current month, the API returns statistics…
  • GETGet NodeBalancer statistics/:apiVersion/nodebalancers/:nodeBalancerId/statsReturns detailed statistics about the requested NodeBalancer. <<LB>> __OAuth scopes__. nodebalancers:read_only Learn more...

Kernels

  • GETList kernels/:apiVersion/linode/kernels?page={{page}}&page_size={{page_size}}Lists available Kernels. Due to the extensive list of available kernels, please keep pagination controls in mind when managing responses to this operation.…
  • GETGet a kernel/:apiVersion/linode/kernels/:kernelIdReturns information about a single Kernel. <<LB>> __CLI__. linode-cli kernels view latest-64bit Learn more...

Clusters

  • GETList Kubernetes clusters/:apiVersion/lke/clustersLists current Kubernetes clusters available on your account. <<LB>> __CLI__. linode-cli lke clusters-list Learn more... __OAuth scopes__. lke:read_only Learn…
  • POSTCreate a Kubernetes cluster/:apiVersion/lke/clustersCreates a Kubernetes cluster. The Kubernetes cluster will be created asynchronously. You can use the events system to determine when the Kubernetes cluster is…
  • GETGet a Kubernetes cluster/:apiVersion/lke/clusters/:clusterIdGet a specific Cluster by ID. <<LB>> __CLI__. linode-cli lke cluster-view 12345 Learn more... __OAuth scopes__. lke:read_only Learn more...
  • PUTUpdate a Kubernetes cluster/:apiVersion/lke/clusters/:clusterIdUpdates a Kubernetes cluster. <<LB>> __CLI__. linode-cli lke cluster-update 12345 \ --label lkecluster54321 \ --control_plane.high_availability true \…
  • DELETEDelete a Kubernetes cluster/:apiVersion/lke/clusters/:clusterIdDeletes a cluster from your account. > 🚧 > > Deleting a cluster is a destructive action and can't be undone. When a cluster is deleted, all supporting…
  • POSTRecycle cluster nodes/:apiVersion/lke/clusters/:clusterId/recycleRecycles all nodes in all pools of a designated Kubernetes Cluster. All Linodes within the Cluster will be deleted and replaced with new Linodes on a rolling…
  • POSTRegenerate a Kubernetes cluster/:apiVersion/lke/clusters/:clusterId/regenerateRegenerate the Kubeconfig file and/or the service account token for a Cluster. This is a helper operation that allows performing both the Delete a Kubeconfig…
  • GETList clusters/:apiVersion/object-storage/clustersDeprecated. __Deprecated__ Returns a paginated list of available Object Storage legacy clusters. > 📘 > > This displays deprecated clusterId values that…
  • GETGet a cluster/:apiVersion/object-storage/clusters/:clusterIdDeprecated. __Deprecated__ Returns a single Object Storage cluster. > 📘 > > This displays deprecated clusterId values that represent regions used with older…

Control Plane ACL

  • GETGet the control plane access control list/:apiVersion/lke/clusters/:clusterId/control_plane_aclGet a specific cluster's control plane access control List. <<LB>> __CLI__. linode-cli lke cluster-acl-view 12345 Learn more... __OAuth scopes__.…
  • PUTUpdate the control plane access control list/:apiVersion/lke/clusters/:clusterId/control_plane_aclUpdates a specific cluster's control plane access control list. <<LB>> __CLI__. linode-cli lke cluster-acl-update 12345 \ --acl.enabled true \…
  • DELETEDelete the control plane access control list/:apiVersion/lke/clusters/:clusterId/control_plane_aclDisable control plane access controls and deletes all rules. This has the same effect as calling PUT with an acl json map value of {“enabled” : false}. <<LB>>…

Cluster dashboard

  • GETGet a Kubernetes cluster dashboard URL/:apiVersion/lke/clusters/:clusterId/dashboardGet a Kubernetes Dashboard access URL for this Cluster, which enables performance of administrative tasks through a web interface. Dashboards are installed…

Kubeconfigs

  • GETGet a Kubeconfig/:apiVersion/lke/clusters/:clusterId/kubeconfigGet the Kubeconfig file for a Cluster. Please note that it often takes 2-5 minutes before the Kubeconfig file is ready after first creating a new cluster.…
  • DELETEDelete a Kubeconfig/:apiVersion/lke/clusters/:clusterId/kubeconfigDelete and regenerate the Kubeconfig file for a Cluster. <<LB>> __CLI__. linode-cli lke kubeconfig-delete 12345 Learn more... __OAuth scopes__. lke:read_write…

Nodes

  • GETGet a node/:apiVersion/lke/clusters/:clusterId/nodes/:nodeIdReturns the values for a specified node object. <<LB>> __CLI__. linode-cli lke node-view 123456 12345-6aa78910bc Learn more... __OAuth scopes__.…
  • DELETEDelete a node/:apiVersion/lke/clusters/:clusterId/nodes/:nodeIdDeletes a specific Node from a Node Pool. __Deleting a Node is a destructive action and cannot be undone.__ Deleting a Node will reduce the size of the Node…
  • POSTRecycle a node/:apiVersion/lke/clusters/:clusterId/nodes/:nodeId/recycleRecycles an individual Node in the designated Kubernetes Cluster. The Node will be deleted and replaced with a new Linode, which may take a few minutes.…
  • GETList nodes/:apiVersion/nodebalancers/:nodeBalancerId/configs/:configId/nodes?page={{page}}&page_size={{page_size}}Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port. <<LB>> __CLI__.…
  • POSTCreate a node/:apiVersion/nodebalancers/:nodeBalancerId/configs/:configId/nodesCreates a backend node that can receive traffic for the NodeBalancer configuration. Requests are routed to backend nodes on the specified port based on their…
  • GETGet a NodeBalancer's node/:apiVersion/nodebalancers/:nodeBalancerId/configs/:configId/nodes/:nodeIdReturns information about a single Node, a backend for this NodeBalancer's configured port. <<LB>> __CLI__. linode-cli nodebalancers node-view 12345 4567…
  • PUTUpdate a node/:apiVersion/nodebalancers/:nodeBalancerId/configs/:configId/nodes/:nodeIdUpdates information about a node, a backend for this NodeBalancer's configured port. > 🚧 > > You can configure UDP on the same NodeBalancer that also uses…
  • DELETEDelete a NodeBalancer's node/:apiVersion/nodebalancers/:nodeBalancerId/configs/:configId/nodes/:nodeIdDeletes a Node from this Config. This backend will no longer receive traffic for the configured port of this NodeBalancer. This does not change or remove the…

Node pools

  • GETList node pools/:apiVersion/lke/clusters/:clusterId/poolsReturns all active Node Pools on a Kubernetes cluster. <<LB>> __CLI__. linode-cli lke pools-list 12345 Learn more... __OAuth scopes__. lke:read_only Learn…
  • POSTCreate a node pool/:apiVersion/lke/clusters/:clusterId/poolsCreates a new Node Pool for the designated Kubernetes cluster. <<LB>> __CLI__. linode-cli lke pool-create 12345 \ --type g6-standard-4 \ --count 6 \ --tags…
  • GETGet a node pool/:apiVersion/lke/clusters/:clusterId/pools/:poolIdGet a specific Node Pool by ID. <<LB>> __CLI__. linode-cli lke pool-view 12345 456 Learn more... __OAuth scopes__. lke:read_only Learn more...
  • PUTUpdate a node pool/:apiVersion/lke/clusters/:clusterId/pools/:poolIdUpdates a node pool's count, labels and taints, and autoscaler configuration. Linodes are created or deleted to match changes to the Node Pool's count.…
  • DELETEDelete a node pool/:apiVersion/lke/clusters/:clusterId/pools/:poolIdDelete a specific Node Pool from a Kubernetes cluster. __Deleting a Node Pool is a destructive action and cannot be undone.__ Deleting a Node Pool will delete…
  • POSTRecycle a node pool/:apiVersion/lke/clusters/:clusterId/pools/:poolId/recycleRecycles a Node Pool for the designated Kubernetes Cluster. All Linodes within the Node Pool will be deleted and replaced with new Linodes on a rolling basis,…

LKE service tokens

  • DELETEDelete a service token/:apiVersion/lke/clusters/:clusterId/servicetokenDelete and regenerate the service account token for a Cluster. > 📘 > > When you regenerate a service account token, the cluster's control plane components and…

LKE versions

  • GETList LKE Kubernetes versions (any tier)/:apiVersion/lke/tiers/:tier/versionsList LKE Kubernetes versions available for deployment to a Kubernetes cluster (any tier). <<LB>> __CLI__. linode-cli lke tiered-versions-list standard Learn…
  • GETGet an LKE Kubernetes version (any tier)/:apiVersion/lke/tiers/:tier/versions/:versionView an LKE Kubernetes version available for deployment to a Kubernetes cluster (any tier) <<LB>> __CLI__. linode-cli lke tiered-version-view standard 1.31…
  • GETList LKE Kubernetes versions (non-enterprise)/:apiVersion/lke/versionsList LKE Kubernetes versions available for deployment to a standard-tier Kubernetes cluster. <<LB>> __CLI__. linode-cli lke versions-list Learn more...…
  • GETGet an LKE Kubernetes version (non-enterprise)/:apiVersion/lke/versions/:versionView an LKE Kubernetes version available for deployment to a standard tier Kubernetes cluster. <<LB>> __CLI__. linode-cli lke version-view 1.31 Learn more...…

LKE types

  • GETList Kubernetes types/:apiVersion/lke/typesReturns Kubernetes types and prices, including any region-specific rates. <<LB>> __CLI__. linode-cli lke types Learn more...

Longview clients

  • GETList Longview clients/:apiVersion/longview/clients?page={{page}}&page_size={{page_size}}Returns a paginated list of Longview Clients you have access to. Longview Client is used to monitor stats on your Linode with the help of the Longview Client…
  • POSTCreate a Longview client/:apiVersion/longview/clientsCreates a Longview Client. This Client will not begin monitoring the status of your server until you configure the Longview Client application on your Linode…
  • GETGet a Longview client/:apiVersion/longview/clients/:clientIdReturns a single Longview Client you can access. <<LB>> __CLI__. linode-cli longview view 789 Learn more... __OAuth scopes__. longview:read_only Learn more...
  • PUTUpdate a Longview client/:apiVersion/longview/clients/:clientIdUpdates a Longview Client. This cannot update how it monitors your server; use the Longview Client application on your Linode for monitoring configuration.…
  • DELETEDelete a Longview client/:apiVersion/longview/clients/:clientIdDeletes a Longview Client from your Account. __All information stored for this client will be lost.__ This _does not_ uninstall the Longview Client…

Longview plans

  • GETGet a Longview plan/:apiVersion/longview/planGet the details of your current Longview plan. This returns a LongviewSubscription object for your current Longview Pro plan, or an empty set {} if your…
  • PUTUpdate a Longview plan/:apiVersion/longview/planUpdate your Longview plan to that of the given subscription ID. This returns a LongviewSubscription object for the updated Longview Pro plan, or an empty set…

Longview subscriptions

  • GETList Longview subscriptions/:apiVersion/longview/subscriptions?page={{page}}&page_size={{page_size}}Returns a paginated list of available Longview subscriptions. This is a public endpoint and requires no authentication. <<LB>> __CLI__. linode-cli longview…
  • GETGet a Longview subscription/:apiVersion/longview/subscriptions/:subscriptionIdGet the Longview plan details as a single LongviewSubscription object for the provided subscription ID. This is a public endpoint and requires no…

Longview types

  • GETList Longview types/:apiVersion/longview/typesReturns Longview types and prices, including any region-specific rates. <<LB>> __CLI__. linode-cli longview types Learn more...

Managed contacts

  • GETList managed contacts/:apiVersion/managed/contacts?page={{page}}&page_size={{page_size}}Returns a paginated list of managed contacts on your account. This operation can only be accessed by the unrestricted users of an account. <<LB>> __CLI__.…
  • POSTCreate a managed contact/:apiVersion/managed/contactsCreates a managed contact. When investigating or resolving an issue with a service monitor, Akamai Support may reach out to this contact. This operation can…
  • GETGet a managed contact/:apiVersion/managed/contacts/:contactIdReturns a single managed contact. This operation can only be accessed by the unrestricted users of an account. <<LB>> __CLI__. linode-cli managed contact-view…
  • PUTUpdate a managed contact/:apiVersion/managed/contacts/:contactIdUpdates information for a managed contact. This operation can only be accessed by the unrestricted users of an account. <<LB>> __CLI__. linode-cli managed…
  • DELETEDelete a managed contact/:apiVersion/managed/contacts/:contactIdDeletes a managed contact. This operation can only be accessed by the unrestricted users of an account. <<LB>> __CLI__. linode-cli managed contact-delete 567…

Managed credentials

  • GETList managed credentials/:apiVersion/managed/credentials?page={{page}}&page_size={{page_size}}Returns a paginated list of managed credentials on your account. This operation can only be accessed by the unrestricted users of an account. <<LB>> __CLI__.…
  • POSTCreate a managed credential/:apiVersion/managed/credentialsCreates a managed credential to store usernames and passwords for applications running on your Linode. Akamai Support can use these credentials to access your…
  • GETGet a managed credential/:apiVersion/managed/credentials/:credentialIdReturns a single Managed Credential. This operation can only be accessed by the unrestricted users of an account. <<LB>> __CLI__. linode-cli managed…

Showing 300 of 400 endpoints. Fork the collection to see all of them.

API details

Base URL
https://api.linode.com
Authentication
OAuth 2.0 (authorization code flow) with 29 scopes
A bearer token in the Authorization header
Operations
449 operations on 308 pathsGET 219POST 126PUT 53DELETE 51
10 marked deprecated
Main resources
Image sharing 22Databases 17Linode instances 15Firewalls 14IP addresses 13Buckets 12Linode interfaces 10Volumes 10Clusters 9Disks 8
Response formats
application/json image/png
Description format
OpenAPI 3.0.1, API version 4.215.0

How to test the Akamai: Linode API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Linode API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 29 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get your account” (GET /:apiVersion/account), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Akamai: Linode API?

Add a Cloud Computing instance so you can build, release, and scale applications faster with virtual machines. It is listed under Developer tools and has 449 endpoints.

Who publishes the Akamai: Linode API?

It is listed from Linode's public API description (an OpenAPI document), not published by Linode on Swastik Codes. Anyone who controls linode.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Akamai: Linode API?

Requests go to https://api.linode.com. Endpoint paths are added to this base URL.

How do I authenticate with the Akamai: Linode API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 29 scopes; A bearer token in the Authorization header.

How many endpoints does the Akamai: Linode API have?

449 operations on 308 paths (219 GET, 126 POST, 53 PUT, 51 DELETE). The largest groups are Image sharing, Databases, Linode instances, Firewalls. This listing's collection holds the first 400.

Is forking the Akamai: Linode API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.