Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-17111176225.7 KB
Subscriptions

Add a subscription of a specific type

Create a new subscription to watch a tag and get notifications of changes

post/subscriptions

Headers

x-anchore-accountstring

An account name to change the resource scope of the request to that account, if permissions allow (admin only)

Request body

subscription_keystring
subscription_valuestring nullable
subscription_typestring

Example request

{
  "subscription_value": "subscription_value",
  "subscription_key": "subscription_key",
  "subscription_type": "subscription_type"
}

Response

Subscription add success

subscription_keystring

The key value that the subscription references. E.g. a tag value or a repo name.

subscription_typestring

The type of the subscription

subscription_valuestring nullable

The value of the subscription target

userIdstring

The userId of the subscribed user

activeboolean

Is the subscription currently active

subscription_idstring

the unique id for this subscription record

Example response

[
  {
    "subscription_id": "subscription_id",
    "subscription_value": "subscription_value",
    "active": true,
    "subscription_key": "subscription_key",
    "subscription_type": "subscription_type",
    "userId": "userId"
  }
]