API Reference

Connector API

Patch Ticket

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

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

Get Ticket

Request

Returns a Ticket object matching {ticketId} from the token-linked Integration.

Path

ticketIdstring(Id)required

curl -i -X GET \
  'https://api.synqly.com/v1/ticketing/tickets/{ticketId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultobject(Ticket)required

Ticketing ticket

result.idstring(Id)required

result.summarystringrequired

Ticket 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.creatorstring or null

User who created this ticket.

result.assigneestring or null

Who ticket is assigned to.

result.contactstring or null

Ticket contact information.

result.descriptionstring or null

Ticket description.

result.prioritystring(Priority)

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

result.due_datestring or null(date-time)

The ticket's due date.

result.completion_datestring or null(date-time)

The ticket's complete date.

result.statusstring(Status)

result.projectstring(Id)

result.issue_typestring(IssueTypeId)

Unique identifier for an issue type

result.tagsArray of strings or null

Associate tags with Ticket

result.attachmentsArray of objects or null(AttachmentMetadata)

Metadata of attachments associated with the ticket

result.custom_fieldsobject or null

Custom fields for this ticket, keys are the custom field names.

result.unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

metaobject(MetaResponse)

Response

application/json

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

Patch Ticket

Request

Updates the Ticket object matching {ticketId} in the token-linked Integration.

Path

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

Responses

Bodyapplication/json

resultobject(Ticket)required

Ticketing ticket

result.idstring(Id)required

result.summarystringrequired

Ticket 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.creatorstring or null

User who created this ticket.

result.assigneestring or null

Who ticket is assigned to.

result.contactstring or null

Ticket contact information.

result.descriptionstring or null

Ticket description.

result.prioritystring(Priority)

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

result.due_datestring or null(date-time)

The ticket's due date.

result.completion_datestring or null(date-time)

The ticket's complete date.

result.statusstring(Status)

result.projectstring(Id)

result.issue_typestring(IssueTypeId)

Unique identifier for an issue type

result.tagsArray of strings or null

Associate tags with Ticket

result.attachmentsArray of objects or null(AttachmentMetadata)

Metadata of attachments associated with the ticket

result.custom_fieldsobject or null

Custom fields for this ticket, keys are the custom field names.

result.unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

metaobject(MetaResponse)

Response

application/json

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

Create Attachment

Request

[beta: currently supported by Jira] Creates an Attachment for the ticket with id {ticketId} in the token-linked Integration.

Path

ticketIdstring(Id)required

Bodyapplication/jsonrequired

file_namestringrequired

The name of the file.

contentstring(byte)required

File contents

curl -i -X POST \
  'https://api.synqly.com/v1/ticketing/attachments/{ticketId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "file_name": "string",
    "content": "string"
  }'

Responses

Bodyapplication/json

resultobject(AttachmentMetadata)required

Attachment in a ticketing system

result.idstring(Id)required

result.ticket_idstring(Id)required

result.file_namestringrequired

The name of the file.

result.file_typestringrequired

The type of the file.

result.created_datestring(date-time)required

The date the attachment was created.

result.creatorstringrequired

The user who created the attachment.

result.file_sizeinteger or null

The size of the file in bytes.

result.unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

metaobject(MetaResponse)

Response

application/json

{
  "result": {
    "id": "string",
    "ticket_id": "string",
    "file_name": "string",
    "file_type": "string",
    "file_size": 0,
    "created_date": "2019-08-24T14:15:22Z",
    "creator": "string",
    "unmapped": {}
  },
  "meta": {
    "stats": { … },
    "api": { … }
  }
}

Vulnerabilities

Operations

Connector API

Assets

Edr

Hooks

Identity

Notifications

Operations (In Development)

Siem

Sink

Storage

Ticketing

Get Ticket

Request

Responses

Was this helpful?

Patch Ticket

Request

Responses

Was this helpful?

Create Attachment

Request

Responses

Was this helpful?

Vulnerabilities