Pitchfork - Monitoring

Account

Get Account

/v1.0/{ddi}/account

Get Limits

/v1.0/{ddi}/limits

List Audits

/v1.0/{ddi}/audits

Update Account

/v1.0/{ddi}/account

Update properties on the account

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
webhook_token	text	No	Webhook token between 10 and 64 characters long
meta_key	text	No	Meta Key name no longer than 255 characters
meta_value	text	No	Meta Value no longer than 255 characters

* Required for API Call

Entities

Create Entity

/v1.0/{ddi}/entities

Creates a new entity based on the specified parameters

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
entity_name	text	Yes	Nmae of the new entity
ip_label	text	No	Label for IP address
ip_address	text	No	IP address that can be referenced by checks
agent_id	text	No	Agent to which the entity is bound
meta_key	text	No	Mey key name
meta_value	text	No	Meta value for key

* Required for API Call

Delete Entity

/v1.0/{ddi}/entities/{entity_id}

Deletes the specified entity

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID

* Required for API Call

Get Details Of Entity

/v1.0/{ddi}/entities/{entity_id}

Get all details about the specified entity

View Documentation

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID

* Required for API Call

List Entities

/v1.0/{ddi}/entities

List all entities for the account

View Documentation

	Parameter		Type	Required	Description
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Update Entity

/v1.0/{ddi}/entities/{entity_id}

Update the specified entity

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
entity_id	text	Yes	Entity ID
agent_id	text	No	Agent UUID
meta_key	text	No	Meta key name
meta_value	text	No	Meta value for key
label_value	text	No	Label for the Entity

* Required for API Call

Checks

Create Check

/v1.0/{ddi}/entities/{entity_id}/checks

Create check for the specified entity

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
entity_id	text	Yes	Entity ID
check_type	text	Yes	Type of Check
label	text	No	Label or Name for check
disabled	boolean	No	Disable the check
period	integer	No	The period in seconds for the check
timeout	integer	No	Timeout in seconds for the check
detail_key	text	No	Key for details specific to check type i.e. url, address, etc.
detail_value	text	No	Value for detail key specific for check type
meta_key	text	No	Meta Key name
meta_value	text	No	Meta value for key
mon_zone	text	No	Monitoring Zone only needed for remote checks
target_alias	text	No	Key of entity's ip_addresses hash to use to rsolve the check. Mutaully exclusive to target_hostname
target_hostname	text	No	Hostname the check should target. Mutually exclusive to target alias.
target_resolver	text	No	How to resolve the check target. Used with target_hostname

* Required for API Call

Delete Check

/v1.0/{ddi}/entities/{entity_id}/checks/{check_id}

Delete the specified check for the specified entity

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID
	check_id		text	Yes	Check ID

* Required for API Call

Get Check Details

/v1.0/{ddi}/entities/{entity_id}/checks/{check_id}

Get all details for the specified check and specified entity

View Documentation

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID
	check_id		text	Yes	Check ID

* Required for API Call

List Checks

/v1.0/{ddi}/entities/{entity_id}/checks

List all checks for the specified entity

View Documentation

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Test Check

/v1.0/{ddi}/entities/{entity_id}/test-check

Test check before creating it

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
entity_id	text	Yes	Entity ID
check_type	text	Yes	Type of Check
label	text	No	Label or Name for check
disabled	boolean	No	Disable the check
period	integer	No	The period in seconds for the check
timeout	integer	No	Timeout in seconds for the check
detail_key	text	No	Key for details specific to check type i.e. url, address, etc.
detail_value	text	No	Value for detail key specific for check type
meta_key	text	No	Meta Key name
meta_value	text	No	Meta value for key
mon_zone	text	No	Monitoring Zone only needed for remote checks
target_alias	text	No	Key of entity's ip_addresses hash to use to rsolve the check. Mutaully exclusive to target_hostname
target_hostname	text	No	Hostname the check should target. Mutually exclusive to target alias.
target_resolver	text	No	How to resolve the check target. Used with target_hostname

* Required for API Call

Test Check With Debug

/v1.0/{ddi}/entities/{entity_id}/test-check?debug=true

