flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

getAccount

Returns the contact and billing information related to your Account.

OnInit
./lib/actions/getAccount.js
OnStartup
-
OnClose
-

Attributes

-

updateAccount

Updates contact and billing information related to your Account.

OnInit
./lib/actions/updateAccount.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account

OnInit
./lib/actions/x_linode_cli_command_account.js
OnStartup
-
OnClose
-

Attributes

-

createCreditCard

Adds/edit credit card information to your Account. Only one credit card can be associated with your Account, so using this endpoint will overwrite your currently active card information with the new credit card.

OnInit
./lib/actions/createCreditCard.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_credit_card

OnInit
./lib/actions/x_linode_cli_command_account_credit_card.js
OnStartup
-
OnClose
-

Attributes

-

getEvents

Returns a collection of Event objects representing actions taken on your Account. The Events returned depends on your grants.

OnInit
./lib/actions/getEvents.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_events

OnInit
./lib/actions/x_linode_cli_command_account_events.js
OnStartup
-
OnClose
-

Attributes

-

getEvent

Returns a single Event object.

OnInit
./lib/actions/getEvent.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_events__eventId_

OnInit
./lib/actions/x_linode_cli_command_account_events__eventId_.js
OnStartup
-
OnClose
-

Attributes

-

eventRead

Marks a single Event as read.

OnInit
./lib/actions/eventRead.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_events__eventId__read

OnInit
./lib/actions/x_linode_cli_command_account_events__eventId__read.js
OnStartup
-
OnClose
-

Attributes

-

eventSeen

Marks all Events up to and including this Event by ID as seen.

OnInit
./lib/actions/eventSeen.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_events__eventId__seen

OnInit
./lib/actions/x_linode_cli_command_account_events__eventId__seen.js
OnStartup
-
OnClose
-

Attributes

-

getInvoices

Returns a paginated list of Invoices against your Account.

OnInit
./lib/actions/getInvoices.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_invoices

OnInit
./lib/actions/x_linode_cli_command_account_invoices.js
OnStartup
-
OnClose
-

Attributes

-

getInvoice

Returns a single Invoice object.

OnInit
./lib/actions/getInvoice.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_invoices__invoiceId_

OnInit
./lib/actions/x_linode_cli_command_account_invoices__invoiceId_.js
OnStartup
-
OnClose
-

Attributes

-

getInvoiceItems

Returns a paginated list of Invoice items.

OnInit
./lib/actions/getInvoiceItems.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_invoices__invoiceId__items

OnInit
./lib/actions/x_linode_cli_command_account_invoices__invoiceId__items.js
OnStartup
-
OnClose
-

Attributes

-

getNotifications

Returns a collection of Notification objects representing important, often time-sensitive items related to your Account. You cannot interact directly with Notifications, and a Notification will disappear when the circumstances causing it have been resolved. For example, if you have an important Ticket open, you must respond to the Ticket to dismiss the Notification.

OnInit
./lib/actions/getNotifications.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_notifications

OnInit
./lib/actions/x_linode_cli_command_account_notifications.js
OnStartup
-
OnClose
-

Attributes

-

getClients

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 Account, and may allow them to grant some level of access to their Linodes or other entities to your application.

OnInit
./lib/actions/getClients.js
OnStartup
-
OnClose
-

Attributes

-

createClient

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

OnInit
./lib/actions/createClient.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_oauth_clients

OnInit
./lib/actions/x_linode_cli_command_account_oauth_clients.js
OnStartup
-
OnClose
-

Attributes

-

deleteClient

Deletes an OAuth Client registered with Linode. The Client ID and Client secret will no longer be accepted by https://login.linode.com, and all tokens issued to this client will be invalidated (meaning that if your application was using a token, it will no longer work).

OnInit
./lib/actions/deleteClient.js
OnStartup
-
OnClose
-

Attributes

-

getClient

Returns information about a single OAuth client.

OnInit
./lib/actions/getClient.js
OnStartup
-
OnClose
-

Attributes

-

updateClient

Update 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 callback url changed in your application.

OnInit
./lib/actions/updateClient.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_oauth_clients__clientId_

OnInit
./lib/actions/x_linode_cli_command_account_oauth_clients__clientId_.js
OnStartup
-
OnClose
-

Attributes

-

resetClientSecret

Resets 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 or disclosed anywhere. This can be used to generate a new secret in case the one you have has been leaked, or to get a new secret if you lost the original. The old secret is expired immediately, and logins to your client with the old secret will fail.

OnInit
./lib/actions/resetClientSecret.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_oauth_clients__clientId__reset_secret

OnInit
./lib/actions/x_linode_cli_command_account_oauth_clients__clientId__reset_secret.js
OnStartup
-
OnClose
-

Attributes

-

getClientThumbnail

Returns the thumbnail for this OAuth Client. This is a publicly-viewable endpoint, and can be accessed without authentication.

OnInit
./lib/actions/getClientThumbnail.js
OnStartup
-
OnClose
-

Attributes

-

setClientThumbnail

Upload 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 publicly-viewable.

OnInit
./lib/actions/setClientThumbnail.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_oauth_clients__clientId__thumbnail

OnInit
./lib/actions/x_linode_cli_command_account_oauth_clients__clientId__thumbnail.js
OnStartup
-
OnClose
-

Attributes

-

getPayments

Returns a paginated list of Payments made on this Account.

OnInit
./lib/actions/getPayments.js
OnStartup
-
OnClose
-

Attributes

-

createPayment

Makes a Payment to your Account via credit card. This will charge your credit card the requested amount.

OnInit
./lib/actions/createPayment.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_payments

OnInit
./lib/actions/x_linode_cli_command_account_payments.js
OnStartup
-
OnClose
-

Attributes

-

createPayPalPayment

