API Clients
The outside software that holds a key to this company. Every call it makes runs as a named user here, so nothing it can reach is anything that user could not already reach. The key is shown once when it is issued and never again.
Where to find it
- Module: Platform
- Group: Connectivity
- Section: Published API
- Screen: API Clients
Address in the console: /platform/api-clients
List · 14 columns · 13 fields on its form · 3 of them required · 2 actions
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Client | Code | code |
| Name | Text | name |
| Software | Text | software_name |
| Protocol | Status | protocol |
| Acts as | Text | run_as_name |
| Readiness | Status | readiness |
| Granted | Number | grant_count |
| Addresses | Number | allowlist_count |
| Key | Code | key_last4 |
| Rate/min | Number | rate_limit_per_minute |
| Calls (24h) | Number | calls_24h |
| Refused (24h) | Number | refused_24h |
| Last used | Date and time | last_used_at |
| Status | Status | status |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Client code required | Text | ||
| Name required | Text | ||
| What software is this | Text | A key outlives the person who asked for it. In three years somebody has to decide whether it is still needed, and this is what they will have to go on. | |
| Who to ask about it | Email address | ||
| Where it lives | Text | ||
| What it is for | Long text | ||
| Protocol | Choice | rest, mcp, both | The same key reaches the same data either way; this decides which door it opens. An MCP key presented to the REST API is refused by name rather than confusingly. |
| Acts as required | Choice | Looked up from existing records | Every call this key makes is made as this person. Whatever they may not do, the key may not do — which is what stops an exposure ever widening access rather than narrowing it. Give it a user made for the purpose, with the narrowest role that works. |
| Only from allowed addresses | Yes or no | On, and it means it: a key with no addresses listed reaches nothing. Switching it off is a deliberate decision that this key may be presented from anywhere in the world by anybody holding it. | |
| Rate limit per minute | Number | ||
| What to tell an MCP client | Long text | Sent as the server instructions when an agent connects. A model that is not told these tools reach a live ledger will treat them as a sandbox. | |
| Status | Choice | active, suspended, revoked | |
| Expires | Date |
What you can do here
Issue key primary
Issue a new API key
Withdraw key
Withdraw this key
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.