Subscriptions

Update an existing and specific subscription

Changed on
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

Example request

{
  "subscription_value": "subscription_value",
  "active": true
}

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"
  }
]

Changes

  • 38e5705e0b21Revision changes
    • info

      removed the analysis_update enum value from the / response property for the response status

    • info

      removed the policy_eval enum value from the / response property for the response status

    • info

      removed the repo_update enum value from the / response property for the response status

    • info

      removed the tag_update enum value from the / response property for the response status

    • info

      removed the vuln_update enum value from the / response property for the response status

  • 75f483ab10a0Revision changes
    • warning

      added the new analysis_update enum value to the / response property for the response status

    • warning

      added the new policy_eval enum value to the / response property for the response status

    • warning

      added the new repo_update enum value to the / response property for the response status

    • warning

      added the new tag_update enum value to the / response property for the response status

    • warning

      added the new vuln_update enum value to the / response property for the response status