• Buy Now
    • Rackspace Cloud
    • Email & Apps
    • Fanatical Support for AWS
    • Managed Google Cloud Platform
    • Office 365
  • Log In
    • MyRackspace Portal
    • Cloud Control Panel
    • Rackspace Webmail Login
    • Cloud Office Control Panel
  • Rackspace Logo
  • Developer Home
  • Developer Documentation
  • Blogs ▼
    • Technical Blog
    • Rackspace Blog
    • Solve: Thought Leadership
  • Support Documentation

Developer Docs


Let’s Build Something Powerful Together!

End-to-End Multicloud Solutions.   Solving Together.™   Learn more at Rackspace.com

Submit an issue
  • Rackspace Monitoring 1.0
  • Getting Started Guide
    • Get your credentials
    • Send API requests to Rackspace Monitoring
      • Using cURL
    • Authenticate to the Rackspace Cloud
      • Authenticating by using cURL
      • Authenticating by using the Raxmon client
    • Rackspace Monitoring Concepts
      • Account
      • Alarm and alert
      • Check and check type
      • Entity
      • ID or Id
      • Metric, cumulative and instantaneous
      • Monitoring agent
      • Monitoring zone
      • Notification and notification type
      • Notification plan
      • Suppression
      • How Rackspace Monitoring works
      • How the monitoring agent works
    • Create your first monitor
      • Creating an entity
      • Listing monitoring zones
      • Creating a check
      • Testing the check
      • Listing all checks for the entity
      • Setting up notifications
      • Creating a notification plan
      • Creating an alarm
      • Deleting an entity
    • Install and configure the agent
      • Install the agent
      • Configure the agent
      • Start the agent
      • First steps with the agent
  • General API information
    • Service access endpoints
    • Rackspace Monitoring contract version
    • Request/Response types
    • Paginated collections
    • Time series collections
    • Limits
      • Rate limits
      • Resource limits
    • Faults
    • Audits
    • Role based access control (RBAC)
      • Assigning roles to account users
      • Roles available for Rackspace Monitoring
      • Multiproduct global roles and permissions
      • Resolving conflicts between RBAC multiproduct versus custom (product-specific) roles
      • RBAC permissions cross-reference to Rackspace Monitoring operations
  • API Reference
    • Account
      • Get account information
      • Update properties on an account
      • Get Limits
      • Get audit information
    • Entities
      • Create an entity
      • List entities for an account
      • Get an entity by ID
      • Update an entity by ID
      • Delete entity by ID
    • Check types
      • List check types
      • Get a check type by ID
    • Monitoring zones
      • List monitoring zones
      • Get monitoring zone by ID
      • Perform a traceroute from a monitoring zone
      • Create a private monitoring zone
      • Update a private monitor zone by ID
      • Delete a private monitoring zone by ID
    • Checks
      • Create a check
      • Test a check
      • Test a check with debug
      • Test an existing check
      • List checks for an entity
      • Get a check by ID
      • Update a check by ID
      • Delete a check by ID
    • Metrics
      • Cumulative and instantaneous metrics
      • Data granularity
      • Data point expiration
      • Metrics API operations
      • List metrics by check ID
      • Get data points by metric name
    • Notification types
      • Email notification type
      • Webhook notification type
      • PagerDuty notification type
      • SMS notification type
      • VictorOps notification type
      • Notification types API operations
      • Get a notification type by ID
    • Notifications
      • Create a notification
      • Test a notification
      • List notifications
      • Test an existing notification
      • Update a notification
      • Delete a notification
    • Notification plans
      • Create a notification plan
      • List notification plans
      • Get a notification plan by ID
      • Update a notification plan by ID
      • Delete a notification plan
    • Alarms
      • Create an alarm
      • Test an alarm
      • List alarms
      • Get alarm by ID
      • Update alarm by ID
      • Delete alarm by ID
    • Alarm examples
      • List alarm examples
      • Get alarm example by ID
      • Evaluate alarm example
    • Alarm notification history
      • List alarm notification history
      • List alarm notification history by check ID
      • List a single alarm notification
    • Changelogs
      • List alarm changelogs
      • Get alarm changelogs by entity ID
    • Suppressions
      • Create suppression
      • List suppressions
      • Get a suppression by ID
      • Update a suppression
      • Delete suppression
    • Suppression logs
      • List suppression logs
    • Views
      • Get overview
      • Get alarms view by notification plan
    • Agents
      • Security
      • Agent IDs
      • Agents API operations
      • List agent connections
    • Agent tokens
      • Create an agent token
      • List agent tokens
      • Get an agent token by ID
      • Update an agent token
      • Delete an agent token
    • Agent host information
      • Get agent host info types
      • Get CPU information
      • Get disk information
      • Get host filesystem information
      • Get host memory information
      • Get host network interface information
      • Get host process information
      • Get host system information
      • Get information about host users
    • Agent targets
      • List agent check targets
  • Technical reference
    • Alert Triggering and Alarms
      • Alert work flow
      • Alarm language
      • Alert policies
      • Constructs with function modifiers
      • Best practices for creating alerts
    • Check types
      • Remote check types
      • Agent check types
      • Hostinfo checks
      • Check status codes
    • Client libraries and tools
      • Ruby - rackspace-monitoring Library
      • Integration resource: Rackspace Monitoring Cookbook
    • Agent configuration
      • Agent plugin check
      • CPU check with alarm
      • Filesystem check; alarm
      • Load average check; no alarm
      • Memory check; alarm
      • MySQL check; alarm
      • Network check; no alarms
  • Release notes
    • v1.20, January 31, 2016
      • What's new
      • Resolved issues
      • Known issues
    • v1.19, December 31, 2015
      • What's new
      • Resolved issues
      • Known issues
    • v1.18, November 30, 2015
      • What's new
      • Resolved issues
      • Known issues
    • v1.17, October 22, 2015
      • What's new
      • Resolved issues
      • Known issues
    • v1.16, September 18, 2015
      • What's new
      • Resolved issues
      • Known issues
    • v1.15, August 15, 2015
      • What's new
      • Resolved issues
      • Known issues
    • v1.14, July 29, 2015
      • What's new
      • Resolved issues
      • Known issues
    • v1.13, May 27, 2015
      • What's new
      • Resolved issues
      • Known issues
    • v1.12, April 26, 2015
      • What's new
      • Resolved issues
      • Known issues
    • v1.11, March 28, 2015
      • What's new
      • Resolved issues
      • Known issues
    • v1.10, January 23, 2015
      • What's new
      • Resolved issues
      • Known issues
    • v1.9, December 1, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.8, August 13, 2014
      • What's new
    • Resolved issues
      • Known issues
    • v1.7, July 03, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.6, June 16, 2014
      • What's new
      • Resolved issues
      • Known issues
    • v1.5, March 31, 2014
      • What's new
      • Resolved issues
      • Documentation issues
      • Known issues
    • v1.4, August 22, 2012
      • What's new
      • Resolved issues
      • Known issues
    • v1.3, June 14, 2012
      • What's new
      • Resolved issues
      • Known issues
    • v1.2, May 10, 2012
      • What's new
      • Resolved issues
      • Known issues
    • v1.1, March 28, 2012
      • What's new
      • Resolved issues
      • Known issues
  • Service updates
  • Additional resources
  • Disclaimer

