# Confidential Ledger API

> Confidential Ledger API on Apizie: 33 endpoints (Retrieves a list of collection ids present in the Confidential Ledger, Gets a list of tags for a collection., Gets quotes for all nodes of the Confidential Ledger., Gets the constitution used for governance., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-confidentialledger-confidential-ledger`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://apizie.tech/api/cloud/azure-confidentialledger-confidential-ledger
- OpenAPI: https://apizie.tech/api/cloud/azure-confidentialledger-confidential-ledger/openapi.json

Write and retrieve ledger entries against the Confidential Ledger service.

## Endpoints

### Retrieves a list of collection ids present in the Confidential Ledger
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/list-collections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |

### Gets a list of tags for a collection.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/list-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| collectionId | string | no | The collection id. |

### Gets quotes for all nodes of the Confidential Ledger.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-enclave-quotes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |

### Gets the constitution used for governance.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-constitution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |

### Lists the consortium members.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/list-consortium-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |

### Gets details on a list of users.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/list-ledger-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |

### Gets a user with multiple roles.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-ledger-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| userId | string | yes | The user id, either an AAD object ID or certificate fingerprint. |

### Adds a user or updates a user's fields.
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/create-or-update-ledger-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| userId | string | yes | The user id, either an AAD object ID or certificate fingerprint. |
| body | object | yes | JSON request body |

### Deletes a user with multiple roles from the Confidential Ledger.
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/delete-ledger-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| userId | string | yes | The user id, either an AAD object ID or certificate fingerprint. |

### Gets role actions for user defined roles
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-user-defined-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| roleName | string | yes | user defined role name |

### Creates new roles and their actions
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/create-user-defined-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| body | object | yes | JSON request body |

### Patch replaces the allowed action on existing roles,if the desire is to remove an existing action, the role…
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/update-user-defined-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| body | object | yes | JSON request body |

### Deletes user defined roles
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/delete-user-defined-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| roleName | string | yes | user defined role name |

### Gets ledger entries from a collection corresponding to a range.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/list-ledger-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| collectionId | string | no | The collection id. |
| fromTransactionId | string | no | Specify the first transaction ID in a range. |
| toTransactionId | string | no | Specify the last transaction ID in a range. |
| tag | string | no | Single tag. |

### Writes a ledger entry.
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/create-ledger-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| collectionId | string | no | The collection id. |
| tags | string | no | Comma separated tags. |
| body | object | yes | JSON request body |

### Gets the ledger entry at the specified transaction id. A collection id may optionally be specified to…
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-ledger-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| collectionId | string | no | The collection id. |
| transactionId | string | yes | Identifies a write transaction. |

### Gets a receipt certifying ledger contents at a particular transaction id.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-receipt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| transactionId | string | yes | Identifies a write transaction. |

### Gets the status of an entry identified by a transaction id.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-transaction-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| transactionId | string | yes | Identifies a write transaction. |

### Gets the current value available in the ledger.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-current-ledger-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| collectionId | string | no | The collection id. |

### Gets a user defined endpoint.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-user-defined-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |

### Creates a user defined endpoint.
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/create-user-defined-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| body | object | yes | JSON request body |

### Module for user defined endpoints.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-user-defined-endpoints-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| module_name | string | yes | module name of the user defined endpoint |

### Runtime options for user defined endpoints.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-runtime-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |

### Runtime options for user defined endpoints.
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/update-runtime-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| body | object | yes | JSON request body |

### Retrieves a list of user defined functions present in the Confidential Ledger
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/list-user-defined-functions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |

### Gets a user defined function.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-user-defined-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| functionId | string | yes | Identifies a user defined function. |

### Creates a user defined function.
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/create-user-defined-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| functionId | string | yes | Identifies a user defined function. |
| body | object | yes | JSON request body |

### Deletes a user defined function from the Confidential Ledger.
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/delete-user-defined-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| functionId | string | yes | Identifies a user defined function. |

### Executes a user defined function.
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/execute-user-defined-function` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| functionId | string | yes | Identifies a user defined function. |
| body | object | no | JSON request body |

### Gets details on a list of users.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/list-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |

### Gets a user.
`GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/get-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| userId | string | yes | The user id, either an AAD object ID or certificate fingerprint. |

### Adds a user or updates a user's fields.
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/create-or-update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| userId | string | yes | The user id, either an AAD object ID or certificate fingerprint. |
| body | object | yes | JSON request body |

### Deletes a user from the Confidential Ledger.
`POST https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ledgerEndpoint | string | yes | The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com. |
| api-version | string | no | The API version to use for this operation. |
| userId | string | yes | The user id, either an AAD object ID or certificate fingerprint. |

## Example
```
curl "https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/list-collections" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Confidential Ledger API?
Create a free Apizie key, then send GET https://apizie.tech/v1/cloud:azure-confidentialledger-confidential-ledger/list-collections with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Confidential Ledger API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Confidential Ledger itself also needs your own key from azure.com.

### Can AI agents use the Confidential Ledger API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-confidentialledger-confidential-ledger.

### What is the status of the Confidential Ledger API?
Needs your own provider key (bring your own key)