API Keys

Create API Key

POST/v1/api_keys

Get API Key Details

GET/v1/api_keys/{api_key_id}

Update API Key

PATCH/v1/api_keys/{api_key_id}

Delete API Key

DELETE/v1/api_keys/{api_key_id}

List API Keys

GET/v1/api_keys

ModelsExpand Collapse

APIKey object { id, created_at, expires_at, 10 more }

API Key response.

id: string

API Key ID.

created_at: string

When the API Key was created.

formatdate-time

expires_at: string

When the API Key expires and is no longer valid.

formatdate-time

managed: boolean

Whether this API key is system-managed.

name: string

API Key name.

maxLength255

minLength1

permissions: array of APIKeyPermission { permission, resource_type }

Scoped permissions for this API key.

permission: APIPermissionLevel

Permission level: “read” or “edit”.

One of the following:

"read"

"edit"

resource_type: APIPermissionResourceType

Resource type this permission applies to.

One of the following:

"vm"

"vpc"

"volume"

"connect_connection"

"rpc_node_dedicated"

"rpc_node_flex"

"nks_cluster"

"nks_node_pool"

"project"

"api_key"

"organization"

"audit_log"

"usage"

project_ids: array of string

Project IDs this API key is scoped to.

source_ip_rule: SourceIPRuleResponse { allowed, blocked }

IP filter rules.

allowed: array of string

List of IPv4 CIDR addresses to allow.

blocked: array of string

List of IPv4 CIDR addresses to deny.

status: "active" or "inactive" or "expired"

Status of the API Key.

One of the following:

"active"

"inactive"

"expired"

tags: array of string

Tags to attach to the API Key.

updated_at: string

When the API Key was updated.

formatdate-time

key: optional string

API Key. Only returned on creation.

starts_at: optional string

When the API Key starts to be valid.

formatdate-time

APIKeyList object { items, pagination }

items: array of APIKey { id, created_at, expires_at, 10 more }

id: string

API Key ID.

created_at: string

When the API Key was created.

formatdate-time

expires_at: string

When the API Key expires and is no longer valid.

formatdate-time

managed: boolean

Whether this API key is system-managed.

name: string

API Key name.

maxLength255

minLength1

permissions: array of APIKeyPermission { permission, resource_type }

Scoped permissions for this API key.

permission: APIPermissionLevel

Permission level: “read” or “edit”.

One of the following:

"read"

"edit"

resource_type: APIPermissionResourceType

Resource type this permission applies to.

One of the following:

"vm"

"vpc"

"volume"

"connect_connection"

"rpc_node_dedicated"

"rpc_node_flex"

"nks_cluster"

"nks_node_pool"

"project"

"api_key"

"organization"

"audit_log"

"usage"

project_ids: array of string

Project IDs this API key is scoped to.

source_ip_rule: SourceIPRuleResponse { allowed, blocked }

IP filter rules.

allowed: array of string

List of IPv4 CIDR addresses to allow.

blocked: array of string

List of IPv4 CIDR addresses to deny.

status: "active" or "inactive" or "expired"

Status of the API Key.

One of the following:

"active"

"inactive"

"expired"

tags: array of string

Tags to attach to the API Key.

updated_at: string

When the API Key was updated.

formatdate-time

key: optional string

API Key. Only returned on creation.

starts_at: optional string

When the API Key starts to be valid.

formatdate-time

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

APIKeyPermission object { permission, resource_type }

API Key permission.

permission: APIPermissionLevel

Permission level: “read” or “edit”.

One of the following:

"read"

"edit"

resource_type: APIPermissionResourceType

Resource type this permission applies to.

One of the following:

"vm"

"vpc"

"volume"

"connect_connection"

"rpc_node_dedicated"

"rpc_node_flex"

"nks_cluster"

"nks_node_pool"

"project"

"api_key"

"organization"

"audit_log"

"usage"

APIPermissionLevel = "read" or "edit"

Permission level: “read” or “edit”.

One of the following:

"read"

"edit"

APIPermissionResourceType = "vm" or "vpc" or "volume" or 10 more

Resource type this permission applies to.

One of the following:

"vm"

"vpc"

"volume"

"connect_connection"

"rpc_node_dedicated"

"rpc_node_flex"

"nks_cluster"

"nks_node_pool"

"project"

"api_key"

"organization"

"audit_log"

"usage"