IDERA Developer Site


Format of CURL Request

The general format for the curl request is described below. You can get the curl software from here

curl -su <APIKEY>:U <HTTP/HTTPS>://api.copperegg.com/v2/alerts/definitions.json

or

curl -s <HTTP/HTTPS>://<APIKEY>:U@api.copperegg.com/v2/alerts/alerts/definitions.json

APIKEY is the user’s unique key used for both identification and authentication.

To obtain the APIKEY follow these steps.

  • Log in to your account on CopperEgg.
  • Go to Settings Tab.
  • Click on Personal Settings tab on the left-hand side.
  • Scroll down to ‘User API Access’ Section, APIKEY is available here.

HTTP and HTTPS both are supported.


Available APIs

Given below is a brief description of all APIs available.


Alert

Definitions

Alert Definitions define the conditions which are periodically checked and if the conditions are met then an Alert is generated. The following actions can be performed using this API.

  • Index - Fetch all your Alert Definition.
  • Show - Show in-depth information for a single Alert Definition.
  • Update - Update/Create an Alert Definition.
Notification Profiles

Notification Profiles define the various channels defined by the user for sending notifications. There are two notification profile - User Notification Profiles and Custom Notification Profiles. Each Alert Definition can have one or more than one associated Notification profiles. The following actions can be performed using this API.

  • Index - Fetch all Notification Profiles
  • Show - Fetch in-depth information for a single Notification Profile.
  • Create - Create a new Notification Profile.
  • Update - Update an existing Notification Profile.
  • Delete - Delete an existing Notification Profile.
Issues

Issues are automatically created by CopperEgg’s alerting system whenever one of the conditions defined in Alert Definition is met. The following actions can be performed using this API.

  • Index - Fetch all Issues.
  • Show - Fetch in-depth information for a single Issue.
  • Update - Update an Issue.
  • Delete - Delete an Issue.
Schedules

Schedules are for creating Maintenance periods for the resources monitored by CopperEgg. During which any Issues created will not be notified to the user. The following actions can be performed using this API.

  • Index - Fetch all Schedules.
  • Show - Fetch in-depth information for a single Schedules.
  • Create - Create a new Schedules.
  • Update - Update a Schedules.
  • Delete - Delete a Schedules.
Annotations

Annotations can be used to annotate event time line on monitoring graphs for later inspection. The following actions can be performed using this API.

  • Index - Fetch all Annotations.
  • Show - Fetch in-depth information for a single Annotations.
  • Create - Create a new Annotations.
  • Update - Update an Annotations.
  • Delete - Delete an Annotations.

RevealCloud

Servers

Server represent each of the user’s system monitored by CopperEgg. The following actions can be performed using this API.

  • Index - Fetch details of all monitored systems.
  • Hide - Hide/Unhide a system.
  • Delete - Remove a system from being monitored by CopperEgg.
Samples

Samples API can be used to fetch collected data for a system. The only action available in this API is fetching the data for a system and for a given time period.

Tags

Tags are used to group multiple systems monitored by CopperEgg. The following actions can be performed using this API.

  • Index - Fetch all system Tags.
  • Show - Fetch all system grouped by a tag.
  • Create - Add a new System Tag to one or more monitored Systems.
  • Delete - Remove a tag from on system.

Amazon Web Services(AWS)

AWS Accounts

Server represent each of the user’s system monitored by CopperEgg. The following actions can be performed using this API.

  • Index - Fetch details of all monitored AWS Accounts.
  • Create - Add a new AWS Account on monitoring.
  • Update - Update an existing AWS Account.
  • Delete - Remove AWS Account from monitoring.
Samples

Samples API can be used to fetch collected data for an AWS Account. Samples for various AWS services can be fetched using this API.


RevealUptime

Probes

Probe refers to a periodic test of an internet-connected service. Today the supported Probe types include TCP port connections, ICMP, DNS, HTTP GET/POST and HTTPS GET/POST, REST, SSL. ‘Station’ refers to a location from which the tests are being generated. The following actions can be performed using this API.

  • Index - Fetch details of all monitored probe.
  • Show - Fetch in-depth of a single probe.
  • Create - Create a new Probe.
  • Update - Update an existing probe.
  • Delete - Remove an existing probe.
Samples

Samples API can be used to fetch collected data for a probe. The only action available in this API is fetching the data for a probe and for a given time period.

Tags

Tags are used to group multiple probes monitored by CopperEgg. The following actions can be performed using this API.

  • Index - Fetch all probe Tags.
  • Show - Fetch all probe grouped by a tag.
  • Create - Add a new Probe Tag to one or more monitored Systems.
  • Delete - Remove a tag from on probe.

Real Time User Monitoring

Samples

Samples API can be used to fetch collected RUM data samples.


Custom Metrics

Metric Groups

Custom Metrics allow the user to create custom groups for which data can be collected, monitored. A custom metric group behaves exactly as a probe or a system i.e Users can send data to CopperEgg, define alerts, see the graphs on CopperEgg UI. Metric Group API allows users to create their own metric groups and performs various functions on them.

  • Index - Fetch all defined Metric Groups.
  • Show - Fetch in-depth details of a Single Metric Group.
  • Create - Create a new Metric Group.
  • Update - Update an existing Metric Group.
  • Delete - Delete an existing Metric Group.
Custom Metric Objects and Staleness

Each Metric Group has one or more Metric Objects for which data is sent. CopperEgg provides API for counting and deleting stale Custom objects.

Dashboards

Custom Metrics Dashboards allows the user to create dashboards for organizing the custom metrics and view their associated charts. Following operation are available in Custom Metric Dashboard API.

  • Index - Fetch all defined Custom Metric Dashboard.
  • Create - Create a new Custom Metric Dashboard.
  • Update - Update an existing Custom Metric Dashboard.
  • Delete - Delete an existing Custom Metric Dashboard.
Samples

Samples API can be used to fetch collected data for custom metrics. The only action available in this API is fetching the data for a custom metric and for a given time period.

Tags

Tags are used to group multiple custom metrics monitored by CopperEgg. The following actions can be performed using this API.

  • Index - Fetch all defined Custom Metrics tags.
  • Show - Fetch custom metric object associated with a single custom metric tag.
  • Create - Add a new Custom Metrics Tag to a custom metric object.
  • Delete - Remove a Custom Metrics Tag from a custom metric object.

Releases

January 25, 2017

  • Added AWS Documentation.

January 13, 2017

  • Update to RevealMetrics Group API to disallow creation of Metric Groups with name containg periods or spaces.

January 12, 2017

  • Update API Documentation.

December 10, 2015

  • Updated API Documentation.

December 31, 2015

  • Pagination added to API which allows fetching issues from Alerts API in batches of 100.

February 12, 2014

  • Added Alert Schedules information.

January 2, 2014

  • Added RUM information.
  • Fixed missing Servers page.

November 18, 2013

  • Filled in some missing Server Sample data information.
  • Changed ‘Systems’ to ‘Servers’.