Palo Alto Networks IP Pool API

The IP Pool API from Palo Alto Networks — 1 operation(s) for ip pool.

Documentation GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PUT /mt/sp-interconnect/interconnects/{interconnectId}/ip-pool Update an interconnect's IP address pool · Update IP Address Pool #

Ask an LLM

“Can I change the IP blocks on an interconnect pool that already exists?”

“How do I switch an existing pool's IP provider?”

Tell an agent

Update the IP pool on interconnect {interconnectId} to provider {ipProvider} with blocks {ipBlocks}.

Change the existing pool's IP provider on interconnect {interconnectId} to {ipProvider}.

GET /mt/sp-interconnect/interconnects/{interconnectId}/ip-pool View an interconnect's IP address pool · Get IP Address Address Pool #

Ask an LLM

“Which CIDR ranges are assigned to my service provider interconnect?”

“Is an interconnect's IP pool provided by the SP or by Palo Alto Networks?”

Tell an agent

Show the IP address pool for interconnect {interconnectId}.

Get the CIDR blocks and provider status on interconnect {interconnectId}.

DELETE /mt/sp-interconnect/interconnects/{interconnectId}/ip-pool Remove an interconnect's IP address pool · Delete IP Address Pool #

Ask an LLM

“What happens to routing when I delete an interconnect's IP pool?”

“Can I unassign all CIDR blocks from an interconnect at once?”

Tell an agent destructive · confirm first

Delete the IP pool on interconnect {interconnectId}.

Remove all IP block associations from interconnect {interconnectId}.

POST /mt/sp-interconnect/interconnects/{interconnectId}/ip-pool Attach a new IP address pool to an interconnect · Create New Pool #

Ask an LLM

“How do I provision the first IP address pool on a new interconnect?”

“Can a newly attached pool use SP-provided addresses instead of PANW-provided ones?”

Tell an agent

Create a new IP pool on interconnect {interconnectId} with provider {ipProvider}.

Provision pool blocks {ipBlocks} from provider {ipProvider} on interconnect {interconnectId}.

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-ip-pool-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/palo-alto-networks:palo-alto-networks-ip-pool-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: SP Interconnect Manage IP Pool API
  version: '1.0'
  description: 'These APIs provide the administrative tools necessary to configure and manage the lifecycle of Service Provider (SP) Interconnects

    and virtual VlanAttachments within the management plane.'
servers:
- url: https://api.sase.paloaltonetworks.com
security:
- authKey: []
tags:
- name: IP Pool
paths:
  /mt/sp-interconnect/interconnects/{interconnectId}/ip-pool:
    put:
      tags:
      - IP Pool
      summary: Update IP Address Pool
      description: Update IP Address Pool.
      parameters:
      - name: interconnectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPPoolRequest'
            examples:
              Update IP Pool with new CIDRs:
                value:
                  ipProvider: SP
                  ipBlocks:
                  - edgeLocation: mexico-central
                    cidr:
                    - 21.58.2.0/29
                    - 21.58.3.0/29
                    type: SECONDARY
              Add additional edge location:
                value:
                  ipProvider: SP
                  ipBlocks:
                  - edgeLocation: us-west-1
                    cidr:
                    - 12.2.2.0/26
                    type: SECONDARY
                  - edgeLocation: us-east-1
                    cidr:
                    - 12.3.3.0/26
                    type: SECONDARY
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Update IP Pool:
                  value:
                    data:
                      id: 7673a661-a98b-4202-b70a-8edc3934a3f5
                      ipBlocks:
                      - cidr:
                        - 21.58.2.0/29
                        displayName: Mexico Central
                        edgeLocation: mexico-central
                      ipProvider: SP
                      name: ip-pool-test
                      permittedActions: []
                      region: us-south1
                      state: NOT_STARTED
                      status: PENDING
                      tsgId: '1091039496'
                    requestId: 6eb154b3-5ac0-441c-a8e4-a092f5b5b588
        '500':
          description: Internal Error
        '400':
          description: Bad Request
      operationId: PutMtSp-interconnectInterconnectsBy_interconnectidIp-pool
    get:
      tags:
      - IP Pool
      summary: Get IP Address Address Pool
      description: View the current IP Address address configuration assigned to an Interconnect, including CIDR ranges and provider status. This provides visibility into the addressing scheme used at the edge for egress routing. Access this to verify that the correct SP-provided or public IP Address ranges are in effect. The data returned includes the IP Address pool ID, its provisioning state, and a list of all active CIDR blocks.
      parameters:
      - name: interconnectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Get IP Pool by id:
                  value:
                    data:
                      cloudProvider: AWS
                      createTime: 1748207866258
                      id: 64753c22-8234-4d06-8410-2fc7a949a8f5
                      interconnectId: 424f9837-68b3-11f0-92e9-4201ac16024e
                      ipBlocks:
                      - cidr:
                        - 18.2.1.0/28
                        displayName: US Northwest
                        edgeLocation: us-west-2
                        type: SECONDARY
                      ipProvider: SP
                      permittedActions:
                      - ASSIGN_IP_POOL
                      - DELETE_IP_POOL
                      - UPDATE_IP_POOL
                      state: NOT_STARTED
                      status: PENDING
                      updateTime: 1748207866258
                    requestId: 7d7de6bc-f96b-4cd7-bad4-fb7a5689eba7
        '400':
          description: Bad Request
      operationId: GetMtSp-interconnectInterconnectsBy_interconnectidIp-pool
    delete:
      tags:
      - IP Pool
      summary: Delete IP Address Pool
      description: Remove all IP Address block associations and provider settings from the specified Interconnect. Terminating the pool stops the use of specific CIDRs for routing and returns the container to an unassigned state. Use this when retiring BYOIP ranges or preparing to swap service provider IP Address schemes. Note that deleting an active pool will immediately impact egress traffic relying on those addresses.
      parameters:
      - name: interconnectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Delete IP Pool by id:
                  value:
                    data: IP Pool successfully deleted
                    requestId: e34443d5-dfbd-482b-a76c-5d753034efc0
      operationId: DeleteMtSp-interconnectInterconnectsBy_interconnectidIp-pool
    post:
      tags:
      - IP Pool
      summary: Create New Pool
      description: Provision and attach a new IP Address address pool to an existing Interconnect. This defines the addressing model (SP-provided or PANW-provided) that Prisma Access traffic will use at the edge. Use this when finalizing the egress setup for a new regional Interconnect container. When using SP-provided pools, you must include at least one valid public CIDR block mapped to a supported edge location.
      parameters:
      - name: interconnectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPPoolRequest'
            examples:
              Create SP provided IP Pool:
                value:
                  ipProvider: SP
                  ipBlocks:
                  - edgeLocation: us-west-1
                    cidr:
                    - 12.2.2.0/26
                    type: SECONDARY
                  - edgeLocation: us-west2
                    cidr:
                    - 12.1.2.0/26
                    type: PRIMARY
              Create PANW provided IP Pool:
                value:
                  ipProvider: PANW
              Create AWS IP Pool:
                value:
                  ipProvider: SP
                  ipBlocks:
                  - edgeLocation: us-east-1a
                    cidr:
                    - 18.2.1.0/28
                    - 18.2.2.0/28
                    type: SECONDARY
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              examples:
                Add an IP Pool:
                  value:
                    data:
                      cloudProvider: GCP
                      createTime: 1758577740021
                      id: 3dec9dea-c100-495b-9fb2-16b44c1eae3a
                      interconnectId: 1689a56a-9386-40b5-aa9a-0cebad2650d8
                      ipBlocks:
                      - cidr:
                        - 12.2.2.0/26
                        displayName: US West
                        edgeLocation: us-west-1
                        type: SECONDARY
                      - cidr:
                        - 12.1.2.0/26
                        edgeLocation: us-west2
                        type: PRIMARY
                      ipProvider: SP
                      permittedActions: []
                      state: VALIDATING_CIDR_IN_ORCHESTRATOR
                      status: IN_PROGRESS
                      updateTime: 1758577740331
                    requestId: 8c085ae4-bf26-4de5-86bd-2ba446b65d47
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                CIDR already used:
                  value:
                    error:
                      errorCode: 52070
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: CIDR is already used
                    requestId: a1b2c3d4-5e6f-7890-abcd-ef1234567890
                Private IP not allowed:
                  value:
                    error:
                      errorCode: 52068
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: CIDR in IP Pool is private IP, only public IPs allowed
                    requestId: b2c3d4e5-6f78-9012-bcde-f12345678901
                Max CIDRs reached:
                  value:
                    error:
                      errorCode: 52071
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: Only ten cidr blocks allowed per edge location
                    requestId: c3d4e5f6-7890-1234-cdef-012345678901
                IP Pool already exists:
                  value:
                    error:
                      errorCode: 52013
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: IP Pool already exists in interconnect
                    requestId: d4e5f678-9012-3456-def0-123456789012
                Invalid CIDR range for GCP:
                  value:
                    error:
                      errorCode: 52123
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: GCP CloudProvider IP Block CIDRs must be between /25 to /29
                    requestId: e5f67890-1234-5678-ef01-234567890123
        '500':
          description: Internal Error
      operationId: PostMtSp-interconnectInterconnectsBy_interconnectidIp-pool
components:
  schemas:
    IPPoolRequest:
      type: object
      required:
      - ipProvider
      properties:
        ipBlocks:
          type: array
          uniqueItems: true
          items:
            $ref: '#/components/schemas/IPBlockEntry'
        ipProvider:
          $ref: '#/components/schemas/IPProvider'
    IPProvider:
      type: string
      enum:
      - SP
      - PANW
    IPBlockType:
      type: string
      enum:
      - PRIMARY
      - SECONDARY
    IPBlockEntry:
      type: object
      required:
      - cidr
      properties:
        edgeLocation:
          type: string
        cidr:
          type: array
          minItems: 1
          uniqueItems: true
          items:
            type: string
        type:
          $ref: '#/components/schemas/IPBlockType'
  securitySchemes:
    authKey:
      type: http
      scheme: Bearer