Allowed Software
Where a key may be presented from: a browser origin, a host, an address or a network. A key that requires an allowlist and has no entries reaches nothing — "no addresses named" reads as "not reachable yet", never as "anywhere".
Where to find it
- Module: Platform
- Group: Connectivity
- Section: Published API
- Screen: Allowed Software
Address in the console: /platform/api-allowlist
List · 7 columns · 5 fields on its form · 3 of them required
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 | client_code |
| Software | Text | client_name |
| Kind | Status | kind |
| Address | Code | value |
| Note | Text | note |
| Active | Yes or no | is_active |
| Added | Date and time | created_at |
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 required | Choice | Looked up from existing records | |
| Kind required | Choice | origin, host, ip, cidr | origin — a browser, https://app.partner.com. host — the referring host, for an embedded integration that sends no origin. ip — one server. cidr — a network, 203.0.113.0/24 (IPv4 only; name an IPv6 address exactly). |
| Address required | Text | Exactly as it will arrive. An origin includes the scheme and no trailing slash. | |
| Note | Text | Which of their servers this is. The thing you will want when they move hosting and half the calls start failing. | |
| Active | Yes or no |
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.