openapi: 3.2.0
info:
  contact: {}
  description: 'A prefix list allows you to group specific IP addresses that require the same policy enforcement. A prefix list can contain one or more IP addresses or IP netmask in the CIDR notation.

    '
  title: Manage Prefix Lists API
  version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: ManagePrefixLists
paths:
  /v1/config/rulestacks/{rulestackname}/prefixlists:
    get:
      description: "Retrieve the information about the prefix lists for the specified rulestack. \n"
      operationId: get-v1-config-rulestacks-rulestackname-prefixlists
      parameters:
      - description: ''
        in: path
        name: rulestackname
        required: true
        schema:
          type: string
      - description: 'If the number of prefix lists available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of prefix list, use this token in your next request.

          '
        in: query
        name: nexttoken
        required: false
        schema:
          maxLength: 2048
          minLength: 1
          pattern: ^[-0-9A-Za-z:\/+=]+$
          title: Nexttoken
          type: string
      - description: 'Prefix list candidate.

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

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

          '
        in: query
        name: uncommitted
        required: false
        schema:
          default: false
          title: Uncommitted
          type: boolean
      - description: 'The maximum number of prefix lists 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPrefixListResponse'
          description: OK
      summary: List PrefixLists
      tags:
      - ManagePrefixLists
    post:
      description: 'Create a prefix list to configure and maintain security groups and route tables.

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

          '
        in: path
        name: rulestackname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePrefixListRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePrefixListResponse'
          description: OK
      summary: Create a PrefixList
      tags:
      - ManagePrefixLists
  /v1/config/rulestacks/{rulestackname}/prefixlists/{name}:
    delete:
      description: "Delete the prefix list associated with the specified rulestack.  \n"
      operationId: delete-v1-config-rulestacks-rulestackname-prefixlists-name
      parameters:
      - description: 'The name of the rulestack.

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

          '
        in: path
        name: name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeletePrefixListRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePrefixListResponse'
          description: OK
      summary: Delete a PrefixList
      tags:
      - ManagePrefixLists
    get:
      description: "Return the prefix list associated with a rulestack.  \n"
      operationId: get-v1-config-rulestacks-rulestackname-prefixlists-name
      parameters:
      - description: 'The name of the rulestack.

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

          '
        in: path
        name: name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribePrefixListRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribePrefixListResponse'
          description: OK
      summary: Describe a PrefixList
      tags:
      - ManagePrefixLists
    put:
      description: 'Update the prefix list associated with a rulestack.

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

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

          '
        in: path
        name: name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePrefixListRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePrefixListResponse'
          description: OK
      summary: Update a PrefixList
      tags:
      - ManagePrefixLists
