Warning! We are retiring the domain pitchfork.cloudapi.co. This site is, and will continue to be available via https://pitchfork.rax.io.
 

Monitoring - API Calls

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

Entities

Create Entity
/v1.0/{ddi}/entities
Delete Entity
/v1.0/{ddi}/entities/{entity_id}
Get Details Of Entity
/v1.0/{ddi}/entities/{entity_id}
List Entities
/v1.0/{ddi}/entities
Update Entity
/v1.0/{ddi}/entities/{entity_id}

Checks

Create Check
/v1.0/{ddi}/entities/{entity_id}/checks
Delete Check
/v1.0/{ddi}/entities/{entity_id}/checks/{check_id}
Get Check Details
/v1.0/{ddi}/entities/{entity_id}/checks/{check_id}
List Checks
/v1.0/{ddi}/entities/{entity_id}/checks
Test Check
/v1.0/{ddi}/entities/{entity_id}/test-check
Test Check With Debug
/v1.0/{ddi}/entities/{entity_id}/test-check?debug=true
Test Existing Check
/v1.0/{ddi}/entities/{entity_id}/checks/{check_id}/test
Update Check
/v1.0/{ddi}/entities/{entity_id}/checks/{check_id}

Alarms

Create Alarm
/v1.0/{ddi}/entities/{entity_id}/alarms
Delete Alarm
/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}
Get Alarm Details
/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}
List Alarms
/v1.0/{ddi}/entities/{entity_id}/alarms
Update Alarm
/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}

Suppressions

Create Suppression
/v1.0/{ddi}/suppressions
Delete Supression
/v1.0/{ddi}/suppressions/{suppression_id}
Get Suppression Details
/v1.0/{ddi}/suppressions/{suppression_id}
List Suppression Logs
/v1.0/{ddi}/suppression_logs
List Suppressions
/v1.0/{ddi}/suppressions
Update Suppression
/v1.0/{ddi}/suppressions/{suppression_id}

Notifications

Create Notification
/v1.0/{ddi}/notifications
Delete Notification
/v1.0/{ddi}/notifications/{notification_id}
Get Details About Notification
/v1.0/{ddi}/notifications/{notification_id}
List Notifications
/v1.0/{ddi}/notifications
Test Existing Notification
/v1.0/{ddi}/notifications/{notification_id}/test
Test Notification
/v1.0/{ddi}/test-notification
Update Notifications
/v1.0/{ddi}/notifications/{notification_id}

Agents

Get Agent Connection Details
/v1.0/{ddi}/agents/{agent_id}/connections/{connection_id}
Get Agent Details
/v1.0/{ddi}/agents/{agent_id}
List Agent Connections
/v1.0/{ddi}/agents/{agent_id}/connections
List Agents
/v1.0/{ddi}/agents

Zones

Get Monitoring Zone Details
/v1.0/{ddi}/monitoring_zones/{zone_id}
List Monitoring Zone
/v1.0/{ddi}/monitoring_zones
Perform Traceroute From Zone
/v1.0/{ddi}/monitoring_zones/{zone_id}/traceroute

Check Types

Get Check Type Details
/v1.0/{ddi}/check_types/{check_type_id}
List Check Types
/v1.0/{ddi}/check_types

Notification Plan

Create Notification Plan
/v1.0/{ddi}/notification_plans
Delete Notification Plan
/v1.0/{ddi}/notification_plans/{notification_plan_id}
Get Details Of Notification Plan
/v1.0/{ddi}/notification_plans/{notification_plan_id}
List Notification Plans
/v1.0/{ddi}/notification_plans
Update Notification Plan
/v1.0/{ddi}/notification_plans/{notification_plan_id}

Notification Types

Get Details For Notification Type
/v1.0/{ddi}/notification_types/{note_type_id}
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}
List Metrics
/v1.0/{ddi}/entities/{entity_id}/checks/{check_id}/metrics

Alarm Notification History

Discover Alarm Notification History
/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}/notification_history
Get Alarm Notification History Details
/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}/notification_history/{check_id}/{history_item_uuid}
List Alarm Notification History
/v1.0/{ddi}/entities/{entity_id}/alarms/{alarm_id}/notification_history/{check_id}

Changelogs

Get Alarm Changelogs
/v1.0/{ddi}/changelogs/alarms
Get Entity Alarm Changelogs
/v1.0/{ddi}/changelogs/alarms?entityId={entity_id}

Overview

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

Agent Tokens

Create Agent Token
/v1.0/{ddi}/agent_tokens
Delete Agent Token
/v1.0/{ddi}/agent_tokens/{token_id}
Get Details For Agent Token
/v1.0/{ddi}/agent_tokens/{token_id}
List Agent Tokens
/v1.0/{ddi}/agent_tokens
Update Agent Token
/v1.0/{ddi}/agent_tokens/{token_id}

Agent Targets

List Agent Check Type Targets
/v1.0/{ddi}/entities/{entity_id}/agent/check_types/{agent_check_type}/targets

Agent Host Information

Get Agent Host Info Types
/v1.0/{ddi}/agents/{agent_id}/host_info_types
Get Disk Information
/v1.0/{ddi}/agents/{agent_id}/host_info/disks
Get Filesystem Information
/v1.0/{ddi}/agents/{agent_id}/host_info/filesystems
Get Logged In User Information
/v1.0/{ddi}/agents/{agent_id}/host_info/who
Get Memory Information
/v1.0/{ddi}/agents/{agent_id}/host_info/memory
Get Network Interface Information
/v1.0/{ddi}/agents/{agent_id}/host_info/network_interfaces
Get Processes Information
/v1.0/{ddi}/agents/{agent_id}/host_info/processes
Get Processor Information
/v1.0/{ddi}/agents/{agent_id}/host_info/cpus
Get System Information
/v1.0/{ddi}/agents/{agent_id}/host_info/system

Alarm Examples

Evaluate Alarm Example
/v1.0/{ddi}/alarm_examples/{example_id}
Get Details Of Alarm Example
/v1.0/{ddi}/alarm_examples/{example_id}
List Alarm Examples
/v1.0/{ddi}/alarm_examples