> For the complete documentation index, see [llms.txt](https://docs.validationcloud.io/v1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.validationcloud.io/v1/about/admin-api-keys.md).

# Admin API Keys

{% hint style="info" %}
**Using Claude Code or another AI harness like Codex?** You can interact with the Admin API using our skills & plugins. Visit <https://github.com/validationcloud/skills> to get started
{% endhint %}

Admin API Keys are team-scoped credentials for managing your Validation Cloud setup programmatically.\
Provisioning Node API endpoints, reading usage, or wiring Validation Cloud into your own CI/CD.

<figure><img src="/files/NAnCiqv0w5iREUMLBGYF" alt="Admin Keys page"><figcaption></figcaption></figure>

{% hint style="info" %}
**Availability.** Admin API Keys are available on the **Scale** and **Enterprise** Node API plans (not Free). Within those teams, only **Admins** can view this page, create keys, or revoke them. See [Team Accounts](/v1/about/team-accounts.md) for how roles differ.
{% endhint %}

### Scopes

Each key is assigned a single scope. Choose the least-privileged one that does the job.

<table><thead><tr><th width="131.88922119140625">Scope</th><th>What the key can do</th></tr></thead><tbody><tr><td><strong>Read</strong></td><td>List endpoints and read usage data</td></tr><tr><td><strong>Read &#x26; Write</strong></td><td>Read operations plus create, update, and delete endpoints</td></tr></tbody></table>

### Creating a key

1. On the Admin API Keys page: <https://app.validationcloud.io/api-keys>, choose a **Scope** (Read or Read & Write).
2. Give the key a descriptive **Name** (for example, `ci-provisioner`).
3. Click **Create key**, then copy the key and store it somewhere secure.

{% hint style="danger" %}
**Keys are shown once** and can't be retrieved later. If you lose one, revoke it and create a new one. Treat keys like passwords, store them in a secrets manager and never commit them to source control.
{% endhint %}

Keys are prefixed with `vc_adm_`. Pass yours as a bearer token on every request:

```bash
curl -s "https://api.validationcloud.io/admin/v1/endpoints" \
  -H "Authorization: ApiKey vc_adm_xxxxxxxxxxxxxxxxxxxx"
```

### Revoking a key

Find the key in the **Active Keys** list and click **Revoke**.

{% hint style="warning" %}
Revoking is immediate and permanent. Anything still using the key will start failing authentication. Roll your applications over to a new key before revoking the old one.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.validationcloud.io/v1/about/admin-api-keys.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.