Account v4.176.0

Account View

GET https://api.linode.com/v4/account

Returns the contact and billing information related to your Account.

Authorizations

personalAccessToken
oauthaccount:read_only

Request Samples

Response Samples

Responses

Account Update

PUT https://api.linode.com/v4/account

Updates contact and billing information related to your account. If you exclude any properties from the request, the operation leaves them unchanged.

Note: When updating an account’s country to “US”, you’ll get an error if the account’s zip is not a valid US zip code.

Parent and child accounts

In a parent and child account environment, the following apply:

  • You can’t change the company for a parent account. Akamai uses this value to set the name for a child account parent user (proxy user) on any child account.

  • Child account users can’t run this operation. These users don’t have access to billing-related operations.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

address_1
string <= 64 characters

First line of this Account’s billing address.

address_2
string <= 64 characters

Second line of this Account’s billing address.

city
string <= 24 characters

The city for this Account’s billing address.

company
string <= 128 characters

The company name associated with this Account.

Must not include any of the following characters: < > ( ) " =

country
string

The two-letter ISO 3166 country code of this Account’s billing address.

email
string <= 128 characters

The email address of the person associated with this Account.

first_name
string <= 50 characters

The first name of the person associated with this Account.

Must not include any of the following characters: < > ( ) " =

last_name
string <= 50 characters

The last name of the person associated with this Account.

Must not include any of the following characters: < > ( ) " =

phone
string <= 32 characters

The phone number associated with this Account.

state
string <= 24 characters

If billing address is in the United States (US) or Canada (CA), only the two-letter ISO 3166 State or Province code are accepted. If entering a US military address, state abbreviations (AA, AE, AP) should be entered. If the address is outside the US or CA, this is the Province associated with the Account’s billing address.

tax_id
string <= 25 characters

The tax identification number associated with this Account, for tax calculations in some countries. If you do not live in a country that collects tax, this should be an empty string ("").

zip
string

The zip code of this Account’s billing address. The following restrictions apply:

  • Can only contain ASCII letters, numbers, and hyphens (-).
  • Must not contain more than 9 letter or number characters.

Response Samples

Responses

Account Availability

GET https://api.linode.com/v4/account/availability

Returns a paginated list of the services available to you, for all Linode regions.

Note: Only authorized Users can access this endpoint.

Authorizations

personalAccessToken
oauthaccount:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Region Service Availability

GET https://api.linode.com/v4/account/availability/{id}

View the available services for your account in a specific region.

Note: Only authorized users can access this.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

idstring
Required

The slug for the applicable data center. Run the GET /regions operation to view the slug for each data center.

Request Samples

Response Samples

Responses

Account Cancel

POST https://api.linode.com/v4/account/cancel

Cancels an active Linode account. Akamai attempts to charge the credit card on file for any remaining balance. An error occurs if this charge fails. Note: This command can only be accessed by account users with unrestricted access. Parent and child accounts In a parent and child account environment, the following apply:

  • A child account user can’t cancel a child account.
  • You can’t cancel a parent account if it has an active child account.
  • You need to work with your Akamai account team to dissolve any parent-child account relationships before you can fully cancel a child or parent account.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

comments
string

Any reason for cancelling the account, and any other comments you might have about your Linode service.

Response Samples

Responses

Child Account List

GET https://api.linode.com/v4/account/child-accounts

Returns a paginated list of basic information for the child accounts that exist for your parent account. See Parent and Child Accounts for Akamai Partners for details on these accounts.

Note: This command can only be accessed by an unrestricted parent user, or restricted parent user with the child_account_access grant.

Authorizations

personalAccessToken
oauthchild_account:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Child Account View

GET https://api.linode.com/v4/account/child-accounts/{euuid}

View a specific child account based on its euuid. See Parent and Child Accounts for Akamai Partners for details on these accounts. Note: This command can only be accessed by an unrestricted user, or restricted user with the child_account_access grant.

Authorizations

personalAccessToken
oauthchild_account:read_only

Path Parameters

euuidstring
Required

