VICALAPI Reference
General
Create a VICAL
Create VICAL
Creates a Verified Issuer Certificate Authority List (VICAL) based on the policy of the requested ecosystem. Refer to VICAL ot learn more about the VICAL purpose and data structure.
POST
/v1/ecosystems/{ecosystemId}/vicals
AuthorizationBearer <token>
In: header
Path Parameters
curl -X POST "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals"
{
"vicalIssueID": 1337,
"date": "2024-07-28T23:01:13.000Z"
}
Empty
Retrieve all VICALs
Retrieve all VICALs
Retrieves all VICALs available in the requested ecosystem.
GET
/v1/ecosystems/{ecosystemId}/vicals/public
Path Parameters
ecosystemIdstring
The UUID of the ecosystem
Format
uuid
Query Parameters
limit?number
Range size of returned list.
Default
100
Range
1 <= value <= 1000
cursor?string
Starting point for the list of entries.
curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/public?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"
{
"data": [
{
"vicalIssueID": 1337,
"date": "2024-07-28T23:01:13.000Z",
"filename": "vical-2024-07-28-1722164473000.cbor",
"isAutoPublished": false
}
],
"nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Retrieve a VICAL
Retrieve specific VICAL
Retrieves a specific VICAL from the requested ecosystem by providing the VICAL version identifier.
GET
/v1/ecosystems/{ecosystemId}/vicals/public/{vicalIssueId}
Path Parameters
ecosystemIdstring
The UUID of the ecosystem
Format
uuid
vicalIssueIdinteger
Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created.
Format
int32
curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/public/1337"
"string"
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Retrieve latest VICAL
Retrieve latest VICAL
Retrieves the latest VICAL from the requested ecosystem.
GET
/v1/ecosystems/{ecosystemId}/vicals/public/latest
Path Parameters
ecosystemIdstring
The UUID of the ecosystem
Format
uuid
curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/public/latest"
"string"
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
How would you rate this page?