Azure Blockchain Workbench REST API

Azure Blockchain Workbench helps organizations build rich, integrated multi-party blockchain applications quickly and easily. Azure Blockchain Workbench REST API provides developers and information workers a way to integrate to blockchain applications. For example, a developer can use the REST API to enable IoT devices to send data to a blockchain application. Or, an information worker can use the REST API and Power BI to create visualization of blockchain data.

Use the Azure Blockchain Workbench REST API to:

  • Create and manage blockchain applications and workflows within a blockchain consortium
  • Manage users and organizations associated with a consortium, blockchain applications, or application workflows
  • Integrate blockchain applications into their organization's applications or third-party applications
  • Create custom mobile or web apps integrated with blockchain applications
  • Perform transactions on a blockchain
  • Retrieve transactional and contract data from a blockchain

For more information about Blockchain Workbench applications, see Azure Blockchain Workbench configuration reference.

Base URL

When making a request to the REST API, all URLs have the following base: https://{blockchain-workbench-api-subdomain}/api/v2

The {blockchain-workbench-api-subdomain} is the subdomain of the Blockchain Workbench REST API web service. The REST API web service is created when you deploy Blockchain Workbench.

If you know your Blockchain Workbench URL, the REST API subdomain is similar to the Blockchain Workbench subdomain. The third level domain name includes a -api suffix. For example, if your Blockchain Workbench URL is, your REST API subdomain is


HTTP requests to the REST API are protected with Azure Active Directory (Azure AD).

To make an authenticated request to the REST APIs, client code requires authentication with valid credentials before you can call the API. Authentication is coordinated between the various actors by Azure AD, and provides your client with an access token as proof of the authentication. The token is then sent in the HTTP Authorization header of REST API requests. To learn more about Azure AD authentication, see Azure Active Directory for developers.

See REST API samples for examples of how to authenticate.

Using the REST API

You can review REST API calls using Swagger UI. In a browser, navigate to the REST API base URL. The Swagger UI for the Blockchain Workbench deployment is displayed.

Swagger UI


Since API requests require authentication, you can't use the Swagger UI Try it out! functionality.

For example scenarios using the Blockchain Workbench REST API, see using the Azure Blockchain Workbench REST API.

See REST API samples to get started.

If you want to test or experiment with Workbench APIs, you can use Postman to make API calls to your deployment. Download a sample Postman collection of Workbench API requests from GitHub. See the README file for details on authenticating and using the example API requests.

REST Operation Groups

Operation group Description
Applications Management of Blockchain Workbench blockchain applications
Capabilities List of capabilities user can perform within Blockchain Workbench
Checkers Developer tools used to validate Workbench configuration and blockchain smart contracts
Connections Connection to blockchain networks
Contracts V2 Smart contract instances, including ability to take actions on smart contracts
Ledgers Supported blockchain networks
Users Management of users within Blockchain Workbench