Shorten.REST API Documentation
Shorten.REST API Documentationv1.0.0
Introduction The Shorten.rest API allows you to programmatically create short URLs (an 'alias') for longer URL (a 'destination'). Each alias you create can be used to redirect the end user (person clicking on the link) to one or more destination URLs A default destination is always set and specific destinations can be set to redirect the end user to preferred destinations based on the user's geographical location (country) and device Operating System. In order to use the Shorten.Rest URL Shortening API you can choose to bind your own branded domain, sub-domain or to…
- Endpoints
- 7 (3 GET, 2 POST, 1 PUT, 1 DELETE)
- Base URL
https://api.shorten.rest- Authentication
- API key
- Spec format
- OpenAPI 3.0.0
- API version
- 1.0.0
- Source
- docs.shorten.rest
- Provider
- shorten.rest
- Categories
- Developer Tools
- Last updated
Use this API in Bruno:
- Download the Bruno collection above and unzip it.
- In Bruno, choose Open Collection and select the unzipped folder.
- Set the
baseUrlvariable (for examplehttps://api.shorten.rest) and your API key credentials, then send requests.
POST
Create alias
{{baseUrl}}/aliases
HEADERS
x-api-key
{{apiKey}}
BODY json
{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-api-key: {{apiKey}}");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/aliases" {:headers {:x-api-key "{{apiKey}}"}
:content-type :json
:form-params {:destinations [{:country ""
:os ""
:url ""}]
:metatags [{:content ""
:name ""}]
:snippets [{:id ""
:parameters {}}]}})
require "http/client"
url = "{{baseUrl}}/aliases"
headers = HTTP::Headers{
"x-api-key" => "{{apiKey}}"
"content-type" => "application/json"
}
reqBody = "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/aliases"),
Headers =
{
{ "x-api-key", "{{apiKey}}" },
},
Content = new StringContent("{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases");
var request = new RestRequest("", Method.Post);
request.AddHeader("x-api-key", "{{apiKey}}");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases"
payload := strings.NewReader("{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "{{apiKey}}")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/aliases HTTP/1.1
X-Api-Key: {{apiKey}}
Content-Type: application/json
Host: example.com
Content-Length: 235
{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/aliases")
.setHeader("x-api-key", "{{apiKey}}")
.setHeader("content-type", "application/json")
.setBody("{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases"))
.header("x-api-key", "{{apiKey}}")
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/aliases")
.post(body)
.addHeader("x-api-key", "{{apiKey}}")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/aliases")
.header("x-api-key", "{{apiKey}}")
.header("content-type", "application/json")
.body("{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}")
.asString();
const data = JSON.stringify({
destinations: [
{
country: '',
os: '',
url: ''
}
],
metatags: [
{
content: '',
name: ''
}
],
snippets: [
{
id: '',
parameters: {}
}
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/aliases');
xhr.setRequestHeader('x-api-key', '{{apiKey}}');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/aliases',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
data: {
destinations: [{country: '', os: '', url: ''}],
metatags: [{content: '', name: ''}],
snippets: [{id: '', parameters: {}}]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases';
const options = {
method: 'POST',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
body: '{"destinations":[{"country":"","os":"","url":""}],"metatags":[{"content":"","name":""}],"snippets":[{"id":"","parameters":{}}]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/aliases',
method: 'POST',
headers: {
'x-api-key': '{{apiKey}}',
'content-type': 'application/json'
},
processData: false,
data: '{\n "destinations": [\n {\n "country": "",\n "os": "",\n "url": ""\n }\n ],\n "metatags": [\n {\n "content": "",\n "name": ""\n }\n ],\n "snippets": [\n {\n "id": "",\n "parameters": {}\n }\n ]\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/aliases")
.post(body)
.addHeader("x-api-key", "{{apiKey}}")
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases',
headers: {
'x-api-key': '{{apiKey}}',
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
destinations: [{country: '', os: '', url: ''}],
metatags: [{content: '', name: ''}],
snippets: [{id: '', parameters: {}}]
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/aliases',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
body: {
destinations: [{country: '', os: '', url: ''}],
metatags: [{content: '', name: ''}],
snippets: [{id: '', parameters: {}}]
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/aliases');
req.headers({
'x-api-key': '{{apiKey}}',
'content-type': 'application/json'
});
req.type('json');
req.send({
destinations: [
{
country: '',
os: '',
url: ''
}
],
metatags: [
{
content: '',
name: ''
}
],
snippets: [
{
id: '',
parameters: {}
}
]
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/aliases',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
data: {
destinations: [{country: '', os: '', url: ''}],
metatags: [{content: '', name: ''}],
snippets: [{id: '', parameters: {}}]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases';
const options = {
method: 'POST',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
body: '{"destinations":[{"country":"","os":"","url":""}],"metatags":[{"content":"","name":""}],"snippets":[{"id":"","parameters":{}}]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-api-key": @"{{apiKey}}",
@"content-type": @"application/json" };
NSDictionary *parameters = @{ @"destinations": @[ @{ @"country": @"", @"os": @"", @"url": @"" } ],
@"metatags": @[ @{ @"content": @"", @"name": @"" } ],
@"snippets": @[ @{ @"id": @"", @"parameters": @{ } } ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/aliases"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/aliases" in
let headers = Header.add_list (Header.init ()) [
("x-api-key", "{{apiKey}}");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'destinations' => [
[
'country' => '',
'os' => '',
'url' => ''
]
],
'metatags' => [
[
'content' => '',
'name' => ''
]
],
'snippets' => [
[
'id' => '',
'parameters' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json",
"x-api-key: {{apiKey}}"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/aliases', [
'body' => '{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}',
'headers' => [
'content-type' => 'application/json',
'x-api-key' => '{{apiKey}}',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/aliases');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'x-api-key' => '{{apiKey}}',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'destinations' => [
[
'country' => '',
'os' => '',
'url' => ''
]
],
'metatags' => [
[
'content' => '',
'name' => ''
]
],
'snippets' => [
[
'id' => '',
'parameters' => [
]
]
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'destinations' => [
[
'country' => '',
'os' => '',
'url' => ''
]
],
'metatags' => [
[
'content' => '',
'name' => ''
]
],
'snippets' => [
[
'id' => '',
'parameters' => [
]
]
]
]));
$request->setRequestUrl('{{baseUrl}}/aliases');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'x-api-key' => '{{apiKey}}',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}'
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"
headers = {
'x-api-key': "{{apiKey}}",
'content-type': "application/json"
}
conn.request("POST", "/baseUrl/aliases", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases"
payload = {
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}
headers = {
"x-api-key": "{{apiKey}}",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases"
payload <- "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, add_headers('x-api-key' = '{{apiKey}}'), content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '{{apiKey}}'
request["content-type"] = 'application/json'
request.body = "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/aliases') do |req|
req.headers['x-api-key'] = '{{apiKey}}'
req.body = "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases";
let payload = json!({
"destinations": (
json!({
"country": "",
"os": "",
"url": ""
})
),
"metatags": (
json!({
"content": "",
"name": ""
})
),
"snippets": (
json!({
"id": "",
"parameters": json!({})
})
)
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-api-key", "{{apiKey}}".parse().unwrap());
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/aliases \
--header 'content-type: application/json' \
--header 'x-api-key: {{apiKey}}' \
--data '{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}'
echo '{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}' | \
http POST {{baseUrl}}/aliases \
content-type:application/json \
x-api-key:'{{apiKey}}'
wget --quiet \
--method POST \
--header 'x-api-key: {{apiKey}}' \
--header 'content-type: application/json' \
--body-data '{\n "destinations": [\n {\n "country": "",\n "os": "",\n "url": ""\n }\n ],\n "metatags": [\n {\n "content": "",\n "name": ""\n }\n ],\n "snippets": [\n {\n "id": "",\n "parameters": {}\n }\n ]\n}' \
--output-document \
- {{baseUrl}}/aliases
import Foundation
let headers = [
"x-api-key": "{{apiKey}}",
"content-type": "application/json"
]
let parameters = [
"destinations": [
[
"country": "",
"os": "",
"url": ""
]
],
"metatags": [
[
"content": "",
"name": ""
]
],
"snippets": [
[
"id": "",
"parameters": []
]
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"aliasName": "aBcDe012",
"domainName": "your.domain.com",
"shortUrl": "https://your.domain.com/aBcDe012"
}
DELETE
Delete alias
{{baseUrl}}/aliases
HEADERS
x-api-key
{{apiKey}}
QUERY PARAMS
aliasName
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases?aliasName=");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-api-key: {{apiKey}}");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/aliases" {:headers {:x-api-key "{{apiKey}}"}
:query-params {:aliasName ""}})
require "http/client"
url = "{{baseUrl}}/aliases?aliasName="
headers = HTTP::Headers{
"x-api-key" => "{{apiKey}}"
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/aliases?aliasName="),
Headers =
{
{ "x-api-key", "{{apiKey}}" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases?aliasName=");
var request = new RestRequest("", Method.Delete);
request.AddHeader("x-api-key", "{{apiKey}}");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases?aliasName="
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-api-key", "{{apiKey}}")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/aliases?aliasName= HTTP/1.1
X-Api-Key: {{apiKey}}
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/aliases?aliasName=")
.setHeader("x-api-key", "{{apiKey}}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases?aliasName="))
.header("x-api-key", "{{apiKey}}")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/aliases?aliasName=")
.delete(null)
.addHeader("x-api-key", "{{apiKey}}")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/aliases?aliasName=")
.header("x-api-key", "{{apiKey}}")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/aliases?aliasName=');
xhr.setRequestHeader('x-api-key', '{{apiKey}}');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/aliases',
params: {aliasName: ''},
headers: {'x-api-key': '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases?aliasName=';
const options = {method: 'DELETE', headers: {'x-api-key': '{{apiKey}}'}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/aliases?aliasName=',
method: 'DELETE',
headers: {
'x-api-key': '{{apiKey}}'
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases?aliasName=")
.delete(null)
.addHeader("x-api-key", "{{apiKey}}")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases?aliasName=',
headers: {
'x-api-key': '{{apiKey}}'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/aliases',
qs: {aliasName: ''},
headers: {'x-api-key': '{{apiKey}}'}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/aliases');
req.query({
aliasName: ''
});
req.headers({
'x-api-key': '{{apiKey}}'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/aliases',
params: {aliasName: ''},
headers: {'x-api-key': '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases?aliasName=';
const options = {method: 'DELETE', headers: {'x-api-key': '{{apiKey}}'}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-api-key": @"{{apiKey}}" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/aliases?aliasName="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/aliases?aliasName=" in
let headers = Header.add (Header.init ()) "x-api-key" "{{apiKey}}" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases?aliasName=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"x-api-key: {{apiKey}}"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/aliases?aliasName=', [
'headers' => [
'x-api-key' => '{{apiKey}}',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/aliases');
$request->setMethod(HTTP_METH_DELETE);
$request->setQueryData([
'aliasName' => ''
]);
$request->setHeaders([
'x-api-key' => '{{apiKey}}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases');
$request->setRequestMethod('DELETE');
$request->setQuery(new http\QueryString([
'aliasName' => ''
]));
$request->setHeaders([
'x-api-key' => '{{apiKey}}'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases?aliasName=' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases?aliasName=' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-api-key': "{{apiKey}}" }
conn.request("DELETE", "/baseUrl/aliases?aliasName=", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases"
querystring = {"aliasName":""}
headers = {"x-api-key": "{{apiKey}}"}
response = requests.delete(url, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases"
queryString <- list(aliasName = "")
response <- VERB("DELETE", url, query = queryString, add_headers('x-api-key' = '{{apiKey}}'), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases?aliasName=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '{{apiKey}}'
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/aliases') do |req|
req.headers['x-api-key'] = '{{apiKey}}'
req.params['aliasName'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases";
let querystring = [
("aliasName", ""),
];
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-api-key", "{{apiKey}}".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.query(&querystring)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url '{{baseUrl}}/aliases?aliasName=' \
--header 'x-api-key: {{apiKey}}'
http DELETE '{{baseUrl}}/aliases?aliasName=' \
x-api-key:'{{apiKey}}'
wget --quiet \
--method DELETE \
--header 'x-api-key: {{apiKey}}' \
--output-document \
- '{{baseUrl}}/aliases?aliasName='
import Foundation
let headers = ["x-api-key": "{{apiKey}}"]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases?aliasName=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get alias
{{baseUrl}}/aliases
HEADERS
x-api-key
{{apiKey}}
QUERY PARAMS
aliasName
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases?aliasName=");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-api-key: {{apiKey}}");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/aliases" {:headers {:x-api-key "{{apiKey}}"}
:query-params {:aliasName ""}})
require "http/client"
url = "{{baseUrl}}/aliases?aliasName="
headers = HTTP::Headers{
"x-api-key" => "{{apiKey}}"
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/aliases?aliasName="),
Headers =
{
{ "x-api-key", "{{apiKey}}" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases?aliasName=");
var request = new RestRequest("", Method.Get);
request.AddHeader("x-api-key", "{{apiKey}}");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases?aliasName="
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "{{apiKey}}")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/aliases?aliasName= HTTP/1.1
X-Api-Key: {{apiKey}}
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/aliases?aliasName=")
.setHeader("x-api-key", "{{apiKey}}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases?aliasName="))
.header("x-api-key", "{{apiKey}}")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/aliases?aliasName=")
.get()
.addHeader("x-api-key", "{{apiKey}}")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/aliases?aliasName=")
.header("x-api-key", "{{apiKey}}")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/aliases?aliasName=');
xhr.setRequestHeader('x-api-key', '{{apiKey}}');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/aliases',
params: {aliasName: ''},
headers: {'x-api-key': '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases?aliasName=';
const options = {method: 'GET', headers: {'x-api-key': '{{apiKey}}'}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/aliases?aliasName=',
method: 'GET',
headers: {
'x-api-key': '{{apiKey}}'
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases?aliasName=")
.get()
.addHeader("x-api-key", "{{apiKey}}")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases?aliasName=',
headers: {
'x-api-key': '{{apiKey}}'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/aliases',
qs: {aliasName: ''},
headers: {'x-api-key': '{{apiKey}}'}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/aliases');
req.query({
aliasName: ''
});
req.headers({
'x-api-key': '{{apiKey}}'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/aliases',
params: {aliasName: ''},
headers: {'x-api-key': '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases?aliasName=';
const options = {method: 'GET', headers: {'x-api-key': '{{apiKey}}'}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-api-key": @"{{apiKey}}" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/aliases?aliasName="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/aliases?aliasName=" in
let headers = Header.add (Header.init ()) "x-api-key" "{{apiKey}}" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases?aliasName=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: {{apiKey}}"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/aliases?aliasName=', [
'headers' => [
'x-api-key' => '{{apiKey}}',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/aliases');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'aliasName' => ''
]);
$request->setHeaders([
'x-api-key' => '{{apiKey}}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'aliasName' => ''
]));
$request->setHeaders([
'x-api-key' => '{{apiKey}}'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases?aliasName=' -Method GET -Headers $headers
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases?aliasName=' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-api-key': "{{apiKey}}" }
conn.request("GET", "/baseUrl/aliases?aliasName=", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases"
querystring = {"aliasName":""}
headers = {"x-api-key": "{{apiKey}}"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases"
queryString <- list(aliasName = "")
response <- VERB("GET", url, query = queryString, add_headers('x-api-key' = '{{apiKey}}'), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases?aliasName=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '{{apiKey}}'
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/aliases') do |req|
req.headers['x-api-key'] = '{{apiKey}}'
req.params['aliasName'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases";
let querystring = [
("aliasName", ""),
];
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-api-key", "{{apiKey}}".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/aliases?aliasName=' \
--header 'x-api-key: {{apiKey}}'
http GET '{{baseUrl}}/aliases?aliasName=' \
x-api-key:'{{apiKey}}'
wget --quiet \
--method GET \
--header 'x-api-key: {{apiKey}}' \
--output-document \
- '{{baseUrl}}/aliases?aliasName='
import Foundation
let headers = ["x-api-key": "{{apiKey}}"]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases?aliasName=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"createdAt": 1595845801514,
"domainName": "your.domain.com",
"name": "aBcDe012",
"updatedAt": 1595845801514
}
GET
Get aliases by domain
{{baseUrl}}/aliases/all
HEADERS
x-api-key
{{apiKey}}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/all");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-api-key: {{apiKey}}");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/aliases/all" {:headers {:x-api-key "{{apiKey}}"}})
require "http/client"
url = "{{baseUrl}}/aliases/all"
headers = HTTP::Headers{
"x-api-key" => "{{apiKey}}"
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/aliases/all"),
Headers =
{
{ "x-api-key", "{{apiKey}}" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases/all");
var request = new RestRequest("", Method.Get);
request.AddHeader("x-api-key", "{{apiKey}}");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/all"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "{{apiKey}}")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/aliases/all HTTP/1.1
X-Api-Key: {{apiKey}}
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/aliases/all")
.setHeader("x-api-key", "{{apiKey}}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/all"))
.header("x-api-key", "{{apiKey}}")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/aliases/all")
.get()
.addHeader("x-api-key", "{{apiKey}}")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/aliases/all")
.header("x-api-key", "{{apiKey}}")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/aliases/all');
xhr.setRequestHeader('x-api-key', '{{apiKey}}');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/aliases/all',
headers: {'x-api-key': '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/all';
const options = {method: 'GET', headers: {'x-api-key': '{{apiKey}}'}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/aliases/all',
method: 'GET',
headers: {
'x-api-key': '{{apiKey}}'
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases/all")
.get()
.addHeader("x-api-key", "{{apiKey}}")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases/all',
headers: {
'x-api-key': '{{apiKey}}'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/aliases/all',
headers: {'x-api-key': '{{apiKey}}'}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/aliases/all');
req.headers({
'x-api-key': '{{apiKey}}'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/aliases/all',
headers: {'x-api-key': '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/all';
const options = {method: 'GET', headers: {'x-api-key': '{{apiKey}}'}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-api-key": @"{{apiKey}}" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/aliases/all"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/aliases/all" in
let headers = Header.add (Header.init ()) "x-api-key" "{{apiKey}}" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/all",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: {{apiKey}}"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/aliases/all', [
'headers' => [
'x-api-key' => '{{apiKey}}',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/all');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'x-api-key' => '{{apiKey}}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases/all');
$request->setRequestMethod('GET');
$request->setHeaders([
'x-api-key' => '{{apiKey}}'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases/all' -Method GET -Headers $headers
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/all' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-api-key': "{{apiKey}}" }
conn.request("GET", "/baseUrl/aliases/all", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/all"
headers = {"x-api-key": "{{apiKey}}"}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/all"
response <- VERB("GET", url, add_headers('x-api-key' = '{{apiKey}}'), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases/all")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '{{apiKey}}'
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/aliases/all') do |req|
req.headers['x-api-key'] = '{{apiKey}}'
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/all";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-api-key", "{{apiKey}}".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/aliases/all \
--header 'x-api-key: {{apiKey}}'
http GET {{baseUrl}}/aliases/all \
x-api-key:'{{apiKey}}'
wget --quiet \
--method GET \
--header 'x-api-key: {{apiKey}}' \
--output-document \
- {{baseUrl}}/aliases/all
import Foundation
let headers = ["x-api-key": "{{apiKey}}"]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/all")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Update alias
{{baseUrl}}/aliases
HEADERS
x-api-key
{{apiKey}}
QUERY PARAMS
aliasName
BODY json
{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases?aliasName=");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-api-key: {{apiKey}}");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/aliases" {:headers {:x-api-key "{{apiKey}}"}
:query-params {:aliasName ""}
:content-type :json
:form-params {:destinations [{:country ""
:os ""
:url ""}]
:metatags [{:content ""
:name ""}]
:snippets [{:id ""
:parameters {}}]}})
require "http/client"
url = "{{baseUrl}}/aliases?aliasName="
headers = HTTP::Headers{
"x-api-key" => "{{apiKey}}"
"content-type" => "application/json"
}
reqBody = "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/aliases?aliasName="),
Headers =
{
{ "x-api-key", "{{apiKey}}" },
},
Content = new StringContent("{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases?aliasName=");
var request = new RestRequest("", Method.Put);
request.AddHeader("x-api-key", "{{apiKey}}");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases?aliasName="
payload := strings.NewReader("{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "{{apiKey}}")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/aliases?aliasName= HTTP/1.1
X-Api-Key: {{apiKey}}
Content-Type: application/json
Host: example.com
Content-Length: 235
{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/aliases?aliasName=")
.setHeader("x-api-key", "{{apiKey}}")
.setHeader("content-type", "application/json")
.setBody("{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases?aliasName="))
.header("x-api-key", "{{apiKey}}")
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/aliases?aliasName=")
.put(body)
.addHeader("x-api-key", "{{apiKey}}")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/aliases?aliasName=")
.header("x-api-key", "{{apiKey}}")
.header("content-type", "application/json")
.body("{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}")
.asString();
const data = JSON.stringify({
destinations: [
{
country: '',
os: '',
url: ''
}
],
metatags: [
{
content: '',
name: ''
}
],
snippets: [
{
id: '',
parameters: {}
}
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/aliases?aliasName=');
xhr.setRequestHeader('x-api-key', '{{apiKey}}');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/aliases',
params: {aliasName: ''},
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
data: {
destinations: [{country: '', os: '', url: ''}],
metatags: [{content: '', name: ''}],
snippets: [{id: '', parameters: {}}]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases?aliasName=';
const options = {
method: 'PUT',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
body: '{"destinations":[{"country":"","os":"","url":""}],"metatags":[{"content":"","name":""}],"snippets":[{"id":"","parameters":{}}]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/aliases?aliasName=',
method: 'PUT',
headers: {
'x-api-key': '{{apiKey}}',
'content-type': 'application/json'
},
processData: false,
data: '{\n "destinations": [\n {\n "country": "",\n "os": "",\n "url": ""\n }\n ],\n "metatags": [\n {\n "content": "",\n "name": ""\n }\n ],\n "snippets": [\n {\n "id": "",\n "parameters": {}\n }\n ]\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/aliases?aliasName=")
.put(body)
.addHeader("x-api-key", "{{apiKey}}")
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases?aliasName=',
headers: {
'x-api-key': '{{apiKey}}',
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
destinations: [{country: '', os: '', url: ''}],
metatags: [{content: '', name: ''}],
snippets: [{id: '', parameters: {}}]
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/aliases',
qs: {aliasName: ''},
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
body: {
destinations: [{country: '', os: '', url: ''}],
metatags: [{content: '', name: ''}],
snippets: [{id: '', parameters: {}}]
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/aliases');
req.query({
aliasName: ''
});
req.headers({
'x-api-key': '{{apiKey}}',
'content-type': 'application/json'
});
req.type('json');
req.send({
destinations: [
{
country: '',
os: '',
url: ''
}
],
metatags: [
{
content: '',
name: ''
}
],
snippets: [
{
id: '',
parameters: {}
}
]
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/aliases',
params: {aliasName: ''},
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
data: {
destinations: [{country: '', os: '', url: ''}],
metatags: [{content: '', name: ''}],
snippets: [{id: '', parameters: {}}]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases?aliasName=';
const options = {
method: 'PUT',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
body: '{"destinations":[{"country":"","os":"","url":""}],"metatags":[{"content":"","name":""}],"snippets":[{"id":"","parameters":{}}]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-api-key": @"{{apiKey}}",
@"content-type": @"application/json" };
NSDictionary *parameters = @{ @"destinations": @[ @{ @"country": @"", @"os": @"", @"url": @"" } ],
@"metatags": @[ @{ @"content": @"", @"name": @"" } ],
@"snippets": @[ @{ @"id": @"", @"parameters": @{ } } ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/aliases?aliasName="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/aliases?aliasName=" in
let headers = Header.add_list (Header.init ()) [
("x-api-key", "{{apiKey}}");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases?aliasName=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'destinations' => [
[
'country' => '',
'os' => '',
'url' => ''
]
],
'metatags' => [
[
'content' => '',
'name' => ''
]
],
'snippets' => [
[
'id' => '',
'parameters' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json",
"x-api-key: {{apiKey}}"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/aliases?aliasName=', [
'body' => '{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}',
'headers' => [
'content-type' => 'application/json',
'x-api-key' => '{{apiKey}}',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/aliases');
$request->setMethod(HTTP_METH_PUT);
$request->setQueryData([
'aliasName' => ''
]);
$request->setHeaders([
'x-api-key' => '{{apiKey}}',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'destinations' => [
[
'country' => '',
'os' => '',
'url' => ''
]
],
'metatags' => [
[
'content' => '',
'name' => ''
]
],
'snippets' => [
[
'id' => '',
'parameters' => [
]
]
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'destinations' => [
[
'country' => '',
'os' => '',
'url' => ''
]
],
'metatags' => [
[
'content' => '',
'name' => ''
]
],
'snippets' => [
[
'id' => '',
'parameters' => [
]
]
]
]));
$request->setRequestUrl('{{baseUrl}}/aliases');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'aliasName' => ''
]));
$request->setHeaders([
'x-api-key' => '{{apiKey}}',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases?aliasName=' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}'
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases?aliasName=' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"
headers = {
'x-api-key': "{{apiKey}}",
'content-type': "application/json"
}
conn.request("PUT", "/baseUrl/aliases?aliasName=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases"
querystring = {"aliasName":""}
payload = {
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}
headers = {
"x-api-key": "{{apiKey}}",
"content-type": "application/json"
}
response = requests.put(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases"
queryString <- list(aliasName = "")
payload <- "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, query = queryString, add_headers('x-api-key' = '{{apiKey}}'), content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases?aliasName=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '{{apiKey}}'
request["content-type"] = 'application/json'
request.body = "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/aliases') do |req|
req.headers['x-api-key'] = '{{apiKey}}'
req.params['aliasName'] = ''
req.body = "{\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ]\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases";
let querystring = [
("aliasName", ""),
];
let payload = json!({
"destinations": (
json!({
"country": "",
"os": "",
"url": ""
})
),
"metatags": (
json!({
"content": "",
"name": ""
})
),
"snippets": (
json!({
"id": "",
"parameters": json!({})
})
)
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-api-key", "{{apiKey}}".parse().unwrap());
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url '{{baseUrl}}/aliases?aliasName=' \
--header 'content-type: application/json' \
--header 'x-api-key: {{apiKey}}' \
--data '{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}'
echo '{
"destinations": [
{
"country": "",
"os": "",
"url": ""
}
],
"metatags": [
{
"content": "",
"name": ""
}
],
"snippets": [
{
"id": "",
"parameters": {}
}
]
}' | \
http PUT '{{baseUrl}}/aliases?aliasName=' \
content-type:application/json \
x-api-key:'{{apiKey}}'
wget --quiet \
--method PUT \
--header 'x-api-key: {{apiKey}}' \
--header 'content-type: application/json' \
--body-data '{\n "destinations": [\n {\n "country": "",\n "os": "",\n "url": ""\n }\n ],\n "metatags": [\n {\n "content": "",\n "name": ""\n }\n ],\n "snippets": [\n {\n "id": "",\n "parameters": {}\n }\n ]\n}' \
--output-document \
- '{{baseUrl}}/aliases?aliasName='
import Foundation
let headers = [
"x-api-key": "{{apiKey}}",
"content-type": "application/json"
]
let parameters = [
"destinations": [
[
"country": "",
"os": "",
"url": ""
]
],
"metatags": [
[
"content": "",
"name": ""
]
],
"snippets": [
[
"id": "",
"parameters": []
]
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases?aliasName=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get clicks
{{baseUrl}}/clicks
HEADERS
x-api-key
{{apiKey}}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/clicks");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-api-key: {{apiKey}}");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/clicks" {:headers {:x-api-key "{{apiKey}}"}})
require "http/client"
url = "{{baseUrl}}/clicks"
headers = HTTP::Headers{
"x-api-key" => "{{apiKey}}"
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/clicks"),
Headers =
{
{ "x-api-key", "{{apiKey}}" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/clicks");
var request = new RestRequest("", Method.Get);
request.AddHeader("x-api-key", "{{apiKey}}");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/clicks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "{{apiKey}}")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/clicks HTTP/1.1
X-Api-Key: {{apiKey}}
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/clicks")
.setHeader("x-api-key", "{{apiKey}}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/clicks"))
.header("x-api-key", "{{apiKey}}")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/clicks")
.get()
.addHeader("x-api-key", "{{apiKey}}")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/clicks")
.header("x-api-key", "{{apiKey}}")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/clicks');
xhr.setRequestHeader('x-api-key', '{{apiKey}}');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/clicks',
headers: {'x-api-key': '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/clicks';
const options = {method: 'GET', headers: {'x-api-key': '{{apiKey}}'}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/clicks',
method: 'GET',
headers: {
'x-api-key': '{{apiKey}}'
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/clicks")
.get()
.addHeader("x-api-key", "{{apiKey}}")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/clicks',
headers: {
'x-api-key': '{{apiKey}}'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/clicks',
headers: {'x-api-key': '{{apiKey}}'}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/clicks');
req.headers({
'x-api-key': '{{apiKey}}'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/clicks',
headers: {'x-api-key': '{{apiKey}}'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/clicks';
const options = {method: 'GET', headers: {'x-api-key': '{{apiKey}}'}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-api-key": @"{{apiKey}}" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/clicks"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/clicks" in
let headers = Header.add (Header.init ()) "x-api-key" "{{apiKey}}" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/clicks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: {{apiKey}}"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/clicks', [
'headers' => [
'x-api-key' => '{{apiKey}}',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/clicks');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'x-api-key' => '{{apiKey}}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/clicks');
$request->setRequestMethod('GET');
$request->setHeaders([
'x-api-key' => '{{apiKey}}'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/clicks' -Method GET -Headers $headers
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/clicks' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-api-key': "{{apiKey}}" }
conn.request("GET", "/baseUrl/clicks", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/clicks"
headers = {"x-api-key": "{{apiKey}}"}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/clicks"
response <- VERB("GET", url, add_headers('x-api-key' = '{{apiKey}}'), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/clicks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '{{apiKey}}'
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/clicks') do |req|
req.headers['x-api-key'] = '{{apiKey}}'
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/clicks";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-api-key", "{{apiKey}}".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/clicks \
--header 'x-api-key: {{apiKey}}'
http GET {{baseUrl}}/clicks \
x-api-key:'{{apiKey}}'
wget --quiet \
--method GET \
--header 'x-api-key: {{apiKey}}' \
--output-document \
- {{baseUrl}}/clicks
import Foundation
let headers = ["x-api-key": "{{apiKey}}"]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/clicks")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Get clicks statistics
{{baseUrl}}/clicks/pg
HEADERS
x-api-key
{{apiKey}}
BODY json
{
"aliasId": "",
"dateFrom": "",
"dateTo": "",
"domain": "",
"lastId": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/clicks/pg");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-api-key: {{apiKey}}");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/clicks/pg" {:headers {:x-api-key "{{apiKey}}"}
:content-type :json
:form-params {:aliasId "aBcDe012"
:dateFrom "2001-05-02"
:dateTo "2001-05-02"
:domain "short.fyi"
:lastId 100}})
require "http/client"
url = "{{baseUrl}}/clicks/pg"
headers = HTTP::Headers{
"x-api-key" => "{{apiKey}}"
"content-type" => "application/json"
}
reqBody = "{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/clicks/pg"),
Headers =
{
{ "x-api-key", "{{apiKey}}" },
},
Content = new StringContent("{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/clicks/pg");
var request = new RestRequest("", Method.Post);
request.AddHeader("x-api-key", "{{apiKey}}");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/clicks/pg"
payload := strings.NewReader("{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "{{apiKey}}")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/clicks/pg HTTP/1.1
X-Api-Key: {{apiKey}}
Content-Type: application/json
Host: example.com
Content-Length: 123
{
"aliasId": "aBcDe012",
"dateFrom": "2001-05-02",
"dateTo": "2001-05-02",
"domain": "short.fyi",
"lastId": 100
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/clicks/pg")
.setHeader("x-api-key", "{{apiKey}}")
.setHeader("content-type", "application/json")
.setBody("{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/clicks/pg"))
.header("x-api-key", "{{apiKey}}")
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/clicks/pg")
.post(body)
.addHeader("x-api-key", "{{apiKey}}")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/clicks/pg")
.header("x-api-key", "{{apiKey}}")
.header("content-type", "application/json")
.body("{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}")
.asString();
const data = JSON.stringify({
aliasId: 'aBcDe012',
dateFrom: '2001-05-02',
dateTo: '2001-05-02',
domain: 'short.fyi',
lastId: 100
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/clicks/pg');
xhr.setRequestHeader('x-api-key', '{{apiKey}}');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/clicks/pg',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
data: {
aliasId: 'aBcDe012',
dateFrom: '2001-05-02',
dateTo: '2001-05-02',
domain: 'short.fyi',
lastId: 100
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/clicks/pg';
const options = {
method: 'POST',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
body: '{"aliasId":"aBcDe012","dateFrom":"2001-05-02","dateTo":"2001-05-02","domain":"short.fyi","lastId":100}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/clicks/pg',
method: 'POST',
headers: {
'x-api-key': '{{apiKey}}',
'content-type': 'application/json'
},
processData: false,
data: '{\n "aliasId": "aBcDe012",\n "dateFrom": "2001-05-02",\n "dateTo": "2001-05-02",\n "domain": "short.fyi",\n "lastId": 100\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}")
val request = Request.Builder()
.url("{{baseUrl}}/clicks/pg")
.post(body)
.addHeader("x-api-key", "{{apiKey}}")
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/clicks/pg',
headers: {
'x-api-key': '{{apiKey}}',
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
aliasId: 'aBcDe012',
dateFrom: '2001-05-02',
dateTo: '2001-05-02',
domain: 'short.fyi',
lastId: 100
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/clicks/pg',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
body: {
aliasId: 'aBcDe012',
dateFrom: '2001-05-02',
dateTo: '2001-05-02',
domain: 'short.fyi',
lastId: 100
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/clicks/pg');
req.headers({
'x-api-key': '{{apiKey}}',
'content-type': 'application/json'
});
req.type('json');
req.send({
aliasId: 'aBcDe012',
dateFrom: '2001-05-02',
dateTo: '2001-05-02',
domain: 'short.fyi',
lastId: 100
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/clicks/pg',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
data: {
aliasId: 'aBcDe012',
dateFrom: '2001-05-02',
dateTo: '2001-05-02',
domain: 'short.fyi',
lastId: 100
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/clicks/pg';
const options = {
method: 'POST',
headers: {'x-api-key': '{{apiKey}}', 'content-type': 'application/json'},
body: '{"aliasId":"aBcDe012","dateFrom":"2001-05-02","dateTo":"2001-05-02","domain":"short.fyi","lastId":100}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-api-key": @"{{apiKey}}",
@"content-type": @"application/json" };
NSDictionary *parameters = @{ @"aliasId": @"aBcDe012",
@"dateFrom": @"2001-05-02",
@"dateTo": @"2001-05-02",
@"domain": @"short.fyi",
@"lastId": @100 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/clicks/pg"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/clicks/pg" in
let headers = Header.add_list (Header.init ()) [
("x-api-key", "{{apiKey}}");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/clicks/pg",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'aliasId' => 'aBcDe012',
'dateFrom' => '2001-05-02',
'dateTo' => '2001-05-02',
'domain' => 'short.fyi',
'lastId' => 100
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json",
"x-api-key: {{apiKey}}"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/clicks/pg', [
'body' => '{
"aliasId": "aBcDe012",
"dateFrom": "2001-05-02",
"dateTo": "2001-05-02",
"domain": "short.fyi",
"lastId": 100
}',
'headers' => [
'content-type' => 'application/json',
'x-api-key' => '{{apiKey}}',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/clicks/pg');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'x-api-key' => '{{apiKey}}',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'aliasId' => 'aBcDe012',
'dateFrom' => '2001-05-02',
'dateTo' => '2001-05-02',
'domain' => 'short.fyi',
'lastId' => 100
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'aliasId' => 'aBcDe012',
'dateFrom' => '2001-05-02',
'dateTo' => '2001-05-02',
'domain' => 'short.fyi',
'lastId' => 100
]));
$request->setRequestUrl('{{baseUrl}}/clicks/pg');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'x-api-key' => '{{apiKey}}',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/clicks/pg' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"aliasId": "aBcDe012",
"dateFrom": "2001-05-02",
"dateTo": "2001-05-02",
"domain": "short.fyi",
"lastId": 100
}'
$headers=@{}
$headers.Add("x-api-key", "{{apiKey}}")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/clicks/pg' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"aliasId": "aBcDe012",
"dateFrom": "2001-05-02",
"dateTo": "2001-05-02",
"domain": "short.fyi",
"lastId": 100
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}"
headers = {
'x-api-key': "{{apiKey}}",
'content-type': "application/json"
}
conn.request("POST", "/baseUrl/clicks/pg", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/clicks/pg"
payload = {
"aliasId": "aBcDe012",
"dateFrom": "2001-05-02",
"dateTo": "2001-05-02",
"domain": "short.fyi",
"lastId": 100
}
headers = {
"x-api-key": "{{apiKey}}",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/clicks/pg"
payload <- "{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, add_headers('x-api-key' = '{{apiKey}}'), content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/clicks/pg")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '{{apiKey}}'
request["content-type"] = 'application/json'
request.body = "{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/clicks/pg') do |req|
req.headers['x-api-key'] = '{{apiKey}}'
req.body = "{\n \"aliasId\": \"aBcDe012\",\n \"dateFrom\": \"2001-05-02\",\n \"dateTo\": \"2001-05-02\",\n \"domain\": \"short.fyi\",\n \"lastId\": 100\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/clicks/pg";
let payload = json!({
"aliasId": "aBcDe012",
"dateFrom": "2001-05-02",
"dateTo": "2001-05-02",
"domain": "short.fyi",
"lastId": 100
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-api-key", "{{apiKey}}".parse().unwrap());
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/clicks/pg \
--header 'content-type: application/json' \
--header 'x-api-key: {{apiKey}}' \
--data '{
"aliasId": "aBcDe012",
"dateFrom": "2001-05-02",
"dateTo": "2001-05-02",
"domain": "short.fyi",
"lastId": 100
}'
echo '{
"aliasId": "aBcDe012",
"dateFrom": "2001-05-02",
"dateTo": "2001-05-02",
"domain": "short.fyi",
"lastId": 100
}' | \
http POST {{baseUrl}}/clicks/pg \
content-type:application/json \
x-api-key:'{{apiKey}}'
wget --quiet \
--method POST \
--header 'x-api-key: {{apiKey}}' \
--header 'content-type: application/json' \
--body-data '{\n "aliasId": "aBcDe012",\n "dateFrom": "2001-05-02",\n "dateTo": "2001-05-02",\n "domain": "short.fyi",\n "lastId": 100\n}' \
--output-document \
- {{baseUrl}}/clicks/pg
import Foundation
let headers = [
"x-api-key": "{{apiKey}}",
"content-type": "application/json"
]
let parameters = [
"aliasId": "aBcDe012",
"dateFrom": "2001-05-02",
"dateTo": "2001-05-02",
"domain": "short.fyi",
"lastId": 100
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/clicks/pg")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()