Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Inductive Automation logging API

Logging configuration

Inductive Automation logging API is one of 88 APIs that Inductive Automation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include logging. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 10 paths. It is described by OpenAPI 3.0.3, at version 8.3.0.

Requests are made against 2 base URLs: http://{gateway-host}:{port}, https://{gateway-host}:{port}.

11 operations 10 paths 0 schemas 1 DELETE5 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.3.0
Base URL
https://{gateway-host}:8088/api
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Inductive Automation logging API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Ignition-API-Token (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Time-limited API token. Obtain by posting credentials to the token endpoint. See /data/api/v1/token for details.

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

logging 11

Logging configuration

GET
/data/api/v1/logs
Logs
logs-get 11 params → 200400401404
GET
/data/api/v1/logs/download
Download Logs
download-logs-get → 200400401404
POST
/data/api/v1/logs/levelreset
Reset Logger Levels
reset-logger-levels-post → 200400401404
GET
/data/api/v1/logs/loggers
Loggers
loggers-get 5 params → 200400401404
POST
/data/api/v1/logs/loggers/{loggerName}
Set Logger Level
set-logger-level-post 2 params → 200400401404
POST
/data/api/v1/logs/monitoring-session
Monitoring Session Logs
monitoring-session-logs-post 5 params body → 200400401404
POST
/data/api/v1/logs/properties
Modify Logger Context Properties (Bulk)
modify-logger-context-properties-(bulk)-post → 200400401404
GET
/data/api/v1/logs/properties/applied
Applied Logger Context Properties
applied-logger-context-properties-get 5 params → 200400401404
GET
/data/api/v1/logs/properties/registered
Registered Logger Context Properties
registered-logger-context-properties-get 5 params → 200400401404
POST
/data/api/v1/logs/properties/{key}
Add Logger Context Property
add-logger-context-property-post 3 params → 200400401404
DELETE
/data/api/v1/logs/properties/{key}
Remove Logger Context Property
remove-logger-context-property-delete 3 params → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-logging-api-openapi.yml Raw ↑

Other APIs Inductive Automation publishes across the network.

Ignition Gateway REST API
Inductive Automation access-control API
Inductive Automation agent-group API
Inductive Automation agent-management API
Inductive Automation alarm-journal-resources API
Inductive Automation alarm-notification-profile API
Inductive Automation api-token API
Inductive Automation audit API
Inductive Automation call-script API
Inductive Automation certificate-management API
Inductive Automation charts-info API
Inductive Automation client-pki-certificate-management API