The child account to look up. You can run the Child Account List operation to find the applicable account and store its euuid.

Request Samples

Response Samples

Responses

Proxy User Token Create

POST https://api.linode.com/v4/account/child-accounts/{euuid}/token

Create a short-lived bearer token for a parent user on a child account, using the euuid of that child account. In the context of the API, a parent user on a child account is referred to as a “proxy user.” When Akamai provisions your parent-child account environment, a proxy user is automatically set in the child account. It follows a specific naming convention:

<Parent account company name>_<SHA256 hash of parent company name and child account euuid>

Note: The variables above use only the first 15 and 16 characters of these values, respectively.

The token lets a parent account run API operations through the proxy user, as if they are a child user in the child account.

These points apply to the use of this operation:

  • To create a token, a parent account user needs the child_account_access grant. This lets them use the proxy user on the child account. You can view a parent account user to check its child_account_access setting. To add this access, you can update the parent account user.

  • The created token inherits the permissions of the proxy user. It will never have less.

  • The API returns the raw token in the response. You can’t get it again, so be sure to store it.

Example workflow:

  1. List child accounts and store the euuid for the applicable one.
  2. Run this operation and store the token that’s created for the proxy user.
  3. As a parent account user with access to the proxy user in the child account, use this token to authenticate API operations, as if you were a child user.

Authorizations

personalAccessToken
oauthchild_account:read_write

Path Parameters

euuidstring
Required

The child account to look up. You can run the Child Account List operation to find the applicable account and store its euuid.

Request Samples

Response Samples

Responses

Credit Card Add/Edit

POST https://api.linode.com/v4/account/credit-card

DEPRECATED. Please use Payment Method Add ( POST /account/payment-methods).

Adds a credit card Payment Method to your account and sets it as the default method.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

card_number
Required
string<digits> 14..24 characters

Your credit card number. No spaces or hyphens (-) allowed.

cvv
Required
string<digits> 3..4 characters

CVV (Card Verification Value) of the credit card, typically found on the back of the card.

expiry_month
Required
integer 1..12

A value from 1-12 representing the expiration month of your credit card.

  • 1 = January
  • 2 = February
  • 3 = March
  • Etc.

expiry_year
Required
integer 4..4 characters

A four-digit integer representing the expiration year of your credit card.

The combination of expiry_month and expiry_year must result in a month/year combination of the current month or in the future. An expiration date set in the past is invalid.

Response Samples

Responses

Entity Transfers List

GET https://api.linode.com/v4/account/entity-transfers

DEPRECATED. Please use Service Transfers List.

Authorizations

personalAccessToken
oauthaccount:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Entity Transfer Create

POST https://api.linode.com/v4/account/entity-transfers

DEPRECATED. Please use Service Transfer Create.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

entities
Required
object

A collection of the entities to include in this transfer request, separated by type.

linodes
array of integers

An array containing the IDs of each of the Linodes included in this transfer.

Response Samples

Responses

Entity Transfer Cancel

DELETE https://api.linode.com/v4/account/entity-transfers/{token}

DEPRECATED. Please use Service Transfer Cancel.

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

tokenstring<uuid>
Required

The UUID of the Entity Transfer.

Request Samples

Response Samples

Responses

Entity Transfer View

GET https://api.linode.com/v4/account/entity-transfers/{token}

DEPRECATED. Please use Service Transfer View.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

tokenstring<uuid>
Required

The UUID of the Entity Transfer.

Request Samples

Response Samples

Responses

Entity Transfer Accept

POST https://api.linode.com/v4/account/entity-transfers/{token}/accept

DEPRECATED. Please use Service Transfer Accept.

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

tokenstring<uuid>
Required

The UUID of the Entity Transfer.

Request Samples

Response Samples

Responses

Events List

GET https://api.linode.com/v4/account/events

Returns a collection of Event objects representing actions taken on your Account from the last 90 days. The Events returned depend on your grants.

Authorizations

personalAccessToken
oauthevents:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Event View

GET https://api.linode.com/v4/account/events/{eventId}

