Platform › APIs & Events
API Clients
Machine access to this platform, scoped and rate limited. The key is shown once when it is issued and never again.
Where to find it
- Module: Platform
- Group: Connectivity
- Section: APIs & Events
- Screen: API Clients
Address in the console: /platform/api-clients
List · 9 columns · 8 fields on its form · 2 of them required · 1 action
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 |
| Prefix | Code | key_prefix |
| Key | Code | key_last4 |
| Scopes | Text | scopes |
| Rate/min | Number | rate_limit_per_minute |
| Calls | Number | call_count |
| 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 it is for | Long text | ||
| Scopes | Text | Comma separated, e.g. accounting:read, scm:read | |
| Rate limit per minute | Number | ||
| Allowed IPs | Text | ||
| Status | Choice | active, suspended, revoked | |
| Expires | Date |
What you can do here
Issue key primary
Issue a new API 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.