Managed

Managed Contact View

get
https://api.linode.com/v4/managed/contacts/{contactId}

Returns a single Managed Contact.

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

Path Parameters

contactId
Required
integer

The ID of the contact to access.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/managed/contacts/567

Response Samples

{
  "email": "john.doe@example.org",
  "phone": {
    "primary": "123-456-7890",
    "secondary": ""
  },
  "updated": "2018-01-01T00:01:01",
  "id": 1234,
  "group": "on-call",
  "name": "John Doe"
}

Responses

200: The requested Managed Contact.

email
string <email>

The address to email this Contact to alert them of issues.

phone
object

Information about how to reach this Contact by phone.

primary
Nullable
string

This Contact's primary phone number.

secondary
Nullable
string

This Contact's secondary phone number.

updated
string <date-time>

When this Contact was last updated.

id
integer

This Contact's unique ID.

group
Filterable
Nullable
string [2 .. 50] characters

A grouping for this Contact. This is for display purposes only.

name
string [2 .. 64] characters [a-zA-Z0-9-_ ]{2,64}

The name of this Contact.

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.

Managed Contact Update

put
https://api.linode.com/v4/managed/contacts/{contactId}

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

Path Parameters

contactId
Required
integer

The ID of the contact to access.

Request Body Schema

email
string <email>

The address to email this Contact to alert them of issues.

group
Filterable
Nullable
string [2 .. 50] characters

A grouping for this Contact. This is for display purposes only.

name
string [2 .. 64] characters [a-zA-Z0-9-_ ]{2,64}

The name of this Contact.

phone
object

Information about how to reach this Contact by phone.

primary
Nullable
string

This Contact's primary phone number.

secondary
Nullable
string

This Contact's secondary phone number.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X PUT -d '{
      "name": "John Doe",
      "email": "john.doe@example.org",
      "phone": {
        "primary": "123-456-7890",
        "secondary": null
      },
      "group": "on-call"
    }' \
    https://api.linode.com/v4/managed/contacts/567

Response Samples

{
  "email": "john.doe@example.org",
  "phone": {
    "primary": "123-456-7890",
    "secondary": ""
  },
  "id": 1234,
  "updated": "2018-01-01T00:01:01",
  "group": "on-call",
  "name": "John Doe"
}

Responses

200: Contact updated successfully.

email
string <email>

The address to email this Contact to alert them of issues.

phone
object

Information about how to reach this Contact by phone.

primary
Nullable
string

This Contact's primary phone number.

secondary
Nullable
string

This Contact's secondary phone number.

id
integer

This Contact's unique ID.

group
Filterable
Nullable
string [2 .. 50] characters

A grouping for this Contact. This is for display purposes only.

name
string [2 .. 64] characters [a-zA-Z0-9-_ ]{2,64}

The name of this Contact.

updated
string <date-time>

When this Contact was last updated.

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.

Managed Contact Delete

delete
https://api.linode.com/v4/managed/contacts/{contactId}

Deletes a Managed Contact.

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

Path Parameters

contactId
Required
integer

The ID of the contact to access.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    -X DELETE \
    https://api.linode.com/v4/managed/contacts/567

Response Samples

{}

Responses

200: Contact 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.