Palo Alto Networks Manage FQDN Lists API

openapi: 3.2.0
info:
  contact: {}
  description: "For Fully Qualified Domain Name (FQDN) address objects, DNS provides the FQDN resolution to the IP addresses eliminating the need to manually update them every time you resolve 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"
  title: Manage FQDN Lists API
  version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: ManageFQDNLists
paths:
  /v1/config/rulestacks/{rulestackname}/fqdnlists:
    get:
      description: "Retrieve the information about the FDQN lists for the specified rulestack. \n"
      operationId: get-v1-config-rulestacks-rulestackname-fqdnlists
      parameters:
      - description: 'If the number of FQDNs available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of FQDN list, use this token in your next request.

          '
        in: query
        name: nexttoken
        required: false
        schema:
          title: Nexttoken
          type: string
      - description: 'FQDN candidate.

          '
        in: query
        name: candidate
        required: false
        schema:
          default: true
          title: Candidate
          type: boolean
      - description: 'FQDNs in run state.

          '
        in: query
        name: running
        required: false
        schema:
          default: false
          title: Running
          type: boolean
      - description: 'Uncommitted FQDN lists.

          '
        in: query
        name: uncommitted
        required: false
        schema:
          default: false
          title: Uncommitted
          type: boolean
      - description: 'The maximum number of FQDNs that you want NGFW to return for this request.

          '
        in: query
        name: maxresults
        required: false
        schema:
          default: 1024
          maximum: 1024
          minimum: 1
          title: Maxresults
          type: integer
      - description: 'Retrieve FQDN information.

          '
        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: List FQDNLists
      tags:
      - ManageFQDNLists
    post:
      description: 'Create a 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 a FQDNList
      tags:
      - ManageFQDNLists
  /v1/config/rulestacks/{rulestackname}/fqdnlists/{name}:
    delete:
      description: "Delete the FDQN list associated with a rulestack. \n"
      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 a FQDNList
      tags:
      - ManageFQDNLists
    get:
      description: "Return the information the FDQN list associated with a rulestack. \n"
      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: Describe a FQDNList
      tags:
      - ManageFQDNLists
    put:
      description: 'Update the FDQN 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 a FQDNList
      tags:
      - ManageFQDNLists
