TabGeckoGET
/api/v1/proxies/{id}
Retrieve a proxy
Request#
POSIX shell · curl
curl --fail-with-body --request GET \
"$ADBR_API_URL/api/v1/proxies/{id}" \
-H "Authorization: Bearer $ADBR_API_TOKEN"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:read
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 |
|---|---|---|---|
id | path | Yes |
Complete parameter schemas
OpenAPI JSON
[
{
"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": [
"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"
]
}
}
}
}
}
}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 abrufen",
"tags": [
"Proxys"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"proxies:read"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"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"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}