CONNECTION-GROUPS.md

Connection Groups

Manage connection groups.

Table of Contents

• List Connection Groups
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• List Connections and Connection Groups
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Details of Connection Group
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Details of Connection Group Tree
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Update Connection Group
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Create Connection Group
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Delete Connection Group
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body

List Connection Groups

List connection groups.

GET /api/session/data/{{data_source}}/connectionGroups

Headers

None.

Path Parameters

• data_source (string, required) - Data source

Query Parameters

• token (string, required) - Auth Token

Request Body

None.

Response

Status Code

• 200 - OK

Response Body

@TODO

---

List Connections and Connection Groups

List connection groups with connections.

GET /api/session/data/{{data_source}}/connectionGroups/ROOT/tree

Headers

None.

Path Parameters

• data_source (string, required) - Data source

Query Parameters

• token (string, required) - Auth Token

Request Body

None.

Response

Status Code

• 200 - OK

Response Body

@TODO

---

Details of Connection Group

Details of connection group.

GET /api/session/data/{{data_source}}/connectionGroups/{{connection_group}}

Headers

None.

Path Parameters

• data_source (string, required) - Data source
• connection_group (integer, required) - Connection group identifier

Query Parameters

• token (string, required) - Auth Token

Request Body

None.

Response

Status Code

• 200 - OK

Response Body

@TODO

---

Details of Connection Group Tree

Details of connection group tree.

GET /api/session/data/{{data_source}}/connectionGroups/{{connection_group}}/tree

Headers

None.

Path Parameters

• data_source (string, required) - Data source
• connection_group (integer, required) - Connection group identifier

Query Parameters

• token (string, required) - Auth Token
• permission (string, optional) - Permission

Request Body

None.

Response

Status Code

• 200 - OK

Response Body

@TODO

---

Update Connection Group

Updates connection group.

PUT /api/session/data/{{data_source}}/connectionGroups/{{connection_group}}

Headers

• Content-Type (string, required) - application/json

Path Parameters

• data_source (string, required) - Data source
• connection_group (integer, required) - Connection group identifier

Query Parameters

• token (string, required) - Auth Token

Request Body

@TODO

{
  "name": "test",
  "identifier": "1",
  "parentIdentifier": "ROOT",
  "type": "ORGANIZATIONAL",
  "activeConnections": 0,
  "attributes": {
    "max-connections": "",
    "max-connections-per-user": "",
    "enable-session-affinity": ""
  }
}

Response

Status Code

• 204 - No Content

Response Body

This request does not return a response body.

---

Create Connection Group

Creates connection group.

POST /api/session/data/{{data_source}}/connectionGroups

Headers

• Content-Type (string, required) - application/json

Path Parameters

• data_source (string, required) - Data source

Query Parameters

• token (string, required) - Auth Token

Request Body

@TODO

{
  "parentIdentifier": "1",
  "name": "name",
  "type": "ORGANIZATIONAL",
  "attributes": {
    "max-connections": "",
    "max-connections-per-user": "",
    "enable-session-affinity": ""
  }
}

Response

Status Code

• 200 - OK

Response Body

@TODO

---

Delete Connection Group

Delete connection group.

DELETE /api/session/data/{{data_source}}/connectionGroups/{{connection_group}}

Headers

None.

Path Parameters

• data_source (string, required) - Data source
• connection_group (string, required) - Connection groups identifier

Query Parameters

• token (string, required) - Auth token

Request Body

None.

Response

Status Code

• 204 - No Content

Response Body

This request does not return a response body.

---

Back to Top