components:
  schemas:
    DeleteFqdnListResponse.FqdnListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          description: "Audit remarks.    \n"
          title: Auditcomment
          type: string
        Description:
          description: "The FQDN list description. \n"
          title: Description
          type: string
        FqdnList:
          description: "FQDN list.    \n"
          items:
            maxLength: 255
            minLength: 1
            pattern: ^[a-zA-Z0-9._-]+$
            type: string
          title: Fqdnlist
          type: array
        UpdateToken:
          description: 'Refresh token.

            '
          title: Updatetoken
          type: string
      required:
      - FqdnList
      title: FqdnListDetails
      type: object
    CreateFqdnListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          description: "Default value of a successful response is 0. Any other number indicates an error code.  \n\n400—HTTP bad request\n* InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.\n* LimitExceededException—Operation failed due to violation in limit settings.\n* ThrottlingException—Operation failed due to throttling limitations.\n* AccessDeniedException—You do not have sufficient access to perform this action.\n\n500—Bad request \n* InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.\n* InsufficientCapacityException—AWS currently does not have enough capacity to fulfill your request.\n"
          title: Errorcode
          type: integer
        Reason:
          description: 'The error description.

            '
          title: Reason
          type: string
      title: Result
      type: object
    DeleteFqdnListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/DeleteFqdnListResponse.ResponseData'
          description: 'The API call response.

            '
        ResponseStatus:
          $ref: '#/components/schemas/DeleteFqdnListResponse.Result'
          description: 'The API call response status.

            '
      title: DeleteFqdnListResponse
      type: object
    ListFqdnListResponse.UncommittedFqdnListDetails:
      additionalProperties: false
      properties:
        Name:
          description: 'Name of the FQDN list.

            '
          maxLength: 128
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
          title: Name
          type: string
        operation:
          description: 'FQDN list operation.

            '
          title: Operation
          type: string
      required:
      - Name
      - operation
      title: UncommittedFqdnListDetails
      type: object
    CreateFqdnListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/CreateFqdnListResponse.ResponseData'
          description: 'The API call response.

            '
        ResponseStatus:
          $ref: '#/components/schemas/CreateFqdnListResponse.Result'
          description: 'The API call response status.

            '
      title: CreateFqdnListResponse
      type: object
    DeleteFqdnListRequest:
      additionalProperties: false
      properties: {}
      title: DeleteFqdnListRequest
      type: object
    DescribeFqdnListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          description: "Default value of a successful response is 0. Any other number indicates an error code.  \n\n400—HTTP bad request\n* InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.\n* LimitExceededException—Operation failed due to violation in limit settings.\n* ThrottlingException—Operation failed due to throttling limitations.\n* AccessDeniedException—You do not have sufficient access to perform this action.\n\n500—Bad request \n* InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.\n* InsufficientCapacityException—AWS currently does not have enough capacity to fulfill your request.\n"
          title: Errorcode
          type: integer
        Reason:
          description: 'The error description.

            '
          title: Reason
          type: string
      title: Result
      type: object
    ListFqdnListResponse.ResponseData:
      additionalProperties: false
      properties:
        FqdnListCandidate:
          description: 'FQDN list candidate.

            '
          items:
            type: string
          title: Fqdnlistcandidate
          type: array
        FqdnListRunning:
          description: 'FQDN lists on run state.

            '
          items:
            type: string
          title: Fqdnlistrunning
          type: array
        FqdnListUncommitted:
          description: 'Uncommitted FQDN lists.

            '
          items:
            $ref: '#/components/schemas/ListFqdnListResponse.UncommittedFqdnListDetails'
          title: Fqdnlistuncommitted
          type: array
        NextToken:
          description: 'If the number of FQDN lists available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of FQDN list, use this token in your next request.

            '
          title: Nexttoken
          type: string
        RuleStackName:
          description: 'Name of the rulestack.

            '
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    DeleteFqdnListResponse.ResponseData:
      additionalProperties: false
      properties:
        FqdnListEntry:
          $ref: '#/components/schemas/DeleteFqdnListResponse.FqdnListDetails'
          description: 'The FQDN list entry.

            '
        Name:
          description: "Name of the FQDN list.    \n"
          title: Name
          type: string
        RuleStackName:
          description: "Name of the rulestack. \n"
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    DescribeFqdnListResponse.FqdnListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          description: "Audit remarks.    \n"
          title: Auditcomment
          type: string
        Description:
          description: 'The FQDN list description.

            '
          title: Description
          type: string
        FqdnList:
          description: 'The FQDN list.

            '
          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:
          description: "Audit remarks.    \n"
          title: Auditcomment
          type: string
        Description:
          description: "The FQDN list description. \n"
          title: Description
          type: string
        FqdnList:
          description: "FQDN list.    \n"
          items:
            maxLength: 255
            minLength: 1
            pattern: ^[a-zA-Z0-9._-]+$
            type: string
          title: Fqdnlist
          type: array
        UpdateToken:
          description: 'Refresh token.

            '
          title: Updatetoken
          type: string
      required:
      - FqdnList
      title: FqdnListDetails
      type: object
    DescribeFqdnListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/DescribeFqdnListResponse.ResponseData'
          description: 'The API call response.

            '
        ResponseStatus:
          $ref: '#/components/schemas/DescribeFqdnListResponse.Result'
          description: 'The API call response status.

            '
      title: DescribeFqdnListResponse
      type: object
    DeleteFqdnListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          description: "Default value of a successful response is 0. Any other number indicates an error code.  \n\n400—HTTP bad request\n* InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.\n* LimitExceededException—Operation failed due to violation in limit settings.\n* ResourceNotFoundException—Unable to locate a resource using the parameters you provided.\n* ThrottlingException—Operation failed due to throttling limitations.\n* AccessDeniedException—You do not have sufficient access to perform this action.\n\n500—Bad request \n* InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.\n* InsufficientCapacityException—AWS currently does not have enough capacity to fulfill your request.\n"
          title: Errorcode
          type: integer
        Reason:
          description: 'The error description.

            '
          title: Reason
          type: string
      title: Result
      type: object
    UpdateFqdnListRequest:
      additionalProperties: false
      properties:
        AuditComment:
          description: 'The URL category audit remarks.

            '
          maxLength: 512
          title: Auditcomment
          type: string
        Description:
          description: 'A description of the rulestack.

            '
          maxLength: 512
          title: Description
          type: string
        FqdnList:
          description: 'The FQDN address objects list.

            '
          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'
          description: 'The FQDN list entry.

            '
        Name:
          description: "Name of the FQDN list.    \n"
          title: Name
          type: string
        RuleStackName:
          description: "Name of the rulestack. \n"
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    UpdateFqdnListResponse.FqdnListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          description: "Audit remarks.    \n"
          title: Auditcomment
          type: string
        Description:
          description: "The FQDN list description. \n"
          title: Description
          type: string
        FqdnList:
          description: "FQDN list.    \n"
          items:
            maxLength: 255
            minLength: 1
            pattern: ^[a-zA-Z0-9._-]+$
            type: string
          title: Fqdnlist
          type: array
        UpdateToken:
          description: 'Refresh token.

            '
          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
          description: "Default value of a successful response is 0. Any other number indicates an error code.  \n\n400—HTTP bad request\n* InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.\n* LimitExceededException—Operation failed due to violation in limit settings.\n* ResourceNotFoundException—Unable to locate a resource using the parameters you provided.\n* ThrottlingException—Operation failed due to throttling limitations.\n* AccessDeniedException—You do not have sufficient access to perform this action.\n\n500—Bad request \n* InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.\n* InsufficientCapacityException—AWS currently does not have enough capacity to fulfill your request.\n"
          title: Errorcode
          type: integer
        Reason:
          description: 'The error description.

            '
          title: Reason
          type: string
      title: Result
      type: object
    DescribeFqdnListResponse.ResponseData:
      additionalProperties: false
      properties:
        FqdnListCandidate:
          $ref: '#/components/schemas/DescribeFqdnListResponse.FqdnListDetails'
          description: 'The FQDN list candidate.

            '
        FqdnListRunning:
          $ref: '#/components/schemas/DescribeFqdnListResponse.FqdnListInfo'
          description: 'The FQDN lists on run state.

            '
        Name:
          description: "Name of the FQDN list entry.    \n"
          title: Name
          type: string
        RuleStackName:
          description: "Name of the rulestack. \n"
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    UpdateFqdnListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/UpdateFqdnListResponse.ResponseData'
          description: 'The API call response.

            '
        ResponseStatus:
          $ref: '#/components/schemas/UpdateFqdnListResponse.Result'
          description: 'The API call response status.

            '
      title: UpdateFqdnListResponse
      type: object
    UpdateFqdnListResponse.ResponseData:
      additionalProperties: false
      properties:
        FqdnListEntry:
          $ref: '#/components/schemas/UpdateFqdnListResponse.FqdnListDetails'
          description: 'The FQDN list entry.

            '
        Name:
          description: "Name of the FQDN list.    \n"
          title: Name
          type: string
        RuleStackName:
          description: "Name of the rulestack. \n"
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    CreateFqdnListRequest:
      additionalProperties: false
      properties:
        AuditComment:
          description: 'The URL category audit remarks.

            '
          maxLength: 512
          title: Auditcomment
          type: string
        Description:
          description: 'A description of the rulestack.

            '
          maxLength: 512
          title: Description
          type: string
        FqdnList:
          description: "The FQDN address objects list.    \n"
          items:
            maxLength: 255
            minLength: 1
            pattern: ^[a-zA-Z0-9._-]+$
            type: string
          title: Fqdnlist
          type: array
        Name:
          description: 'Name of the rulestack.

            '
          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
          description: "Default value of a successful response is 0. Any other number indicates an error code.  \n\n400—HTTP bad request\n* InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.\n* ResourceNotFoundException—Unable to locate a resource using the parameters you provided.\n* ThrottlingException—Operation failed due to throttling limitations.\n\n500—Bad request \n* InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.\n"
          title: Errorcode
          type: integer
        Reason:
          description: "The error description. \n"
          title: Reason
          type: string
      title: Result
      type: object
    DescribeFqdnListResponse.FqdnListInfo:
      additionalProperties: false
      properties:
        AuditComment:
          description: "Audit remarks.    \n"
          title: Auditcomment
          type: string
        Description:
          description: 'The FQDN list description.

            '
          title: Description
          type: string
        FqdnList:
          description: 'The FQDN list.

            '
          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
          description: 'Rulestack candidate.

            '
          title: Candidate
          type: boolean
        Running:
          default: false
          description: 'Rulestacks in run state.

            '
          title: Running
          type: boolean
      title: DescribeFqdnListRequest
      type: object