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.
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.
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:
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.
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.
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/integration_points?filter=string&limit=0&order=string&start_after=string&total=true' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Id of the Integrations category
List of allowed providers for test environment.
List of allowed providers for production environment.
Name of integration point, will be shown to end-users in the Connect UI.
Optional description of the Integration Point. Will not be displayed to end-users of Connect UI.
{ "result": [ { … } ], "total": 0 }
Id of the Integrations category
List of allowed providers for test environment.
List of allowed providers for production environment.
Unique short name for this Integration Point (lowercase [a-z0-9_-], can be used in URLs). Also used for case insensitive duplicate name detection and default sort order. Defaults to IntegrationPointId if both name and fullname are not specified.
Name of integration point, will be shown to end-users in the Connect UI. Defaults to the same value as the 'name' field if not specified.
Optional description of the Integration Point. Will not be displayed to end-users of Connect UI.
curl -i -X POST \
https://api.synqly.com/v1/integration_points \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"fullname": "string",
"description": "string",
"connector": "assets",
"environments": {
"test": [
"assets_armis_centrix"
],
"prod": [
"assets_armis_centrix"
]
},
"additional_mappings": [
{
"providers": [
"assets_armis_centrix"
],
"mapping_type": "recommended",
"resource": "devices",
"actions": [
"query"
],
"source": "string",
"destination": "string",
"literal": true,
"data_type": "string"
}
]
}'Enables creation, editing and deletion of Integrations.
Id of the Integrations category
List of allowed providers for test environment.
List of allowed providers for production environment.
Name of integration point, will be shown to end-users in the Connect UI.
Optional description of the Integration Point. Will not be displayed to end-users of Connect UI.
{ "result": { "id": "string", "fullname": "string", "description": "string", "connector": "assets", "environments": { … }, "additional_mappings": [ … ], "name": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } }
curl -i -X GET \
'https://api.synqly.com/v1/integration_points/{integrationPointId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Enables creation, editing and deletion of Integrations.
Id of the Integrations category
List of allowed providers for test environment.
List of allowed providers for production environment.
Name of integration point, will be shown to end-users in the Connect UI.
Optional description of the Integration Point. Will not be displayed to end-users of Connect UI.
{ "result": { "id": "string", "fullname": "string", "description": "string", "connector": "assets", "environments": { … }, "additional_mappings": [ … ], "name": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } }
Id of the Integrations category
List of allowed providers for test environment.
List of allowed providers for production environment.
Optional description of the Integration Point. Will not be displayed to end-users of Connect UI.
curl -i -X PUT \
'https://api.synqly.com/v1/integration_points/{integrationPointId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"id": "string",
"fullname": "string",
"description": "string",
"connector": "assets",
"environments": {
"test": [
"assets_armis_centrix"
],
"prod": [
"assets_armis_centrix"
]
},
"additional_mappings": [
{
"providers": [
"assets_armis_centrix"
],
"mapping_type": "recommended",
"resource": "devices",
"actions": [
"query"
],
"source": "string",
"destination": "string",
"literal": true,
"data_type": "string"
}
],
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}'Enables creation, editing and deletion of Integrations.
Id of the Integrations category
List of allowed providers for test environment.
List of allowed providers for production environment.
Name of integration point, will be shown to end-users in the Connect UI.
Optional description of the Integration Point. Will not be displayed to end-users of Connect UI.
{ "result": { "id": "string", "fullname": "string", "description": "string", "connector": "assets", "environments": { … }, "additional_mappings": [ … ], "name": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } }
The path to the field to copy from. This is required for copy and move operations.
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/integration_points/{integrationPointId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"from": "string",
"value": null
}
]'Enables creation, editing and deletion of Integrations.
Id of the Integrations category
List of allowed providers for test environment.
List of allowed providers for production environment.
Name of integration point, will be shown to end-users in the Connect UI.
Optional description of the Integration Point. Will not be displayed to end-users of Connect UI.
{ "result": { "id": "string", "fullname": "string", "description": "string", "connector": "assets", "environments": { … }, "additional_mappings": [ … ], "name": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } }
curl -i -X DELETE \
'https://api.synqly.com/v1/integration_points/{integrationPointId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'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.