Account v4.78.3

Account View

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

Returns the contact and billing information related to your Account.

Authorizations

personalAccessToken
oauth account: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.

Authorizations

personalAccessToken
oauth account:read_write

Request Body Schema

active_promotions
array
credit_monthly_cap
string

The amount available to spend per month.

credit_remaining
string

The total amount of credit left for this promotion.

description
string

A detailed description of this promotion.

expire_dt
string

When this promotion’s credits expire.

image_url
string

The location of an image for this promotion.

summary
string

Short details of this promotion.

this_month_credit_remaining
string

The amount of credit left for this month for this promotion.

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.

country
string 2..2 characters

The two-letter 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.

last_name
string <= 50 characters

The last name of the person associated with this Account.

phone
string <= 32 characters

The phone number associated with this Account.

state
string <= 24 characters

If billing address is in the United States, this is the State portion of the Account’s billing address. If the address is outside the US, this is the Province associated with the Account’s billing address.

tax_id
string <= 100 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 null.

zip
string <= 16 characters

The zip code of this Account’s billing address.

Request Samples

Response Samples

Responses

Account Cancel

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

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

Authorizations

personalAccessToken
oauth account:read_write

Request Body Schema

comments
string

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

Request Samples

Response Samples

Responses

Credit Card Add/Edit

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

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.

Authorizations

personalAccessToken
oauth account:read_write

Request Body Schema

card_number
Required
string 13..23 characters

Your credit card number. No spaces or dashes allowed.

cvv
Required
string

The Card Verification Value on the back of the card.

expiry_month
Required
integer

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

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

expiry_year
Required
integer

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.

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
oauth events:read_only

Query Parameters

page
Type:
integer >= 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..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
oauth events:read_only

Path Parameters

eventId integer 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
oauth events:read_write

Path Parameters

eventId integer 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
oauth events:read_only

Path Parameters

eventId integer 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
oauth account:read_only

Query Parameters

page
Type:
integer >= 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..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
oauth account:read_only

Path Parameters

invoiceId integer 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
oauth account:read_only

Path Parameters

invoiceId integer Required

The ID of the Invoice.

Query Parameters

page
Type:
integer >= 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..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
oauth account: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
oauth account:read_only

Path Parameters

loginId integer Required

The ID of the login object to access.

Request Samples

Response Samples

Responses

Maintenance List

GET https://api.linode.com/v4beta/account/maintenance
Beta

Returns a collection of Maintenance objects for any entity a user has permissions to view.

Currently, Linodes are the only entities available for viewing.

Beta: This endpoint is in beta. Please make sure to prepend all requests with /v4beta instead of /v4, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of beta.

Authorizations

personalAccessToken
oauth maintenance:read_only

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
oauth account: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
oauth account:read_only

Query Parameters

page
Type:
integer >= 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..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
oauth account:read_write

Request Body Schema

label
Filterable
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.

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.

Request Samples

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
oauth account:read_write

Path Parameters

clientId string 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
oauth account:read_only

Path Parameters

clientId string 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
oauth account:read_write

Path Parameters

clientId string Required

The OAuth Client ID to look up.

Request Body Schema

label
Filterable
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.

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.

Request Samples

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
oauth account:read_write

Path Parameters

clientId string 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

clientId string 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
oauth account:read_write

Path Parameters

clientId string Required

The OAuth Client ID to look up.

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
oauth account:read_only

Query Parameters

page
Type:
integer >= 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..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 via credit card. This will charge your credit card the requested amount.

Authorizations

personalAccessToken
oauth account:read_write

Request Body Schema

cvv
string

CVV (Card Verification Value) of the credit card to be used for the Payment.

usd
Required
string

The amount in US Dollars of the Payment. The maximum credit card payment that can be made is $50,000 dollars.

Request Samples

Response Samples

Responses

PayPal Payment Stage

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

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 to complete the Payment.

Authorizations

personalAccessToken
oauth account:read_write

Request Body Schema

cancel_url
Required
string

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

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.

Request Samples

Response Samples

Responses

Staged/Approved PayPal Payment Execute

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

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.

Authorizations

personalAccessToken
oauth account:read_write

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.

Request Samples

Response Samples

Responses

Payment View

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

Returns information about a specific Payment.

Authorizations

personalAccessToken
oauth account:read_only

Path Parameters

paymentId integer Required

The ID of the Payment to look up.

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
oauth account:read_only

Request Samples

Response Samples

Responses

Account Settings Update

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

Updates your Account settings.

To update your Longview subscription plan, send a request to Update Longview Plan.

Authorizations

personalAccessToken
oauth account:read_write

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.

Request Samples

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
oauth account: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
oauth account:read_only

Request Samples

Response Samples

Responses

Users List

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

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.

Authorizations

personalAccessToken
oauth account:read_only

Query Parameters

page
Type:
integer >= 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..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. 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.

Authorizations

personalAccessToken
oauth account:read_write

Request Body Schema

email
Required
string <email>

The new User’s email address.

restricted
boolean

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

username
Required
string 3..32 characters

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

Request Samples

Response Samples

Responses

User Delete

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

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.

Authorizations

personalAccessToken
oauth account:read_write

Path Parameters

username string 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.

Authorizations

personalAccessToken
oauth account:read_only

Path Parameters

username string 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. 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.

Authorizations

personalAccessToken
oauth account:read_write

Path Parameters

username string Required

The username to look up.

Request Body Schema

restricted
boolean

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

ssh_keys
array

A list of SSH Key labels added by this User. These are the keys that will be deployed if this User is included in the authorized_users field of a create Linode, rebuild Linode, or create Disk request.

username
Filterable
string 3..32 characters

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

Request Samples

Response Samples

Responses

User's Grants View

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

Returns the full grants structure for the specified account User (other than the account owner, see below for details). This includes all entities on the Account alongside the level of access this User has to each of them.

The current authenticated User, including the account owner, may view their own grants at the /profile/grants endpoint, but will not see entities that they do not have access to.

Authorizations

personalAccessToken
oauth account:read_only

Path Parameters

username string 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 do not need to include the grant for every entity on the Account in this request; any that are not included will remain unchanged.

Authorizations

personalAccessToken
oauth account:read_write

Path Parameters

username string Required

The username to look up.

Request Body Schema

domain
array

The grants this User has pertaining to Domains on this Account. There will be one entry per Domain on the 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.

add_domains
boolean

If true, this User may add Domains.

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.

cancel_account
boolean

If true, this User may cancel the entire Account.

longview_subscription
boolean

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

image
array

The grants this User has pertaining to Images on this Account. There will be one entry per Image on the 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

The grants this User has pertaining to Linodes on this Account. There will be one entry per Linode on the 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

The grants this User has pertaining to Longview Clients on this Account. There will be one entry per Longview Client on the 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

The grants this User has pertaining to NodeBalancers on this Account. There will be one entry per NodeBalancer on the 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

The grants this User has pertaining to StackScripts on this Account. There will be one entry per StackScript on the 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

The grants this User has pertaining to Volumes on this Account. There will be one entry per Volume on the 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.

Request Samples

Response Samples

Responses