{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8b73e904-dc66-4851-82ca-ea140a2bfb2a","name":"GSLB.me 2.0","description":"<a href=\"https://www.gslb.me\">GSLB.me</a> comes with a fully-fledged REST API to manage your DNS services. Using the API you can add, modify, delete, enable and disable domains (<a href=\"https://www.gslb.me\">GSLB.me</a> refers to DNS domains as “zones“), records, geohosts and targets.\n<a href=\"https://www.gslb.me\">GSLB.me</a> can be fully orchestrated through its REST API.\n\n# Overview\nWhat is REST?\n\nREST (REpresentational State Transfer) is an HTTP-based protocol: using standard HTTP methods such as GET, POST, PUT and DELETE it allows for remote method/procedure calls. What REST allows you to do is to develop your own client-side code that interacts with GSLB.me to dynamically provision and orchestrate your DNS services.\n\n# Authentication\n\nAll API requests must be authenticated: credentials are your username (in the form of the e-mail address you used to register to <a href=\"https://www.gslb.me\">GSLB.me</a>) and your password. When you first create your account on GSLB.me the API password is set identical to the web GUI password. It is then possible to modify it through the web GUI itself.\n\nAuthentication is performed by adding to each API request a standard Basic HTTP Authorization header.\n\nThe Authorization header can be created as follows:\n\n* Username and password are combined into a string in the form “username:password”\n* The resulting string (without quotes) is then encoded using Base64\n* The HTTP “Authorization” header is added to the API request. It must be named “Authorization” and its value must be “Basic” followed by one space character, followed by the Base64-encoded string\n\n\nFor instance, if your username is “username@mysite.com” and your password is “mypassword”, we would have:\n\n* Username and password are combined into “username@mysite.com:mypassword”\n* The string “username@mysite.com:password” without quotes is encoded using Base64\n* The HTTP “Authorization” header is formed as follows:\n    \n    Authorization: Basic dXNlcm5hbWVAbXlzaXRlLmNvbTpteXBhc3N3b3JkCg==\n\n\nThis can be easily generated using the standard bash shell:\n\n    user ~ $ echo \"username@mysite.com:mypassword\" | base64\n    dXNlcm5hbWVAbXlzaXRlLmNvbTpteXBhc3N3b3JkCg==\n\n# Content types\n\nAn “Accept” HTTP header can be specified for GET requests. Such header tells the API to encode its output using json or XML. The “Accept” header can be set to any of:\n\n    Accept: application/json\n    Accept: application/xml\n\n\nIf the “Accept” header is omitted in the request, json encoding is used by default.\nAPI endpoint\n\nThe endpoint URL for the API is:\n\n    https://api.gslb.me\n\n\nHTTPS is mandatory, HTTP is not supported due to security reasons.\n\n# API response encoding\n\nThe encoding format of API responses can be selected between JSON and XML by adding the “Accept” HTTP header in the request.\n\nTo select JSON encoding:\n\n    Accept: application/json\n\n\nTo select XML encoding:\n\n    Accept: application/xml\n\n\nIf no “Accept” header is specified, the API defaults to JSON encoding.\n\n# Error Codes\nEvery API response includes an HTTP status code. The status code provides information on whether and how the request was successfully processed. In case of errors the status code details what went wrong.\n\nThe API can return the following HTTP status codes:\n\n    200 - OK (API call successfully completed)\n    400 - Bad Request (Incorrect request format / Wrong parameters)\n    401 - Unauthorized (Each API request must be authenticated via HTTP Basic Auth)\n    403 - Forbidden (The request is not allowed)\n    404 - Not found (The requested method does not exist / The requested object does not exist)\n    406 - Not Acceptable (The \"Accept\" request header was set to an invalid value)\n    411 - Length Required (A \"PUT\" or \"POST\" method was called without specifying the header \"Content-Length: 0\")\n    500 - Server Error (An internal error occurred, contact support)\n    503 - Service Unavailable (Currently unable to service your request / Rate limiting your request, try again in a short while)\n\n\nEvery API response includes an HTTP status code. The status code provides information on whether and how the request was successfully processed. In case of errors the status code details what went wrong.\n\nIn addition to the HTTP status code, every API response includes a payload that provides more details on the outcome of the request.\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1667416","team":291867,"collectionId":"8b73e904-dc66-4851-82ca-ea140a2bfb2a","publishedId":"RW1aJfNb","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1667416/RW1aJfNb","privateUrl":"https://go.postman.co/documentation/1667416-8b73e904-dc66-4851-82ca-ea140a2bfb2a","customColor":{"top-bar":"eeeeee","right-sidebar":"FFFFFF","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-04-26T22:22:40.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f12e6898578fc40ef2a2a75a823a334fcf92d1a795aa665f0f42dee8f19bed48","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/RW1aJfNb"}