List API Keys

$ nirvana api-keys list

GET/v1/api_keys

List all API keys

ParametersExpand Collapse

--cursor: optional string

Pagination cursor returned by a previous request

--limit: optional number

Maximum number of items to return

ReturnsExpand Collapse

api_key_list: 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.

expires_at: string

When the API Key expires and is no longer valid.

managed: boolean

Whether this API key is system-managed.

name: string

API Key name.

permissions: array of APIKeyPermission { permission, resource_type }

Scoped permissions for this API key.

permission: "read" or "edit"

Permission level: “read” or “edit”.

"read"

"edit"

resource_type: "vm" or "vpc" or "volume" or 10 more

Resource type this permission applies to.

"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: object { 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.

"active"

"inactive"

"expired"

tags: array of string

Tags to attach to the API Key.

updated_at: string

When the API Key was updated.

key: optional string

API Key. Only returned on creation.

starts_at: optional string

When the API Key starts to be valid.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

List API Keys

nirvana api-keys list \
  --api-key 'My API Key'

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "expires_at": "2025-01-01T00:00:00Z",
      "managed": false,
      "name": "My API Key",
      "permissions": [
        {
          "permission": "edit",
          "resource_type": "vm"
        }
      ],
      "project_ids": [
        "string"
      ],
      "source_ip_rule": {
        "allowed": [
          "192.168.1.0/24",
          "10.0.0.0/8"
        ],
        "blocked": [
          "192.168.1.100/32"
        ]
      },
      "status": "active",
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z",
      "key": "6r17s0jy_b0_RbSofrrNvawFQcaN-VbGtUM7cKCW7_k",
      "starts_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}

Returns Examples

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "expires_at": "2025-01-01T00:00:00Z",
      "managed": false,
      "name": "My API Key",
      "permissions": [
        {
          "permission": "edit",
          "resource_type": "vm"
        }
      ],
      "project_ids": [
        "string"
      ],
      "source_ip_rule": {
        "allowed": [
          "192.168.1.0/24",
          "10.0.0.0/8"
        ],
        "blocked": [
          "192.168.1.100/32"
        ]
      },
      "status": "active",
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z",
      "key": "6r17s0jy_b0_RbSofrrNvawFQcaN-VbGtUM7cKCW7_k",
      "starts_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}