API Reference
/
Management API
/
Capabilities

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
Languages
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

Capabilities

Operations

List Connectors

Request

Returns a list of all Connectors.

Query
expandArray of strings(ListConnectorCapabilitiesExpandOptions)

Expand the capabilities result fields that are otherwise omitted or returned as references to OpenAPI spec components. NOTE: This can yield very big response objects.

Items Value"providers"
curl -i -X GET \
  'https://api.synqly.com/v1/capabilities/connectors?expand=providers' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objects(Connector)required
result[].​idstring(CategoryId)required

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"
result[].​namestring(CategoryId)required

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"
result[].​fullnamestringrequired

Display name of the Connector.

result[].​descriptionstringrequired

Description of the Connector.

result[].​provider_idsArray of strings(ProviderId)required

List of Providers that implement the Connector.

result[].​providersArray of objects or null(ProviderCapabilities)

List of capabilities for Providers that implement the Connector.

result[].​connectorstring(CategoryId)

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"
Response
application/json
{
  "result": [
    { … }
  ]
}

List Providers

Request

Returns a list of all Provider capabilities and their configurations.

Query
expandArray of strings(ListProviderCapabilitiesExpandOptions)

Expand the capabilities result fields that are otherwise omitted or returned as references to OpenAPI spec components. NOTE: This can yield very big response objects.

Items Enum"connector""operations""provider_config"
curl -i -X GET \
  'https://api.synqly.com/v1/capabilities/providers?expand=connector' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objects(ProviderCapabilities)required
result[].​idstring(ProviderId)required
result[].​namestringrequired

Name of the Provider.

result[].​fullnamestringrequired

Display name of the Provider.

result[].​descriptionstringrequired

Description of the Provider.

result[].​connector_idstring(CategoryId)required

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"
result[].​connectorCategoryId (string) or Connector (object)(ConnectorOrId)
One of:

Id of the Integrations category

string(CategoryId)

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"
result[].​operationsArray of objects or null(ProviderOperations)

Operations that the Provider implements.

result[].​provider_configany or null

Details on the specific configuration options for the Provider.

result[].​releaseobject(ProviderRelease)
Response
application/json
{
  "result": [
    { … }
  ]
}

Get Provider

Request

Returns the capabilities and configurations for a specific Provider type

Path
providerIdstring(ProviderConfigId)required

List of supported providers.

Enum"assets_armis_centrix""assets_nozomi_vantage""assets_servicenow""assets_servicenow_mock""edr_crowdstrike""edr_defender""edr_malwarebytes""edr_sentinelone""edr_sophos""identity_entra_id"
Query
expandArray of strings(GetProviderCapabilitiesExpandOptions)

Expand the capabilities result fields that are otherwise omitted or returned as references to OpenAPI spec components. NOTE: This can yield very big response objects.

Items Enum"connector""operations""request_body""provider_config"
curl -i -X GET \
  'https://api.synqly.com/v1/capabilities/providers/{providerId}?expand=connector' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultobject(ProviderCapabilities)required
result.​idstring(ProviderId)required
result.​namestringrequired

Name of the Provider.

result.​fullnamestringrequired

Display name of the Provider.

result.​descriptionstringrequired

Description of the Provider.

result.​connector_idstring(CategoryId)required

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"
result.​connectorCategoryId (string) or Connector (object)(ConnectorOrId)
One of:

Id of the Integrations category

string(CategoryId)

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"
result.​operationsArray of objects or null(ProviderOperations)

Operations that the Provider implements.

result.​provider_configany or null

Details on the specific configuration options for the Provider.

result.​releaseobject(ProviderRelease)
Response
application/json
{
  "result": {
    "id": "string",
    "name": "string",
    "fullname": "string",
    "description": "string",
    "connector_id": "assets",
    "connector": "assets",
    "operations": [ … ],
    "provider_config": null,
    "release": { … }
  }
}

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

Meta

Operations

Operations (In Development)

In Development

This feature is actively being developed. Breaking changes should be expected.

Please contact us before using this feature.

Operations

Organization Webhooks

Operations

Organization

Operations

Permissionset

Operations

Roles

Operations

Status

Operations

Sub Orgs

Operations

Tokens

Operations

Transforms

Operations