POST

/api/v1/proxies/test

Check proxy settings or a direct connection (mode=none) without saving; optionally detect the protocol automatically

Request#

POSIX shell · curl

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

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.

Authentication and permissions#

Authentication: Bearer token

Scopes: proxies:read

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

Parameters#

No path or query parameters declared.

Request body#

Required.

Complete body schema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "anyOf": [
          {
            "type": "object",
            "required": [
              "mode"
            ],
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "none"
                ]
              },
              "ip_checker": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 32
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "host",
              "port"
            ],
            "properties": {
              "ssh_private_key": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 65536
              },
              "ssh_key_passphrase": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 1024
              },
              "ip_checker": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 32
              },
              "protocol": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "http"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "https"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "socks4"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "socks4a"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "socks5"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "socks5h"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "ssh"
                    ]
                  }
                ]
              },
              "detect_protocol": {
                "type": "boolean",
                "description": "HTTP, HTTPS oder SOCKS5 durch Handshake erkennen; protocol wird zuerst geprüft. Kein Speichern."
              },
              "host": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "port": {
                "type": "integer",
                "minimum": 1,
                "maximum": 65535
              },
              "username": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 512
              },
              "password": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 1024
              },
              "ssh_host_key": {
                "type": [
                  "string",
                  "null"
                ],
                "pattern": "^SHA256:[A-Za-z0-9+/]{43}$"
              }
            },
            "additionalProperties": false
          }
        ]
      }
    }
  }
}

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-Angaben oder direkte Verbindung (mode=none) prüfen, ohne zu speichern; Protokoll optional automatisch erkennen",
  "tags": [
    "Proxys"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "anyOf": [
            {
              "type": "object",
              "required": [
                "mode"
              ],
              "properties": {
                "mode": {
                  "type": "string",
                  "enum": [
                    "none"
                  ]
                },
                "ip_checker": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 32
                }
              },
              "additionalProperties": false
            },
            {
              "type": "object",
              "required": [
                "host",
                "port"
              ],
              "properties": {
                "ssh_private_key": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 65536
                },
                "ssh_key_passphrase": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 1024
                },
                "ip_checker": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 32
                },
                "protocol": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "http"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "https"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "socks4"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "socks4a"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "socks5"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "socks5h"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "ssh"
                      ]
                    }
                  ]
                },
                "detect_protocol": {
                  "type": "boolean",
                  "description": "HTTP, HTTPS oder SOCKS5 durch Handshake erkennen; protocol wird zuerst geprüft. Kein Speichern."
                },
                "host": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 255
                },
                "port": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                },
                "username": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 512
                },
                "password": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "maxLength": 1024
                },
                "ssh_host_key": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "pattern": "^SHA256:[A-Za-z0-9+/]{43}$"
                }
              },
              "additionalProperties": false
            }
          ]
        }
      }
    }
  },
  "x-required-scopes": [
    "proxies:read"
  ],
  "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"
          }
        }
      }
    }
  }
}