-
Notifications
You must be signed in to change notification settings - Fork 7
Using the CLI using an API Key
jpmarceau edited this page Aug 3, 2021
·
2 revisions
In the context of the Coveo Platform, an API key is an access token carrying a certain set of privileges in a specific Coveo organization. It can grant access to Coveo APIs and can be used as an authentication method to use the CLI.
The simplest way to create an API key is via the Coveo Administration Console, but you can also create one programmatically. Refer to our documentation for detailed instructions on creating and managing API Keys.
The privileges you need to grant your API key depend on what you'll do with the CLI.
To use the ui:create commands, you'll need the following permissions on the target API key:
- Search Service - Impersonate: Allowed
- Organization Service - API Keys: View All and 'Can Create' checked