Test check before creating it and include all debug information if available

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
entity_id	text	Yes	Entity ID
check_type	text	Yes	Type of Check
label	text	No	Label or Name for check
disabled	boolean	No	Disable the check
period	integer	No	The period in seconds for the check
timeout	integer	No	Timeout in seconds for the check
detail_key	text	No	Key for details specific to check type i.e. url, address, etc.
detail_value	text	No	Value for detail key specific for check type
meta_key	text	No	Meta Key name
meta_value	text	No	Meta value for key
mon_zone	text	No	Monitoring Zone only needed for remote checks
target_alias	text	No	Key of entity's ip_addresses hash to use to rsolve the check. Mutaully exclusive to target_hostname
target_hostname	text	No	Hostname the check should target. Mutually exclusive to target alias.
target_resolver	text	No	How to resolve the check target. Used with target_hostname

* Required for API Call

Test Existing Check

/v1.0/{ddi}/entities/{entity_id}/checks/{check_id}/test

Test an existing check for the specified entity

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID
	check_id		text	Yes	Check ID

* Required for API Call

Update Check

/v1.0/{ddi}/entities/{entity_id}/checks/{check_id}

Update check for the specified entity and check

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
entity_id	text	Yes	Entity ID
check_id	text	Yes	Check ID
check_type	text	Yes	Type of Check
label	text	No	Label or Name for check
disabled	boolean	No	Disable the check
period	integer	No	The period in seconds for the check
timeout	integer	No	Timeout in seconds for the check
detail_key	text	No	Key for details specific to check type i.e. url, address, etc.
detail_value	text	No	Value for detail key specific for check type
meta_key	text	No	Meta Key name
meta_value	text	No	Meta value for key
mon_zone	text	No	Monitoring Zone only needed for remote checks
target_alias	text	No	Key of entity's ip_addresses hash to use to rsolve the check. Mutaully exclusive to target_hostname
target_hostname	text	No	Hostname the check should target. Mutually exclusive to target alias.
target_resolver	text	No	How to resolve the check target. Used with target_hostname

* Required for API Call

Alarms

Create Alarm

/v1.0/{ddi}/entities/{entity_id}/alarms

Creates a new alarm for the specified entity on the specified server

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
entity_id	text	Yes	Enitity ID
check_id	text	Yes	Check ID
notification_plan_id	text	Yes	Notification Plan ID
criteria	text	No	Criteria - Alarm DSL code to run
disabled	boolean	No	Disable the alarm
label	text	No	Label for alarm
meta_key	text	No	Meta Key
meta_value	text	No	Meta Value

* Required for API Call

Delete Alarm

/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}

Delete the specified alarm for the specified entity

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID
	alarm_id		text	Yes	Alarm ID

* Required for API Call

Get Alarm Details

/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}

Get alarm information for the the specified entity and the specified alarm

View Documentation

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID
	alarm_id		text	Yes	Alarm ID

* Required for API Call

List Alarms

/v1.0/{ddi}/entities/{entity_id}/alarms

List all alarms for the specified entity

View Documentation

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Update Alarm

/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}

Update the specified alarm for the specified entity

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
entity_id	text	Yes	Entity ID
alarm_id	text	Yes	Alarm ID
check_id	text	No	Check ID
notification_plan_id	text	No	Notification Plan ID
criteria	text	No	Criteria - Alarm DSL code to run
disabled	boolean	No	Disable the alarm
label	text	No	Label for alarm
meta_key	text	No	Meta Key
meta_value	text	No	Meta Value

* Required for API Call

Suppressions

Create Suppression

/v1.0/{ddi}/suppressions

Create a suppression for the account

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
notification_plans	list	No	Notification plan. If specified only those entities, checks, or alarms that use this notification plan can be suppressed. Leave blank to use all notification plans.
suppress_entities	list	No	List of entities to suppress. If notifications is specified then only suppress entity if it is in the specified notification plan.
suppress_checks	list	No	List of checks to suppress. If notifications is set then only suppress checks if it is in notification plan. Ignored if checks listed are in a specified entity.
suppress_alarms	list	No	List of alarms to suppress. If notification plan is set then only suppress alarms if it is in notification plan. Ignored if specified alarms are in already specified entities or checks.
start_time	text	No	When to start the suppression in epoch time with milliseconds. Set to 0 for to use current time
end_time	text	No	End time to stop the suppression in epoch time with milliseconds

