REST API Documentation

GSLB.me comes with a fully-fledged REST API to manage your DNS services. Using the API you can add, modify, delete, enable and disable domains (zones), records, geohosts and targets. GSLB.me can be fully orchestrated through its REST API.

API v2.0 reference
Download Postman collection
$ curl -u username@mydomain.com:password https://api.gslb.me/2.0/zone/mydomain.com
{
  "zone": {
    "name": "mydomain.com",
    "active": "true",
    "needscommit": "false",
    "ttl": "1800"
  },
  "rrsets": { "rrset": [ … ] }
}

Getting started

Authentication

All API requests must be authenticated with HTTP Basic Authentication: your username is the e-mail address you registered with, and the API password can be changed through the web GUI.

Content types

Add an “Accept” header set to application/json or application/xml. If the header is omitted, responses are JSON-encoded.

API endpoint

The endpoint for v2.0 requests is https://api.gslb.me/2.0. HTTPS is mandatory, HTTP is not supported.

API v2.0 reference

Click a gear to jump straight to the call.

ResourceReadCreateModifyDeleteCommit
ZoneReadCreateModifyDeleteCommit
RecordsReadCreateModifyDelete
GeohostReadCreateModifyDeleteCommit
TargetsReadCreateModifyDelete
ChecksRead
AlertsRead
CountriesRead
Balancing algorithmsRead
StatisticsRead
ReportingRead

Postman collection – 26 documented calls and a 35-step end-to-end test suite. Details · Download

Workflows

Publish a zone with records

Create the zone, add records, commit the zone. Record changes become active only after the commit.

Create a geohost with targets

Look up checks and balancing algorithms, create the geohost, add its targets and commit.

Test everything

Run the end-to-end suite in Postman or Newman: it creates a temporary zone, checks every call and cleans up.

Clients and tools

Metrics

User-defined metrics can be pushed to GSLB.me on a per-target basis and evaluated to determine whether the target is available.