Subscription

APIs for Subscription management

List Subscriptions in Enterprise

API to view all the subscriptions in an enterprise

Request
Security:
path Parameters
enterprise_id
required
string <uuid>

A UUID string identifying the enterprise.

query Parameters
limit
integer

Number of results to return per page.

offset
integer

Return results from this index.

Responses
200

successful operation

get/v0/enterprise/{enterprise_id}/subscription/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Create a Subscription

Returns Subscription instance

Request
Security:
path Parameters
enterprise_id
required
string <uuid>

A UUID string identifying the enterprise.

Request Body schema: */*
aws_account_id
required
string (AWS account Id) non-empty
Responses
201

successful operation

post/v0/enterprise/{enterprise_id}/subscription/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "aws_account_id": "string",
  • "sns_topic_arn": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_subscribed": true,
  • "enterprise": "string"
}

Get subscription information

Returns subscription instance

Request
Security:
path Parameters
subscription_id
required
string <uuid>

A UUID string identifying the subscription.

enterprise_id
required
string <uuid>

A UUID string identifying the enterprise.

Responses
200

successful operation

get/v0/enterprise/{enterprise_id}/subscription/{subscription_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "aws_account_id": "string",
  • "sns_topic_arn": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_subscribed": true,
  • "enterprise": "string"
}

Delete a subscription

Empty response

Request
Security:
path Parameters
subscription_id
required
string <uuid>

A UUID string identifying the subscription.

enterprise_id
required
string <uuid>

A UUID string identifying the enterprise.

Responses
204

successful operation

delete/v0/enterprise/{enterprise_id}/subscription/{subscription_id}/