Console Connect logo

Support Tickets

Create and view tickets for the Console Connect Support team.

Get support tickets for the logged in users company

Get a list of support tickets.

Securityapi-key
Request
query Parameters
status
required
string

Criteria for searching support tickets.

Enum: "open" "closed"
Example: status=open
page
integer

The "page" of results from a query.

Example: page=1
pageSize
integer

The number of results to be returned in a query.

Example: pageSize=200
Responses
200

Returns an array of support tickets.

401

Throws an error for an unauthorized request.

get/v2/support-tickets
Response samples
application/json
[
  • {
    }
]

Create support ticket

Create a support ticket for the logged in users company.

Securityapi-key
Request
Request Body schema: application/json
name
string
description
string
issueType
string
Enum: "Application" "Circuit Down" "Circuit Flapping" "Circuit taking errors" "High Latency" "Operational Request" "Others" "Packet Loss/Drops" "Request Reason of Outage" "Slow Response" "Unstable"
object
object
Responses
200

Returns a single support ticket.

400

Throws an error for an invalid ticket id.

401

Throws an error for an unauthorized request.

post/v2/support-tickets
Request samples
application/json

An example payload when raising a ticket for a service available in the /support-tickets/services list.

{
  • "name": "My ConsoleConnect speed issue",
  • "description": "My port has slow speeds between 8am and 9am GMT+7",
  • "issueType": "Slow Response",
  • "service": {
    },
  • "customerContact": {
    }
}
Response samples
application/json
{
  • "id": "INC000001234567",
  • "name": "Ticket Name Label",
  • "description": "This is the description of the ticket",
  • "priority": [
    ],
  • "status": "Acknowledged",
  • "ticketType": "Incident",
  • "creationDate": "2023-01-01T01:02:03.000+0000",
  • "notes": [
    ],
  • "relatedParty": [
    ],
  • "relatedEntity": [
    ],
  • "channel": {
    },
  • "@type": "troubleTicket"
}

Get support ticket by Id

Get a single support ticket.

Securityapi-key
Request
path Parameters
id
required
string

The id of the support ticket.

Example: INC000001234567
Responses
200

Returns a single support ticket.

400

Throws an error for an invalid ticket id.

401

Throws an error for an unauthorized request.

404

Throws an error for a support ticket that does not exist.

get/v2/support-tickets/{id}
Response samples
application/json
{
  • "id": "INC000001234567",
  • "name": "Ticket Name Label",
  • "description": "This is the description of the ticket",
  • "priority": [
    ],
  • "status": "Acknowledged",
  • "ticketType": "Incident",
  • "creationDate": "2023-01-01T01:02:03.000+0000",
  • "notes": [
    ],
  • "relatedParty": [
    ],
  • "relatedEntity": [
    ],
  • "channel": {
    },
  • "@type": "troubleTicket"
}

List Console Services

Provides a list of Console Connect services that a support ticket can be created for.

Securityapi-key
Responses
200

Returns the resulting with the new note.

401

Throws an error for an unauthorized request.

get/v2/support-tickets/services
Response samples
application/json
[
  • {
    }
]

Add Note to support ticket

Adds a note to an existing support ticket.

Securityapi-key
Request
path Parameters
id
required
string

The id of the support ticket.

Example: INC000001234567
Request Body schema: application/json

The note text.

noteText
string

The text comment to be added to the ticket.

Responses
200

Returns the resulting with the new note.

400

Throws an error for an malformed/bad request.

401

Throws an error for an unauthorized request.

404

Throws an error for a support ticket that does not exist.

post/v2/support-tickets/{id}/addNote
Request samples
application/json
{
  • "noteText": "My connection is experiencing packet loss between 0800 and 0807 every day."
}
Response samples
application/json
{
  • "id": "INC000001234567",
  • "name": "Ticket Name Label",
  • "description": "This is the description of the ticket",
  • "priority": [
    ],
  • "status": "Acknowledged",
  • "ticketType": "Incident",
  • "creationDate": "2023-01-01T01:02:03.000+0000",
  • "notes": [
    ],
  • "relatedParty": [
    ],
  • "relatedEntity": [
    ],
  • "channel": {
    },
  • "@type": "troubleTicket"
}
➔ Next to Heartbeat