ravion api-key
Create a service-account API key in the dashboard: Settings > Service accounts > select the account > Create API key. Use it as RAVION_API_KEY for automation, not a personal membership key.
Aliases: api-keys
Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Manage Ravion API keys from the CLI. Create service-account keys in Settings > Service accounts > select the account > Create API key, then use RAVION_API_KEY for automation instead of a personal membership key.
ravion api-keyapi-keys
ravion api-key deleteravion api-key delete <id> [flags]
| Flag | Required | Description |
|---|---|---|
-y, --yes | skip confirmation prompt |
ravion api-key getravion api-key get <id> [flags]
| Flag | Required | Description |
|---|---|---|
--json | emit response as JSON |
ravion api-key listravion api-key list [flags]
| Flag | Required | Description |
|---|---|---|
--cursor <string> | cursor | |
--json | emit response as JSON | |
--limit <int> | limit | |
--owner-id <string> | Optional owner id filter. Must be provided with ownerType. | |
--owner-type <string> | Optional owner type filter. Must be provided with ownerId. Available values: MEMBERSHIP, SERVICE_ACCOUNT. | |
-v, --verbose | show full output |
ravion api-key permissionsravion api-key permissions [flags]
| Flag | Required | Description |
|---|---|---|
--owner-id <string> | yes | ID of the membership or service account the key authenticates as. |
--owner-type <string> | yes | Type of principal the key authenticates as. Available values: MEMBERSHIP, SERVICE_ACCOUNT. |
--json | emit response as JSON | |
-v, --verbose | include display labels |
ravion api-key updateravion api-key update <id> [flags]
| Flag | Required | Description |
|---|---|---|
--clear-permissions | Remove the key’s limit and inherit all of its owner’s permissions | |
--description <string> | Optional context for where or why this API key is used. | |
--json | emit response as JSON | |
--name <string> | User-facing label for the API key. | |
--permissions <type:action> | The most the key may do, as type:action pairs from the authorization catalog, for example project:read or pipelineRun:create. The key may do something only when its owner may too, so it can narrow its owner’s permissions but never widen them. Null means everything its owner may do. Omitting this field on create uses the owner’s permissions; omitting it on update preserves the current limit. Limits apply only in organizations with authorization enforcement enabled. Limited keys cannot access the Terraform Cloud API or personal-account operations, and cannot select another organization. Only a member signed in to the dashboard or the CLI can change it, never an API key. |
Was this page helpful?