Aruba CX icon

Aruba CX

Interact with Aruba CX Switch REST API

Configuration → Get Checkpoint

AI-generated

Summary

Retrieves a named checkpoint configuration from an Aruba CX switch

Inputs

  • hostOverride — Optional: Override the hostname from credentials (useful for loops with multiple switches)
  • domain (required) — Domain of the Aruba CX API
  • checkpointName (required) — Name of the checkpoint to retrieve
  • additionalOptions — Optional extra options such as output format (e.g., JSON or text)

Output shape

a list of checkpoint configuration objects

May be empty; errors are returned as a JSON object when continueOnFail is enabled, otherwise the operation throws

Examples

Example 1: Fetch a checkpoint using default settings

hostOverride: "", domain: "System", checkpointName: "backup-2025-01-01", additionalOptions: {"format": "json"}

Discussion