Palo Alto Networks · JSON Structure

Sase Config Orchestration Api Onboarding Status Structure

OnboardingStatus schema from Palo Alto Networks SASE Configuration Orchestration API

Type: object Properties: 6
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

OnboardingStatus is a JSON Structure definition published by Palo Alto Networks, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id status steps error_message started_at completed_at

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-config-orchestration-api-onboarding-status-structure.json",
  "name": "OnboardingStatus",
  "description": "OnboardingStatus schema from Palo Alto Networks SASE Configuration Orchestration API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Remote network identifier."
    },
    "status": {
      "type": "string",
      "description": "Current onboarding phase.",
      "enum": [
        "pending",
        "provisioning",
        "configuring",
        "tunnel_establishing",
        "completed",
        "failed"
      ]
    },
    "steps": {
      "type": "array",
      "description": "Individual onboarding steps and their completion state.",
      "items": {
        "type": "object",
        "properties": {
          "step": {
            "type": "string",
            "description": "Step name."
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "in_progress",
              "completed",
              "failed"
            ]
          },
          "message": {
            "type": "string",
            "description": "Status message or error detail for this step."
          },
          "completed_at": {
            "type": "datetime"
          }
        }
      }
    },
    "error_message": {
      "type": "string",
      "description": "Error description if onboarding failed."
    },
    "started_at": {
      "type": "datetime"
    },
    "completed_at": {
      "type": "datetime"
    }
  }
}