An API key lets another system call the Kelvin API for one client organisation: to raise and read engineering requests and projects. A Deployr connection code creates its own key, so you need one here only for another system.
- 1
Under API keys, choose the Organisation the key is for.
- 2
Enter a Key name that says who will use it, and choose when it Expires: never, in 30 days, in 90 days or in a year.
- 3
Choose Create key, then Copy to copy it, and pass it to whoever will use it.
The block shows the address the API is called at and the shape of a request.
The key is shown once
Copy it as soon as it appears. It leaves the page once it is copied, when the browser tab is hidden, or after 10 minutes. Kelvin keeps only its first few characters, so a lost key can't be shown again: create a new one and revoke the old.
Reading the list
Each key shows its name and first characters, its organisation, when it was created and last used, and its Status: Active, Expired or Revoked. A key with an expiry shows the date it runs until, or ran out. An expired key is refused like a revoked one.
Keys created by Deployr connection codes are listed here too.
Revoking a key
Choose Revoke on the key's row and confirm with Revoke key. Anything calling Kelvin with that key is refused from then on. A revoked key stays in the list and can't be switched back on.
Note
Revoking the key a connection code created cuts that client's Deployr off from Kelvin. Create a new connection code to pair it again.