Caps API

Caps API Reference

Note: This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance. If you are looking for a simple way to test our API you might prefer our Postman collection, the YAML runner or the Developers section of the web UI.

Additional YAML examples can be found in the articles in the Overview section.

Caps API Examples#

The Caps API enables you to check the resource limits remaining under your Tenancy subscription.

Retrieve a Cap#

Retrieve the number of remaining Access Policies:

curl -g -v -X GET \
     -H "@$HOME/.datatrails/bearer-token.txt" \
     "https://app.datatrails.ai/archivist/v1/caps?service=access_policies"    

The response is:

{
    "caps": [
        {
            "resource_type": "AccessPolicies",
            "resource_remaining": "6"
        }
    ]
}

These are the available values for “?service=”:

• access_policies
• applications
• assets
• blobs
• compliance_policies
• locations
• tenancies/users

Caps OpenAPI Docs#