API Documentation
💡Have feedback for this page? Let us know on the IA Forum.
The API documentation in the Gateway provides a complete, dynamically generated specification of the HTTP API routes made publicly available by the Gateway and installed modules. These routes allow external systems to securely interact with Ignition using RESTful requests.
The page is intended for developers, integrators, or system administrators who need to interface with Ignition from external services, custom applications, or automation tools.
There are two ways to view the API documentation:
Interactive Documentation Page: A browser-based UI for exploring all available endpoints.
Raw API JSON Spec: A machine-readable document used for importing into tools or generating client SDKs.
Only routes that are explicitly documented by installed modules will appear in the API documentation. Internal or session-dependent routes are excluded.
The API documentation is dynamically generated based on the current state of the Gateway and its installed modules.
Using the API Documentation Page​
The API documentation is designed to help users:
- Discover available HTTP endpoints provided by installed modules
- Understand required parameters, authentication methods, and response formats
- Integrate with Ignition from third-party tools or services
- Generate client SDKs using compatible API tools
When browsing the /openapi interface, you can find the required parameters, authentication details, and expected response schemas for each documented route.
Accessing the Documentation​
You can access the API documentation UI from any modern web browser that has network access to the Gateway.
| Format | URL Example |
|---|---|
| Interactive Documentation Page | http[s]://<gateway-host>:<port>/openapi |
| Raw API JSON Specification | http[s]://<gateway-host>:<port>/openapi.json |
Authenticating Requests​
Most documented endpoints require authentication using an API Token. API Tokens are managed from the Platform > Security > API Keys page of the Gateway and must be included in the Authorization header of each request:
Authorization: Bearer <your-api-token>
To learn more about how API Tokens are created, refer to the API Keys page.
Configuration Resources​
As of version 8.3, many configuration elements in Ignition are exposed as resources using a standardized format. These resources are automatically documented and accessible through RESTful API endpoints, which appear in the /openapi specification.
These endpoints allow external systems to:
- Discover available configuration resource types
- List, read, create, update, and delete configuration resources
- Upload and retrieve related data files
- Perform configuration sync operations
These routes are organized under:
/data/api/v1/resources
For example:
GET /data/api/v1/resources/list/<moduleId>/<typeId>: Lists all resources of a given typePOST /data/api/v1/resources/<moduleId>/<typeId>: Creates a new resourceDELETE /data/api/v1/resources/<moduleId>/<typeId>/<name>/<signature>: Deletes a specific named resource
You can explore these and related routes by searching for /resources/ under the interactive OpenAPI page.
These resource routes are useful for:
- Infrastructure-as-code workflows
- Third party orchestration tools
- Remote configuration management
- Automating Gateway setup in containerized or cloud environments
Example Request​
Below is an example of using curl to call a documented endpoint:
curl -H "Authorization: Bearer YOUR_TOKEN" \
https://<gateway-host>:8088/data/mymodule/api/v1/getItem/abc-123