Documentation / Proxies / Endpoint
POST

/api/v1/proxies/parse

Detect proxy lines and return a preview (without saving or passwords)

Request#

POSIX shell · curl
curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/proxies/parse" \
  -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.

FieldTypeRequiredDescription
textstringYes
default_protocolunionNo
columnsarrayNo
Complete body schema
OpenAPI JSON
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "text"
        ],
        "properties": {
          "text": {
            "type": "string",
            "maxLength": 5000000
          },
          "default_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"
                ]
              }
            ]
          },
          "columns": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 40
            },
            "maxItems": 20
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response
OpenAPI JSON
{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "lines"
        ],
        "properties": {
          "lines": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "line",
                "status",
                "error",
                "warnings",
                "duplicate_of",
                "proxy",
                "alternatives"
              ],
              "properties": {
                "line": {
                  "type": "integer"
                },
                "status": {
                  "type": "string"
                },
                "error": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "warnings": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "duplicate_of": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "proxy": {
                  "anyOf": [
                    {
                      "type": "object",
                      "required": [
                        "protocol",
                        "protocol_source",
                        "host",
                        "port",
                        "username",
                        "password_present",
                        "name",
                        "remark",
                        "change_ip_url",
                        "provider",
                        "provider_params",
                        "pattern"
                      ],
                      "properties": {
                        "protocol": {
                          "type": "string"
                        },
                        "protocol_source": {
                          "type": "string"
                        },
                        "host": {
                          "type": "string"
                        },
                        "port": {
                          "type": "integer"
                        },
                        "username": {
                          "type": [
                            "null",
                            "string"
                          ]
                        },
                        "password_present": {
                          "type": "boolean"
                        },
                        "name": {
                          "type": [
                            "null",
                            "string"
                          ]
                        },
                        "remark": {
                          "type": [
                            "null",
                            "string"
                          ]
                        },
                        "change_ip_url": {
                          "type": [
                            "null",
                            "string"
                          ]
                        },
                        "provider": {
                          "type": [
                            "null",
                            "string"
                          ]
                        },
                        "provider_params": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "string"
                          }
                        },
                        "pattern": {
                          "type": "string"
                        }
                      }
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "alternatives": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "protocol",
                      "protocol_source",
                      "host",
                      "port",
                      "username",
                      "password_present",
                      "name",
                      "remark",
                      "change_ip_url",
                      "provider",
                      "provider_params",
                      "pattern"
                    ],
                    "properties": {
                      "protocol": {
                        "type": "string"
                      },
                      "protocol_source": {
                        "type": "string"
                      },
                      "host": {
                        "type": "string"
                      },
                      "port": {
                        "type": "integer"
                      },
                      "username": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "password_present": {
                        "type": "boolean"
                      },
                      "name": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "remark": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "change_ip_url": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "provider": {
                        "type": [
                          "null",
                          "string"
                        ]
                      },
                      "provider_params": {
                        "type": "object",
                        "additionalProperties": {
                          "type": "string"
                        }
                      },
                      "pattern": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
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-Zeilen erkennen und als Vorschau zurückgeben (ohne Speichern, ohne Passwörter)",
  "tags": [
    "Proxys"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "text"
          ],
          "properties": {
            "text": {
              "type": "string",
              "maxLength": 5000000
            },
            "default_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"
                  ]
                }
              ]
            },
            "columns": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 40
              },
              "maxItems": 20
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "proxies:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "lines"
            ],
            "properties": {
              "lines": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "line",
                    "status",
                    "error",
                    "warnings",
                    "duplicate_of",
                    "proxy",
                    "alternatives"
                  ],
                  "properties": {
                    "line": {
                      "type": "integer"
                    },
                    "status": {
                      "type": "string"
                    },
                    "error": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "warnings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "duplicate_of": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "proxy": {
                      "anyOf": [
                        {
                          "type": "object",
                          "required": [
                            "protocol",
                            "protocol_source",
                            "host",
                            "port",
                            "username",
                            "password_present",
                            "name",
                            "remark",
                            "change_ip_url",
                            "provider",
                            "provider_params",
                            "pattern"
                          ],
                          "properties": {
                            "protocol": {
                              "type": "string"
                            },
                            "protocol_source": {
                              "type": "string"
                            },
                            "host": {
                              "type": "string"
                            },
                            "port": {
                              "type": "integer"
                            },
                            "username": {
                              "type": [
                                "null",
                                "string"
                              ]
                            },
                            "password_present": {
                              "type": "boolean"
                            },
                            "name": {
                              "type": [
                                "null",
                                "string"
                              ]
                            },
                            "remark": {
                              "type": [
                                "null",
                                "string"
                              ]
                            },
                            "change_ip_url": {
                              "type": [
                                "null",
                                "string"
                              ]
                            },
                            "provider": {
                              "type": [
                                "null",
                                "string"
                              ]
                            },
                            "provider_params": {
                              "type": "object",
                              "additionalProperties": {
                                "type": "string"
                              }
                            },
                            "pattern": {
                              "type": "string"
                            }
                          }
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "alternatives": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "protocol",
                          "protocol_source",
                          "host",
                          "port",
                          "username",
                          "password_present",
                          "name",
                          "remark",
                          "change_ip_url",
                          "provider",
                          "provider_params",
                          "pattern"
                        ],
                        "properties": {
                          "protocol": {
                            "type": "string"
                          },
                          "protocol_source": {
                            "type": "string"
                          },
                          "host": {
                            "type": "string"
                          },
                          "port": {
                            "type": "integer"
                          },
                          "username": {
                            "type": [
                              "null",
                              "string"
                            ]
                          },
                          "password_present": {
                            "type": "boolean"
                          },
                          "name": {
                            "type": [
                              "null",
                              "string"
                            ]
                          },
                          "remark": {
                            "type": [
                              "null",
                              "string"
                            ]
                          },
                          "change_ip_url": {
                            "type": [
                              "null",
                              "string"
                            ]
                          },
                          "provider": {
                            "type": [
                              "null",
                              "string"
                            ]
                          },
                          "provider_params": {
                            "type": "object",
                            "additionalProperties": {
                              "type": "string"
                            }
                          },
                          "pattern": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

Search for headless, MCP, cookies or an API endpoint.

↑ ↓ NavigateEnter OpenEsc Close