Palo Alto Networks Sites API

openapi: 3.2.0
info:
  title: Palo Alto Networks Sites API
  version: '1.0'
  description: 'Operations tagged Sites across 4 of this provider''s published API definitions: palo-alto-networks-sites-api-openapi.yml, palo-alto-prisma-sd-wan-api-openapi-original.yml, palo-alto-scm-config-cloudngfw-setup-device-onboarding-device-onboarding-updated-openapi.yaml, palo-alto-scm-config-sase-deployment-deployment-services-june-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.stratacloud.paloaltonetworks.com/aiops/bpa/v1
  description: AIOps for NGFW BPA API production server.
- url: https://api.sase.paloaltonetworks.com
  description: Prisma SD-WAN unified SASE API server.
- url: https://api.cloudgenix.com/v4.7
  description: Legacy CloudGenix API server (v4.7).
- url: https://api.strata.paloaltonetworks.com/config/setup/device-onboarding/v1
  description: Current
- url: https://api.strata.paloaltonetworks.com/config/deployment/v1
  description: Current
- url: https://api.sase.paloaltonetworks.com/sse/config/v1
  description: Legacy
tags:
- name: Sites
  description: SD-WAN site management for branch offices, data centers, and remote locations.
paths:
  /sdwan/config/v1/sites:
    get:
      operationId: listSites
      summary: Palo Alto Networks List SD-WAN Sites
      description: Returns a list of all SD-WAN sites configured in the tenant. Each site represents a physical location such as a branch office, data center, or retail store with one or more ION devices providing SD-WAN functionality.
      tags:
      - Sites
      parameters:
      - name: offset
        in: query
        description: Starting offset for pagination.
        schema:
          type: integer
          default: 0
        example: 0
      - name: limit
        in: query
        description: Maximum number of sites to return.
        schema:
          type: integer
          default: 100
          maximum: 1000
        example: 100
      - name: name
        in: query
        description: Filter sites by name.
        schema:
          type: string
        example: Production Sensor 29
      responses:
        '200':
          description: Sites returned successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: Total number of sites matching the query.
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Site'
              examples:
                ListSites200Example:
                  summary: Default listSites 200 response
                  x-microcks-default: true
                  value:
                    count: 322
                    items:
                    - id: example-id
                      name: Corporate Agent 04
                      description: Malware Security network monitoring network policy threat configured.
                      admin_state: active
                      element_cluster_role: SPOKE
                      address:
                        street: example-street
                        city: example-city
                        state: example-state
                        post_code: example-post_code
                        country: GB
                      location:
                        latitude: 87.48
                        longitude: 37.43
                      tags:
                      - production
                      created_at: '2026-10-04T07:36:12Z'
                      updated_at: '2024-08-23T22:58:22Z'
                    - id: example-id
                      name: Corporate Agent 04
                      description: Malware Security network monitoring network policy threat configured.
                      admin_state: active
                      element_cluster_role: SPOKE
                      address:
                        street: example-street
                        city: example-city
                        state: example-state
                        post_code: example-post_code
                        country: GB
                      location:
                        latitude: 87.48
                        longitude: 37.43
                      tags:
                      - production
                      created_at: '2026-10-04T07:36:12Z'
                      updated_at: '2024-08-23T22:58:22Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - oauth2Bearer: []
    post:
      operationId: createSite
      summary: Palo Alto Networks Create an SD-WAN Site
      description: Creates a new SD-WAN site definition. After creation, ION elements and WAN interfaces can be configured and assigned to the site.
      tags:
      - Sites
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Site'
            examples:
              CreateSiteRequestExample:
                summary: Default createSite request
                x-microcks-default: true
                value:
                  id: example-id
                  name: Corporate Agent 04
                  description: Malware Security network monitoring network policy threat configured.
                  admin_state: active
                  element_cluster_role: SPOKE
                  address:
                    street: example-street
                    city: example-city
                    state: example-state
                    post_code: example-post_code
                    country: GB
                  location:
                    latitude: 87.48
                    longitude: 37.43
                  tags:
                  - production
                  created_at: '2026-10-04T07:36:12Z'
                  updated_at: '2024-08-23T22:58:22Z'
      responses:
        '200':
          description: Site created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Site'
              examples:
                CreateSite200Example:
                  summary: Default createSite 200 response
                  x-microcks-default: true
                  value:
                    id: example-id
                    name: Corporate Agent 04
                    description: Malware Security network monitoring network policy threat configured.
                    admin_state: active
                    element_cluster_role: SPOKE
                    address:
                      street: example-street
                      city: example-city
                      state: example-state
                      post_code: example-post_code
                      country: GB
                    location:
                      latitude: 87.48
                      longitude: 37.43
                    tags:
                    - production
                    created_at: '2026-10-04T07:36:12Z'
                    updated_at: '2024-08-23T22:58:22Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - oauth2Bearer: []
    servers:
    - url: https://api.stratacloud.paloaltonetworks.com/aiops/bpa/v1
      description: AIOps for NGFW BPA API production server.
  /sdwan/config/v1/sites/{site_id}:
    get:
      operationId: getSite
      summary: Palo Alto Networks Get an SD-WAN Site
      description: Returns the configuration of a specific SD-WAN site by ID.
      tags:
      - Sites
      parameters:
      - name: site_id
        in: path
        required: true
        description: Unique site identifier.
        schema:
          type: string
        example: '330934'
      responses:
        '200':
          description: Site returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Site'
              examples:
                GetSite200Example:
                  summary: Default getSite 200 response
                  x-microcks-default: true
                  value:
                    id: example-id
                    name: Corporate Agent 04
                    description: Malware Security network monitoring network policy threat configured.
                    admin_state: active
                    element_cluster_role: SPOKE
                    address:
                      street: example-street
                      city: example-city
                      state: example-state
                      post_code: example-post_code
                      country: GB
                    location:
                      latitude: 87.48
                      longitude: 37.43
                    tags:
                    - production
                    created_at: '2026-10-04T07:36:12Z'
                    updated_at: '2024-08-23T22:58:22Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - oauth2Bearer: []
    put:
      operationId: updateSite
      summary: Palo Alto Networks Update an SD-WAN Site
      description: Updates the configuration of an existing SD-WAN site.
      tags:
      - Sites
      parameters:
      - name: site_id
        in: path
        required: true
        description: Unique site identifier.
        schema:
          type: string
        example: '655853'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Site'
            examples:
              UpdateSiteRequestExample:
                summary: Default updateSite request
                x-microcks-default: true
                value:
                  id: example-id
                  name: Corporate Agent 04
                  description: Malware Security network monitoring network policy threat configured.
                  admin_state: active
                  element_cluster_role: SPOKE
                  address:
                    street: example-street
                    city: example-city
                    state: example-state
                    post_code: example-post_code
                    country: GB
                  location:
                    latitude: 87.48
                    longitude: 37.43
                  tags:
                  - production
                  created_at: '2026-10-04T07:36:12Z'
                  updated_at: '2024-08-23T22:58:22Z'
      responses:
        '200':
          description: Site updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Site'
              examples:
                UpdateSite200Example:
                  summary: Default updateSite 200 response
                  x-microcks-default: true
                  value:
                    id: example-id
                    name: Corporate Agent 04
                    description: Malware Security network monitoring network policy threat configured.
                    admin_state: active
                    element_cluster_role: SPOKE
                    address:
                      street: example-street
                      city: example-city
                      state: example-state
                      post_code: example-post_code
                      country: GB
                    location:
                      latitude: 87.48
                      longitude: 37.43
                    tags:
                    - production
                    created_at: '2026-10-04T07:36:12Z'
                    updated_at: '2024-08-23T22:58:22Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - oauth2Bearer: []
    delete:
      operationId: deleteSite
      summary: Palo Alto Networks Delete an SD-WAN Site
      description: Deletes an SD-WAN site and all associated configuration.
      tags:
      - Sites
      parameters:
      - name: site_id
        in: path
        required: true
        description: Unique site identifier.
        schema:
          type: string
        example: '653838'
      responses:
        '200':
          description: Site deleted successfully.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - oauth2Bearer: []
    servers:
    - url: https://api.stratacloud.paloaltonetworks.com/aiops/bpa/v1
      description: AIOps for NGFW BPA API production server.
  /sites:
    post:
      tags:
      - Sites
      summary: Create sites
      description: 'Creates one or more sites with All-or-Nothing semantics. All sites must pass validation,

        or none will be created. Validates uniqueness, required fields, and property constraints.

        '
      operationId: createSites
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_sites_request'
      responses:
        '201':
          description: Sites created successfully
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - success
                    description: Response status indicator
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Site ID
                        name:
                          type: string
                          description: Site name
                  message:
                    type: string
                    description: Human-readable message
                  request_id:
                    type: string
                    format: uuid
                    description: Unique request identifier for troubleshooting
        '400':
          $ref: '#/components/responses/BadRequest_2'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError_2'
      security:
      - scmToken: []
    get:
      tags:
      - Sites
      summary: List sites
      description: 'Retrieves all sites for the tenant with optional filtering by status, site group, and site names.

        Includes claims and resolution history for each site.


        **Filter Priority**: If multiple filters are provided, the priority is:

        1. `name` - Filter by specific site names (highest priority)

        2. `site-group` - Filter by site group name

        3. `status` - Filter by claim status (applied after other filters)

        '
      operationId: listSites
      parameters:
      - name: name
        in: query
        description: 'Filter sites by name. Multiple values supported (e.g., `?name=A&name=B`).

          Returns only sites matching the specified names.

          '
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: status
        in: query
        description: Filter sites by claim status
        schema:
          type: string
          enum:
          - all
          - claimed
          - unclaimed
          default: all
      - name: site-group
        in: query
        description: Filter sites by site group name
        schema:
          type: string
      responses:
        '200':
          description: Sites retrieved successfully
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - success
                    description: Response status indicator
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/site_with_claims'
                    description: Array of sites with their claims and resolution history
                  message:
                    type: string
                    description: Human-readable message
                  request_id:
                    type: string
                    format: uuid
                    description: Unique request identifier for troubleshooting
        '500':
          $ref: '#/components/responses/InternalServerError_2'
      security:
      - scmToken: []
    servers:
    - url: https://api.strata.paloaltonetworks.com/config/setup/device-onboarding/v1
      description: Current
  /sites/{id}:
    get:
      tags:
      - Sites
      summary: Get a site
      description: Retrieves a single site by UUID with its claims and resolution history
      operationId: getSiteByID
      parameters:
      - $ref: '#/components/parameters/site_id'
      responses:
        '200':
          description: Site retrieved successfully
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - success
                    description: Response status indicator
                  data:
                    $ref: '#/components/schemas/site_with_claims'
                    description: Site with claims and resolution history
                  message:
                    type: string
                    description: Human-readable message
                  request_id:
                    type: string
                    format: uuid
                    description: Unique request identifier for troubleshooting
        '404':
          $ref: '#/components/responses/NotFound_2'
        '500':
          $ref: '#/components/responses/InternalServerError_2'
      security:
      - scmToken: []
    put:
      tags:
      - Sites
      summary: Update a site
      description: 'Updates a site''s name, site group, or property values. Site must be unclaimed

        to be updated.

        '
      operationId: updateSiteByID
      parameters:
      - $ref: '#/components/parameters/site_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_site_request'
      responses:
        '200':
          description: Site updated successfully
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - success
                    description: Response status indicator
                  data:
                    $ref: '#/components/schemas/site'
                    description: Updated site
                  message:
                    type: string
                    description: Human-readable message
                  request_id:
                    type: string
                    format: uuid
                    description: Unique request identifier for troubleshooting
        '404':
          $ref: '#/components/responses/NotFound_2'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError_2'
      security:
      - scmToken: []
    delete:
      tags:
      - Sites
      summary: Delete a site
      description: 'Deletes a site by ID. Site must be unclaimed unless force=true is specified.

        '
      operationId: deleteSiteByID
      parameters:
      - $ref: '#/components/parameters/site_id'
      - name: force
        in: query
        description: Force delete even if site is claimed
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Site deleted successfully - returns deleted resource
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                properties:
                  status:
                    type: string
                    enum:
                    - success
                    description: Response status indicator
                  data:
                    $ref: '#/components/schemas/site'
                    description: Deleted site
                  message:
                    type: string
                    description: Human-readable message
                  request_id:
                    type: string
                    format: uuid
                    description: Unique request identifier for troubleshooting
        '404':
          $ref: '#/components/responses/NotFound_2'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError_2'
      security:
      - scmToken: []
    servers:
    - url: https://api.strata.paloaltonetworks.com/config/setup/device-onboarding/v1
      description: Current
