Create API key

Creates an API key.

An API key is an encrypted string that identifies a client application or agentic client. Unlike access tokens, an API key is not tied to a particular user account, but is itself a principal. Clients must pass a valid API key in the Authorization header of all requests. The API key enables the platform to authenticate the client and authorize requests to access API resources.

Body Params
string
required

Name of API key.

Must be unique on the tenant. The names of deleted API keys are reserved and cannot be used. To reuse a deleted key, use the Regenerate API Key operation.

groups
array of int64s

List of groupIds that identify user groups.

The API key is granted the access rights and permissions assigned to the specified user groups. An API key that is not assigned to any user group has no access rights.

groups
Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json