Keys
Create, rotate, and delete API keys
Retrieve API Keys
Returns the API keys of your workspace: yours and every other member's, including their full key values. Without a workspace, returns your own keys. The response holds at most 50 keys, oldest first.
Limited to 100 requests per minute. Also accepts an OAuth 2.0 access token with the account scope.
Retrieve API Keys › Responses
The keys of your workspace. Each key still authenticates as its own owner, and its requests are charged to that owner.
Create an API Key
Creates an API key for your account and returns its value in data.message. The request body is optional:
- Without
name, the key is namedDefault key, orDefault key 2,Default key 3, and so on when that name is taken. - Without
expires_in_days, the key expires in 365 days, the maximum.
You can hold as many unexpired keys as pricing.available_keys in GET /me, and at least 25 while you have unused credit-pack credits. Expired keys don't count. Past the limit, the request fails with 422 rate_limit.
Tomba emails you when a key is created. Limited to 100 requests per hour. Also accepts an OAuth 2.0 access token with the account scope. See Rotate keys.
Create an API Key › Request Body optional
nameLabel for the key, 2 to 100 characters after trimming spaces. Name the key after where it will be used.
expires_in_daysKey lifetime in days, from 1 to 365.
Create an API Key › Responses
Key created.
Retrieve a Single API Key
Returns one API key of your workspace, including its value. After rotating a key with PUT, read its new value here.
Limited to 100 requests per minute for each key ID. Also accepts an OAuth 2.0 access token with the account scope.
path Parameters
keyIdThe key's ID. A non-numeric ID fails with 422.
Retrieve a Single API Key › Responses
The key.
Reset an API Key
Rotates a key: issues a new value and a new 365-day expiry, and the old value stops working immediately. The key keeps its ID, name, and creator. Rotating also revives an expired key.
The response doesn't include the new value; read it with GET /keys/{keyId}. Any member of the key owner's workspace can rotate the key. Limited to 100 requests per hour for each key ID. Also accepts an OAuth 2.0 access token with the account scope.
path Parameters
keyIdThe key's ID. A non-numeric ID fails with 422.
Reset an API Key › Responses
Key rotated.
Result of an update or delete.
Delete an API Key
Deletes a key. Requests made with it fail from then on.
Any member of the key owner's workspace can delete the key. Limited to 100 requests per hour for each key ID. Also accepts an OAuth 2.0 access token with the account scope.
path Parameters
keyIdThe key's ID. A non-numeric ID fails with 422.
Delete an API Key › Responses
Key deleted.
Result of an update or delete.
Rename an API Key
Changes a key's name. The name is the only field you can edit. Expiry can't be changed: to extend a key, rotate it with PUT, which issues a new value with a new 365-day term.
Any member of the key owner's workspace can rename the key. Limited to 100 requests per hour for each key ID. Also accepts an OAuth 2.0 access token with the account scope.
path Parameters
keyIdThe key's ID. A non-numeric ID fails with 422.
Rename an API Key › Request Body
nameNew name for the key, 2 to 100 characters after trimming spaces.
Rename an API Key › Responses
Key renamed.
Result of an update or delete.