Notification types#

The notification type categorizes the notifications that you can configure. When you create a notification, you must specify one of the following Rackspace Monitoring notification types:

Notification Description
Email Alerts where the message is delivered to a specified address.
Webhook Industry-standard web hooks, where JSON is posted to a configurable URL.
PagerDuty An incident management system integrated with Rackspace Monitoring.
SMS Text alerts where the message is delivered to any phone number.
VictorOps An incident management system integrated with Rackspace Monitoring.

The following sections describe the attributes associated with each notification type and provide information about the notification type API operations available to retrieve notification type information.

  • Email notification type
  • Webhook notification type
  • PagerDuty notification type
  • SMS notification type
  • VictorOps notification type
  • Notification types API operations
  • Get a notification type by ID

Email notification type#

The email notification takes the following parameters:

Name Description Validation
address Email address to send notifications to
  • Email address

Webhook notification type#

The webhook notification takes the following parameters:

Name Description Validation
url An HTTP or HTTPS URL to POST to
  • URL

Example: Webhook notification POST to a specified URL with JSON Payload

{
   "event_id": "acOne:enOne:alOne:chOne:1326910500000:WARNING",
   "log_entry_id": "6da55310-4200-11e1-aaaf-cd4c8801b6b1",
   "details": {
       "target": null,
       "timestamp": 1326905540481,
       "metrics": {
           "tt_firstbyte": {
               "type": "I",
               "data": 2,
               "unit": "milliseconds"
           },
           "duration": {
               "type": "I",
               "data": 2,
               "unit": "milliseconds"
           },
           "bytes": {
               "type": "i",
               "data": 17,
               "unit": "bytes"
           },
           "tt_connect": {
               "type": "I",
               "data": 0,
               "unit": "milliseconds"
           },
           "code": {
               "type": "s",
               "data": "200",
               "unit": "unknown"
           }
       },
       "state": "WARNING",
       "status": "warn.",
       "txn_id": "sometransaction",
       "collector_address_v4": "127.0.0.1",
       "collector_address_v6": null,
       "observations": [
           {
               "monitoring_zone_id": "mzOne",
               "state": "WARNING",
               "status": "warn.",
               "timestamp": 1326905540481,
               "collectorState": "UP"
           }
       ]
   },
   "entity": {
       "id": "enOne",
       "label": "entity one",
       "ip_addresses": {
           "default": "127.0.0.1"
       },
       "metadata": null,
       "managed": false,
       "uri": null,
       "agent_id": null,
       "created_at": 1326905540481,
       "updated_at": 1326905540481
   },
   "check": {
       "id": "chOne",
       "label": "ch a",
       "type": "remote.http",
       "details": {
           "url": "http://www.foo.com",
           "body": "b",
           "method": "GET",
           "follow_redirects": true,
           "include_body": false
       },
       "monitoring_zones_poll": [
           "mzOne"
       ],
       "timeout": 30,
       "period": 60,
       "target_alias": "default",
       "target_hostname": "",
       "target_resolver": "",
       "disabled": false,
       "metadata": null,
       "confd_name": null,
       "confd_hash": null,
       "active_suppressions": null,
       "scheduled_suppressions": null,
       "created_at": 1326905540481,
       "updated_at": 1326905540481
   },
   "alarm": {
       "id": "alOne",
       "label": "Alarm 1",
       "check_id": "chOne",
       "entity_id": "enOne",
       "criteria": "if (metric[\"t\"] >= 2.1) { return WARNING } return WARNING",
       "disabled": false,
       "notification_plan_id": "npOne",
       "metadata": null,
       "confd_name": null,
       "confd_hash": null,
       "active_suppressions": null,
       "scheduled_suppressions": null,
       "created_at": 1326905540481,
       "updated_at": 1326905540481
       },
       "tenant_id": "91111"
}

