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

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

List Integrations

Request

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

Query

limitinteger or null

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

start_afterstring or null

Return Integration 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.

expandArray of strings(ListIntegrationOptions)

Expand the integration result with the related integration point and/or account information.

Items Enum"account""accounts""integration_point""integration_points""all"

totalboolean or null

Return total number of all integrations in the system, respecting all applied filters. This is expensive, use sparingly.

curl -i -X GET \
  'https://api.synqly.com/v1/integrations?expand=account&filter=string&limit=0&order=string&start_after=string&total=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultArray of objects(Integration)required

result[].idstring(Id)required

result[].fullnamestringrequired

Human friendly display name for this integration.

result[].refresh_token_idstring(Id)required

result[].account_idstring(Id)required

result[].categorystring(CategoryId)required

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"

result[].provider_configArmis Centrix (object) or Nozomi Vantage (object) or ServiceNow CMDB (object) or [MOCK] ServiceNow CMDB (object) or CrowdStrike EDR (object) or Defender EDR (object) or Malwarebytes EDR (object) or SentinelOne EDR (object) or Sophos EDR (object) or Microsoft Entra ID (object) or Google Workspace (object) or Okta (object) or PingOne Identity (object) or Jira (object) or Notifications Test (object) or Slack (object) or Microsoft Teams (object) or Elasticsearch (object) or Google Chronicle (object) or SIEM Test (object) or IBM QRadar (object) or Rapid7 InsightIDR (object) or Microsoft Sentinel (object) or Splunk (object) or Sumo Logic Cloud SIEM (object) or AWS Security Lake (object) or AWS SQS (object) or Azure Monitor Logs (object) or Crowdstrike HEC (object) or Elasticsearch (object) or Sink Test (object) or Splunk (object) or AWS S3 (object) or Azure Blob Storage (object) or Google Cloud Storage (object) or Storage Test (object) or Autotask (object) or Jira (object) or Ticketing Test (object) or PagerDuty (object) or ServiceNow ITSM (object) or ServiceNow SIR (object) or Torq (object) or CrowdStrike Spotlight (object) or Nucleus Vulnerability Management (object) or Qualys VMDR (object) or Rapid7 InsightVM Cloud (object) or Tanium Vulnerability Management (object) or Tenable Vulnerability Management (object)(ProviderConfig)required

One of:

Configuration for the Armis Centrix Assets Provider

result[].provider_config.typestringrequired

Value"assets_armis_centrix"

result[].provider_config.credentialTokenCredential (object) or ArmisCredential (object)(ArmisCredential)required

One of:

Base type for all credential types

result[].provider_config.credential.typestringrequired

Value"token"

result[].provider_config.credential.secretstringrequired

Secret value of the token.

result[].provider_config.urlstringrequired

URL for the Armis Centrix API. This should be the base URL for the API, without any path components. For example, "https://tenant.armis.com".

result[].provider_fullnamestringrequired

Human friendly display name for the provider.

result[].provider_typestringrequired

Type of the provider for this Integration.

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[].accountobject(Account)

result[].integration_point_idstring(Id)

result[].integration_pointobject(IntegrationPoint)

Enables creation, editing and deletion of Integrations.

result[].bridge_selectorBridgeSelector (object) or BridgeSelector (object)(BridgeSelector)

One of:

result[].webhook_configobject(WebhookConfig)

result[].additional_mappingsArray of objects or null(AdditionalMapping)

Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response.

totalinteger or null

Response

application/json

{
  "result": [
    { … }
  ],
  "total": 0
}

List Account Integrations

Request

Returns a list of all Integration objects belonging to the Account matching {accountId}.

Path

accountIdstring(Id)required

Query

limitinteger or null

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

start_afterstring or null

Return Integration objects starting after this name.

orderArray of strings or null

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.

expandArray of strings(ListIntegrationOptions)

Expand the integration result with the related integration point and/or account information.

Items Enum"account""accounts""integration_point""integration_points""all"

totalboolean or null

Return total number of integrations for a particular account. This is expensive, use sparingly.

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

Responses

Bodyapplication/json

resultArray of objects(Integration)required

result[].idstring(Id)required

