clients

Creates, updates, deletes, gets or lists a clients resource.

Overview

Name	clients
Type	Resource
Id	linode.longview.clients

Fields

The following fields are returned by SELECT queries:

get_longview_client

The requested Longview Client.

Name	Datatype	Description
id	integer	Read-only This Client's unique ID.
api_key	string	Read-only The API key for this Client, used when configuring the Longview Client application on your Linode. Returns as [REDACTED] if you do not have read-write access to this client. (example: BD1B4B54-D752-A76D-5A9BD8A17F39DB61)
apps	object	Read-only 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.
created	string (date-time)	Read-only When this Longview Client was created. (example: 2018-01-01T00:01:01)
install_code	string	Read-only The install code for this Client, used when configuring the Longview Client application on your Linode. Returns as [REDACTED] if you do not have read-write access to this client. (example: BD1B5605-BF5E-D385-BA07AD518BE7F321)
label	string	Filterable This Client's unique label. This is for display purposes only. (example: client789, pattern: [a-zA-Z0-9-_]{3,32})
updated	string (date-time)	Read-only When this Longview Client was last updated. (example: 2018-01-01T00:01:01)

get_longview_clients

A paginated list of Longview Clients.

Name	Datatype	Description
data	array
page	integer	Read-only The current page.
pages	integer	Read-only The total number of pages.
results	integer	Read-only The total number of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_longview_client	select			Returns a single Longview Client you can access. Learn more... Learn more...
get_longview_clients	select		page, page_size	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. Learn more... Learn more...
post_longview_client	insert			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. Learn more... Learn more...
put_longview_client	replace			Updates a Longview Client. This cannot update how it monitors your server; use the Longview Client application on your Linode for monitoring configuration. Learn more... Learn more...
delete_longview_client	delete			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. Learn more... Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
page	integer	The page of a collection to return.
page_size	integer	The number of items to return per page.

SELECT examples

get_longview_client

Returns a single Longview Client you can access.

Learn more...

Learn more...

SELECT
id,
api_key,
apps,
created,
install_code,
label,
updated
FROM linode.longview.clients;

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

Learn more...

Learn more...

SELECT
data,
page,
pages,
results
FROM linode.longview.clients
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';

INSERT examples

post_longview_client

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.

Learn more...

Learn more...

INSERT INTO linode.longview.clients (
data__label
)
SELECT 
'{{ label }}'
RETURNING
id,
api_key,
apps,
created,
install_code,
label,
updated
;

Manifest

# Description fields are for documentation purposes
- name: clients
  props:
    - name: label
      value: string
      description: >
        __Filterable__ This Client's unique label. This is for display purposes only.
        

REPLACE examples

put_longview_client

Updates a Longview Client. This cannot update how it monitors your server; use the Longview Client application on your Linode for monitoring configuration.

Learn more...

Learn more...

REPLACE linode.longview.clients
SET 
data__label = '{{ label }}'
WHERE 

RETURNING
id,
api_key,
apps,
created,
install_code,
label,
updated;

DELETE examples

delete_longview_client

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.

Learn more...

Learn more...

DELETE FROM linode.longview.clients;