Skip to content

API Reference / API keys

Rename an API key

Changes an API key's label. The name carries no authority, so no two-factor re-verification is needed. The rename is recorded in the activity log.

POST/accounts.v1.Accounts/SetAPIKeyName

Request body

application/jsonRequired

Request to rename an API key in the caller's workspace. A non-administrator can rename only their own keys.

apiKeyId?string

Opaque 16-byte identifier of the API key to rename, base64-encoded in JSON.

Format"byte" base64

name?string

The new label, 1 to 256 characters after trimming surrounding whitespace.

Response body

application/json

Success

apiKey?APIKey

The API key with its new name.

Show attributes
createdAt?string

When the key was created.

Format"date-time"

createdBy?string

Opaque 16-byte identifier of the user who created the key and owns it, base64-encoded in JSON.

Format"byte" base64

expiresAt?string

When the key stops authenticating. Requests at or after this time are rejected as unauthenticated. Absent when the key never expires.

Format"date-time"

id?string

Opaque 16-byte identifier of the API key, assigned on creation. Base64-encoded in JSON.

Format"byte" base64

keyPrefix?string

The first 8 characters of the secret, kept so a key can be recognised in lists. Cannot authenticate on its own.

lastUsedAt?string

When the key last authenticated a request. Absent when the key has never been used.

Format"date-time"

name?string

Label chosen when the key was created, 1 to 256 characters, to tell keys apart.

policies?array<string>

Names of the policies granted to the key, at least one, such as "trading" or "steam". ListPolicies lists the valid names and the permissions each grants.

previousKeyExpiresAt?string

When the secret this key had before its last rotation stops authenticating. A time in the past means it has stopped. Absent when the key was never rotated with a grace period, or was last rotated with none.

Format"date-time"

revealable?boolean

Whether RevealAPIKey can return this key's secret. False for a key created before secrets were stored. Rotate it to make it revealable.

workspaceId?string

Opaque 16-byte identifier of the workspace the key is confined to, base64-encoded in JSON.

Format"byte" base64

curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/SetAPIKeyName" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ==",
    "name": "Deploy pipeline"
  }'
{
  "apiKey": {
    "id": "CgsMDQ4PEBESExQVFhcYGQ==",
    "name": "Deploy pipeline",
    "keyPrefix": "gm_live_8f3a",
    "workspaceId": "AAECAwQFBgcICQoLDA0ODw==",
    "createdAt": "2026-06-29T12:00:00Z",
    "policies": [
      "trading"
    ]
  }
}