How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Palo Alto Networks Onboarding Rules API

Onboarding rules information

Palo Alto Networks Onboarding Rules API is one of 741 APIs that Palo Alto Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Onboarding Rules. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.strata.paloaltonetworks.com/config/setup/device-onboarding/v1.

6 operations 3 paths 14 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://{firewall}/api/
Authentication
OAuth 2.0, HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Palo Alto Networks Onboarding Rules API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (scmOAuth) using the clientCredentials flow. It accepts HTTP bearer tokens (JWT) (scmToken). By default, every request must be authenticated.

  • scmOAuth — Strata Cloud Manager APIs authenticate client requests using the OAuth 2.0 Client Credentials flow. Please use the clientid, clientsecret values associated wit…
  • scmToken — Strata Cloud Manager APIs authenticate client requests using the OAuth 2.0 Client Credentials flow. Please use the clientid, clientsecret values associated wit…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Onboarding Rules 6

Onboarding rules information

POST
/onboarding-rules
Create an onboarding rule
createOnboardingRule body → 201400409500
GET
/onboarding-rules
List onboarding rules
listOnboardingRules → 200500
POST
/onboarding-rules/{id}:move
Move an onboarding rule
moveOnboardingRuleByID 1 param body → 200400404500
GET
/onboarding-rules/{id}
Get an onboarding rule
getOnboardingRuleByID 1 param → 200404500
PUT
/onboarding-rules/{id}
Update an onboarding rule
updateOnboardingRuleByID 1 param body → 200400404409500
DELETE
/onboarding-rules/{id}
Delete an onboarding rule
deleteOnboardingRuleByID 1 param → 200404409500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are resolved_onboarding_rule (13 properties), onboard_rule_entry (13 properties), update_onboarding_rule_request (10 properties), create_onboarding_rule_request (8 properties). Each schema is shown below with its type and property counts.

resolved_variable
object
3 properties 3 required
resource_validation_result
object
3 properties
resolved_onboarding_rule
object
13 properties
device_model
object
1 property
model_criteria
object
2 properties
onboard_match_criteria
object
1 property
create_onboarding_rule_request
object
8 properties 6 required
update_onboarding_rule_request
object
10 properties 6 required
variable
object
2 properties 2 required
resolution_rule
object
1 property 1 required
onboard_rule_entry
object
13 properties 5 required
onboard_actions
object
Actions to perform during onboarding
move_onboarding_rule_request
object
2 properties 1 required
resource_validation_error
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-onboarding-rules-api-openapi.yml Raw ↑

Other APIs Palo Alto Networks publishes across the network.

PAN-OS XML API
PAN-OS OpenConfig API
Panorama API
AutoFocus API (Deprecated)
Prisma SASE Service Status API
Cross-Platform Service Status API
SASE Authentication Service API
Expedition API (Deprecated)
VM-Series Licensing API
Palo Alto Networks 5G Deregistered Trend API
Palo Alto Networks 5G Network Interconnects and Bandwidth API
Palo Alto Networks 5G Registered Trend API
Where this information came from

This is an independent, third-party profile of Palo Alto Networks Onboarding Rules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.