Returns a single Event object.

Authorizations

personalAccessToken
oauthevents:read_only

Path Parameters

eventIdinteger
Required

The ID of the Event.

Request Samples

Response Samples

Responses

Event Mark as Read

POST https://api.linode.com/v4/account/events/{eventId}/read

Marks a single Event as read.

Authorizations

personalAccessToken
oauthevents:read_only

Path Parameters

eventIdinteger
Required

The ID of the Event to designate as read.

Request Samples

Response Samples

Responses

Event Mark as Seen

POST https://api.linode.com/v4/account/events/{eventId}/seen

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

Authorizations

personalAccessToken
oauthevents:read_only

Path Parameters

eventIdinteger
Required

The ID of the Event to designate as seen.

Request Samples

Response Samples

Responses

Invoices List

GET https://api.linode.com/v4/account/invoices

Returns a paginated list of Invoices against your Account.

Authorizations

personalAccessToken
oauthaccount:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Invoice View

GET https://api.linode.com/v4/account/invoices/{invoiceId}

Returns a single Invoice object.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

invoiceIdinteger
Required

The ID of the Invoice.

Request Samples

Response Samples

Responses

Invoice Items List

GET https://api.linode.com/v4/account/invoices/{invoiceId}/items

Returns a paginated list of Invoice items.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

invoiceIdinteger
Required

The ID of the Invoice.

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

User Logins List All

GET https://api.linode.com/v4/account/logins

Returns 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 an account.

Authorizations

personalAccessToken
oauthaccount:read_only

Request Samples

Response Samples

Responses

Login View

GET https://api.linode.com/v4/account/logins/{loginId}

Returns 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 limited to only the logins of the user that is accessing this API endpoint. This command can only be accessed by the unrestricted users of the account.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

loginIdinteger
Required

The ID of the login object to access.

Request Samples

Response Samples

Responses

Maintenance List

GET https://api.linode.com/v4/account/maintenance

Returns a collection of Maintenance objects for any entity a user has permissions to view. Canceled Maintenance objects are not returned.

Currently, Linodes are the only entities available for viewing.

Authorizations

personalAccessToken
oauth

Request Samples

Response Samples

Responses

Notifications List

GET https://api.linode.com/v4/account/notifications

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.

Authorizations

personalAccessToken
oauthaccount:read_only

Request Samples

Response Samples

Responses

OAuth Clients List

GET https://api.linode.com/v4/account/oauth-clients

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.

Authorizations

personalAccessToken
oauthaccount:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

OAuth Client Create

POST https://api.linode.com/v4/account/oauth-clients

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.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

label
Required
string 1..512 characters

The name of this application. This will be presented to users when they are asked to grant it access to their Account.

public
boolean
Default: false

If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the OAuth spec for more details.

redirect_uri
Required
string<url>

The location a successful log in from https://login.linode.com should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.

Response Samples

Responses

OAuth Client Delete

DELETE https://api.linode.com/v4/account/oauth-clients/{clientId}

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

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

clientIdstring
Required

The OAuth Client ID to look up.

Request Samples

Response Samples

Responses

OAuth Client View

GET https://api.linode.com/v4/account/oauth-clients/{clientId}

Returns information about a single OAuth client.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

clientIdstring
Required

The OAuth Client ID to look up.

Request Samples

Response Samples

Responses

OAuth Client Update

PUT https://api.linode.com/v4/account/oauth-clients/{clientId}

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.

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

clientIdstring
Required

The OAuth Client ID to look up.

Request Samples

Request Body Schema

label
string 1..512 characters

The name of this application. This will be presented to users when they are asked to grant it access to their Account.

public
boolean
Default: false

If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the OAuth spec for more details.

redirect_uri
string<url>

The location a successful log in from https://login.linode.com should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.

Response Samples

Responses

OAuth Client Secret Reset

POST https://api.linode.com/v4/account/oauth-clients/{clientId}/reset-secret

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.

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

clientIdstring
Required

The OAuth Client ID to look up.

Request Samples

