Subscriptions

Add a subscription of a specific type

Changed on

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

post/subscriptions

Request

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

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

Changes

  • 38e5705e0b21Revision changes
    • breaking

      removed the enum value analysis_update of the request property

    • breaking

      removed the enum value policy_eval of the request property

    • breaking

      removed the enum value repo_update of the request property

    • breaking

      removed the enum value tag_update of the request property

    • breaking

      removed the enum value vuln_update of the request property

    • 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
    • breaking

      request property was restricted to a list of enum values

    • 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

    • info

      added the new analysis_update enum value to the request property

    • info

      added the new policy_eval enum value to the request property

    • info

      added the new repo_update enum value to the request property

    • info

      added the new tag_update enum value to the request property

    • info

      added the new vuln_update enum value to the request property