Control Plane API

Preview

Sign in during Public Preview to get the Team plan free, plus an early-adopter discount when we launch. Sign in

Control Plane API

Available on Starter Standard Team Compare plans →

The Control Plane API lets you provision and manage Subscriptions, Resource Groups and Resources in Locally using the standard Azure Resource Manager APIs. It's a foundational part of Locally - anything that interacts with Azure, such as the Azure CLI, Terraform, Pulumi or the Azure SDKs, calls it.

It runs at https://localhost:5680, and when viewed in a browser looks similar to below:

Screenshot of the Control Plane

You can interact with the Control Plane API from common tooling like the Azure CLI and HashiCorp Terraform by running the commands you'd normally use to provision infrastructure, for example:

$ locally run az group list

Local Development Helpers

In order to make the API more explorable during development, when viewed in a browser, the Control Plane API doesn't require any authentication by default - but does when accessed from the Azure CLI/SDKs and other tooling.

You can toggle this behaviour in the Settings section of the Locally Dashboard:

Screenshot of the Settings section of the Locally Dashboard

Whilst this behaviour does differ from the Azure API, we feel it provides a better UX during development.

Note that as mentioned above, when the Control Plane API is interacted with using any other method (like the Azure SDKs) then a valid authentication token is required.

Preview

Sign in during Public Preview to get the Team plan free, plus an early-adopter discount when we launch. Sign in

A local cloud for you and your agents.

Your Azure infrastructure, running on your machine. Deploy in seconds, break things freely, and ship to Azure when you're ready.