API Reference
Configuration
Update a VICAL configuration
PUT
/v1/ecosystems/{ecosystemId}/vicals/configurationUpdate the VICAL configuration for the requested ecosystem
Roles
admindts-provider
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration" \ -H "Content-Type: application/json" \ -d '{ "vicalProvider": "Mattr" }'{ "vicalProvider": "Mattr", "autoPublish": { "enabled": true, "frequency": "Daily", "configuredAt": "2025-07-01T00:00:00.000Z" }}Retrieve VICAL configurations
GET
/v1/ecosystems/{ecosystemId}/vicals/configurationRetrieve the VICAL configuration from the requested ecosystem
Roles
admindts-provider
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidResponse Body
application/json
application/json
curl -X GET "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration"{ "vicalProvider": "Mattr", "autoPublish": { "enabled": true, "frequency": "Daily", "configuredAt": "2025-07-01T00:00:00.000Z" }}Delete VICAL configuration
DELETE
/v1/ecosystems/{ecosystemId}/vicals/configurationDelete the VICAL configuration for the requested ecosystem
Roles
admindts-provider
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidResponse Body
application/json
curl -X DELETE "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration"Empty
How would you rate this page?
Last updated on