Skip to main content
POST
/
subscriptions
/
{platformType}
Create subscriptions (bulk)
curl --request POST \
  --url https://{host}/subscriptions/{platformType} \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "subscriptionName": "My Weekly Cloud Feed",
    "description": "Finance BU, prod apps; weekly",
    "owner": "",
    "active": "true",
    "webhook": {
      "uri": "https://hooks.example/teams",
      "authType": "basic",
      "authValue": "user:pass"
    },
    "tagReferences": [
      {
        "tagID": "business_unit",
        "operator": "equals",
        "values": [
          "Finance"
        ]
      }
    ],
    "propertyReferences": [
      {
        "propertyID": "serviceType",
        "operator": "equals",
        "values": [
          "Virtual Machine"
        ]
      }
    ],
    "suppressionReferences": [
      {
        "suppressionID": "no-m3",
        "operator": "like",
        "values": [
          "m3*"
        ],
        "revokeBy": "1735689600000"
      }
    ],
    "returnStructure": {
      "showAliases": true,
      "fields": [
        "name",
        "region",
        "currentType",
        "recommendedType",
        "savingsEstimate",
        "rptHref"
      ]
    },
    "schedule": {
      "frequency": "WEEKLY",
      "at": "08:30"
    }
  }
]'
[
  {
    "subscriptionRef": "<string>",
    "subscriptionName": "<string>",
    "description": "<string>",
    "owner": "<string>",
    "outputType": "<string>",
    "active": "true",
    "webhook": {
      "uri": "<string>",
      "authType": "<string>",
      "authValue": "<string>"
    },
    "propertyReferences": [
      {
        "propertyID": "<string>",
        "operator": "<string>",
        "values": [
          "<string>"
        ]
      }
    ],
    "tagReferences": [
      {
        "tagID": "<string>",
        "operator": "<string>",
        "values": [
          "<string>"
        ]
      }
    ],
    "suppressionReferences": [
      {
        "suppressionID": "<string>",
        "operator": "<string>",
        "values": [
          "<string>"
        ],
        "revokeBy": "<string>"
      }
    ],
    "returnStructure": {
      "showAliases": false,
      "fields": [
        "<string>"
      ]
    },
    "schedule": {
      "frequency": "<string>",
      "at": "<string>"
    },
    "webhookStatus": "<string>",
    "lastTriggered": "<string>",
    "message": "<string>",
    "status": 123
  }
]

Path Parameters

platformType
enum<string>
required

Technology platform (cloud or containers).

Available options:
cloud,
containers

Body

application/json · object[]
subscriptionName
string

Unique per platform if global; unique per owner if private.

owner
string

"" for global (admin only) or username for private; non-admins default to their username.

description
string
outputType
enum<string>
default:application/json

Only supported output type.

Available options:
application/json
active
enum<string>
default:false

true=active; false=dormant (no scheduled posts; on-demand still available).

Available options:
true,
false
webhook
object

Webhook destination for delivering subscription notifications.

propertyReferences
object[]
tagReferences
object[]
suppressionReferences
object[]
returnStructure
object
schedule
object

If omitted, notifications typically trigger nightly after analysis/reporting.

Response

Created (batch result)

subscriptionRef
string
required

Unique ID assigned to the subscription.

subscriptionName
string
required
description
string
owner
string

Empty for global; username for private.

outputType
string
active
enum<string>
Available options:
true,
false
webhook
object

Webhook destination for delivering subscription notifications.

propertyReferences
object[]
tagReferences
object[]
suppressionReferences
object[]
returnStructure
object
schedule
object

If omitted, notifications typically trigger nightly after analysis/reporting.

webhookStatus
string

Success | Failure of last push to webhook (with timestamp).

lastTriggered
string

On-Demand Success/Failure or Scheduled Success/Failure with timestamp.

message
string

Error/status message (on error).

status
integer

HTTP-like status code (200, 204, 400, 401, 404, 415, 500).