Linode API
Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to…
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
Introduction
The Linode API provides the ability to programmatically manage the full
range of Linode products and services.
This reference is designed to assist application developers and system
administrators. Each endpoint includes descriptions, request syntax, and
examples using standard HTTP requests. Response data is returned in JSON
format.
This document was generated from our OpenAPI Specification. See the
OpenAPI website for more information.
Download the Linode OpenAPI Specification .
Changelog
View our Changelog to see release
notes on all changes made to our API.
Access and Authentication
Some endpoints are publicly accessible without requiring authentication.
All endpoints affecting your Account, however, require either a Personal
Access Token or OAuth authentication (when using third-party
applications).
Personal Access Token
The easiest way to access the API is with a Personal Access Token (PAT)
generated from the
Linode Cloud Manager or
the Create Personal Access Token endpoint.
All scopes for the OAuth security model (defined below) apply to this
security model as well.
Authentication
| Security Scheme Type: | HTTP |
|---|---|
| HTTP Authorization Scheme | bearer |
OAuth
If you only need to access the Linode API for personal use,
we recommend that you create a personal access token.
If you're designing an application that can authenticate with an arbitrary Linode user, then
you should use the OAuth 2.0 workflows presented in this section.
For a more detailed example of an OAuth 2.0 implementation, see our guide on How to Create an OAuth App with the Linode Python API Library.
Before you implement OAuth in your application, you first need to create an OAuth client. You can do this with the Linode API or via the Cloud Manager:
- When creating the client, you'll supply a
labeland aredirect_uri(referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a
client_idand asecret. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created.
- A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation.
- A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client.
- Public and private clients follow different workflows, as described below.
OAuth Workflow
The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used
to authenticate a user before an application can start making API calls on the user's behalf.
Notes:
- With respect to the diagram in section 1.2 of RFC 6749, login.linode.com (referred to in this section as the login server)
is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the api server) is the Resource Server.
- The OAuth spec refers to the private and public workflows listed below as the authorization code flow and implicit flow.
| PRIVATE WORKFLOW | PUBLIC WORKFLOW |
|---|---|
| 1. The user visits the application's website and is directed to login with Linode. | 1. The user visits the application's website and is directed to login with Linode. |
2. Your application then redirects the user to Linode's login server with the client application's client_id and requested OAuth scope, which should appear in the URL of the login page. | 2. Your application then redirects the user to Linode's login server with the client application's client_id and requested OAuth scope, which should appear in the URL of the login page. |
| 3. The user logs into the login server with their username and password. | 3. The user logs into the login server with their username and password. |
| 4. The login server redirects the user to the specificed redirect URL with… |
Endpoints 350
Account
- GETAccount View
/accountReturns the contact and billing information related to your Account. - PUTAccount Update
/accountUpdates contact and billing information related to your Account. - POSTAccount Cancel
/account/cancelCancels 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… - POSTCredit Card Add/Edit
/account/credit-cardDeprecated. DEPRECATED. Please use Payment Method Add (POST /account/payment-methods). Adds a credit card Payment Method to your account and sets it as the… - GETEntity Transfers List
/account/entity-transfers?page=1&page_size=100Deprecated. DEPRECATED. Please use Service Transfers List. - POSTEntity Transfer Create
/account/entity-transfersDeprecated. DEPRECATED. Please use Service Transfer Create. - GETEntity Transfer View
/account/entity-transfers/:tokenDeprecated. DEPRECATED. Please use Service Transfer View. - DELETEEntity Transfer Cancel
/account/entity-transfers/:tokenDeprecated. DEPRECATED. Please use Service Transfer Cancel. - POSTEntity Transfer Accept
/account/entity-transfers/:token/acceptDeprecated. DEPRECATED. Please use Service Transfer Accept. - GETEvents List
/account/events?page=1&page_size=100Returns a collection of Event objects representing actions taken on your Account from the last 90 days. The Events returned depend on your grants. - GETEvent View
/account/events/:eventIdReturns a single Event object. - POSTEvent Mark as Read
/account/events/:eventId/readMarks a single Event as read. - POSTEvent Mark as Seen
/account/events/:eventId/seenMarks all Events up to and including this Event by ID as seen. - GETInvoices List
/account/invoices?page=1&page_size=100Returns a paginated list of Invoices against your Account. - GETInvoice View
/account/invoices/:invoiceIdReturns a single Invoice object. - GETInvoice Items List
/account/invoices/:invoiceId/items?page=1&page_size=100Returns a paginated list of Invoice items. - GETUser Logins List All
/account/loginsReturns a collection of successful logins for all users on the account during the last 90 days. This command can only be accessed by the unrestricted users of… - GETLogin View
/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… - GETMaintenance List
/account/maintenanceReturns a collection of Maintenance objects for any entity a user has permissions to view. Cancelled Maintenance objects are not returned. Currently, Linodes… - GETNotifications List
/account/notificationsReturns a collection of Notification objects representing important, often time-sensitive items related to your Account. You cannot interact directly with… - GETOAuth Clients List
/account/oauth-clients?page=1&page_size=100Returns 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… - POSTOAuth Client Create
/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… - GETOAuth Client View
/account/oauth-clients/:clientIdReturns information about a single OAuth client. - PUTOAuth Client Update
/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… - DELETEOAuth Client Delete
/account/oauth-clients/:clientIdDeletes an OAuth Client registered with Linode. The Client ID and Client secret will no longer be accepted by <a target="_top"… - POSTOAuth Client Secret Reset
/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… - GETOAuth Client Thumbnail View
/account/oauth-clients/:clientId/thumbnailReturns the thumbnail for this OAuth Client. This is a publicly-viewable endpoint, and can be accessed without authentication. - PUTOAuth Client Thumbnail Update
/account/oauth-clients/:clientId/thumbnailUpload a thumbnail for a client you own. You must upload an image file that will be returned when the thumbnail is retrieved. This image will be… - GETPayment Methods List
/account/payment-methods?page=1&page_size=100Returns a paginated list of Payment Methods for this Account. - POSTPayment Method Add
/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… - GETPayment Method View
/account/payment-methods/:paymentMethodIdView the details of the specified Payment Method. - DELETEPayment Method Delete
/account/payment-methods/:paymentMethodIdDeactivate the specified Payment Method. The default Payment Method can not be deleted. To add a new default Payment Method, access the Payment Method Add… - POSTPayment Method Make Default
/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. - GETPayments List
/account/payments?page=1&page_size=100Returns a paginated list of Payments made on this Account. - POSTPayment Make
/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… - POSTPayPal Payment Stage
/account/payments/paypalDeprecated. Note: This endpoint is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud… - POSTStaged/Approved PayPal Payment Execute
/account/payments/paypal/executeDeprecated. Note: This endpoint is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud… - GETPayment View
/account/payments/:paymentIdReturns information about a specific Payment. - POSTPromo Credit Add
/account/promo-codesAdds 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… - GETService Transfers List
/account/service-transfers?page=1&page_size=100Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer. This… - POSTService Transfer Create
/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… - GETService Transfer View
/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… - POSTService Transfer Accept
/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… - GETAccount Settings View
/account/settingsReturns information related to your Account settings: Managed service subscription, Longview subscription, and network helper. - PUTAccount Settings Update
/account/settingsUpdates your Account settings. To update your Longview subscription plan, send a request to Update Longview Plan. - POSTLinode Managed Enable
/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… - GETNetwork Utilization View
/account/transferReturns a Transfer object showing your network utilization, in GB, for the current month. - GETUsers List
/account/users?page=1&page_size=100Returns a paginated list of Users on your Account. This command can only be accessed by the unrestricted users of an account. Users may access all or part of… - POSTUser Create
/account/usersCreates a User on your Account. Once created, a confirmation message containing password creation and login instructions is sent to the User's email address.… - GETUser View
/account/users/:usernameReturns information about a single User on your Account. This command can only be accessed by the unrestricted users of an account. - PUTUser Update
/account/users/:usernameUpdate information about a User on your Account. This can be used to change the restricted status of a User. When making a User restricted, no grants will be… - DELETEUser Delete
/account/users/:usernameDeletes a User. The deleted User will be immediately logged out and may no longer log in or perform any actions. All of the User's Grants will be removed.… - GETUser's Grants View
/account/users/:username/grantsReturns the full grants structure for the specified account User (other than the account owner, see below for details). This includes all entities on the… - PUTUser's Grants Update
/account/users/:username/grantsUpdate the grants a User has. This can be used to give a User access to new entities or actions, or take access away. You do not need to include the grant for…
Databases
- GETManaged Database Engines List
/databases/engines?page=1&page_size=100Display all available Managed Database engine types and versions. Engine IDs are used when creating new Managed Databases. - GETManaged Database Engine View
/databases/engines/:engineId?page=1&page_size=100Display information for a single Managed Database engine type and version. - GETManaged Databases List All
/databases/instances?page=1&page_size=100Display all Managed Databases that are accessible by your User, regardless of engine type. For more detailed information on a particular Database instance,… - GETManaged MongoDB Databases List
/databases/mongodb/instances?page=1&page_size=100Display all accessible Managed MongoDB Databases. Note: New MongoDB Databases cannot currently be created. - GETManaged MongoDB Database View
/databases/mongodb/instances/:instanceIdDisplay information for a single, accessible Managed MongoDB Database. Note: New MongoDB Databases cannot currently be created. - PUTManaged MongoDB Database Update
/databases/mongodb/instances/:instanceIdUpdate a Managed MongoDB Database. Requires read_write access to the Database. The Database must have an active status to perform this command. Updating… - DELETEManaged MongoDB Database Delete
/databases/mongodb/instances/:instanceIdRemove a Managed MongoDB Database from your Account. Requires read_write access to the Database. The Database must have an active, failed, or degraded status… - GETManaged MongoDB Database Backups List
/databases/mongodb/instances/:instanceId/backups?page=1&page_size=100Display all backups for an accessible Managed MongoDB Database. The Database must not be provisioning to perform this command. Database auto type backups are… - POSTManaged MongoDB Database Backup Snapshot Create
/databases/mongodb/instances/:instanceId/backupsCreates a snapshot backup of a Managed MongoDB Database. Requires read_write access to the Database. Up to 3 snapshot backups for each Database can be stored… - GETManaged MongoDB Database Backup View
/databases/mongodb/instances/:instanceId/backups/:backupIdDisplay information for a single backup for an accessible Managed MongoDB Database. The Database must not be provisioning to perform this command. Note: New… - DELETEManaged MongoDB Database Backup Delete
/databases/mongodb/instances/:instanceId/backups/:backupIdDelete a single backup for an accessible Managed MongoDB Database. Requires read_write access to the Database. The Database must not be provisioning to… - POSTManaged MongoDB Database Backup Restore
/databases/mongodb/instances/:instanceId/backups/:backupId/restoreRestore a backup to a Managed MongoDB Database on your Account. Requires read_write access to the Database. The Database must have an active status to perform… - GETManaged MongoDB Database Credentials View
/databases/mongodb/instances/:instanceId/credentialsDisplay the root username and password for an accessible Managed MongoDB Database. The Database must have an active status to perform this command. Note: New… - POSTManaged MongoDB Database Credentials Reset
/databases/mongodb/instances/:instanceId/credentials/resetReset the root password for a Managed MongoDB Database. Requires read_write access to the Database. A new root password is randomly generated and accessible… - POSTManaged MongoDB Database Patch
/databases/mongodb/instances/:instanceId/patchApply security patches and updates to the underlying operating system of the Managed MongoDB Database. This function runs during regular maintenance windows,… - GETManaged MongoDB Database SSL Certificate View
/databases/mongodb/instances/:instanceId/sslDisplay the SSL CA certificate for an accessible Managed MongoDB Database. The Database must have an active status to perform this command. Note: New MongoDB… - GETManaged MySQL Databases List
/databases/mysql/instances?page=1&page_size=100Display all accessible Managed MySQL Databases. - POSTManaged MySQL Database Create
/databases/mysql/instancesProvision a Managed MySQL Database. Restricted Users must have the add_databases grant to use this command. New instances can take approximately 15 to 30… - GETManaged MySQL Database View
/databases/mysql/instances/:instanceIdDisplay information for a single, accessible Managed MySQL Database. - PUTManaged MySQL Database Update
/databases/mysql/instances/:instanceIdUpdate a Managed MySQL Database. Requires read_write access to the Database. The Database must have an active status to perform this command. Updating… - DELETEManaged MySQL Database Delete
/databases/mysql/instances/:instanceIdRemove a Managed MySQL Database from your Account. Requires read_write access to the Database. The Database must have an active, failed, or degraded status to… - GETManaged MySQL Database Backups List
/databases/mysql/instances/:instanceId/backups?page=1&page_size=100Display all backups for an accessible Managed MySQL Database. The Database must not be provisioning to perform this command. Database auto type backups are… - POSTManaged MySQL Database Backup Snapshot Create
/databases/mysql/instances/:instanceId/backupsCreates a snapshot backup of a Managed MySQL Database. Requires read_write access to the Database. Up to 3 snapshot backups for each Database can be stored at… - GETManaged MySQL Database Backup View
/databases/mysql/instances/:instanceId/backups/:backupIdDisplay information for a single backup for an accessible Managed MySQL Database. The Database must not be provisioning to perform this command. - DELETEManaged MySQL Database Backup Delete
/databases/mysql/instances/:instanceId/backups/:backupIdDelete a single backup for an accessible Managed MySQL Database. Requires read_write access to the Database. The Database must not be provisioning to perform… - POSTManaged MySQL Database Backup Restore
/databases/mysql/instances/:instanceId/backups/:backupId/restoreRestore a backup to a Managed MySQL Database on your Account. Requires read_write access to the Database. The Database must have an active status to perform… - GETManaged MySQL Database Credentials View
/databases/mysql/instances/:instanceId/credentialsDisplay the root username and password for an accessible Managed MySQL Database. The Database must have an active status to perform this command. - POSTManaged MySQL Database Credentials Reset
/databases/mysql/instances/:instanceId/credentials/resetReset the root password for a Managed MySQL Database. Requires read_write access to the Database. A new root password is randomly generated and accessible… - POSTManaged MySQL Database Patch
/databases/mysql/instances/:instanceId/patchApply security patches and updates to the underlying operating system of the Managed MySQL Database. This function runs during regular maintenance windows,… - GETManaged MySQL Database SSL Certificate View
/databases/mysql/instances/:instanceId/sslDisplay the SSL CA certificate for an accessible Managed MySQL Database. The Database must have an active status to perform this command. - GETManaged PostgreSQL Databases List
/databases/postgresql/instances?page=1&page_size=100Display all accessible Managed PostgreSQL Databases. - POSTManaged PostgreSQL Database Create
/databases/postgresql/instancesProvision a Managed PostgreSQL Database. Restricted Users must have the add_databases grant to use this command. New instances can take approximately 15 to 30… - GETManaged PostgreSQL Database View
/databases/postgresql/instances/:instanceIdDisplay information for a single, accessible Managed PostgreSQL Database. - PUTManaged PostgreSQL Database Update
/databases/postgresql/instances/:instanceIdUpdate a Managed PostgreSQL Database. Requires read_write access to the Database. The Database must have an active status to perform this command. Updating… - DELETEManaged PostgreSQL Database Delete
/databases/postgresql/instances/:instanceIdRemove a Managed PostgreSQL Database from your Account. Requires read_write access to the Database. The Database must have an active, failed, or degraded… - GETManaged PostgreSQL Database Backups List
/databases/postgresql/instances/:instanceId/backups?page=1&page_size=100Display all backups for an accessible Managed PostgreSQL Database. The Database must not be provisioning to perform this command. Database auto type backups… - POSTManaged PostgreSQL Database Backup Snapshot Create
/databases/postgresql/instances/:instanceId/backupsCreates a snapshot backup of a Managed PostgreSQL Database. Requires read_write access to the Database. Up to 3 snapshot backups for each Database can be… - GETManaged PostgreSQL Database Backup View
/databases/postgresql/instances/:instanceId/backups/:backupIdDisplay information for a single backup for an accessible Managed PostgreSQL Database. The Database must not be provisioning to perform this command. - DELETEManaged PostgreSQL Database Backup Delete
/databases/postgresql/instances/:instanceId/backups/:backupIdDelete a single backup for an accessible Managed PostgreSQL Database. Requires read_write access to the Database. The Database must not be provisioning to… - POSTManaged PostgreSQL Database Backup Restore
/databases/postgresql/instances/:instanceId/backups/:backupId/restoreRestore a backup to a Managed PostgreSQL Database on your Account. Requires read_write access to the Database. The Database must have an active status to… - GETManaged PostgreSQL Database Credentials View
/databases/postgresql/instances/:instanceId/credentialsDisplay the root username and password for an accessible Managed PostgreSQL Database. The Database must have an active status to perform this command. - POSTManaged PostgreSQL Database Credentials Reset
/databases/postgresql/instances/:instanceId/credentials/resetReset the root password for a Managed PostgreSQL Database. Requires read_write access to the Database. A new root password is randomly generated and… - POSTManaged PostgreSQL Database Patch
/databases/postgresql/instances/:instanceId/patchApply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. This function runs during regular maintenance… - GETManaged PostgreSQL Database SSL Certificate View
/databases/postgresql/instances/:instanceId/sslDisplay the SSL CA certificate for an accessible Managed PostgreSQL Database. The Database must have an active status to perform this command. - GETManaged Database Types List
/databases/types?page=1&page_size=100Display all Managed Database node types. The type and number of nodes determine the resources and price of a Managed Database instance. Each Managed Database… - GETManaged Database Type View
/databases/types/:typeId?page=1&page_size=100Display the details of a single Managed Database type. The type and number of nodes determine the resources and price of a Managed Database instance.
Domains
- GETDomains List
/domains?page=1&page_size=100This 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… - POSTDomain Create
/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… - POSTDomain Import
/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… - GETDomain View
/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… - PUTDomain Update
/domains/:domainIdUpdate information about a Domain in Linode's DNS Manager. - DELETEDomain Delete
/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… - POSTDomain Clone
/domains/:domainId/cloneClones a Domain and all associated DNS records from a Domain that is registered in Linode's DNS manager. - GETDomain Records List
/domains/:domainId/records?page=1&page_size=100Returns a paginated list of Records configured on a Domain in Linode's DNS Manager. - POSTDomain Record Create
/domains/:domainId/recordsAdds a new Domain Record to the zonefile this Domain represents. Each domain can have up to 12,000 active records. - GETDomain Record View
/domains/:domainId/records/:recordIdView a single Record on this Domain. - PUTDomain Record Update
/domains/:domainId/records/:recordIdUpdates a single Record on this Domain. - DELETEDomain Record Delete
/domains/:domainId/records/:recordIdDeletes a Record on this Domain. - GETDomain Zone File View
/domains/:domainId/zone-fileReturns the zone file for the last rendered zone for the specified domain.
Images
- GETImages List
/images?page=1&page_size=100Returns a paginated list of Images. * Public Images have IDs that begin with "linode/". These distribution images are generally available to all users. *… - POSTImage Create
/imagesCaptures a private gold-master Image from a Linode Disk. - POSTImage Upload
/images/uploadInitiates an Image upload. This endpoint creates a new private Image object and returns it along with the URL to which image data can be uploaded. Image data… - GETImage View
/images/:imageIdGet information about a single Image. * Public Images have IDs that begin with "linode/". These distribution images are generally available to all users. *… - PUTImage Update
/images/:imageIdUpdates a private Image that you have permission to read_write. - DELETEImage Delete
/images/:imageIdDeletes a private Image you have permission to read_write. Deleting an Image is a destructive action and cannot be undone.
Linode Instances
- GETLinodes List
/linode/instances?page=1&page_size=100Returns a paginated list of Linodes you have permission to view. - POSTLinode Create
/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… - GETLinode View
/linode/instances/:linodeIdGet a specific Linode by ID. - PUTLinode Update
/linode/instances/:linodeIdUpdates a Linode that you have permission to read_write. Important: You must be an unrestricted User in order to add or modify tags on Linodes. - DELETELinode Delete
/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… - GETBackups List
/linode/instances/:linodeId/backupsReturns information about this Linode's available backups. - POSTSnapshot Create
/linode/instances/:linodeId/backupsCreates 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… - POSTBackups Cancel
/linode/instances/:linodeId/backups/cancelCancels the Backup service on the given Linode. Deletes all of this Linode's existing backups forever. - POSTBackups Enable
/linode/instances/:linodeId/backups/enableEnables backups for the specified Linode. - GETBackup View
/linode/instances/:linodeId/backups/:backupIdReturns information about a Backup. - POSTBackup Restore
/linode/instances/:linodeId/backups/:backupId/restoreRestores a Linode's Backup to the specified Linode. - POSTLinode Boot
/linode/instances/:linodeId/bootBoots 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… - POSTLinode Clone
/linode/instances/:linodeId/cloneYou can clone your Linode's existing Disks or Configuration profiles to another Linode on your Account. In order for this request to complete successfully,… - GETConfiguration Profiles List
/linode/instances/:linodeId/configs?page=1&page_size=100Lists Configuration profiles associated with a Linode. - POSTConfiguration Profile Create
/linode/instances/:linodeId/configsAdds a new Configuration profile to a Linode. - GETConfiguration Profile View
/linode/instances/:linodeId/configs/:configIdReturns information about a specific Configuration profile. - PUTConfiguration Profile Update
/linode/instances/:linodeId/configs/:configIdUpdates a Configuration profile. - DELETEConfiguration Profile Delete
/linode/instances/:linodeId/configs/:configIdDeletes the specified Configuration profile from the specified Linode. - GETDisks List
/linode/instances/:linodeId/disks?page=1&page_size=100View Disk information for Disks associated with this Linode. - POSTDisk Create
/linode/instances/:linodeId/disksAdds 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… - GETDisk View
/linode/instances/:linodeId/disks/:diskIdView Disk information for a Disk associated with this Linode. - PUTDisk Update
/linode/instances/:linodeId/disks/:diskIdUpdates a Disk that you have permission to read_write. - DELETEDisk Delete
/linode/instances/:linodeId/disks/:diskIdDeletes a Disk you have permission to read_write. Deleting a Disk is a destructive action and cannot be undone. - POSTDisk Clone
/linode/instances/:linodeId/disks/:diskId/cloneCopies 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… - POSTDisk Root Password Reset
/linode/instances/:linodeId/disks/:diskId/passwordResets the password of a Disk you have permission to read_write. - POSTDisk Resize
/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… - GETFirewalls List
/linode/instances/:linodeId/firewalls?page=1&page_size=100View Firewall information for Firewalls associated with this Linode. - GETNetworking Information List
/linode/instances/:linodeId/ipsReturns networking information for a single Linode. - POSTIPv4 Address Allocate
/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… - GETIP Address View
/linode/instances/:linodeId/ips/:addressView information about the specified IP address associated with the specified Linode. - PUTIP Address Update
/linode/instances/:linodeId/ips/:addressUpdates a the reverse DNS (RDNS) for a particular IP Address associated with this Linode. Setting the RDNS to null for a public IPv4 address, resets it to the… - DELETEIPv4 Address Delete
/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. - POSTDC Migration/Pending Host Migration Initiate
/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… - POSTLinode Upgrade
/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… - GETLinode NodeBalancers View
/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… - POSTLinode Root Password Reset
/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… - POSTLinode Reboot
/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… - POSTLinode Rebuild
/linode/instances/:linodeId/rebuildRebuilds a Linode you have the read_write permission to modify. A rebuild will first shut down the Linode, delete all disks and configs on the Linode, and… - POSTLinode Boot into Rescue Mode
/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… - POSTLinode Resize
/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… - POSTLinode Shut Down
/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… - GETLinode Statistics View
/linode/instances/:linodeId/statsReturns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours. - GETStatistics View (year/month)
/linode/instances/:linodeId/stats/:year/:monthReturns statistics for a specific month. The year/month values must be either a date in the past, or the current month. If the current month, statistics will… - GETNetwork Transfer View
/linode/instances/:linodeId/transferReturns a Linode's network transfer pool statistics for the current month. - GETNetwork Transfer View (year/month)
/linode/instances/:linodeId/transfer/:year/:monthReturns a Linode's network transfer statistics for a specific month. The year/month values must be either a date in the past, or the current month. - GETLinode's Volumes List
/linode/instances/:linodeId/volumes?page=1&page_size=100View Block Storage Volumes attached to this Linode. - GETKernels List
/linode/kernels?page=1&page_size=100Lists available Kernels. - GETKernel View
/linode/kernels/:kernelIdReturns information about a single Kernel.
Linode Types
- GETTypes List
/linode/typesReturns collection of Linode Types, including pricing and specifications for each Type. These are used when creating or resizing Linodes. - GETType View
/linode/types/:typeIdReturns information about a specific Linode Type, including pricing and specifications. This is used when creating or resizing Linodes.
Linode Kubernetes Engine (LKE)
- GETKubernetes Clusters List
/lke/clustersLists current Kubernetes clusters available on your account. - POSTKubernetes Cluster Create
/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… - GETKubernetes Cluster View
/lke/clusters/:clusterIdGet a specific Cluster by ID. - PUTKubernetes Cluster Update
/lke/clusters/:clusterIdUpdates a Kubernetes cluster. - DELETEKubernetes Cluster Delete
/lke/clusters/:clusterIdDeletes a Cluster you have permission to read_write. Deleting a Cluster is a destructive action and cannot be undone. Deleting a Cluster: Deletes all Linodes… - GETKubernetes API Endpoints List
/lke/clusters/:clusterId/api-endpointsList the Kubernetes API server endpoints for this cluster. Please note that it often takes 2-5 minutes before the endpoint is ready after first creating a new… - GETKubernetes Cluster Dashboard URL View
/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… - GETKubeconfig View
/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. - DELETEKubeconfig Delete
/lke/clusters/:clusterId/kubeconfigDelete and regenerate the Kubeconfig file for a Cluster. - GETNode View
/lke/clusters/:clusterId/nodes/:nodeIdReturns the values for a specified node object. - DELETENode Delete
/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 Pool… - POSTNode Recycle
/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.… - GETNode Pools List
/lke/clusters/:clusterId/poolsReturns all active Node Pools on a Kubernetes cluster. - POSTNode Pool Create
/lke/clusters/:clusterId/poolsCreates a new Node Pool for the designated Kubernetes cluster. - GETNode Pool View
/lke/clusters/:clusterId/pools/:poolIdGet a specific Node Pool by ID. - PUTNode Pool Update
/lke/clusters/:clusterId/pools/:poolIdUpdates a Node Pool's count and autoscaler configuration. Linodes will be created or deleted to match changes to the Node Pool's count. Any local storage on… - DELETENode Pool Delete
/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 all… - POSTNode Pool Recycle
/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,… - POSTCluster Nodes Recycle
/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… - POSTKubernetes Cluster Regenerate
/lke/clusters/:clusterId/regenerateRegenerate the Kubeconfig file and/or the service account token for a Cluster. This is a helper command that allows performing both the Kubeconfig Delete and… - DELETEService Token Delete
/lke/clusters/:clusterId/servicetokenDelete and regenerate the service account token for a Cluster. Note: When regenerating a service account token, the Cluster's control plane components and… - GETKubernetes Versions List
/lke/versionsList the Kubernetes versions available for deployment to a Kubernetes cluster. - GETKubernetes Version View
/lke/versions/:versionView a Kubernetes version available for deployment to a Kubernetes cluster.
Longview
- GETLongview Clients List
/longview/clients?page=1&page_size=100Returns 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… - POSTLongview Client Create
/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… - GETLongview Client View
/longview/clients/:clientIdReturns a single Longview Client you can access. - PUTLongview Client Update
/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. - DELETELongview Client Delete
/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 application… - GETLongview Plan View
/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… - PUTLongview Plan Update
/longview/planUpdate your Longview plan to that of the given subcription ID. This returns a LongviewSubscription object for the updated Longview Pro plan, or an empty set… - GETLongview Subscriptions List
/longview/subscriptions?page=1&page_size=100Returns a paginated list of available Longview Subscriptions. This is a public endpoint and requires no authentication. - GETLongview Subscription View
/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…
Managed
- GETManaged Contacts List
/managed/contacts?page=1&page_size=100Returns a paginated list of Managed Contacts on your Account. This command can only be accessed by the unrestricted users of an account. - POSTManaged Contact Create
/managed/contactsCreates 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… - GETManaged Contact View
/managed/contacts/:contactIdReturns a single Managed Contact. This command can only be accessed by the unrestricted users of an account. - PUTManaged Contact Update
/managed/contacts/:contactIdUpdates information about a Managed Contact. This command can only be accessed by the unrestricted users of an account. - DELETEManaged Contact Delete
/managed/contacts/:contactIdDeletes a Managed Contact. This command can only be accessed by the unrestricted users of an account. - GETManaged Credentials List
/managed/credentials?page=1&page_size=100Returns a paginated list of Managed Credentials on your Account. This command can only be accessed by the unrestricted users of an account. - POSTManaged Credential Create
/managed/credentialsCreates a Managed Credential. A Managed Credential is stored securely to allow Linode special forces to access your Managed Services and resolve issues. This… - GETManaged SSH Key View
/managed/credentials/sshkeyReturns the unique SSH public key assigned to your Linode account's Managed service. If you add this public key to a Linode on your account, Linode special… - GETManaged Credential View
/managed/credentials/:credentialIdReturns a single Managed Credential. This command can only be accessed by the unrestricted users of an account. - PUTManaged Credential Update
/managed/credentials/:credentialIdUpdates the label of a Managed Credential. This endpoint does not update the username and password for a Managed Credential. To do this, use the Managed… - POSTManaged Credential Delete
/managed/credentials/:credentialId/revokeDeletes a Managed Credential. Linode special forces will no longer have access to this Credential when attempting to resolve issues. This command can only be… - POSTManaged Credential Username and Password Update
/managed/credentials/:credentialId/updateUpdates the username and password for a Managed Credential. This command can only be accessed by the unrestricted users of an account. - GETManaged Issues List
/managed/issues?page=1&page_size=100Returns a paginated list of recent and ongoing issues detected on your Managed Services. This command can only be accessed by the unrestricted users of an… - GETManaged Issue View
/managed/issues/:issueIdReturns a single Issue that is impacting or did impact one of your Managed Services. This command can only be accessed by the unrestricted users of an account. - GETManaged Linode Settings List
/managed/linode-settings?page=1&page_size=100Returns a paginated list of Managed Settings for your Linodes. There will be one entry per Linode on your Account. This command can only be accessed by the… - GETLinode's Managed Settings View
/managed/linode-settings/:linodeIdReturns a single Linode's Managed settings. This command can only be accessed by the unrestricted users of an account. - PUTLinode's Managed Settings Update
/managed/linode-settings/:linodeIdUpdates a single Linode's Managed settings. This command can only be accessed by the unrestricted users of an account. - GETManaged Services List
/managed/servicesReturns a paginated list of Managed Services on your Account. These are the services Linode Managed is monitoring and will report and attempt to resolve… - POSTManaged Service Create
/managed/servicesCreates a Managed Service. Linode Managed will begin monitoring this service and reporting and attempting to resolve any Issues. This command can only be… - GETManaged Service View
/managed/services/:serviceIdReturns information about a single Managed Service on your Account. This command can only be accessed by the unrestricted users of an account. - PUTManaged Service Update
/managed/services/:serviceIdUpdates information about a Managed Service. This command can only be accessed by the unrestricted users of an account. - DELETEManaged Service Delete
/managed/services/:serviceIdDeletes a Managed Service. This service will no longer be monitored by Linode Managed. This command can only be accessed by the unrestricted users of an… - POSTManaged Service Disable
/managed/services/:serviceId/disableTemporarily disables monitoring of a Managed Service. This command can only be accessed by the unrestricted users of an account. - POSTManaged Service Enable
/managed/services/:serviceId/enableEnables monitoring of a Managed Service. This command can only be accessed by the unrestricted users of an account. - GETManaged Stats List
/managed/statsReturns a list of Managed Stats on your Account in the form of x and y data points. You can use these data points to plot your own graph visualizations. These…
Networking
- GETFirewalls List
/networking/firewalls?page=1&page_size=100Returns a paginated list of accessible Firewalls. - POSTFirewall Create
/networking/firewallsCreates a Firewall to filter network traffic. * Use the rules property to create inbound and outbound access rules. * Use the devices property to assign the… - GETFirewall View
/networking/firewalls/:firewallIdGet a specific Firewall resource by its ID. The Firewall's Devices will not be returned in the response. Instead, use the List Firewall Devices endpoint to… - PUTFirewall Update
/networking/firewalls/:firewallIdUpdates information for a Firewall. Some parts of a Firewall's configuration cannot be manipulated by this endpoint: A Firewall's Devices cannot be set with… - DELETEFirewall Delete
/networking/firewalls/:firewallIdDelete a Firewall resource by its ID. This will remove all of the Firewall's Rules from any Linode services that the Firewall was assigned to. A… - GETFirewall Devices List
/networking/firewalls/:firewallId/devices?page=1&page_size=100Returns a paginated list of a Firewall's Devices. A Firewall Device assigns a Firewall to a Linode service (referred to as the Device's entity). Currently,… - POSTFirewall Device Create
/networking/firewalls/:firewallId/devicesCreates 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. *… - GETFirewall Device View
/networking/firewalls/:firewallId/devices/:deviceIdReturns information for a Firewall Device, which assigns a Firewall to a Linode service (referred to as the Device's entity). Currently, only Devices with an… - DELETEFirewall Device Delete
/networking/firewalls/:firewallId/devices/:deviceIdRemoves a Firewall Device, which removes a Firewall from the Linode service it was assigned to by the Device. This will remove all of the Firewall's Rules… - GETFirewall Rules List
/networking/firewalls/:firewallId/rulesReturns the inbound and outbound Rules for a Firewall. - PUTFirewall Rules Update
/networking/firewalls/:firewallId/rulesUpdates the inbound and outbound Rules for a Firewall. Note: This command replaces all of a Firewall's inbound and/or outbound rulesets with the values… - GETIP Addresses List
/networking/ipsReturns a paginated list of IP Addresses on your Account, excluding private addresses. - POSTIP Address Allocate
/networking/ipsAllocates a new IPv4 Address on your Account. The Linode must be configured to support additional addresses - please open a support ticket requesting… - POSTIP Addresses Assign
/networking/ips/assignAssign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your… - POSTIP Addresses Share
https://api.linode.com/v4beta/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… - GETIP Address View
/networking/ips/:addressReturns information about a single IP Address on your Account. - PUTIP Address RDNS Update
/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… - POSTLinodes Assign IPv4s
/networking/ipv4/assignThis command is equivalent to IP Addresses Assign (POST /networking/ips/assign). Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one… - POSTIPv4 Sharing Configure
/networking/ipv4/shareThis command is equivalent to IP Addresses Share (POST /networking/ips/share). Configure shared IPs. IP sharing allows IP address reassignment (also referred… - GETIPv6 Pools List
/networking/ipv6/pools?page=1&page_size=100Displays the IPv6 pools on your Account. A pool of IPv6 addresses are routed to all of your Linodes in a single Region. Any Linode on your Account may bring… - GETIPv6 Ranges List
/networking/ipv6/ranges?page=1&page_size=100Displays the IPv6 ranges on your Account. * An IPv6 range is a /64 or /54 block of IPv6 addresses routed to a single Linode in a given Region. * Your Linode… - POSTIPv6 Range Create
/networking/ipv6/rangesCreates an IPv6 Range and assigns it based on the provided Linode or route target IPv6 SLAAC address. See the ipv6 property when accessing the Linode View… - GETIPv6 Range View
/networking/ipv6/ranges/:rangeView IPv6 range information. - DELETEIPv6 Range Delete
/networking/ipv6/ranges/:rangeRemoves this IPv6 range from your account and disconnects the range from any assigned Linodes. Note: Shared IPv6 ranges cannot be deleted at this time. Please… - GETVLANs List
https://api.linode.com/v4beta/networking/vlans?page=1&page_size=100Returns a list of all Virtual Local Area Networks (VLANs) on your Account. VLANs provide a mechanism for secure communication between two or more Linodes that…
NodeBalancers
- GETNodeBalancers List
/nodebalancers?page=1&page_size=100Returns a paginated list of NodeBalancers you have access to. - POSTNodeBalancer Create
/nodebalancersCreates a NodeBalancer in the requested Region. NodeBalancers require a port Config with at least one backend Node to start serving requests. When using the… - GETNodeBalancer View
/nodebalancers/:nodeBalancerIdReturns a single NodeBalancer you can access. - PUTNodeBalancer Update
/nodebalancers/:nodeBalancerIdUpdates information about a NodeBalancer you can access. - DELETENodeBalancer Delete
/nodebalancers/:nodeBalancerIdDeletes a NodeBalancer. This is a destructive action and cannot be undone. Deleting a NodeBalancer will also delete all associated Configs and Nodes, although… - GETConfigs List
/nodebalancers/:nodeBalancerId/configs?page=1&page_size=100Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer… - POSTConfig Create
/nodebalancers/:nodeBalancerId/configsCreates 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… - GETConfig View
/nodebalancers/:nodeBalancerId/configs/:configIdReturns configuration information for a single port of this NodeBalancer. - PUTConfig Update
/nodebalancers/:nodeBalancerId/configs/:configIdUpdates the configuration for a single port on a NodeBalancer. - DELETEConfig Delete
/nodebalancers/:nodeBalancerId/configs/:configIdDeletes the Config for a port of this NodeBalancer. This cannot be undone. Once completed, this NodeBalancer will no longer respond to requests on the given… - GETNodes List
/nodebalancers/:nodeBalancerId/configs/:configId/nodes?page=1&page_size=100Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port. - POSTNode Create
/nodebalancers/:nodeBalancerId/configs/:configId/nodesCreates a NodeBalancer Node, a backend that can accept traffic for this NodeBalancer Config. Nodes are routed requests on the configured port based on their… - GETNode View
/nodebalancers/:nodeBalancerId/configs/:configId/nodes/:nodeIdReturns information about a single Node, a backend for this NodeBalancer's configured port. - PUTNode Update
/nodebalancers/:nodeBalancerId/configs/:configId/nodes/:nodeIdUpdates information about a Node, a backend for this NodeBalancer's configured port. - DELETENode Delete
/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… - POSTConfig Rebuild
/nodebalancers/:nodeBalancerId/configs/:configId/rebuildRebuilds a NodeBalancer Config and its Nodes that you have permission to modify. Use this command to update a NodeBalancer's Config and Nodes with a single… - GETNodeBalancer Statistics View
/nodebalancers/:nodeBalancerId/statsReturns detailed statistics about the requested NodeBalancer.
Object Storage
- GETObject Storage Buckets List
/object-storage/bucketsReturns a paginated list of all Object Storage Buckets that you own. This endpoint is available for convenience. It is recommended that instead you use the… - POSTObject Storage Bucket Create
/object-storage/bucketsCreates an Object Storage Bucket in the specified cluster. Accounts with negative balances cannot access this command. If the bucket already exists and is… - GETObject Storage Buckets in Cluster List
/object-storage/buckets/:clusterIdReturns a list of Buckets in this cluster belonging to this Account. This endpoint is available for convenience. It is recommended that instead you use the… - GETObject Storage Bucket View
/object-storage/buckets/:clusterId/:bucketReturns a single Object Storage Bucket. This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API… - DELETEObject Storage Bucket Remove
/object-storage/buckets/:clusterId/:bucketRemoves a single bucket. Bucket objects must be removed prior to removing the bucket. While buckets containing objects _may_ be deleted using the s3cmd… - PUTObject Storage Bucket Access Update
/object-storage/buckets/:clusterId/:bucket/accessAllows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings. Only allows enabling/disabling CORS for all origins,… - POSTObject Storage Bucket Access Modify
/object-storage/buckets/:clusterId/:bucket/accessAllows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings. Only allows enabling/disabling CORS for all origins,… - GETObject Storage Object ACL Config View
/object-storage/buckets/:clusterId/:bucket/object-acl?name=stringView an Object's configured Access Control List (ACL) in this Object Storage bucket. ACLs define who can access your buckets and objects and specify the level… - PUTObject Storage Object ACL Config Update
/object-storage/buckets/:clusterId/:bucket/object-aclUpdate an Object's configured Access Control List (ACL) in this Object Storage bucket. ACLs define who can access your buckets and objects and specify the… - GETObject Storage Bucket Contents List
/object-storage/buckets/:clusterId/:bucket/object-list?marker=string&delimiter=string&prefix=string&page_size=100Returns the contents of a bucket. The contents are paginated using a marker, which is the name of the last object on the previous page. Objects may be… - POSTObject Storage Object URL Create
/object-storage/buckets/:clusterId/:bucket/object-urlCreates 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… - GETObject Storage TLS/SSL Cert View
/object-storage/buckets/:clusterId/:bucket/sslReturns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user. - POSTObject Storage TLS/SSL Cert Upload
/object-storage/buckets/:clusterId/:bucket/sslUpload 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… - DELETEObject Storage TLS/SSL Cert Delete
/object-storage/buckets/:clusterId/:bucket/sslDeletes this Object Storage bucket's user uploaded TLS/SSL certificate and private key. - POSTObject Storage Cancel
/object-storage/cancelCancel Object Storage on an Account. Warning: Removes all buckets and their contents from your Account. This data is irretrievable once removed. - GETClusters List
/object-storage/clustersReturns a paginated list of Object Storage Clusters that are available for use. Users can connect to the clusters with third party clients to create buckets… - GETCluster View
/object-storage/clusters/:clusterIdReturns a single Object Storage Cluster. - GETObject Storage Keys List
/object-storage/keysReturns a paginated list of Object Storage Keys for authenticating to the Object Storage S3 API. - POSTObject Storage Key Create
/object-storage/keysProvisions a new Object Storage Key on your account. Accounts with negative balances cannot access this command. * To create a Limited Access Key with… - GETObject Storage Key View
/object-storage/keys/:keyIdReturns a single Object Storage Key provisioned for your account. - PUTObject Storage Key Update
/object-storage/keys/:keyIdUpdates an Object Storage Key on your account. - DELETEObject Storage Key Revoke
/object-storage/keys/:keyIdRevokes an Object Storage Key. This keypair will no longer be usable by third-party clients. - GETObject Storage Transfer View
/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…
Profile
- GETProfile View
/profileReturns information about the current User. This can be used to see who is acting in applications where more than one token is managed. For example, in… - PUTProfile Update
/profileUpdate information in your Profile. This endpoint requires the "account:read_write" OAuth Scope. - GETAuthorized Apps List
/profile/apps?page=1&page_size=100This is a collection of OAuth apps that you've given access to your Account, and includes the level of access granted. - GETAuthorized App View
/profile/apps/:appIdReturns information about a single app you've authorized to access your Account. - DELETEApp Access Revoke
/profile/apps/:appIdExpires this app token. This token may no longer be used to access your Account. - GETTrusted Devices List
/profile/devicesReturns a paginated list of active TrustedDevices for your User. Browsers with an active Remember Me Session are logged into your account until the session… - GETTrusted Device View
/profile/devices/:deviceIdReturns a single active TrustedDevice for your User. - DELETETrusted Device Revoke
/profile/devices/:deviceIdRevoke an active TrustedDevice for your User. Once a TrustedDevice is revoked, this device will have to log in again before accessing your Linode account. - GETGrants List
/profile/grantsThis returns a GrantsResponse describing what the acting User has been granted access to. For unrestricted users, this will return a 204 and no body because…
Showing 300 of 350 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://api.linode.com/v4https://api.linode.com/v4beta- Authentication
- OAuth 2.0 (authorization code flow) with 29 scopes
A bearer token in the Authorization header - Operations
- 350 operations on 226 pathsGET 158POST 110DELETE 43PUT 39
8 marked deprecated - Main resources
- Account 54Linode Instances 48Databases 46Profile 31Managed 25Networking 25Linode Kubernetes Engine (LKE) 23Object Storage 23NodeBalancers 17Domains 13
- Response formats
application/jsonimage/png- Description format
- OpenAPI 3.0.1, API version
4.145.0 - Links
- OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Linode API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Linode API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Account View” (GET /account), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Linode API?
Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to… It is listed under Developer tools and has 350 endpoints.
Who publishes the 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 Linode API?
Its description lists 2 base URLs: https://api.linode.com/v4, https://api.linode.com/v4beta. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the 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 Linode API have?
350 operations on 226 paths (158 GET, 110 POST, 43 DELETE, 39 PUT). The largest groups are Account, Linode Instances, Databases, Profile.
Is forking the Linode API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.