Palo Alto Networks Certificate Tags API

openapi: 3.2.0
info:
  title: TLS Protect Cloud API for Strata Cloud Manager Certificate Tags API
  description: Use the TLS Protect Cloud APIs to manage certificates, certificate requests, applications, machine identities, users, teams, event logs, and more. This Open API spec file was created on June 04, 2026. © 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo Alto Networks. A list of our trademarks can be found at https://www.paloaltonetworks.com/company/trademarks.html. All other marks mentioned herein may be trademarks of their respective companies.
  version: 1.0.0
  license:
    name: MIT
    url: https://opensource.org/license/mit
servers:
- url: https://api.strata.paloaltonetworks.com/ngts
  description: Strata Cloud Manager API
security:
- scmToken: []
tags:
- name: Certificate Tags
  description: APIs for Certificate Tags.
paths:
  /v1/tags:
    get:
      description: Retrieve details of all available tags
      operationId: tags_getAll
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagResponse'
          description: Details of tags in response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Retrieve all tags
      tags:
      - Certificate Tags
    post:
      description: Create tag with optional values
      operationId: tags_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagRequest'
        description: Properties of the new tag.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagInformation'
          description: Tag is created. Details in response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Create a tag
      tags:
      - Certificate Tags
  /v1/tags/{name}:
    get:
      description: Retrieve a tag with 'name' attribute matching a specified value
      operationId: tags_getByName
      parameters:
      - description: Name of the tag.
        in: path
        name: name
        required: true
        schema:
          description: Name of the tag.
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagInformation'
          description: Details of tag in response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Tag not found
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Retrieve tag by name
      tags:
      - Certificate Tags
    delete:
      description: Delete a tag with 'name' attribute matching a specified value
      operationId: tags_deleteByName
      parameters:
      - description: Name of the tag.
        in: path
        name: name
        required: true
        schema:
          description: Name of the tag.
          type: string
      responses:
        '202':
          description: Tag is deleted
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Tag not found
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Delete tag by name
      tags:
      - Certificate Tags
  /v1/tags/{name}/values:
    get:
      description: Retrieve tag values for a tag with 'name' attribute matching specified value
      operationId: tags_get_values
      parameters:
      - description: Name of the tag.
        in: path
        name: name
        required: true
        schema:
          description: Name of the tag.
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagValuesResponse'
          description: Tag values in response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Tag not found
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Retrieve values for a tag
      tags:
      - Certificate Tags
    post:
      description: Create tag values for a tag with 'name' attribute matching specified value
      operationId: tag_values_create
      parameters:
      - description: Name of the tag.
        in: path
        name: name
        required: true
        schema:
          description: Name of the tag.
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagValuesRequest'
        description: The values of the tag.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagValuesResponse'
          description: Tag values created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Create tag values
      tags:
      - Certificate Tags
  /v1/tags/{name}/values/{value}:
    delete:
      description: Delete a value associated with a tag
      operationId: tags_deleteValueByName
      parameters:
      - description: Name of the tag
        in: path
        name: name
        required: true
        schema:
          description: Name of the tag
          type: string
      - description: Name of the value to delete
        in: path
        name: value
        required: true
        schema:
          description: Name of the value to delete
          type: string
      responses:
        '202':
          description: Tag value deleted
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Tag not found
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Delete a tag value
      tags:
      - Certificate Tags
  /v1/tags/values:
    get:
      description: Retrieve tag values for all tags
      operationId: tags_getAllValues
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagValuesResponse'
          description: Tag values in response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Retrieve values for all tags
      tags:
      - Certificate Tags
  /v1/tags/creation:
    post:
      description: Create tags in bulk with optional values
      operationId: tags_bulk_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsBulkRequest'
        description: Properties of the new tags.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsAndValuesResponse'
          description: Tags are created. Details in response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Create tags in bulk
      tags:
      - Certificate Tags
  /v1/tags/deletion:
    post:
      description: Delete tags in bulk by specified keys and values
      operationId: tags_bulk_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsBulkRequest'
        description: Properties of the tags to delete.
        required: true
      responses:
        '202':
          description: Tags are deleted
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Tags not found
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Delete tags in bulk
      tags:
      - Certificate Tags
  /v1/tagsassignment:
    patch:
      description: Replace, add, or delete one or more tags or tag values to/from one or more entities
      operationId: tags_assignToEntities
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsAssignRequest'
        description: Properties of the assignments.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsAssignResponse'
          description: Tag assign response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Replace Add Or Delete Tags
      tags:
      - Certificate Tags
  /v1/tagsassignment/aggregates:
    post:
      description: Bulk operation to retrieve number of entities per tag
      operationId: tags_assignmentAggregates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsAssignmentAggregatesRequest'
        description: Entity Type and list of tags and/or tag:value pairs.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsAssignmentAggregatesResponse'
          description: Entity type and total count per tag in response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse8'
          description: Incomplete or malformed request
      summary: Bulk operation to retrieve number of
      tags:
      - Certificate Tags
