Domain forward API definition

Analytics

getAnalyticsKpis

Get analytics KPIs


/analytics/kpis

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//analytics/kpis?startDate=&endDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

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

public class AnalyticsApiExample {

    public static void main(String[] args) {
        
        AnalyticsApi apiInstance = new AnalyticsApi();
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The id of the redirect to retrieve
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The id of the redirect to retrieve
        try {
            Hostnames result = apiInstance.getAnalyticsKpis(startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsKpis");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The id of the redirect to retrieve
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The id of the redirect to retrieve
        try {
            Hostnames result = apiInstance.getAnalyticsKpis(startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsKpis");
            e.printStackTrace();
        }
    }
}
Date *startDate = 2013-10-20T19:20:30+01:00; // The id of the redirect to retrieve
Date *endDate = 2013-10-20T19:20:30+01:00; // The id of the redirect to retrieve

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

// Get analytics KPIs
[apiInstance getAnalyticsKpisWith:startDate
    endDate:endDate
              completionHandler: ^(Hostnames output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DomainForwardApiDefinition = require('domain_forward_api_definition');

var api = new DomainForwardApiDefinition.AnalyticsApi()
var startDate = 2013-10-20T19:20:30+01:00; // {{Date}} The id of the redirect to retrieve
var endDate = 2013-10-20T19:20:30+01:00; // {{Date}} The id of the redirect to retrieve

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsKpis(startDate, endDate, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AnalyticsApi();
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | The id of the redirect to retrieve
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | The id of the redirect to retrieve

            try
            {
                // Get analytics KPIs
                Hostnames result = apiInstance.getAnalyticsKpis(startDate, endDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsKpis: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAnalyticsApi();
$startDate = 2013-10-20T19:20:30+01:00; // Date | The id of the redirect to retrieve
$endDate = 2013-10-20T19:20:30+01:00; // Date | The id of the redirect to retrieve

try {
    $result = $api_instance->getAnalyticsKpis($startDate, $endDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsKpis: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $startDate = 2013-10-20T19:20:30+01:00; # Date | The id of the redirect to retrieve
my $endDate = 2013-10-20T19:20:30+01:00; # Date | The id of the redirect to retrieve

eval { 
    my $result = $api_instance->getAnalyticsKpis(startDate => $startDate, endDate => $endDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsKpis: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
startDate = 2013-10-20T19:20:30+01:00 # Date | The id of the redirect to retrieve
endDate = 2013-10-20T19:20:30+01:00 # Date | The id of the redirect to retrieve

try: 
    # Get analytics KPIs
    api_response = api_instance.get_analytics_kpis(startDate, endDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsKpis: %s\n" % e)

Parameters

Query parameters
Name Description
startDate*
Date (date-time)
The id of the redirect to retrieve
Required
endDate*
Date (date-time)
The id of the redirect to retrieve
Required

Responses

Status: 200 - Analytics KPIs

Status: default - unexpected error


Hostnames

getHostnameById

Get a single hostname


/hostnames/{hostnameId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//hostnames/{hostnameId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostnamesApi;

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

public class HostnamesApiExample {

    public static void main(String[] args) {
        
        HostnamesApi apiInstance = new HostnamesApi();
        UUID hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the hostname
        try {
            HostnameDetail result = apiInstance.getHostnameById(hostnameId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostnamesApi#getHostnameById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostnamesApi;

public class HostnamesApiExample {

    public static void main(String[] args) {
        HostnamesApi apiInstance = new HostnamesApi();
        UUID hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the hostname
        try {
            HostnameDetail result = apiInstance.getHostnameById(hostnameId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostnamesApi#getHostnameById");
            e.printStackTrace();
        }
    }
}
UUID *hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the hostname

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

// Get a single hostname
[apiInstance getHostnameByIdWith:hostnameId
              completionHandler: ^(HostnameDetail output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DomainForwardApiDefinition = require('domain_forward_api_definition');

var api = new DomainForwardApiDefinition.HostnamesApi()
var hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} The id of the hostname

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHostnameById(hostnameId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new HostnamesApi();
            var hostnameId = new UUID(); // UUID | The id of the hostname

            try
            {
                // Get a single hostname
                HostnameDetail result = apiInstance.getHostnameById(hostnameId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostnamesApi.getHostnameById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHostnamesApi();
$hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the hostname

try {
    $result = $api_instance->getHostnameById($hostnameId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostnamesApi->getHostnameById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HostnamesApi;

my $api_instance = WWW::SwaggerClient::HostnamesApi->new();
my $hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the hostname

eval { 
    my $result = $api_instance->getHostnameById(hostnameId => $hostnameId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HostnamesApi->getHostnameById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HostnamesApi()
hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the hostname

try: 
    # Get a single hostname
    api_response = api_instance.get_hostname_by_id(hostnameId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostnamesApi->getHostnameById: %s\n" % e)

Parameters

Path parameters
Name Description
hostnameId*
UUID (uuid)
The id of the hostname
Required

Responses

Status: 200 - Expected response to a valid request

Status: default - unexpected error


listHostnames

List all hostnames


/hostnames

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//hostnames"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostnamesApi;

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

public class HostnamesApiExample {

    public static void main(String[] args) {
        
        HostnamesApi apiInstance = new HostnamesApi();
        try {
            Hostnames result = apiInstance.listHostnames();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostnamesApi#listHostnames");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostnamesApi;

public class HostnamesApiExample {

    public static void main(String[] args) {
        HostnamesApi apiInstance = new HostnamesApi();
        try {
            Hostnames result = apiInstance.listHostnames();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostnamesApi#listHostnames");
            e.printStackTrace();
        }
    }
}

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

// List all hostnames
[apiInstance listHostnamesWithCompletionHandler: 
              ^(Hostnames output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DomainForwardApiDefinition = require('domain_forward_api_definition');

var api = new DomainForwardApiDefinition.HostnamesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listHostnames(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new HostnamesApi();

            try
            {
                // List all hostnames
                Hostnames result = apiInstance.listHostnames();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostnamesApi.listHostnames: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHostnamesApi();

try {
    $result = $api_instance->listHostnames();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostnamesApi->listHostnames: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HostnamesApi;

my $api_instance = WWW::SwaggerClient::HostnamesApi->new();

eval { 
    my $result = $api_instance->listHostnames();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HostnamesApi->listHostnames: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HostnamesApi()

try: 
    # List all hostnames
    api_response = api_instance.list_hostnames()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostnamesApi->listHostnames: %s\n" % e)

Parameters

Responses

Status: 200 - An array of hostnames

Status: default - unexpected error


recheckHostnameDns

Recheck hostname dns


/hostnames/{hostnameId}/check

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//hostnames/{hostnameId}/check"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostnamesApi;

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

public class HostnamesApiExample {

    public static void main(String[] args) {
        
        HostnamesApi apiInstance = new HostnamesApi();
        UUID hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the hostname to recheck dns settings for
        try {
            apiInstance.recheckHostnameDns(hostnameId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostnamesApi#recheckHostnameDns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostnamesApi;

public class HostnamesApiExample {

    public static void main(String[] args) {
        HostnamesApi apiInstance = new HostnamesApi();
        UUID hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the hostname to recheck dns settings for
        try {
            apiInstance.recheckHostnameDns(hostnameId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostnamesApi#recheckHostnameDns");
            e.printStackTrace();
        }
    }
}
UUID *hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the hostname to recheck dns settings for

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

// Recheck hostname dns
[apiInstance recheckHostnameDnsWith:hostnameId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DomainForwardApiDefinition = require('domain_forward_api_definition');

var api = new DomainForwardApiDefinition.HostnamesApi()
var hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} The id of the hostname to recheck dns settings for

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.recheckHostnameDns(hostnameId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new HostnamesApi();
            var hostnameId = new UUID(); // UUID | The id of the hostname to recheck dns settings for

            try
            {
                // Recheck hostname dns
                apiInstance.recheckHostnameDns(hostnameId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostnamesApi.recheckHostnameDns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHostnamesApi();
$hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the hostname to recheck dns settings for

try {
    $api_instance->recheckHostnameDns($hostnameId);
} catch (Exception $e) {
    echo 'Exception when calling HostnamesApi->recheckHostnameDns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HostnamesApi;

my $api_instance = WWW::SwaggerClient::HostnamesApi->new();
my $hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the hostname to recheck dns settings for

eval { 
    $api_instance->recheckHostnameDns(hostnameId => $hostnameId);
};
if ($@) {
    warn "Exception when calling HostnamesApi->recheckHostnameDns: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HostnamesApi()
hostnameId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the hostname to recheck dns settings for

try: 
    # Recheck hostname dns
    api_instance.recheck_hostname_dns(hostnameId)
except ApiException as e:
    print("Exception when calling HostnamesApi->recheckHostnameDns: %s\n" % e)

Parameters

Path parameters
Name Description
hostnameId*
UUID (uuid)
The id of the hostname to recheck dns settings for
Required

Responses

Status: 200 - Null response

Status: default - unexpected error


Redirects

createRedirect

Create a redirect


/redirects

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//redirects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RedirectsApi;

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

public class RedirectsApiExample {

    public static void main(String[] args) {
        
        RedirectsApi apiInstance = new RedirectsApi();
        RedirectCreate body = ; // RedirectCreate | Body to create the redirect
        try {
            apiInstance.createRedirect(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectsApi#createRedirect");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RedirectsApi;

public class RedirectsApiExample {

    public static void main(String[] args) {
        RedirectsApi apiInstance = new RedirectsApi();
        RedirectCreate body = ; // RedirectCreate | Body to create the redirect
        try {
            apiInstance.createRedirect(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectsApi#createRedirect");
            e.printStackTrace();
        }
    }
}
RedirectCreate *body = ; // Body to create the redirect

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

// Create a redirect
[apiInstance createRedirectWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DomainForwardApiDefinition = require('domain_forward_api_definition');

var api = new DomainForwardApiDefinition.RedirectsApi()
var body = ; // {{RedirectCreate}} Body to create the redirect

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createRedirect(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new RedirectsApi();
            var body = new RedirectCreate(); // RedirectCreate | Body to create the redirect

            try
            {
                // Create a redirect
                apiInstance.createRedirect(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RedirectsApi.createRedirect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiRedirectsApi();
$body = ; // RedirectCreate | Body to create the redirect

try {
    $api_instance->createRedirect($body);
} catch (Exception $e) {
    echo 'Exception when calling RedirectsApi->createRedirect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RedirectsApi;

my $api_instance = WWW::SwaggerClient::RedirectsApi->new();
my $body = WWW::SwaggerClient::Object::RedirectCreate->new(); # RedirectCreate | Body to create the redirect

eval { 
    $api_instance->createRedirect(body => $body);
};
if ($@) {
    warn "Exception when calling RedirectsApi->createRedirect: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RedirectsApi()
body =  # RedirectCreate | Body to create the redirect

try: 
    # Create a redirect
    api_instance.create_redirect(body)
except ApiException as e:
    print("Exception when calling RedirectsApi->createRedirect: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Null response

Status: default - unexpected error


deleteRedirectsById

Delete multiple redirects


/redirects

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//redirects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RedirectsApi;

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

public class RedirectsApiExample {

    public static void main(String[] args) {
        
        RedirectsApi apiInstance = new RedirectsApi();
        RedirectDelete body = ; // RedirectDelete | Body to delete the redirects
        try {
            apiInstance.deleteRedirectsById(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectsApi#deleteRedirectsById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RedirectsApi;

public class RedirectsApiExample {

    public static void main(String[] args) {
        RedirectsApi apiInstance = new RedirectsApi();
        RedirectDelete body = ; // RedirectDelete | Body to delete the redirects
        try {
            apiInstance.deleteRedirectsById(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectsApi#deleteRedirectsById");
            e.printStackTrace();
        }
    }
}
RedirectDelete *body = ; // Body to delete the redirects

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

// Delete multiple redirects
[apiInstance deleteRedirectsByIdWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DomainForwardApiDefinition = require('domain_forward_api_definition');

var api = new DomainForwardApiDefinition.RedirectsApi()
var body = ; // {{RedirectDelete}} Body to delete the redirects

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteRedirectsById(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new RedirectsApi();
            var body = new RedirectDelete(); // RedirectDelete | Body to delete the redirects

            try
            {
                // Delete multiple redirects
                apiInstance.deleteRedirectsById(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RedirectsApi.deleteRedirectsById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiRedirectsApi();
$body = ; // RedirectDelete | Body to delete the redirects

try {
    $api_instance->deleteRedirectsById($body);
} catch (Exception $e) {
    echo 'Exception when calling RedirectsApi->deleteRedirectsById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RedirectsApi;

my $api_instance = WWW::SwaggerClient::RedirectsApi->new();
my $body = WWW::SwaggerClient::Object::RedirectDelete->new(); # RedirectDelete | Body to delete the redirects

eval { 
    $api_instance->deleteRedirectsById(body => $body);
};
if ($@) {
    warn "Exception when calling RedirectsApi->deleteRedirectsById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RedirectsApi()
body =  # RedirectDelete | Body to delete the redirects

try: 
    # Delete multiple redirects
    api_instance.delete_redirects_by_id(body)
except ApiException as e:
    print("Exception when calling RedirectsApi->deleteRedirectsById: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: default - unexpected error


getRedirectById

Get a single redirect


/redirects/{redirectId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//redirects/{redirectId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RedirectsApi;

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

public class RedirectsApiExample {

    public static void main(String[] args) {
        
        RedirectsApi apiInstance = new RedirectsApi();
        UUID redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the redirect to retrieve
        try {
            Redirect result = apiInstance.getRedirectById(redirectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectsApi#getRedirectById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RedirectsApi;

public class RedirectsApiExample {

    public static void main(String[] args) {
        RedirectsApi apiInstance = new RedirectsApi();
        UUID redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the redirect to retrieve
        try {
            Redirect result = apiInstance.getRedirectById(redirectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectsApi#getRedirectById");
            e.printStackTrace();
        }
    }
}
UUID *redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the redirect to retrieve

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

// Get a single redirect
[apiInstance getRedirectByIdWith:redirectId
              completionHandler: ^(Redirect output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DomainForwardApiDefinition = require('domain_forward_api_definition');

var api = new DomainForwardApiDefinition.RedirectsApi()
var redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} The id of the redirect to retrieve

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRedirectById(redirectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new RedirectsApi();
            var redirectId = new UUID(); // UUID | The id of the redirect to retrieve

            try
            {
                // Get a single redirect
                Redirect result = apiInstance.getRedirectById(redirectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RedirectsApi.getRedirectById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiRedirectsApi();
$redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the redirect to retrieve

try {
    $result = $api_instance->getRedirectById($redirectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedirectsApi->getRedirectById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RedirectsApi;

my $api_instance = WWW::SwaggerClient::RedirectsApi->new();
my $redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the redirect to retrieve

eval { 
    my $result = $api_instance->getRedirectById(redirectId => $redirectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RedirectsApi->getRedirectById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RedirectsApi()
redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the redirect to retrieve

try: 
    # Get a single redirect
    api_response = api_instance.get_redirect_by_id(redirectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RedirectsApi->getRedirectById: %s\n" % e)

Parameters

Path parameters
Name Description
redirectId*
UUID (uuid)
The id of the redirect to retrieve
Required

Responses

Status: 200 - Expected response to a valid request

Status: default - unexpected error


listRedirects

List all redirects


/redirects

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//redirects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RedirectsApi;

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

public class RedirectsApiExample {

    public static void main(String[] args) {
        
        RedirectsApi apiInstance = new RedirectsApi();
        try {
            Redirects result = apiInstance.listRedirects();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectsApi#listRedirects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RedirectsApi;

public class RedirectsApiExample {

    public static void main(String[] args) {
        RedirectsApi apiInstance = new RedirectsApi();
        try {
            Redirects result = apiInstance.listRedirects();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectsApi#listRedirects");
            e.printStackTrace();
        }
    }
}

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

// List all redirects
[apiInstance listRedirectsWithCompletionHandler: 
              ^(Redirects output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DomainForwardApiDefinition = require('domain_forward_api_definition');

var api = new DomainForwardApiDefinition.RedirectsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRedirects(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new RedirectsApi();

            try
            {
                // List all redirects
                Redirects result = apiInstance.listRedirects();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RedirectsApi.listRedirects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiRedirectsApi();

try {
    $result = $api_instance->listRedirects();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedirectsApi->listRedirects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RedirectsApi;

my $api_instance = WWW::SwaggerClient::RedirectsApi->new();

eval { 
    my $result = $api_instance->listRedirects();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RedirectsApi->listRedirects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RedirectsApi()

try: 
    # List all redirects
    api_response = api_instance.list_redirects()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RedirectsApi->listRedirects: %s\n" % e)

Parameters

Responses

Status: 200 - An array of redirects

Status: default - unexpected error


updateRedirect

Update a redirect


/redirects/{redirectId}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//redirects/{redirectId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RedirectsApi;

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

public class RedirectsApiExample {

    public static void main(String[] args) {
        
        RedirectsApi apiInstance = new RedirectsApi();
        RedirectCreate body = ; // RedirectCreate | Body to create the redirect
        UUID redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the redirect to update
        try {
            apiInstance.updateRedirect(body, redirectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectsApi#updateRedirect");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RedirectsApi;

public class RedirectsApiExample {

    public static void main(String[] args) {
        RedirectsApi apiInstance = new RedirectsApi();
        RedirectCreate body = ; // RedirectCreate | Body to create the redirect
        UUID redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the redirect to update
        try {
            apiInstance.updateRedirect(body, redirectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectsApi#updateRedirect");
            e.printStackTrace();
        }
    }
}
RedirectCreate *body = ; // Body to create the redirect
UUID *redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the redirect to update

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

// Update a redirect
[apiInstance updateRedirectWith:body
    redirectId:redirectId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DomainForwardApiDefinition = require('domain_forward_api_definition');

var api = new DomainForwardApiDefinition.RedirectsApi()
var body = ; // {{RedirectCreate}} Body to create the redirect
var redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} The id of the redirect to update

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateRedirect(bodyredirectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new RedirectsApi();
            var body = new RedirectCreate(); // RedirectCreate | Body to create the redirect
            var redirectId = new UUID(); // UUID | The id of the redirect to update

            try
            {
                // Update a redirect
                apiInstance.updateRedirect(body, redirectId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RedirectsApi.updateRedirect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiRedirectsApi();
$body = ; // RedirectCreate | Body to create the redirect
$redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the redirect to update

try {
    $api_instance->updateRedirect($body, $redirectId);
} catch (Exception $e) {
    echo 'Exception when calling RedirectsApi->updateRedirect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RedirectsApi;

my $api_instance = WWW::SwaggerClient::RedirectsApi->new();
my $body = WWW::SwaggerClient::Object::RedirectCreate->new(); # RedirectCreate | Body to create the redirect
my $redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the redirect to update

eval { 
    $api_instance->updateRedirect(body => $body, redirectId => $redirectId);
};
if ($@) {
    warn "Exception when calling RedirectsApi->updateRedirect: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RedirectsApi()
body =  # RedirectCreate | Body to create the redirect
redirectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the redirect to update

try: 
    # Update a redirect
    api_instance.update_redirect(body, redirectId)
except ApiException as e:
    print("Exception when calling RedirectsApi->updateRedirect: %s\n" % e)

Parameters

Path parameters
Name Description
redirectId*
UUID (uuid)
The id of the redirect to update
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Null response

Status: default - unexpected error


User

me

get me


/me

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//me"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        try {
            User result = apiInstance.me();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#me");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        try {
            User result = apiInstance.me();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#me");
            e.printStackTrace();
        }
    }
}

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

// get me
[apiInstance meWithCompletionHandler: 
              ^(User output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DomainForwardApiDefinition = require('domain_forward_api_definition');

var api = new DomainForwardApiDefinition.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.me(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserApi();

            try
            {
                // get me
                User result = apiInstance.me();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.me: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserApi();

try {
    $result = $api_instance->me();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->me: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

my $api_instance = WWW::SwaggerClient::UserApi->new();

eval { 
    my $result = $api_instance->me();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->me: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserApi()

try: 
    # get me
    api_response = api_instance.me()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->me: %s\n" % e)

Parameters

Responses

Status: 200 - get the current user

Status: default - unexpected error


updateUser

Update a user


/me

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//me"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        UserUpdate body = ; // UserUpdate | Body to update the user
        try {
            apiInstance.updateUser(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        UserUpdate body = ; // UserUpdate | Body to update the user
        try {
            apiInstance.updateUser(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUser");
            e.printStackTrace();
        }
    }
}
UserUpdate *body = ; // Body to update the user

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

// Update a user
[apiInstance updateUserWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DomainForwardApiDefinition = require('domain_forward_api_definition');

var api = new DomainForwardApiDefinition.UserApi()
var body = ; // {{UserUpdate}} Body to update the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUser(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserApi();
            var body = new UserUpdate(); // UserUpdate | Body to update the user

            try
            {
                // Update a user
                apiInstance.updateUser(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserApi();
$body = ; // UserUpdate | Body to update the user

try {
    $api_instance->updateUser($body);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $body = WWW::SwaggerClient::Object::UserUpdate->new(); # UserUpdate | Body to update the user

eval { 
    $api_instance->updateUser(body => $body);
};
if ($@) {
    warn "Exception when calling UserApi->updateUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserApi()
body =  # UserUpdate | Body to update the user

try: 
    # Update a user
    api_instance.update_user(body)
except ApiException as e:
    print("Exception when calling UserApi->updateUser: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Null response

Status: default - unexpected error