Manage an EMQX Fleets Deployment

This page describes the management operations available for an EMQX Fleets deployment, including monitoring the deployment overview, managing API keys, and configuring deployment settings.

Deployment Overview

The Deployment Overview page is the main dashboard for a Fleets deployment. It shows:

Metric	Description
Thing Types	Total number of Thing Types defined in this deployment
Things	Total number of registered devices
Things Online / Offline	Current online and offline device counts
Status	Deployment status: Running or Stopped
Cloud Platform	The cloud provider hosting this deployment
Region	The region where the deployment is running
Created At	Deployment creation timestamp

Deployment API Keys

API keys allow programmatic access to the Fleets REST API. Each key has its own set of API permissions, scoped to specific endpoints and HTTP methods.

The API Endpoint for this deployment is shown at the top of the Deployment API Key section on the Deployment Overview page. Use this URL as the base URL for all Fleets REST API calls:

https://{deploymentId}.ala.gcp.fleets.mqttce.net:8443

Authenticate all API requests with Basic Auth using the API key and secret:

Authorization: Basic <base64(apiKey:apiSecret)>

Create an API Key

1. On the Deployment Overview page, go to the Deployment API Key section.

2. Click + New API Key.

3. Enter a Name for the key.

4. Under API Permissions, select the endpoints and HTTP methods this key is allowed to access. Use the method buttons (GET, POST, PUT, PATCH, DELETE) to filter by method, or use the search box to filter by path prefix.

   Grant only the permissions the key actually needs. For example, a key used by a device to report data only needs POST /api/v1/thing-datas; a key used for read-only monitoring only needs GET access to /api/v1/things and /api/v1/thing-types. Use Select All only for administrative or testing purposes.

   

5. Click Confirm. A dialog displays the generated API Key and API Secret.

   TIP

   The API Secret is shown only once at creation. Store it securely. It cannot be retrieved later.

6. Click Close.

Manage API Keys

• View permissions: Click the expand arrow to the left of a key to see its assigned API Permissions, grouped by resource path.
• Edit: Click the edit icon in the Actions column to update the Name or modify the API Permissions.
• Delete: Click the delete icon in the Actions column to revoke access immediately.

Important Notice

Deleting an API key used by a running application or device will immediately break those integrations. Verify that the key is no longer in use before deleting it.

Deployment Settings

The Deployment Settings page shows the deployment's configuration details.

Field	Description
Deployment Name	Editable. Click the edit icon to rename.
Deployment ID	Unique identifier for this deployment. Used in API calls and support requests.
Plan	Current plan (for example, Starter).
Network ID	The network identifier for this deployment.
Cloud Platform	Cloud provider (read-only).
Region	Deployment region (read-only).
Billing Method	Current billing method (for example, Pay as you go).

Rename a Deployment

1. Go to Deployment Settings.
2. Click the edit icon next to Deployment Name.
3. Enter the new name and confirm.

Next Steps

• Thing Types
• Device Shadow