Palo Alto Networks Prefix List API

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 CIDR notation.\n\n### Permission Policies\n\n| Action                       | Local Firewall Administrator  | Local Rulestack Administrator | Global Rulestack Administrator |\n| ---------------------------- | :---------------------------: | :---------------------------: | :----------------------------: |\n| Create Prefix List           | ☐                       | **☑**                   | **☑**                    | \n| Delete Prefix List           | ☐                       | **☑**                   | **☑**                    |                        \n| Update Prefix List           | ☐                       | **☑**                   | **☑**                    |   \n| Describe Prefix List         | **☑**                   | **☑**                   | **☑**                    |\n| List Prefix Lists            | **☑**                   | **☑**                   | **☑**                    |\n"
  title: Manage Prefix List API
  version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: PrefixList
paths:
  /v1/config/rulestacks/{rulestackname}/prefixlists:
    get:
      description: 'Retrieve information about the prefix lists for the specified rulestack.

        '
      operationId: get-v1-config-rulestacks-rulestackname-prefixlists
      parameters:
      - description: ''
        in: path
        name: rulestackname
        required: true
        schema:
          type: string
      - description: ''
        in: query
        name: nexttoken
        required: false
        schema:
          maxLength: 2048
          minLength: 1
          pattern: ^[-0-9A-Za-z:\/+=]+$
          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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPrefixListResponse'
          description: OK
      summary: Retrieve prefix lists
      tags:
      - PrefixList
    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 prefix list
      tags:
      - PrefixList
  /v1/config/rulestacks/{rulestackname}/prefixlists/{name}:
    delete:
      description: 'Delete the prefix list associated with the specified rulestack.

        '
      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 prefix list
      tags:
      - PrefixList
    get:
      description: 'Retrieve the prefix list associated with a rulestack.

        '
      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: Retrieve prefix list
      tags:
      - PrefixList
    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 prefix list
      tags:
      - PrefixList
