Get Geolocation Status
Endpoint
GET /apiops/settings/geolocation/
Authentication
Requires a Personal API Access Token belonging to a user with the ADMIN role.
Header
Authorization: Bearer YOUR_TOKEN
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer {token} | Yes |
This endpoint takes no path, query or body parameters. Geolocation is a system-wide setting, not a project-scoped one.
Response
Success Response (200 OK)
{
"status": "SUCCESS",
"resultList": [
{
"enabled": true,
"name": "GeoLite2-City",
"fileName": "GeoLite2-City.mmdb",
"uploadDate": "2026-08-01T09:14:22.301Z",
"mmdbFileUploaded": true
}
],
"resultCount": 1
}
When Geolocation has never been configured, the setting is returned with its defaults and
mmdbFileUploaded: false.
Response Fields
| Field | Type | Description |
|---|---|---|
| enabled | boolean | Whether Geolocation is enabled |
| name | string | Geolocation setting name |
| fileName | string | Name of the MMDB file recorded on the setting |
| uploadDate | date | When the MMDB file was uploaded |
| mmdbFileUploaded | boolean | Whether the MMDB file data actually exists in the database |
Error Response (400 Bad Request)
{
"status": "FAILURE",
"resultMessage": "Unauthorized! Only users with ADMIN role can access this resource!"
}
cURL Example
curl -X GET \
"https://demo.apinizer.com/apiops/settings/geolocation/" \
-H "Authorization: Bearer YOUR_TOKEN"
Notes and Warnings
- The MMDB file is never downloaded: MMDB databases are typically tens of megabytes. This endpoint returns status metadata only; there is no APIops endpoint that streams the file back
fileNamevsmmdbFileUploaded:fileNameanduploadDateare stored on the setting document, while the file itself is stored separately in chunks. UsemmdbFileUploadedto check whether the data is really present - a setting can carry a file name while the data is absent- Read-only: This endpoint does not modify anything and does not trigger a deployment
Permissions
- User must have the ADMIN role (system administrators also qualify)
Related Documentation
- Upload MMDB File - Upload the MMDB database file
- Enable Geolocation - Enable Geolocation
- Disable Geolocation - Disable Geolocation