Inductive Automation config-email-profile API
Email profile configuration
OpenAPI Specification
openapi: 3.0.3
info:
title: Ignition Gateway REST access-control config-email-profile 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-email-profile
description: Email profile configuration
paths:
/data/api/v1/resources/delete/ignition/email-profile:
post:
summary: Delete Email Profile Settings (multiple)
operationId: delete-email-profile-settings-(multiple)-post
tags:
- config-email-profile
description: Delete multiple Email Profile Settings 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/email-profile/{name}:
get:
summary: Get Email Profile Settings Config
operationId: get-email-profile-settings-config-get
tags:
- config-email-profile
description: Retrieve configuration details about a specific Email Profile Settings 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/email-profile:
put:
summary: Modify Email Profile Settings
operationId: modify-email-profile-settings-put
tags:
- config-email-profile
description: Modify one or more Email Profile Settings 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>
settings:
settings:
hostname:
value: '<Error: Too many levels of nesting to fake this schema>'
port:
value: '<Error: Too many levels of nesting to fake this schema>'
useSslPort:
value: '<Error: Too many levels of nesting to fake this schema>'
startTlsEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
username:
value: '<Error: Too many levels of nesting to fake this schema>'
password:
value: '<Error: Too many levels of nesting to fake this schema>'
advanced:
smtpTimeout:
value: '<Error: Too many levels of nesting to fake this schema>'
debugModeEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
sslProtocols:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
profile:
type: <string>
settings:
settings:
hostname:
value: '<Error: Too many levels of nesting to fake this schema>'
port:
value: '<Error: Too many levels of nesting to fake this schema>'
useSslPort:
value: '<Error: Too many levels of nesting to fake this schema>'
startTlsEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
username:
value: '<Error: Too many levels of nesting to fake this schema>'
password:
value: '<Error: Too many levels of nesting to fake this schema>'
advanced:
smtpTimeout:
value: '<Error: Too many levels of nesting to fake this schema>'
debugModeEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
sslProtocols:
value: '<Error: Too many levels of nesting to fake this schema>'
- name: <string>
signature: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
settings:
settings:
hostname:
value: '<Error: Too many levels of nesting to fake this schema>'
port:
value: '<Error: Too many levels of nesting to fake this schema>'
useSslPort:
value: '<Error: Too many levels of nesting to fake this schema>'
startTlsEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
username:
value: '<Error: Too many levels of nesting to fake this schema>'
password:
value: '<Error: Too many levels of nesting to fake this schema>'
advanced:
smtpTimeout:
value: '<Error: Too many levels of nesting to fake this schema>'
debugModeEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
sslProtocols:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
profile:
type: <string>
settings:
settings:
hostname:
value: '<Error: Too many levels of nesting to fake this schema>'
port:
value: '<Error: Too many levels of nesting to fake this schema>'
useSslPort:
value: '<Error: Too many levels of nesting to fake this schema>'
startTlsEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
username:
value: '<Error: Too many levels of nesting to fake this schema>'
password:
value: '<Error: Too many levels of nesting to fake this schema>'
advanced:
smtpTimeout:
value: '<Error: Too many levels of nesting to fake this schema>'
debugModeEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
sslProtocols:
value: '<Error: Too many levels of nesting to fake this schema>'
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 Email Profile Settings
operationId: create-email-profile-settings-post
tags:
- config-email-profile
description: Create a new Email Profile Settings 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>
settings:
settings:
hostname:
value: '<Error: Too many levels of nesting to fake this schema>'
port:
value: '<Error: Too many levels of nesting to fake this schema>'
useSslPort:
value: '<Error: Too many levels of nesting to fake this schema>'
startTlsEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
username:
value: '<Error: Too many levels of nesting to fake this schema>'
password:
value: '<Error: Too many levels of nesting to fake this schema>'
advanced:
smtpTimeout:
value: '<Error: Too many levels of nesting to fake this schema>'
debugModeEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
sslProtocols:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
profile:
type: <string>
settings:
settings:
hostname:
value: '<Error: Too many levels of nesting to fake this schema>'
port:
value: '<Error: Too many levels of nesting to fake this schema>'
useSslPort:
value: '<Error: Too many levels of nesting to fake this schema>'
startTlsEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
username:
value: '<Error: Too many levels of nesting to fake this schema>'
password:
value: '<Error: Too many levels of nesting to fake this schema>'
advanced:
smtpTimeout:
value: '<Error: Too many levels of nesting to fake this schema>'
debugModeEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
sslProtocols:
value: '<Error: Too many levels of nesting to fake this schema>'
- name: <string>
collection: <string>
enabled: <boolean>
description: <string>
config:
profile:
type: <string>
settings:
settings:
hostname:
value: '<Error: Too many levels of nesting to fake this schema>'
port:
value: '<Error: Too many levels of nesting to fake this schema>'
useSslPort:
value: '<Error: Too many levels of nesting to fake this schema>'
startTlsEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
username:
value: '<Error: Too many levels of nesting to fake this schema>'
password:
value: '<Error: Too many levels of nesting to fake this schema>'
advanced:
smtpTimeout:
value: '<Error: Too many levels of nesting to fake this schema>'
debugModeEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
sslProtocols:
value: '<Error: Too many levels of nesting to fake this schema>'
backupConfig:
profile:
type: <string>
settings:
settings:
hostname:
value: '<Error: Too many levels of nesting to fake this schema>'
port:
value: '<Error: Too many levels of nesting to fake this schema>'
useSslPort:
value: '<Error: Too many levels of nesting to fake this schema>'
startTlsEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
username:
value: '<Error: Too many levels of nesting to fake this schema>'
password:
value: '<Error: Too many levels of nesting to fake this schema>'
advanced:
smtpTimeout:
value: '<Error: Too many levels of nesting to fake this schema>'
debugModeEnabled:
value: '<Error: Too many levels of nesting to fake this schema>'
sslProtocols:
value: '<Error: Too many levels of nesting to fake this schema>'
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/email-profile/{name}/{signature}:
delete:
summary: Delete Email Profile Settings
operationId: delete-email-profile-settings-delete
tags:
- config-email-profile
description: Delete a Email Profile Settings 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/email-profile:
get:
summary: List Email Profile Settings Resources
operationId: list-email-profile-settings-resources-get
tags:
- config-email-profile
description: List all Email Profile Settings 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/email-profile:
get:
summary: Get Email Profile Settings Names
operationId: get-email-profile-settings-names-get
tags:
- config-email-profile
description: List all Email Profile Settings 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/email-profile/{name}:
post:
summary: Rename Email Profile Settings
operationId: rename-email-profile-settings-post
tags:
- config-email-profile
description: Change the name of a Email Profile Settings 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/email-profile:
get:
summary: Describe 'Email Profile Settings' Resource Type
operationId: describe-'email-profile-settings'-resource-type-get
tags:
- config-email-profile
description: Describe the Email Profile Settings 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