Dokumentation / Proxys / Endpunkt
GET

/api/v1/proxies

Proxys auflisten (Passwörter maskiert)

Anfrage#

POSIX-Shell · curl
curl --fail-with-body --request GET \
  "$ADBR_API_URL/api/v1/proxies" \
  -H "Authorization: Bearer $ADBR_API_TOKEN"

Verwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs.

Authentifizierung und Rechte#

Authentifizierung: Bearer-Token

Scopes: proxies:read

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Kontorechte, Anfrageinhalt, Tresorzustand und Ressourcenrechte können weitere Voraussetzungen setzen.

Parameter#

ParameterOrtPflichtBeschreibung
group_idqueryNein
check_statusqueryNein
sortqueryNein
orderqueryNein
searchqueryNein
protocolqueryNein
tagqueryNein
unusedqueryNein
trashqueryNein
pagequeryNein
limitqueryNein
Vollständige Parameterschemas
OpenAPI JSON
[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "query",
    "name": "group_id",
    "required": false
  },
  {
    "schema": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "unverified"
          ]
        },
        {
          "type": "string",
          "enum": [
            "passed"
          ]
        },
        {
          "type": "string",
          "enum": [
            "failed"
          ]
        }
      ]
    },
    "in": "query",
    "name": "check_status",
    "required": false
  },
  {
    "schema": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "dsn"
          ]
        },
        {
          "type": "string",
          "enum": [
            "name"
          ]
        },
        {
          "type": "string",
          "enum": [
            "created_at"
          ]
        },
        {
          "type": "string",
          "enum": [
            "last_check_at"
          ]
        },
        {
          "type": "string",
          "enum": [
            "profile_count"
          ]
        }
      ]
    },
    "in": "query",
    "name": "sort",
    "required": false
  },
  {
    "schema": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "asc"
          ]
        },
        {
          "type": "string",
          "enum": [
            "desc"
          ]
        }
      ]
    },
    "in": "query",
    "name": "order",
    "required": false
  },
  {
    "schema": {
      "type": "string",
      "maxLength": 200
    },
    "in": "query",
    "name": "search",
    "required": false
  },
  {
    "schema": {
      "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"
          ]
        }
      ]
    },
    "in": "query",
    "name": "protocol",
    "required": false
  },
  {
    "schema": {
      "type": "string",
      "maxLength": 50
    },
    "in": "query",
    "name": "tag",
    "required": false
  },
  {
    "schema": {
      "type": "boolean"
    },
    "in": "query",
    "name": "unused",
    "required": false
  },
  {
    "schema": {
      "type": "boolean"
    },
    "in": "query",
    "name": "trash",
    "required": false
  },
  {
    "schema": {
      "type": "integer",
      "minimum": 1
    },
    "in": "query",
    "name": "page",
    "required": false
  },
  {
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    },
    "in": "query",
    "name": "limit",
    "required": false
  }
]

Anfragekörper#

Kein Anfragekörper deklariert.

Antworten#

