openapi: 3.2.0
info:
  contact: {}
  description: "Address objects with type Fully Qualified Domain Name (FQDN). An FQDN object provides further ease of use because DNS provides the FQDN resolution to the IP addresses instead of you needing to know the IP addresses and manually updating them every time the FQDN resolves to a new IP address.\n\nThese are the following formats for FQDN.  \n\n- Host names are composed of a sequence of labels concatenated with dots\n- Each label must be from 1 to 63 characters long\n- The entire host name, including the delimiting dots, has a maximum of 253 ASCII characters\n- DNS names can contain only alphabetical characters (A-Z), numeric characters (0-9), minus sign (-), and period (.)  \n\nFor more information, see [FQDN formats](https://en.wikipedia.org/wiki/Hostname).\n\n### Permission Policies\n\n| Action                       | Local Firewall Administrator  | Local Rulestack Administrator | Global Rulestack Administrator |\n| ---------------------------- | :---------------------------: | :---------------------------: | :----------------------------: |\n| Create FQDN List             | ☐                       | **☑**                   | **☑**                    | \n| Delete FQDN List             | ☐                       | **☑**                   | **☑**                    |                        \n| Update FQDN List             | ☐                       | **☑**                   | **☑**                    |   \n| List FQDN Lists              | **☑**                   | **☑**                   | **☑**                    |\n| Describe FQDN List           | **☑**                   | **☑**                   | **☑**                    |\n"
  title: Manage FQDN List API
  version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: FQDNList
paths:
  /v1/config/rulestacks/{rulestackname}/fqdnlists:
    get:
      description: 'Retrieve information about the FQDN lists for the specified rulestack.

        '
      operationId: get-v1-config-rulestacks-rulestackname-fqdnlists
      parameters:
      - description: ''
        in: query
        name: nexttoken
        required: false
        schema:
          title: Nexttoken
          type: string
      - description: ''
        in: query
        name: candidate
        required: false
        schema:
          default: true
          title: Candidate
          type: boolean
      - description: ''
        in: query
        name: running
        required: false
        schema:
          default: false
          title: Running
          type: boolean
      - description: ''
        in: query
        name: uncommitted
        required: false
        schema:
          default: false
          title: Uncommitted
          type: boolean
      - description: ''
        in: query
        name: maxresults
        required: false
        schema:
          default: 1024
          maximum: 1024
          minimum: 1
          title: Maxresults
          type: integer
      - description: ''
        in: query
        name: describe
        required: false
        schema:
          default: false
          title: Describe
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFqdnListResponse'
          description: OK
      summary: Retrieve FQDN lists
      tags:
      - FQDNList
    post:
      description: 'Create an FQDN list for a rulestack.

        '
      operationId: post-v1-config-rulestacks-rulestackname-fqdnlists
      parameters:
      - description: 'The name of the rulestack.

          '
        in: path
        name: rulestackname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFqdnListRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFqdnListResponse'
          description: OK
      summary: Create FQDN list
      tags:
      - FQDNList
  /v1/config/rulestacks/{rulestackname}/fqdnlists/{name}:
    delete:
      description: 'Delete the FQDN list associated with a rulestack.

        '
      operationId: delete-v1-config-rulestacks-rulestackname-fqdnlists-name
      parameters:
      - description: 'The name of the rulestack.

          '
        in: path
        name: rulestackname
        required: true
        schema:
          type: string
      - description: 'The name of the FQDN list.

          '
        in: path
        name: name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFqdnListRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFqdnListResponse'
          description: OK
      summary: Delete FQDN list
      tags:
      - FQDNList
    get:
      description: 'Retrieve information about the FQDN list associated with a rulestack.

        '
      operationId: get-v1-config-rulestacks-rulestackname-fqdnlists-name
      parameters:
      - description: 'The name of the rulestack.

          '
        in: path
        name: rulestackname
        required: true
        schema:
          type: string
      - description: 'The name of the FQDN list.

          '
        in: path
        name: name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeFqdnListRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeFqdnListResponse'
          description: OK
      summary: Retrieve FQDN list
      tags:
      - FQDNList
    put:
      description: 'Update the FQDN list associated with a rulestack.

        '
      operationId: put-v1-config-rulestacks-rulestackname-fqdnlists-name
      parameters:
      - description: 'The name of the rulestack.

          '
        in: path
        name: rulestackname
        required: true
        schema:
          type: string
      - description: 'The name of the FQDN list.

          '
        in: path
        name: name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFqdnListRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFqdnListResponse'
          description: OK
      summary: Update FQDN list
      tags:
      - FQDNList
