ISE API Specifications

Overview

This section contains OpenAPI 3.0 specifications downloaded directly from Cisco ISE. These specs can be used for:

  • Code generation - Generate client libraries with openapi-generator

  • Type hints - Generate Pydantic/dataclass models

  • Validation - Validate request/response payloads

  • Documentation - Import into Swagger UI or Redoc

Available Specifications

Specification Version Endpoints Description

ERS API

3.1.0

199

External RESTful Services - endpoints, groups, profiles, dACLs

Policy API

1.0.0

75

Network Access & Device Admin - policy sets, auth/authz rules

Endpoint API

1.0.0

7

Bulk operations, advanced filtering, device summaries

Custom Attributes API

1.0.0

3

Endpoint custom attribute definitions

Certificates API

1.0.0

16

PKI management - CSR, system certs, trusted certs

DataConnect Views

-

70 views

Oracle database views for reporting/analytics

Specification Files

Raw OpenAPI JSON files are stored in the repository:

specs/
└── ise/
    ├── ise-34-ers-openapi.json            # ERS API (2.4 MB, 199 endpoints)
    ├── ise-openapi-policy.json            # Policy API (456 KB, 75 endpoints)
    ├── ise-openapi-endpoint.json          # Endpoint API (31 KB, 7 endpoints)
    ├── ise-openapi-custom-attributes.json # Custom Attributes (7.5 KB, 3 endpoints)
    ├── ise-openapi-certificates.json      # Certificates (173 KB, 16 endpoints)
    └── ise-dataconnect-views.html         # DataConnect (137 KB, 70 views)

Usage Examples

Generate Python Client

# Install openapi-generator
pip install openapi-generator-cli

# Generate Python client
openapi-generator-cli generate \
  -i specs/ise/ise-34-ers-openapi.json \
  -g python \
  -o ./generated/ise-ers-client \
  --additional-properties=packageName=ise_ers

Generate Pydantic Models

# Install datamodel-code-generator
pip install datamodel-code-generator

# Generate models
datamodel-codegen \
  --input specs/ise/ise-34-ers-openapi.json \
  --output ./generated/ise_models.py \
  --output-model-type pydantic_v2.BaseModel

View in Swagger UI

# Run Swagger UI locally
docker run -p 8080:8080 \
  -e SWAGGER_JSON=/specs/ise-34-ers-openapi.json \
  -v $(pwd)/specs/ise:/specs \
  swaggerapi/swagger-ui

Related