result[].fullnamestringrequired

Human friendly display name for this integration.

result[].refresh_token_idstring(Id)required

result[].account_idstring(Id)required

result[].categorystring(CategoryId)required

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"

One of:

Configuration for the Armis Centrix Assets Provider

result[].provider_config.typestringrequired

Value"assets_armis_centrix"

result[].provider_config.credentialTokenCredential (object) or ArmisCredential (object)(ArmisCredential)required

One of:

Base type for all credential types

result[].provider_config.credential.typestringrequired

Value"token"

result[].provider_config.credential.secretstringrequired

Secret value of the token.

result[].provider_config.urlstringrequired

URL for the Armis Centrix API. This should be the base URL for the API, without any path components. For example, "https://tenant.armis.com".

result[].provider_fullnamestringrequired

Human friendly display name for the provider.

result[].provider_typestringrequired

Type of the provider for this Integration.

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[].accountobject(Account)

result[].integration_point_idstring(Id)

result[].integration_pointobject(IntegrationPoint)

Enables creation, editing and deletion of Integrations.

result[].bridge_selectorBridgeSelector (object) or BridgeSelector (object)(BridgeSelector)

One of:

result[].webhook_configobject(WebhookConfig)

result[].additional_mappingsArray of objects or null(AdditionalMapping)

Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response.

totalinteger or null

Response

application/json

{
  "result": [
    { … }
  ],
  "total": 0
}

Create Integration

Request

Creates an Integration object belonging to the Account matching {accountId}. Configures the Integration with the Provider specified in the request. Returns an Integration token for use with Integration APIs.

Path

accountIdstring(Id)required

Bodyapplication/jsonrequired

provider_configArmis Centrix (object) or Nozomi Vantage (object) or ServiceNow CMDB (object) or [MOCK] ServiceNow CMDB (object) or CrowdStrike EDR (object) or Defender EDR (object) or Malwarebytes EDR (object) or SentinelOne EDR (object) or Sophos EDR (object) or Microsoft Entra ID (object) or Google Workspace (object) or Okta (object) or PingOne Identity (object) or Jira (object) or Notifications Test (object) or Slack (object) or Microsoft Teams (object) or Elasticsearch (object) or Google Chronicle (object) or SIEM Test (object) or IBM QRadar (object) or Rapid7 InsightIDR (object) or Microsoft Sentinel (object) or Splunk (object) or Sumo Logic Cloud SIEM (object) or AWS Security Lake (object) or AWS SQS (object) or Azure Monitor Logs (object) or Crowdstrike HEC (object) or Elasticsearch (object) or Sink Test (object) or Splunk (object) or AWS S3 (object) or Azure Blob Storage (object) or Google Cloud Storage (object) or Storage Test (object) or Autotask (object) or Jira (object) or Ticketing Test (object) or PagerDuty (object) or ServiceNow ITSM (object) or ServiceNow SIR (object) or Torq (object) or CrowdStrike Spotlight (object) or Nucleus Vulnerability Management (object) or Qualys VMDR (object) or Rapid7 InsightVM Cloud (object) or Tanium Vulnerability Management (object) or Tenable Vulnerability Management (object)(ProviderConfig)required

One of:

Configuration for the Armis Centrix Assets Provider

provider_config.typestringrequired

Value"assets_armis_centrix"

provider_config.credentialTokenCredential (object) or ArmisCredential (object)(ArmisCredential)required

One of:

Base type for all credential types

provider_config.credential.typestringrequired

Value"token"

provider_config.credential.secretstringrequired

Secret value of the token.

provider_config.urlstringrequired

URL for the Armis Centrix API. This should be the base URL for the API, without any path components. For example, "https://tenant.armis.com".

namestring or null

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

fullnamestring or null

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

integration_point_idstring(Id)

bridge_selectorBridgeSelector (object) or BridgeSelector (object)(BridgeSelector)

One of:

webhook_configobject(WebhookConfig)

additional_mappingsArray of objects or null(AdditionalMapping)

Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response.

