API Reference / Proxy pools
Delete an unused imported proxy pool
Soft-deletes an imported, provider-less pool and its unassigned proxy sessions together. Provider-owned pools and pools with any live assignment, including an assignment awaiting a session, cannot be deleted. Deleted pools and sessions remain in the audit trail and disappear from ordinary reads.
/ proxies. v1. Proxies/ DeletePoolRequest body
application/jsonRequired
Request to delete an imported proxy pool and its sessions. A provider's pool, or a pool with accounts assigned, is rejected.
poolId?stringID of the unused imported pool to delete. The workspace comes from the authenticated actor.
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. 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 operation was aborted, typically because of a concurrency conflict.
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/DeletePool" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"poolId": "AY+MISIifMyN3T09PT09PQ=="
}'const res = await fetch("https://api.goldmine.to/proxies.v1.Proxies/DeletePool", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"poolId": "AY+MISIifMyN3T09PT09PQ=="
}),
});
const data = await res.json();body := strings.NewReader(`{
"poolId": "AY+MISIifMyN3T09PT09PQ=="
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/proxies.v1.Proxies/DeletePool", 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/DeletePool",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"poolId": "AY+MISIifMyN3T09PT09PQ=="
},
)
data = res.json(){}{
"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": "aborted",
"message": "The operation was aborted, typically because of a concurrency conflict."
}{
"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."
}