Longview

View Longview Client

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

Returns a single Longview Client you can access.

Authorizations

Personal Access Token
OAuth: ( longview:read_only)

Path Parameters

clientId
Required
integer

The Longview Client ID to access.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/longview/clients/789

Response Samples

{
  "id": 1234,
  "created": "2018-01-01T00:01:01.000Z",
  "label": "client789",
  "updated": "2018-01-01T00:01:01.000Z",
  "api_key": "BD1B4B54-D752-A76D-5A9BD8A17F39DB61",
  "install_code": "BD1B5605-BF5E-D385-BA07AD518BE7F321",
  "apps": [
    {
      "apache": true,
      "nginx": "",
      "mysql": true
    }
  ]
}

Responses

200: The requested Longview Client.

id
integer

This Client's unique ID.

created
string <date-time>

When this Longview Client was created.

label
Filterable
string [3 .. 32] characters [a-zA-Z0-9-_]{3,32}

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

updated
string <date-time>

When this Longview Client was last updated.

api_key
string

The API key for this Client, used when configuring the Longview Client application on your Linode.

install_code
string

The install code for this Client, used when configuring the Longview Client application on your Linode.

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

apache
boolean

If True, the Apache Longview Client module is monitoring Apache on your server.

nginx
boolean

If True, the Nginx Longview Client module is monitoring Nginx on your server.

mysql
boolean

If True, the MySQL Longview Client modules is monitoring MySQL on your server.

default: Error

errors
array of objects
reason
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.

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

Update Longview Client

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

Personal Access Token
OAuth: ( longview:read_write)

Path Parameters

clientId
Required
integer

The Longview Client ID to access.

Request Body Schema

label
Filterable
string [3 .. 32] characters [a-zA-Z0-9-_]{3,32}

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

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
      "label": "client789"
    }' \
    https://api.linode.com/v4/longview/clients/789

Response Samples

{
  "id": 1234,
  "label": "client789",
  "created": "2018-01-01T00:01:01.000Z",
  "updated": "2018-01-01T00:01:01.000Z",
  "api_key": "BD1B4B54-D752-A76D-5A9BD8A17F39DB61",
  "install_code": "BD1B5605-BF5E-D385-BA07AD518BE7F321",
  "apps": [
    {
      "apache": true,
      "nginx": "",
      "mysql": true
    }
  ]
}

Responses

200: Longview Client updated successfully.

id
integer

This Client's unique ID.

label
Filterable
string [3 .. 32] characters [a-zA-Z0-9-_]{3,32}

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

created
string <date-time>

When this Longview Client was created.

updated
string <date-time>

When this Longview Client was last updated.

api_key
string

The API key for this Client, used when configuring the Longview Client application on your Linode.

install_code
string

The install code for this Client, used when configuring the Longview Client application on your Linode.

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

apache
boolean

If True, the Apache Longview Client module is monitoring Apache on your server.

nginx
boolean

If True, the Nginx Longview Client module is monitoring Nginx on your server.

mysql
boolean

If True, the MySQL Longview Client modules is monitoring MySQL on your server.

default: Error

errors
array of objects
reason
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.

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

Delete Longview Client

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

Personal Access Token
OAuth: ( longview:read_write)

Path Parameters

clientId
Required
integer

The Longview Client ID to access.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    -X DELETE \
    https://api.linode.com/v4/longview/clients/789

Response Samples

{}

Responses

200: Longview Client deleted successfully.

default: Error

errors
array of objects
reason
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.

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