GET

/api/v1/proxy-groups

Proxygruppen einschließlich Default auflisten

Anfrage#

POSIX-Shell · curl

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

Keine Pfad- oder Query-Parameter deklariert.

Anfragekörper#

Kein Anfragekörper deklariert.

Antworten#

200 · Standardantwort

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-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": "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"
          }
        }
      }
    }
  }
}