200 · Standardantwort
OpenAPI JSON
{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "items",
          "total",
          "page",
          "limit"
        ],
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "group_id",
                "ssh_key_set",
                "id",
                "compat_proxy_id",
                "name",
                "protocol",
                "host",
                "port",
                "username",
                "password_set",
                "change_ip_url",
                "change_ip_cooldown_s",
                "provider",
                "provider_params",
                "ip_checker",
                "remark",
                "tags",
                "last_check",
                "last_check_at",
                "profile_count",
                "created_at",
                "updated_at",
                "row_version",
                "deleted_at",
                "purge_after"
              ],
              "properties": {
                "group_id": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "ssh_key_set": {
                  "type": "boolean"
                },
                "id": {
                  "type": "string"
                },
                "compat_proxy_id": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "name": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "protocol": {
                  "type": "string"
                },
                "host": {
                  "type": "string"
                },
                "port": {
                  "type": "integer"
                },
                "username": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "password_set": {
                  "type": "boolean"
                },
                "change_ip_url": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "change_ip_cooldown_s": {
                  "type": [
                    "null",
                    "integer"
                  ]
                },
                "provider": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "provider_params": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                },
                "ip_checker": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "remark": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "last_check": {
                  "anyOf": [
                    {
                      "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"
                        }
                      }
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "last_check_at": {
                  "type": [
                    "null",
                    "integer"
                  ]
                },
                "profile_count": {
                  "type": "integer"
                },
                "created_at": {
                  "type": "integer"
                },
                "updated_at": {
                  "type": "integer"
                },
                "row_version": {
                  "type": "integer"
                },
                "deleted_at": {
                  "type": [
                    "null",
                    "integer"
                  ]
                },
                "purge_after": {
                  "type": [
                    "null",
                    "integer"
                  ]
                }
              }
            }
          },
          "total": {
            "type": "integer"
          },
          "page": {
            "type": "integer"
          },
          "limit": {
            "type": "integer"
          }
        }
      }
    }
  }
}
default · HTTP-Fehlerhülle. Status und error.code bezeichnen den Fehler.
OpenAPI JSON
{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

Allgemeine Authentifizierungs- und Transportfehler können zusätzlich zu den dokumentierten Antworten auftreten.

OpenAPI-Definition#

Vollständige Operationsdefinition
OpenAPI JSON
{
  "summary": "Proxys auflisten (Passwörter maskiert)",
  "tags": [
    "Proxys"
  ],
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "query",
      "name": "group_id",
      "required": false
    },
    {
      "schema": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "unverified"
            ]
          },
          {
            "type": "string",
            "enum": [
              "passed"
            ]
          },
          {
            "type": "string",
            "enum": [
              "failed"
            ]
          }
        ]
      },
      "in": "query",
      "name": "check_status",
      "required": false
    },
    {
      "schema": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "dsn"
            ]
          },
          {
            "type": "string",
            "enum": [
              "name"
            ]
          },
          {
            "type": "string",
            "enum": [
              "created_at"
            ]
          },
          {
            "type": "string",
            "enum": [
              "last_check_at"
            ]
          },
          {
            "type": "string",
            "enum": [
              "profile_count"
            ]
          }
        ]
      },
      "in": "query",
      "name": "sort",
      "required": false
    },
    {
      "schema": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "asc"
            ]
          },
          {
            "type": "string",
            "enum": [
              "desc"
            ]
          }
        ]
      },
      "in": "query",
      "name": "order",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "maxLength": 200
      },
      "in": "query",
      "name": "search",
      "required": false
    },
    {
      "schema": {
        "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"
            ]
          }
        ]
      },
      "in": "query",
      "name": "protocol",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "maxLength": 50
      },
      "in": "query",
      "name": "tag",
      "required": false
    },
    {
      "schema": {
        "type": "boolean"
      },
      "in": "query",
      "name": "unused",
      "required": false
    },
    {
      "schema": {
        "type": "boolean"
      },
      "in": "query",
      "name": "trash",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 1
      },
      "in": "query",
      "name": "page",
      "required": false
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 1000
      },
      "in": "query",
      "name": "limit",
      "required": false
    }
  ],
  "x-required-scopes": [
    "proxies:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "items",
              "total",
              "page",
              "limit"
            ],
            "properties": {
              "items": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "group_id",
                    "ssh_key_set",
                    "id",
                    "compat_proxy_id",
                    "name",
                    "protocol",
                    "host",
                    "port",
                    "username",
                    "password_set",
                    "change_ip_url",
                    "change_ip_cooldown_s",
                    "provider",
                    "provider_params",
                    "ip_checker",
                    "remark",
                    "tags",
                    "last_check",
                    "last_check_at",
                    "profile_count",
                    "created_at",
                    "updated_at",
                    "row_version",
                    "deleted_at",
                    "purge_after"
                  ],
                  "properties": {
                    "group_id": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "ssh_key_set": {
                      "type": "boolean"
                    },
                    "id": {
                      "type": "string"
                    },
                    "compat_proxy_id": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "name": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "protocol": {
                      "type": "string"
                    },
                    "host": {
                      "type": "string"
                    },
                    "port": {
                      "type": "integer"
                    },
                    "username": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "password_set": {
                      "type": "boolean"
                    },
                    "change_ip_url": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "change_ip_cooldown_s": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "provider": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "provider_params": {
                      "type": "object",
                      "additionalProperties": {
                        "type": "string"
                      }
                    },
                    "ip_checker": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "remark": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "last_check": {
                      "anyOf": [
                        {
                          "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"
                            }
                          }
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "last_check_at": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "profile_count": {
                      "type": "integer"
                    },
                    "created_at": {
                      "type": "integer"
                    },
                    "updated_at": {
                      "type": "integer"
                    },
                    "row_version": {
                      "type": "integer"
                    },
                    "deleted_at": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "purge_after": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    }
                  }
                }
              },
              "total": {
                "type": "integer"
              },
              "page": {
                "type": "integer"
              },
              "limit": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

Suche nach Headless, MCP, Cookies oder einem API-Endpunkt.

↑ ↓ NavigierenEnter ÖffnenEsc Schließen