The following fields are contained within a single payload:

Field Description
eventID The ID for the event in the system.
logEntryID The ID for the log entry.
entity The entity record that triggered the alert.
check The check record that triggered the alert.
alarm The alarm record that triggered the alert.

The following fields will be populated in the request header when your webhook is called:

Header field Description
x-rackspace-webhook-token The webhook token defined in an account. This is used in your web application to verify that your webhook is called by an authorized Rackspace service.

PagerDuty notification type#

To use PagerDuty with Rackspace Monitoring, go to the PagerDuty website and sign up for an account. You will get an API Key in PagerDuty to be used when setting up the PagerDuty notification. To learn how to use this notification type, read the PagerDuty blog Rackspace Monitoring Now Integrates with PagerDuty.

Name Description Validation
service_key The PagerDuty service key to use
  • Alphanumeric string
  • String between 1 and 32 characters long
service_endpoint The PagerDuty service endpoint to use
  • URL
  • Optional

SMS notification type#

A notification sent by text to your phone, including international phone numbers; for example +15551234567. Standard text messaging rates charged by your phone service provider will apply.

Name Description Validation
phone_number Phone number to send the notification to, with leading + and country code (E.164 format)
  • String matching the regex //^+[0-9]{6,15}$//

VictorOps notification type#

A notification sent as a webhook to your VictorOps account.

To use VictorOps with Rackspace Monitoring, go to the VictorOps website and sign up for an account. You will get an API key and configure routing keys for the teams in VictorOps. The API key and routing key will be used when setting up the VictorOps notification. To learn more about this notification type, read the VictorOps blog Internet Age of Unix Philosophy and visit the VictorOps Knowledge Base.

