API Reference

Management API

The Synqly Management APIs enable you to manage the resources within your Synqly organization, such as setting up Accounts for your customers and creating Integrations to connect your product to the different service Providers supported by Synqly.

For more information see the Synqly Overview.

Download OpenAPI description

management.json

management.yaml

Servers

Synqly

https://api.synqly.com/

Accounts

Accounts under your Organization are used to manage Integrations, Credentials, and other account specific resources. Accounts are secure containers and may be used to represent tenants in your system. Data is never shared across accounts.

For more information on Accounts, see the Synqly Overview.

Operations

Audit

Operations

Auth

Operations

Bridges

Operations

List Bridge Groups

Request

Returns a list of all Bridge Group objects that match the query params.

Path

accountIdstring(Id)required

Query

limitinteger or null

Number of Bridge objects to return in this page. Defaults to 100.

start_afterstring or null

Return Bridge objects starting after this name.

orderArray of strings or null

Select a field to order the results by. Defaults to name. To control the direction of the sorting, append [asc] or [desc] to the field name. For example, name[desc] will sort the results by name in descending order. The ordering defaults to asc if not specified. May be used multiple times to order by multiple fields, and the ordering is applied in the order the fields are specified.

filterArray of strings or null

Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together.

curl -i -X GET \
  'https://api.synqly.com/v1/bridges/{accountId}?filter=string&limit=0&order=string&start_after=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultArray of objects(BridgeGroup)required

result[].idstring(Id)required

result[].fullnamestringrequired

Full name of bridge

result[].namestringrequired

Human-readable name for this resource

result[].created_atstring(date-time)required

Time object was originally created

result[].updated_atstring(date-time)required

Last time object was updated

result[].descriptionstring or null

Description of the resources included in the bridge and permissions granted on those resources. Includes details of when to use this bridge along with the intended personas.

result[].labelsArray of strings or null

Labels applied to Bridges within the group. These labels can be used by integrations to select the groups of bridges capable of handling requests to the integration.

Response

application/json

{
  "result": [
    { … }
  ]
}

Create Bridge Group

Request

Creates a Bridge Group with a unique identifier and authentication credentials. This allows for Bridge Agents to connect to Synqly. For more information on Bridges, refer to our Synqly Overview.

Path

accountIdstring(Id)required

Bodyapplication/jsonrequired

namestring or null

Unique short name for this Bridge (lowercase [a-z0-9_-], can be used in URLs). Also used for case insensitive duplicate name detection and default sort order. Defaults to BridgeGroupId if both name and fullname are not specified.

fullnamestring or null

Human friendly display name for this Bridge, will auto-generate 'name' field (if 'name' is not specified). Defaults to the same value as the 'name' field if not specified.

descriptionstring or null

Description of the resources included in the bridge and permissions granted on those resources. Includes details of when to use this bridge along with the intended personas.

labelsArray of strings or null

Bridge selection labels

curl -i -X POST \
  'https://api.synqly.com/v1/bridges/{accountId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "fullname": "string",
    "description": "string",
    "labels": [
      "string"
    ]
  }'

Responses

Bodyapplication/json

resultobject(CreateBridgeResponseResult)required

result.bridgeobject(BridgeGroup)required

A Bridge Group represents a connection between the Synqly Saas or Embedded service and a Bridge Agent. See 'Synqly Bridge Agent' guide in Synqly docs for additional information.

result.bridge.idstring(Id)required

result.bridge.fullnamestringrequired

Full name of bridge

result.bridge.namestringrequired

Human-readable name for this resource

result.bridge.created_atstring(date-time)required

Time object was originally created

result.bridge.updated_atstring(date-time)required

Last time object was updated

result.bridge.descriptionstring or null

Description of the resources included in the bridge and permissions granted on those resources. Includes details of when to use this bridge along with the intended personas.

result.bridge.labelsArray of strings or null

Labels applied to Bridges within the group. These labels can be used by integrations to select the groups of bridges capable of handling requests to the integration.

result.credentialstringrequired