Response Samples

Responses

OAuth Client Thumbnail View

GET https://api.linode.com/v4/account/oauth-clients/{clientId}/thumbnail

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

Authorizations

Path Parameters

clientIdstring
Required

The OAuth Client ID to look up.

Request Samples

Response Samples

Responses

OAuth Client Thumbnail Update

PUT https://api.linode.com/v4/account/oauth-clients/{clientId}/thumbnail

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.

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

clientIdstring
Required

The OAuth Client ID to look up.

Request Samples

Response Samples

Responses

Payment Methods List

GET https://api.linode.com/v4/account/payment-methods

Returns a paginated list of Payment Methods for this Account.

Authorizations

personalAccessToken
oauthaccount:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Payment Method Add

POST https://api.linode.com/v4/account/payment-methods

Adds a Payment Method to your Account with the option to set it as the default method.

  • Adding a default Payment Method removes the default status from any other Payment Method.

  • An Account can have up to 6 active Payment Methods.

  • Up to 60 Payment Methods can be added each day.

  • Prior to adding a Payment Method, ensure that your billing address information is up-to-date with a valid zip by using the Account Update ( PUT /account) endpoint.

  • A payment_method_add event is generated when a payment is successfully submitted.

Parent and child accounts

In a parent and child account environment, the following apply:

  • Child account users can’t run this operation. These users don’t have access to billing-related operations.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

data
Required
object

An object representing the credit card information you have on file with Linode to make Payments against your Account.

card_number
Required
string<digits> 14..24 characters

Your credit card number. No spaces or hyphens (-) allowed.

cvv
Required
string<digits> 3..4 characters

CVV (Card Verification Value) of the credit card, typically found on the back of the card.

expiry_month
Required
integer 1..12

A value from 1-12 representing the expiration month of your credit card.

  • 1 = January
  • 2 = February
  • 3 = March
  • Etc.

expiry_year
Required
integer 4..4 characters

A four-digit integer representing the expiration year of your credit card.

The combination of expiry_month and expiry_year must result in a month/year combination of the current month or in the future. An expiration date set in the past is invalid.

is_default
Required
boolean

Whether this Payment Method is the default method for automatically processing service charges.

type
Required
string
Enum: credit_card

The type of Payment Method.

Alternative Payment Methods including Google Pay and PayPal can be added using the Cloud Manager. See the Manage Payment Methods guide for details and instructions.

Response Samples

Responses

Payment Method Delete

DELETE https://api.linode.com/v4/account/payment-methods/{paymentMethodId}

Deactivate the specified Payment Method.

The default Payment Method can not be deleted. To add a new default Payment Method, access the Payment Method Add ( POST /account/payment-methods) endpoint. To designate an existing Payment Method as the default method, access the Payment Method Make Default ( POST /account/payment-methods/{paymentMethodId}/make-default) endpoint.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

paymentMethodIdinteger
Required

The ID of the Payment Method to look up.

Request Samples

Response Samples

Responses

Payment Method View

GET https://api.linode.com/v4/account/payment-methods/{paymentMethodId}

View the details of the specified Payment Method.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

paymentMethodIdinteger
Required

The ID of the Payment Method to look up.

Request Samples

Response Samples

Responses

Payment Method Make Default

POST https://api.linode.com/v4/account/payment-methods/{paymentMethodId}/make-default

Make the specified Payment Method the default method for automatically processing payments. Removes the default status from any other Payment Method.

Parent and child accounts

In a parent and child account environment, the following apply:

  • Child account users can’t run this operation. These users don’t have access to billing-related operations.

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

paymentMethodIdinteger
Required

The ID of the Payment Method to make default.

Request Samples

Response Samples

Responses

Payments List

GET https://api.linode.com/v4/account/payments

Returns a paginated list of Payments made on this Account.

Authorizations

personalAccessToken
oauthaccount:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Payment Make

POST https://api.linode.com/v4/account/payments

Makes a Payment to your Account.

  • The requested amount is charged to the default Payment Method if no payment_method_id is specified.

  • A payment_submitted event is generated when a payment is successfully submitted.

