Look up a setting, route or term
The values you look up: environment variables, API routes, file formats, state names, helper commands and the words IRIS uses.
Find the route for a task
Use the Console by hand, and the authenticated /api/v1 API for automation.
For a sequence you can run, see Automate with the API.
| Task | API |
|---|---|
| List images | GET /api/v1/images |
| Upload or import an image | PUT /api/v1/images/upload/{filename}, POST /api/v1/images/import |
| List or add devices | GET /api/v1/devices, POST /api/v1/devices |
| Set a device's image assignment | POST /api/v1/devices/{device_id}/assign |
| Onboard or undeploy the agent | POST /api/v1/devices/{device_id}/onboard, POST /api/v1/devices/{device_id}/undeploy |
| Read device reports | GET /api/v1/devices/{device_id}/reports |
| Read policy or audit history | GET /api/v1/peer-policy, GET /api/v1/audit |
An assignment update replaces the whole ordered image list. Jobs run in the background, so follow one until it finishes. For every route with its schemas and errors, see Console API. The catalog on port 8443, the tracker on 6969 and the artifact server on 8000 have their own credentials and serve the device agent, not your integrations: see APIs the device agent uses.
Pages in this section
| Page | What it holds |
|---|---|
| Server configuration | Server and Console variables, container paths, credential file formats. |
| Device agent configuration | Agent variables and keys, installer variables, the files on each platform. |
| Console API | Sign-in, tokens, routes by area, request limits, versioning, error bodies. |
| Roles and sharing-policy API | Routes and fields for roles, the named groups of devices that share with each other. |
| APIs the device agent uses | The catalog, tracker, telemetry and artifact listeners, and what each answers. |
| Data formats and states | Catalog fields, policy fields, CSV columns, device state names. |
| Telemetry signals | Metric families, one attribute table per log event, example records. |
| Manual installation reference | Individual build, key and deployment procedures. |
| Helper commands | Each helper script: what it does, where it runs, which task uses it. |
| Glossary | The words IRIS uses, each with its plain meaning. |
| Cisco references and third-party components | The Cisco documentation the guides cite, and the third-party parts IRIS ships. |
| API error codes (problem types) | Every error code the API returns, what it means, what to do. |
| Browse the API | The same routes as a read-only Swagger UI, generated from the server's contract. |