Name Description Validation
routing key The optional VictorOps routing_key to use with Rackspace Monitoring. You create a routing_key in VictorOps for team on-call configuration. (/^[a-zA-Z0-9-_.]+$/)
api key The VictorOps api_key to use with Rackspace Monitoring. You get this when you sign up for a VictorOps account. UUID v4 format

Notification types API operations#

Use the following API operations to review information about notification types.

List notification types#

GET /notification_types

Lists available notification types.

This operation can be paginated. For information, see Paginated collections.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 OK The request completed.
401 Unauthorized The system received a request from a user that is not authenticated.
403 Forbidden The system received a request that the user is not authorized to make.
500 Internal Server Error An unexpected condition was encountered.
503 Service Unavailable The system is experiencing heavy load or another system failure.

Request#

The following table shows the header parameters for the request:

Name Type Description
X-Auth-Token String (Required) A valid authentication token with administrative access. For details, see Get your credentials

Note

This operation does not accept a request body.

Response#

Example List notification types: JSON response

{
    "values": [
        {
            "id": "webhook",
            "fields": [
                {
                    "name": "url",
                    "description": "An HTTP or HTTPS URL to POST to",
                    "optional": false
                }
            ]
        },
        {
            "id": "email",
            "fields": [
                {
                    "name": "address",
                    "description": "Email address to send notifications to",
                    "optional": false
                }
            ]
        },
        {
            "id": "pagerduty",
            "fields": [
                {
                    "name": "service_key",
                    "description": "The PagerDuty service key to use.",
                    "optional": false
                }
            ]
        },
        {
            "id": "sms",
            "fields": [
                {
                    "name": "phone_number",
                    "description": "Phone number to send the notification to, with \
                                    leading + and country code (E.164 format)",
                    "optional": false
                }
            ]
        },
        {
            "id": "managed",
            "fields": null
        },
        {
            "id": "technicalContactsEmail",
            "fields": null
        },
        {
            "id": "atomHopper",
            "fields": [
                {
                    "name": "category",
                    "description": "A category by which to identify this notification.  \
                                    Categories will be prefixed by 'monitoring.alerts.',\
                                    so they will end up looking like: \
                                    'monitoring.alerts.USER_DEFINED_CATEGORY'", \
                                    "optional": false \
                }
            ]
        },
        {
            "id": "victorops",
            "fields": [
                {
                    "name": "api_key",
                    "description": "The VictorOps api key to use.",
                    "optional": false
                },
                {
                    "name": "routing_key",
                    "description": "The VictorOps routing key to use.",
                    "optional": false
                }
            ]
        }
    ],
    "metadata": {
        "count": 8,
        "limit": 50,
        "marker": null,
        "next_marker": null,
        "next_href": null
    }
}

Get a notification type by ID#

GET /notification_types/{notificationTypeId}

Returns information about the specified Notification type.

The following table shows the possible response codes for this operation:

Response Code Name Description
200 OK The request completed.
401 Unauthorized The system received a request from a user that is not authenticated.
403 Forbidden The system received a request that the user is not authorized to make.
500 Internal Server Error An unexpected condition was encountered.
503 Service Unavailable The system is experiencing heavy load or another system failure.

Request#

This table shows the header parameters for the request:

Name Type Description
X-Auth-Token String (Required) A valid authentication token with administrative access. For details, see Get your credentials

Note

This operation does not accept a request body.

Response#

Example Get notification type by ID: JSON response

{
    "id": "webhook",
    "fields": [
        {
            "name": "url",
            "description": "An HTTP or HTTPS URL to POST to",
            "optional": false
        }
    ]
}
Previous Metrics
Next Notifications
Developer Network
  • Developer Center
  • API Documentation and User Guides
  • SDKs
  • Rackspace How-To
Blogs
  • Technical Blog
  • Rackspace Blog
  • Solve: Thought Leadership
Other Information
  • Customer Stories
  • Events
  • Programs
  • Careers
  • Style Guide for Technical Content
©2020 Rackspace US, Inc.
  • ©2020 Rackspace US, Inc.
  • About Rackspace
  • Privacy Statement
  • Website Terms
  • Trademarks