API Keys
Write API Keys
Create API Key
POST
`/v1/api-keys`
API Key Generation and Management:
- Initial Creation:
- Upon creation, the full API key is displayed only once in the
api_key
property of the response. - Option to provide a custom name for the API key.
- Upon creation, the full API key is displayed only once in the
- Scope Assignment:
- Scopes can be defined using either integer values or string literals (
read
,write
, andnull
).- Write Access: Can be represented as 2 or
write
- Read access: Can be represented as 1 or
read
- No access: Can be represented as 0 or
null
- Write Access: Can be represented as 2 or
- Important: Scope assignment is restricted by the permissions of the current API key in use. You can only add scopes that are already present in your current key.
- Scopes can be defined using either integer values or string literals (
Update API Key
POST
`/v1/api-keys/:api-key`
You can update the name and scopes of your API Key.