GET

/api/v1/proxy-groups

List proxy groups including Default

Request#

POSIX shell · curl

curl --fail-with-body --request GET \
  "$ADBR_API_URL/api/v1/proxy-groups" \
  -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#

No path or query parameters declared.

Request body#

No request body declared.

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "items"
        ],
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "name",
                "proxy_count",
                "created_at",
                "updated_at",
                "is_default"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "proxy_count": {
                  "type": "integer"
                },
                "created_at": {
                  "type": [
                    "null",
                    "integer"
                  ]
                },
                "updated_at": {
                  "type": [
                    "null",
                    "integer"
                  ]
                },
                "is_default": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      }
    }
  }
}

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": "Proxygruppen einschließlich Default auflisten",
  "tags": [
    "Proxys"
  ],
  "x-required-scopes": [
    "proxies:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "items"
            ],
            "properties": {
              "items": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "proxy_count",
                    "created_at",
                    "updated_at",
                    "is_default"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "proxy_count": {
                      "type": "integer"
                    },
                    "created_at": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "updated_at": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "is_default": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}