components:
  schemas:
    TagsAssignmentAggregatesRequest:
      properties:
        entityType:
          description: Object type that the tag applies to. If null, get all object types
          enum:
          - CERTIFICATE
          - CERTIFICATE_INSTANCE
          - APPLICATION
          example: CERTIFICATE
          type: string
        tags:
          description: Array of tags
          example:
          - TAG
          - Tag:Value
          items:
            description: Array of tags
            example: '["TAG","Tag:Value"]'
            type: string
          maxItems: 100
          type: array
          uniqueItems: true
      required:
      - tags
      type: object
    TagsAssignmentAggregatesResponse:
      properties:
        aggregates:
          additionalProperties:
            description: Represents a mapping of tag name to list of aggregates information
            items:
              $ref: '#/components/schemas/TagsAssignmentAggregatesResponseInformation'
            type: array
          description: Represents a mapping of tag name to list of aggregates information
          example:
            TagNew:
            - count: 2
              entityType: CERTIFICATE
            - count: 5
              entityType: APPLICATION
            tag:value:
            - count: 6
              entityType: CERTIFICATE
            - count: 1
              entityType: APPLICATION
          type: object
      type: object
    TagsAssignResponse:
      properties:
        tagsAssignInformation:
          items:
            $ref: '#/components/schemas/TagsAssignResponseInformation'
          type: array
      type: object
    ErrorResponse8:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/ErrorInformation8'
          type: array
      type: object
    TagsAndValuesResponse:
      properties:
        tagsAndValues:
          items:
            $ref: '#/components/schemas/TagsAndValuesInformation'
          type: array
      type: object
    TagRequest:
      description: Array of tag and tag-value objects
      properties:
        name:
          description: Name of the tag
          example: Application
          minLength: 1
          type: string
        values:
          description: Array of values associated with the tag
          example:
          - TLS Protect
          - Jetstack
          items:
            description: Array of values associated with the tag
            example: '["TLS Protect","Jetstack"]'
            type: string
          type: array
      required:
      - name
      type: object
    TagInformation:
      properties:
        companyId:
          description: UUID specific to your company
          example: 265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c
          format: uuid
          type: string
        id:
          description: UUID of the tag
          example: 265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c
          format: uuid
          type: string
        isReserved:
          description: Used by Venafi to reserve system tags
          example: false
          type: boolean
        key:
          description: Same as tag name, though all lowercase
          example: application
          type: string
        name:
          description: Name of the tag
          example: Application
          type: string
      type: object
    AnyValue8:
      description: Can be any value - string, number, boolean, array or object.
    TagValueInformation:
      properties:
        companyId:
          description: UUID specific to your company
          example: 265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c
          format: uuid
          type: string
        id:
          description: The ID of the value
          example: 265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c
          format: uuid
          type: string
        tagId:
          description: The ID of the tag the value applies to
          example: 265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c
          format: uuid
          type: string
        value:
          description: Name of the value
          example: TLS Protect
          type: string
      type: object
    TagsAssignmentAggregatesResponseInformation:
      description: Represents a mapping of tag name to list of aggregates information
      example:
        TagNew:
        - count: 2
          entityType: CERTIFICATE
        - count: 5
          entityType: APPLICATION
        tag:value:
        - count: 6
          entityType: CERTIFICATE
        - count: 1
          entityType: APPLICATION
      properties:
        count:
          description: Number of entities per type
          example: 2
          format: int32
          type: integer
        entityType:
          description: Object type that the tag applies to
          example: CERTIFICATE
          type: string
      type: object
    TagValuesRequest:
      properties:
        values:
          description: Array of value names to associate with the tag
          items:
            description: Array of value names to associate with the tag
            example: 265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c
            type: string
          minItems: 1
          type: array
      required:
      - values
      type: object
    TagValuesResponse:
      properties:
        count:
          description: Number of values returned
          example: 7
          format: int32
          type: integer
        values:
          items:
            $ref: '#/components/schemas/TagValueInformation'
          type: array
      type: object
    TagsAssignResponseInformation:
      properties:
        companyId:
          description: UUID specific to your company
          example: 265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c
          format: uuid
          type: string
        creationDate:
          description: The date when the assignment is created
          example: '2023-01-30T16:28:53.166Z'
          format: date-time
          type: string
        entityId:
          description: UUID of the object
          example: 265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c
          format: uuid
          type: string
        entityType:
          description: Object type that the tag applies to
          example: CERTIFICATE
          type: string
        errorInformation:
          $ref: '#/components/schemas/TagAssignmentErrorInformation'
        modificationDate:
          description: The date when the assignment is last modified
          example: '2023-01-30T16:28:53.166Z'
          format: date-time
          type: string
        status:
          description: Status of the assigned entity
          example: ASSIGNED
          type: string
        tags:
          description: The tags that are assigned
          example:
          - Application:TLS
          items:
            description: The tags that are assigned
            example: '["Application:TLS"]'
            type: string
          type: array
          uniqueItems: true
      type: object
    TagResponse:
      properties:
        count:
          description: Number of tags returned
          example: 7
          format: int32
          type: integer
        tags:
          items:
            $ref: '#/components/schemas/TagInformation'
          type: array
      type: object
    ErrorInformation8:
      properties:
        args:
          items:
            $ref: '#/components/schemas/AnyValue8'
          type: array
        code:
          format: int32
          type: integer
        message:
          type: string
      type: object
    TagsAndValuesInformation:
      properties:
        tag:
          $ref: '#/components/schemas/TagInformation'
        values:
          items:
            $ref: '#/components/schemas/TagValueInformation'
          type: array
      type: object
    TagAssignmentErrorInformation:
      description: Error information for tags not assigned
      example:
        errorInformation:
          message: not assigned
          statusCode: 1111
      properties:
        args:
          items:
            $ref: '#/components/schemas/AnyValue8'
          type: array
        message:
          type: string
        statusCode:
          format: int32
          type: integer
      type: object
    TagsBulkRequest:
      properties:
        tags:
          description: Array of tag and tag-value objects
          items:
            $ref: '#/components/schemas/TagRequest'
          type: array
      type: object
    TagsAssignRequest:
      properties:
        action:
          description: Action to perform
          enum:
          - REPLACE
          - ADD
          - DELETE
          - DELETE_ALL
          example: REPLACE
          type: string
        entityIds:
          description: Array of UUIDs of the objects
          example:
          - 265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c
          items:
            description: Array of UUIDs of the objects
            format: uuid
            type: string
          minItems: 1
          type: array
          uniqueItems: true
        entityType:
          description: Object type that the tag applies to
          enum:
          - CERTIFICATE
          - CERTIFICATE_INSTANCE
          - APPLICATION
          example: CERTIFICATE
          type: string
        targetedTags:
          description: Array of tags to apply
          example:
          - 265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c
          items:
            description: Array of tags to apply
            example: '["265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c"]'
            type: string
          type: array
          uniqueItems: true
      required:
      - entityIds
      type: object
  securitySchemes:
    scmOAuth:
      type: oauth2
      description: 'Strata Cloud Manager APIs authenticate client requests using the OAuth 2.0 Client Credentials flow. Please use the `client_id`, `client_secret` values associated with an IAM service account along with a scope value of `tsg_id:XXXXXXXXXX`, where `XXXXXXXXXX` is the Tenant Service Group (TSG) ID. The resulting JWT access token should be attached to all API calls as a `Bearer` token in the `Authorization` header (ex. `Authorization: Bearer tokenstring`).'
      flows:
        clientCredentials:
          tokenUrl: https://auth.apps.paloaltonetworks.com/oauth2/access_token
          scopes: {}
    scmToken:
      type: http
      description: 'Strata Cloud Manager APIs authenticate client requests using the OAuth 2.0 Client Credentials flow. Please use the `client_id`, `client_secret` values associated with an IAM service account along with a scope value of `tsg_id:XXXXXXXXXX`, where `XXXXXXXXXX` is the Tenant Service Group (TSG) ID. The resulting JWT access token should be attached to all API calls as a `Bearer` token in the `Authorization` header (ex. `Authorization: Bearer tokenstring`).'
      scheme: bearer
      bearerFormat: JWT