Support

Support Tickets List

get
https://api.linode.com/v4/support/tickets

Returns a collection of Support Tickets on your Account. Support Tickets can be both tickets you open with Linode for support, as well as tickets generated by Linode regarding your Account. This collection includes all Support Tickets generated on your Account, with open tickets returned first.

Query Parameters

page
integer > = 1
Default: 1

The page of a collection to return.

page_size
integer [25 .. 500]
Default: 100

The number of items to return per page.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/support/tickets

Response Samples

{
  "data": [
    {
      "id": "",
      "entity": {
        "id": 10400,
        "label": "linode123456",
        "type": "linode",
        "url": "/v4/linode/instances/123456"
      },
      "status": "open",
      "updated": "2015-06-04T16:07:03",
      "description": "I'm having trouble setting the root password on my Linode. I tried following the instructions but something is not working and I'm not sure what I'm doing wrong. Can you please help me figure out how I can reset it?\n",
      "attachments": [],
      "closed": "2015-06-04T16:07:03",
      "closable": "",
      "gravatar_id": "474a1b7373ae0be4132649e69c36ce30",
      "opened": "2015-06-04T14:16:44",
      "opened_by": "some_user",
      "summary": "Having trouble resetting root password on my Linode\n",
      "updated_by": "some_other_user"
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

200: Returns a paginated list of SupportTicket objects.

data
array of objects
id
integer

The ID of the Support Ticket.

entity
Nullable
object

The entity this Ticket was opened for.

id
integer

The unique ID for this Ticket's entity.

label
string

The current label of this entity.

type
string

The type of entity this is related to.

url
string

The URL where you can access the object this event is for. If a relative URL, it is relative to the domain you retrieved the entity from.

status
string
Enum: "closed""new""open"

The current status of this Ticket.

updated
Filterable
string

The date and time this Ticket was last updated.

description
string

The full details of the issue or question.

attachments
array

A list of filenames representing attached files associated with this Ticket.

closed
Filterable
Nullable
string

The date and time this Ticket was closed.

closable
boolean

Whether the Support Ticket may be closed.

gravatar_id
string

The Gravatar ID of the User who opened this Ticket.

opened
Filterable
string

The date and time this Ticket was created.

opened_by
string

The User who opened this Ticket.

summary
string

The summary or title for this Ticket.

updated_by
Nullable
string

The User who last updated this Ticket.

page
integer

The current page.

pages
integer

The total number of pages.

results
integer

The total number of results.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.

Support Ticket Open

post
https://api.linode.com/v4/support/tickets

Open a Support Ticket. Only one of the ID attributes (linode_id, domain_id, etc.) can be set on a single Support Ticket.

Request Body Schema

description
Required
string [1 .. 65000] characters

The full details of the issue or question.

summary
Required
string [1 .. 64] characters

The summary or title for this SupportTicket.

database_id
integer

The ID of the Managed Database this ticket is regarding, if relevant.

domain_id
integer

The ID of the Domain this ticket is regarding, if relevant.

firewall_id
integer

The ID of the Firewall this ticket is regarding, if relevant.

linode_id
integer

The ID of the Linode this ticket is regarding, if relevant.

lkecluster_id
integer

The ID of the Kubernetes cluster this ticket is regarding, if relevant.

longviewclient_id
integer

The ID of the Longview client this ticket is regarding, if relevant.

managed_issue
boolean

Designates if this ticket is related to a Managed service. If true, the following constraints will apply:

  • No ID attributes (i.e. linode_id, domain_id, etc.) should be provided with this request.
  • Your account must have a Managed service enabled.
nodebalancer_id
integer

The ID of the NodeBalancer this ticket is regarding, if relevant.

region
string

The Region ID for the associated VLAN this ticket is regarding.

Only allowed when submitting a VLAN ticket.

vlan
string

The label of the VLAN this ticket is regarding, if relevant. To view your VLANs, use the VLANs List (GET /networking/vlans) endpoint.

Requires a specified region to identify the VLAN.

volume_id
integer

The ID of the Volume this ticket is regarding, if relevant.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
      "description": "I'm having trouble setting the root password on my Linode. I tried following the instructions but something is not working and I'm not sure what I'm doing wrong. Can you please help me figure out how I can reset it?",
      "linode_id": 123,
      "summary": "Having trouble resetting root password on my Linode"
    }' \
    https://api.linode.com/v4/support/tickets

Response Samples

{
  "status": "open",
  "updated": "2015-06-04T16:07:03",
  "id": 1234,
  "description": "I'm having trouble setting the root password on my Linode. I tried following the instructions but something is not working and I'm not sure what I'm doing wrong. Can you please help me figure out how I can reset it?\n",
  "summary": "Having trouble resetting root password on my Linode\n",
  "entity": {
    "id": 10400,
    "type": "linode",
    "label": "linode123456",
    "url": "/v4/linode/instances/123456"
  },
  "attachments": [],
  "closed": "2015-06-04T16:07:03",
  "closable": "",
  "gravatar_id": "474a1b7373ae0be4132649e69c36ce30",
  "opened": "2015-06-04T14:16:44",
  "opened_by": "some_user",
  "updated_by": "some_other_user"
}

Responses

200: Support Ticket opened.

status
string
Enum: "closed""new""open"

The current status of this Ticket.

updated
Filterable
string <date-time>

The date and time this Ticket was last updated.

id
integer

The ID of the Support Ticket.

description
string [1 .. 65000] characters

The full details of the issue or question.

summary
string [1 .. 64] characters

The summary or title for this Ticket.

entity
Nullable
object

The entity this Ticket was opened for.

id
integer

The unique ID for this Ticket's entity.

type
string

The type of entity this is related to.

label
string

The current label of this entity.

url
string

The URL where you can access the object this event is for. If a relative URL, it is relative to the domain you retrieved the entity from.

attachments
array of objects

A list of filenames representing attached files associated with this Ticket.

closed
Filterable
Nullable
string <date-time>

The date and time this Ticket was closed.

closable
boolean

Whether the Support Ticket may be closed.

gravatar_id
string

The Gravatar ID of the User who opened this Ticket.

opened
Filterable
string <date-time>

The date and time this Ticket was created.

opened_by
string

The User who opened this Ticket.

updated_by
Nullable
string

The User who last updated this Ticket.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.