## Update API Key

`client.apiKeys.update(stringapiKeyID, APIKeyUpdateParamsbody, RequestOptionsoptions?): APIKey`

**patch** `/v1/api_keys/{api_key_id}`

Update an existing API key

### Parameters

- `apiKeyID: string`

- `body: APIKeyUpdateParams`

  - `name?: string`

    API Key name.

  - `permissions?: Array<Permission>`

    Scoped permissions for this API key. When provided, replaces the entire set. At least one is required.

    - `permission: APIPermissionLevel`

      Permission level: "read" or "edit".

      - `"read"`

      - `"edit"`

    - `resource_type: APIPermissionResourceType`

      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<string>`

    Project IDs this API key is scoped to. When provided, replaces the entire set. At least one is required.

  - `source_ip_rule?: SourceIPRule`

    IP filter rules.

    - `allowed?: Array<string>`

      List of IPv4 CIDR addresses to allow.

    - `blocked?: Array<string>`

      List of IPv4 CIDR addresses to deny.

  - `tags?: Array<string>`

    Tags to attach to the API Key.

### Returns

- `APIKey`

  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<APIKeyPermission>`

    Scoped permissions for this API key.

    - `permission: APIPermissionLevel`

      Permission level: "read" or "edit".

      - `"read"`

      - `"edit"`

    - `resource_type: APIPermissionResourceType`

      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<string>`

    Project IDs this API key is scoped to.

  - `source_ip_rule: SourceIPRuleResponse`

    IP filter rules.

    - `allowed: Array<string>`

      List of IPv4 CIDR addresses to allow.

    - `blocked: Array<string>`

      List of IPv4 CIDR addresses to deny.

  - `status: "active" | "inactive" | "expired"`

    Status of the API Key.

    - `"active"`

    - `"inactive"`

    - `"expired"`

  - `tags: Array<string>`

    Tags to attach to the API Key.

  - `updated_at: string`

    When the API Key was updated.

  - `key?: string`

    API Key. Only returned on creation.

  - `starts_at?: string`

    When the API Key starts to be valid.

### Example

```typescript
import NirvanaLabs from '@nirvana-labs/nirvana';

const client = new NirvanaLabs({
  apiKey: process.env['NIRVANA_LABS_API_KEY'], // This is the default and can be omitted
});

const apiKey = await client.apiKeys.update('api_key_id');

console.log(apiKey.id);
```

#### Response

```json
{
  "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"
}
```