API Reference / Proxy providers
Reveal a proxy provider's key
Returns the stored API key of one connected proxy provider in your workspace. Requires the same manage permission as connecting or updating the provider. The key is never part of a provider read, a list or an event, and each reveal is recorded in the audit log. This does not contact the provider.
/ proxies. v1. Proxies/ RevealProviderCredentialsRequest body
application/jsonRequired
Request for the stored API credential of one connected proxy provider in the caller's workspace.
providerId?stringOpaque 16-byte identifier of the provider connection, base64-encoded in JSON.
Format"byte" base64
Response body
application/json
Success
credentials?stringThe provider account's API credential as UTF-8 bytes, base64-encoded in JSON, exactly as it was last sent to ConnectProvider or UpdateProvider: the Webshare API token or the Proxyline API key.
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
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.
application/json
The service is temporarily unavailable. Retry with backoff.
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/proxies.v1.Proxies/RevealProviderCredentials" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"providerId": "AY+MIBEReqqLuywsLCwsLA=="
}'const res = await fetch("https://api.goldmine.to/proxies.v1.Proxies/RevealProviderCredentials", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"providerId": "AY+MIBEReqqLuywsLCwsLA=="
}),
});
const data = await res.json();body := strings.NewReader(`{
"providerId": "AY+MIBEReqqLuywsLCwsLA=="
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/proxies.v1.Proxies/RevealProviderCredentials", 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/proxies.v1.Proxies/RevealProviderCredentials",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"providerId": "AY+MIBEReqqLuywsLCwsLA=="
},
)
data = res.json(){
"credentials": "d2Vic2hhcmUtdG9rZW4tQWJDZEVmMTIzNDU2"
}{
"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."
}{
"code": "unavailable",
"message": "The service is temporarily unavailable. Retry with backoff."
}