Skip to main content
POST
/
connection
Create Connection
curl --request POST \
  --url https://api.pathstack.io/connection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "credentials": {},
  "business_name": "<string>",
  "abn": "<string>",
  "email": "<string>",
  "active": true,
  "collection_start_time": "2023-11-07T05:31:56Z",
  "collection_end_time": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ]
}
'
import requests

url = "https://api.pathstack.io/connection"

payload = {
"credentials": {},
"business_name": "<string>",
"abn": "<string>",
"email": "<string>",
"active": True,
"collection_start_time": "2023-11-07T05:31:56Z",
"collection_end_time": "2023-11-07T05:31:56Z",
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
credentials: {},
business_name: '<string>',
abn: '<string>',
email: '<string>',
active: true,
collection_start_time: '2023-11-07T05:31:56Z',
collection_end_time: '2023-11-07T05:31:56Z',
tags: ['<string>']
})
};

fetch('https://api.pathstack.io/connection', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pathstack.io/connection",
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([
'credentials' => [

],
'business_name' => '<string>',
'abn' => '<string>',
'email' => '<string>',
'active' => true,
'collection_start_time' => '2023-11-07T05:31:56Z',
'collection_end_time' => '2023-11-07T05:31:56Z',
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.pathstack.io/connection"

payload := strings.NewReader("{\n \"credentials\": {},\n \"business_name\": \"<string>\",\n \"abn\": \"<string>\",\n \"email\": \"<string>\",\n \"active\": true,\n \"collection_start_time\": \"2023-11-07T05:31:56Z\",\n \"collection_end_time\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.pathstack.io/connection")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": {},\n \"business_name\": \"<string>\",\n \"abn\": \"<string>\",\n \"email\": \"<string>\",\n \"active\": true,\n \"collection_start_time\": \"2023-11-07T05:31:56Z\",\n \"collection_end_time\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.pathstack.io/connection")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": {},\n \"business_name\": \"<string>\",\n \"abn\": \"<string>\",\n \"email\": \"<string>\",\n \"active\": true,\n \"collection_start_time\": \"2023-11-07T05:31:56Z\",\n \"collection_end_time\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "business_name": "<string>",
    "abn": "<string>",
    "email": "<string>",
    "active": true,
    "id": "<string>",
    "tenant_id": "<string>",
    "collection_start_time": "2023-11-07T05:31:56Z",
    "collection_end_time": "2023-11-07T05:31:56Z",
    "configuration": {}
  }
}
{
"error": {
"code": 400,
"message": "Invalid JWT format"
}
}
{
"error": {
"code": 401,
"message": "Authentication header is missing, or token is invalid/expired."
}
}
{
"error": {
"code": 403,
"message": "You do not have access to this resource"
}
}
{
"error": {
"code": 422,
"message": "Field required",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version
string<date>
default:2024-03-26

Body

application/json
integration_name
enum<string>
required
Available options:
mtdata,
geotab,
navman,
mixtelematics,
radius,
verizon_connect,
volvo,
fleetsu,
digital_matter,
netstar,
netstar_v2,
webfleet,
scania,
linxio,
geoforce,
michelin_connected_fleet,
navixy,
netcorp,
mapon
credentials
Credentials · object
required
business_name
string | null
required
abn
string | null
required
email
string | null
required
active
boolean
required
collection_start_time
string<date-time> | null
collection_end_time
string<date-time> | null
tags
string[] | null

Response

Successful Response

data
ConnectionNoCredentials · object
required