Update API key entry

put

http://127.0.0.1:8080/apiKey

Updates an existing API key's configuration. The API key value itself cannot be changed. Either permission or rbacRoles must be provided. Changes are logged in the system audit trail.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

required

The unique name of the API key to update. Must match an existing key exactly.

Body Params

Updated API key configuration. The key value is preserved from the existing entry.

Request body for updating an existing API key. Either permission or rbacRoles must be provided. The key value cannot be changed.

name

string

required

Unique identifier name for the API key. Should match the name query parameter.

description

string

Human-readable description of the API key's purpose.

active

boolean

required

Whether the API key is active. Set to false to disable the key without deleting it.

expiration

int64

required

UNIX timestamp (seconds) when the key expires. Set to 0 for no expiration.

permission

string

enum

required

Access level for the API key. Use empty string when rbacRoles is set.

Allowed:

rbacRoles

string

Comma-separated RBAC role names. Overrides basic permission when set.

applianceAccessGroup

string

Name of an appliance access group to restrict which appliances this key can manage.

ipList

array of strings

IP addresses or CIDR subnets allowed to use this key. Empty array allows all IPs.

ipList

Responses

204

API key updated successfully. No content returned.

401

Unauthorized. Authentication required or invalid credentials.

403

Forbidden. User does not have net_read_write permission required to update API keys.

500

Internal Server Error. Failed to update the API key due to a server-side issue.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request. Validation failed.

404Not Found. No API key exists with the specified name.