POST

/api/v1/geo/update

Download or update the IP geolocation database (DB-IP Lite, CC BY 4.0)

Request#

POSIX shell · curl

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

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: settings:write

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": [
          "source",
          "loaded",
          "database_type",
          "city",
          "asn",
          "attribution",
          "timezone_table"
        ],
        "properties": {
          "source": {
            "type": "string"
          },
          "loaded": {
            "type": "boolean"
          },
          "database_type": {
            "type": [
              "null",
              "string"
            ]
          },
          "city": {
            "type": "object",
            "required": [
              "file",
              "present",
              "size_bytes",
              "modified_at"
            ],
            "properties": {
              "file": {
                "type": "string"
              },
              "present": {
                "type": "boolean"
              },
              "size_bytes": {
                "type": [
                  "null",
                  "integer"
                ]
              },
              "modified_at": {
                "type": [
                  "null",
                  "integer"
                ]
              }
            }
          },
          "asn": {
            "type": "object",
            "required": [
              "file",
              "present",
              "size_bytes",
              "modified_at"
            ],
            "properties": {
              "file": {
                "type": "string"
              },
              "present": {
                "type": "boolean"
              },
              "size_bytes": {
                "type": [
                  "null",
                  "integer"
                ]
              },
              "modified_at": {
                "type": [
                  "null",
                  "integer"
                ]
              }
            }
          },
          "attribution": {
            "type": "string"
          },
          "timezone_table": {
            "type": "string"
          }
        }
      }
    }
  }
}

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": "IP-Geo-Datenbank (DB-IP Lite, CC BY 4.0) herunterladen oder aktualisieren",
  "tags": [
    "Proxys"
  ],
  "x-required-scopes": [
    "settings:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "source",
              "loaded",
              "database_type",
              "city",
              "asn",
              "attribution",
              "timezone_table"
            ],
            "properties": {
              "source": {
                "type": "string"
              },
              "loaded": {
                "type": "boolean"
              },
              "database_type": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "city": {
                "type": "object",
                "required": [
                  "file",
                  "present",
                  "size_bytes",
                  "modified_at"
                ],
                "properties": {
                  "file": {
                    "type": "string"
                  },
                  "present": {
                    "type": "boolean"
                  },
                  "size_bytes": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  },
                  "modified_at": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  }
                }
              },
              "asn": {
                "type": "object",
                "required": [
                  "file",
                  "present",
                  "size_bytes",
                  "modified_at"
                ],
                "properties": {
                  "file": {
                    "type": "string"
                  },
                  "present": {
                    "type": "boolean"
                  },
                  "size_bytes": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  },
                  "modified_at": {
                    "type": [
                      "null",
                      "integer"
                    ]
                  }
                }
              },
              "attribution": {
                "type": "string"
              },
              "timezone_table": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}