components:
  responses:
    Forbidden:
      description: Insufficient permissions for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Invalid request parameters or body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing or invalid OAuth2 access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            type: object
            required:
            - status
            - error
            properties:
              status:
                type: string
                enum:
                - error
              data:
                type: array
                items:
                  $ref: '#/components/schemas/resource_validation_result'
              error:
                type: string
                description: Error message
    BadRequest_2:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            required:
            - status
            - error
            properties:
              status:
                type: string
                enum:
                - error
              data:
                type: array
                items:
                  $ref: '#/components/schemas/resource_validation_result'
              error:
                type: string
                description: Error message
    InternalServerError_2:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            required:
            - status
            - error
            properties:
              status:
                type: string
                enum:
                - error
              error:
                type: string
                description: Error message
    NotFound_2:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            required:
            - status
            - error
            properties:
              status:
                type: string
                enum:
                - error
              error:
                type: string
                description: Error message
    access_errors:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/generic_error'
          examples:
            auth_unauthorized:
              $ref: '#/components/examples/json_403_panui_auth_unauthorized'
    not_found:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/generic_error'
          examples:
            object_not_present:
              $ref: '#/components/examples/json_404_panui_mgmt_object_not_present'
    conflict_errors:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/generic_error'
          examples:
            object_not_unique:
              $ref: '#/components/examples/json_409_panui_mgmt_object_not_unique'
            name_not_unique:
              $ref: '#/components/examples/json_409_panui_mgmt_name_not_unique'
            reference_not_zero:
              $ref: '#/components/examples/json_409_panui_mgmt_reference_not_zero'
    bad_request_errors_basic:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/generic_error'
          examples:
            input_format_mismatch:
              $ref: '#/components/examples/json_400_panui_restapi_input_format_mismatch'
            output_format_mismatch:
              $ref: '#/components/examples/json_400_panui_restapi_output_format_mismatch'
            missing_query_parameter:
              $ref: '#/components/examples/json_400_panui_restapi_missing_query_parameter'
            invalid_query_parameter:
              $ref: '#/components/examples/json_400_panui_restapi_invalid_query_parameter'
    default_errors:
      description: General Errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/generic_error'
          examples:
            version_not_supported:
              $ref: '#/components/examples/json_501_panui_restapi_version_not_supported'
            method_not_allowed:
              $ref: '#/components/examples/json_501_panui_restapi_method_not_supported'
            action_not_supported:
              $ref: '#/components/examples/json_405_panui_restapi_action_not_supported'
            bad_xpath:
              $ref: '#/components/examples/json_400_panui_mgmt_bad_xpath'
            invalid_command:
              $ref: '#/components/examples/json_400_panui_mgmt_invalid_command'
            malformed_command:
              $ref: '#/components/examples/json_400_panui_mgmt_malformed_command'
            session_timeout:
              $ref: '#/components/examples/json_504_panui_mgmt_session_timeout'
    auth_errors:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/generic_error'
          examples:
            auth_not_authenticated:
              $ref: '#/components/examples/json_401_panui_auth_not_authenticated'
            invalid_credential:
              $ref: '#/components/examples/json_401_panui_auth_invalid_credential'
            key_too_long:
              $ref: '#/components/examples/json_401_panui_auth_key_too_long'
            key_expired:
              $ref: '#/components/examples/json_401_panui_auth_key_expired'
            need_password_change:
              $ref: '#/components/examples/json_401_panui_auth_need_password_change'
    bad_request_errors_basic_with_body:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/generic_error'
          examples:
            input_format_mismatch:
              $ref: '#/components/examples/json_400_panui_restapi_input_format_mismatch'
            output_format_mismatch:
              $ref: '#/components/examples/json_400_panui_restapi_output_format_mismatch'
            missing_query_parameter:
              $ref: '#/components/examples/json_400_panui_restapi_missing_query_parameter'
            invalid_query_parameter:
              $ref: '#/components/examples/json_400_panui_restapi_invalid_query_parameter'
            missing_body:
              $ref: '#/components/examples/json_400_panui_restapi_missing_body'
            invalid_object:
              $ref: '#/components/examples/json_400_panui_mgmt_invalid_object'
    http_ok:
      description: OK
  schemas:
    ErrorResponse:
      type: object
      properties:
        _error:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: example-code
              message:
                type: string
                example: Investigation firewall on investigation blocked malware on on activity traffic.
          example:
          - code: example-code
            message: Traffic activity blocked incident activity alert rule alert firewall incident.
          - code: example-code
            message: Traffic policy on violation blocked Security investigation blocked rule on malware network.
    Site:
      type: object
      required:
      - name
      properties:
        id:
          type: string
          description: Unique identifier for the site.
          readOnly: true
          example: example-id
        name:
          type: string
          description: Name of the SD-WAN site.
          example: Corporate Agent 04
        description:
          type: string
          description: Optional description of the site.
          example: Malware Security network monitoring network policy threat configured.
        admin_state:
          type: string
          enum:
          - active
          - disabled
          default: active
          description: Administrative state of the site.
          example: active
        element_cluster_role:
          type: string
          enum:
          - SPOKE
          - HUB
          - NONE
          default: SPOKE
          description: Role of the site in the SD-WAN topology.
          example: SPOKE
        address:
          type: object
          description: Physical address of the site.
          properties:
            street:
              type: string
              example: example-street
            city:
              type: string
              example: example-city
            state:
              type: string
              example: example-state
            post_code:
              type: string
              example: example-post_code
            country:
              type: string
              example: GB
          example:
            street: example-street
            city: example-city
            state: example-state
            post_code: example-post_code
            country: GB
        location:
          type: o

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-sites-api-openapi.yml