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 call-script API

Script invocation endpoints

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

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

8 operations 7 paths 0 schemas 1 DELETE4 GET2 POST1 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 call-script 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 8

Across 7 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

call-script 8

Script invocation endpoints

PUT
/data/api/v1/resources/com.inductiveautomation.sip-notification/script-settings
Modify Call Script
modify-call-script-put body → 200400401404
POST
/data/api/v1/resources/com.inductiveautomation.sip-notification/script-settings
Create Call Script
create-call-script-post body → 200400401404
DELETE
/data/api/v1/resources/com.inductiveautomation.sip-notification/script-settings/{name}/{signature}
Delete Call Script
delete-call-script-delete 4 params → 200400401404
POST
/data/api/v1/resources/delete/com.inductiveautomation.sip-notification/script-settings
Delete Call Script (multiple)
delete-call-script-(multiple)-post 1 param body → 200400401404
GET
/data/api/v1/resources/find/com.inductiveautomation.sip-notification/script-settings/{name}
Get Call Script Config
get-call-script-config-get 2 params → 200400401404
GET
/data/api/v1/resources/list/com.inductiveautomation.sip-notification/script-settings
List Call Script Resources
list-call-script-resources-get 5 params → 200400401404
GET
/data/api/v1/resources/names/com.inductiveautomation.sip-notification/script-settings
Get Call Script Names
get-call-script-names-get 5 params → 200400401404
GET
/data/api/v1/resources/type/com.inductiveautomation.sip-notification/script-settings
Describe 'Call Script' Resource Type
describe-'call-script'-resource-type-get → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-call-script-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 certificate-management API
Inductive Automation charts-info API
Inductive Automation client-pki-certificate-management API
Inductive Automation config-alarm API