Skip to content
Nirvana LabsNirvana Labs API
Docs
    API Reference

    API Keys

    Create API Key
    $ nirvana api-keys create
    POST/v1/api_keys
    Get API Key Details
    $ nirvana api-keys get
    GET/v1/api_keys/{api_key_id}
    Update API Key
    $ nirvana api-keys update
    PATCH/v1/api_keys/{api_key_id}
    Delete API Key
    $ nirvana api-keys delete
    DELETE/v1/api_keys/{api_key_id}
    List API Keys
    $ nirvana api-keys list
    GET/v1/api_keys
    ModelsExpand Collapse
    api_key: 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.

    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.

    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.

    api_key_permission: object { permission, resource_type }

    API Key permission.

    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"
    api_permission_level: "read" or "edit"

    Permission level: “read” or “edit”.

    "read"
    "edit"
    api_permission_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"