components:
  schemas:
    UpdatePrefixListRequest:
      additionalProperties: false
      properties:
        AuditComment:
          maxLength: 512
          title: Auditcomment
          type: string
        Description:
          maxLength: 512
          title: Description
          type: string
        PrefixList:
          items:
            type: string
          title: Prefixlist
          type: array
        UpdateToken:
          title: Updatetoken
          type: string
      required:
      - PrefixList
      title: UpdatePrefixListRequest
      type: object
    CreatePrefixListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    UpdatePrefixListResponse.ResponseData:
      additionalProperties: false
      properties:
        Name:
          title: Name
          type: string
        PrefixListEntry:
          $ref: '#/components/schemas/UpdatePrefixListResponse.PrefixListDetails'
        RuleStackName:
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    DeletePrefixListResponse.PrefixListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          title: Auditcomment
          type: string
        Description:
          title: Description
          type: string
        PrefixList:
          items:
            type: string
          title: Prefixlist
          type: array
        UpdateToken:
          default: '1'
          title: Updatetoken
          type: string
      required:
      - PrefixList
      title: PrefixListDetails
      type: object
    CreatePrefixListRequest:
      additionalProperties: false
      properties:
        AuditComment:
          maxLength: 512
          title: Auditcomment
          type: string
        Description:
          maxLength: 512
          title: Description
          type: string
        Name:
          maxLength: 58
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
          title: Name
          type: string
        PrefixList:
          items:
            type: string
          title: Prefixlist
          type: array
      required:
      - Name
      - PrefixList
      title: CreatePrefixListRequest
      type: object
    CreatePrefixListResponse.PrefixListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          title: Auditcomment
          type: string
        Description:
          title: Description
          type: string
        PrefixList:
          items:
            type: string
          title: Prefixlist
          type: array
        UpdateToken:
          default: '1'
          title: Updatetoken
          type: string
      required:
      - PrefixList
      title: PrefixListDetails
      type: object
    CreatePrefixListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/CreatePrefixListResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/CreatePrefixListResponse.Result'
      title: CreatePrefixListResponse
      type: object
    ListPrefixListResponse.UncommittedPrefixListDetails:
      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: UncommittedPrefixListDetails
      type: object
    DeletePrefixListResponse.ResponseData:
      additionalProperties: false
      properties:
        Name:
          title: Name
          type: string
        PrefixListEntry:
          $ref: '#/components/schemas/DeletePrefixListResponse.PrefixListDetails'
        RuleStackName:
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    DescribePrefixListRequest:
      additionalProperties: false
      properties:
        Candidate:
          default: true
          title: Candidate
          type: boolean
        MaxResults:
          default: 100
          title: Maxresults
          type: integer
        NextToken:
          maxLength: 2048
          minLength: 1
          pattern: ^[-0-9A-Za-z:\/+=]+$
          title: Nexttoken
          type: string
        Running:
          default: false
          title: Running
          type: boolean
      title: DescribePrefixListRequest
      type: object
    DeletePrefixListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          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'
        ResponseStatus:
          $ref: '#/components/schemas/ListPrefixListResponse.Result'
      title: ListPrefixListResponse
      type: object
    CreatePrefixListResponse.ResponseData:
      additionalProperties: false
      properties:
        Name:
          title: Name
          type: string
        PrefixListEntry:
          $ref: '#/components/schemas/CreatePrefixListResponse.PrefixListDetails'
        RuleStackName:
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    DescribePrefixListResponse.ResponseData:
      additionalProperties: false
      properties:
        Name:
          title: Name
          type: string
        NextToken:
          maxLength: 2048
          minLength: 1
          pattern: ^[-0-9A-Za-z:\/+=]+$
          title: Nexttoken
          type: string
        PrefixListCandidate:
          $ref: '#/components/schemas/DescribePrefixListResponse.PrefixListDetails'
        PrefixListRunning:
          $ref: '#/components/schemas/DescribePrefixListResponse.PrefixListDetails'
        RuleStackName:
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    ListPrefixListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    UpdatePrefixListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/UpdatePrefixListResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/UpdatePrefixListResponse.Result'
      title: UpdatePrefixListResponse
      type: object
    ListPrefixListResponse.ResponseData:
      additionalProperties: false
      properties:
        NextToken:
          maxLength: 2048
          minLength: 1
          pattern: ^[-0-9A-Za-z:\/+=]+$
          title: Nexttoken
          type: string
        PrefixListCandidate:
          items:
            type: string
          title: Prefixlistcandidate
          type: array
        PrefixListRunning:
          items:
            type: string
          title: Prefixlistrunning
          type: array
        PrefixListUncommitted:
          items:
            $ref: '#/components/schemas/ListPrefixListResponse.UncommittedPrefixListDetails'
          title: Prefixlistuncommitted
          type: array
        RuleStackName:
          title: Rulestackname
          type: string
      title: ResponseData
      type: object
    DescribePrefixListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/DescribePrefixListResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/DescribePrefixListResponse.Result'
      title: DescribePrefixListResponse
      type: object
    DescribePrefixListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    UpdatePrefixListResponse.PrefixListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          title: Auditcomment
          type: string
        Description:
          title: Description
          type: string
        PrefixList:
          items:
            type: string
          title: Prefixlist
          type: array
        UpdateToken:
          default: '1'
          title: Updatetoken
          type: string
      required:
      - PrefixList
      title: PrefixListDetails
      type: object
    DescribePrefixListResponse.PrefixListDetails:
      additionalProperties: false
      properties:
        AuditComment:
          title: Auditcomment
          type: string
        Description:
          title: Description
          type: string
        PrefixList:
          items:
            type: string
          title: Prefixlist
          type: array
        UpdateToken:
          default: '1'
          title: Updatetoken
          type: string
      required:
      - PrefixList
      title: PrefixListDetails
      type: object
    UpdatePrefixListResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    DeletePrefixListResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/DeletePrefixListResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/DeletePrefixListResponse.Result'
      title: DeletePrefixListResponse
      type: object