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

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)

list

A paginated list of ManagedContacts.

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)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	contactId		Returns a single managed contact. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
list	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...
create	insert			Creates a managed contact. When investigating or resolving an issue with a service monitor, Akamai Support may reach out to this contact. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
update	replace	contactId		Updates information for a managed contact. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
delete	delete	contactId		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
contactId	string	The ID of the contact to access.
page	integer	The page of a collection to return.
page_size	integer	The number of items to return per page.

SELECT examples

get

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
WHERE contactId = '{{ contactId }}' -- required
;

list

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
id,
name,
email,
group,
phone,
updated
FROM linode.managed.contacts
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}'
;

INSERT examples

create

Creates a managed contact. When investigating or resolving an issue with a service monitor, Akamai Support may reach out to this contact.

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

Learn more...

Learn more...

INSERT INTO linode.managed.contacts (
email,
group,
name,
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: "{{ email }}"
    description: |
      The address to email this Contact to alert them of issues.
  - name: group
    value: "{{ group }}"
    description: |
      __Filterable__ A grouping for this Contact. This is for display purposes only.
  - name: name
    value: "{{ name }}"
    description: |
      The name of this Contact.
  - name: phone
    description: |
      Information about how to reach this Contact by phone.
    value:
      primary: "{{ primary }}"
      secondary: "{{ secondary }}"

REPLACE examples

update

Updates information for 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 
email = '{{ email }}',
group = '{{ group }}',
name = '{{ name }}',
phone = '{{ phone }}'
WHERE 
contactId = '{{ contactId }}' --required
RETURNING
id,
name,
email,
group,
phone,
updated;

DELETE examples

delete

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
WHERE contactId = '{{ contactId }}' --required
;