List Monitor References

Get the list of resources that reference the provided monitor.

application/json

Body

result

required

List of resources that reference a given monitor.

Any of

allOf {2}

array [object {4}]

allOf {2}

One of

array [object {4}]

object

List of resources that reference a given monitor.

Example:

[{"reference_type":"referrer","resource_id":"17b5962d775c646f3f9725cbc7a53df4","resource_name":"primary-dc-1","resource_type":"pool"}]

reference_type

enum<string>

optional

Allowed values:

*referralreferrer

resource_id

string

optional

resource_name

string

optional

resource_type

string

optional

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "reference_type": "referrer",
            "resource_id": "17b5962d775c646f3f9725cbc7a53df4",
            "resource_name": "primary-dc-1",
            "resource_type": "pool"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List Monitor References

Request

Request samples

Responses