API Reference / API keys
Delete an API key
Permanently revokes an API key. Requests authenticated with that key stop working immediately.
/ accounts. v1. Accounts/ DeleteAPIKeyRequest body
application/jsonRequired
Request to permanently delete an API key in the caller's workspace, which stops it authenticating immediately. A non-administrator can delete only their own keys.
apiKeyId?stringOpaque 16-byte identifier of the API key to delete, base64-encoded in JSON. An unknown key, or another user's key, returns not_found.
Format"byte" base64
Response body
application/json
Success
No fields.
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
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/DeleteAPIKey" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ=="
}'const res = await fetch("https://api.goldmine.to/accounts.v1.Accounts/DeleteAPIKey", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ=="
}),
});
const data = await res.json();body := strings.NewReader(`{
"apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ=="
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/accounts.v1.Accounts/DeleteAPIKey", 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/DeleteAPIKey",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ=="
},
)
data = res.json(){}{
"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": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}