Support
v4.176.0 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.
Authorizations personalAccessToken oauth account:read_only
Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
default
{
"data" : [
{
"attachments" : [
null
],
"closable" : false ,
"closed" : "2015-06-04T16:07:03" ,
"description" : "I am having trouble setting the root password on my Linode. I tried following the instructions but something is not working. Can you please help me figure out how I can reset it?\n" ,
"entity" : {
"id" : 10400 ,
"label" : "linode123456" ,
"type" : "linode" ,
"url" : "/v4/linode/instances/123456"
},
"gravatar_id" : "474a1b7373ae0be4132649e69c36ce30" ,
"id" : 11223344 ,
"opened" : "2015-06-04T14:16:44" ,
"opened_by" : "some_user" ,
"status" : "open" ,
"summary" : "Having trouble resetting root password on my Linode\n" ,
"updated" : "2015-06-04T16:07:03" ,
"updated_by" : "some_other_user"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of SupportTicket objects.
array
of objects
array
of strings
A list of filenames representing attached files associated with this Ticket.
boolean
Whether the Support Ticket may be closed.
string<date-time>
The date and time this Ticket was closed.
string
1..65000
characters
The full details of the issue or question.
object
The entity this Ticket was opened for.
integer
The unique ID for this Ticket’s entity.
string
The current label of this entity.
string
The type of entity this is related to.
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.
string
The Gravatar ID of the User who opened this Ticket.
integer
The ID of the Support Ticket.
string<date-time>
The date and time this Ticket was created.
string
The User who opened this Ticket.
stringEnum:
closed
new
open
The current status of this Ticket.
string
1..64
characters
The summary or title for this Ticket.
string<date-time>
The date and time this Ticket was last updated.
string
The User who last updated this Ticket.
integer
The current
page .
integer
The total number of
pages .
integer
The total number of results.
Error
array
of objects
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.
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.
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.
Authorizations personalAccessToken oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"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
linode-cli tickets create \
"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?" \
123 \
"Having trouble resetting root password on my Linode"
Request Body Schema integer
The ID of the Managed Database this ticket is regarding, if relevant.
string
1..65000
characters
The full details of the issue or question.
integer
The ID of the Domain this ticket is regarding, if relevant.
integer
The ID of the Firewall this ticket is regarding, if relevant.
integer
The ID of the Linode this ticket is regarding, if relevant.
integer
The ID of the Kubernetes cluster this ticket is regarding, if relevant.
integer
The ID of the Longview client this ticket is regarding, if relevant.
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 . integer
The ID of the NodeBalancer this ticket is regarding, if relevant.
string
The
Region ID for the associated VLAN this ticket is regarding.
Only allowed when submitting a VLAN ticket.
string
1..64
characters
The summary or title for this SupportTicket.
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.
integer
The ID of the Volume this ticket is regarding, if relevant.
integer
The ID of the VPC this ticket is regarding, if relevant.
Response Samples
200
default
{
"attachments" : [
null
],
"closable" : false ,
"closed" : "2015-06-04T16:07:03" ,
"description" : "I am having trouble setting the root password on my Linode. I tried following the instructions but something is not working. Can you please help me figure out how I can reset it?\n" ,
"entity" : {
"id" : 10400 ,
"label" : "linode123456" ,
"type" : "linode" ,
"url" : "/v4/linode/instances/123456"
},
"gravatar_id" : "474a1b7373ae0be4132649e69c36ce30" ,
"id" : 11223344 ,
"opened" : "2015-06-04T14:16:44" ,
"opened_by" : "some_user" ,
"status" : "open" ,
"summary" : "Having trouble resetting root password on my Linode\n" ,
"updated" : "2015-06-04T16:07:03" ,
"updated_by" : "some_other_user"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Support Ticket opened.
array
of strings
A list of filenames representing attached files associated with this Ticket.
boolean
Whether the Support Ticket may be closed.
string<date-time>
The date and time this Ticket was closed.
string
1..65000
characters
The full details of the issue or question.
object
The entity this Ticket was opened for.
integer
The unique ID for this Ticket’s entity.
string
The current label of this entity.
string
The type of entity this is related to.
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.
string
The Gravatar ID of the User who opened this Ticket.
integer
The ID of the Support Ticket.
string<date-time>
The date and time this Ticket was created.
string
The User who opened this Ticket.
stringEnum:
closed
new
open
The current status of this Ticket.
string
1..64
characters
The summary or title for this Ticket.
string<date-time>
The date and time this Ticket was last updated.
string
The User who last updated this Ticket.
Error
array
of objects
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.
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.
Support Ticket View GET
https://api.linode.com/v4/support/tickets/{ticketId}
Returns a Support Ticket under your Account.
Authorizations personalAccessToken oauth account:read_only
Path Parameters ticketId integer
Required The ID of the Support Ticket.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli tickets view 11223344
Response Samples
200
default
{
"attachments" : [
null
],
"closable" : false ,
"closed" : "2015-06-04T16:07:03" ,
"description" : "I am having trouble setting the root password on my Linode. I tried following the instructions but something is not working. Can you please help me figure out how I can reset it?\n" ,
"entity" : {
"id" : 10400 ,
"label" : "linode123456" ,
"type" : "linode" ,
"url" : "/v4/linode/instances/123456"
},
"gravatar_id" : "474a1b7373ae0be4132649e69c36ce30" ,
"id" : 11223344 ,
"opened" : "2015-06-04T14:16:44" ,
"opened_by" : "some_user" ,
"status" : "open" ,
"summary" : "Having trouble resetting root password on my Linode\n" ,
"updated" : "2015-06-04T16:07:03" ,
"updated_by" : "some_other_user"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a single SupportTicket object.
array
of strings
A list of filenames representing attached files associated with this Ticket.
boolean
Whether the Support Ticket may be closed.
string<date-time>
The date and time this Ticket was closed.
string
1..65000
characters
The full details of the issue or question.
object
The entity this Ticket was opened for.
integer
The unique ID for this Ticket’s entity.
string
The current label of this entity.
string
The type of entity this is related to.
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.
string
The Gravatar ID of the User who opened this Ticket.
integer
The ID of the Support Ticket.
string<date-time>
The date and time this Ticket was created.
string
The User who opened this Ticket.
stringEnum:
closed
new
open
The current status of this Ticket.
string
1..64
characters
The summary or title for this Ticket.
string<date-time>
The date and time this Ticket was last updated.
string
The User who last updated this Ticket.
Error
array
of objects
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.
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.
Support Ticket Attachment Create POST
https://api.linode.com/v4/support/tickets/{ticketId}/attachments
Adds a file attachment to an existing Support
Ticket on your Account. File attachments are used to assist our
Support team in resolving your Ticket. Examples of attachments
are screen shots and text files that provide additional information.
The file attachment is submitted in the request as multipart/form-data.
Note : Accepted file extensions include: .gif, .jpg, .jpeg, .pjpg,
.pjpeg, .tif, .tiff, .png, .pdf, or .txt.
Authorizations personalAccessToken oauth account:read_write
Path Parameters ticketId integer
Required The ID of the Support Ticket.
Request Samples
Shell
curl -H "Authorization: Bearer $TOKEN " \
\
'file=@/Users/LinodeGuy/pictures/screen_shot.jpg' \
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Error
array
of objects
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.
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.
Support Ticket Close POST
https://api.linode.com/v4/support/tickets/{ticketId}/close
Closes a Support Ticket you have access to modify.
Authorizations personalAccessToken oauth account:read_write
Path Parameters ticketId integer
Required The ID of the Support Ticket.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli tickets close 11223344
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Support Ticket closed successfully.
Error
array
of objects
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.
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.
Replies List GET
https://api.linode.com/v4/support/tickets/{ticketId}/replies
Returns a collection of replies to a Support Ticket on your Account.
Authorizations personalAccessToken oauth account:read_only
Path Parameters ticketId integer
Required The ID of the Support Ticket.
Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli tickets replies 11223344
Response Samples
200
default
{
"data" : [
{
"created" : "2015-06-02T14:31:41" ,
"created_by" : "John Q. Linode" ,
"description" : "Hello,\\nI'm sorry to hear that you are having trouble resetting the root password of your Linode. Just to be sure, have you tried to follow the instructions in our online documentation? The link is here:\\n \\nhttps://linode.com/docs/guides/reset-the-root-password-on-your-linode/ \\n\\nIf you have, please reply with any additional steps you have also taken.\\n\\nRegards, Linode Support Team\n" ,
"from_linode" : true ,
"gravatar_id" : "474a1b7373ae0be4132649e69c36ce30" ,
"id" : 11223345
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of SupportTicketReply objects.
array
of objects
string<date-time>
The date and time this Ticket reply was created.
string
The User who submitted this reply.
string
The body of this Support Ticket reply.
boolean
If set to true, this reply came from a Linode employee.
string
The Gravatar ID of the User who created this reply.
integer
The unique ID of this Support Ticket reply.
integer
The current
page .
integer
The total number of
pages .
integer
The total number of results.
Error
array
of objects
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.
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.
Reply Create POST
https://api.linode.com/v4/support/tickets/{ticketId}/replies
Adds a reply to an existing Support Ticket.
Authorizations personalAccessToken oauth account:read_write
Path Parameters ticketId integer
Required The ID of the Support Ticket.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"description": "Thank you for your help. I was able to figure out what the problem was and I successfully reset my password. You guys are the best!"
}' \
linode-cli tickets reply 11223344 \
"Thank you for your help. I was able to figure out what the problem was and I successfully reset my password. You guys are the best!"
Request Body Schema string
1..65535
characters
The content of your reply.
Response Samples
200
default
{
"created" : "2015-06-02T14:31:41" ,
"created_by" : "John Q. Linode" ,
"description" : "Hello,\\nI'm sorry to hear that you are having trouble resetting the root password of your Linode. Just to be sure, have you tried to follow the instructions in our online documentation? The link is here:\\n \\nhttps://linode.com/docs/guides/reset-the-root-password-on-your-linode/ \\n\\nIf you have, please reply with any additional steps you have also taken.\\n\\nRegards, Linode Support Team\n" ,
"from_linode" : true ,
"gravatar_id" : "474a1b7373ae0be4132649e69c36ce30" ,
"id" : 11223345
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Reply created.
string<date-time>
The date and time this Ticket reply was created.
string
The User who submitted this reply.
string
The body of this Support Ticket reply.
boolean
If set to true, this reply came from a Linode employee.
string
The Gravatar ID of the User who created this reply.
integer
The unique ID of this Support Ticket reply.
Error
array
of objects
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.
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.
