Subscriptions API

The /subscriptions API endpoint

The /subscriptions API endpoint provides HTTP GET access to subscription data.

/subscriptions (GET)

EXAMPLE

The following example demonstrates a request to the /subscriptions API, resulting in a JSON Array of JSON Hashes containing subscription definitions.

$ curl -s http://127.0.0.1:3000/subscriptions | jq .
[
  {
    "dc": "us_west1",
    "name": "web_server"
  },
  {
    "dc": "us_west1",
    "name": "database"
  }
]

API Specification

/subscriptions (GET)
description Returns a list of subscriptions by name and datacenter (dc).
example url http://hostname:3000/subscriptions
response type Array
response codes
  • Success: 200 (OK)
  • Error: 500 (Internal Server Error)
output
[
  {
    "dc": "us_west1",
    "name": "web_server"
  },
  {
    "dc": "us_west1",
    "name": "database"
  }
]
Is this page helpful?