* Required for API Call

Delete Supression

/v1.0/{ddi}/suppressions/{suppression_id}

Delete the specified suppression from the account

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	suppression_id		text	Yes	Suppression ID

* Required for API Call

Get Suppression Details

/v1.0/{ddi}/suppressions/{suppression_id}

Get the state of the specified suppression

View Documentation

	Parameter		Type	Required	Description
	suppression_id		text	Yes	Suppression ID

* Required for API Call

List Suppression Logs

/v1.0/{ddi}/suppression_logs

List the suppression logs for the specified account

View Documentation

	Parameter		Type	Required	Description
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

List Suppressions

/v1.0/{ddi}/suppressions

List all suppression for the account

View Documentation

	Parameter		Type	Required	Description
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Update Suppression

/v1.0/{ddi}/suppressions/{suppression_id}

Update the supplied suppression options for the specified suppression

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
suppression_id	text	Yes	Suppression ID
notification_plans	list	No	Notification plan. If specified only those entities, checks, or alarms that use this notification plan can be suppressed. Leave blank to use all notification plans.
suppress_entities	list	No	List of entities to suppress. If notifications is specified then only suppress entity if it is in the specified notification plan.
suppress_checks	list	No	List of checks to suppress. If notifications is set then only suppress checks if it is in notification plan. Ignored if checks listed are in a specified entity.
suppress_alarms	list	No	List of alarms to suppress. If notification plan is set then only suppress alarms if it is in notification plan. Ignored if specified alarms are in already specified entities or checks.
start_time	text	No	When to start the suppression in epoch time with milliseconds. Set to 0 for to use current time
end_time	text	No	End time to stop the suppression in epoch time with milliseconds. Set to 0 for current time

* Required for API Call

Notifications

Create Notification

/v1.0/{ddi}/notifications

Create a specific type of notification based on the information provided

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
label	text	Yes	Label for the notification
type	text	Yes	Type of notification
detail_name	text	Yes	Name for location based on type
detail_location	text	Yes	Location to send the notification (Based on the type)

* Required for API Call

Delete Notification

/v1.0/{ddi}/notifications/{notification_id}

Delete the specified notification

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	notification_id		text	Yes	Notification ID

* Required for API Call

Get Details About Notification

/v1.0/{ddi}/notifications/{notification_id}

Get all details for the specified notification

View Documentation

	Parameter		Type	Required	Description
	notification_id		text	Yes	Notification ID

* Required for API Call

List Notifications

/v1.0/{ddi}/notifications

Test Existing Notification

/v1.0/{ddi}/notifications/{notification_id}/test

Test an existing specified notification

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	notification_id		text	Yes	Notification ID

* Required for API Call

Test Notification

/v1.0/{ddi}/test-notification

Test a specified location before creating

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
type	text	Yes	Type of check to test
detail_name	text	Yes	Name for location based on type
detail_location	text	Yes	Location to send notification i.e. email address or URL

* Required for API Call

Update Notifications

/v1.0/{ddi}/notifications/{notification_id}

Update the specified notification

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
notification_id	text	Yes	Notification ID
type	text	Yes	Type of Notification
detail_name	text	Yes	Name for location based on type
detail_location	text	Yes	Location to send notification i.e. email address or URL

* Required for API Call

Agents

Get Agent Connection Details

/v1.0/{ddi}/agents/{agent_id}/connections/{connection_id}

Get details about the specified connection for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent ID
	connection_id		text	Yes	Connection ID

* Required for API Call

Get Agent Details

/v1.0/{ddi}/agents/{agent_id}

Get specified agent details

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent ID

* Required for API Call

List Agent Connections

/v1.0/{ddi}/agents/{agent_id}/connections

List the connections for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent ID

* Required for API Call

List Agents

/v1.0/{ddi}/agents

List all agents that have checked in in the last 30 days

View Documentation

	Parameter		Type	Required	Description
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Zones

Get Monitoring Zone Details

/v1.0/{ddi}/monitoring_zones/{zone_id}

Get details about the specified monitoring zone

View Documentation

	Parameter		Type	Required	Description
	zone_id		text	Yes	Monitoring Zone ID

* Required for API Call

List Monitoring Zone

/v1.0/{ddi}/monitoring_zones

