Palo Alto Networks Manage NGFW Tags API

openapi: 3.2.0
info:
  contact: {}
  description: "Apply tags to help search and filter your Cloud NGFW resources.\n\n### Permission Policies\n\n| Action                         | Local Firewall Administrator  | Local Rulestack Administrator | Global Rulestack Administrator |\n| ------------------------------ | :---------------------------: | :---------------------------: | :----------------------------: |\n| Tag Resource                   | **☑**                   | ☐                       | ☐                        | \n| Untag Resource                 | **☑**                   | ☐                       | ☐                        |                      \n| List Firewall Tags             | **☑**                   | **☑**                   | ☐                        |\n"
  title: Manage Cloud NGFW Tags Manage NGFW Tags API
  version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: ManageNGFWTags
paths:
  /v1/config/ngfirewalls/{ngfirewallname}/tags:
    delete:
      description: 'Remove the tags associated with a resource.

        '
      operationId: delete-v1-config-ngfirewalls-ngfirewallname-tags
      parameters:
      - description: ''
        in: path
        name: ngfirewallname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FirewallUntagResourceRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FirewallUntagResourceResponse'
          description: OK
      summary: Remove firewall tags
      tags:
      - ManageNGFWTags
    get:
      description: 'Retrieve the tags associated with a resource.

        '
      operationId: get-v1-config-ngfirewalls-ngfirewallname-tags
      parameters:
      - description: ''
        in: path
        name: ngfirewallname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FirewallListTagsForResourceRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FirewallListTagsForResourceResponse'
          description: OK
      summary: Retrieve firewall tags
      tags:
      - ManageNGFWTags
    post:
      description: 'Add tags to a resource. Tag the resources you manage through NGFW firewalls and policies.

        '
      operationId: post-v1-config-ngfirewalls-ngfirewallname-tags
      parameters:
      - description: 'The name of the NGFW.

          '
        in: path
        name: ngfirewallname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FirewallTagResourceRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FirewallTagResourceResponse'
          description: OK
      summary: Add firewall tags
      tags:
      - ManageNGFWTags
components:
  schemas:
    FirewallListTagsForResourceResponse.ResponseData:
      additionalProperties: false
      properties:
        AccountId:
          title: Accountid
          type: string
        FirewallName:
          title: Firewallname
          type: string
        NextToken:
          title: Nexttoken
          type: string
        Tags:
          items:
            $ref: '#/components/schemas/FirewallListTagsForResourceResponse.TagEntry'
          title: Tags
          type: array
      title: ResponseData
      type: object
    FirewallUntagResourceResponse.ResponseData:
      additionalProperties: false
      properties:
        AccountId:
          title: Accountid
          type: string
        FirewallName:
          title: Firewallname
          type: string
        TagKeys:
          items:
            type: string
          title: Tagkeys
          type: array
      title: ResponseData
      type: object
    FirewallTagResourceResponse.ResponseData:
      additionalProperties: false
      properties:
        FirewallName:
          title: Firewallname
          type: string
        Tags:
          items:
            $ref: '#/components/schemas/FirewallTagResourceResponse.TagEntry'
          title: Tags
          type: array
      title: ResponseData
      type: object
    FirewallListTagsForResourceResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/FirewallListTagsForResourceResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/FirewallListTagsForResourceResponse.Result'
      title: FirewallListTagsForResourceResponse
      type: object
    FirewallUntagResourceResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    FirewallTagResourceResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    FirewallListTagsForResourceRequest:
      additionalProperties: false
      properties:
        AccountId:
          title: Accountid
          type: string
        MaxResults:
          default: 1024
          maximum: 1024
          minimum: 1
          title: Maxresults
          type: integer
        NextToken:
          title: Nexttoken
          type: string
      required:
      - AccountId
      title: FirewallListTagsForResourceRequest
      type: object
    FirewallTagResourceResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/FirewallTagResourceResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/FirewallTagResourceResponse.Result'
      title: FirewallTagResourceResponse
      type: object
    FirewallTagResourceResponse.TagEntry:
      additionalProperties: false
      properties:
        Key:
          title: Key
          type: string
        Value:
          title: Value
          type: string
      required:
      - Key
      - Value
      title: TagEntry
      type: object
    FirewallListTagsForResourceResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    FirewallUntagResourceRequest:
      additionalProperties: false
      properties:
        AccountId:
          title: Accountid
          type: string
        TagKeys:
          items:
            maxLength: 128
            minLength: 1
            pattern: ^.*$
            type: string
          maxItems: 50
          title: Tagkeys
          type: array
      required:
      - AccountId
      - TagKeys
      title: FirewallUntagResourceRequest
      type: object
    FirewallTagResourceRequest.TagEntry:
      additionalProperties: false
      properties:
        Key:
          title: Key
          type: string
        Value:
          title: Value
          type: string
      required:
      - Key
      - Value
      title: TagEntry
      type: object
    FirewallTagResourceRequest:
      additionalProperties: false
      properties:
        AccountId:
          title: Accountid
          type: string
        Tags:
          items:
            $ref: '#/components/schemas/FirewallTagResourceRequest.TagEntry'
          maxItems: 50
          title: Tags
          type: array
      required:
      - AccountId
      - Tags
      title: FirewallTagResourceRequest
      type: object
    FirewallListTagsForResourceResponse.TagEntry:
      additionalProperties: false
      properties:
        Key:
          title: Key
          type: string
        Value:
          title: Value
          type: string
      required:
      - Key
      - Value
      title: TagEntry
      type: object
    FirewallUntagResourceResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/FirewallUntagResourceResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/FirewallUntagResourceResponse.Result'
      title: FirewallUntagResourceResponse
      type: object