curl -i -X POST \
  'https://api.synqly.com/v1/integrations/{accountId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "fullname": "string",
    "provider_config": {
      "type": "assets_armis_centrix",
      "credential": {
        "type": "token",
        "secret": "string"
      },
      "url": "string"
    },
    "integration_point_id": "string",
    "bridge_selector": {
      "type": "id",
      "value": "string"
    },
    "webhook_config": {
      "items": [
        {
          "webhook_url": "string",
          "event_filter": [
            "TicketCreated"
          ]
        }
      ]
    },
    "additional_mappings": [
      {
        "resource": "devices",
        "actions": [
          "query"
        ],
        "source": "string",
        "destination": "string",
        "literal": true,
        "data_type": "string"
      }
    ]
  }'

Responses

Bodyapplication/json

resultobject(CreateIntegrationResponseResult)required

result.integrationobject(Integration)required

Connects an Account to an external service

result.integration.idstring(Id)required

result.integration.fullnamestringrequired

Human friendly display name for this integration.

result.integration.refresh_token_idstring(Id)required

result.integration.account_idstring(Id)required

result.integration.categorystring(CategoryId)required

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"

result.integration.provider_configArmis Centrix (object) or Nozomi Vantage (object) or ServiceNow CMDB (object) or [MOCK] ServiceNow CMDB (object) or CrowdStrike EDR (object) or Defender EDR (object) or Malwarebytes EDR (object) or SentinelOne EDR (object) or Sophos EDR (object) or Microsoft Entra ID (object) or Google Workspace (object) or Okta (object) or PingOne Identity (object) or Jira (object) or Notifications Test (object) or Slack (object) or Microsoft Teams (object) or Elasticsearch (object) or Google Chronicle (object) or SIEM Test (object) or IBM QRadar (object) or Rapid7 InsightIDR (object) or Microsoft Sentinel (object) or Splunk (object) or Sumo Logic Cloud SIEM (object) or AWS Security Lake (object) or AWS SQS (object) or Azure Monitor Logs (object) or Crowdstrike HEC (object) or Elasticsearch (object) or Sink Test (object) or Splunk (object) or AWS S3 (object) or Azure Blob Storage (object) or Google Cloud Storage (object) or Storage Test (object) or Autotask (object) or Jira (object) or Ticketing Test (object) or PagerDuty (object) or ServiceNow ITSM (object) or ServiceNow SIR (object) or Torq (object) or CrowdStrike Spotlight (object) or Nucleus Vulnerability Management (object) or Qualys VMDR (object) or Rapid7 InsightVM Cloud (object) or Tanium Vulnerability Management (object) or Tenable Vulnerability Management (object)(ProviderConfig)required

One of:

Configuration for the Armis Centrix Assets Provider

result.integration.provider_config.typestringrequired

Value"assets_armis_centrix"

result.integration.provider_config.credentialTokenCredential (object) or ArmisCredential (object)(ArmisCredential)required

One of:

Base type for all credential types

result.integration.provider_config.credential.typestringrequired

Value"token"

result.integration.provider_config.credential.secretstringrequired

Secret value of the token.

result.integration.provider_config.urlstringrequired

URL for the Armis Centrix API. This should be the base URL for the API, without any path components. For example, "https://tenant.armis.com".

result.integration.provider_fullnamestringrequired

Human friendly display name for the provider.

result.integration.provider_typestringrequired

Type of the provider for this Integration.

result.integration.namestringrequired

Human-readable name for this resource

result.integration.created_atstring(date-time)required

Time object was originally created

result.integration.updated_atstring(date-time)required

Last time object was updated

result.integration.accountobject(Account)

result.integration.integration_point_idstring(Id)

result.integration.integration_pointobject(IntegrationPoint)

Enables creation, editing and deletion of Integrations.

result.integration.bridge_selectorBridgeSelector (object) or BridgeSelector (object)(BridgeSelector)

One of:

result.integration.webhook_configobject(WebhookConfig)

result.integration.additional_mappingsArray of objects or null(AdditionalMapping)

Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response.

result.tokenobject(TokenPair)required

result.token.accessobject(Token)required

result.token.access.secretstringrequired

Secret value for the token; used for authentication when making requests.

result.token.access.expiresstring(date-time)required

Time when this token expires and can no longer be used again.

