API Reference
Configuration
Update a VICAL configuration
PUT
/v1/ecosystems/{ecosystemId}/vicals/configurationAuthorization
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/497f6eca-6276-4993-bfeb-53cbbbba6f08/vicals/configuration" \ -H "Content-Type: application/json" \ -d '{ "vicalProvider": "string" }'{ "vicalProvider": "string", "autoPublish": { "enabled": true, "frequency": "Daily", "configuredAt": "2019-08-24T14:15:22Z" }}Retrieve VICAL configurations
GET
/v1/ecosystems/{ecosystemId}/vicals/configurationAuthorization
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/497f6eca-6276-4993-bfeb-53cbbbba6f08/vicals/configuration"{ "vicalProvider": "string", "autoPublish": { "enabled": true, "frequency": "Daily", "configuredAt": "2019-08-24T14:15:22Z" }}Delete VICAL configuration
DELETE
/v1/ecosystems/{ecosystemId}/vicals/configurationAuthorization
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/497f6eca-6276-4993-bfeb-53cbbbba6f08/vicals/configuration"Empty
How would you rate this page?
Last updated on