GlobalR API

Create

domainPost

Create domain | Domain name registration

Domain name must be registered thru provided information from reseller. .AM domain registration requres manual approvement on the side or registry. So, when registration comes, it is automatically being reserved by registry. In 0-3 days domain name must be approved. .GE registration is offline. It takes 0-10 days to register and approve domain name on the side of registry.


/domain

Usage and SDK Samples


curl -X post "https://globalr.com/api/domain"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .CreateApi;

import java.io.File;
import java.util.*;

public class CreateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: internalApiKey
        ApiKeyAuth internalApiKey = (ApiKeyAuth) defaultClient.getAuthentication("internalApiKey");
        internalApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //internalApiKey.setApiKeyPrefix("Token");

        CreateApi apiInstance = new CreateApi();
        Register_body body = ; // Register_body | Request body for domain registration
        try {
            api_response result = apiInstance.domainPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateApi#domainPost");
            e.printStackTrace();
        }
    }
}

                                                  

import .CreateApi;

public class CreateApiExample {

    public static void main(String[] args) {
        CreateApi apiInstance = new CreateApi();
        Register_body body = ; // Register_body | Request body for domain registration
        try {
            api_response result = apiInstance.domainPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreateApi#domainPost");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_token"];


Register_body *body = ; // Request body for domain registration

CreateApi *apiInstance = [[CreateApi alloc] init];

// Create domain | Domain name registration
[apiInstance domainPostWith:body
              completionHandler: ^(api_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['api_token'] = "Token"

var api = new .CreateApi()

var body = ; // {Register_body} Request body for domain registration


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.domainPost(body, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class domainPostExample
    {
        public void main()
        {

            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("api_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_token", "Bearer");

            var apiInstance = new CreateApi();
            var body = new Register_body(); // Register_body | Request body for domain registration

            try
            {
                // Create domain | Domain name registration
                api_response result = apiInstance.domainPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CreateApi.domainPost: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_token', 'Bearer');

$api_instance = new io.swagger.client\Api\CreateApi();
$body = ; // Register_body | Request body for domain registration

try {
    $result = $api_instance->domainPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreateApi->domainPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters
Name Description
body *
{
name:
string

Domain name

mode:
string (test)

If value = test, registration pass thru a test mode. If not in real mode

period:
integer (1-5)
contacts:
{
owner:
{
name:
string

Contact name (Mandatory)

surname:
string

Contact surname (Mandatory)

organisation:
email:
phone:
mobile_phone:
fax:
country:
city:
state:
address:
address2:
zip:
admin:
billing:
technical:
ns:
[

Minimum 2 maximum 6 NS accpeted. You can also bind IP, but this parameter is not requred.

]

Responses

Status: 201 - completed

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Status: 402 - Payment Required

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Status: 422 - invalid data

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Status: 500 - Internal Error

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Information

domainNameGet

Get domain information

Below is given the procedure how to get detailed information from database of GlobalR & Registry for the extension.


/domain/{name}

Usage and SDK Samples


curl -X get "https://globalr.com/api/domain/{name}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .InformationApi;

import java.io.File;
import java.util.*;

public class InformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: internalApiKey
        ApiKeyAuth internalApiKey = (ApiKeyAuth) defaultClient.getAuthentication("internalApiKey");
        internalApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //internalApiKey.setApiKeyPrefix("Token");

        InformationApi apiInstance = new InformationApi();
        String name = name_example; // String | Domain name
        try {
            domain_info result = apiInstance.domainNameGet(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InformationApi#domainNameGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .InformationApi;

public class InformationApiExample {

    public static void main(String[] args) {
        InformationApi apiInstance = new InformationApi();
        String name = name_example; // String | Domain name
        try {
            domain_info result = apiInstance.domainNameGet(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InformationApi#domainNameGet");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_token"];


String *name = name_example; // Domain name

InformationApi *apiInstance = [[InformationApi alloc] init];

// Get domain information
[apiInstance domainNameGetWith:name
              completionHandler: ^(domain_info output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['api_token'] = "Token"

var api = new .InformationApi()

var name = name_example; // {String} Domain name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.domainNameGet(name, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class domainNameGetExample
    {
        public void main()
        {

            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("api_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_token", "Bearer");

            var apiInstance = new InformationApi();
            var name = name_example;  // String | Domain name

            try
            {
                // Get domain information
                domain_info result = apiInstance.domainNameGet(name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InformationApi.domainNameGet: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_token', 'Bearer');

$api_instance = new io.swagger.client\Api\InformationApi();
$name = name_example; // String | Domain name

try {
    $result = $api_instance->domainNameGet($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformationApi->domainNameGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
name*

Responses

Status: 200 - Domain information object

{
domains:
string

Requested domain name

available:
boolean

If domain is available return value true, if not false.

message:
string

Text message for request.

whois:
string

WHOIS information from registry

info:
{

This information will be displayed in case domain has been registered thru GlobalR

name:
string

Requested domain name

created_at:
string (date)
expiration_date:
string (date)
status_id:
integer (int32)
exp_days:
integer (int16)

the total days remains till domain will be expired

contacts:
{
owner:
admin:
billing:
technical:
ns:
[

Minimum 2 maximum 6 NS accpeted. You can also bind IP, but this parameter is not requred.

]
prices:
[

Price list for domain - table of years and total prices

{
price:
year:
]

Status: 406 - Unsupported extension

{
domains:
string

Requested domain name

available:
boolean

If domain is available return value true, if not false.

message:
string

Text message for request.

whois:
string

WHOIS information from registry

info:
{

This information will be displayed in case domain has been registered thru GlobalR

name:
string

Requested domain name

created_at:
string (date)
expiration_date:
string (date)
status_id:
integer (int32)
exp_days:
integer (int16)

the total days remains till domain will be expired

contacts:
{
owner:
admin:
billing:
technical:
ns:
[

Minimum 2 maximum 6 NS accpeted. You can also bind IP, but this parameter is not requred.

]
prices:
[

Price list for domain - table of years and total prices

{
price:
year:
]

Renew

domainRenewPost

Renew domain

Renew domain, Important/:test mode is not supported. Only realtime.


/domain/renew

Usage and SDK Samples


curl -X post "https://globalr.com/api/domain/renew?name=&period="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RenewApi;

import java.io.File;
import java.util.*;

public class RenewApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: internalApiKey
        ApiKeyAuth internalApiKey = (ApiKeyAuth) defaultClient.getAuthentication("internalApiKey");
        internalApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //internalApiKey.setApiKeyPrefix("Token");

        RenewApi apiInstance = new RenewApi();
        String name = name_example; // String | Domain name
        Integer period = 56; // Integer | Domain renewal period
        try {
            api_response result = apiInstance.domainRenewPost(name, period);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RenewApi#domainRenewPost");
            e.printStackTrace();
        }
    }
}

                                                  

import .RenewApi;

public class RenewApiExample {

    public static void main(String[] args) {
        RenewApi apiInstance = new RenewApi();
        String name = name_example; // String | Domain name
        Integer period = 56; // Integer | Domain renewal period
        try {
            api_response result = apiInstance.domainRenewPost(name, period);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RenewApi#domainRenewPost");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_token"];


String *name = name_example; // Domain name
Integer *period = 56; // Domain renewal period

RenewApi *apiInstance = [[RenewApi alloc] init];

// Renew domain
[apiInstance domainRenewPostWith:name
    period:period
              completionHandler: ^(api_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['api_token'] = "Token"

var api = new .RenewApi()

var name = name_example; // {String} Domain name

var period = 56; // {Integer} Domain renewal period


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.domainRenewPost(name, period, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class domainRenewPostExample
    {
        public void main()
        {

            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("api_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_token", "Bearer");

            var apiInstance = new RenewApi();
            var name = name_example;  // String | Domain name
            var period = 56;  // Integer | Domain renewal period

            try
            {
                // Renew domain
                api_response result = apiInstance.domainRenewPost(name, period);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RenewApi.domainRenewPost: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_token', 'Bearer');

$api_instance = new io.swagger.client\Api\RenewApi();
$name = name_example; // String | Domain name
$period = 56; // Integer | Domain renewal period

try {
    $result = $api_instance->domainRenewPost($name, $period);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenewApi->domainRenewPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Query parameters
Name Description
name*
period*

Responses

Status: 200 - success

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Status: 201 - completed

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Status: 402 - Payment Required

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Status: 422 - invalid data

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Status: 500 - Internal Error

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Update

domainPut

Domain name information update request

This request means cotact & NS information update. There are four block of contact information - Owner, Administrative, Technical and Billing. Each block could be updated seperately. While update of any information in some block, whole information of the block must be sent. In the block of owner you can't change Name and Last Name or Company Name (in case of organization) information. This part requres printed documents.


/domain

Usage and SDK Samples


curl -X put "https://globalr.com/api/domain"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .UpdateApi;

import java.io.File;
import java.util.*;

public class UpdateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: internalApiKey
        ApiKeyAuth internalApiKey = (ApiKeyAuth) defaultClient.getAuthentication("internalApiKey");
        internalApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //internalApiKey.setApiKeyPrefix("Token");

        UpdateApi apiInstance = new UpdateApi();
        Update_body body = ; // Update_body | Request body for domain update
        try {
            api_response result = apiInstance.domainPut(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UpdateApi#domainPut");
            e.printStackTrace();
        }
    }
}

                                                  

import .UpdateApi;

public class UpdateApiExample {

    public static void main(String[] args) {
        UpdateApi apiInstance = new UpdateApi();
        Update_body body = ; // Update_body | Request body for domain update
        try {
            api_response result = apiInstance.domainPut(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UpdateApi#domainPut");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_token"];


Update_body *body = ; // Request body for domain update

UpdateApi *apiInstance = [[UpdateApi alloc] init];

// Domain name information update request
[apiInstance domainPutWith:body
              completionHandler: ^(api_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['api_token'] = "Token"

var api = new .UpdateApi()

var body = ; // {Update_body} Request body for domain update


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.domainPut(body, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class domainPutExample
    {
        public void main()
        {

            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("api_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_token", "Bearer");

            var apiInstance = new UpdateApi();
            var body = new Update_body(); // Update_body | Request body for domain update

            try
            {
                // Domain name information update request
                api_response result = apiInstance.domainPut(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UpdateApi.domainPut: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_token', 'Bearer');

$api_instance = new io.swagger.client\Api\UpdateApi();
$body = ; // Update_body | Request body for domain update

try {
    $result = $api_instance->domainPut($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UpdateApi->domainPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters
Name Description
body *
{
name:
string

Domain name

mode:
string (test)

If value = test, update pass thru a test mode. If not in real mode

contacts:
{
owner:
admin:
billing:
technical:
ns:
[

Minimum 2 maximum 6 NS accpeted. You can also bind IP, but this parameter is not requred.

]

Responses

Status: 200 - success

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Status: 201 - completed

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Status: 402 - Payment Required

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Status: 422 - invalid data

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]

Status: 500 - Internal Error

{
status:
integer
textStatus:
string
message:
string
errors:
[
{
field:
message:
]
Generated 2016-11-23T11:26:36.456Z