API Reference / API keys
Set an API key's policies
Replaces the policies granted to an existing API key, changing what it may do without changing the key itself. The secret value is untouched, so every consumer keeps working. A recent two-factor re-verification is required, exactly as creating a key is.
/ accounts. v1. Accounts/ SetAPIKeyPoliciesRequest body
application/jsonRequired
Request to replace the policies of an existing API key in the caller's workspace. Requires a two-factor step-up in the last 5 minutes, and a non-administrator can change only their own keys.
apiKeyId?stringOpaque 16-byte identifier of the API key to change, base64-encoded in JSON.
Format"byte" base64
policies?array<string>The complete new set of policy names, replacing the current set. At least one, each a name returned by ListPolicies.
Response body
application/json
Success
apiKey?APIKeyThe API key with its new policies.
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. The request cannot be carried out in the current system state.
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
The request was rate limited. Slow down and retry later.
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/SetAPIKeyPolicies" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ==",
"policies": [
"trading",
"analytics",
"csfloat-wallets"
]
}'const res = await fetch("https://api.goldmine.to/accounts.v1.Accounts/SetAPIKeyPolicies", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ==",
"policies": [
"trading",
"analytics",
"csfloat-wallets"
]
}),
});
const data = await res.json();body := strings.NewReader(`{
"apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ==",
"policies": [
"trading",
"analytics",
"csfloat-wallets"
]
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/accounts.v1.Accounts/SetAPIKeyPolicies", 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/SetAPIKeyPolicies",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ==",
"policies": [
"trading",
"analytics",
"csfloat-wallets"
]
},
)
data = res.json(){
"apiKey": {
"id": "CgsMDQ4PEBESExQVFhcYGQ==",
"name": "CI deploy key",
"keyPrefix": "gm_live_8f3a",
"workspaceId": "AAECAwQFBgcICQoLDA0ODw==",
"createdAt": "2026-06-29T12:00:00Z",
"policies": [
"trading",
"analytics",
"csfloat-wallets"
]
}
}{
"code": "failed_precondition",
"message": "The request cannot be carried out in the current system state."
}{
"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": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}