contacts

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

Overview

Name	contacts
Type	Resource
Id	linode.managed.contacts

Fields

The following fields are returned by SELECT queries:

get_managed_contact

The requested Managed Contact.

Name	Datatype	Description
id	integer	Read-only This Contact's unique ID.
name	string	The name of this Contact. (example: John Doe, pattern: [a-zA-Z0-9-_ ]{2,64})
email	string (email)	The address to email this Contact to alert them of issues. (example: john.doe@example.org)
group	string	Filterable A grouping for this Contact. This is for display purposes only. (example: on-call)
phone	object	Information about how to reach this Contact by phone.
updated	string (date-time)	Read-only When this Contact was last updated. (example: 2018-01-01T00:01:01)

get_managed_contacts

A paginated list of ManagedContacts.

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_managed_contact	select			Returns a single Managed Contact. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
get_managed_contacts	select		page, page_size	Returns a paginated list of Managed Contacts on your Account. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
post_managed_contact	insert			Creates a Managed Contact. A Managed Contact is someone Linode special forces can contact in the course of attempting to resolve an issue with a Managed Service. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
put_managed_contact	replace			Updates information about a Managed Contact. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
delete_managed_contact	delete			Deletes a Managed Contact. This operation can only be accessed by the unrestricted users of an account. 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_managed_contact

Returns a single Managed Contact.

This operation can only be accessed by the unrestricted users of an account.

Learn more...

Learn more...

SELECT
id,
name,
email,
group,
phone,
updated
FROM linode.managed.contacts;

get_managed_contacts

Returns a paginated list of Managed Contacts on your Account.

This operation can only be accessed by the unrestricted users of an account.

Learn more...

Learn more...

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

INSERT examples

post_managed_contact

Creates a Managed Contact. A Managed Contact is someone Linode special forces can contact in the course of attempting to resolve an issue with a Managed Service.

This operation can only be accessed by the unrestricted users of an account.

Learn more...

Learn more...

INSERT INTO linode.managed.contacts (
data__email,
data__group,
data__name,
data__phone
)
SELECT 
'{{ email }}',
'{{ group }}',
'{{ name }}',
'{{ phone }}'
RETURNING
id,
name,
email,
group,
phone,
updated
;

Manifest

# Description fields are for documentation purposes
- name: contacts
  props:
    - name: email
      value: string
      description: >
        The address to email this Contact to alert them of issues.
        
    - name: group
      value: string
      description: >
        __Filterable__ A grouping for this Contact. This is for display purposes only.
        
    - name: name
      value: string
      description: >
        The name of this Contact.
        
    - name: phone
      value: object
      description: >
        Information about how to reach this Contact by phone.
        

REPLACE examples

put_managed_contact

Updates information about a Managed Contact. This operation can only be accessed by the unrestricted users of an account.

Learn more...

Learn more...

REPLACE linode.managed.contacts
SET 
data__email = '{{ email }}',
data__group = '{{ group }}',
data__name = '{{ name }}',
data__phone = '{{ phone }}'
WHERE 

RETURNING
id,
name,
email,
group,
phone,
updated;

DELETE examples

delete_managed_contact

Deletes a Managed Contact.

This operation can only be accessed by the unrestricted users of an account.

Learn more...

Learn more...

DELETE FROM linode.managed.contacts;