Microsoft Azure

Azure Confidentialledger data plane

Write and retrieve ledger entries against the Confidential Ledger service.

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Write and retrieve ledger entries against the Confidential Ledger service.

Endpoints 33

  • GETRetrieves a list of collection ids present in the Confidential Ledger/app/collections?api-version=stringCollection ids are user-created collections of ledger entries
  • GETGets a list of tags for a collection./app/collections/tags?api-version=string&collectionId=stringRetrieves the tags associated with a collection.
  • GETGets quotes for all nodes of the Confidential Ledger./app/enclaveQuotes?api-version=stringA quote is an SGX enclave measurement that can be used to verify the validity of a node and its enclave.
  • GETGets the constitution used for governance./app/governance/constitution?api-version=stringThe constitution is a script that assesses and applies proposals from consortium members.
  • GETLists the consortium members./app/governance/members?api-version=stringConsortium members can manage the Confidential Ledger.
  • GETGets details on a list of users./app/ledgerUsers?api-version=stringAll users' object IDs and multiple roles will be returned.
  • GETGets a user with multiple roles./app/ledgerUsers/:userId?api-version=stringGets a user with multiple roles.
  • DELETEDeletes a user with multiple roles from the Confidential Ledger./app/ledgerUsers/:userId?api-version=stringDeletes a user with multiple roles from the Confidential Ledger.
  • PATCHAdds a user or updates a user's fields./app/ledgerUsers/:userId?api-version=stringA JSON merge patch is applied for existing users
  • GETGets role actions for user defined roles/app/roles?api-version=string&roleName=stringuser defined roles allow users to define and manage app specific AuthZ policy.
  • PUTCreates new roles and their actions/app/roles?api-version=stringUser defined roles allow users to define and manage app specific AuthZ policy.
  • DELETEDeletes user defined roles/app/roles?api-version=string&roleName=stringA user defined role allows the users to create and manage their own role actions using the API.
  • PATCHPatch replaces the allowed action on existing roles,if the desire is to remove an existing action, the role must be deleted and recreated./app/roles?api-version=stringUser defined roles allow users to define and manage app specific AuthZ policy.
  • GETGets ledger entries from a collection corresponding to a range./app/transactions?api-version=string&collectionId=string&fromTransactionId=string&toTransactionId=string&tag=stringA collection id may optionally be specified. Only entries in the specified (or default) collection will be returned.
  • POSTWrites a ledger entry./app/transactions?api-version=string&collectionId=string&tags=stringA collection id may optionally be specified.
  • GETGets the ledger entry at the specified transaction id. A collection id may optionally be specified to indicate the collection from which to fetch the value./app/transactions/:transactionId?api-version=string&collectionId=stringTo return older ledger entries, the relevant sections of the ledger must be read from disk and validated. To prevent blocking within the enclave, the response…
  • GETGets a receipt certifying ledger contents at a particular transaction id./app/transactions/:transactionId/receipt?api-version=stringGets a receipt certifying ledger contents at a particular transaction id.
  • GETGets the status of an entry identified by a transaction id./app/transactions/:transactionId/status?api-version=stringGets the status of an entry identified by a transaction id.
  • GETGets the current value available in the ledger./app/transactions/current?api-version=string&collectionId=stringA collection id may optionally be specified.
  • GETGets a user defined endpoint./app/userDefinedEndpoints?api-version=stringReturns the user defined endpoint in the ACL instance
  • PUTCreates a user defined endpoint./app/userDefinedEndpoints?api-version=stringCreates the user defined endpoint in the ACL instance
  • GETModule for user defined endpoints./app/userDefinedEndpoints/modules?api-version=string&module_name=stringIt gets the module for the user defined endpoint.
  • GETRuntime options for user defined endpoints./app/userDefinedEndpoints/runtimeOptions?api-version=stringIt returns the runtime options
  • PATCHRuntime options for user defined endpoints./app/userDefinedEndpoints/runtimeOptions?api-version=stringUpdates the runtime options.
  • GETRetrieves a list of user defined functions present in the Confidential Ledger/app/userDefinedFunctions?api-version=stringUser defined functions stored in the Confidential Ledger
  • GETGets a user defined function./app/userDefinedFunctions/:functionId?api-version=stringReturns the user defined function in the Confidential Ledger
  • PUTCreates a user defined function./app/userDefinedFunctions/:functionId?api-version=stringCreates the user defined function in the Confidential Ledger
  • DELETEDeletes a user defined function from the Confidential Ledger./app/userDefinedFunctions/:functionId?api-version=stringDeletes a user defined function from the Confidential Ledger.
  • POSTExecutes a user defined function./app/userDefinedFunctions/:functionId:execute?api-version=stringExecutes the user defined function in the Confidential Ledger
  • GETGets details on a list of users./app/users?api-version=stringAll users' object IDs and single role per user will be returned.
  • GETGets a user./app/users/:userId?api-version=stringGets a user.
  • DELETEDeletes a user from the Confidential Ledger./app/users/:userId?api-version=stringDeletes a user from the Confidential Ledger.
  • PATCHAdds a user or updates a user's fields./app/users/:userId?api-version=stringA JSON merge patch is applied for existing users

API details

Authentication
None declared in the description
Operations
33 operations on 21 pathsGET 20PATCH 4DELETE 4PUT 3POST 2
Response formats
application/json
Description format
Swagger 2.0, API version 2026-02-23

How to test the Azure Confidentialledger data plane in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Confidentialledger data plane collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Retrieves a list of collection ids present in the Confidential Ledger” (GET /app/collections?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Confidentialledger data plane?

Write and retrieve ledger entries against the Confidential Ledger service. It is listed under Data & analytics and has 33 endpoints.

Who publishes the Azure Confidentialledger data plane?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure Confidentialledger data plane?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Azure Confidentialledger data plane have?

33 operations on 21 paths (20 GET, 4 PATCH, 4 DELETE, 3 PUT, 2 POST).

Is forking the Azure Confidentialledger data plane free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.