result.token.access.permissionsobject(Permission)required

result.token.access.permissions.resource_idstring(Id)required

result.token.access.permissions.resource_typestringrequired

Type of the resource that this permission grants access to. Must be one of the following: "organization, "integration"

result.token.access.permissions.parent_idstring(Id)required

result.token.access.permissions.idstring(Id)required

result.token.access.permissions.organization_idstring(Id)required

result.token.access.permissions.member_idstring(Id)required

result.token.access.permissions.role_bindingArray of strings or null(RoleName)

Roles granted to this token.

result.token.access.permissions.adhoc_roleobject(AdhocRole)

result.token.access.permissions.root_organization_idstring(Id)

result.token.refreshobject(Token)required

result.token.refresh.secretstringrequired

Secret value for the token; used for authentication when making requests.

result.token.refresh.expiresstring(date-time)required

Time when this token expires and can no longer be used again.

result.token.refresh.permissionsobject(Permission)required

result.token.refresh.permissions.resource_idstring(Id)required

result.token.refresh.permissions.resource_typestringrequired

Type of the resource that this permission grants access to. Must be one of the following: "organization, "integration"

result.token.refresh.permissions.parent_idstring(Id)required

result.token.refresh.permissions.idstring(Id)required

result.token.refresh.permissions.organization_idstring(Id)required

result.token.refresh.permissions.member_idstring(Id)required

result.token.refresh.permissions.role_bindingArray of strings or null(RoleName)

Roles granted to this token.

result.token.refresh.permissions.adhoc_roleobject(AdhocRole)

result.token.refresh.permissions.root_organization_idstring(Id)

result.credentials_createdArray of objects or null(CredentialResponse)

Response

application/json

{
  "result": {
    "credentials_created": [ … ],
    "integration": { … },
    "token": { … }
  }
}

Get Integration

Request

Returns the Integration object matching {integrationId} where the Integration belongs to the Account matching {accountId}.

Path

accountIdstring(Id)required

integrationIdstring(Id)required

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

Responses

Bodyapplication/json

resultobject(Integration)required

Connects an Account to an external service

result.idstring(Id)required

result.fullnamestringrequired

Human friendly display name for this integration.

result.refresh_token_idstring(Id)required

result.account_idstring(Id)required

result.categorystring(CategoryId)required

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"

result.provider_configArmis Centrix (object) or Nozomi Vantage (object) or ServiceNow CMDB (object) or [MOCK] ServiceNow CMDB (object) or CrowdStrike EDR (object) or Defender EDR (object) or Malwarebytes EDR (object) or SentinelOne EDR (object) or Sophos EDR (object) or Microsoft Entra ID (object) or Google Workspace (object) or Okta (object) or PingOne Identity (object) or Jira (object) or Notifications Test (object) or Slack (object) or Microsoft Teams (object) or Elasticsearch (object) or Google Chronicle (object) or SIEM Test (object) or IBM QRadar (object) or Rapid7 InsightIDR (object) or Microsoft Sentinel (object) or Splunk (object) or Sumo Logic Cloud SIEM (object) or AWS Security Lake (object) or AWS SQS (object) or Azure Monitor Logs (object) or Crowdstrike HEC (object) or Elasticsearch (object) or Sink Test (object) or Splunk (object) or AWS S3 (object) or Azure Blob Storage (object) or Google Cloud Storage (object) or Storage Test (object) or Autotask (object) or Jira (object) or Ticketing Test (object) or PagerDuty (object) or ServiceNow ITSM (object) or ServiceNow SIR (object) or Torq (object) or CrowdStrike Spotlight (object) or Nucleus Vulnerability Management (object) or Qualys VMDR (object) or Rapid7 InsightVM Cloud (object) or Tanium Vulnerability Management (object) or Tenable Vulnerability Management (object)(ProviderConfig)required

One of:

Configuration for the Armis Centrix Assets Provider

result.provider_config.typestringrequired

Value"assets_armis_centrix"

result.provider_config.credentialTokenCredential (object) or ArmisCredential (object)(ArmisCredential)required

One of:

Base type for all credential types

result.provider_config.credential.typestringrequired

