Create Custom Tag Rule

POST 
/code/api/v1/tag-rules

Prisma Cloud Application Security supports tagging management for IaC templates, based on the company’s open-source tool Yor (https://yor.io/). With tag rules, you can manage your tagging strategies easily across providers and repositories, even before they go live. Such capability allows users to enable out-of-the-box (OOTB) Prisma Cloud Application Security tag rules, such as the traceability tag (“yor_trace”) used for code-to-cloud resource tracing and drift detection. Furthermore, Prisma Cloud Application Security enables custom tag rule creation and management (edit, clone, enable, disable and delete).

This API is used to save a new custom tag rule definition based on input of:

• Repositories
• Rule definition
• Key name
• Rule status (enabled/disabled)
• Description (a sentence explaining the rule)

The response includes:

• Repositories where the rule is applied
• Rule Definition
• Rule status (enabled/disabled)
• Rule ID
• Rule name
• Description

Request

application/json

Body

required

description string
isEnabled boolean
name stringrequired
repositories string[]required
ruleDefinition objectrequired
tag_groups object[]required
Array [
name stringrequired
tags object[]required
Array [
name stringrequired
value objectrequired
default string
matches object[]
Array [
object
]
]
]
tagRuleOOTBId string

Responses

200

Tag saved

application/json

Schema

Schema

canDoActions boolean
createdBy stringrequired
creationDate stringrequired
definition objectrequired
tag_groups object[]required
Array [
name stringrequired
tags object[]required
Array [
name stringrequired
value objectrequired
default string
matches object[]
Array [
object
]
]
]
description string
id stringrequired
isEnabled booleanrequired
name stringrequired
repositories string[]required
tagRuleOOTBId string

Example (from schema)

{
  "canDoActions": true,
  "createdBy": "string",
  "creationDate": "string",
  "definition": {
    "tag_groups": [
      {
        "name": "string",
        "tags": [
          {
            "name": "string",
            "value": {
              "default": "string",
              "matches": [
                {}
              ]
            }
          }
        ]
      }
    ]
  },
  "description": "string",
  "id": "string",
  "isEnabled": true,
  "name": "string",
  "repositories": [
    "string"
  ],
  "tagRuleOOTBId": "string"
}

422

Request arguments validation error

Loading...