Create Connection

posthttps://api.flxpoint.com/connections

Use this when you want to create connection data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Endpoint to create a Connection.

Requires Account-level privileges.

Request

Bodyapplication/json

connectionTypestring

namestring

configsarray[ConnectionConfigUpdateRequest]

handlestring

valuestring

Example request

post/connections

curl -X POST "https://api.flxpoint.com/connections" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "connectionType": "string",
         "name": "string",
         "configs": [
           {
             "handle": "string",
             "value": "string"
           }
         ]
       }'

Example body · application/json

{
  "connectionType": "string",
  "name": "string",
  "configs": [
    {
      "handle": "string",
      "value": "string"
    }
  ]
}

Responses

200OKapplication/json

idinteger

connectionTypestring

connectionTypeIdinteger

connectionTypeNamestring

requiresConnectionToTestbooleandeprecated

namestring

configsarray[ConnectionConfig]

handlestring

namestring

requiredboolean

editableboolean

dataTypestring

defaultValuestring

optionsarray[ConnectionConfigOption]

valuestring

labelstring

advancedboolean

valuestring

hiddenboolean

descriptionstring

sortOrderinteger

Example response

{
  "id": 0,
  "connectionType": "string",
  "connectionTypeId": 0,
  "connectionTypeName": "string",
  "requiresConnectionToTest": true,
  "name": "string",
  "configs": [
    {
      "handle": "string",
      "name": "string",
      "required": true,
      "editable": true,
      "dataType": "string",
      "defaultValue": "string",
      "options": [
        {
          "value": null,
          "label": null
        }
      ],
      "advanced": true,
      "value": "string",
      "hidden": true,
      "description": "string",
      "sortOrder": 0
    }
  ]
}

401Unauthorized

No schema documented for this status.

OpenAPI fragment

{
  "post": {
    "summary": "Create Connection",
    "description": "Endpoint to create a Connection. \n\nRequires Account-level privileges. ",
    "parameters": [],
    "requestBody": {
      "description": "",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ConnectionUpdateRequest"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Connection"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight