API Reference
/
Connector API
/
Operations (In Development)

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
Languages
Servers
Synqly
https://api.synqly.com/

Assets

Operations

Edr

Operations

Hooks

Operations

Identity

Operations

Notifications

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

AlphaGet Asynchronous Operation state

Request

In Development

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

Please contact us before using this operation.

Returns the Asynchronous Operation object matching {operationId}.

Path
operationIdstring(Id)required
curl -i -X GET \
  'https://api.synqly.com/v1/operations/{operationId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultobject(Operation)required
result.​idstring(Id)required
result.​created_atstring(date-time)required

Time object was originally created

result.​updated_atstring(date-time)required

Last time object was updated

result.​account_idstring(Id)required
result.​integration_idstring(Id)required
result.​operationstringrequired

Name of the operation that will be run for this operation.

result.​inputobject(OperationInput)required
result.​input.​filtersArray of strings or null

Limit the number of results returned by the operation. If not specified, the operation will return all results.

result.​input.​limitinteger or null

Limit query results by these filters.

result.​statusstring(OperationStatus)required
Enum"SCHEDULED""PROCESSING""CANCELLED""COMPLETE"
result.​cpu_timeinteger(int64)required

Cpu time in microseconds

result.​in_bytesinteger(int64)required

Number of bytes sent to sink integration

result.​scheduleobject(OperationSchedule)
result.​errorsArray of objects or null(OperationError)

Errors that occurred during the operation

Response
application/json
{
  "result": {
    "id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "account_id": "string",
    "integration_id": "string",
    "schedule": { … },
    "operation": "string",
    "input": { … },
    "status": "SCHEDULED",
    "errors": [ … ],
    "cpu_time": 0,
    "in_bytes": 0
  }
}

AlphaCancel Asynchronous Operation

Request

In Development

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

Please contact us before using this operation.

Cancels the Asynchronous Operation matching {operationId}.

Path
operationIdstring(Id)required
curl -i -X POST \
  'https://api.synqly.com/v1/operations/{operationId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response
No content

AlphaCreate Asynchronous Operation

Request

In Development

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

Please contact us before using this operation.

Creates an Asynchronous Operation object.

Bodyapplication/jsonrequired
operationstringrequired

Name of the operation that will be run for this operation.

inputobject(OperationInput)required
input.​filtersArray of strings or null

Limit the number of results returned by the operation. If not specified, the operation will return all results.

input.​limitinteger or null

Limit query results by these filters.

scheduleobject(OperationSchedule)
curl -i -X POST \
  https://api.synqly.com/v1/operations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "schedule": {
      "run_at": "2019-08-24T14:15:22Z",
      "interval": "string"
    },
    "operation": "string",
    "input": {
      "filters": [
        "string"
      ],
      "limit": 0
    }
  }'

Responses

Bodyapplication/json
resultobject(CreateOperationResponseResult)required
result.​operationobject(Operation)required
result.​operation.​idstring(Id)required
result.​operation.​created_atstring(date-time)required

Time object was originally created

result.​operation.​updated_atstring(date-time)required

Last time object was updated

result.​operation.​account_idstring(Id)required
result.​operation.​integration_idstring(Id)required
result.​operation.​operationstringrequired

Name of the operation that will be run for this operation.

result.​operation.​inputobject(OperationInput)required
result.​operation.​input.​filtersArray of strings or null

Limit the number of results returned by the operation. If not specified, the operation will return all results.

result.​operation.​input.​limitinteger or null

Limit query results by these filters.

result.​operation.​statusstring(OperationStatus)required
Enum"SCHEDULED""PROCESSING""CANCELLED""COMPLETE"
result.​operation.​cpu_timeinteger(int64)required

Cpu time in microseconds

result.​operation.​in_bytesinteger(int64)required

Number of bytes sent to sink integration

result.​operation.​scheduleobject(OperationSchedule)
result.​operation.​errorsArray of objects or null(OperationError)

Errors that occurred during the operation

Response
application/json
{
  "result": {
    "operation": { … }
  }
}

Siem

Operations

Sink

Operations

Storage

Operations

Ticketing

Operations

Vulnerabilities

Operations