API Reference
Ecosystems
Create an Ecosystem
Create ecosystem
Creates an ecosystem.
Analytic events
- ECOSYSTEM_CREATE_START
- ECOSYSTEM_CREATE_SUCCESS
- ECOSYSTEM_CREATE_FAIL
POST
/v1/ecosystems
AuthorizationBearer <token>
In: header
namestring
The name of the ecosystem.
Length
1 <= length <= 50
integrations?array<MATTR Integration | VICAL Integration>
Details external trust sources which are integrated into the ecosystem. These can be either a different ecosystem or a VICAL.
curl -X POST "https://example.vii.au01.mattr.global/v1/ecosystems" \ -H "Content-Type: application/json" \ -d '{ "name": "My Ecosystem" }'
{
"id": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
"name": "My Ecosystem",
"integrations": [
{
"format": "MATTR",
"url": "https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy",
"enabled": true,
"integrationResult": {
"success": true,
"lastSyncedAt": "2024-09-10T02:28:36.550Z",
"lastModifiedAt": "2024-08-10T02:28:36.550Z",
"failReasons": [
{
"type": "UnknownVerificationError",
"message": "Unknown verification error occurred"
}
]
}
}
]
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Empty
Sync Ecosystems
Sync ecosystem
Synchronizes all configured consumptions and integrations by retrieving the most recent trust information. Analytic events
- ECOSYSTEM_TENANT_SYNC_ALL_START
- ECOSYSTEM_TENANT_SYNC_ALL_SUCCESS
- ECOSYSTEM_TENANT_SYNC_ALL_FAIL
POST
/v1/ecosystems/sync
AuthorizationBearer <token>
In: header
curl -X POST "https://example.vii.au01.mattr.global/v1/ecosystems/sync"
{
"tenantConfiguration": {
"ecosystems": [
{
"url": "https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe"
}
]
},
"integrations": [
{
"format": "MATTR",
"url": "https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy",
"enabled": true
}
]
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Retrieve all Ecosystems
Retrieve all ecosystems
Retrieves a list of ecosystems.
Analytic events
- ECOSYSTEM_RETRIEVE_LIST_START
- ECOSYSTEM_RETRIEVE_LIST_SUCCESS
- ECOSYSTEM_RETRIEVE_LIST_FAIL
GET
/v1/ecosystems
AuthorizationBearer <token>
In: header
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?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"
{
"data": [
{
"id": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
"name": "My Ecosystem",
"integrations": [
{
"format": "MATTR",
"url": "https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy",
"enabled": true,
"integrationResult": {
"success": true,
"lastSyncedAt": "2024-09-10T02:28:36.550Z",
"lastModifiedAt": "2024-08-10T02:28:36.550Z",
"failReasons": [
{
"type": "UnknownVerificationError",
"message": "Unknown verification error occurred"
}
]
}
}
]
}
],
"nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Retrieve a Ecosystem
Retrieve ecosystem
Retrieves an ecosystem by its ID.
Analytic events
- ECOSYSTEM_RETRIEVE_START
- ECOSYSTEM_RETRIEVE_SUCCESS
- ECOSYSTEM_RETRIEVE_FAIL
GET
/v1/ecosystems/{ecosystemId}
AuthorizationBearer <token>
In: header
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"
{
"id": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
"name": "My Ecosystem",
"integrations": [
{
"format": "MATTR",
"url": "https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy",
"enabled": true,
"integrationResult": {
"success": true,
"lastSyncedAt": "2024-09-10T02:28:36.550Z",
"lastModifiedAt": "2024-08-10T02:28:36.550Z",
"failReasons": [
{
"type": "UnknownVerificationError",
"message": "Unknown verification error occurred"
}
]
}
}
]
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Update a Ecosystem
Update ecosystem
Updates an ecosystem by its ID.
Analytic events
- ECOSYSTEM_UPDATE_START
- ECOSYSTEM_UPDATE_SUCCESS
- ECOSYSTEM_UPDATE_FAIL
PUT
/v1/ecosystems/{ecosystemId}
AuthorizationBearer <token>
In: header
Path Parameters
name?string
The name of the ecosystem.
Length
1 <= length <= 50
integrations?array<MATTR Integration | VICAL Integration>
curl -X PUT "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d" \ -H "Content-Type: application/json" \ -d '{}'
{
"id": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
"name": "My Ecosystem",
"integrations": [
{
"format": "MATTR",
"url": "https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy",
"enabled": true,
"integrationResult": {
"success": true,
"lastSyncedAt": "2024-09-10T02:28:36.550Z",
"lastModifiedAt": "2024-08-10T02:28:36.550Z",
"failReasons": [
{
"type": "UnknownVerificationError",
"message": "Unknown verification error occurred"
}
]
}
}
]
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Empty
Delete a Ecosystem
Delete ecosystem
Deletes an ecosystem by its ID.
Analytic events
- ECOSYSTEM_DELETE_START
- ECOSYSTEM_DELETE_SUCCESS
- ECOSYSTEM_DELETE_FAIL
DELETE
/v1/ecosystems/{ecosystemId}
AuthorizationBearer <token>
In: header
Path Parameters
curl -X DELETE "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d"
Empty
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}
Empty
How would you rate this page?