Parent and child accounts

In a parent and child account environment, the following apply:

  • Child account users can’t run this operation. These users don’t have access to billing-related operations.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

payment_method_id
integer

The ID of the Payment Method to apply to the Payment.

usd
string

The amount in US Dollars of the Payment.

  • Can begin with or without $.
  • Commas (,) are not accepted.
  • Must end with a decimal expression, such as .00 or .99.
  • Minimum: $5.00 or the Account balance, whichever is lower.
  • Maximum: $2000.00 or the Account balance up to $50000.00, whichever is greater.

Response Samples

Responses

PayPal Payment Stage

POST https://api.linode.com/v4/account/payments/paypal

Note: This endpoint is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See Manage Payment Methods.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

cancel_url
Required
string

The URL to have PayPal redirect to when Payment is canceled.

redirect_url
Required
string

The URL to have PayPal redirect to when Payment is approved.

usd
Required
string

The payment amount in USD. Minimum accepted value of $5 USD. Maximum accepted value of $500 USD or credit card payment limit; whichever value is highest. PayPal’s maximum transaction limit is $10,000 USD.

Response Samples

Responses

Staged/Approved PayPal Payment Execute

POST https://api.linode.com/v4/account/payments/paypal/execute

Note: This endpoint is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See Manage Payment Methods.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

payer_id
Required
string

The PayerID returned by PayPal during the transaction authorization process.

payment_id
Required
string

The PaymentID returned from POST /account/payments/paypal that has been approved with PayPal.

Response Samples

Responses

Payment View

GET https://api.linode.com/v4/account/payments/{paymentId}

Returns information about a specific Payment.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

paymentIdinteger
Required

The ID of the Payment to look up.

Request Samples

Response Samples

Responses

Promo Credit Add

POST https://api.linode.com/v4/account/promo-codes

