Sign inGet started
Docs
Get started

Piloterr API Authentication

How to authenticate Piloterr API requests: one Bearer API key plus a connectionId. MindCloud handles Piloterr's custom auth scheme for you.

Every Piloterr API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Piloterr account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a Piloterr connection in Connections. Piloterr uses its own authentication scheme. You provide whatever it requires when you create the connection — MindCloud handles the provider-specific details for you.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Piloterr account that should run the action. MindCloud stores and refreshes the Piloterr credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling Get Usage with an Piloterr connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/piloterr/actions/get-usage/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Piloterr account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect Piloterr

You need a Piloterr account with an active API key.

  1. Open API Keys in Piloterr

    In the Piloterr dashboard, go to API Keys.

  2. Create or copy an API key

    Create a new active API key or copy an existing active key.

  3. Paste the key into MindCloud

    Enter that value into the API Key field when creating the connection.

  4. Test the connection

    Run the Usage action to confirm the key is valid.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.