OpenAPI Reference

OpenAPI - The modern REST API for ISE system operations, backup/restore, and certificate management.

Overview

Port 443

Protocol

HTTPS

Authentication

Basic Auth

Content Type

application/json

Base URL

<ise-pan>/api/v1/

Setup

# Load credentials
dsource d000 dev/network

# Test connectivity
curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  "https://${ISE_PAN_FQDN}/api/v1/backup-restore/config/last-backup-status" | jq .

API Categories

Category Base Path Operations

Backup & Restore

/api/v1/backup-restore/

Backup, restore, schedule, status

Certificates

/api/v1/certs/

System certs, trusted certs, CSR

Repository

/api/v1/repository/

List, create, delete repositories

Deployment

/api/v1/deployment/

Node registration, roles

Patch

/api/v1/patch/

Install, rollback patches

System

/api/v1/system-settings/

Proxy, SMTP, etc.

Backup & Restore

Get Last Backup Status

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  "https://${ISE_PAN_FQDN}/api/v1/backup-restore/config/last-backup-status"
Response
{
  "response": {
    "action": "BACKUP",
    "status": "COMPLETED",
    "repository": "nas-01",
    "name": "pre-migration-CFG10-260209-2251.tar.gpg",
    "startDate": "Tue Feb 09 22:51:00 PST 2026",
    "percentComplete": 100,
    "hostName": "ise-01.inside.domusdigitalis.dev",
    "initiatedFrom": "OPEN_API"
  }
}

Trigger Configuration Backup

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "repositoryName": "nas-01",
    "backupEncryptionKey": "YourSecureKey123",
    "backupName": "pre-migration"
  }' \
  "https://${ISE_PAN_FQDN}/api/v1/backup-restore/config/backup"

Trigger Restore

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "repositoryName": "nas-01",
    "restoreFile": "pre-migration-CFG10-260209-2251.tar.gpg",
    "backupEncryptionKey": "YourSecureKey123",
    "restoreIncludeAdeos": "false"
  }' \
  "https://${ISE_PAN_FQDN}/api/v1/backup-restore/config/restore"

Cancel Running Backup

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  -X POST \
  "https://${ISE_PAN_FQDN}/api/v1/backup-restore/config/cancel-backup"

Repository Management

List Repositories

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  "https://${ISE_PAN_FQDN}/api/v1/repository"
Response
{
  "response": [
    {
      "name": "nas-01",
      "protocol": "NFS",
      "serverName": "10.50.1.70",
      "path": "/volume1/ise_backups"
    },
    {
      "name": "disk",
      "protocol": "DISK",
      "path": "/"
    }
  ]
}

List Files in Repository

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  "https://${ISE_PAN_FQDN}/api/v1/repository/nas-01/files"

Create Repository

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "name": "backup-repo",
    "protocol": "SFTP",
    "serverName": "10.50.1.70",
    "path": "/backups/ise",
    "userName": "backup-user",
    "password": "password123"
  }' \
  "https://${ISE_PAN_FQDN}/api/v1/repository"

Certificate Management

List System Certificates

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  "https://${ISE_PAN_FQDN}/api/v1/certs/system-certificate"

List Trusted Certificates

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  "https://${ISE_PAN_FQDN}/api/v1/certs/trusted-certificate"

Get Trusted Certificate by ID

CERT_ID="abc-123-def"

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  "https://${ISE_PAN_FQDN}/api/v1/certs/trusted-certificate/${CERT_ID}"

Import Trusted Certificate

# Base64 encode the certificate
CERT_B64=$(base64 -w0 /path/to/ca-cert.pem)

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -X POST \
  -d "{
    \"name\": \"DOMUS-ROOT-CA\",
    \"data\": \"${CERT_B64}\",
    \"allowBasicConstraintCAFalse\": false,
    \"allowOutOfDateCert\": false,
    \"trustForIseAuth\": true,
    \"trustForClientAuth\": true,
    \"trustForCertificateBasedAdminAuth\": false,
    \"trustForCiscoServicesAuth\": false
  }" \
  "https://${ISE_PAN_FQDN}/api/v1/certs/trusted-certificate/import"

Generate CSR

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "allowWildCardCert": false,
    "certificateRequestKeyAlgorithm": "RSA",
    "certificateRequestKeySize": 4096,
    "commonName": "ise-01.inside.domusdigitalis.dev",
    "organization": "Domus Digitalis",
    "organizationalUnit": "IT",
    "city": "Los Angeles",
    "state": "California",
    "country": "US",
    "sanDNS": ["ise-01.inside.domusdigitalis.dev"],
    "sanIP": ["10.50.1.24"],
    "usedFor": ["ADMIN", "EAP", "PXGRID"]
  }' \
  "https://${ISE_PAN_FQDN}/api/v1/certs/certificate-signing-request"

Delete Trusted Certificate

CERT_ID="abc-123-def"

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -X DELETE \
  "https://${ISE_PAN_FQDN}/api/v1/certs/trusted-certificate/${CERT_ID}"

Deployment

Get Deployment Info

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  "https://${ISE_PAN_FQDN}/api/v1/deployment/node"

Get Node Details

NODE_NAME="ise-01"

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  "https://${ISE_PAN_FQDN}/api/v1/deployment/node/${NODE_NAME}"

Patch Management

List Installed Patches

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  "https://${ISE_PAN_FQDN}/api/v1/patch"

Install Patch

curl -sk -u "${ISE_API_USER}:${ISE_API_PASS}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "repositoryName": "nas-01",
    "patchName": "ise-patchbundle-3.4.0.608-Patch1.SPA.x86_64.tar.gz"
  }' \
  "https://${ISE_PAN_FQDN}/api/v1/patch/install"

netapi CLI Equivalent

curl netapi

Backup status

netapi ise backup-status

Trigger backup

netapi ise backup --repo nas-01 --name pre-migration

Restore

netapi ise restore --repo nas-01 --file backup.tar.gpg

List repositories

netapi ise list-repositories

List backups

netapi ise list-backups --repo nas-01

See Also