Adds an expiring Promo Credit to your account. The following restrictions apply:

  • Your account needs to be less than 90 days old.

  • You can’t already have a Promo Credit on your account.

  • The user making the request needs to be unrestricted. You can use the User Update (/docs/api/account/#user-update) operation to change a user’s restricted status.

  • The promo_code needs to be valid and unexpired.

Parent and child accounts

In a parent and child account environment, the following apply:

  • Child account users can’t run this operation. These users don’t have access to billing-related operations.

Authorizations

personalAccessToken
oauthaccount:read_only

Request Samples

Request Body Schema

promo_code
Required
string 1..32 characters

The Promo Code.

Response Samples

Responses

Service Transfers List

GET https://api.linode.com/v4/account/service-transfers

Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer.

This command can only be accessed by the unrestricted users of an account.

Authorizations

personalAccessToken
oauthaccount:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Service Transfer Create

POST https://api.linode.com/v4/account/service-transfers

Creates a transfer request for the specified services. A request can contain any of the specified service types and any number of each service type. At this time, only Linodes can be transferred.

When created successfully, a confirmation email is sent to the account that created this transfer containing a transfer token and instructions on completing the transfer.

When a transfer is accepted, the requested services are moved to the receiving account. Linode services will not experience interruptions due to the transfer process. Backups for Linodes are transferred as well.

DNS records that are associated with requested services will not be transferred or updated. Please ensure that associated DNS records have been updated or communicated to the recipient prior to the transfer.

A transfer can take up to three hours to complete once accepted. When a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account.

This command can only be accessed by the unrestricted users of an account.

There are several conditions that you need to meet to successfully create a transfer request:

  1. The account creating the transfer can’t have a past due balance or active Terms of Service violation.

  2. The service needs to be owned by the account that is creating the transfer.

  3. The service can’t be assigned to another Service Transfer that is pending or that’s been accepted and is incomplete.

  4. Linodes can’t:

    • be assigned to a NodeBalancer, Firewall, VLAN, VPC, or Managed Service.

    • have any attached Block Storage Volumes.

    • have any shared IP addresses.

    • have any assigned /56, /64, or /116 IPv6 ranges.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

entities
Required
object

A collection of the services to include in this transfer request, separated by type.

linodes
array of integers

An array containing the IDs of each of the Linodes included in this transfer.

Response Samples

Responses

Service Transfer Cancel

DELETE https://api.linode.com/v4/account/service-transfers/{token}

Cancels the Service Transfer for the provided token. Once canceled, a transfer cannot be accepted or otherwise acted on in any way. If canceled in error, the transfer must be created again.

When canceled, an email notification for the cancellation is sent to the account that created this transfer. Transfers can not be canceled if they are expired or have been accepted.

This command can only be accessed by the unrestricted users of the account that created this transfer.

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

tokenstring<uuid>
Required

The UUID of the Service Transfer.

Request Samples

Response Samples

Responses

Service Transfer View

GET https://api.linode.com/v4/account/service-transfers/{token}

Returns the details of the Service Transfer for the provided token.

While a transfer is pending, any unrestricted user of any account can access this command. After a transfer has been accepted, it can only be viewed by unrestricted users of the accounts that created and accepted the transfer. If canceled or expired, only unrestricted users of the account that created the transfer can view it.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

tokenstring<uuid>
Required

The UUID of the Service Transfer.

Request Samples

Response Samples

Responses

Service Transfer Accept

POST https://api.linode.com/v4/account/service-transfers/{token}/accept

Accept a Service Transfer for the provided token to receive the services included in the transfer to your account. At this time, only Linodes can be transferred.

When accepted, email confirmations are sent to the accounts that created and accepted the transfer. A transfer can take up to three hours to complete once accepted. Once a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account.

This command can only be accessed by the unrestricted users of the account that receives the transfer. Users of the same account that created a transfer cannot accept the transfer.

There are several conditions that must be met in order to accept a transfer request:

  1. Only transfers with a pending status can be accepted.

  2. The account accepting the transfer must have a registered payment method and must not have a past due balance or other account limitations for the services to be transferred.

  3. Both the account that created the transfer and the account that is accepting the transfer must not have any active Terms of Service violations.

  4. The service must still be owned by the account that created the transfer.

  5. Linodes must not:

    • be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service.

    • have any attached Block Storage Volumes.

    • have any shared IP addresses.

    • have any assigned /56, /64, or /116 IPv6 ranges.

Any and all of the above conditions must be cured and maintained by the relevant account prior to the transfer’s expiration to allow the transfer to be accepted by the receiving account.

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

tokenstring<uuid>
Required

The UUID of the Service Transfer.

Request Samples

Response Samples

Responses

Account Settings View

GET https://api.linode.com/v4/account/settings

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

Authorizations

personalAccessToken
oauthaccount:read_only

Request Samples

Response Samples

Responses

Account Settings Update

PUT https://api.linode.com/v4/account/settings

Updates your account settings. For a Longview subscription plan, see Update Longview Plan.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

backups_enabled
boolean

Account-wide backups default. If true, all Linodes created will automatically be enrolled in the Backups service. If false, Linodes will not be enrolled by default, but may still be enrolled on creation or later.

network_helper
boolean

Enables network helper across all users by default for new Linodes and Linode Configs.

Response Samples

Responses

Linode Managed Enable

POST https://api.linode.com/v4/account/settings/managed-enable

Enables 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 software stack reachable over TCP or HTTP. See our Linode Managed guide to learn more.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Response Samples

Responses

Network Utilization View

GET https://api.linode.com/v4/account/transfer

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

Authorizations

personalAccessToken
oauthaccount:read_only

Request Samples

Response Samples

Responses

Users List

GET https://api.linode.com/v4/account/users

Returns a paginated list of all users on your account.

Note: This command can only be accessed by account users with unrestricted access.

A user can access all or part of an account based on their access status and grants:

  • Unrestricted access. These users can access everything on an account.

  • Restricted access. These users can only access entities or perform actions they’ve been given specific grants to.

Authorizations

personalAccessToken
oauthaccount:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..500
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

User Create

POST https://api.linode.com/v4/account/users

Creates a user on your account. You determine the new user’s account access by setting it to restricted or unrestricted and by defining its grants. After completion, the API sends a confirmation message containing password creation and login instructions to the user’s email address.

Note: This command can only be accessed by account users with unrestricted access.

Parent and child accounts

In a parent and child account environment, the following apply:

  • A parent account user can create new parent account users.

  • A child account can update the child account parent user (proxy user) to unrestricted. This gives the proxy user access to create new child account users.

  • A child account user can create new child account users.

  • You can’t create a proxy user. The proxy user in a child account is predefined when you initially provision the parent-child relationship.

Authorizations

personalAccessToken
oauthaccount:read_write

Request Samples

Request Body Schema

email
Required
string<email>

The email address for the User. Linode sends emails to this address for account management communications. May be used for other communications as configured.

restricted
boolean

If true, the User must be granted access to perform actions or access entities on this Account. See User Grants View ( GET /account/users/{username}/grants) for details on how to configure grants for a restricted User.

username
Required
string 3..32 characters

The User’s username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts).

