Component Server HTTP API reference

Component Server API$

Server

Action
Endpoints related to callbacks/triggers execution.

GET/api/v1/action/index

POST/api/v1/action/execute

Component
Endpoints related to component metadata access.

GET/api/v1/component/index

GET/api/v1/component/details

GET/api/v1/component/dependencies

GET/api/v1/component/dependency/{id}

GET/api/v1/component/icon/{id}

GET/api/v1/component/icon/family/{id}

POST/api/v1/component/migrate/{id}/{configurationVersion}

Configuration Type
Endpoints related to configuration types (reusable configuration) metadata access.

GET/api/v1/configurationtype/index

GET/api/v1/configurationtype/details

POST/api/v1/configurationtype/migrate/{id}/{configurationVersion}

Documentation
Endpoint to retrieve embedded component documentation.

GET/api/v1/documentation/component/{id}

Environment
Endpoint giving access to versions and last update timestamp of the server.

GET/api/v1/environment

Scroll to top