Skip to main content

Properties

description?

optional description?: string

Description

What the key is for.

expires_at

expires_at: string
Format: date-time

Description

When the key expires, as an ISO 8601 timestamp. It must be in the future and within the maximum key lifetime; a later value is refused with the limit named.

name

name: string

Description

A name for the key, shown in the key list.

permissions

permissions: string[]

Description

The permissions the key carries, such as project.chart.get. Each must be one the key’s root scope can carry and one the organization’s data plane key policy allows; the key creation screen under the project’s Settings → API Keys lists them.

project_id

project_id: string

Description

The unique identifier of the project the key is rooted at