API Reference

/

Connector API

/

Connector API

The Synqly Connector APIs provide a unifying interface and data model for all supported service Providers.

See the Synqly Overview for more information.

Download OpenAPI description

connectors.json

connectors.yaml

Servers

Synqly

https://api.synqly.com/

Assets

Operations

Edr

Operations

Hooks

Operations

Identity

Operations

Notifications

Operations

Get Notification

Request

Returns the Notification object matching {notificationId} from the token-linked Integration.

Path

notificationIdstring(Id)required

curl -i -X GET \
  'https://api.synqly.com/v1/notifications/get/{notificationId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultobject(Notification)required

Notification object

result.idstring(Id)required

result.summarystringrequired

Notification summary.

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.prioritystring(Priority)

Enum"URGENT""CRITICAL""HIGH""MEDIUM""MODERATE""LOW""PLANNING"

result.notification_statusstring(NotificationStatus)

Enum"OPEN""CLOSED"

result.projectstring or null

Notification project

result.statusstring or null

The current status of the notification.

result.descriptionstring or null

Notification description.

result.issue_typestring or null

The notification's type.

result.creatorstring or null

The user who created this notification.

result.assigneestring or null

Who notification is assigned to.

result.contactstring or null

The notification contact information.

result.tagsArray of strings or null

Associate tags with Notification

metaobject(MetaResponse)

Response

application/json

{
  "result": {
    "id": "string",
    "summary": "string",
    "priority": "URGENT",
    "notification_status": "OPEN",
    "project": "string",
    "status": "string",
    "description": "string",
    "issue_type": "string",
    "creator": "string",
    "assignee": "string",
    "contact": "string",
    "tags": [ … ],
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "stats": { … },
    "api": { … }
  }
}

Create Notification

Request

Creates a Notification object in the token-linked Integration.

Bodyapplication/jsonrequired

summarystringrequired

Notification summary.

namestring or null

This field is deprecated and no longer used.

prioritystring(Priority)

Enum"URGENT""CRITICAL""HIGH""MEDIUM""MODERATE""LOW""PLANNING"

projectstring or null

Notification project

statusstring or null

The current status of the notification.

descriptionstring or null

Notification description.

issue_typestring or null

The notification's type.

creatorstring or null

The user who created this notification.

assigneestring or null

Who notification is assigned to.

contactstring or null

The notification contact information.

tagsArray of strings or null

Associate tags with Notification

curl -i -X POST \
  https://api.synqly.com/v1/notifications/create \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "summary": "string",
    "priority": "URGENT",
    "project": "string",
    "status": "string",
    "description": "string",
    "issue_type": "string",
    "creator": "string",
    "assignee": "string",
    "contact": "string",
    "tags": [
      "string"
    ]
  }'

Responses

Bodyapplication/json

resultobject(Notification)required

Notification object

result.idstring(Id)required

result.summarystringrequired

Notification summary.

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.prioritystring(Priority)

Enum"URGENT""CRITICAL""HIGH""MEDIUM""MODERATE""LOW""PLANNING"

result.notification_statusstring(NotificationStatus)

Enum"OPEN""CLOSED"

result.projectstring or null

Notification project

result.statusstring or null

The current status of the notification.

result.descriptionstring or null

Notification description.

result.issue_typestring or null

The notification's type.

result.creatorstring or null

The user who created this notification.

result.assigneestring or null

Who notification is assigned to.

result.contactstring or null

The notification contact information.

result.tagsArray of strings or null

Associate tags with Notification

metaobject(MetaResponse)

Response

application/json

{
  "result": {
    "id": "string",
    "summary": "string",
    "priority": "URGENT",
    "notification_status": "OPEN",
    "project": "string",
    "status": "string",
    "description": "string",
    "issue_type": "string",
    "creator": "string",
    "assignee": "string",
    "contact": "string",
    "tags": [ … ],
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "stats": { … },
    "api": { … }
  }
}

Clear Notification

Request

Resolves a Notification object in the token-linked Integration.

Path

notificationIdstring(Id)required

curl -i -X POST \
  'https://api.synqly.com/v1/notifications/clear/{notificationId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

Operations (In Development)

In Development

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

Please contact us before using this feature.

Operations

Siem

Operations

Sink

Operations

Storage

Operations

Ticketing

Operations

Vulnerabilities

Operations