Subscriptions

Update an existing and specific subscription

put/subscriptions/{subscriptionId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /subscriptions/{subscriptionId}
  • Auth
    none declared

Path parameters

subscriptionIdstring required

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_valuestring nullable

The new subscription value, e.g. the new tag to be subscribed to

activeboolean

Toggle the subscription processing on or off

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

Changes

No recorded changes to this operation across all 70 revisions of this API.