Documentation / Proxies / Endpoint
POST

/api/v1/proxies/import

Import proxy lines; return a result per line without silently discarding entries

Request#

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

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

Parameters#

ParameterLocationRequiredDescription
operation_idqueryNo
Complete parameter schemas
OpenAPI JSON
[
  {
    "schema": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9-]{16,64}$"
    },
    "in": "query",
    "name": "operation_id",
    "required": false
  }
]

Request body#

Required.

FieldTypeRequiredDescription
textstringYes
default_protocolunionNo
columnsarrayNo
tagsarrayNo
group_idstring | nullNo
ip_checkerstring | nullNo
skip_duplicatesbooleanNo
accept_ambiguousbooleanNo
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
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 50
            },
            "maxItems": 30
          },
          "group_id": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 64
          },
          "ip_checker": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 32
          },
          "skip_duplicates": {
            "type": "boolean"
          },
          "accept_ambiguous": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response
OpenAPI JSON
{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "lines",
          "created",
          "duplicates",
          "ambiguous",
          "invalid"
        ],
        "properties": {
          "lines": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "line",
                "status",
                "id",
                "existing_id",
                "error",
                "warnings"
              ],
              "properties": {
                "line": {
                  "type": "integer"
                },
                "status": {
                  "type": "string"
                },
                "id": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "existing_id": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "error": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "warnings": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "created": {
            "type": "integer"
          },
          "duplicates": {
            "type": "integer"
          },
          "ambiguous": {
            "type": "integer"
          },
          "invalid": {
            "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-Zeilen importieren; Ergebnis je Zeile, nichts wird still verworfen",
  "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
            },
            "tags": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 50
              },
              "maxItems": 30
            },
            "group_id": {
              "type": [
                "string",
                "null"
              ],
              "minLength": 1,
              "maxLength": 64
            },
            "ip_checker": {
              "type": [
                "string",
                "null"
              ],
              "maxLength": 32
            },
            "skip_duplicates": {
              "type": "boolean"
            },
            "accept_ambiguous": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^[a-zA-Z0-9-]{16,64}$"
      },
      "in": "query",
      "name": "operation_id",
      "required": false
    }
  ],
  "x-required-scopes": [
    "proxies:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "lines",
              "created",
              "duplicates",
              "ambiguous",
              "invalid"
            ],
            "properties": {
              "lines": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "line",
                    "status",
                    "id",
                    "existing_id",
                    "error",
                    "warnings"
                  ],
                  "properties": {
                    "line": {
                      "type": "integer"
                    },
                    "status": {
                      "type": "string"
                    },
                    "id": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "existing_id": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "error": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "warnings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              },
              "created": {
                "type": "integer"
              },
              "duplicates": {
                "type": "integer"
              },
              "ambiguous": {
                "type": "integer"
              },
              "invalid": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "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