Value"token"

result.provider_config.credential.secretstringrequired

Secret value of the token.

result.provider_config.urlstringrequired

URL for the Armis Centrix API. This should be the base URL for the API, without any path components. For example, "https://tenant.armis.com".

result.provider_fullnamestringrequired

Human friendly display name for the provider.

result.provider_typestringrequired

Type of the provider for this Integration.

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.accountobject(Account)

result.integration_point_idstring(Id)

result.integration_pointobject(IntegrationPoint)

Enables creation, editing and deletion of Integrations.

result.bridge_selectorBridgeSelector (object) or BridgeSelector (object)(BridgeSelector)

One of:

result.webhook_configobject(WebhookConfig)

result.additional_mappingsArray of objects or null(AdditionalMapping)

Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response.

Response

application/json

{
  "result": {
    "id": "string",
    "fullname": "string",
    "refresh_token_id": "string",
    "account_id": "string",
    "account": { … },
    "category": "assets",
    "provider_config": { … },
    "provider_fullname": "string",
    "provider_type": "string",
    "integration_point_id": "string",
    "integration_point": { … },
    "bridge_selector": { … },
    "webhook_config": { … },
    "additional_mappings": [ … ],
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Update Integration

Request

Updates the Integration object matching {integrationId}, where the Integration belongs to the Account matching {accountId}.

Path

accountIdstring(Id)required

integrationIdstring(Id)required

Bodyapplication/jsonrequired

idstring(Id)required

fullnamestringrequired

Human friendly display name for this integration.

refresh_token_idstring(Id)required

account_idstring(Id)required

categorystring(CategoryId)required

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"

One of:

Configuration for the Armis Centrix Assets Provider

provider_config.typestringrequired

Value"assets_armis_centrix"

provider_config.credentialTokenCredential (object) or ArmisCredential (object)(ArmisCredential)required

One of:

Base type for all credential types

provider_config.credential.typestringrequired

Value"token"

provider_config.credential.secretstringrequired

Secret value of the token.

provider_config.urlstringrequired

URL for the Armis Centrix API. This should be the base URL for the API, without any path components. For example, "https://tenant.armis.com".

provider_fullnamestringrequired

Human friendly display name for the provider.

provider_typestringrequired

Type of the provider for this Integration.

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

accountobject(Account)

integration_point_idstring(Id)

integration_pointobject(IntegrationPoint)

Enables creation, editing and deletion of Integrations.

bridge_selectorBridgeSelector (object) or BridgeSelector (object)(BridgeSelector)

One of:

webhook_configobject(WebhookConfig)

additional_mappingsArray of objects or null(AdditionalMapping)

Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response.

curl -i -X PUT \
  'https://api.synqly.com/v1/integrations/{accountId}/{integrationId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "fullname": "string",
    "refresh_token_id": "string",
    "account_id": "string",
    "account": {
      "id": "string",
      "fullname": "string",
      "organization_id": "string",
      "environment": "test",
      "labels": [
        "string"
      ],
      "name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "category": "assets",
    "provider_config": {
      "type": "assets_armis_centrix",
      "credential": {
        "type": "token",
        "secret": "string"
      },
      "url": "string"
    },
    "provider_fullname": "string",
    "provider_type": "string",
    "integration_point_id": "string",
    "integration_point": {
      "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"
    },
    "bridge_selector": {
      "type": "id",
      "value": "string"
    },
    "webhook_config": {
      "items": [
        {
          "webhook_url": "string",
          "event_filter": [
            "TicketCreated"
          ]
        }
      ]
    },
    "additional_mappings": [
      {
        "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"
  }'

Responses

Bodyapplication/json

resultobject(Integration)required

Connects an Account to an external service

result.idstring(Id)required

result.fullnamestringrequired

Human friendly display name for this integration.

result.refresh_token_idstring(Id)required

result.account_idstring(Id)required

result.categorystring(CategoryId)required

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"

One of:

Configuration for the Armis Centrix Assets Provider

result.provider_config.typestringrequired

Value"assets_armis_centrix"

result.provider_config.credentialTokenCredential (object) or ArmisCredential (object)(ArmisCredential)required

One of:

Base type for all credential types

result.provider_config.credential.typestringrequired

Value"token"

result.provider_config.credential.secretstringrequired

Secret value of the token.

result.provider_config.urlstringrequired

URL for the Armis Centrix API. This should be the base URL for the API, without any path components. For example, "https://tenant.armis.com".

result.provider_fullnamestringrequired

Human friendly display name for the provider.

result.provider_typestringrequired

Type of the provider for this Integration.

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.accountobject(Account)

result.integration_point_idstring(Id)

result.integration_pointobject(IntegrationPoint)

Enables creation, editing and deletion of Integrations.

result.bridge_selectorBridgeSelector (object) or BridgeSelector (object)(BridgeSelector)

One of:

result.webhook_configobject(WebhookConfig)

result.additional_mappingsArray of objects or null(AdditionalMapping)

Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response.

Response

application/json

{
  "result": {
    "id": "string",
    "fullname": "string",
    "refresh_token_id": "string",
    "account_id": "string",
    "account": { … },
    "category": "assets",
    "provider_config": { … },
    "provider_fullname": "string",
    "provider_type": "string",
    "integration_point_id": "string",
    "integration_point": { … },
    "bridge_selector": { … },
    "webhook_config": { … },
    "additional_mappings": [ … ],
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Patch Integration

Request

Patches the Integration object matching {integrationId}, where the Integration belongs to the Account matching {accountId}.

Path

accountIdstring(Id)required

integrationIdstring(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/integrations/{accountId}/{integrationId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "from": "string",
      "value": null
    }
  ]'

Responses

Bodyapplication/json

resultobject(Integration)required

Connects an Account to an external service

result.idstring(Id)required

result.fullnamestringrequired

Human friendly display name for this integration.

result.refresh_token_idstring(Id)required

result.account_idstring(Id)required

result.categorystring(CategoryId)required

Id of the Integrations category

Enum"assets""edr""identity""notifications""siem""sink""storage""ticketing""vulnerabilities"

One of:

Configuration for the Armis Centrix Assets Provider

result.provider_config.typestringrequired

Value"assets_armis_centrix"

result.provider_config.credentialTokenCredential (object) or ArmisCredential (object)(ArmisCredential)required

One of:

Base type for all credential types

result.provider_config.credential.typestringrequired

Value"token"

result.provider_config.credential.secretstringrequired

Secret value of the token.

result.provider_config.urlstringrequired

URL for the Armis Centrix API. This should be the base URL for the API, without any path components. For example, "https://tenant.armis.com".

result.provider_fullnamestringrequired

Human friendly display name for the provider.

result.provider_typestringrequired

Type of the provider for this Integration.

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.accountobject(Account)

result.integration_point_idstring(Id)

result.integration_pointobject(IntegrationPoint)

Enables creation, editing and deletion of Integrations.

result.bridge_selectorBridgeSelector (object) or BridgeSelector (object)(BridgeSelector)

One of:

result.webhook_configobject(WebhookConfig)

result.additional_mappingsArray of objects or null(AdditionalMapping)

Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response.

Response

application/json

{
  "result": {
    "id": "string",
    "fullname": "string",
    "refresh_token_id": "string",
    "account_id": "string",
    "account": { … },
    "category": "assets",
    "provider_config": { … },
    "provider_fullname": "string",
    "provider_type": "string",
    "integration_point_id": "string",
    "integration_point": { … },
    "bridge_selector": { … },
    "webhook_config": { … },
    "additional_mappings": [ … ],
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Delete Integration

Request

Deletes the Integration object matching {integrationId}, where the Integrationbelongs to theAccountmatching{accountId}. Deleting an Integration` also deletes any tokens that belong to it.

Path

accountIdstring(Id)required

integrationIdstring(Id)required

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

Responses

Response

No content

Verify Integration

Request

Verifies an ephemeral Integration and provider configuration and tests the authentication and provider connectivity. The provider config credential IDs can utilize persistent IDs or use "#/n" reference IDs; where (n) is the zero based offset in the optional credentials list.

Path

accountIdstring(Id)required

Bodyapplication/jsonrequired

integrationobject(CreateIntegrationRequest)required

integration.provider_configArmis Centrix (object) or Nozomi Vantage (object) or ServiceNow CMDB (object) or [MOCK] ServiceNow CMDB (object) or CrowdStrike EDR (object) or Defender EDR (object) or Malwarebytes EDR (object) or SentinelOne EDR (object) or Sophos EDR (object) or Microsoft Entra ID (object) or Google Workspace (object) or Okta (object) or PingOne Identity (object) or Jira (object) or Notifications Test (object) or Slack (object) or Microsoft Teams (object) or Elasticsearch (object) or Google Chronicle (object) or SIEM Test (object) or IBM QRadar (object) or Rapid7 InsightIDR (object) or Microsoft Sentinel (object) or Splunk (object) or Sumo Logic Cloud SIEM (object) or AWS Security Lake (object) or AWS SQS (object) or Azure Monitor Logs (object) or Crowdstrike HEC (object) or Elasticsearch (object) or Sink Test (object) or Splunk (object) or AWS S3 (object) or Azure Blob Storage (object) or Google Cloud Storage (object) or Storage Test (object) or Autotask (object) or Jira (object) or Ticketing Test (object) or PagerDuty (object) or ServiceNow ITSM (object) or ServiceNow SIR (object) or Torq (object) or CrowdStrike Spotlight (object) or Nucleus Vulnerability Management (object) or Qualys VMDR (object) or Rapid7 InsightVM Cloud (object) or Tanium Vulnerability Management (object) or Tenable Vulnerability Management (object)(ProviderConfig)required

One of:

Configuration for the Armis Centrix Assets Provider

integration.provider_config.typestringrequired

Value"assets_armis_centrix"

integration.provider_config.credentialTokenCredential (object) or ArmisCredential (object)(ArmisCredential)required

One of:

Base type for all credential types

integration.provider_config.credential.typestringrequired

Value"token"

integration.provider_config.credential.secretstringrequired

Secret value of the token.

integration.provider_config.urlstringrequired

URL for the Armis Centrix API. This should be the base URL for the API, without any path components. For example, "https://tenant.armis.com".

integration.namestring or null

integration.fullnamestring or null

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

integration.integration_point_idstring(Id)

integration.bridge_selectorBridgeSelector (object) or BridgeSelector (object)(BridgeSelector)

One of:

integration.webhook_configobject(WebhookConfig)

integration.additional_mappingsArray of objects or null(AdditionalMapping)

Additional data mappings for this integration. This allows for custom data to be mapped to the custom_fields portion of the response.

curl -i -X POST \
  'https://api.synqly.com/v1/integrations/{accountId}/verify' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "integration": {
      "name": "string",
      "fullname": "string",
      "provider_config": {
        "type": "assets_armis_centrix",
        "credential": {
          "type": "token",
          "secret": "string"
        },
        "url": "string"
      },
      "integration_point_id": "string",
      "bridge_selector": {
        "type": "id",
        "value": "string"
      },
      "webhook_config": {
        "items": [
          {
            "webhook_url": "string",
            "event_filter": [
              "TicketCreated"
            ]
          }
        ]
      },
      "additional_mappings": [
        {
          "resource": "devices",
          "actions": [
            "query"
          ],
          "source": "string",
          "destination": "string",
          "literal": true,
          "data_type": "string"
        }
      ]
    }
  }'

Responses

Response

No content

Members

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

Management API

Accounts

Audit

Auth

Bridges

Capabilities

Credentials

Integration Points

Integrations

List Integrations

Request

Responses

Was this helpful?

List Account Integrations

Request

Responses

Was this helpful?

Create Integration

RequestExpand all

Responses

Was this helpful?

Get Integration

Request

Responses

Was this helpful?

Update Integration

RequestExpand all

Responses

Was this helpful?

Patch Integration

Request

Responses

Was this helpful?

Delete Integration

Request

Responses

Was this helpful?

Verify Integration

RequestExpand all

Responses

Was this helpful?

Members

Meta

Operations (In Development)

Organization Webhooks

Organization

Permissionset

Roles

Status

Sub Orgs

Tokens

Transforms

Request

Request

Request