Update VICAL configuration
Update the VICAL configuration for the requested ecosystem
Roles: ["admin","dts-provider"]
SecuritybearerAuth
Request
path Parameters
Request Body schema: application/jsonrequired
Responses
200
VICAL configuration updated
400
Bad Request. The request was malformed or missing required parameters.
put/v1/ecosystems/{ecosystemId}/vicals/configuration
Request samples
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
application/json
{- "vicalProvider": "Mattr",
- "vicalProviderFullName": "MATTR Limited",
- "certificateCountry": "NZ",
- "certificateCommonName": "Example Certificate Common Name",
- "autoPublish": {
- "enabled": true,
- "frequency": "Daily"
}
}
Response samples
- 200
- 400
application/json
{- "vicalProvider": "Mattr",
- "vicalProviderFullName": "MATTR Limited",
- "certificateCountry": "NZ",
- "certificateCommonName": "Example Certificate Common Name",
- "autoPublish": {
- "enabled": true,
- "frequency": "Daily"
}
}
Retrieve VICAL configuration
Retrieve the VICAL configuration from the requested ecosystem
Roles: ["admin","dts-provider"]
SecuritybearerAuth
Request
Responses
200
VICAL configuration retrieved
404
Not Found. The specified resource was not found.
get/v1/ecosystems/{ecosystemId}/vicals/configuration
Request samples
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
Response samples
- 200
- 404
application/json
{- "vicalProvider": "Mattr",
- "vicalProviderFullName": "MATTR Limited",
- "certificateCountry": "NZ",
- "certificateCommonName": "Example Certificate Common Name",
- "autoPublish": {
- "enabled": true,
- "frequency": "Daily"
}
}
Delete VICAL configuration
Delete the VICAL configuration for the requested ecosystem
Roles: ["admin","dts-provider"]
SecuritybearerAuth
Request
Responses
204
VICAL configuration deleted
404
Not Found. The specified resource was not found.
delete/v1/ecosystems/{ecosystemId}/vicals/configuration
Request samples
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
Response samples
- 404
application/json
{- "code": "string",
- "message": "string",
- "details": [
- {
- "value": "string",
- "msg": "Invalid value",
- "param": "id",
- "location": "body"
}
]
}