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.
/ accounts. v1. Accounts/ SetAPIKeyNameRequest body
application/jsonRequired
Request to rename an API key in the caller's workspace. A non-administrator can rename only their own keys.
apiKeyId?stringOpaque 16-byte identifier of the API key to rename, base64-encoded in JSON.
Format"byte" base64
name?stringThe new label, 1 to 256 characters after trimming surrounding whitespace.
Response body
application/json
Success
apiKey?APIKeyThe API key with its new name.
Show attributes
createdAt?stringWhen the key was created.
Format"date-time"
createdBy?stringOpaque 16-byte identifier of the user who created the key and owns it, base64-encoded in JSON.
Format"byte" base64
expiresAt?stringWhen the key stops authenticating. Requests at or after this time are rejected as unauthenticated. Absent when the key never expires.
Format"date-time"
id?stringOpaque 16-byte identifier of the API key, assigned on creation. Base64-encoded in JSON.
Format"byte" base64
keyPrefix?stringThe first 8 characters of the secret, kept so a key can be recognised in lists. Cannot authenticate on its own.
lastUsedAt?stringWhen the key last authenticated a request. Absent when the key has never been used.
Format"date-time"
name?stringLabel 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?stringWhen 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?booleanWhether RevealAPIKey can return this key's secret. False for a key created before secrets were stored. Rotate it to make it revealable.
workspaceId?stringOpaque 16-byte identifier of the workspace the key is confined to, base64-encoded in JSON.
Format"byte" base64
application/json
The request was malformed, such as a missing required field or an unparseable cursor.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The requested resource does not exist in this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
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"
}'const res = await fetch("https://api.goldmine.to/accounts.v1.Accounts/SetAPIKeyName", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ==",
"name": "Deploy pipeline"
}),
});
const data = await res.json();body := strings.NewReader(`{
"apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ==",
"name": "Deploy pipeline"
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/accounts.v1.Accounts/SetAPIKeyName", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/accounts.v1.Accounts/SetAPIKeyName",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ==",
"name": "Deploy pipeline"
},
)
data = res.json(){
"apiKey": {
"id": "CgsMDQ4PEBESExQVFhcYGQ==",
"name": "Deploy pipeline",
"keyPrefix": "gm_live_8f3a",
"workspaceId": "AAECAwQFBgcICQoLDA0ODw==",
"createdAt": "2026-06-29T12:00:00Z",
"policies": [
"trading"
]
}
}{
"code": "invalid_argument",
"message": "The request was malformed, such as a missing required field or an unparseable cursor."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "not_found",
"message": "The requested resource does not exist in this workspace."
}{
"code": "internal",
"message": "An internal server error occurred."
}