components:
  schemas:
    UpdatePrefixListRequest:
      additionalProperties: false
      properties:
        AuditComment:
          description: 'The prefix list audit remarks.

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

            '
          maxLength: 512
          title: Description
          type: string
        PrefixList:
          description: "The prefix list details. \n"
          items:
            type: string
          title: Prefixlist
          type: array
        UpdateToken:
          description: 'Refresh token.

            '
          title: Updatetoken
          type: string
      required:
      - PrefixList
      title: UpdatePrefixListRequest
      type: object
    CreatePrefixListResponse.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
    UpdatePrefixListResponse.ResponseData:
      additionalProperties: false
      properties:
        Name:
          description: "Name of the prefix list.    \n"
          title: Name
          type: string
        PrefixListEntry:
          $ref: '#/components/schemas/UpdatePrefixListResponse.PrefixListDetails'
          description: 'The prefix list entry.

            '
        RuleStackName:
          description: "Name of the rulestack. \n"
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    DeletePrefixListResponse.PrefixListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          description: "Audit remarks.    \n"
          title: Auditcomment
          type: string
        Description:
          description: "The prefix list description. \n"
          title: Description
          type: string
        PrefixList:
          items:
            type: string
          title: Prefixlist
          type: array
        UpdateToken:
          default: '1'
          description: 'Refresh token.

            '
          title: Updatetoken
          type: string
      required:
      - PrefixList
      title: PrefixListDetails
      type: object
    CreatePrefixListRequest:
      additionalProperties: false
      properties:
        AuditComment:
          description: 'The prefix list audit remarks.

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

            '
          maxLength: 512
          title: Description
          type: string
        Name:
          description: 'Name of the prefix list.

            '
          maxLength: 58
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
          title: Name
          type: string
        PrefixList:
          description: "The prefix list details.    \n"
          items:
            type: string
          title: Prefixlist
          type: array
      required:
      - Name
      - PrefixList
      title: CreatePrefixListRequest
      type: object
    CreatePrefixListResponse.PrefixListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          description: "Audit remarks.    \n"
          title: Auditcomment
          type: string
        Description:
          description: "The prefix list description. \n"
          title: Description
          type: string
        PrefixList:
          description: "Prefix list.    \n"
          items:
            type: string
          title: Prefixlist
          type: array
        UpdateToken:
          default: '1'
          description: 'Refresh token.

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

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

            '
      title: CreatePrefixListResponse
      type: object
    ListPrefixListResponse.UncommittedPrefixListDetails:
      additionalProperties: false
      properties:
        Name:
          description: 'Name of the prefix list.

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

            '
          title: Operation
          type: string
      required:
      - Name
      - Operation
      title: UncommittedPrefixListDetails
      type: object
    DeletePrefixListResponse.ResponseData:
      additionalProperties: false
      properties:
        Name:
          description: "Name of the prefix list.    \n"
          title: Name
          type: string
        PrefixListEntry:
          $ref: '#/components/schemas/DeletePrefixListResponse.PrefixListDetails'
        RuleStackName:
          description: "Name of the rulestack. \n"
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    DescribePrefixListRequest:
      additionalProperties: false
      properties:
        Candidate:
          default: true
          description: 'Prefix list candidate.

            '
          title: Candidate
          type: boolean
        MaxResults:
          default: 100
          description: "The maximum number of Prefix lists that you want NGFW to return for this request. \n"
          title: Maxresults
          type: integer
        NextToken:
          description: 'If the number of Prefix lists available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of Prefix list, use this token in your next request.

            '
          maxLength: 2048
          minLength: 1
          pattern: ^[-0-9A-Za-z:\/+=]+$
          title: Nexttoken
          type: string
        Running:
          default: false
          description: 'Prefix list in run state.

            '
          title: Running
          type: boolean
      title: DescribePrefixListRequest
      type: object
    DeletePrefixListResponse.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
    DeletePrefixListRequest:
      additionalProperties: false
      properties: {}
      title: DeletePrefixListRequest
      type: object
    ListPrefixListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/ListPrefixListResponse.ResponseData'
          description: 'The API call response.

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

            '
      title: ListPrefixListResponse
      type: object
    CreatePrefixListResponse.ResponseData:
      additionalProperties: false
      properties:
        Name:
          description: "Name of the prefix list.    \n"
          title: Name
          type: string
        PrefixListEntry:
          $ref: '#/components/schemas/CreatePrefixListResponse.PrefixListDetails'
        RuleStackName:
          description: "Name of the rulestack. \n"
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    DescribePrefixListResponse.ResponseData:
      additionalProperties: false
      properties:
        Name:
          description: "Name of the prefix list entry.    \n"
          title: Name
          type: string
        NextToken:
          description: 'If the number of prefix lists available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of prefix lists, use this token in your next request.

            '
          maxLength: 2048
          minLength: 1
          pattern: ^[-0-9A-Za-z:\/+=]+$
          title: Nexttoken
          type: string
        PrefixListCandidate:
          $ref: '#/components/schemas/DescribePrefixListResponse.PrefixListDetails'
          description: 'The prefix list candidate.

            '
        PrefixListRunning:
          $ref: '#/components/schemas/DescribePrefixListResponse.PrefixListDetails'
          description: 'The prefix lists on run state.

            '
        RuleStackName:
          description: "Name of the rulestack. \n"
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    ListPrefixListResponse.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
    UpdatePrefixListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/UpdatePrefixListResponse.ResponseData'
          description: 'The API call response.

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

            '
      title: UpdatePrefixListResponse
      type: object
    ListPrefixListResponse.ResponseData:
      additionalProperties: false
      properties:
        NextToken:
          description: 'If the number of Prefix lists available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of Prefix list, use this token in your next request.

            '
          maxLength: 2048
          minLength: 1
          pattern: ^[-0-9A-Za-z:\/+=]+$
          title: Nexttoken
          type: string
        PrefixListCandidate:
          description: 'Prefix list candidate.

            '
          items:
            type: string
          title: Prefixlistcandidate
          type: array
        PrefixListRunning:
          description: 'Prefix lists on run state.

            '
          items:
            type: string
          title: Prefixlistrunning
          type: array
        PrefixListUncommitted:
          description: 'Uncommitted Prefix lists.

            '
          items:
            $ref: '#/components/schemas/ListPrefixListResponse.UncommittedPrefixListDetails'
          title: Prefixlistuncommitted
          type: array
        RuleStackName:
          description: 'Name of the rulestack.

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

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

            '
      title: DescribePrefixListResponse
      type: object
    DescribePrefixListResponse.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
    UpdatePrefixListResponse.PrefixListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          description: "Audit remarks.    \n"
          title: Auditcomment
          type: string
        Description:
          description: "The prefix list description. \n"
          title: Description
          type: string
        PrefixList:
          description: "Prefix list.    \n"
          items:
            type: string
          title: Prefixlist
          type: array
        UpdateToken:
          default: '1'
          description: 'Refresh token.

            '
          title: Updatetoken
          type: string
      required:
      - PrefixList
      title: PrefixListDetails
      type: object
    DescribePrefixListResponse.PrefixListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          description: "Audit remarks.    \n"
          title: Auditcomment
          type: string
        Description:
          description: 'The prefix list description.

            '
          title: Description
          type: string
        PrefixList:
          description: 'The prefix list.

            '
          items:
            type: string
          title: Prefixlist
          type: array
        UpdateToken:
          default: '1'
          description: 'Refresh token.

            '
          title: Updatetoken
          type: string
      required:
      - PrefixList
      title: PrefixListDetails
      type: object
    UpdatePrefixListResponse.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
    DeletePrefixListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/DeletePrefixListResponse.ResponseData'
          description: 'The API call response.

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

            '
      title: DeletePrefixListResponse
      type: object