Response Samples

Responses

User Delete

DELETE https://api.linode.com/v4/account/users/{username}

Deletes a user. The API immediately logs the user out and removes all of its grants.

Note: This command can only be accessed by account users with unrestricted access.

Parent and child accounts

In a parent and child account environment, the following apply:

  • You can’t delete a child account parent user (proxy user). The API returns a 403 error if you target a proxy user with this operation.

  • A parent account using an unrestricted proxy user can use this operation to delete a child account user.

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

usernamestring
Required

The username to look up.

Request Samples

Response Samples

Responses

User View

GET https://api.linode.com/v4/account/users/{username}

Returns information about a single user on your account.

Note: This command can only be accessed by account users with unrestricted access.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

usernamestring
Required

The username to look up.

Request Samples

Response Samples

Responses

User Update

PUT https://api.linode.com/v4/account/users/{username}

Update information about a user on your account, including its restricted status. When setting a user to restricted, the API sets no grants for it. You need to set grants so that user can access things on the account.

Note: This command can only be accessed by account users with unrestricted access.

Parent and child accounts

In a parent and child account environment, the following apply:

  • You can’t edit the username or email values for the child account parent user (proxy user). These are predefined for the proxy user when you initially provision the parent-child relationship. Only a proxy user’s restricted status can be modified. This can only be done by an unrestricted child account user.

  • A parent account using an unrestricted proxy user in a child account can modify the username, email, and restricted status for an existing child account user.

  • A restricted account user–parent or child–can’t change their user to unrestricted.

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

usernamestring
Required

The username to look up.

Request Samples

Request Body Schema

email
string<email>

The email address for the User. Linode sends emails to this address for account management communications. May be used for other communications as configured.

restricted
boolean

If true, the User must be granted access to perform actions or access entities on this Account. See User Grants View ( GET /account/users/{username}/grants) for details on how to configure grants for a restricted User.

username
string 3..32 characters

The User’s username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts).

Response Samples

Responses

User's Grants View

GET https://api.linode.com/v4/account/users/{username}/grants

Returns the full grants structure for an account username you specify. This includes all entities on the account, and the level of access this user has to each of them.

This doesn’t apply to the account owner or the current authenticated user. You can use the Grants List operation to view those grants. However, this doesn’t show the entities that they don’t have access to.

Note: This command can only be accessed by account users with unrestricted access.

Authorizations

personalAccessToken
oauthaccount:read_only

Path Parameters

usernamestring
Required

The username to look up.

Request Samples

Response Samples

Responses

User's Grants Update

PUT https://api.linode.com/v4/account/users/{username}/grants

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 don’t need to include the grant for every entity on the account in this request. Any that are not included remain unchanged.

Note: This command can only be accessed by account users with unrestricted access.

Parent and child accounts

In a parent and child account environment, the following apply:

  • No child account user can modify the account_access grant for the child account parent user (proxy user).

  • An unrestricted child account user can configure all other grants for the proxy user, via global object.

  • An unrestricted child account user can enable the account_access grant for other child account users. However, enabled child users are still subject to child user restrictions–they can’t perform write operations for any billing or account information.

