Skip to main content
PATCH
/
api
/
keys
/
{keyId}
Update API key
curl --request PATCH \
  --url https://nexus-dev.gerowallet.io/api/keys/{keyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production dashboard"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "cardano-mainnet",
  "keyPrefix": "nxs_aB3kP9xZ",
  "maskedKey": "nxs_aB3kP9xZ••••••••••••••••",
  "network": "MAINNET",
  "subscriptionTier": "PRO",
  "writeAccess": true,
  "enabled": true,
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "totalRequests": 12345,
  "createdAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://nexus.gerowallet.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT Token Authentication

Path Parameters

​
keyId
string<uuid>
required

Body

application/json

Partial update request for a user-owned API key

​
name
string

New human-readable label. Must be unique per user (case-insensitive).

Required string length: 1 - 100
Example:

"Production dashboard"

Response

Key updated

API key metadata

​
id
string<uuid>

API key ID

​
name
string

Human-readable label

Example:

"cardano-mainnet"

​
keyPrefix
string

First 12 characters of the key for UI identification

Example:

"nxs_aB3kP9xZ"

​
maskedKey
string

Masked key for display (prefix + ••••••••••••••••)

Example:

"nxs_aB3kP9xZ••••••••••••••••"

​
network
enum<string>

Blockchain network

Available options:
MAINNET,
PREPROD
Example:

"MAINNET"

​
subscriptionTier
string

Subscription tier, if any

Example:

"PRO"

​
writeAccess
boolean

Whether this key may submit write operations

​
enabled
boolean

Whether this key is active

​
lastUsedAt
string<date-time>

Last time the key was used for authentication

​
totalRequests
integer<int64>

Cumulative number of authenticated requests made with this key since creation. Updated asynchronously on each request.

Example:

12345

​
createdAt
string<date-time>

When the key was created