JWT for the Bridge Group to connect to Synqly. This must be saved in a file {bridgeId}.creds in the same directory as the bridge executable.

Response

application/json

{
  "result": {
    "bridge": { … },
    "credential": "string"
  }
}

Get Bridge Groups

Request

Returns the Bridge Group object matching {bridgeId}. For more information on Bridges, refer to the Bridge Overview.

Path

accountIdstring(Id)required

bridgeIdstring(Id)required

curl -i -X GET \
  'https://api.synqly.com/v1/bridges/{accountId}/{bridgeId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultobject(BridgeGroup)required

A Bridge Group represents a connection between the Synqly Saas or Embedded service and a Bridge Agent. See 'Synqly Bridge Agent' guide in Synqly docs for additional information.

result.idstring(Id)required

result.fullnamestringrequired

Full name of bridge

result.namestringrequired

Human-readable name for this resource

result.created_atstring(date-time)required

Time object was originally created

result.updated_atstring(date-time)required

Last time object was updated

result.descriptionstring or null

Description of the resources included in the bridge and permissions granted on those resources. Includes details of when to use this bridge along with the intended personas.

result.labelsArray of strings or null

Labels applied to Bridges within the group. These labels can be used by integrations to select the groups of bridges capable of handling requests to the integration.

Response

application/json

