light-mode-image
Learn
API Reference

Ecosystems

Create an Ecosystem

POST/v1/ecosystems

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

name*string

The name of the ecosystem.

Length1 <= length <= 50
integrations?

Details external trust sources which are integrated into the ecosystem. These can be either a different ecosystem or a VICAL.

Response Body

application/json

application/json

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

POST/v1/ecosystems/sync

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

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

GET/v1/ecosystems

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Default100
Range1 <= value <= 1000
cursor?string

Starting point for the list of entries.

Response Body

application/json

application/json

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems"
{
  "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

GET/v1/ecosystems/{ecosystemId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

ecosystemId*string

The UUID of the ecosystem

Formatuuid

Response Body

application/json

application/json

application/json

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

PUT/v1/ecosystems/{ecosystemId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

ecosystemId*string

The UUID of the ecosystem

Formatuuid

Request Body

application/json

name?string

The name of the ecosystem.

Length1 <= length <= 50
integrations?

Response Body

application/json

application/json

application/json

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/v1/ecosystems/{ecosystemId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

ecosystemId*string

The UUID of the ecosystem

Formatuuid

Response Body

application/json

application/json

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?

Guide

Previous Page

Participants

Next Page

On this page

Create an EcosystemSync EcosystemsRetrieve all EcosystemsRetrieve a EcosystemUpdate a EcosystemDelete a Ecosystem