Longview
v4.83.1 Longview Clients List GET
https://api.linode.com/v4/longview/clients
Returns a paginated list of Longview Clients you have access to. Longview Client is used to monitor stats on your Linode with the help of the Longview Client application.
Authorizations personalAccessToken oauth longview:read_only
Query Parameters page Type: integer
>= 1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..100Default:
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" : [
{
"api_key" : "BD1B4B54-D752-A76D-5A9BD8A17F39DB61" ,
"apps" : {
"apache" : true ,
"mysql" : true ,
"nginx" : false
},
"created" : "2018-01-01T00:01:01" ,
"id" : 789 ,
"install_code" : "BD1B5605-BF5E-D385-BA07AD518BE7F321" ,
"label" : "client789" ,
"updated" : "2018-01-01T00:01:01"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of Longview Clients.
array of objects
string
The API key for this Client, used when configuring the Longview Client application on your Linode.
object
The apps this Client is monitoring on your Linode. This is configured when you install the Longview Client application, and is present here for information purposes only.
boolean
If True, the Apache Longview Client module is monitoring Apache on your server.
boolean
If True, the MySQL Longview Client modules is monitoring MySQL on your server.
boolean
If True, the Nginx Longview Client module is monitoring Nginx on your server.
string <date-time>
When this Longview Client was created.
integer
This Client’s unique ID.
string
The install code for this Client, used when configuring the Longview Client application on your Linode.
string
3..32
characters
This Client’s unique label. This is for display purposes only.
string <date-time>
When this Longview Client was last updated.
integer
integer
integer
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.
Longview Client Create POST
https://api.linode.com/v4/longview/clients
Creates a Longview Client. This Client will not begin monitoring the status of your server until you configure the Longview Client application on your Linode using the returning install_code and api_key.
Authorizations personalAccessToken oauth longview:read_write
Request Body Schema string
3..32
characters
This Client’s unique label. This is for display purposes only.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"label": "client789"
}' \
linode-cli longview create \
Response Samples
200
default
{
"api_key" : "BD1B4B54-D752-A76D-5A9BD8A17F39DB61" ,
"apps" : {
"apache" : true ,
"mysql" : true ,
"nginx" : false
},
"created" : "2018-01-01T00:01:01" ,
"id" : 789 ,
"install_code" : "BD1B5605-BF5E-D385-BA07AD518BE7F321" ,
"label" : "client789" ,
"updated" : "2018-01-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Longview Client created successfully.
string
The API key for this Client, used when configuring the Longview Client application on your Linode.
object
The apps this Client is monitoring on your Linode. This is configured when you install the Longview Client application, and is present here for information purposes only.
boolean
If True, the Apache Longview Client module is monitoring Apache on your server.
boolean
If True, the MySQL Longview Client modules is monitoring MySQL on your server.
boolean
If True, the Nginx Longview Client module is monitoring Nginx on your server.
string <date-time>
When this Longview Client was created.
integer
This Client’s unique ID.
string
The install code for this Client, used when configuring the Longview Client application on your Linode.
string
3..32
characters
This Client’s unique label. This is for display purposes only.
string <date-time>
When this Longview Client 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.
Longview Client Delete DELETE
https://api.linode.com/v4/longview/clients/{clientId}
Deletes a Longview Client from your Account.
All information stored for this client will be lost.
This does not uninstall the Longview Client application for your Linode - you must do that manually.
Authorizations personalAccessToken oauth longview:read_write
Path Parameters clientId integer
Required The Longview Client ID to access.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli longview delete 789
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Longview 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.
Longview Client View GET
https://api.linode.com/v4/longview/clients/{clientId}
Returns a single Longview Client you can access.
Authorizations personalAccessToken oauth longview:read_only
Path Parameters clientId integer
Required The Longview Client ID to access.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli longview view 789
Response Samples
200
default
{
"api_key" : "BD1B4B54-D752-A76D-5A9BD8A17F39DB61" ,
"apps" : {
"apache" : true ,
"mysql" : true ,
"nginx" : false
},
"created" : "2018-01-01T00:01:01" ,
"id" : 789 ,
"install_code" : "BD1B5605-BF5E-D385-BA07AD518BE7F321" ,
"label" : "client789" ,
"updated" : "2018-01-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The requested Longview Client.
string
The API key for this Client, used when configuring the Longview Client application on your Linode.
object
The apps this Client is monitoring on your Linode. This is configured when you install the Longview Client application, and is present here for information purposes only.
boolean
If True, the Apache Longview Client module is monitoring Apache on your server.
boolean
If True, the MySQL Longview Client modules is monitoring MySQL on your server.
boolean
If True, the Nginx Longview Client module is monitoring Nginx on your server.
string <date-time>
When this Longview Client was created.
integer
This Client’s unique ID.
string
The install code for this Client, used when configuring the Longview Client application on your Linode.
string
3..32
characters
This Client’s unique label. This is for display purposes only.
string <date-time>
When this Longview Client 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.
Longview Client Update PUT
https://api.linode.com/v4/longview/clients/{clientId}
Updates a Longview Client. This cannot update how it monitors your server; use the Longview Client application on your Linode for monitoring configuration.
Authorizations personalAccessToken oauth longview:read_write
Path Parameters clientId integer
Required The Longview Client ID to access.
Request Body Schema string
3..32
characters
This Client’s unique label. This is for display purposes only.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"label": "client789"
}' \
linode-cli longview update 789 \
Response Samples
200
default
{
"api_key" : "BD1B4B54-D752-A76D-5A9BD8A17F39DB61" ,
"apps" : {
"apache" : true ,
"mysql" : true ,
"nginx" : false
},
"created" : "2018-01-01T00:01:01" ,
"id" : 789 ,
"install_code" : "BD1B5605-BF5E-D385-BA07AD518BE7F321" ,
"label" : "client789" ,
"updated" : "2018-01-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Longview Client updated successfully.
string
The API key for this Client, used when configuring the Longview Client application on your Linode.
object
The apps this Client is monitoring on your Linode. This is configured when you install the Longview Client application, and is present here for information purposes only.
boolean
If True, the Apache Longview Client module is monitoring Apache on your server.
boolean
If True, the MySQL Longview Client modules is monitoring MySQL on your server.
boolean
If True, the Nginx Longview Client module is monitoring Nginx on your server.
string <date-time>
When this Longview Client was created.
integer
This Client’s unique ID.
string
The install code for this Client, used when configuring the Longview Client application on your Linode.
string
3..32
characters
This Client’s unique label. This is for display purposes only.
string <date-time>
When this Longview Client 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.
Longview Plan View GET
https://api.linode.com/v4/longview/plan
Get the details of your current Longview plan. This returns a LongviewSubscription object for your current Longview Pro plan, or an empty set {} if your current plan is Longview Free.
You must have at least one of the following global
User Grants in order to access this endpoint:
"account_access": read_write"account_access": read_only"longview_subscription": true"add_longview": trueTo update your subscription plan, send a request to
Update Longview Plan .
Authorizations personalAccessToken oauth longview:read_only
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli longview plan-view
Response Samples
200
default
{
"clients_included" : 10 ,
"id" : "longview-10" ,
"label" : "Longview Pro 10 pack" ,
"price" : {
"hourly" : 0.06 ,
"monthly" : 40
}
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The Longview plan details for this account.
integer
The number of Longview Clients that may be created with this Subscription tier.
stringEnum:
longview-3
longview-10
longview-40
longview-100
The unique ID of this Subscription tier.
string
A display name for this Subscription tier.
object
Pricing information about this Subscription tier.
number
The hourly price, in US dollars, for this Subscription tier.
number
The maximum monthly price in US Dollars for this Subscription tier. You will never be charged more than this amount per month for this subscription.
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.
Longview Plan Update PUT
https://api.linode.com/v4/longview/plan
Update your Longview plan to that of the given subcription ID. This returns a LongviewSubscription object for the updated Longview Pro plan, or an empty set {} if the updated plan is Longview Free.
You must have "longview_subscription": true configured as a global
User Grant in order to access this endpoint.
You can send a request to the
List Longview Subscriptions endpoint to receive the details, including id’s, of each plan.
Authorizations personalAccessToken oauth longview:read_write
Request Body Schema longview_subscription
Nullable
stringEnum:
longview-3
longview-10
longview-40
longview-100
The subscription ID for a particular Longview plan. A value of null corresponds to Longview Free.
You can send a request to the
List Longview Subscriptions endpoint to receive the details of each plan.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"longview_subscription": "longview-10"
}' \
linode-cli longview plan-update --longview_subscription longview-10
Response Samples
200
default
{
"clients_included" : 10 ,
"id" : "longview-10" ,
"label" : "Longview Pro 10 pack" ,
"price" : {
"hourly" : 0.06 ,
"monthly" : 40
}
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The updated Longview plan details for this account.
integer
The number of Longview Clients that may be created with this Subscription tier.
stringEnum:
longview-3
longview-10
longview-40
longview-100
The unique ID of this Subscription tier.
string
A display name for this Subscription tier.
object
Pricing information about this Subscription tier.
number
The hourly price, in US dollars, for this Subscription tier.
number
The maximum monthly price in US Dollars for this Subscription tier. You will never be charged more than this amount per month for this subscription.
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.
Longview Subscriptions List GET
https://api.linode.com/v4/longview/subscriptions
Returns a paginated list of available Longview Subscriptions. This is a public endpoint and requires no authentication.
Authorizations Query Parameters page Type: integer
>= 1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..100Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli longview subscriptions-list
Response Samples
200
default
{
"data" : [
{
"clients_included" : 10 ,
"id" : "longview-10" ,
"label" : "Longview Pro 10 pack" ,
"price" : {
"hourly" : 0.06 ,
"monthly" : 40
}
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of Longview Subscriptions.
array of objects
integer
The number of Longview Clients that may be created with this Subscription tier.
stringEnum:
longview-3
longview-10
longview-40
longview-100
The unique ID of this Subscription tier.
string
A display name for this Subscription tier.
object
Pricing information about this Subscription tier.
number
The hourly price, in US dollars, for this Subscription tier.
number
The maximum monthly price in US Dollars for this Subscription tier. You will never be charged more than this amount per month for this subscription.
integer
integer
integer
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.
Longview Subscription View GET
https://api.linode.com/v4/longview/subscriptions/{subscriptionId}
Get the Longview plan details as a single LongviewSubscription object for the provided subscription ID. This is a public endpoint and requires no authentication.
Authorizations Path Parameters subscriptionId string
Required The Longview Subscription to look up.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli longview subscription-view \
Response Samples
200
default
{
"clients_included" : 10 ,
"id" : "longview-10" ,
"label" : "Longview Pro 10 pack" ,
"price" : {
"hourly" : 0.06 ,
"monthly" : 40
}
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The requested Longview Subscription details.
integer
The number of Longview Clients that may be created with this Subscription tier.
stringEnum:
longview-3
longview-10
longview-40
longview-100
The unique ID of this Subscription tier.
string
A display name for this Subscription tier.
object
Pricing information about this Subscription tier.
number
The hourly price, in US dollars, for this Subscription tier.
number
The maximum monthly price in US Dollars for this Subscription tier. You will never be charged more than this amount per month for this subscription.
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.
