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 service-connectors API

Service connector configuration

Inductive Automation service-connectors 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 service-connectors. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 9 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}.

12 operations 9 paths 0 schemas 2 DELETE5 GET3 POST2 PUT

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 service-connectors 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 12

Across 9 paths, the API surfaces 12 operations — 2 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

service-connectors 12

Service connector configuration

GET
/data/api/v1/resources/datafile/ignition/service-connector/{name}/{filename}
Get Service Connectors Data File
get-service-connectors-data-file-get 3 params → 200400401404
PUT
/data/api/v1/resources/datafile/ignition/service-connector/{name}/{filename}
Update Service Connectors Data File
update-service-connectors-data-file-put 5 params → 200400401404
DELETE
/data/api/v1/resources/datafile/ignition/service-connector/{name}/{filename}
Delete Service Connectors Data File
delete-service-connectors-data-file-delete 4 params → 200400401404
POST
/data/api/v1/resources/delete/ignition/service-connector
Delete Service Connectors (multiple)
delete-service-connectors-(multiple)-post 1 param body → 200400401404
GET
/data/api/v1/resources/find/ignition/service-connector/{name}
Get Service Connectors Config
get-service-connectors-config-get 2 params → 200400401404
PUT
/data/api/v1/resources/ignition/service-connector
Modify Service Connectors
modify-service-connectors-put body → 200400401404
POST
/data/api/v1/resources/ignition/service-connector
Create Service Connectors
create-service-connectors-post body → 200400401404
DELETE
/data/api/v1/resources/ignition/service-connector/{name}/{signature}
Delete Service Connectors
delete-service-connectors-delete 4 params → 200400401404
GET
/data/api/v1/resources/list/ignition/service-connector
List Service Connectors Resources
list-service-connectors-resources-get 5 params → 200400401404
GET
/data/api/v1/resources/names/ignition/service-connector
Get Service Connectors Names
get-service-connectors-names-get 5 params → 200400401404
POST
/data/api/v1/resources/rename/ignition/service-connector/{name}
Rename Service Connectors
rename-service-connectors-post 2 params body → 200400401404
GET
/data/api/v1/resources/type/ignition/service-connector
Describe 'Service Connectors' Resource Type
describe-'service-connectors'-resource-type-get → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-service-connectors-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