Skip to Content
Valdra Help
Account and billing

API keys

Create a key so your own systems can read your privacy and compliance status from the Valdra API.

Read the video as text

API keys, in Valdra.

The clinic in this video is made up, and so is every detail.

Your own tools, like a dashboard or a script, can read your privacy status from Valdra with an API key.

API keys come with the Professional and Enterprise plans, and only an admin can create or revoke one.

Name each key after the tool that uses it, and choose read only unless that tool must create records.

The full key shows once, right after you create it. Valdra keeps only a fingerprint of it, so copy it then.

When a tool no longer needs its key, revoke it. Anything still using that key stops working at once.

View docs lists each request your tool can make, with an example response.

What this is for

Your own tools, such as a dashboard or a script, can read your status from Valdra. Each tool uses its own API key. You can revoke a key at any time.

Before you start

  • Plan: Professional and Enterprise. Professional has 10 keys, Enterprise no limit. API keys and the MCP server are included in the Professional and Enterprise plans.
  • Role: only an Admin can create or revoke keys. An Auditor can see the list.
  • Have ready: a name for the key that says where it is used.

Steps

Open API keys

In the menu, open Account, then click API keys under Developers.

Name the key and choose its access

Type the Key name, for example the tool that will use it. Choose Read only, or Read and write (creates incidents and requests).

Choose Read only unless the tool must create records.

Click Create key

You will see API key created; save it now and the full key. This is the only time the full key will be shown. Click Copy and store it securely.

Read the docs

Click View docs to open Partner API docs, with each request, its parameters and an example response.

The Partner API docs page.
The Partner API docs page.

What you will see

Your keys are listed under Your keys, with when each was created and last used. To stop a key, click Revoke next to it.

If your plan changes to one without the API, your current plan does not include the API: existing keys are kept, but their requests are refused until you upgrade to Professional.

Common mistakes and fixes

You see API keys and the MCP server are included in the Professional and Enterprise plans. Your plan does not include keys. Click View plans.

You see Upgrade for more keys. Every key slot is used. Revoke a key you no longer use, or upgrade.

You lost a key. It cannot be shown again. Revoke it and create a new one.

If it did not work

Failed to create API key. Wait a moment and click Create key again.

Failed to revoke key. Please try again. Click Revoke again.

Network error. Please try again. Check your internet connection and try again.

Next step

See every connection your workspace has.

On this page