POST

/api/v1/proxies/{id}/change-ip

Change-IP-URL aufrufen; verify=true misst die Ausgangs-IP davor und danach. changed bestätigt den URL-Aufruf, ip_changed den gemessenen Wechsel (null: nicht bestätigt)

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/proxies/{id}/change-ip" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

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

Authentifizierung und Rechte#

Authentifizierung: Bearer-Token

Scopes: proxies:write

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

Parameter#

Parameter	Ort	Pflicht	Beschreibung
`verify`	query	Nein
`id`	path	Ja

Vollständige Parameterschemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "boolean"
    },
    "in": "query",
    "name": "verify",
    "required": false
  },
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Anfragekörper#

Kein Anfragekörper deklariert.

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "changed",
          "ip_changed",
          "before_ip",
          "after_ip",
          "http_status",
          "attempts",
          "next_allowed_at"
        ],
        "properties": {
          "changed": {
            "type": "boolean"
          },
          "ip_changed": {
            "type": [
              "null",
              "boolean"
            ]
          },
          "before_ip": {
            "type": [
              "null",
              "string"
            ]
          },
          "after_ip": {
            "type": [
              "null",
              "string"
            ]
          },
          "http_status": {
            "type": "integer"
          },
          "attempts": {
            "type": "integer"
          },
          "next_allowed_at": {
            "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": "Change-IP-URL aufrufen; verify=true misst die Ausgangs-IP davor und danach. changed bestätigt den URL-Aufruf, ip_changed den gemessenen Wechsel (null: nicht bestätigt)",
  "tags": [
    "Proxys"
  ],
  "parameters": [
    {
      "schema": {
        "type": "boolean"
      },
      "in": "query",
      "name": "verify",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "proxies:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "changed",
              "ip_changed",
              "before_ip",
              "after_ip",
              "http_status",
              "attempts",
              "next_allowed_at"
            ],
            "properties": {
              "changed": {
                "type": "boolean"
              },
              "ip_changed": {
                "type": [
                  "null",
                  "boolean"
                ]
              },
              "before_ip": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "after_ip": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "http_status": {
                "type": "integer"
              },
              "attempts": {
                "type": "integer"
              },
              "next_allowed_at": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}