Authorizations

personalAccessToken
oauthaccount:read_write

Path Parameters

usernamestring
Required

The username to look up.

Request Samples

Request Body Schema

database
array of objects

The grants this User has for each Database that is owned by this Account.

id
integer

The ID of the entity this grant applies to.

permissions
Nullable
string
Enum: read_only read_write

The level of access this User has to this entity. If null, this User has no access.

domain
array of objects

The grants this User has for each Domain that is owned by this Account.

id
integer

The ID of the entity this grant applies to.

permissions
Nullable
string
Enum: read_only read_write

The level of access this User has to this entity. If null, this User has no access.

global
object

A structure containing the Account-level grants a User has.

account_access
Nullable
string
Enum: read_only read_write

The level of access this User has to Account-level actions, like billing information. A restricted User will never be able to manage users.

Parent and child accounts

In a parent and child account environment, this grant can be added to a child account user, to give the user read-write access. This gives the child user unrestricted access to expected management operations, such as creating other child users. However, child users don’t have write access to billing operations. The API issues a specific error message if a write operation is attempted by a child user.

add_databases
boolean

If true, this User may add Managed Databases.

add_domains
boolean

If true, this User may add Domains.

add_firewalls
boolean

If true, this User may add Firewalls.

add_images
boolean

If true, this User may add Images.

add_linodes
boolean

If true, this User may create Linodes.

add_longview
boolean

If true, this User may create Longview clients and view the current plan.

add_nodebalancers
boolean

If true, this User may add NodeBalancers.

add_stackscripts
boolean

If true, this User may add StackScripts.

add_volumes
boolean

If true, this User may add Volumes.

add_vpcs
boolean

If true, this User may add VPCs.

cancel_account
boolean

If true, this User may cancel the entire Account.

child_account_access
Nullable
boolean

In a parent and child account environment, this gives a parent account access to endpoints that can be used to manage child accounts. Unrestricted parent account users have access to this grant, while restricted parent users don’t. An unrestricted parent user can set this to true to add this grant to a restricted parent user. Displayed as null for all non-parent accounts.

longview_subscription
boolean

If true, this User may manage the Account’s Longview subscription.

image
array of objects

The grants this User has for each Image that is owned by this Account.

id
integer

The ID of the entity this grant applies to.

permissions
Nullable
string
Enum: read_only read_write

The level of access this User has to this entity. If null, this User has no access.

linode
array of objects

The grants this User has for each Linode that is owned by this Account.

id
integer

The ID of the entity this grant applies to.

permissions
Nullable
string
Enum: read_only read_write

The level of access this User has to this entity. If null, this User has no access.

longview
array of objects

The grants this User has for each Longview Client that is owned by this Account.

id
integer

The ID of the entity this grant applies to.

permissions
Nullable
string
Enum: read_only read_write

The level of access this User has to this entity. If null, this User has no access.

nodebalancer
array of objects

The grants this User has for each NodeBalancer that is owned by this Account.

id
integer

The ID of the entity this grant applies to.

permissions
Nullable
string
Enum: read_only read_write

The level of access this User has to this entity. If null, this User has no access.

stackscript
array of objects

The grants this User has for each StackScript that is owned by this Account.

id
integer

The ID of the entity this grant applies to.

permissions
Nullable
string
Enum: read_only read_write

The level of access this User has to this entity. If null, this User has no access.

volume
array of objects

The grants this User has for each Block Storage Volume that is owned by this Account.

id
integer

The ID of the entity this grant applies to.

permissions
Nullable
string
Enum: read_only read_write

The level of access this User has to this entity. If null, this User has no access.

vpc
array of objects

The grants this User has for each VPC that is owned by this Account.

id
integer

The ID of the entity this grant applies to.

permissions
Nullable
string
Enum: read_only read_write

The level of access this User has to this entity. If null, this User has no access.

Response Samples

Responses