Longview v4.174.0

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
oauthlongview:read_only

Query Parameters

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

The page of a collection to return.

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

The number of items to return per page.

Request Samples

Response Samples

Responses

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
oauthlongview:read_write

Request Samples

Request Body Schema

label
[string] 3..32 characters

This Client’s unique label. This is for display purposes only.

Response Samples

Responses

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
oauthlongview:read_write

Path Parameters

clientId[integer]
Required

The Longview Client ID to access.

Request Samples

Response Samples

Responses

Longview Client View

GET https://api.linode.com/v4/longview/clients/{clientId}

Returns a single Longview Client you can access.

Authorizations

personalAccessToken
oauthlongview:read_only

Path Parameters

clientId[integer]
Required

The Longview Client ID to access.

Request Samples

Response Samples

Responses

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
oauthlongview:read_write

Path Parameters

clientId[integer]
Required

The Longview Client ID to access.

Request Samples

Request Body Schema

label
[string] 3..32 characters

This Client’s unique label. This is for display purposes only.

Response Samples

Responses

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": true

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

Authorizations

personalAccessToken
oauthlongview:read_only

Request Samples

Response Samples

Responses

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
oauthlongview:read_write

Request Samples

Request Body Schema

longview_subscription
Nullable
[string]
Enum: 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.

Response Samples

Responses

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] >= 1
Default: 1
Default:
1

The page of a collection to return.

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

The number of items to return per page.

Request Samples

Response Samples

Responses

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

Response Samples

Responses