Skip to main content

Update a Tag

PUT 
/api/v32.04/tags/:id
x-prisma-cloud-target-env: {"permission":"collections","saas":true,"self-hosted":true}
x-public: true

Updates the parameters in a given tag.

You must define all parameters in your PUT request.

Note: "" (an empty string) is automatically assigned for any unspecified field.

cURL Request​

Refer to the following example cURL command that updates the parameters in a tag named my_tag:

$ curl -k \
  -u <USER> \
  -H 'Content-Type: application/json' \
  -X PUT \
  -d \
'{
   "name": "my_tag2",
   "color": "#ff0000",
   "description": "A super cool tag"
 }' \
  "https://<CONSOLE>/api/v<VERSION>/tags/my_tag"

Request​

Path Parameters

    id stringrequired

Body

    color common.Color (string)

    Color is a hexadecimal representation of color code value

    description string

    Description is the tag description.

    name string

    Name is the tag name.

    vulns object[]

    Vulns are the tagged vulnerabilities.

  • Array [
    • checkBaseLayer boolean

    (Applies only to the resource type 'image') Checks whether the base layer in an image is the resource image.

    comment string

    Adds a comment.

    id string

    Specifies the Common Vulnerability and Exposures (CVE) ID.

    packageName string

    Specifies the source or the binary package name where the vulnerability is found. Use the source package name for tagging if only source package exists. Use the wildcard * for tagging all the packages.

    resourceType vuln.TagType (string)

    Possible values: [image,host,function,]

    TagType specifies the resource type for tagging where the vulnerability is found. Use the wildcard * to apply the tag to all the resource types where the vulnerability is found

    resources string (string)[]

    (Required when you define the resource type) Specifies the resources for tagging where the vulnerability is found. Either specify the resource names separated by a comma or use the wildcard * to apply the tag to all the resources where the vulnerability is found.

  • ]

Responses​

OK

Loading...