Create Connection Group

Creates a new connection group. Pass an optional connections array to assign existing database and cloud storage connections to the group on creation. All referenced connections must belong to the same account.

POST /connection_groups

Create Connection Group

cURL

curl --request POST \
  --url https://api.xplenty.com/{account_id}/api/connection_groups \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_group": {
    "name": "<string>",
    "description": "<string>"
  },
  "connections": [
    {
      "id": 123,
      "type": "<string>"
    }
  ]
}
'

import requests

url = "https://api.xplenty.com/{account_id}/api/connection_groups"

payload = {
    "connection_group": {
        "name": "<string>",
        "description": "<string>"
    },
    "connections": [
        {
            "id": 123,
            "type": "<string>"
        }
    ]
}
headers = {
    "Accept": "<accept>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Accept: '<accept>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    connection_group: {name: '<string>', description: '<string>'},
    connections: [{id: 123, type: '<string>'}]
  })
};

fetch('https://api.xplenty.com/{account_id}/api/connection_groups', 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.xplenty.com/{account_id}/api/connection_groups",
  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([
    'connection_group' => [
        'name' => '<string>',
        'description' => '<string>'
    ],
    'connections' => [
        [
                'id' => 123,
                'type' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Accept: <accept>",
    "Authorization: Basic <encoded-value>",
    "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.xplenty.com/{account_id}/api/connection_groups"

	payload := strings.NewReader("{\n  \"connection_group\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\"\n  },\n  \"connections\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("Accept", "<accept>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.xplenty.com/{account_id}/api/connection_groups")
  .header("Accept", "<accept>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_group\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\"\n  },\n  \"connections\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.xplenty.com/{account_id}/api/connection_groups")

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

request = Net::HTTP::Post.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection_group\": {\n    \"name\": \"<string>\",\n    \"description\": \"<string>\"\n  },\n  \"connections\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "account_id": 123,
  "modified_by": {
    "name": "<string>",
    "email": "<string>"
  },
  "connections": [
    {
      "id": 123,
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

Accept · string · default: application/vnd.xplenty+json; version=2 · required

API version header — required on all requests

Body

application/json

connection_group · object · required

Show child attributes

connections · object[]

Connections to attach to the new group.

Show child attributes

Response

201 - application/vnd.xplenty+json; version=2

Connection group created

id · integer

name · string

description · string | null

account_id · integer

modified_by · object

User who last modified the group.

Show child attributes

connections · object[]

Database and cloud storage connections assigned to this group.

Show child attributes

created_at · string<date-time>

updated_at · string<date-time>