Perform Traceroute From Zone

/v1.0/{ddi}/monitoring_zones/{zone_id}/traceroute

Perform a traceroute from the specified monitoring zone to a target IP address

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
zone_id	text	Yes	Monitoring Zone ID
target	text	Yes	Target hostname or IP address
resolver	text	No	Target resolver type. Only needed when specifying target as hostname

* Required for API Call

Check Types

Get Check Type Details

/v1.0/{ddi}/check_types/{check_type_id}

Get details about the specified check type

View Documentation

	Parameter		Type	Required	Description
	check_type_id		text	Yes	Check ID

* Required for API Call

List Check Types

/v1.0/{ddi}/check_types

List all the available check types

View Documentation

	Parameter		Type	Required	Description
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Notification Plan

Create Notification Plan

/v1.0/{ddi}/notification_plans

Create a notification plan

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
label	text	Yes	Label for the notification plan
critical_state	list	No	Array or list of notification lists to be notified when alert in a Critical state
warning_state	list	No	Array or list of notification lists to be notified when alert in a Warning state
ok_state	list	No	Array or list of notification lists to be notified when alert in a OK state

* Required for API Call

Delete Notification Plan

/v1.0/{ddi}/notification_plans/{notification_plan_id}

Delete the specified notification plan

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	notification_plan_id		text	Yes	Notification plan ID to remove

* Required for API Call

Get Details Of Notification Plan

/v1.0/{ddi}/notification_plans/{notification_plan_id}

Get details about the specified notification plan

View Documentation

	Parameter		Type	Required	Description
	notification_plan_id		text	Yes	Notification Plan ID

* Required for API Call

List Notification Plans

/v1.0/{ddi}/notification_plans

Update Notification Plan

/v1.0/{ddi}/notification_plans/{notification_plan_id}

Update the specified notification plan

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
notification_plan_id	text	Yes	Notification plan ID
label	text	No	Label or name of plan
critical_state	list	No	Array or list of notification lists to notify when state is Critical
warning_state	list	No	Array or list of notification lists to notify when state is Warning
ok_state	list	No	Array or list of notification lists to notify when state is OK

* Required for API Call

Notification Types

Get Details For Notification Type

/v1.0/{ddi}/notification_types/{note_type_id}

Get all details about the specified notifcation type

View Documentation

	Parameter		Type	Required	Description
	note_type_id		text	Yes	Notification Type ID

* Required for API Call

List Notification Types

/v1.0/{ddi}/notification_types

Metrics

Get Data Points

/v1.0/{ddi}/entities/{entity_id}/checks/{check_id}/metrics/{metric_name}/plot?from={from}&to={to}&resolution={resolution}

Queries for all data points of metric name between two points in time

View Documentation

Parameter	Type	Required	Description
entity_id	text	Yes	Entity ID
check_id	text	Yes	Check ID
metric_name	text	Yes	Name of metric
from	integer	Yes	Epoch time in miliseconds marking start of range
to	integer	Yes	Epoch time in miliseconds marking end of range
resolution	text	Yes	Number of points or granularity of the data

* Required for API Call

List Metrics

/v1.0/{ddi}/entities/{entity_id}/checks/{check_id}/metrics

List the metrics associated with the specified check

View Documentation

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID
	check_id		text	Yes	Check ID
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Alarm Notification History

Discover Alarm Notification History

/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}/notification_history

List checks for which alarm notification history is available

View Documentation

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID
	alarm_id		text	Yes	Alarm ID

* Required for API Call

Get Alarm Notification History Details

/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}/notification_history/{check_id}/{history_item_uuid}

Retrieve a single alarm notification history item

View Documentation

Parameter	Type	Required	Description
entity_id	text	Yes	Entity ID
alarm_id	text	Yes	Alarm ID
check_id	text	Yes	Check ID
history_item_uuid	text	Yes	History Item UUID

* Required for API Call

List Alarm Notification History

/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}/notification_history/{check_id}

List the alarm notification history for the specified entity, alarm, and check

View Documentation

Parameter	Type	Required	Description
entity_id	text	Yes	Entity ID
alarm_id	text	Yes	Alarm ID
check_id	text	Yes	Check ID

* Required for API Call

Changelogs

Get Alarm Changelogs

/v1.0/{ddi}/changelogs/alarms

