POST

/api/v1/proxies/{id}/test

Check a proxy: reachability, IPv4/IPv6 exit IP, location, time zone, ASN, and latency; save the result

Request#

POSIX shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/proxies/{id}/test" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs.

Authentication and permissions#

Authentication: Bearer token

Scopes: proxies:write

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

Parameter	Location	Required	Description
`ip_checker`	query	No
`apply_protocol`	query	No	Only with detect_protocol=true: apply a successfully detected HTTP/HTTPS/SOCKS5 protocol if the proxy version is unchanged. The check result is not saved.
`detect_protocol`	query	No	Use saved credentials to detect HTTP/HTTPS/SOCKS5 without saving the protocol or check result.
`id`	path	Yes

Complete parameter schemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "maxLength": 32
    },
    "in": "query",
    "name": "ip_checker",
    "required": false
  },
  {
    "schema": {
      "type": "boolean"
    },
    "in": "query",
    "name": "apply_protocol",
    "required": false,
    "description": "Nur zusammen mit detect_protocol=true: erfolgreich erkanntes HTTP-/HTTPS-/SOCKS5-Protokoll bei unveränderter Proxyversion übernehmen. Prüfergebnis wird dabei nicht gespeichert."
  },
  {
    "schema": {
      "type": "boolean"
    },
    "in": "query",
    "name": "detect_protocol",
    "required": false,
    "description": "Gespeicherte Zugangsdaten zur HTTP-/HTTPS-/SOCKS5-Erkennung verwenden, ohne Protokoll oder Prüfergebnis zu speichern."
  },
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Request body#

No request body declared.

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "ok",
          "checked_at",
          "error_class",
          "error_code",
          "protocol_detected",
          "ipv4",
          "ipv6",
          "country",
          "region",
          "city",
          "postal_code",
          "latitude",
          "longitude",
          "accuracy_km",
          "timezone",
          "utc_offset",
          "languages",
          "asn",
          "as_org",
          "latency_ms",
          "geo_source",
          "duplicate_profiles"
        ],
        "properties": {
          "ok": {
            "type": "boolean"
          },
          "checked_at": {
            "type": "integer"
          },
          "error_class": {
            "type": [
              "null",
              "string"
            ]
          },
          "error_code": {
            "type": [
              "null",
              "string"
            ]
          },
          "protocol_detected": {
            "type": [
              "null",
              "string"
            ]
          },
          "ipv4": {
            "type": [
              "null",
              "string"
            ]
          },
          "ipv6": {
            "type": [
              "null",
              "string"
            ]
          },
          "country": {
            "type": [
              "null",
              "string"
            ]
          },
          "region": {
            "type": [
              "null",
              "string"
            ]
          },
          "city": {
            "type": [
              "null",
              "string"
            ]
          },
          "postal_code": {
            "type": [
              "null",
              "string"
            ]
          },
          "latitude": {
            "type": [
              "null",
              "number"
            ]
          },
          "longitude": {
            "type": [
              "null",
              "number"
            ]
          },
          "accuracy_km": {
            "type": [
              "null",
              "number"
            ]
          },
          "timezone": {
            "type": [
              "null",
              "string"
            ]
          },
          "utc_offset": {
            "type": [
              "null",
              "string"
            ]
          },
          "languages": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "asn": {
            "type": [
              "null",
              "integer"
            ]
          },
          "as_org": {
            "type": [
              "null",
              "string"
            ]
          },
          "latency_ms": {
            "type": "object",
            "required": [
              "tcp",
              "handshake",
              "first_byte"
            ],
            "properties": {
              "tcp": {
                "type": [
                  "null",
                  "number"
                ]
              },
              "handshake": {
                "type": [
                  "null",
                  "number"
                ]
              },
              "first_byte": {
                "type": [
                  "null",
                  "number"
                ]
              }
            }
          },
          "geo_source": {
            "type": [
              "null",
              "string"
            ]
          },
          "duplicate_profiles": {
            "type": "integer"
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "Proxy prüfen: Erreichbarkeit, Exit-IP v4/v6, Standort, Zeitzone, ASN, Latenz; Ergebnis wird gespeichert",
  "tags": [
    "Proxys"
  ],
  "parameters": [
    {
      "schema": {
        "type": "string",
        "maxLength": 32
      },
      "in": "query",
      "name": "ip_checker",
      "required": false
    },
    {
      "schema": {
        "type": "boolean"
      },
      "in": "query",
      "name": "apply_protocol",
      "required": false,
      "description": "Nur zusammen mit detect_protocol=true: erfolgreich erkanntes HTTP-/HTTPS-/SOCKS5-Protokoll bei unveränderter Proxyversion übernehmen. Prüfergebnis wird dabei nicht gespeichert."
    },
    {
      "schema": {
        "type": "boolean"
      },
      "in": "query",
      "name": "detect_protocol",
      "required": false,
      "description": "Gespeicherte Zugangsdaten zur HTTP-/HTTPS-/SOCKS5-Erkennung verwenden, ohne Protokoll oder Prüfergebnis zu speichern."
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "proxies:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "ok",
              "checked_at",
              "error_class",
              "error_code",
              "protocol_detected",
              "ipv4",
              "ipv6",
              "country",
              "region",
              "city",
              "postal_code",
              "latitude",
              "longitude",
              "accuracy_km",
              "timezone",
              "utc_offset",
              "languages",
              "asn",
              "as_org",
              "latency_ms",
              "geo_source",
              "duplicate_profiles"
            ],
            "properties": {
              "ok": {
                "type": "boolean"
              },
              "checked_at": {
                "type": "integer"
              },
              "error_class": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "error_code": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "protocol_detected": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "ipv4": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "ipv6": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "country": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "region": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "city": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "postal_code": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "latitude": {
                "type": [
                  "null",
                  "number"
                ]
              },
              "longitude": {
                "type": [
                  "null",
                  "number"
                ]
              },
              "accuracy_km": {
                "type": [
                  "null",
                  "number"
                ]
              },
              "timezone": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "utc_offset": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "languages": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "asn": {
                "type": [
                  "null",
                  "integer"
                ]
              },
              "as_org": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "latency_ms": {
                "type": "object",
                "required": [
                  "tcp",
                  "handshake",
                  "first_byte"
                ],
                "properties": {
                  "tcp": {
                    "type": [
                      "null",
                      "number"
                    ]
                  },
                  "handshake": {
                    "type": [
                      "null",
                      "number"
                    ]
                  },
                  "first_byte": {
                    "type": [
                      "null",
                      "number"
                    ]
                  }
                }
              },
              "geo_source": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "duplicate_profiles": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}