components:
  schemas:
    DeleteFqdnListResponse.FqdnListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          title: Auditcomment
          type: string
        Description:
          title: Description
          type: string
        FqdnList:
          items:
            maxLength: 255
            minLength: 1
            pattern: ^[a-zA-Z0-9._-]+$
            type: string
          title: Fqdnlist
          type: array
        UpdateToken:
          title: Updatetoken
          type: string
      required:
      - FqdnList
      title: FqdnListDetails
      type: object
    CreateFqdnListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    DeleteFqdnListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/DeleteFqdnListResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/DeleteFqdnListResponse.Result'
      title: DeleteFqdnListResponse
      type: object
    ListFqdnListResponse.UncommittedFqdnListDetails:
      additionalProperties: false
      properties:
        Name:
          maxLength: 128
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
          title: Name
          type: string
        operation:
          title: Operation
          type: string
      required:
      - Name
      - operation
      title: UncommittedFqdnListDetails
      type: object
    CreateFqdnListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/CreateFqdnListResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/CreateFqdnListResponse.Result'
      title: CreateFqdnListResponse
      type: object
    DeleteFqdnListRequest:
      additionalProperties: false
      properties: {}
      title: DeleteFqdnListRequest
      type: object
    DescribeFqdnListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    ListFqdnListResponse.ResponseData:
      additionalProperties: false
      properties:
        FqdnListCandidate:
          items:
            type: string
          title: Fqdnlistcandidate
          type: array
        FqdnListRunning:
          items:
            type: string
          title: Fqdnlistrunning
          type: array
        FqdnListUncommitted:
          items:
            $ref: '#/components/schemas/ListFqdnListResponse.UncommittedFqdnListDetails'
          title: Fqdnlistuncommitted
          type: array
        NextToken:
          title: Nexttoken
          type: string
        RuleStackName:
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    DeleteFqdnListResponse.ResponseData:
      additionalProperties: false
      properties:
        FqdnListEntry:
          $ref: '#/components/schemas/DeleteFqdnListResponse.FqdnListDetails'
        Name:
          title: Name
          type: string
        RuleStackName:
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    DescribeFqdnListResponse.FqdnListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          title: Auditcomment
          type: string
        Description:
          title: Description
          type: string
        FqdnList:
          items:
            maxLength: 255
            minLength: 1
            pattern: ^[a-zA-Z0-9._-]+$
            type: string
          title: Fqdnlist
          type: array
      required:
      - FqdnList
      title: FqdnListDetails
      type: object
    CreateFqdnListResponse.FqdnListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          title: Auditcomment
          type: string
        Description:
          title: Description
          type: string
        FqdnList:
          items:
            maxLength: 255
            minLength: 1
            pattern: ^[a-zA-Z0-9._-]+$
            type: string
          title: Fqdnlist
          type: array
        UpdateToken:
          title: Updatetoken
          type: string
      required:
      - FqdnList
      title: FqdnListDetails
      type: object
    DescribeFqdnListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/DescribeFqdnListResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/DescribeFqdnListResponse.Result'
      title: DescribeFqdnListResponse
      type: object
    DeleteFqdnListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    UpdateFqdnListRequest:
      additionalProperties: false
      properties:
        AuditComment:
          maxLength: 512
          title: Auditcomment
          type: string
        Description:
          maxLength: 512
          title: Description
          type: string
        FqdnList:
          items:
            maxLength: 255
            minLength: 1
            pattern: ^[a-zA-Z0-9._-]+$
            type: string
          title: Fqdnlist
          type: array
      required:
      - FqdnList
      title: UpdateFqdnListRequest
      type: object
    CreateFqdnListResponse.ResponseData:
      additionalProperties: false
      properties:
        FqdnListEntry:
          $ref: '#/components/schemas/CreateFqdnListResponse.FqdnListDetails'
        Name:
          title: Name
          type: string
        RuleStackName:
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    UpdateFqdnListResponse.FqdnListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          title: Auditcomment
          type: string
        Description:
          title: Description
          type: string
        FqdnList:
          items:
            maxLength: 255
            minLength: 1
            pattern: ^[a-zA-Z0-9._-]+$
            type: string
          title: Fqdnlist
          type: array
        UpdateToken:
          title: Updatetoken
          type: string
      required:
      - FqdnList
      title: FqdnListDetails
      type: object
    ListFqdnListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/ListFqdnListResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/ListFqdnListResponse.Result'
      title: ListFqdnListResponse
      type: object
    UpdateFqdnListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    DescribeFqdnListResponse.ResponseData:
      additionalProperties: false
      properties:
        FqdnListCandidate:
          $ref: '#/components/schemas/DescribeFqdnListResponse.FqdnListDetails'
        FqdnListRunning:
          $ref: '#/components/schemas/DescribeFqdnListResponse.FqdnListInfo'
        Name:
          title: Name
          type: string
        RuleStackName:
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    UpdateFqdnListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/UpdateFqdnListResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/UpdateFqdnListResponse.Result'
      title: UpdateFqdnListResponse
      type: object
    UpdateFqdnListResponse.ResponseData:
      additionalProperties: false
      properties:
        FqdnListEntry:
          $ref: '#/components/schemas/UpdateFqdnListResponse.FqdnListDetails'
        Name:
          title: Name
          type: string
        RuleStackName:
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    CreateFqdnListRequest:
      additionalProperties: false
      properties:
        AuditComment:
          maxLength: 512
          title: Auditcomment
          type: string
        Description:
          maxLength: 512
          title: Description
          type: string
        FqdnList:
          items:
            maxLength: 255
            minLength: 1
            pattern: ^[a-zA-Z0-9._-]+$
            type: string
          title: Fqdnlist
          type: array
        Name:
          maxLength: 58
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
          title: Name
          type: string
      required:
      - Name
      - FqdnList
      title: CreateFqdnListRequest
      type: object
    ListFqdnListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    DescribeFqdnListResponse.FqdnListInfo:
      additionalProperties: false
      properties:
        AuditComment:
          title: Auditcomment
          type: string
        Description:
          title: Description
          type: string
        FqdnList:
          items:
            maxLength: 255
            minLength: 1
            pattern: ^[a-zA-Z0-9._-]+$
            type: string
          title: Fqdnlist
          type: array
      required:
      - FqdnList
      title: FqdnListInfo
      type: object
    DescribeFqdnListRequest:
      additionalProperties: false
      properties:
        Candidate:
          default: true
          title: Candidate
          type: boolean
        Running:
          default: false
          title: Running
          type: boolean
      title: DescribeFqdnListRequest
      type: object