Subscription Rest API

Overview

Resource Operation Description
Rules GET /subscriptions/(account)/(name)/Rules Get subscription rules.
States GET /subscriptions/(account)/(name)/Rules/States Get subscription rule states.
  GET /subscriptions/(account)/Rules/States  
Subscription PUT /subscriptions/(account)/(name) Update a subscription.
  POST /subscriptions/(account)/(name) Create a subscription.
  GET /subscriptions/(account)/(name) Get subscriptions.
  GET /subscriptions/(account)  
  GET /subscriptions/  
SubscriptionId GET /subscriptions/Id/(subscription_id) Get a subscription by ID.

Details

PUT /subscriptions/(account)/(name)

Update an existing subscription.

Parameters:
  • account – The account name.
  • name – The subscription name.
Status Codes:
POST /subscriptions/(account)/(name)

Create a new subscription.

Parameters:
  • account – The account name.
  • name – The subscription name.
Status Codes:
Returns:

ID if newly created subscription.

GET /subscriptions/(account)/(name)
GET /subscriptions/(account)
GET /subscriptions/

Retrieve a subscription.

Parameters:
  • account – The account name.
  • name – The subscription name.
Response Headers:
 
Status Codes:
Returns:

Line separated list of dictionaries with subscription information.

GET /subscriptions/(account)/(name)/Rules/States
GET /subscriptions/(account)/Rules/States

Return a summary of the states of all rules of a given subscription id.

Parameters:
  • account – The account name.
  • name – The subscription name.
Response Headers:
 
Status Codes:
Returns:

Line separated list of dictionaries with rule information.

GET /subscriptions/Id/(subscription_id)

Retrieve a subscription matching the given subscription id

Parameters:
  • subscription_id – The subscription id.
Response Headers:
 
Status Codes:
Returns:

dictionary with subscription information.

GET /subscriptions/(account)/(name)/Rules

Return all rules of a given subscription id.

Parameters:
  • account – The account name.
  • name – The subscription name.
Response Headers:
 
Status Codes:
Returns:

Line separated list of dictionaries with rule information.