{
  "result": {
    "id": "string",
    "fullname": "string",
    "description": "string",
    "labels": [ … ],
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Update Bridge Group

Request

Updates the Bridge Group object matching {bridgeId}. For more information on Bridges, refer to our Synqly Overview.

Path

accountIdstring(Id)required

bridgeIdstring(Id)required

Bodyapplication/jsonrequired

idstring(Id)required

fullnamestringrequired

Full name of bridge

namestringrequired

Human-readable name for this resource

created_atstring(date-time)required

Time object was originally created

updated_atstring(date-time)required

Last time object was updated

descriptionstring or null

Description of the resources included in the bridge and permissions granted on those resources. Includes details of when to use this bridge along with the intended personas.

labelsArray of strings or null

Labels applied to Bridges within the group. These labels can be used by integrations to select the groups of bridges capable of handling requests to the integration.

curl -i -X PUT \
  'https://api.synqly.com/v1/bridges/{accountId}/{bridgeId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "fullname": "string",
    "description": "string",
    "labels": [
      "string"
    ],
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }'

Responses

Bodyapplication/json

resultobject(BridgeGroup)required

A Bridge Group represents a connection between the Synqly Saas or Embedded service and a Bridge Agent. See 'Synqly Bridge Agent' guide in Synqly docs for additional information.

result.idstring(Id)required

result.fullnamestringrequired

Full name of bridge

result.namestringrequired

Human-readable name for this resource

result.created_atstring(date-time)required

Time object was originally created

result.updated_atstring(date-time)required

Last time object was updated

result.descriptionstring or null

Description of the resources included in the bridge and permissions granted on those resources. Includes details of when to use this bridge along with the intended personas.

result.labelsArray of strings or null

Labels applied to Bridges within the group. These labels can be used by integrations to select the groups of bridges capable of handling requests to the integration.

Response

application/json

{
  "result": {
    "id": "string",
    "fullname": "string",
    "description": "string",
    "labels": [ … ],
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Patch Bridge Group

Request

Patches the Bridge Group object matching {bridgeId}. For more information on Bridges, refer to our Synqly Overview.

Path

accountIdstring(Id)required

bridgeIdstring(Id)required

Bodyapplication/jsonrequiredArray [

opstring(PatchOp)required

Enum"add""copy""move""remove""replace""test"

pathstringrequired

The path to the field to update. The path is a JSON Pointer.

fromstring or null

The path to the field to copy from. This is required for copy and move operations.

valueany or null

The value to set the field to. This is required for add, replace and test operations.

]

curl -i -X PATCH \
  'https://api.synqly.com/v1/bridges/{accountId}/{bridgeId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "from": "string",
      "value": null
    }
  ]'

Responses

Bodyapplication/json

resultobject(BridgeGroup)required

A Bridge Group represents a connection between the Synqly Saas or Embedded service and a Bridge Agent. See 'Synqly Bridge Agent' guide in Synqly docs for additional information.

result.idstring(Id)required

result.fullnamestringrequired

Full name of bridge

result.namestringrequired

Human-readable name for this resource

result.created_atstring(date-time)required

Time object was originally created

result.updated_atstring(date-time)required

Last time object was updated

result.descriptionstring or null

Description of the resources included in the bridge and permissions granted on those resources. Includes details of when to use this bridge along with the intended personas.

result.labelsArray of strings or null

Labels applied to Bridges within the group. These labels can be used by integrations to select the groups of bridges capable of handling requests to the integration.

Response

application/json

{
  "result": {
    "id": "string",
    "fullname": "string",
    "description": "string",
    "labels": [ … ],
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Delete Bridge Group

Request

Deletes the Bridge Group matching {bridgeId}. Deleting an Bridge Group also deletea all Tokens and Credentials belonging to the Bridge Group.

Path

accountIdstring(Id)required

bridgeIdstring(Id)required

curl -i -X DELETE \
  'https://api.synqly.com/v1/bridges/{accountId}/{bridgeId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

Get Bridge Agent Statuses

Request

Returns the status and local configuration of running Bridges Agents in the Bridge Group {bridgeId}.

Path

accountIdstring(Id)required

bridgeIdstring(Id)required

curl -i -X GET \
  'https://api.synqly.com/v1/bridges/{accountId}/{bridgeId}/status' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultArray of objects(BridgeStatus)required

result[].current_timestring(date-time)required

Local time on the Bridge when the status check was performed.

result[].response_durationstringrequired

Round trip time for the status check.

result[].local_configobject(BridgeLocalConfig)required

result[].local_config.versionstringrequired

Version of the Bridge.

result[].local_config.allow_addressesArray of stringsrequired

List of IP addresses that the Bridge is allowed to connect to.

result[].local_config.vaultobject or null

Vault configuration for the Bridge.

result[].local_statsobject(BridgeLocalStats)required

result[].local_stats.requestsinteger(int64)required

result[].local_stats.failuresinteger(int64)required

result[].local_stats.in_bytesinteger(int64)required

result[].local_stats.out_bytesinteger(int64)required

Response

application/json

{
  "result": [
    { … }
  ]
}

Capabilities

Operations

Credentials

Operations

Integration Points

An Integration Point describes a class of Integrations, and lets you describe names, allowed providers and other configuration that should apply to integrations associated with the Integration Point.

While an Integration can be created without associating it with an Integration Point, some Synqly features require the use of Integration Points, such as:

Connect UI
Validating allowed providers
Custom data mapping (coming soon)

Integration Points belong to the Organization, and can be associated with Integrations belonging to different Accounts.

For more information on Integration Points, see the Synqly Overview.

Operations

Integrations

An Integration represents the connection to a specific Provider. Once configured, an Integration enables interaction with the target Provider via our unified and normalized Connector APIs.

Each Integration belongs to an Account and may be associated with an Integration Point to provide additional features and configuration.

For more information on Integrations, see the Synqly Overview.

Operations

Members

Operations

Organization Webhooks

Operations

Organization

Operations

Permissionset

Operations

Roles

Operations

Status

Operations

Sub Orgs

Operations

Tokens

Operations

Transforms

Operations

Management API

Accounts

Audit

Auth

Bridges

List Bridge Groups

Request

Responses

Was this helpful?

Create Bridge Group

Request

Responses

Was this helpful?

Get Bridge Groups

Request

Responses

Was this helpful?

Update Bridge Group

Request

Responses

Was this helpful?

Patch Bridge Group

Request

Responses

Was this helpful?

Delete Bridge Group

Request

Responses

Was this helpful?

Get Bridge Agent Statuses

Request

Responses

Was this helpful?

Capabilities

Credentials

Integration Points

Integrations

Members

Meta

Operations

Organization Webhooks

Organization

Permissionset

Roles

Status

Sub Orgs

Tokens

Transforms