## Update API Key

`client.APIKeys.Update(ctx, apiKeyID, body) (*APIKey, error)`

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

Update an existing API key

### Parameters

- `apiKeyID string`

- `body APIKeyUpdateParams`

  - `Name param.Field[string]`

    API Key name.

  - `Permissions param.Field[[]APIKeyUpdateParamsPermission]`

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

    - `Permission APIPermissionLevel`

      Permission level: "read" or "edit".

      - `const APIPermissionLevelRead APIPermissionLevel = "read"`

      - `const APIPermissionLevelEdit APIPermissionLevel = "edit"`

    - `ResourceType APIPermissionResourceType`

      Resource type this permission applies to.

      - `const APIPermissionResourceTypeVM APIPermissionResourceType = "vm"`

      - `const APIPermissionResourceTypeVPC APIPermissionResourceType = "vpc"`

      - `const APIPermissionResourceTypeVolume APIPermissionResourceType = "volume"`

      - `const APIPermissionResourceTypeConnectConnection APIPermissionResourceType = "connect_connection"`

      - `const APIPermissionResourceTypeRPCNodeDedicated APIPermissionResourceType = "rpc_node_dedicated"`

      - `const APIPermissionResourceTypeRPCNodeFlex APIPermissionResourceType = "rpc_node_flex"`

      - `const APIPermissionResourceTypeNKSCluster APIPermissionResourceType = "nks_cluster"`

      - `const APIPermissionResourceTypeNKSNodePool APIPermissionResourceType = "nks_node_pool"`

      - `const APIPermissionResourceTypeProject APIPermissionResourceType = "project"`

      - `const APIPermissionResourceTypeAPIKey APIPermissionResourceType = "api_key"`

      - `const APIPermissionResourceTypeOrganization APIPermissionResourceType = "organization"`

      - `const APIPermissionResourceTypeAuditLog APIPermissionResourceType = "audit_log"`

      - `const APIPermissionResourceTypeUsage APIPermissionResourceType = "usage"`

  - `ProjectIDs param.Field[[]string]`

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

  - `SourceIPRule param.Field[SourceIPRule]`

    IP filter rules.

  - `Tags param.Field[[]string]`

    Tags to attach to the API Key.

### Returns

- `type APIKey struct{…}`

  API Key response.

  - `ID string`

    API Key ID.

  - `CreatedAt Time`

    When the API Key was created.

  - `ExpiresAt Time`

    When the API Key expires and is no longer valid.

  - `Managed bool`

    Whether this API key is system-managed.

  - `Name string`

    API Key name.

  - `Permissions []APIKeyPermission`

    Scoped permissions for this API key.

    - `Permission APIPermissionLevel`

      Permission level: "read" or "edit".

      - `const APIPermissionLevelRead APIPermissionLevel = "read"`

      - `const APIPermissionLevelEdit APIPermissionLevel = "edit"`

    - `ResourceType APIPermissionResourceType`

      Resource type this permission applies to.

      - `const APIPermissionResourceTypeVM APIPermissionResourceType = "vm"`

      - `const APIPermissionResourceTypeVPC APIPermissionResourceType = "vpc"`

      - `const APIPermissionResourceTypeVolume APIPermissionResourceType = "volume"`

      - `const APIPermissionResourceTypeConnectConnection APIPermissionResourceType = "connect_connection"`

      - `const APIPermissionResourceTypeRPCNodeDedicated APIPermissionResourceType = "rpc_node_dedicated"`

      - `const APIPermissionResourceTypeRPCNodeFlex APIPermissionResourceType = "rpc_node_flex"`

      - `const APIPermissionResourceTypeNKSCluster APIPermissionResourceType = "nks_cluster"`

      - `const APIPermissionResourceTypeNKSNodePool APIPermissionResourceType = "nks_node_pool"`

      - `const APIPermissionResourceTypeProject APIPermissionResourceType = "project"`

      - `const APIPermissionResourceTypeAPIKey APIPermissionResourceType = "api_key"`

      - `const APIPermissionResourceTypeOrganization APIPermissionResourceType = "organization"`

      - `const APIPermissionResourceTypeAuditLog APIPermissionResourceType = "audit_log"`

      - `const APIPermissionResourceTypeUsage APIPermissionResourceType = "usage"`

  - `ProjectIDs []string`

    Project IDs this API key is scoped to.

  - `SourceIPRule SourceIPRuleResponse`

    IP filter rules.

    - `Allowed []string`

      List of IPv4 CIDR addresses to allow.

    - `Blocked []string`

      List of IPv4 CIDR addresses to deny.

  - `Status APIKeyStatus`

    Status of the API Key.

    - `const APIKeyStatusActive APIKeyStatus = "active"`

    - `const APIKeyStatusInactive APIKeyStatus = "inactive"`

    - `const APIKeyStatusExpired APIKeyStatus = "expired"`

  - `Tags []string`

    Tags to attach to the API Key.

  - `UpdatedAt Time`

    When the API Key was updated.

  - `Key string`

    API Key. Only returned on creation.

  - `StartsAt Time`

    When the API Key starts to be valid.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/nirvana-labs/nirvana-go"
  "github.com/nirvana-labs/nirvana-go/api_keys"
  "github.com/nirvana-labs/nirvana-go/option"
)

func main() {
  client := nirvana.NewClient(
    option.WithAPIKey("My API Key"),
  )
  apiKey, err := client.APIKeys.Update(
    context.TODO(),
    "api_key_id",
    api_keys.APIKeyUpdateParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
}
```