Inductive Automation config-audit-profiles API
Audit profile configuration
OpenAPI Specification
openapi: 3.0.3
info:
title: Ignition Gateway REST access-control config-audit-profiles API
description: The Ignition Gateway REST API (Ignition 8.3+) provides an OpenAPI-compliant HTTP interface to Gateway configuration resources including tags, projects, modules, device connections, historian data, user management (SCIM), alarm notification, OPC connections, and more. The specification is dynamically generated based on installed modules. Authentication uses API keys exchanged for time-limited tokens via the X-Ignition-API-Token header. Mutative requests are audit-logged. Supports Kubernetes and Helm-based cloud-native deployments.
version: 8.3.0
contact:
name: Inductive Automation Support
url: https://support.inductiveautomation.com/
license:
name: Commercial
url: https://inductiveautomation.com/pricing/
x-postman-collection: https://raw.githubusercontent.com/inductiveautomation/83-api/main/postman/8.3.postman_collection_v2.json
servers:
- url: http://{gateway-host}:{port}
description: Ignition Gateway (HTTP)
variables:
gateway-host:
default: localhost
description: Hostname or IP address of the Ignition Gateway
port:
default: '8088'
description: Gateway HTTP port (default 8088; HTTPS default 8043)
- url: https://{gateway-host}:{port}
description: Ignition Gateway (HTTPS)
variables:
gateway-host:
default: localhost
description: Hostname or IP address of the Ignition Gateway
port:
default: '8043'
description: Gateway HTTPS port
security:
- apiKeyAuth: []
tags:
- name: config-audit-profiles
description: Audit profile configuration
paths:
/data/api/v1/resources/delete/ignition/audit-profile:
post:
summary: Delete Audit Profiles (multiple)
operationId: delete-audit-profiles-(multiple)-post
tags:
- config-audit-profiles
description: Delete multiple Audit Profiles resources by name
parameters:
- name: confirm
in: query
required: false
schema:
type: string
description: Whether to confirm the deletion, required when the operation would affect other resources.
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
signature: <string>
collection: <string>
- name: <string>
signature: <string>
collection: <string>
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/find/ignition/audit-profile/{name}:
get:
summary: Get Audit Profiles Config
operationId: get-audit-profiles-config-get
tags:
- config-audit-profiles
description: Retrieve configuration details about a specific Audit Profiles resource
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to read the resource from
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/ignition/audit-profile:
put:
summary: Modify Audit Profiles
operationId: modify-audit-profiles-put
tags:
- config-audit-profiles
description: Modify one or more Audit Profiles resources
parameters:
- name: allowInvalidReferences
in: query
required: false
schema:
type: string
description: If true, invalid references will be allowed. Default is false.
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
retentionDays: 90
settings:
databaseName: <string>
pruneEnabled: false
autoCreate: true
tableName: audit_events
keyColumn: audit_events_id
timestampColumn: event_timestamp
actorColumn: actor
actorHostColumn: actor_host
actionColumn: action
actionTargetColumn: action_target
actionValueColumn: action_value
statusCodeColumn: status_code
originatingSystemColumn: originating_system
originatingContextColumn: originating_context
backupConfig:
profile:
type: <string>
retentionDays: 90
settings:
databaseName: <string>
pruneEnabled: false
autoCreate: true
tableName: audit_events
keyColumn: audit_events_id
timestampColumn: event_timestamp
actorColumn: actor
actorHostColumn: actor_host
actionColumn: action
actionTargetColumn: action_target
actionValueColumn: action_value
statusCodeColumn: status_code
originatingSystemColumn: originating_system
originatingContextColumn: originating_context
- name: <string>
signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
retentionDays: 90
settings:
databaseName: <string>
pruneEnabled: false
autoCreate: true
tableName: audit_events
keyColumn: audit_events_id
timestampColumn: event_timestamp
actorColumn: actor
actorHostColumn: actor_host
actionColumn: action
actionTargetColumn: action_target
actionValueColumn: action_value
statusCodeColumn: status_code
originatingSystemColumn: originating_system
originatingContextColumn: originating_context
backupConfig:
profile:
type: <string>
retentionDays: 90
settings:
databaseName: <string>
pruneEnabled: false
autoCreate: true
tableName: audit_events
keyColumn: audit_events_id
timestampColumn: event_timestamp
actorColumn: actor
actorHostColumn: actor_host
actionColumn: action
actionTargetColumn: action_target
actionValueColumn: action_value
statusCodeColumn: status_code
originatingSystemColumn: originating_system
originatingContextColumn: originating_context
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
post:
summary: Create Audit Profiles
operationId: create-audit-profiles-post
tags:
- config-audit-profiles
description: Create a new Audit Profiles resource
parameters:
- name: allowInvalidReferences
in: query
required: false
schema:
type: string
description: If true, invalid references will be allowed. Default is false.
requestBody:
content:
application/json:
schema:
type: object
example:
- name: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
retentionDays: 90
settings:
databaseName: <string>
pruneEnabled: false
autoCreate: true
tableName: audit_events
keyColumn: audit_events_id
timestampColumn: event_timestamp
actorColumn: actor
actorHostColumn: actor_host
actionColumn: action
actionTargetColumn: action_target
actionValueColumn: action_value
statusCodeColumn: status_code
originatingSystemColumn: originating_system
originatingContextColumn: originating_context
backupConfig:
profile:
type: <string>
retentionDays: 90
settings:
databaseName: <string>
pruneEnabled: false
autoCreate: true
tableName: audit_events
keyColumn: audit_events_id
timestampColumn: event_timestamp
actorColumn: actor
actorHostColumn: actor_host
actionColumn: action
actionTargetColumn: action_target
actionValueColumn: action_value
statusCodeColumn: status_code
originatingSystemColumn: originating_system
originatingContextColumn: originating_context
- name: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
retentionDays: 90
settings:
databaseName: <string>
pruneEnabled: false
autoCreate: true
tableName: audit_events
keyColumn: audit_events_id
timestampColumn: event_timestamp
actorColumn: actor
actorHostColumn: actor_host
actionColumn: action
actionTargetColumn: action_target
actionValueColumn: action_value
statusCodeColumn: status_code
originatingSystemColumn: originating_system
originatingContextColumn: originating_context
backupConfig:
profile:
type: <string>
retentionDays: 90
settings:
databaseName: <string>
pruneEnabled: false
autoCreate: true
tableName: audit_events
keyColumn: audit_events_id
timestampColumn: event_timestamp
actorColumn: actor
actorHostColumn: actor_host
actionColumn: action
actionTargetColumn: action_target
actionValueColumn: action_value
statusCodeColumn: status_code
originatingSystemColumn: originating_system
originatingContextColumn: originating_context
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/ignition/audit-profile/{name}/{signature}:
delete:
summary: Delete Audit Profiles
operationId: delete-audit-profiles-delete
tags:
- config-audit-profiles
description: Delete a Audit Profiles resource by name
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: signature
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to delete the resource from
- name: confirm
in: query
required: false
schema:
type: string
description: Whether to confirm the deletion, required when the operation would affect other resources.
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/list/ignition/audit-profile:
get:
summary: List Audit Profiles Resources
operationId: list-audit-profiles-resources-get
tags:
- config-audit-profiles
description: List all Audit Profiles resources, in verbose format, including configuration, metrics, and health checks.
parameters:
- name: limit
in: query
required: false
schema:
type: string
description: The maximum number of items to return.
- name: offset
in: query
required: false
schema:
type: string
description: The number of items to skip before returning results.
- name: sortBy
in: query
required: false
schema:
type: string
description: 'The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`
to specify the sort direction as ascending or descending, respectively.
'
- name: search
in: query
required: false
schema:
type: string
description: A search string to filter items by. Terms separated by whitespace.
- name: key_0
in: query
required: false
schema:
type: string
description: 'Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression).'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/names/ignition/audit-profile:
get:
summary: Get Audit Profiles Names
operationId: get-audit-profiles-names-get
tags:
- config-audit-profiles
description: List all Audit Profiles resources, including just names and enabled bit
parameters:
- name: limit
in: query
required: false
schema:
type: string
description: The maximum number of items to return.
- name: offset
in: query
required: false
schema:
type: string
description: The number of items to skip before returning results.
- name: sortBy
in: query
required: false
schema:
type: string
description: 'The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`
to specify the sort direction as ascending or descending, respectively.
'
- name: search
in: query
required: false
schema:
type: string
description: A search string to filter items by. Terms separated by whitespace.
- name: key_0
in: query
required: false
schema:
type: string
description: 'Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression).'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/rename/ignition/audit-profile/{name}:
post:
summary: Rename Audit Profiles
operationId: rename-audit-profiles-post
tags:
- config-audit-profiles
description: Change the name of a Audit Profiles resource, and update all references to it
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: collection
in: query
required: false
schema:
type: string
description: The configuration collection to rename the resource in
requestBody:
content:
application/json:
schema:
type: object
example:
name: <string>
references: <string>
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
/data/api/v1/resources/type/ignition/audit-profile:
get:
summary: Describe 'Audit Profiles' Resource Type
operationId: describe-'audit-profiles'-resource-type-get
tags:
- config-audit-profiles
description: Describe the Audit Profiles resource type
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-Ignition-API-Token
description: Time-limited API token. Obtain by posting credentials to the token endpoint. See /data/api/v1/token for details.
externalDocs:
description: Ignition 8.3 Gateway REST API Documentation
url: https://www.docs.inductiveautomation.com/docs/8.3/platform/gateway/openapi