Get Entity Alarm Changelogs

/v1.0/{ddi}/changelogs/alarms?entityId={entity_id}

Get changelogs for the specified entity

View Documentation

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID

* Required for API Call

Overview

Get Overview

/v1.0/{ddi}/views/overview

Agent Tokens

Create Agent Token

/v1.0/{ddi}/agent_tokens

Creates a new agent token

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	label		text	Yes	Label for agent token

* Required for API Call

Delete Agent Token

/v1.0/{ddi}/agent_tokens/{token_id}

Delete the specified agent token

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	token_id		text	Yes	Token ID

* Required for API Call

Get Details For Agent Token

/v1.0/{ddi}/agent_tokens/{token_id}

Get all details for the specified agent token

View Documentation

	Parameter		Type	Required	Description
	token_id		text	Yes	Token ID

* Required for API Call

List Agent Tokens

/v1.0/{ddi}/agent_tokens

List all agent tokens for the account

View Documentation

	Parameter		Type	Required	Description
Filter		text	No	Filter parameters i.e. limit=100. For multiple parameters separate using an & i.e. limit=100&marker=100

* Required for API Call

Update Agent Token

/v1.0/{ddi}/agent_tokens/{token_id}

Update the specified agent token

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

	Parameter		Type	Required	Description
	token_id		text	Yes	Token ID
	label		text	Yes	Label for the Token

* Required for API Call

Agent Targets

List Agent Check Type Targets

/v1.0/{ddi}/entities/{entity_id}/agent/check_types/{agent_check_type}/targets

List the devices allowed for the specified agent check type on the server where the agent is installed

View Documentation

	Parameter		Type	Required	Description
	entity_id		text	Yes	Entity ID
	agent_check_type		text	Yes	Agent Check Type

* Required for API Call

Agent Host Information

Get Agent Host Info Types

/v1.0/{ddi}/agents/{agent_id}/host_info_types

Get list of host info types supplied from the agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent UUID

* Required for API Call

Get Disk Information

/v1.0/{ddi}/agents/{agent_id}/host_info/disks

Get disk information from the host machine for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent ID

* Required for API Call

Get Filesystem Information

/v1.0/{ddi}/agents/{agent_id}/host_info/filesystems

Get filesystem information from the host machine for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent ID

* Required for API Call

Get Logged In User Information

/v1.0/{ddi}/agents/{agent_id}/host_info/who

Get logged in users from the host machine for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent ID

* Required for API Call

Get Memory Information

/v1.0/{ddi}/agents/{agent_id}/host_info/memory

Get memory information from the host machine for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent ID

* Required for API Call

Get Network Interface Information

/v1.0/{ddi}/agents/{agent_id}/host_info/network_interfaces

Get network information from the host machine for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent ID

* Required for API Call

Get Processes Information

/v1.0/{ddi}/agents/{agent_id}/host_info/processes

Get processes running information from the host machine for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent ID

* Required for API Call

Get Processor Information

/v1.0/{ddi}/agents/{agent_id}/host_info/cpus

Get CPU information from the host machine for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent ID

* Required for API Call

Get System Information

/v1.0/{ddi}/agents/{agent_id}/host_info/system

Get system information from the host machine for the specified agent

View Documentation

	Parameter		Type	Required	Description
	agent_id		text	Yes	Agent ID

* Required for API Call

Alarm Examples

Evaluate Alarm Example

/v1.0/{ddi}/alarm_examples/{example_id}

Evaluate with the specified data a specified alarm example

View Documentation

Warning! This action can be destructive or can result in additional charges to the account.

Parameter	Type	Required	Description
example_id	text	Yes	Alarm Example ID
value_key	text	Yes	Label for the value i.e. string or integer
value	text	Yes	Value to test against

* Required for API Call

Get Details Of Alarm Example

/v1.0/{ddi}/alarm_examples/{example_id}

Get all details of the specified alarm example

View Documentation

	Parameter		Type	Required	Description
	example_id		text	Yes	Alarm Example ID

* Required for API Call

List Alarm Examples

/v1.0/{ddi}/alarm_examples

Monitoring - API Calls

Account

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Entities

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Checks

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL

Request Headers

Request Data Object

Response Headers

Response Body

Request URL