This begins the process of submitting a Payment via PayPal. After calling this endpoint, you must take the resulting `payment_id` along with the `payer_id` from your PayPal account and [POST /account/payments/paypal-execute](#operation/executePayPalPayment) to complete the Payment.

OnInit
./lib/actions/createPayPalPayment.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_payments_paypal

OnInit
./lib/actions/x_linode_cli_command_account_payments_paypal.js
OnStartup
-
OnClose
-

Attributes

-

executePayPalPayment

Given a PaymentID and PayerID - as generated by PayPal during the transaction authorization process - this endpoint executes the Payment to capture the funds and credit your Linode Account.

OnInit
./lib/actions/executePayPalPayment.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_payments_paypal_execute

OnInit
./lib/actions/x_linode_cli_command_account_payments_paypal_execute.js
OnStartup
-
OnClose
-

Attributes

-

getPayment

Returns information about a specific Payment.

OnInit
./lib/actions/getPayment.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_payments__paymentId_

OnInit
./lib/actions/x_linode_cli_command_account_payments__paymentId_.js
OnStartup
-
OnClose
-

Attributes

-

getAccountSettings

Returns information related to your Account settings: Managed service subscription, Longview subscription, and network helper.

OnInit
./lib/actions/getAccountSettings.js
OnStartup
-
OnClose
-

Attributes

-

updateAccountSettings

Updates your Account settings.

OnInit
./lib/actions/updateAccountSettings.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_settings

OnInit
./lib/actions/x_linode_cli_command_account_settings.js
OnStartup
-
OnClose
-

Attributes

-

getTransfer

Returns a Transfer object showing your network utilization, in GB, for the current month.

OnInit
./lib/actions/getTransfer.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_transfer

OnInit
./lib/actions/x_linode_cli_command_account_transfer.js
OnStartup
-
OnClose
-

Attributes

-

getUsers

Returns a paginated list of Users on your Account. Users may access all or part of your Account based on their restricted status and grants. An unrestricted User may access everything on the account, whereas restricted User may only access entities or perform actions they've been given specific grants to.

OnInit
./lib/actions/getUsers.js
OnStartup
-
OnClose
-

Attributes

-

createUser

Creates a User on your Account. Once created, the User will be able to log in and access portions of your Account. Access is determined by whether or not they are restricted, and what grants they have been given.

OnInit
./lib/actions/createUser.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_users

OnInit
./lib/actions/x_linode_cli_command_account_users.js
OnStartup
-
OnClose
-

Attributes

-

deleteUser

Deletes 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.

OnInit
./lib/actions/deleteUser.js
OnStartup
-
OnClose
-

Attributes

-

getUser

Returns information about a single User on your Account.

OnInit
./lib/actions/getUser.js
OnStartup
-
OnClose
-

Attributes

-

updateUser

Update 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 configured by default and you must then set up grants in order for the User to access anything on the Account.

OnInit
./lib/actions/updateUser.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_users__username_

OnInit
./lib/actions/x_linode_cli_command_account_users__username_.js
OnStartup
-
OnClose
-

Attributes

-

getUserGrants

Returns the full grants structure for this User. This includes all entities on the Account alongside what level of access this User has to each of them. Individual users may view their own grants at the [/profile/grants](#operation/getProfileGrants) endpoint, but will not see entities that they have no access to.

OnInit
./lib/actions/getUserGrants.js
OnStartup
-
OnClose
-

Attributes

-

updateUserGrants

Update 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 every entity on the Account in this request; any that are not included will remain unchanged.

OnInit
./lib/actions/updateUserGrants.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_account_users__username__grants

OnInit
./lib/actions/x_linode_cli_command_account_users__username__grants.js
OnStartup
-
OnClose
-

Attributes

-

getDomains

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 domains and point your registrar at Linode's nameservers.

OnInit
./lib/actions/getDomains.js
OnStartup
-
OnClose
-

Attributes

-

createDomain

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

OnInit
./lib/actions/createDomain.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_domains

OnInit
./lib/actions/x_linode_cli_command_domains.js
OnStartup
-
OnClose
-

Attributes

-

importDomain

Imports 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 - 2600:3c00::5e - 2600:3c00::5f

OnInit
./lib/actions/importDomain.js
OnStartup
-
OnClose
-

Attributes

-

deleteDomain

Deletes 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 associated Domain Records.

OnInit
./lib/actions/deleteDomain.js
OnStartup
-
OnClose
-

Attributes

-

getDomain

This 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 the domain and point your registrar at Linode's nameservers.

OnInit
./lib/actions/getDomain.js
OnStartup
-
OnClose
-

Attributes

-

updateDomain

Update information about a Domain in Linode's DNS Manager.

OnInit
./lib/actions/updateDomain.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_domains__domainId_

OnInit
./lib/actions/x_linode_cli_command_domains__domainId_.js
OnStartup
-
OnClose
-

Attributes

-

getDomainRecords

Returns a paginated list of Records configured on a Domain in Linode's DNS Manager.

OnInit
./lib/actions/getDomainRecords.js
OnStartup
-
OnClose
-

Attributes

-

createDomainRecord

Adds a new Domain Record to the zonefile this Domain represents.

OnInit
./lib/actions/createDomainRecord.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_domains__domainId__records

OnInit
./lib/actions/x_linode_cli_command_domains__domainId__records.js
OnStartup
-
OnClose
-

Attributes

-

deleteDomainRecord

Deletes a Record on this Domain.

OnInit
./lib/actions/deleteDomainRecord.js
OnStartup
-
OnClose
-

Attributes

-

getDomainRecord

View a single Record on this Domain.

OnInit
./lib/actions/getDomainRecord.js
OnStartup
-
OnClose
-

Attributes

-

updateDomainRecord

Updates a single Record on this Domain.

OnInit
./lib/actions/updateDomainRecord.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_domains__domainId__records__recordId_

OnInit
./lib/actions/x_linode_cli_command_domains__domainId__records__recordId_.js
OnStartup
-
OnClose
-

Attributes

-

getImages

Returns a paginated list of Images. * Calling this endpoint without authentication returns all public Images. * Authentication is required to return a combined paginated list of all public and your private Images.

OnInit
./lib/actions/getImages.js
OnStartup
-
OnClose
-

Attributes

-

createImage

Creates a private gold-master Image from a Linode Disk. There is no additional charge to store Images for Linode users. Images are limited to three per Account.

OnInit
./lib/actions/createImage.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_images

OnInit
./lib/actions/x_linode_cli_command_images.js
OnStartup
-
OnClose
-

Attributes

-

deleteImage

Deletes a private Image you have permission to `read_write`. **Deleting an Image is a destructive action and cannot be undone.**

OnInit
./lib/actions/deleteImage.js
OnStartup
-
OnClose
-

Attributes

-

getImage

Get information about a single Image.

OnInit
./lib/actions/getImage.js
OnStartup
-
OnClose
-

Attributes

-

updateImage

Updates a private Image that you have permission to `read_write`.

OnInit
./lib/actions/updateImage.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_images__imageId_

OnInit
./lib/actions/x_linode_cli_command_images__imageId_.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeInstances

Returns a paginated list of Linodes you have permission to view.

OnInit
./lib/actions/getLinodeInstances.js
OnStartup
-
OnClose
-

Attributes

-

createLinodeInstance

Creates a Linode Instance on your Account. In order for this request to complete successfully, your User must have the `add_linodes` grant. Creating a new Linode will incur a charge on your Account. Linodes can be created using one of the available Types. See [GET /linode/types](#operation/getLinodeTypes) to get more information about each Type's specs and cost. Linodes can be created in any one of our available [Regions](#operation/getRegions) for a list of available Regions you can deploy your Linode in. Linodes can be created in a number of ways: * Using a Linode Linux Distribution image or an Image you created based on another Linode. * The Linode will be `running` after it completes `provisioning`. * A default config with two Disks, one being a 512 swap disk, is created. * `swap_size` can be used to customize the swap disk size. * Requires a `root_pass` be supplied to use for the root User's Account. * It is recommended to supply SSH keys for the root User using the `authorized_keys` field. * You may also supply a list of usernames via the `authorized_users` field. * These users must have an SSH Key associated with your Profile first. See [/profile/sshkeys](#operation/addSSHKey) for more information. * Using a StackScript. * See [/linode/stackscripts](#operation/getStackScripts) for a list of available StackScripts. * The Linode will be `running` after it completes `provisioning`. * Requires a compatible Image to be supplied. * See [/linode/stackscript/{stackscriptId}](#operation/getStackScript) for compatible Images. * Requires a `root_pass` be supplied to use for the root User's Account. * It is recommended to supply SSH keys for the root User using the `authorized_keys` field. * You may also supply a list of usernames via the `authorized_users` field. * These users must have an SSH Key associated with your Profile first. See [/profile/sshkeys](#operation/addSSHKey) for more information. * Using one of your other Linode's backups. * You must create a Linode large enough to accommodate the Backup's size. * The Disks and Config will match that of the Linode that was backed up. * The `root_pass` will match that of the Linode that was backed up. * Create an empty Linode. * The Linode will remain `offline` and must be manually started. * See [POST /linode/instances/{linodeId}/boot](#operation/bootLinodeInstance). * Disks and Configs must be created manually. * This is only recommended for advanced use cases. **Important**: You must be an unrestricted User in order to add or modify tags on Linodes.

OnInit
./lib/actions/createLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances

OnInit
./lib/actions/x_linode_cli_command_linode_instances.js
OnStartup
-
OnClose
-

Attributes

-

deleteLinodeInstance

Deletes a Linode you have permission to `read_write`. **Deleting a Linode is a destructive action and cannot be undone.** Additionally, deleting a Linode: * Gives up any IP addresses the Linode was assigned. * Deletes all Disks, Backups, Configs, etc. * Stops billing for the Linode and its associated services. You will be billed for time used within the billing period the Linode was active.

OnInit
./lib/actions/deleteLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeInstance

Get a specific Linode by ID.

OnInit
./lib/actions/getLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

updateLinodeInstance

Updates 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.

OnInit
./lib/actions/updateLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId_

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId_.js
OnStartup
-
OnClose
-

Attributes

-

getBackups

Returns information about this Linode's available backups.

OnInit
./lib/actions/getBackups.js
OnStartup
-
OnClose
-

Attributes

-

createSnapshot

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

OnInit
./lib/actions/createSnapshot.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__backups

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__backups.js
OnStartup
-
OnClose
-

Attributes

-

cancelBackups

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

OnInit
./lib/actions/cancelBackups.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__backups_cancel

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__backups_cancel.js
OnStartup
-
OnClose
-

Attributes

-

enableBackups

Enables backups for the specified Linode.

OnInit
./lib/actions/enableBackups.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__backups_enable

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__backups_enable.js
OnStartup
-
OnClose
-

Attributes

-

getBackup

Returns information about a Backup.

OnInit
./lib/actions/getBackup.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__backups__backupId_

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__backups__backupId_.js
OnStartup
-
OnClose
-

Attributes

-

restoreBackup

Restores a Linode's Backup to the specified Linode.

OnInit
./lib/actions/restoreBackup.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__backups__backupId__restore

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__backups__backupId__restore.js
OnStartup
-
OnClose
-

Attributes

-

bootLinodeInstance

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

OnInit
./lib/actions/bootLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__boot

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__boot.js
OnStartup
-
OnClose
-

Attributes

-

cloneLinodeInstance

You can clone your Linode's existing Disks or Configuration profiles to another Linode on your Account. In order for this request to complete successfully, your User must have the `add_linodes` grant. Cloning to a new Linode will incur a charge on your Account. If cloning to an existing Linode, any actions currently running or queued must be completed first before you can clone to it.

OnInit
./lib/actions/cloneLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__clone

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__clone.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeConfigs

Lists Configuration profiles associated with a Linode.

OnInit
./lib/actions/getLinodeConfigs.js
OnStartup
-
OnClose
-

Attributes

-

addLinodeConfig

Adds a new Configuration profile to a Linode.

OnInit
./lib/actions/addLinodeConfig.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__configs

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__configs.js
OnStartup
-
OnClose
-

Attributes

-

deleteLinodeConfig

Deletes the specified Configuration profile from the specified Linode.

OnInit
./lib/actions/deleteLinodeConfig.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeConfig

Returns information about a specific Configuration profile.

OnInit
./lib/actions/getLinodeConfig.js
OnStartup
-
OnClose
-

Attributes

-

updateLinodeConfig

Updates a Configuration profile.

OnInit
./lib/actions/updateLinodeConfig.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__configs__configId_

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__configs__configId_.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeDisks

View Disk information for Disks associated with this Linode.

OnInit
./lib/actions/getLinodeDisks.js
OnStartup
-
OnClose
-

Attributes

-

addLinodeDisk

Adds a new Disk to a Linode. You can optionally create a Disk from an Image (see [/images](#operation/getImages) for a list of available public images, or use one of your own), and optionally provide a StackScript to deploy with this Disk.

OnInit
./lib/actions/addLinodeDisk.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__disks

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__disks.js
OnStartup
-
OnClose
-

Attributes

-

deleteDisk

Deletes a Disk you have permission to `read_write`. **Deleting a Disk is a destructive action and cannot be undone.**

OnInit
./lib/actions/deleteDisk.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeDisk

View Disk information for a Disk associated with this Linode.

OnInit
./lib/actions/getLinodeDisk.js
OnStartup
-
OnClose
-

Attributes

-

updateDisk

Updates a Disk that you have permission to `read_write`.

OnInit
./lib/actions/updateDisk.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__disks__diskId_

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__disks__diskId_.js
OnStartup
-
OnClose
-

Attributes

-

cloneLinodeDisk

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

OnInit
./lib/actions/cloneLinodeDisk.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__disks__diskId__clone

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__disks__diskId__clone.js
OnStartup
-
OnClose
-

Attributes

-

resetDiskPassword

Resets the password of a Disk you have permission to `read_write`.

OnInit
./lib/actions/resetDiskPassword.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__disks__diskId__password

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__disks__diskId__password.js
OnStartup
-
OnClose
-

Attributes

-

resizeDisk

Resizes a Disk you have permission to `read_write`. The Linode this Disk is attached to must be shut down for resizing to take effect. If you are resizing the Disk to a smaller size, it cannot be made smaller than what is required by the total size of the files current on the Disk. The Disk must not be in use. If the Disk is in use, the request will succeed but the resize will ultimately fail.

OnInit
./lib/actions/resizeDisk.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__disks__diskId__resize

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__disks__diskId__resize.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeIPs

Returns networking information for a single Linode.

OnInit
./lib/actions/getLinodeIPs.js
OnStartup
-
OnClose
-

Attributes

-

addLinodeIP

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

OnInit
./lib/actions/addLinodeIP.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__ips

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__ips.js
OnStartup
-
OnClose
-

Attributes

-

removeLinodeIP

Deletes a public IPv4 address associated with this Linode. This will fail if it is the Linode's last remaining public IPv4 address. Private IPv4 addresses cannot be removed via this endpoint.

OnInit
./lib/actions/removeLinodeIP.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeIP

View information about the specified IP address associated with the specified Linode.

OnInit
./lib/actions/getLinodeIP.js
OnStartup
-
OnClose
-

Attributes

-

updateLinodeIP

Updates a particular IP Address associated with this Linode. Only allows setting/resetting reverse DNS.

OnInit
./lib/actions/updateLinodeIP.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__ips__address_

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__ips__address_.js
OnStartup
-
OnClose
-

Attributes

-

migrateLinodeInstance

In some circumstances, a Linode may have pending migrations scheduled that that you can initiate when convenient. In these cases, a Notification will be returned from [GET /account/notifications](#getNotifications). This endpoint initiates the scheduled migration, which will shut the Linode down, migrate it, and then bring it back to its original state.

OnInit
./lib/actions/migrateLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__migrate

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__migrate.js
OnStartup
-
OnClose
-

Attributes

-

mutateLinodeInstance

Linodes 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 upgraded Type provides, and will be subsequently restarted if it was currently running. If any actions are currently running or queued, those actions must be completed first before you can initiate a mutate.

OnInit
./lib/actions/mutateLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__mutate

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__mutate.js
OnStartup
-
OnClose
-

Attributes

-

rebootLinodeInstance

Reboots 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 a reboot.

OnInit
./lib/actions/rebootLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__reboot

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__reboot.js
OnStartup
-
OnClose
-

Attributes

-

rebuildLinodeInstance

Rebuilds 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 then deploy a new `image` to the Linode with the given attributes. Additionally: * Requires an `image` be supplied. * Requires a `root_pass` be supplied to use for the root User's Account. * It is recommended to supply SSH keys for the root User using the `authorized_keys` field.

OnInit
./lib/actions/rebuildLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__rebuild

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__rebuild.js
OnStartup
-
OnClose
-

Attributes

-

rescueLinodeInstance

Rescue Mode is a safe environment for performing many system recovery and disk management tasks. Rescue Mode is based on the Finnix recovery distribution, a self-contained and bootable Linux distribution. You can also use Rescue Mode for tasks other than disaster recovery, such as formatting disks to use different filesystems, copying data between disks, and downloading files from a disk via SSH and SFTP. * Note that "sdh" is reserved and unavailable during rescue.

OnInit
./lib/actions/rescueLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__rescue

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__rescue.js
OnStartup
-
OnClose
-

Attributes

-

resizeLinodeInstance

Resizes 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 before you can initiate a resize. Additionally, the following criteria must be met in order to resize a Linode: * The Linode must not have a pending migration. * Your Account cannot have an outstanding balance. * The Linode must not have more disk allocation than the new Type allows. * In that situation, you must first delete or resize the disk to be smaller.

OnInit
./lib/actions/resizeLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__resize

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__resize.js
OnStartup
-
OnClose
-

Attributes

-

shutdownLinodeInstance

Shuts 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 initiate a shutdown.

OnInit
./lib/actions/shutdownLinodeInstance.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__shutdown

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__shutdown.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeStats

Returns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours.

OnInit
./lib/actions/getLinodeStats.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__stats

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__stats.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeStatsByYearMonth

Returns 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 be retrieved for the past 30 days.

OnInit
./lib/actions/getLinodeStatsByYearMonth.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__stats__year___month_

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__stats__year___month_.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeVolumes

View Block Storage Volumes attached to this Linode.

OnInit
./lib/actions/getLinodeVolumes.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_instances__linodeId__volumes

OnInit
./lib/actions/x_linode_cli_command_linode_instances__linodeId__volumes.js
OnStartup
-
OnClose
-

Attributes

-

getKernels

Lists available Kernels.

OnInit
./lib/actions/getKernels.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_kernels

OnInit
./lib/actions/x_linode_cli_command_linode_kernels.js
OnStartup
-
OnClose
-

Attributes

-

getKernel

Returns information about a single Kernel.

OnInit
./lib/actions/getKernel.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_kernels__kernelId_

OnInit
./lib/actions/x_linode_cli_command_linode_kernels__kernelId_.js
OnStartup
-
OnClose
-

Attributes

-

getStackScripts

If the request is not authenticated, only public StackScripts are returned. For more information on StackScripts, please read our guide: [Automate Deployment with StackScripts](https://linode.com/docs/platform/stackscripts/).

OnInit
./lib/actions/getStackScripts.js
OnStartup
-
OnClose
-

Attributes

-

addStackScript

Creates a StackScript in your Account.

OnInit
./lib/actions/addStackScript.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_stackscripts

OnInit
./lib/actions/x_linode_cli_command_linode_stackscripts.js
OnStartup
-
OnClose
-

Attributes

-

deleteStackScript

Deletes a private StackScript you have permission to `read_write`. You cannot delete a public StackScript.

OnInit
./lib/actions/deleteStackScript.js
OnStartup
-
OnClose
-

Attributes

-

getStackScript

Returns all of the information about a specified StackScript, including the contents of the script.

OnInit
./lib/actions/getStackScript.js
OnStartup
-
OnClose
-

Attributes

-

updateStackScript

Updates a StackScript. **Once a StackScript is made public, it cannot be made private.**

OnInit
./lib/actions/updateStackScript.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_stackscripts__stackscriptId_

OnInit
./lib/actions/x_linode_cli_command_linode_stackscripts__stackscriptId_.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeTypes

Returns collection of Linode Types, including pricing and specifications for each Type. These are used when [creating](#operation/createLinodeInstance) or [resizing](#operation/resizeLinodeInstance) Linodes.

OnInit
./lib/actions/getLinodeTypes.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_types

OnInit
./lib/actions/x_linode_cli_command_linode_types.js
OnStartup
-
OnClose
-

Attributes

-

getLinodeType

Returns information about a specific Linode Type, including pricing and specifications. This is used when [creating](#operation/createLinodeInstance) or [resizing](#operation/resizeLinodeInstance) Linodes.

OnInit
./lib/actions/getLinodeType.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_linode_types__typeId_

OnInit
./lib/actions/x_linode_cli_command_linode_types__typeId_.js
OnStartup
-
OnClose
-

Attributes

-

getLongviewClients

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 application.

OnInit
./lib/actions/getLongviewClients.js
OnStartup
-
OnClose
-

Attributes

-

createLongviewClient

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

OnInit
./lib/actions/createLongviewClient.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_longview_clients

OnInit
./lib/actions/x_linode_cli_command_longview_clients.js
OnStartup
-
OnClose
-

Attributes

-

deleteLongviewClient

Deletes a Longview Client from your Account. **All information stored for this client will be lost.** This _does not_ uninstall the Longview Client application for your Linode - you must do that manually.

OnInit
./lib/actions/deleteLongviewClient.js
OnStartup
-
OnClose
-

Attributes

-

getLongviewClient

Returns a single Longview Client you can access.

OnInit
./lib/actions/getLongviewClient.js
OnStartup
-
OnClose
-

Attributes

-

updateLongviewClient

Updates a Longview Client. This cannot update how it monitors your server; use the Longview Client application on your Linode for monitoring configuration.

OnInit
./lib/actions/updateLongviewClient.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_longview_clients__clientId_

OnInit
./lib/actions/x_linode_cli_command_longview_clients__clientId_.js
OnStartup
-
OnClose
-

Attributes

-

getLongviewSubscriptions

Returns a paginated list of available Longview Subscriptions. This is a public endpoint and requires no authentication.

OnInit
./lib/actions/getLongviewSubscriptions.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_longview_subscriptions

OnInit
./lib/actions/x_linode_cli_command_longview_subscriptions.js
OnStartup
-
OnClose
-

Attributes

-

getLongviewSubscription

Returns a single LongviewSubscription object. This is a public endpoint and requires no authentication.

OnInit
./lib/actions/getLongviewSubscription.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_longview_subscriptions__subscriptionId_

OnInit
./lib/actions/x_linode_cli_command_longview_subscriptions__subscriptionId_.js
OnStartup
-
OnClose
-

Attributes

-

getManagedContacts

Returns a paginated list of Managed Contacts on your Account.

OnInit
./lib/actions/getManagedContacts.js
OnStartup
-
OnClose
-

Attributes

-

createManagedContact

Creates a Managed Contact. A Managed Contact is someone Linode special forces can contact in the course of attempting to resolve an issue with a Managed Service.

OnInit
./lib/actions/createManagedContact.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_contacts

OnInit
./lib/actions/x_linode_cli_command_managed_contacts.js
OnStartup
-
OnClose
-

Attributes

-

deleteManagedContact

Deletes a Managed Contact.

OnInit
./lib/actions/deleteManagedContact.js
OnStartup
-
OnClose
-

Attributes

-

getManagedContact

Returns a single Managed Contact.

OnInit
./lib/actions/getManagedContact.js
OnStartup
-
OnClose
-

Attributes

-

updateManagedContact

Updates information about a Managed Contact.

OnInit
./lib/actions/updateManagedContact.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_contacts__contactId_

OnInit
./lib/actions/x_linode_cli_command_managed_contacts__contactId_.js
OnStartup
-
OnClose
-

Attributes

-

getManagedCredentials

Returns a paginated list of Managed Credentials on your Account.

OnInit
./lib/actions/getManagedCredentials.js
OnStartup
-
OnClose
-

Attributes

-

createManagedCredential

Creates a Managed Credential. A Managed Credential is stored securely to allow Linode special forces to access your Managed Services and resolve issues.

OnInit
./lib/actions/createManagedCredential.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_credentials

OnInit
./lib/actions/x_linode_cli_command_managed_credentials.js
OnStartup
-
OnClose
-

Attributes

-

getManagedCredential

Returns a single Managed Credential.

OnInit
./lib/actions/getManagedCredential.js
OnStartup
-
OnClose
-

Attributes

-

updateManagedCredential

Updates information about a Managed Credential.

OnInit
./lib/actions/updateManagedCredential.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_credentials__credentialId_

OnInit
./lib/actions/x_linode_cli_command_managed_credentials__credentialId_.js
OnStartup
-
OnClose
-

Attributes

-

deleteManagedCredential

Deletes a Managed Credential. Linode special forces will no longer have access to this Credential when attempting to resolve issues.

OnInit
./lib/actions/deleteManagedCredential.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_credentials__credentialId__revoke

OnInit
./lib/actions/x_linode_cli_command_managed_credentials__credentialId__revoke.js
OnStartup
-
OnClose
-

Attributes

-

getManagedIssues

Returns a paginated list of recent and ongoing issues detected on your Managed Services.

OnInit
./lib/actions/getManagedIssues.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_issues

OnInit
./lib/actions/x_linode_cli_command_managed_issues.js
OnStartup
-
OnClose
-

Attributes

-

getManagedIssue

Returns a single Issue that is impacting or did impact one of your Managed Services.

OnInit
./lib/actions/getManagedIssue.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_issues__issueId_

OnInit
./lib/actions/x_linode_cli_command_managed_issues__issueId_.js
OnStartup
-
OnClose
-

Attributes

-

getManagedLinodeSettings

Returns a paginated list of Managed Settings for your Linodes. There will be one entry per Linode on your Account.

OnInit
./lib/actions/getManagedLinodeSettings.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_linode_settings

OnInit
./lib/actions/x_linode_cli_command_managed_linode_settings.js
OnStartup
-
OnClose
-

Attributes

-

getManagedLinodeSetting

Returns a single Linode's Managed settings.

OnInit
./lib/actions/getManagedLinodeSetting.js
OnStartup
-
OnClose
-

Attributes

-

updateManagedLinodeSetting

Updates a single Linode's Managed settings.

OnInit
./lib/actions/updateManagedLinodeSetting.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_linode_settings__linodeId_

OnInit
./lib/actions/x_linode_cli_command_managed_linode_settings__linodeId_.js
OnStartup
-
OnClose
-

Attributes

-

getManagedServices

Returns a paginated list of Managed Services on your Account. These are the services Linode Managed is monitoring and will report and attempt to resolve issues with.

OnInit
./lib/actions/getManagedServices.js
OnStartup
-
OnClose
-

Attributes

-

createManagedService

Creates a Managed Service. Linode Managed will being monitoring this service and reporting and attempting to resolve any Issues.

OnInit
./lib/actions/createManagedService.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_services

OnInit
./lib/actions/x_linode_cli_command_managed_services.js
OnStartup
-
OnClose
-

Attributes

-

deleteManagedService

Deletes a Managed Service. This service will no longer be monitored by Linode Managed.

OnInit
./lib/actions/deleteManagedService.js
OnStartup
-
OnClose
-

Attributes

-

getManagedService

Returns information about a single Managed Service on your Account.

OnInit
./lib/actions/getManagedService.js
OnStartup
-
OnClose
-

Attributes

-

updateManagedService

Updates information about a Managed Service.

OnInit
./lib/actions/updateManagedService.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_services__serviceId_

OnInit
./lib/actions/x_linode_cli_command_managed_services__serviceId_.js
OnStartup
-
OnClose
-

Attributes

-

disableManagedService

Temporarily disables monitoring of a Managed Service.

OnInit
./lib/actions/disableManagedService.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_services__serviceId__disable

OnInit
./lib/actions/x_linode_cli_command_managed_services__serviceId__disable.js
OnStartup
-
OnClose
-

Attributes

-

enableManagedService

Enables monitoring of a Managed Service.

OnInit
./lib/actions/enableManagedService.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_managed_services__serviceId__enable

OnInit
./lib/actions/x_linode_cli_command_managed_services__serviceId__enable.js
OnStartup
-
OnClose
-

Attributes

-

description_networking_ips

OnInit
./lib/actions/description_networking_ips.js
OnStartup
-
OnClose
-

Attributes

-

getIPs

Returns a paginated list of IP Addresses on your Account, excluding private addresses.

OnInit
./lib/actions/getIPs.js
OnStartup
-
OnClose
-

Attributes

-

allocateIP

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

OnInit
./lib/actions/allocateIP.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_networking_ips

OnInit
./lib/actions/x_linode_cli_command_networking_ips.js
OnStartup
-
OnClose
-

Attributes

-

getIP

Returns information about a single IP Address on your Account.

OnInit
./lib/actions/getIP.js
OnStartup
-
OnClose
-

Attributes

-

updateIP

Sets 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 be reset to the default _members.linode.com_ RDNS value.

OnInit
./lib/actions/updateIP.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_networking_ips__address_

OnInit
./lib/actions/x_linode_cli_command_networking_ips__address_.js
OnStartup
-
OnClose
-

Attributes

-

description_networking_ipv4_assign

OnInit
./lib/actions/description_networking_ipv4_assign.js
OnStartup
-
OnClose
-

Attributes

-

assignIPs

Assign multiple IPs to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPv4 Addresses to your Linodes. When the assignment is finished, all Linodes must end up with at least one public IPv4 and no more than one private IPv4.

OnInit
./lib/actions/assignIPs.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_networking_ipv4_assign

OnInit
./lib/actions/x_linode_cli_command_networking_ipv4_assign.js
OnStartup
-
OnClose
-

Attributes

-

description_networking_ipv4_share

OnInit
./lib/actions/description_networking_ipv4_share.js
OnStartup
-
OnClose
-

Attributes

-

shareIPs

Configure shared IPs. A shared IP may be brought up on a Linode other than the one it lists in its response. This can be used to allow one Linode to begin serving requests should another become unresponsive.

OnInit
./lib/actions/shareIPs.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_networking_ipv4_share

OnInit
./lib/actions/x_linode_cli_command_networking_ipv4_share.js
OnStartup
-
OnClose
-

Attributes

-

getIPv6Pools

Displays the IPv6 pools on your Account.

OnInit
./lib/actions/getIPv6Pools.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_networking_ipv6_pools

OnInit
./lib/actions/x_linode_cli_command_networking_ipv6_pools.js
OnStartup
-
OnClose
-

Attributes

-

getIPv6Ranges

Displays the IPv6 ranges on your Account.

OnInit
./lib/actions/getIPv6Ranges.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_networking_ipv6_ranges

OnInit
./lib/actions/x_linode_cli_command_networking_ipv6_ranges.js
OnStartup
-
OnClose
-

Attributes

-

getNodeBalancers

Returns a paginated list of NodeBalancers you have access to.

OnInit
./lib/actions/getNodeBalancers.js
OnStartup
-
OnClose
-

Attributes

-

createNodeBalancer

Creates a NodeBalancer in the requested Region. This NodeBalancer will not start serving requests until it is configured.

OnInit
./lib/actions/createNodeBalancer.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_nodebalancers

OnInit
./lib/actions/x_linode_cli_command_nodebalancers.js
OnStartup
-
OnClose
-

Attributes

-

deleteNodeBalancer

Deletes a NodeBalancer. **This is a destructive action and cannot be undone.** Deleting a NodeBalancer will also delete all associated Configs and Nodes, although the backend servers represented by the Nodes will not be changed or removed. Deleting a NodeBalancer will cause you to lose access to the IP Addresses assigned to this NodeBalancer.

OnInit
./lib/actions/deleteNodeBalancer.js
OnStartup
-
OnClose
-

Attributes

-

getNodeBalancer

Returns a single NodeBalancer you can access.

OnInit
./lib/actions/getNodeBalancer.js
OnStartup
-
OnClose
-

Attributes

-

updateNodeBalancer

Updates information about a NodeBalancer you can access.

OnInit
./lib/actions/updateNodeBalancer.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_nodebalancers__nodeBalancerId_

OnInit
./lib/actions/x_linode_cli_command_nodebalancers__nodeBalancerId_.js
OnStartup
-
OnClose
-

Attributes

-

getNodeBalancerConfigs

Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer will accept traffic on, one Config per port. For example, if you wanted to accept standard HTTP traffic, you would need a Config listening on port 80.

OnInit
./lib/actions/getNodeBalancerConfigs.js
OnStartup
-
OnClose
-

Attributes

-

createNodeBalancerConfig

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

OnInit
./lib/actions/createNodeBalancerConfig.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_nodebalancers__nodeBalancerId__configs

OnInit
./lib/actions/x_linode_cli_command_nodebalancers__nodeBalancerId__configs.js
OnStartup
-
OnClose
-

Attributes

-

deleteNodeBalancerConfig

Deletes 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 port. This also deletes all associated NodeBalancerNodes, but the Linodes they were routing traffic to will be unchanged and will not be removed.

OnInit
./lib/actions/deleteNodeBalancerConfig.js
OnStartup
-
OnClose
-

Attributes

-

getNodeBalancerConfig

Returns configuration information for a single port of this NodeBalancer.

OnInit
./lib/actions/getNodeBalancerConfig.js
OnStartup
-
OnClose
-

Attributes

-

updateNodeBalancerConfig

Updates the configuration for a single port on a NodeBalancer.

OnInit
./lib/actions/updateNodeBalancerConfig.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_nodebalancers__nodeBalancerId__configs__configId_

OnInit
./lib/actions/x_linode_cli_command_nodebalancers__nodeBalancerId__configs__configId_.js
OnStartup
-
OnClose
-

Attributes

-

getNodeBalancerConfigNodes

Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic for this port.

OnInit
./lib/actions/getNodeBalancerConfigNodes.js
OnStartup
-
OnClose
-

Attributes

-

createNodeBalancerNode

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

OnInit
./lib/actions/createNodeBalancerNode.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_nodebalancers__nodeBalancerId__configs__configId__nodes

OnInit
./lib/actions/x_linode_cli_command_nodebalancers__nodeBalancerId__configs__configId__nodes.js
OnStartup
-
OnClose
-

Attributes

-

deleteNodeBalancerConfigNode

Deletes 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 Linode whose address was used in the creation of this Node.

OnInit
./lib/actions/deleteNodeBalancerConfigNode.js
OnStartup
-
OnClose
-

Attributes

-

getNodeBalancerNode

Returns information about a single Node, a backend for this NodeBalancer's configured port.

OnInit
./lib/actions/getNodeBalancerNode.js
OnStartup
-
OnClose
-

Attributes

-

updateNodeBalancerNode

Updates information about a Node, a backend for this NodeBalancer's configured port.

OnInit
./lib/actions/updateNodeBalancerNode.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_nodebalancers__nodeBalancerId__configs__configId__nodes__nodeId_

OnInit
./lib/actions/x_linode_cli_command_nodebalancers__nodeBalancerId__configs__configId__nodes__nodeId_.js
OnStartup
-
OnClose
-

Attributes

-

rebuildNodeBalancerConfig

Rebuilds a NodeBalancer Config and its Nodes that you have permission to modify.

OnInit
./lib/actions/rebuildNodeBalancerConfig.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_nodebalancers__nodeBalancerId__configs__configId__rebuild

OnInit
./lib/actions/x_linode_cli_command_nodebalancers__nodeBalancerId__configs__configId__rebuild.js
OnStartup
-
OnClose
-

Attributes

-

get_nodebalancers__nodeBalancerId__stats

Returns detailed statistics about the requested NodeBalancer.

OnInit
./lib/actions/get_nodebalancers__nodeBalancerId__stats.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_nodebalancers__nodeBalancerId__stats

OnInit
./lib/actions/x_linode_cli_command_nodebalancers__nodeBalancerId__stats.js
OnStartup
-
OnClose
-

Attributes

-

getProfile

Returns 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 third-party OAuth applications. This endpoint is always accessible, no matter what OAuth scopes the acting token has.

OnInit
./lib/actions/getProfile.js
OnStartup
-
OnClose
-

Attributes

-

updateProfile

Update information in your Profile. This endpoint requires the "account:read_write" OAuth Scope.

OnInit
./lib/actions/updateProfile.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile

OnInit
./lib/actions/x_linode_cli_command_profile.js
OnStartup
-
OnClose
-

Attributes

-

description_profile_apps

OnInit
./lib/actions/description_profile_apps.js
OnStartup
-
OnClose
-

Attributes

-

getProfileApps

This is a collection of OAuth apps that you've given access to your Account, and includes the level of access granted.

OnInit
./lib/actions/getProfileApps.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_apps

OnInit
./lib/actions/x_linode_cli_command_profile_apps.js
OnStartup
-
OnClose
-

Attributes

-

deleteProfileApp

Expires this app token. This token may no longer be used to access your Account.

OnInit
./lib/actions/deleteProfileApp.js
OnStartup
-
OnClose
-

Attributes

-

getProfileApp

Returns information about a single app you've authorized to access your Account.

OnInit
./lib/actions/getProfileApp.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_apps__appId_

OnInit
./lib/actions/x_linode_cli_command_profile_apps__appId_.js
OnStartup
-
OnClose
-

Attributes

-

description_profile_devices

OnInit
./lib/actions/description_profile_devices.js
OnStartup
-
OnClose
-

Attributes

-

getDevices

Returns a paginated list of active TrustedDevices for your User. Browsers with an active Remember Me Session are logged into your account until the session expires or is revoked.

OnInit
./lib/actions/getDevices.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_devices

OnInit
./lib/actions/x_linode_cli_command_profile_devices.js
OnStartup
-
OnClose
-

Attributes

-

revokeTrustedDevice

Revoke an active TrustedDevice for your User. Once a TrustedDevice is revoked, this device will have to log in again before accessing your Linode account.

OnInit
./lib/actions/revokeTrustedDevice.js
OnStartup
-
OnClose
-

Attributes

-

description_profile_devices__deviceId_

OnInit
./lib/actions/description_profile_devices__deviceId_.js
OnStartup
-
OnClose
-

Attributes

-

getTrustedDevice

Returns a single active TrustedDevice for your User.

OnInit
./lib/actions/getTrustedDevice.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_devices__deviceId_

OnInit
./lib/actions/x_linode_cli_command_profile_devices__deviceId_.js
OnStartup
-
OnClose
-

Attributes

-

getProfileGrants

This 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 unrestricted users have access to everything without grants. This will not return information about entities you do not have access to. This endpoint is useful when writing third-party OAuth applications to see what options you should present to the acting User. For example, if they do not have `global.add_linodes`, you might not display a button to deploy a new Linode. Any client may access this endpoint; no OAuth scopes are required.

OnInit
./lib/actions/getProfileGrants.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_grants

OnInit
./lib/actions/x_linode_cli_command_profile_grants.js
OnStartup
-
OnClose
-

Attributes

-

description_profile_sshkeys

OnInit
./lib/actions/description_profile_sshkeys.js
OnStartup
-
OnClose
-

Attributes

-

getSSHKeys

Returns a collection of SSH Keys you've added to your Profile.

OnInit
./lib/actions/getSSHKeys.js
OnStartup
-
OnClose
-

Attributes

-

addSSHKey

Adds an SSH Key to your Account profile.

OnInit
./lib/actions/addSSHKey.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_sshkeys

OnInit
./lib/actions/x_linode_cli_command_profile_sshkeys.js
OnStartup
-
OnClose
-

Attributes

-

deleteSSHKey

Deletes an SSH Key you have access to. **Note:** deleting an SSH Key will *not* remove it from any Linode or Disk that was deployed with `authorized_keys`. In those cases, the keys must be manually deleted on the Linode or Disk. This endpoint will only delete the key's association from your Profile.

OnInit
./lib/actions/deleteSSHKey.js
OnStartup
-
OnClose
-

Attributes

-

getSSHKey

Returns a single SSH Key object identified by `id` that you have access to view.

OnInit
./lib/actions/getSSHKey.js
OnStartup
-
OnClose
-

Attributes

-

updateSSHKey

Updates an SSH Key that you have permission to `read_write`.

OnInit
./lib/actions/updateSSHKey.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_sshkeys__sshKeyId_

OnInit
./lib/actions/x_linode_cli_command_profile_sshkeys__sshKeyId_.js
OnStartup
-
OnClose
-

Attributes

-

tfaDisable

Disables Two Factor Authentication for your User. Once successful, login attempts from untrusted computers will only require a password before being successful. This is less secure, and is discouraged.

OnInit
./lib/actions/tfaDisable.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_tfa_disable

OnInit
./lib/actions/x_linode_cli_command_profile_tfa_disable.js
OnStartup
-
OnClose
-

Attributes

-

tfaEnable

Generates a Two Factor secret for your User. TFA will not be enabled until you have successfully confirmed the code you were given with [tfa-enable-confirm](#operation/tfaConfirm) (see below). Once enabled, logins from untrusted computers will be required to provide a TFA code before they are successful.

OnInit
./lib/actions/tfaEnable.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_tfa_enable

OnInit
./lib/actions/x_linode_cli_command_profile_tfa_enable.js
OnStartup
-
OnClose
-

Attributes

-

tfaConfirm

Confirms that you can successfully generate Two Factor codes and enables TFA on your Account. Once this is complete, login attempts from untrusted computers will be required to provide a Two Factor code before they are successful.

OnInit
./lib/actions/tfaConfirm.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_tfa_enable_confirm

OnInit
./lib/actions/x_linode_cli_command_profile_tfa_enable_confirm.js
OnStartup
-
OnClose
-

Attributes

-

description_profile_tokens

OnInit
./lib/actions/description_profile_tokens.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalAccessTokens

Returns a paginated list of Personal Access Tokens currently active for your User.

OnInit
./lib/actions/getPersonalAccessTokens.js
OnStartup
-
OnClose
-

Attributes

-

createPersonalAccessToken

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

OnInit
./lib/actions/createPersonalAccessToken.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_tokens

OnInit
./lib/actions/x_linode_cli_command_profile_tokens.js
OnStartup
-
OnClose
-

Attributes

-

deletePersonalAccessToken

Revokes a Personal Access Token. The token will be invalidated immediately, and requests using that token will fail with a 401. It is possible to revoke access to the token making the request to revoke a token, but keep in mind that doing so could lose you access to the api and require you to create a new token through some other means.

OnInit
./lib/actions/deletePersonalAccessToken.js
OnStartup
-
OnClose
-

Attributes

-

description_profile_tokens__tokenId_

OnInit
./lib/actions/description_profile_tokens__tokenId_.js
OnStartup
-
OnClose
-

Attributes

-

getPersonalAccessToken

Returns a single Personal Access Token.

OnInit
./lib/actions/getPersonalAccessToken.js
OnStartup
-
OnClose
-

Attributes

-

updatePersonalAccessToken

Updates a Personal Access Token.

OnInit
./lib/actions/updatePersonalAccessToken.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_profile_tokens__tokenId_

OnInit
./lib/actions/x_linode_cli_command_profile_tokens__tokenId_.js
OnStartup
-
OnClose
-

Attributes

-

getRegions

Lists the Regions available for Linode services. Not all services are guaranteed to be available in all Regions.

OnInit
./lib/actions/getRegions.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_regions

OnInit
./lib/actions/x_linode_cli_command_regions.js
OnStartup
-
OnClose
-

Attributes

-

getRegion

Returns a single Region.

OnInit
./lib/actions/getRegion.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_regions__regionId_

OnInit
./lib/actions/x_linode_cli_command_regions__regionId_.js
OnStartup
-
OnClose
-

Attributes

-

getTickets

Returns a collection of Support Tickets on your Account. Support Tickets can be both tickets you open with Linode for support, as well as tickets generated by Linode regarding your Account. This collection includes all Support Tickets generated on your Account, with open tickets returned first.

OnInit
./lib/actions/getTickets.js
OnStartup
-
OnClose
-

Attributes

-

createTicket

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

OnInit
./lib/actions/createTicket.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_support_tickets

OnInit
./lib/actions/x_linode_cli_command_support_tickets.js
OnStartup
-
OnClose
-

Attributes

-

getTicket

Returns a Support Ticket under your Account.

OnInit
./lib/actions/getTicket.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_support_tickets__ticketId_

OnInit
./lib/actions/x_linode_cli_command_support_tickets__ticketId_.js
OnStartup
-
OnClose
-

Attributes

-

createTicketAttachment

Adds a file attachment to an existing Support Ticket on your Account. File attachments are used to assist our Support team in resolving your Ticket. Examples of attachments are screen shots and text files that provide additional information. Note: Accepted file extensions include: .gif, .jpg, .jpeg, .pjpg, .pjpeg, .tif, .tiff, .png, .pdf, or .txt.

OnInit
./lib/actions/createTicketAttachment.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_support_tickets__ticketId__attachments

OnInit
./lib/actions/x_linode_cli_command_support_tickets__ticketId__attachments.js
OnStartup
-
OnClose
-

Attributes

-

closeTicket

Closes a Support Ticket you have access to modify.

OnInit
./lib/actions/closeTicket.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_support_tickets__ticketId__close

OnInit
./lib/actions/x_linode_cli_command_support_tickets__ticketId__close.js
OnStartup
-
OnClose
-

Attributes

-

getTicketReplies

Returns a collection of replies to a Support Ticket on your Account.

OnInit
./lib/actions/getTicketReplies.js
OnStartup
-
OnClose
-

Attributes

-

createTicketReply

Adds a reply to an existing Support Ticket.

OnInit
./lib/actions/createTicketReply.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_support_tickets__ticketId__replies

OnInit
./lib/actions/x_linode_cli_command_support_tickets__ticketId__replies.js
OnStartup
-
OnClose
-

Attributes

-

getTags

Tags are User-defined labels attached to objects in your Account, such as Linodes. They are used for specifying and grouping attributes of objects that are relevant to the User. This endpoint returns a paginated list of Tags on your account.

OnInit
./lib/actions/getTags.js
OnStartup
-
OnClose
-

Attributes

-

createTag

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

OnInit
./lib/actions/createTag.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_tags

OnInit
./lib/actions/x_linode_cli_command_tags.js
OnStartup
-
OnClose
-

Attributes

-

deleteTag

Remove a Tag from all objects and delete it. **Important**: You must be an unrestricted User in order to add or modify Tags.

OnInit
./lib/actions/deleteTag.js
OnStartup
-
OnClose
-

Attributes

-

getTaggedObjects

Returns a paginated list of all objects you've tagged with the requested Tag. This is a mixed collection of all object types.

OnInit
./lib/actions/getTaggedObjects.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_tags__label_

OnInit
./lib/actions/x_linode_cli_command_tags__label_.js
OnStartup
-
OnClose
-

Attributes

-

getVolumes

Returns a paginated list of Volumes you have permission to view.

OnInit
./lib/actions/getVolumes.js
OnStartup
-
OnClose
-

Attributes

-

createVolume

Creates a Volume on your Account. In order for this to complete successfully, your User must have the `add_volumes` grant. Creating a new Volume will start accruing additional charges on your account.

OnInit
./lib/actions/createVolume.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_volumes

OnInit
./lib/actions/x_linode_cli_command_volumes.js
OnStartup
-
OnClose
-

Attributes

-

deleteVolume

Deletes a Volume you have permission to `read_write`. **Deleting a Volume is a destructive action and cannot be undone.** Deleting stops billing for the Volume. You will be billed for time used within the billing period the Volume was active.

OnInit
./lib/actions/deleteVolume.js
OnStartup
-
OnClose
-

Attributes

-

getVolume

Get information about a single Volume.

OnInit
./lib/actions/getVolume.js
OnStartup
-
OnClose
-

Attributes

-

updateVolume

Updates a Volume that you have permission to `read_write`.

OnInit
./lib/actions/updateVolume.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_volumes__volumeId_

OnInit
./lib/actions/x_linode_cli_command_volumes__volumeId_.js
OnStartup
-
OnClose
-

Attributes

-

attachVolume

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

OnInit
./lib/actions/attachVolume.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_volumes__volumeId__attach

OnInit
./lib/actions/x_linode_cli_command_volumes__volumeId__attach.js
OnStartup
-
OnClose
-

Attributes

-

cloneVolume

Creates a Volume on your Account. In order for this request to complete successfully, your User must have the `add_volumes` grant. The new Volume will have the same size and data as the source Volume. Creating a new Volume will incur a charge on your Account.

OnInit
./lib/actions/cloneVolume.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_volumes__volumeId__clone

OnInit
./lib/actions/x_linode_cli_command_volumes__volumeId__clone.js
OnStartup
-
OnClose
-

Attributes

-

detachVolume

Detaches a Volume on your Account from a Linode on your Account. In order for this request to complete successfully, your User must have `read_write` access to the Volume and `read_write` access to the Linode.

OnInit
./lib/actions/detachVolume.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_volumes__volumeId__detach

OnInit
./lib/actions/x_linode_cli_command_volumes__volumeId__detach.js
OnStartup
-
OnClose
-

Attributes

-

resizeVolume

Resize an existing Volume on your Account. In order for this request to complete successfully, your User must have the `read_write` permissions to the Volume. * Volumes can only be resized up.

OnInit
./lib/actions/resizeVolume.js
OnStartup
-
OnClose
-

Attributes

-

x_linode_cli_command_volumes__volumeId__resize

OnInit
./lib/actions/x_linode_cli_command_volumes__volumeId__resize.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

OAUTH_CLIENT_ID

OAuth Client ID

type
-
required
-
example
-

OAUTH_CLIENT_SECRET

OAuth Client Secret

type
-
required
-
example
-