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 V Satellite API

APIs for VSatellite.

Palo Alto Networks V Satellite 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 VSatellite. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 14 operations across 11 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.strata.paloaltonetworks.com/ngts.

14 operations 11 paths 41 schemas 1 DELETE6 GET1 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Palo Alto Networks V Satellite 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 14

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

VSatellite 14

APIs for VSatellite.

POST
/v1/edgeinstances/{id}/update
Trigger manual update of Satellite Instance
create-edgeinstances-update 1 param → 202400404412
GET
/v1/edgeencryptionkeys
Retrieve Satellite Encryption Keys
edgeencryptionkeys_getAll 1 param → 200
GET
/v1/edgeencryptionkeys/{id}
Retrieve SatelliteEncryption Key By Id
edgeencryptionkeys_getById 1 param → 200400404412
GET
/v1/edgeinstances
Retrieve Satellite Instances
edgeinstances_getAll 1 param → 200
GET
/v1/edgeinstances/{id}
Retrieve Satellite Instance By Id
edgeinstances_getById 2 params → 200400404412
PUT
/v1/edgeinstances/{id}
Update Satellite Instance
edgeinstances_update 1 param body → 200400404412
POST
/v1/pairingcodes/satellite
Create Pairing Code for Satellite Instance
pairingcodes_create body → 201400
POST
/v1/recoverycodes/satellite
Create Recovery Code for Satellite Instance
recoverycodes_create body → 201400
GET
/v1/edgeworkers
Retrieve Satellite Workers
edgeworkers_getAll 1 param → 200
POST
/v1/edgeworkers
Create Satellite Worker
edgeworkers_create body → 201400412
POST
/v1/edgeworkers/{id}/pair
Pair Satellite Worker with Satellite Instance
edgeworkers_pair 1 param body → 200400412
DELETE
/v1/edgeworkers/{id}
Delete Satellite Worker
edgeworker_delete 1 param → 204400404412
GET
/v1/updatesconfig
Retrieve Updates configuration
updatesconfig_get → 200
PATCH
/v1/updatesconfig
Create or Update Configuration
updatesconfig_patch body → 200

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are EdgeInstanceInformation (27 properties), EdgeWorkerInformation (11 properties), EdgeWorkerHealthDetails (11 properties), EdgeInstanceConnectionDetails (8 properties). Each schema is shown below with its type and property counts.

WorkerStatus
string
PairingCodeRequest
object
3 properties
ProductEntitlement
string
AnyValue6
Can be any value - string, number, boolean, array or object.
EdgeInstanceResponse
object
1 property
WorkerServiceStatusDetails
object
2 properties
ErrorInformation6
object
3 properties
WeeklyPatternInformation
object
3 required
EdgeInstanceRequest
object
2 properties 1 required
EdgeType
string
EdgeStatus
string
PodStatusDetails
object
7 properties
EdgeWorkerInformation
object
11 properties
UpgradeStatus
string
EdgeInstanceInformation
object
27 properties
RecoveryCodeRequest
object
1 property 1 required
UpdatesConfigRequest
object
1 property 1 required
PairingCodeInformation
object
7 properties
EdgeInstanceConnectionDetails
object
8 properties
EdgeInstanceStatusDetailsInformation
object
2 properties
EdgeWorkerRequest
object
3 properties
NamespaceStatusDetails
object
3 properties
HSMEdgeStatus
string
EncryptionKeysResponse
object
1 property
EdgeWorkerStatusDetailsInformation
object
2 properties
EncryptionKeyInformation
object
5 properties
DailyPatternInformation
object
2 required
EdgeWorkerDeleteResponse
object
2 properties
RecoveryCodeInformation
object
8 properties
NodeInfo
object
1 property
UpdatesConfigResponse
object
1 property
EdgeInstanceHealthDetails
object
8 properties
ChartDetails
object
2 properties
KeyAlgorithm
string
NamespaceChartDetails
object
2 properties
NodeCondition
object
4 properties
EdgeWorkersResponse
object
1 property
ErrorResponse6
object
1 property
SchedulerPatternInformation3
object
1 property 1 required
EdgeWorkerHealthDetails
object
11 properties
NodeStatusDetails
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-vsatellite-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 V Satellite 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.