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 projects API

Ignition project management

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

This API exposes 12 operations across 11 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 11 paths 0 schemas 1 DELETE6 GET4 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 projects 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 11 paths, the API surfaces 12 operations — 1 DELETE, 6 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

projects 12

Ignition project management

POST
/data/api/v1/projects
Create Project
create-project-post body → 200400401404
POST
/data/api/v1/projects/copy
Copy Project
copy-project-post body → 200400401404
GET
/data/api/v1/projects/export/{name}
Export Project
export-project-get 1 param → 200400401404
GET
/data/api/v1/projects/find/{name}
Project Details
project-details-get 1 param → 200400401404
POST
/data/api/v1/projects/import/{name}
Import Project
import-project-post 2 params → 200400401404
GET
/data/api/v1/projects/list
List All Projects
list-all-projects-get 5 params → 200400401404
GET
/data/api/v1/projects/names
List All Project Names
list-all-project-names-get 5 params → 200400401404
GET
/data/api/v1/projects/parents
List All Valid Parent Projects
list-all-valid-parent-projects-get 5 params → 200400401404
GET
/data/api/v1/projects/parents/{name}
List Valid Parent Project Names For Project
list-valid-parent-project-names-for-project-get 6 params → 200400401404
POST
/data/api/v1/projects/rename/{name}
Rename Project
rename-project-post 1 param body → 200400401404
PUT
/data/api/v1/projects/{name}
Modify Project
modify-project-put 1 param body → 200400401404
DELETE
/data/api/v1/projects/{name}
Delete an Ignition Project
delete-an-ignition-project-delete 2 params → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-projects-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