Account
v4.175.0 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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
default
{
"active_promotions" : [
{
"credit_monthly_cap" : "10.00" ,
"credit_remaining" : "50.00" ,
"description" : "Receive up to $10 off your services every month for 6 months! Unused credits will expire once this promotion period ends." ,
"expire_dt" : "2018-01-31T23:59:59" ,
"image_url" : "https://linode.com/10_a_month_promotion.svg" ,
"service_type" : "all" ,
"summary" : "$10 off your Linode a month!" ,
"this_month_credit_remaining" : "10.00"
}
],
"active_since" : "2018-01-01T00:01:01" ,
"address_1" : "123 Main Street" ,
"address_2" : "Suite A" ,
"balance" : 200 ,
"balance_uninvoiced" : 145 ,
"billing_source" : "akamai" ,
"capabilities" : [
"Linodes" ,
"NodeBalancers" ,
"Block Storage" ,
"Object Storage"
],
"city" : "Philadelphia" ,
"company" : "Linode LLC" ,
"country" : "US" ,
"credit_card" : {
"expiry" : "11/2022" ,
"last_four" : 1111
},
"email" : "john.smith@linode.com" ,
"euuid" : "E1AF5EEC-526F-487D-B317EBEB34C87D71" ,
"first_name" : "John" ,
"last_name" : "Smith" ,
"phone" : "215-555-1212" ,
"state" : "PA" ,
"tax_id" : "ATU99999999" ,
"zip" : "19102-1234"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a single Account object.
array
of objects
string
The amount available to spend per month.
string
The total amount of credit left for this promotion.
string
A detailed description of this promotion.
string
When this promotion’s credits expire.
string
The location of an image for this promotion.
stringEnum:
all
backup
blockstorage
db_mysql
ip_v4
linode
linode_disk
linode_memory
longview
managed
nodebalancer
objectstorage
transfer_tx
The service to which this promotion applies.
string
Short details of this promotion.
this_month_credit_remaining
string
The amount of credit left for this month for this promotion.
string<date-time>
The date and time the account was activated.
string
<=
64
characters
First line of this Account’s billing address.
string
<=
64
characters
Second line of this Account’s billing address.
number
This Account’s balance, in US dollars.
number
This Account’s current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.
stringEnum:
akamai
linode
The source of service charges for this Account, as determined by its relationship with Akamai.
Accounts that are associated with Akamai-specific customers return a value of akamai.
All other Accounts return a value of linode.
array
of strings
A list of capabilities your account supports.
string
<=
24
characters
The city for this Account’s billing address.
string
<=
128
characters
The company name associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
The two-letter ISO 3166 country code of this Account’s billing address.
object
Credit Card information associated with this Account.
string
The expiration month and year of the credit card.
string
The last four digits of the credit card associated with this Account.
string
<=
128
characters
The email address of the person associated with this Account.
string<uuid>
An external unique identifier for this account.
string
<=
50
characters
The first name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
50
characters
The last name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
32
characters
The phone number associated with this Account.
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.
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 ("").
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.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"address_1": "123 Main St.",
"address_2": "Suite 101",
"city": "Philadelphia",
"company": "My Company, LLC",
"country": "US",
"email": "jsmith@mycompany.com",
"first_name": "John",
"last_name": "Smith",
"phone": "555-555-1212",
"state": "PA",
"tax_id": "ATU99999999",
"zip": "19102"
}' \
linode-cli account update \
"123 Main St." \
"Suite 101" \
\
\ LLC \
\
\
\
\
\
\
\
19102
Request Body Schema string
<=
64
characters
First line of this Account’s billing address.
string
<=
64
characters
Second line of this Account’s billing address.
string
<=
24
characters
The city for this Account’s billing address.
string
<=
128
characters
The company name associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
The two-letter ISO 3166 country code of this Account’s billing address.
string
<=
128
characters
The email address of the person associated with this Account.
string
<=
50
characters
The first name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
50
characters
The last name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
32
characters
The phone number associated with this Account.
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.
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 ("").
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
200
default
{
"active_promotions" : [
{
"credit_monthly_cap" : "10.00" ,
"credit_remaining" : "50.00" ,
"description" : "Receive up to $10 off your services every month for 6 months! Unused credits will expire once this promotion period ends." ,
"expire_dt" : "2018-01-31T23:59:59" ,
"image_url" : "https://linode.com/10_a_month_promotion.svg" ,
"service_type" : "all" ,
"summary" : "$10 off your Linode a month!" ,
"this_month_credit_remaining" : "10.00"
}
],
"active_since" : "2018-01-01T00:01:01" ,
"address_1" : "123 Main Street" ,
"address_2" : "Suite A" ,
"balance" : 200 ,
"balance_uninvoiced" : 145 ,
"billing_source" : "akamai" ,
"capabilities" : [
"Linodes" ,
"NodeBalancers" ,
"Block Storage" ,
"Object Storage"
],
"city" : "Philadelphia" ,
"company" : "Linode LLC" ,
"country" : "US" ,
"credit_card" : {
"expiry" : "11/2022" ,
"last_four" : 1111
},
"email" : "john.smith@linode.com" ,
"euuid" : "E1AF5EEC-526F-487D-B317EBEB34C87D71" ,
"first_name" : "John" ,
"last_name" : "Smith" ,
"phone" : "215-555-1212" ,
"state" : "PA" ,
"tax_id" : "ATU99999999" ,
"zip" : "19102-1234"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The updated Account.
array
of objects
string
The amount available to spend per month.
string
The total amount of credit left for this promotion.
string
A detailed description of this promotion.
string
When this promotion’s credits expire.
string
The location of an image for this promotion.
stringEnum:
all
backup
blockstorage
db_mysql
ip_v4
linode
linode_disk
linode_memory
longview
managed
nodebalancer
objectstorage
transfer_tx
The service to which this promotion applies.
string
Short details of this promotion.
this_month_credit_remaining
string
The amount of credit left for this month for this promotion.
string<date-time>
The date and time the account was activated.
string
<=
64
characters
First line of this Account’s billing address.
string
<=
64
characters
Second line of this Account’s billing address.
number
This Account’s balance, in US dollars.
number
This Account’s current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.
stringEnum:
akamai
linode
The source of service charges for this Account, as determined by its relationship with Akamai.
Accounts that are associated with Akamai-specific customers return a value of akamai.
All other Accounts return a value of linode.
array
of strings
A list of capabilities your account supports.
string
<=
24
characters
The city for this Account’s billing address.
string
<=
128
characters
The company name associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
The two-letter ISO 3166 country code of this Account’s billing address.
object
Credit Card information associated with this Account.
string
The expiration month and year of the credit card.
string
The last four digits of the credit card associated with this Account.
string
<=
128
characters
The email address of the person associated with this Account.
string<uuid>
An external unique identifier for this account.
string
<=
50
characters
The first name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
50
characters
The last name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
32
characters
The phone number associated with this Account.
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.
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 ("").
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.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
Account Availability GET
https://api.linode.com/v4beta/account/availability
Beta
Returns service unavailability for all available regions.
Only authorized Users can access this endpoint.
This endpoint is currently in Beta , and should not be used for production workloads.
Authorizations personalAccessToken oauth account:read_only
Request Samples
Shell
CLI
curl https://api.linode.com/v4/account/availability \
"Authorization: Bearer $TOKEN "
linode-cli account get-availability
Response Samples
200
default
{
"data" : [
{
"region" : "us-east" ,
"unavailable" : [
"Linodes" ,
"Block Storage"
]
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of regions and their unavailable resources.
array
of objects
string
Displays the data center represented by a slug.
array
of strings
A list of strings of unavailable services.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
Region Service Availability GET
https://api.linode.com/v4beta/account/availability/{id}
Beta
Returns a single region’s service availability.
Only authorized Users can access this.
Authorizations personalAccessToken oauth account:read_only
Path Parameters id string
Required The id of the data center.
Request Samples
Shell
CLI
curl https://api.linode.com/v4/account/availability/us-east \
"Authorization: Bearer $TOKEN "
linode-cli account get-account-availability us-east
Response Samples
200
default
{
"region" : "us-east" ,
"unavailable" : [
"Linodes" ,
"Block Storage"
]
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns an object with a region and the region's unavailable resources.
string
Displays the data center represented by a slug.
array
of strings
A list of strings of unavailable services.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"comments": "I am consolidating my accounts."
}' \
linode-cli account cancel \
"I'm consolidating my accounts"
Request Body Schema string
Any reason for cancelling the account, and any other comments you might have about your Linode service.
Response Samples
200
409
default
{
"survey_link" : "https://alinktothesurvey.com"
}
{
"errors" : [
{
"reason" : "We were unable to charge your credit card for services rendered. We cannot cancel this account until the balance has been paid.\n"
}
]
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
409
default
Account canceled
string
A link to Linode’s exit survey.
Could not charge the credit card on file
array
of objects
string
A string explaining that the account could not be canceled because there is an outstanding balance on the account that must be paid first.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth child_account:read_only
Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli child-account list
Response Samples
200
default
{
"active_since" : "2018-01-01T00:01:01" ,
"address_1" : "123 Main Street" ,
"address_2" : "Suite A" ,
"balance" : 200 ,
"balance_uninvoiced" : 145 ,
"billing_source" : "external" ,
"capabilities" : [
"Linodes" ,
"NodeBalancers" ,
"Block Storage" ,
"Object Storage"
],
"city" : "San Diego" ,
"company" : "Acme" ,
"country" : "US" ,
"credit_card" : {
"expiry" : "11/2024" ,
"last_four" : 1111
},
"email" : "john.smith@linode.com" ,
"euuid" : "A1BC2DEF-34GH-567I-J890KLMN12O34P56" ,
"first_name" : "John" ,
"last_name" : "Smith" ,
"phone" : "858-555-1212" ,
"state" : "CA" ,
"tax_id" : "ATU99999999" ,
"zip" : "92111-1234"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns child-level accounts.
string<date-time>
The activation date and time for the child account.
string
<=
64
characters
First line of this child account’s billing address.
string
<=
64
characters
Second line of this child account’s billing address, if applicable.
number
This child account’s balance, in US dollars.
number
This child account’s current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.
stringEnum:
external
The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of external to describe a child account in a parent-child account environment.
array
of strings
A list of the capabilities the child account supports.
string
<=
24
characters
The city for this child account’s billing address.
string
<=
128
characters
The company name for the owner of this child account. It can’t include any of these characters: < > ( ) " =. You can’t change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.
string
The two-letter ISO 3166 country code for this child account’s billing address.
object
Information for the credit card you’ve assigned to this child account.
string
The expiration month and year of the credit card.
string
The last four digits of the credit card.
string
<=
128
characters
The email address of the owner of this child account.
string<uuid>
An external, unique identifier that Akamai assigned to the child account.
string
<=
50
characters
The first name of the owner of this child account. It can’t include any of these characters: < > ( ) " =.
string
<=
50
characters
The last name of the owner of this child account. It can’t include any of these characters: < > ( ) " =.
string
<=
32
characters
The phone number for the owner of this child account.
string
<=
24
characters
The state or province for the billing address (address_1 and address_2, if applicable). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.
Note: If this is a US military address, use state abbreviations (AA, AE, AP).
string
<=
25
characters
The tax identification number for this child account. Use this for tax calculations in some countries. If you live in a country that doesn’t collect taxes, ensure this is an empty string ("").
string
The zip code of this Account’s billing address. The following restrictions apply:
Can only contain ASCII letters, numbers, and hyphens (-). Can’t contain more than 9 letter or number characters.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth child_account:read_only
Path Parameters euuid string
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli child-account view A1BC2DEF-34GH-567I-J890KLMN12O34P56
Response Samples
200
default
{
"active_since" : "2018-01-01T00:01:01" ,
"address_1" : "123 Main Street" ,
"address_2" : "Suite A" ,
"balance" : 200 ,
"balance_uninvoiced" : 145 ,
"billing_source" : "external" ,
"capabilities" : [
"Linodes" ,
"NodeBalancers" ,
"Block Storage" ,
"Object Storage"
],
"city" : "San Diego" ,
"company" : "Acme" ,
"country" : "US" ,
"credit_card" : {
"expiry" : "11/2024" ,
"last_four" : 1111
},
"email" : "john.smith@linode.com" ,
"euuid" : "A1BC2DEF-34GH-567I-J890KLMN12O34P56" ,
"first_name" : "John" ,
"last_name" : "Smith" ,
"phone" : "858-555-1212" ,
"state" : "CA" ,
"tax_id" : "ATU99999999" ,
"zip" : "92111-1234"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns the child-level account for a specified `euuid`.
string<date-time>
The activation date and time for the child account.
string
<=
64
characters
First line of this child account’s billing address.
string
<=
64
characters
Second line of this child account’s billing address, if applicable.
number
This child account’s balance, in US dollars.
number
This child account’s current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.
stringEnum:
external
The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of external to describe a child account in a parent-child account environment.
array
of strings
A list of the capabilities the child account supports.
string
<=
24
characters
The city for this child account’s billing address.
string
<=
128
characters
The company name for the owner of this child account. It can’t include any of these characters: < > ( ) " =. You can’t change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.
string
The two-letter ISO 3166 country code for this child account’s billing address.
object
Information for the credit card you’ve assigned to this child account.
string
The expiration month and year of the credit card.
string
The last four digits of the credit card.
string
<=
128
characters
The email address of the owner of this child account.
string<uuid>
An external, unique identifier that Akamai assigned to the child account.
string
<=
50
characters
The first name of the owner of this child account. It can’t include any of these characters: < > ( ) " =.
string
<=
50
characters
The last name of the owner of this child account. It can’t include any of these characters: < > ( ) " =.
string
<=
32
characters
The phone number for the owner of this child account.
string
<=
24
characters
The state or province for the billing address (address_1 and address_2, if applicable). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.
Note: If this is a US military address, use state abbreviations (AA, AE, AP).
string
<=
25
characters
The tax identification number for this child account. Use this for tax calculations in some countries. If you live in a country that doesn’t collect taxes, ensure this is an empty string ("").
string
The zip code of this Account’s billing address. The following restrictions apply:
Can only contain ASCII letters, numbers, and hyphens (-). Can’t contain more than 9 letter or number characters.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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:
List child accounts and store the euuid for the applicable one.Run this operation and store the token that’s created for the proxy user. 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 oauth child_account:read_write
Path Parameters euuid string
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
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
\
linode-cli child-account create A1BC2DEF-34GH-567I-J890KLMN12O34P56
Response Samples
200
default
{
"created" : "2024-05-01T00:01:01" ,
"expiry" : "2024-05-01T00:16:01" ,
"id" : 918 ,
"label" : "parent1_1234_2024-05-01T00:01:01" ,
"scopes" : "*" ,
"token" : "abcdefghijklmnop"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Token created successfully.
string<date-time>
The date and time this token was created.
string<date-time>
When this token expires. This is default set to 15 minutes from the time of creation. Proxy user tokens can’t be renewed. After this time, Akamai revokes the token and you need to generate a new one.
integer
The proxy user token’s unique ID, which can be used to revoke it.
string
1..100
characters
The name of the token. The API automatically sets this to <username>_<uid>_<time>. It’s composed of the username for your parent account user, the unique uid Akamai assigned to identify your user, and the time the API generated the token. This is for display purposes only, but you can use it to help track how you’re using each proxy user token.
string<oauth-scopes>
The scopes this token was created with. Defaults to *. Proxy user tokens automatically inherit all the permissions of the proxy user.
string
The proxy user token that can be used to access the API and CLI. After you create a token, you can see the full token
in the response. All other operations that contain this token only show the first 16 characters in their response.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"card_number": "4111111111111111",
"expiry_month": 11,
"expiry_year": 2020,
"cvv": "111"
}' \
linode-cli account update-card \
4111111111111111 \
11 \
2025 \
111
Request Body Schema string<digits>
14..24
characters
Your credit card number. No spaces or hyphens (-) allowed.
string<digits>
3..4
characters
CVV (Card Verification Value) of the credit card, typically found on the back of the card.
integer
1..12
A value from 1-12 representing the expiration month of your credit card.
1 = January 2 = February 3 = March Etc. 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
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
Entity Transfers List GET
https://api.linode.com/v4/account/entity-transfers
DEPRECATED . Please use Service Transfers List .
Authorizations personalAccessToken oauth account:read_only
Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
default
{
"data" : [
{
"created" : "2021-02-11T16:37:03" ,
"entities" : {
"linodes" : [
111 ,
222
]
},
"expiry" : "2021-02-12T16:37:03" ,
"is_sender" : true ,
"status" : "pending" ,
"token" : "123E4567-E89B-12D3-A456-426614174000" ,
"updated" : "2021-02-11T16:37:03"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of Entity Transfer objects containing the details of all transfers that have been created and accepted by this account.
array
of objects
string<date-time>
When this transfer was created.
object
A collection of the entities to include in this transfer request, separated by type.
array
of integers
An array containing the IDs of each of the Linodes included in this transfer.
string<date-time>
When this transfer expires. Transfers will automatically expire 24 hours after creation.
boolean
If the requesting account created this transfer.
stringEnum:
accepted
canceled
completed
failed
pending
stale
The status of the transfer request.
accepted: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.
canceled: The transfer has been canceled by the sender.
completed: The transfer has completed successfully.
failed: The transfer has failed after initiation.
pending: The transfer is ready to be accepted.
stale: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.
string<uuid>
The token used to identify and accept or cancel this transfer.
string<date-time>
When this transfer was last updated.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
Entity Transfer Create POST
https://api.linode.com/v4/account/entity-transfers
DEPRECATED . Please use Service Transfer Create .
Authorizations personalAccessToken oauth account:read_write
Request Samples
Shell
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"entities": {
"linodes": [
111,
222
]
}
}' \
Request Body Schema object
A collection of the entities to include in this transfer request, separated by type.
array
of integers
An array containing the IDs of each of the Linodes included in this transfer.
Response Samples
200
default
{
"created" : "2021-02-11T16:37:03" ,
"entities" : {
"linodes" : [
111 ,
222
]
},
"expiry" : "2021-02-12T16:37:03" ,
"is_sender" : true ,
"status" : "pending" ,
"token" : "123E4567-E89B-12D3-A456-426614174000" ,
"updated" : "2021-02-11T16:37:03"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns an Entity Transfer object for the request.
string<date-time>
When this transfer was created.
object
A collection of the entities to include in this transfer request, separated by type.
array
of integers
An array containing the IDs of each of the Linodes included in this transfer.
string<date-time>
When this transfer expires. Transfers will automatically expire 24 hours after creation.
boolean
If the requesting account created this transfer.
stringEnum:
accepted
canceled
completed
failed
pending
stale
The status of the transfer request.
accepted: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.
canceled: The transfer has been canceled by the sender.
completed: The transfer has completed successfully.
failed: The transfer has failed after initiation.
pending: The transfer is ready to be accepted.
stale: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.
string<uuid>
The token used to identify and accept or cancel this transfer.
string<date-time>
When this transfer was last updated.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
Entity Transfer Cancel DELETE
https://api.linode.com/v4/account/entity-transfers/{token}
DEPRECATED . Please use Service Transfer Cancel .
Authorizations personalAccessToken oauth account:read_write
Path Parameters token string<uuid>
Required The UUID of the Entity Transfer.
Request Samples
Shell
curl -H "Authorization: Bearer $TOKEN " \
\
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Entity Transfer canceled.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
Entity Transfer View GET
https://api.linode.com/v4/account/entity-transfers/{token}
DEPRECATED . Please use Service Transfer View .
Authorizations personalAccessToken oauth account:read_only
Path Parameters token string<uuid>
Required The UUID of the Entity Transfer.
Request Samples
Shell
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
default
{
"created" : "2021-02-11T16:37:03" ,
"entities" : {
"linodes" : [
111 ,
222
]
},
"expiry" : "2021-02-12T16:37:03" ,
"is_sender" : true ,
"status" : "pending" ,
"token" : "123E4567-E89B-12D3-A456-426614174000" ,
"updated" : "2021-02-11T16:37:03"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns an Entity Transfer object containing the details of the transfer for the specified token.
string<date-time>
When this transfer was created.
object
A collection of the entities to include in this transfer request, separated by type.
array
of integers
An array containing the IDs of each of the Linodes included in this transfer.
string<date-time>
When this transfer expires. Transfers will automatically expire 24 hours after creation.
boolean
If the requesting account created this transfer.
stringEnum:
accepted
canceled
completed
failed
pending
stale
The status of the transfer request.
accepted: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete.
canceled: The transfer has been canceled by the sender.
completed: The transfer has completed successfully.
failed: The transfer has failed after initiation.
pending: The transfer is ready to be accepted.
stale: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.
string<uuid>
The token used to identify and accept or cancel this transfer.
string<date-time>
When this transfer was last updated.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
Entity Transfer Accept POST
https://api.linode.com/v4/account/entity-transfers/{token}/accept
DEPRECATED . Please use Service Transfer Accept .
Authorizations personalAccessToken oauth account:read_write
Path Parameters token string<uuid>
Required The UUID of the Entity Transfer.
Request Samples
Shell
curl -H "Authorization: Bearer $TOKEN " \
\
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Entity Transfer accepted.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
default
{
"data" : [
{
"action" : "ticket_create" ,
"created" : "2018-01-01T00:01:01" ,
"duration" : 300.56 ,
"entity" : {
"id" : 11111 ,
"label" : "Problem booting my Linode" ,
"type" : "ticket" ,
"url" : "/v4/support/tickets/11111"
},
"id" : 123 ,
"message" : "None" ,
"percent_complete" : null ,
"rate" : null ,
"read" : true ,
"secondary_entity" : {
"id" : "linode/debian9" ,
"label" : "linode1234" ,
"type" : "linode" ,
"url" : "/v4/linode/instances/1234"
},
"seen" : true ,
"status" : null ,
"time_remaining" : null ,
"username" : "exampleUser"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated lists of Event objects from the last 90 days.
array
of objects
stringEnum:
account_update
account_settings_update
backups_enable
backups_cancel
backups_restore
community_question_reply
community_like
credit_card_updated
disk_create
disk_delete
disk_update
disk_duplicate
disk_imagize
disk_resize
dns_record_create
dns_record_delete
dns_record_update
dns_zone_create
dns_zone_delete
dns_zone_import
dns_zone_update
entity_transfer_accept
entity_transfer_cancel
entity_transfer_create
entity_transfer_fail
entity_transfer_stale
firewall_create
firewall_delete
firewall_disable
firewall_enable
firewall_update
firewall_device_add
firewall_device_remove
host_reboot
image_delete
image_update
image_upload
ipaddress_update
lassie_reboot
lish_boot
linode_addip
linode_boot
linode_clone
linode_create
linode_delete
linode_update
linode_deleteip
linode_migrate
linode_migrate_datacenter
linode_migrate_datacenter_create
linode_mutate
linode_mutate_create
linode_reboot
linode_rebuild
linode_resize
linode_resize_create
linode_shutdown
linode_snapshot
linode_config_create
linode_config_delete
linode_config_update
lke_node_create
longviewclient_create
longviewclient_delete
longviewclient_update
managed_disabled
managed_enabled
managed_service_create
managed_service_delete
nodebalancer_create
nodebalancer_delete
nodebalancer_update
nodebalancer_config_create
nodebalancer_config_delete
nodebalancer_config_update
nodebalancer_node_create
nodebalancer_node_delete
nodebalancer_node_update
oauth_client_create
oauth_client_delete
oauth_client_secret_reset
oauth_client_update
obj_access_key_create
obj_access_key_delete
obj_access_key_update
password_reset
payment_method_add
payment_submitted
profile_update
stackscript_create
stackscript_delete
stackscript_update
stackscript_publicize
stackscript_revise
subnet_create
subnet_delete
subnet_update
tag_create
tag_delete
tfa_disabled
tfa_enabled
ticket_attachment_upload
ticket_create
ticket_update
token_create
token_delete
token_update
user_create
user_update
user_delete
user_ssh_key_add
user_ssh_key_delete
user_ssh_key_update
vlan_attach
vlan_detach
volume_attach
volume_clone
volume_create
volume_delete
volume_update
volume_detach
volume_resize
vpc_create
vpc_delete
vpc_update
The action that caused this Event. New actions may be added in the future.
string<date-time>
When this Event was created.
number
The total duration in seconds that it takes for the Event to complete.
object
Detailed information about the Event’s entity, including ID, type, label, and URL used to access it.
integer
The unique ID for an Event’s entity.
Some Event entities do not have IDs associated with them, so they
will not be returned when filtering by ID. These Events include:
Entities for some Events are assigned the ID of the Linode they correspond to.
When filtering by ID for these Events, use the corresponding Linode’s ID.
These Events include:
Tag Events use a tag’s name for the entity ID field. When filtering by ID
for tag Events, supply the name of the tag.
string
The current label of this object. The label may reflect changes that occur with this Event.
stringEnum:
account
backups
community
disks
domain
entity_transfer
firewall
image
ipaddress
linode
longview
managed_service
nodebalancer
oauth_client
profile
stackscript
tag
ticket
token
user
user_ssh_key
volume
The type of entity that is being referenced by the Event.
string
The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.
integer
The unique ID of this Event.
string
Provides additional information about the event. Additional information may include, but is not limited to, a more detailed representation of events which can help diagnose non-obvious failures.
integer
A percentage estimating the amount of time remaining for an Event.
Returns null for notification events.
string
The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events.
boolean
If this Event has been read.
object
Detailed information about the Event’s secondary entity, which provides additional information
for events such as, but not limited to, linode_boot, linode_reboot, linode_create, and linode_clone Event actions.
string
The ID of the object that is the secondary entity.
string
The label of this object.
string
The type of entity that is being referenced by the Event.
string
The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.
boolean
If this Event has been seen.
stringEnum:
failed
finished
notification
scheduled
started
The current status of this Event.
string
The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the percent_complete attribute will indicate about how much more work is to be done.
string
The username of the User who caused the Event.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli events view 123
Response Samples
200
default
{
"action" : "ticket_create" ,
"created" : "2018-01-01T00:01:01" ,
"duration" : 300.56 ,
"entity" : {
"id" : 11111 ,
"label" : "Problem booting my Linode" ,
"type" : "ticket" ,
"url" : "/v4/support/tickets/11111"
},
"id" : 123 ,
"message" : "None" ,
"percent_complete" : null ,
"rate" : null ,
"read" : true ,
"secondary_entity" : {
"id" : "linode/debian9" ,
"label" : "linode1234" ,
"type" : "linode" ,
"url" : "/v4/linode/instances/1234"
},
"seen" : true ,
"status" : null ,
"time_remaining" : null ,
"username" : "exampleUser"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
An Event object
stringEnum:
account_update
account_settings_update
backups_enable
backups_cancel
backups_restore
community_question_reply
community_like
credit_card_updated
disk_create
disk_delete
disk_update
disk_duplicate
disk_imagize
disk_resize
dns_record_create
dns_record_delete
dns_record_update
dns_zone_create
dns_zone_delete
dns_zone_import
dns_zone_update
entity_transfer_accept
entity_transfer_cancel
entity_transfer_create
entity_transfer_fail
entity_transfer_stale
firewall_create
firewall_delete
firewall_disable
firewall_enable
firewall_update
firewall_device_add
firewall_device_remove
host_reboot
image_delete
image_update
image_upload
ipaddress_update
lassie_reboot
lish_boot
linode_addip
linode_boot
linode_clone
linode_create
linode_delete
linode_update
linode_deleteip
linode_migrate
linode_migrate_datacenter
linode_migrate_datacenter_create
linode_mutate
linode_mutate_create
linode_reboot
linode_rebuild
linode_resize
linode_resize_create
linode_shutdown
linode_snapshot
linode_config_create
linode_config_delete
linode_config_update
lke_node_create
longviewclient_create
longviewclient_delete
longviewclient_update
managed_disabled
managed_enabled
managed_service_create
managed_service_delete
nodebalancer_create
nodebalancer_delete
nodebalancer_update
nodebalancer_config_create
nodebalancer_config_delete
nodebalancer_config_update
nodebalancer_node_create
nodebalancer_node_delete
nodebalancer_node_update
oauth_client_create
oauth_client_delete
oauth_client_secret_reset
oauth_client_update
obj_access_key_create
obj_access_key_delete
obj_access_key_update
password_reset
payment_method_add
payment_submitted
profile_update
stackscript_create
stackscript_delete
stackscript_update
stackscript_publicize
stackscript_revise
subnet_create
subnet_delete
subnet_update
tag_create
tag_delete
tfa_disabled
tfa_enabled
ticket_attachment_upload
ticket_create
ticket_update
token_create
token_delete
token_update
user_create
user_update
user_delete
user_ssh_key_add
user_ssh_key_delete
user_ssh_key_update
vlan_attach
vlan_detach
volume_attach
volume_clone
volume_create
volume_delete
volume_update
volume_detach
volume_resize
vpc_create
vpc_delete
vpc_update
The action that caused this Event. New actions may be added in the future.
string<date-time>
When this Event was created.
number
The total duration in seconds that it takes for the Event to complete.
object
Detailed information about the Event’s entity, including ID, type, label, and URL used to access it.
integer
The unique ID for an Event’s entity.
Some Event entities do not have IDs associated with them, so they
will not be returned when filtering by ID. These Events include:
Entities for some Events are assigned the ID of the Linode they correspond to.
When filtering by ID for these Events, use the corresponding Linode’s ID.
These Events include:
Tag Events use a tag’s name for the entity ID field. When filtering by ID
for tag Events, supply the name of the tag.
string
The current label of this object. The label may reflect changes that occur with this Event.
stringEnum:
account
backups
community
disks
domain
entity_transfer
firewall
image
ipaddress
linode
longview
managed_service
nodebalancer
oauth_client
profile
stackscript
tag
ticket
token
user
user_ssh_key
volume
The type of entity that is being referenced by the Event.
string
The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.
integer
The unique ID of this Event.
string
Provides additional information about the event. Additional information may include, but is not limited to, a more detailed representation of events which can help diagnose non-obvious failures.
integer
A percentage estimating the amount of time remaining for an Event.
Returns null for notification events.
string
The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events.
boolean
If this Event has been read.
object
Detailed information about the Event’s secondary entity, which provides additional information
for events such as, but not limited to, linode_boot, linode_reboot, linode_create, and linode_clone Event actions.
string
The ID of the object that is the secondary entity.
string
The label of this object.
string
The type of entity that is being referenced by the Event.
string
The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.
boolean
If this Event has been seen.
stringEnum:
failed
finished
notification
scheduled
started
The current status of this Event.
string
The estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the percent_complete attribute will indicate about how much more work is to be done.
string
The username of the User who caused the Event.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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_only
Path Parameters eventId integer
Required The ID of the Event to designate as read.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
\
linode-cli events mark-read 123
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
\
linode-cli events mark-seen 123
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account invoices-list
Response Samples
200
default
{
"data" : [
{
"billing_source" : "linode" ,
"date" : "2018-01-01T00:01:01" ,
"id" : 123 ,
"label" : "Invoice" ,
"subtotal" : 120.25 ,
"tax" : 12.25 ,
"tax_summary" : [
{
"name" : "PA STATE TAX" ,
"tax" : 12.25
}
],
"total" : 132.5
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of Invoice objects.
array
of objects
stringEnum:
akamai
linode
akamai: This Invoice was generated according to the terms of an agreement between the customer and Akamai.
linode: This Invoice was generated according to the default terms, prices, and discounts.
string<date-time>
When this Invoice was generated.
integer
The Invoice’s unique ID.
string
The Invoice’s display label.
number
The amount of the Invoice before taxes in US Dollars.
number
The amount of tax levied on the Invoice in US Dollars.
array
of objects
The amount of tax broken down into subtotals by source.
string
The source of this tax subtotal.
number
The amount of tax subtotal attributable to this source.
number
The amount of the Invoice after taxes in US Dollars.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account invoice-view 123
Response Samples
200
default
{
"billing_source" : "linode" ,
"date" : "2018-01-01T00:01:01" ,
"id" : 123 ,
"label" : "Invoice" ,
"subtotal" : 120.25 ,
"tax" : 12.25 ,
"tax_summary" : [
{
"name" : "PA STATE TAX" ,
"tax" : 12.25
}
],
"total" : 132.5
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
An Invoice object
stringEnum:
akamai
linode
akamai: This Invoice was generated according to the terms of an agreement between the customer and Akamai.
linode: This Invoice was generated according to the default terms, prices, and discounts.
string<date-time>
When this Invoice was generated.
integer
The Invoice’s unique ID.
string
The Invoice’s display label.
number
The amount of the Invoice before taxes in US Dollars.
number
The amount of tax levied on the Invoice in US Dollars.
array
of objects
The amount of tax broken down into subtotals by source.
string
The source of this tax subtotal.
number
The amount of tax subtotal attributable to this source.
number
The amount of the Invoice after taxes in US Dollars.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account invoice-items 123
Response Samples
200
default
{
"data" : [
{
"amount" : 20.2 ,
"from" : "2018-01-01T00:01:01" ,
"label" : "Linode 123" ,
"quantity" : 4 ,
"region" : "us-west" ,
"tax" : 1.25 ,
"to" : "2018-01-31T11:59:59" ,
"total" : 21.45 ,
"type" : "hourly" ,
"unit_price" : 5.05
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of InvoiceItem objects
array
of objects
number
The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.
string<date-time>
The date the Invoice Item started, based on month.
string
The Invoice Item’s display label.
integer
The quantity of this Item for the specified Invoice.
string
The ID of the applicable Region associated with this Invoice Item.
null if there is no applicable Region.
number
The amount of tax levied on this Item in US Dollars.
string<date-time>
The date the Invoice Item ended, based on month.
number
The price of this Item after taxes in US Dollars.
stringEnum:
hourly
misc
The type of service, ether hourly or misc.
string
The monthly service fee in US Dollars for this Item.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account logins-list
Response Samples
200
default
{
"data" : [
{
"datetime" : "2018-01-01T00:01:01" ,
"id" : 1234 ,
"ip" : "192.0.2.0" ,
"restricted" : true ,
"status" : "successful" ,
"username" : "example_user"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A collection of successful logins for all users on the account during the last 90 days.
array
of objects
string<date-time>
When the login was initiated.
integer
The unique ID of this login object.
string<ip>
The remote IP address that requested the login.
boolean
True if the User that attempted the login was a restricted User, false otherwise.
stringEnum:
successful
failed
Whether the login attempt succeeded or failed.
string
The username of the User that attempted the login.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account login-view 1234
Response Samples
200
default
{
"datetime" : "2018-01-01T00:01:01" ,
"id" : 1234 ,
"ip" : "192.0.2.0" ,
"restricted" : true ,
"status" : "successful" ,
"username" : "example_user"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The requested login object.
string<date-time>
When the login was initiated.
integer
The unique ID of this login object.
string<ip>
The remote IP address that requested the login.
boolean
True if the User that attempted the login was a restricted User, false otherwise.
stringEnum:
successful
failed
Whether the login attempt succeeded or failed.
string
The username of the User that attempted the login.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account maintenance-list
Response Samples
200
default
{
"data" : [
{
"entity" : {
"id" : 1234 ,
"label" : "demo-linode" ,
"type" : "Linode" ,
"url" : "https://api.linode.com/v4/linode/instances/{linodeId}"
},
"reason" : "This maintenance will allow us to update the BIOS on the host's motherboard." ,
"status" : "started" ,
"type" : "reboot" ,
"when" : "2020-07-09T00:01:01"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of Maintenance objects.
array
of objects
object
The entity being affected by maintenance.
number
The id of the entity being affected by maintenance.
string
The label of the entity being affected by maintenance.
string
The type of entity.
string
The API endpoint prefix to use in combination with the entity id to find specific information about the entity.
string
The reason maintenance is being performed.
stringEnum:
completed
pending
started
The maintenance status.
Maintenance progresses in the following sequence: pending, started, then completed.
stringEnum:
reboot
cold_migration
live_migration
The type of maintenance.
string<date-time>
When the maintenance will begin.
Filterable with the following parameters:
A single value in date-time string format ("%Y-%m-%dT%H:%M:%S"), which returns only matches to that value.
A dictionary containing pairs of inequality operator string keys ("+or", “+gt”, “+gte”, “+lt”, “+lte”,
or “+neq”) and single date-time string format values ("%Y-%m-%dT%H:%M:%S"). “+or” accepts an array of values that
may consist of single date-time strings or dictionaries of inequality operator pairs.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account notifications-list
Response Samples
200
default
{
"data" : [
{
"body" : null ,
"entity" : {
"id" : 3456 ,
"label" : "Linode not booting." ,
"type" : "ticket" ,
"url" : "/support/tickets/3456"
},
"label" : "You have an important ticket open!" ,
"message" : "You have an important ticket open!" ,
"severity" : "major" ,
"type" : "ticket_important" ,
"until" : null ,
"when" : null
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of Notification objects.
array
of objects
string
A full description of this Notification, in markdown format. Not all Notifications include bodies.
object
Detailed information about the Notification.
integer
The unique ID of the Notification’s entity, based on the entity
type.
Returns null for the following entity types:
string
The current label for this Notification’s entity.
Returns null for the following entity types:
entity_transferpromotionregionstringEnum:
account
entity_transfer
linode
nodebalancer
promotion
region
ticket
volume
The type of entity this is related to.
string
The URL where you can access the object this Notification is for.
If a relative URL, it is relative to the domain you retrieved the
Notification from.
Returns null for the promotion entity type.
string
A short description of this Notification.
string
A human-readable description of the Notification.
stringEnum:
minor
major
critical
The severity of this Notification. This field can be used to decide how prominently to display the Notification, what color to make the display text, etc.
stringEnum:
migration_scheduled
migration_imminent
migration_pending
reboot_scheduled
outage
payment_due
ticket_important
ticket_abuse
notice
maintenance
promotion
The type of Notification this is.
string<date-time>
If this Notification has a duration, this will be the ending time for the Event/action. For example, if there is scheduled maintenance for one of our systems, until would be set to the end of the maintenance window.
string<date-time>
If this Notification is of an Event that will happen at a fixed, future time, this is when the named action will be taken. For example, if a Linode is to be migrated in response to a Security Advisory, this field will contain the approximate time the Linode will be taken offline for migration.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account clients-list
Response Samples
200
default
{
"data" : [
{
"id" : "2737bf16b39ab5d7b4a1" ,
"label" : "Test_Client_1" ,
"public" : false ,
"redirect_uri" : "https://example.org/oauth/callback" ,
"secret" : "<REDACTED>" ,
"status" : "active" ,
"thumbnail_url" : "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of OAuth Clients.
array
of objects
string
The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).
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.
booleanDefault:
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.
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.
string
The OAuth Client secret, used in the OAuth exchange. This is returned as <REDACTED> except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.
stringEnum:
active
disabled
suspended
The status of this application. active by default.
string<url>
The URL where this client’s thumbnail may be viewed, or null if this client does not have a thumbnail set.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"redirect_uri": "https://example.org/oauth/callback",
"label": "Test_Client_1",
"public": false
}' \
linode-cli account client-create \
\
Request Body Schema 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.
booleanDefault:
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.
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
200
default
{
"id" : "2737bf16b39ab5d7b4a1" ,
"label" : "Test_Client_1" ,
"public" : false ,
"redirect_uri" : "https://example.org/oauth/callback" ,
"secret" : "<REDACTED>" ,
"status" : "active" ,
"thumbnail_url" : "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Client created successfully.
string
The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).
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.
booleanDefault:
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.
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.
string
The OAuth Client secret, used in the OAuth exchange. This is returned as <REDACTED> except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.
stringEnum:
active
disabled
suspended
The status of this application. active by default.
string<url>
The URL where this client’s thumbnail may be viewed, or null if this client does not have a thumbnail set.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli account client-delete \
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Client deleted successfully.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account client-view \
Response Samples
200
default
{
"id" : "2737bf16b39ab5d7b4a1" ,
"label" : "Test_Client_1" ,
"public" : false ,
"redirect_uri" : "https://example.org/oauth/callback" ,
"secret" : "<REDACTED>" ,
"status" : "active" ,
"thumbnail_url" : "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Information about the requested client.
string
The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).
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.
booleanDefault:
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.
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.
string
The OAuth Client secret, used in the OAuth exchange. This is returned as <REDACTED> except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.
stringEnum:
active
disabled
suspended
The status of this application. active by default.
string<url>
The URL where this client’s thumbnail may be viewed, or null if this client does not have a thumbnail set.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"redirect_uri": "https://example.org/oauth/callback",
"label": "Test_Client_1"
}
}' \
linode-cli account client-update \
\
Request Body Schema 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.
booleanDefault:
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.
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
200
default
{
"id" : "2737bf16b39ab5d7b4a1" ,
"label" : "Test_Client_1" ,
"public" : false ,
"redirect_uri" : "https://example.org/oauth/callback" ,
"secret" : "<REDACTED>" ,
"status" : "active" ,
"thumbnail_url" : "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Client updated successfully.
string
The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).
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.
booleanDefault:
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.
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.
string
The OAuth Client secret, used in the OAuth exchange. This is returned as <REDACTED> except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.
stringEnum:
active
disabled
suspended
The status of this application. active by default.
string<url>
The URL where this client’s thumbnail may be viewed, or null if this client does not have a thumbnail set.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
\
linode-cli account client-reset-secret \
Response Samples
200
default
{
"id" : "2737bf16b39ab5d7b4a1" ,
"label" : "Test_Client_1" ,
"public" : false ,
"redirect_uri" : "https://example.org/oauth/callback" ,
"secret" : "<REDACTED>" ,
"status" : "active" ,
"thumbnail_url" : "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Client secret reset successfully.
string
The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).
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.
booleanDefault:
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.
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.
string
The OAuth Client secret, used in the OAuth exchange. This is returned as <REDACTED> except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.
stringEnum:
active
disabled
suspended
The status of this application. active by default.
string<url>
The URL where this client’s thumbnail may be viewed, or null if this client does not have a thumbnail set.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
curl -H "Content-Type: image/png" \
"Authorization: Bearer $TOKEN " \
\
"@/path/to/image"
https://api.linode.com/v4/account/oauth-clients/edc6790ea9db4d224c5c/thumbnail
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Thumbnail updated successfully.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
Payment Methods List GET
https://api.linode.com/v4/account/payment-methods
Returns a paginated list of Payment Methods for this Account.
Authorizations personalAccessToken oauth account:read_only
Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli payment-methods list
Response Samples
200
default
{
"data" : [
{
"created" : "2018-01-15T00:01:01" ,
"data" : {
"card_type" : "Discover" ,
"expiry" : "06/2022" ,
"last_four" : "1234"
},
"id" : 123 ,
"is_default" : true ,
"type" : "credit_card"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of Payment Method objects.
array
of objects
string<date-time>
When the Payment Method was added to the Account.
CreditCardData
GooglePayData
PayPalData
object
Credit card information.
string
The type of credit card.
string<MM/YYYY>
The expiration month and year of the credit card.
string
The last four digits of the credit card number.
object
Google Pay information.
string
The type of credit card.
string<MM/YYYY>
The expiration month and year of the credit card.
string
The last four digits of the credit card number.
object
PayPal information.
string
The email address associated with your PayPal account.
string
PayPal Merchant ID associated with your PayPal account.
integer
The unique ID of this Payment Method.
boolean
Whether this Payment Method is the default method for automatically processing service charges.
stringEnum:
credit_card
google_pay
paypal
The type of Payment Method.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"type": "credit_card",
"is_default": true,
"data": {
"card_number": "4111111111111111",
"expiry_month": 11,
"expiry_year": 2020,
"cvv": "111"
}
}' \
linode-cli payment-methods add \
\
true \
4111111111111111 \
11 \
2020 \
111
Request Body Schema object
An object representing the credit card information you have on file with
Linode to make Payments against your Account.
string<digits>
14..24
characters
Your credit card number. No spaces or hyphens (-) allowed.
string<digits>
3..4
characters
CVV (Card Verification Value) of the credit card, typically found on the back of the card.
integer
1..12
A value from 1-12 representing the expiration month of your credit card.
1 = January 2 = February 3 = March Etc. 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.
boolean
Whether this Payment Method is the default method for automatically processing service charges.
stringEnum:
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
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_only
Path Parameters paymentMethodId integer
Required The ID of the Payment Method to look up.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli payment-methods delete 123
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Payment Method deactivated.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
Payment Method View GET
https://api.linode.com/v4/account/payment-methods/{paymentMethodId}
View the details of the specified Payment Method.
Authorizations personalAccessToken oauth account:read_only
Path Parameters paymentMethodId integer
Required The ID of the Payment Method to look up.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli payment-methods view 123
Response Samples
200
default
{
"created" : "2018-01-15T00:01:01" ,
"data" : {
"card_type" : "Discover" ,
"expiry" : "06/2022" ,
"last_four" : "1234"
},
"id" : 123 ,
"is_default" : true ,
"type" : "credit_card"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a Payment Method Object.
string<date-time>
When the Payment Method was added to the Account.
CreditCardData
GooglePayData
PayPalData
object
Credit card information.
string
The type of credit card.
string<MM/YYYY>
The expiration month and year of the credit card.
string
The last four digits of the credit card number.
object
Google Pay information.
string
The type of credit card.
string<MM/YYYY>
The expiration month and year of the credit card.
string
The last four digits of the credit card number.
object
PayPal information.
string
The email address associated with your PayPal account.
string
PayPal Merchant ID associated with your PayPal account.
integer
The unique ID of this Payment Method.
boolean
Whether this Payment Method is the default method for automatically processing service charges.
stringEnum:
credit_card
google_pay
paypal
The type of Payment Method.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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.
Authorizations personalAccessToken oauth account:read_write
Path Parameters paymentMethodId integer
Required The ID of the Payment Method to make default.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli payment-methods default 123
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Payment Method successfully set as the default method.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account payments-list
Response Samples
200
default
{
"data" : [
{
"date" : "2018-01-15T00:01:01" ,
"id" : 123 ,
"usd" : "120.50"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of Payment objects.
array
of objects
string<date-time>
When the Payment was made.
integer
The unique ID of the Payment.
integer
The amount, in US dollars, of the Payment.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
Payment Make POST
https://api.linode.com/v4/account/payments
Makes a Payment to your Account.
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 oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"usd": "120.50",
"payment_method_id": 123
}' \
linode-cli account payment-create \
\
123
Request Body Schema integer
The ID of the Payment Method to apply to the Payment.
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
200
202
default
{
"date" : "2018-01-15T00:01:01" ,
"id" : 123 ,
"usd" : "120.50"
}
{
"warnings" : [
{
"details" : "Linode 123 could not be rebooted." ,
"title" : "Unable to reboot Linode."
}
]
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
202
default
Payment submitted successfully.
string<date-time>
When the Payment was made.
integer
The unique ID of the Payment.
integer
The amount, in US dollars, of the Payment.
Accepted with warning.
A warnings array is included with the standard 200 response body.
array
of objects
string
Specific information related to the warning.
string
The general warning message.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"usd": "120.50",
"redirect_url": "https://example.org",
"cancel_url": "https://example.org"
}' \
linode-cli account paypal-start \
\
\
Request Body Schema string
The URL to have PayPal redirect to when Payment is canceled.
string
The URL to have PayPal redirect to when Payment is approved.
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
200
299
default
{
"checkout_token" : "EC-1A2B3C4D5E6F7G8H9" ,
"payment_id" : "PAY-1234567890ABCDEFGHIJKLMN"
}
{
"warnings" : [
{
"details" : "Linode 123 could not be rebooted." ,
"title" : "Unable to reboot Linode."
}
]
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
299
default
PayPal Payment staged.
string
The checkout token generated for this Payment.
string
The paypal-generated ID for this Payment. Used when authorizing the Payment in PayPal’s interface.
Request successful. This endpoint is deprecated and may be removed in a future release.
A warnings array is included with the standard 200 response body.
array
of objects
string
Specific information related to the warning.
string
The general warning message.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"payment_id": "PAY-1234567890ABCDEFGHIJKLMN",
"payer_id": "ABCDEFGHIJKLM"
}' \
linode-cli account paypal-execute
Request Body Schema string
The PayerID returned by PayPal during the transaction authorization process.
string
The PaymentID returned from POST /account/payments/paypal that has been approved with PayPal.
Response Samples
200
202
299
default
{
"warnings" : [
{
"details" : "Linode 123 could not be rebooted." ,
"title" : "Unable to reboot Linode."
}
]
}
{
"warnings" : [
{
"details" : "Linode 123 could not be rebooted." ,
"title" : "Unable to reboot Linode."
}
]
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
202
299
default
Accepted with warning.
A warnings array is included with the standard 200 response body.
array
of objects
string
Specific information related to the warning.
string
The general warning message.
Request successful. This endpoint is deprecated and may be removed in a future release.
A warnings array is included with the standard 200 response body.
array
of objects
string
Specific information related to the warning.
string
The general warning message.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account payment-view 123
Response Samples
200
default
{
"date" : "2018-01-15T00:01:01" ,
"id" : 123 ,
"usd" : "120.50"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A Payment object.
string<date-time>
When the Payment was made.
integer
The unique ID of the Payment.
integer
The amount, in US dollars, of the Payment.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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. personalAccessToken oauth account:read_only
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"promo_code": "abcdefABCDEF1234567890"
}' \
linode-cli account \
\
Request Body Schema string
1..32
characters
The Promo Code.
200
default
{
"credit_monthly_cap" : "10.00" ,
"credit_remaining" : "50.00" ,
"description" : "Receive up to $10 off your services every month for 6 months! Unused credits will expire once this promotion period ends." ,
"expire_dt" : "2018-01-31T23:59:59" ,
"image_url" : "https://linode.com/10_a_month_promotion.svg" ,
"service_type" : "all" ,
"summary" : "$10 off your Linode a month!" ,
"this_month_credit_remaining" : "10.00"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
200
default
Promo Credit successfully added.
string
The amount available to spend per month.
string
The total amount of credit left for this promotion.
string
A detailed description of this promotion.
string
When this promotion’s credits expire.
string
The location of an image for this promotion.
stringEnum:
all
backup
blockstorage
db_mysql
ip_v4
linode
linode_disk
linode_memory
longview
managed
nodebalancer
objectstorage
transfer_tx
The service to which this promotion applies.
string
Short details of this promotion.
this_month_credit_remaining
string
The amount of credit left for this month for this promotion.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_only
Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli service-transfers \
Response Samples
200
default
{
"data" : [
{
"created" : "2021-02-11T16:37:03" ,
"entities" : {
"linodes" : [
111 ,
222
]
},
"expiry" : "2021-02-12T16:37:03" ,
"is_sender" : true ,
"status" : "pending" ,
"token" : "123E4567-E89B-12D3-A456-426614174000" ,
"updated" : "2021-02-11T16:37:03"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of Service Transfer objects containing the details of all transfers that have been created and accepted by this account.
array
of objects
string<date-time>
When this transfer was created.
object
A collection of the services to include in this transfer request, separated by type.
array
of integers
An array containing the IDs of each of the Linodes included in this transfer.
string<date-time>
When this transfer expires. Transfers will automatically expire 24 hours after creation.
boolean
If the requesting account created this transfer.
stringEnum:
accepted
canceled
completed
failed
pending
stale
The status of the transfer request.
accepted: The transfer has been accepted by another user and is currently in progress.
Transfers can take up to 3 hours to complete.
canceled: The transfer has been canceled by the sender.
completed: The transfer has completed successfully.
failed: The transfer has failed after initiation.
pending: The transfer is ready to be accepted.
stale: The transfer has exceeded its expiration date. It can no longer be accepted or
canceled.
string<uuid>
The token used to identify and accept or cancel this transfer.
string<date-time>
When this transfer was last updated.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 must be met in order to successfully create a transfer request:
The account creating the transfer must not have a past due balance or active Terms of Service violation.
The service must be owned by the account that is creating the transfer.
The service must not be assigned to another Service Transfer that is pending or that has been accepted and is
incomplete.
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.
Authorizations personalAccessToken oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"entities": {
"linodes": [
111,
222
]
}
}' \
linode-cli service-transfers \
\
111 \
222
Request Body Schema object
A collection of the services to include in this transfer request, separated by type.
array
of integers
An array containing the IDs of each of the Linodes included in this transfer.
Response Samples
200
default
{
"created" : "2021-02-11T16:37:03" ,
"entities" : {
"linodes" : [
111 ,
222
]
},
"expiry" : "2021-02-12T16:37:03" ,
"is_sender" : true ,
"status" : "pending" ,
"token" : "123E4567-E89B-12D3-A456-426614174000" ,
"updated" : "2021-02-11T16:37:03"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a Service Transfer object for the request.
string<date-time>
When this transfer was created.
object
A collection of the services to include in this transfer request, separated by type.
array
of integers
An array containing the IDs of each of the Linodes included in this transfer.
string<date-time>
When this transfer expires. Transfers will automatically expire 24 hours after creation.
boolean
If the requesting account created this transfer.
stringEnum:
accepted
canceled
completed
failed
pending
stale
The status of the transfer request.
accepted: The transfer has been accepted by another user and is currently in progress.
Transfers can take up to 3 hours to complete.
canceled: The transfer has been canceled by the sender.
completed: The transfer has completed successfully.
failed: The transfer has failed after initiation.
pending: The transfer is ready to be accepted.
stale: The transfer has exceeded its expiration date. It can no longer be accepted or
canceled.
string<uuid>
The token used to identify and accept or cancel this transfer.
string<date-time>
When this transfer was last updated.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Path Parameters token string<uuid>
Required The UUID of the Service Transfer.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli service-transfers \
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Service Transfer canceled.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_only
Path Parameters token string<uuid>
Required The UUID of the Service Transfer.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli service-transfers \
Response Samples
200
default
{
"created" : "2021-02-11T16:37:03" ,
"entities" : {
"linodes" : [
111 ,
222
]
},
"expiry" : "2021-02-12T16:37:03" ,
"is_sender" : true ,
"status" : "pending" ,
"token" : "123E4567-E89B-12D3-A456-426614174000" ,
"updated" : "2021-02-11T16:37:03"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a Service Transfer object containing the details of the transfer for the specified token.
string<date-time>
When this transfer was created.
object
A collection of the services to include in this transfer request, separated by type.
array
of integers
An array containing the IDs of each of the Linodes included in this transfer.
string<date-time>
When this transfer expires. Transfers will automatically expire 24 hours after creation.
boolean
If the requesting account created this transfer.
stringEnum:
accepted
canceled
completed
failed
pending
stale
The status of the transfer request.
accepted: The transfer has been accepted by another user and is currently in progress.
Transfers can take up to 3 hours to complete.
canceled: The transfer has been canceled by the sender.
completed: The transfer has completed successfully.
failed: The transfer has failed after initiation.
pending: The transfer is ready to be accepted.
stale: The transfer has exceeded its expiration date. It can no longer be accepted or
canceled.
string<uuid>
The token used to identify and accept or cancel this transfer.
string<date-time>
When this transfer was last updated.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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:
Only transfers with a pending status can be accepted.
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.
Both the account that created the transfer and the account that is accepting the transfer must not have any
active Terms of Service violations.
The service must still be owned by the account that created the transfer.
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 oauth account:read_write
Path Parameters token string<uuid>
Required The UUID of the Service Transfer.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli service-transfers \
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Service Transfer accepted.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account settings
Response Samples
200
default
{
"backups_enabled" : true ,
"longview_subscription" : "longview-3" ,
"managed" : true ,
"network_helper" : false ,
"object_storage" : "active"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a single Account settings object.
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.
string
The Longview Pro tier you are currently subscribed to. The value must be a Longview Subscription ID or null for Longview Free.
boolean
Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we’ll monitor it for connectivity, response, and total request time.
boolean
Enables network helper across all users by default for new Linodes and Linode Configs.
stringEnum:
disabled
suspended
active
Default:
disabled
A string describing the status of this account’s Object Storage service enrollment.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"network_helper": true
}' \
linode-cli account settings-update \
false
Request Body Schema 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.
boolean
Enables network helper across all users by default for new Linodes and Linode Configs.
Response Samples
200
default
{
"backups_enabled" : true ,
"longview_subscription" : "longview-3" ,
"managed" : true ,
"network_helper" : false ,
"object_storage" : "active"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The updated Account settings.
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.
string
The Longview Pro tier you are currently subscribed to. The value must be a Longview Subscription ID or null for Longview Free.
boolean
Our 24/7 incident response service. This robust, multi-homed monitoring system distributes monitoring checks to ensure that your servers remain online and available at all times. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. Once you add a service to Linode Managed, we’ll monitor it for connectivity, response, and total request time.
boolean
Enables network helper across all users by default for new Linodes and Linode Configs.
stringEnum:
disabled
suspended
active
Default:
disabled
A string describing the status of this account’s Object Storage service enrollment.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli account enable-managed
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Managed services enabled for account.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli account transfer
Response Samples
200
default
{
"billable" : 0 ,
"quota" : 9141 ,
"region_transfers" : [
{
"billable" : 0 ,
"id" : "us-east" ,
"quota" : 5010 ,
"used" : 1
}
],
"used" : 2
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a single Transfer object.
integer
The amount of your transfer pool that is billable this billing cycle.
integer
The amount of network usage allowed this billing cycle.
array
of objects
integer
The amount of your transfer pool that is billable this billing cycle for this Region.
string
The Region ID for this network utilization data.
integer
The amount of network usage allowed this billing cycle for this Region.
integer
The amount of network usage you have used this billing cycle for this Region.
integer
The amount of network usage you have used this billing cycle.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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:
Authorizations personalAccessToken oauth account:read_only
Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
default
{
"data" : [
{
"email" : "example_user@linode.com" ,
"last_login" : {
"login_datetime" : "2018-01-01T01:01:01" ,
"status" : "successful"
},
"password_created" : "2018-01-01T01:01:01" ,
"restricted" : true ,
"ssh_keys" : [
"home-pc" ,
"laptop"
],
"tfa_enabled" : true ,
"user_type" : "parent" ,
"username" : "example_user" ,
"verified_phone_number" : "+5555555555"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of users.
array
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.
object
Information for the most recent login attempt for this User.
null if no login attempts have been made since creation of this User.
Access the User Logins List All command for additional login information.
string<date-time>
The date and time of this User’s most recent login attempt.
stringEnum:
successful
failed
The result of the most recent login attempt for this User.
string<date-time>
The date and time when this User’s current password was created.
User passwords are first created during the Account sign-up process, and updated using the Reset Password webpage.
null if this User has not created a password yet.
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.
array
of strings
A list of SSH Key labels added by this User.
Users can add keys with the SSH Key Add (POST /profile/sshkeys ) command.
These keys are deployed when this User is included in the authorized_users
field of the following requests:
boolean
A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. See the Create Two Factor Secret (POST /profile/tfa-enable ) endpoint to enable TFA.
stringEnum:
parent
child
proxy
default
If the user belongs to a parent or child account relationship, this defines the user type in the respective account. Possible values include:
parent. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don’t have access to manage child accounts, but they can be granted this access by an admin user.
child. This is an Akamai partner’s end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.
proxy. This is a user on a child account that gives parent account users access to that child account. A parent account user with the child_account_access grant can create a bearer token from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.
default. This applies to all regular, non-parent-child account users.
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).
verified_phone_number
Nullable
string<phone>
The phone number verified for this User Profile with the Phone Number Verify (POST /profile/phone-number/verify ) command.
null if this User Profile has no verified phone number.
integer
The current page .
integer
The total number of pages .
integer
The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"username": "example_user",
"email": "person@place.com",
"restricted": true
}' \
linode-cli users create \
\
\
true
Request Body Schema 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.
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.
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
200
default
{
"email" : "example_user@linode.com" ,
"last_login" : {
"login_datetime" : "2018-01-01T01:01:01" ,
"status" : "successful"
},
"password_created" : "2018-01-01T01:01:01" ,
"restricted" : true ,
"ssh_keys" : [
"home-pc" ,
"laptop"
],
"tfa_enabled" : true ,
"username" : "example_user" ,
"verified_phone_number" : "+5555555555"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
New User created successfully.
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.
object
Information for the most recent login attempt for this User.
null if no login attempts have been made since creation of this User.
Access the User Logins List All command for additional login information.
string<date-time>
The date and time of this User’s most recent login attempt.
stringEnum:
successful
failed
The result of the most recent login attempt for this User.
string<date-time>
The date and time when this User’s current password was created.
User passwords are first created during the Account sign-up process, and updated using the Reset Password webpage.
null if this User has not created a password yet.
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.
array
of strings
A list of SSH Key labels added by this User.
Users can add keys with the SSH Key Add (POST /profile/sshkeys ) command.
These keys are deployed when this User is included in the authorized_users
field of the following requests:
boolean
A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. See the Create Two Factor Secret (POST /profile/tfa-enable ) endpoint to enable TFA.
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).
verified_phone_number
Nullable
string<phone>
The phone number verified for this User Profile with the Phone Number Verify (POST /profile/phone-number/verify ) command.
null if this User Profile has no verified phone number.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Path Parameters username string
Required The username to look up.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli users delete example_user
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
User deleted successfully.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_only
Path Parameters username string
Required The username to look up.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli users view example_user
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The requested User object
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Path Parameters username string
Required The username to look up.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"username": example_user,
"email": example@linode.com,
"restricted": true
}' \
linode-cli users update example_user \
\
\
true
Request Body Schema 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.
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.
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
200
default
{
"email" : "example_user@linode.com" ,
"last_login" : {
"login_datetime" : "2018-01-01T01:01:01" ,
"status" : "successful"
},
"password_created" : "2018-01-01T01:01:01" ,
"restricted" : true ,
"ssh_keys" : [
"home-pc" ,
"laptop"
],
"tfa_enabled" : true ,
"user_type" : "parent" ,
"username" : "example_user" ,
"verified_phone_number" : "+5555555555"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
User updated successfully.
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.
object
Information for the most recent login attempt for this User.
null if no login attempts have been made since creation of this User.
Access the User Logins List All command for additional login information.
string<date-time>
The date and time of this User’s most recent login attempt.
stringEnum:
successful
failed
The result of the most recent login attempt for this User.
string<date-time>
The date and time when this User’s current password was created.
User passwords are first created during the Account sign-up process, and updated using the Reset Password webpage.
null if this User has not created a password yet.
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.
array
of strings
A list of SSH Key labels added by this User.
Users can add keys with the SSH Key Add (POST /profile/sshkeys ) command.
These keys are deployed when this User is included in the authorized_users
field of the following requests:
boolean
A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. See the Create Two Factor Secret (POST /profile/tfa-enable ) endpoint to enable TFA.
stringEnum:
parent
child
proxy
default
If the user belongs to a parent or child account relationship, this defines the user type in the respective account. Possible values include:
parent. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don’t have access to manage child accounts, but they can be granted this access by an admin user.
child. This is an Akamai partner’s end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.
proxy. This is a user on a child account that gives parent account users access to that child account. A parent account user with the child_account_access grant can create a bearer token from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.
default. This applies to all regular, non-parent-child account users.
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).
verified_phone_number
Nullable
string<phone>
The phone number verified for this User Profile with the Phone Number Verify (POST /profile/phone-number/verify ) command.
null if this User Profile has no verified phone number.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_only
Path Parameters username string
Required The username to look up.
Request Samples
Shell
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
204
default
{
"database" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"domain" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"global" : {
"account_access" : "read_only" ,
"add_databases" : true ,
"add_domains" : true ,
"add_firewalls" : true ,
"add_images" : true ,
"add_linodes" : true ,
"add_longview" : true ,
"add_nodebalancers" : true ,
"add_stackscripts" : true ,
"add_volumes" : true ,
"add_vpcs" : true ,
"cancel_account" : false ,
"child_account_access" : true ,
"longview_subscription" : true
},
"image" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"linode" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"longview" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"nodebalancer" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"stackscript" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"volume" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"vpc" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
]
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
204
default
The User's grants.
array
of objects
The grants this User has for each Database that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Domain that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
object
A structure containing the Account-level grants a User has.
stringEnum:
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.
boolean
If true, this User may add Managed Databases.
boolean
If true, this User may add Domains.
boolean
If true, this User may add Firewalls.
boolean
If true, this User may add Images.
boolean
If true, this User may create Linodes.
boolean
If true, this User may create Longview clients and view the current plan.
boolean
If true, this User may add NodeBalancers.
boolean
If true, this User may add StackScripts.
boolean
If true, this User may add Volumes.
boolean
If true, this User may add VPCs.
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.
boolean
If true, this User may manage the Account’s Longview subscription.
array
of objects
The grants this User has for each Image that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Linode that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Longview Client that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each NodeBalancer that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each StackScript that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Block Storage Volume that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each VPC that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
This is an unrestricted User, and therefore has no grants to return. This User may access everything on the Account and perform all actions.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
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 oauth account:read_write
Path Parameters username string
Required The username to look up.
Request Samples
Shell
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"global": {
"add_linodes": true,
"add_nodebalancers": false,
"add_databases": true,
"add_domains": true,
"add_longview": false,
"add_stackscripts": true,
"longview_subscription": true,
"add_images": true,
"add_volumes": true,
"add_firewalls": true,
"account_access": "read_only",
"cancel_account": false,
"add_vpcs": true
},
"domain": [
{
"id": 123,
"permissions": "read_only"
}
],
"image": [
{
"id": 123,
"permissions": "read_only"
}
],
"linode": [
{
"id": 123,
"permissions": "read_only"
},
{
"id": 234,
"permissions": "read_write"
},
{
"id": 345,
"permissions": "read_only"
}
],
"longview": [
{
"id": 123,
"permissions": "read_only"
},
{
"id": 234,
"permissions": "read_write"
}
],
"nodebalancer": [
{
"id": 123,
"permissions": "read_write"
}
],
"stackscript": [
{
"id": 123,
"permissions": "read_only"
},
{
"id": 124,
"permissions": "read_write"
}
],
"volume": [
{
"id": 123,
"permissions": "read_only"
}
],
"vpc": [
{
"id": 123,
"permissions": "read_write"
}
]
}' \
Request Body Schema array
of objects
The grants this User has for each Database that is owned by this Account.
integer
The ID of the entity this grant applies to.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Domain that is owned by this Account.
integer
The ID of the entity this grant applies to.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
object
A structure containing the Account-level grants a User has.
stringEnum:
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.
boolean
If true, this User may add Managed Databases.
boolean
If true, this User may add Domains.
boolean
If true, this User may add Firewalls.
boolean
If true, this User may add Images.
boolean
If true, this User may create Linodes.
boolean
If true, this User may create Longview clients and view the current plan.
boolean
If true, this User may add NodeBalancers.
boolean
If true, this User may add StackScripts.
boolean
If true, this User may add Volumes.
boolean
If true, this User may add VPCs.
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.
boolean
If true, this User may manage the Account’s Longview subscription.
array
of objects
The grants this User has for each Image that is owned by this Account.
integer
The ID of the entity this grant applies to.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Linode that is owned by this Account.
integer
The ID of the entity this grant applies to.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Longview Client that is owned by this Account.
integer
The ID of the entity this grant applies to.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each NodeBalancer that is owned by this Account.
integer
The ID of the entity this grant applies to.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each StackScript that is owned by this Account.
integer
The ID of the entity this grant applies to.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Block Storage Volume that is owned by this Account.
integer
The ID of the entity this grant applies to.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each VPC that is owned by this Account.
integer
The ID of the entity this grant applies to.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
Response Samples
200
default
{
"database" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"domain" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"global" : {
"account_access" : "read_only" ,
"add_databases" : true ,
"add_domains" : true ,
"add_firewalls" : true ,
"add_images" : true ,
"add_linodes" : true ,
"add_longview" : true ,
"add_nodebalancers" : true ,
"add_stackscripts" : true ,
"add_volumes" : true ,
"add_vpcs" : true ,
"cancel_account" : false ,
"child_account_access" : true ,
"longview_subscription" : true
},
"image" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"linode" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"longview" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"nodebalancer" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"stackscript" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"volume" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
],
"vpc" : [
{
"id" : 123 ,
"label" : "example-entity" ,
"permissions" : "read_only"
}
]
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Grants updated successfully.
array
of objects
The grants this User has for each Database that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Domain that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
object
A structure containing the Account-level grants a User has.
stringEnum:
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.
boolean
If true, this User may add Managed Databases.
boolean
If true, this User may add Domains.
boolean
If true, this User may add Firewalls.
boolean
If true, this User may add Images.
boolean
If true, this User may create Linodes.
boolean
If true, this User may create Longview clients and view the current plan.
boolean
If true, this User may add NodeBalancers.
boolean
If true, this User may add StackScripts.
boolean
If true, this User may add Volumes.
boolean
If true, this User may add VPCs.
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.
boolean
If true, this User may manage the Account’s Longview subscription.
array
of objects
The grants this User has for each Image that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Linode that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Longview Client that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each NodeBalancer that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each StackScript that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each Block Storage Volume that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
array
of objects
The grants this User has for each VPC that is owned by this Account.
integer
The ID of the entity this grant applies to.
string
The current label of the entity this grant applies to, for display purposes.
stringEnum:
read_only
read_write
The level of access this User has to this entity. If null, this User has no access.
Error
array
of objects
string
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as “null” if the error is not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
