Support v4.174.0
Support Tickets List
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 |
The page of a collection to return. |
page_size |
The number of items to return per page. |
Request Samples
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/support/tickets
linode-cli tickets list
Response Samples
{
"data": null,
"page": 1,
"pages": 1,
"results": 1
}
{
"errors": null
}
Responses
data | [array] |
page | [integer] The current page. |
pages | [integer] The total number of pages. |
results | [integer] The total number of results. |
errors | [array] |
Support Ticket Open
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
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
linode-cli tickets create \
--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"
Request Body Schema
database_id | [integer] The ID of the Managed Database this ticket is regarding, if relevant. |
description Required | [string]
1..65000
charactersThe full details of the issue or question. |
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
|
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. |
summary Required | [string]
1..64
charactersThe summary or title for this SupportTicket. |
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 |
volume_id | [integer] The ID of the Volume this ticket is regarding, if relevant. |
vpc_id | [integer] The ID of the VPC this ticket is regarding, if relevant. |
Response Samples
{
"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": null
}
Responses
attachments | [array] A list of filenames representing attached files associated with this Ticket. | ||||||||
closable | [boolean] Whether the Support Ticket may be closed. | ||||||||
closed Nullable | [string]<date-time> The date and time this Ticket was closed. | ||||||||
description | [string]
1..65000
charactersThe full details of the issue or question. | ||||||||
entity Nullable | [object] The entity this Ticket was opened for.
| ||||||||
gravatar_id | [string] The Gravatar ID of the User who opened this Ticket. | ||||||||
id | [integer] The ID of the Support Ticket. | ||||||||
opened | [string]<date-time> The date and time this Ticket was created. | ||||||||
opened_by | [string] The User who opened this Ticket. | ||||||||
status | [string] Enum:
closed
new
open The current status of this Ticket. | ||||||||
summary | [string]
1..64
charactersThe summary or title for this Ticket. | ||||||||
updated | [string]<date-time> The date and time this Ticket was last updated. | ||||||||
updated_by Nullable | [string] The User who last updated this Ticket. |
errors | [array] |
Support Ticket View
Returns a Support Ticket under your Account.
Authorizations
personalAccessToken | |
oauth | account:read_only |
Path Parameters
ticketId | [integer] RequiredThe ID of the Support Ticket. |
Request Samples
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/support/tickets/11223344
linode-cli tickets view 11223344
Response Samples
{
"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": null
}
Responses
attachments | [array] A list of filenames representing attached files associated with this Ticket. | ||||||||
closable | [boolean] Whether the Support Ticket may be closed. | ||||||||
closed Nullable | [string]<date-time> The date and time this Ticket was closed. | ||||||||
description | [string]
1..65000
charactersThe full details of the issue or question. | ||||||||
entity Nullable | [object] The entity this Ticket was opened for.
| ||||||||
gravatar_id | [string] The Gravatar ID of the User who opened this Ticket. | ||||||||
id | [integer] The ID of the Support Ticket. | ||||||||
opened | [string]<date-time> The date and time this Ticket was created. | ||||||||
opened_by | [string] The User who opened this Ticket. | ||||||||
status | [string] Enum:
closed
new
open The current status of this Ticket. | ||||||||
summary | [string]
1..64
charactersThe summary or title for this Ticket. | ||||||||
updated | [string]<date-time> The date and time this Ticket was last updated. | ||||||||
updated_by Nullable | [string] The User who last updated this Ticket. |
errors | [array] |
Support Ticket Attachment Create
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] RequiredThe ID of the Support Ticket. |
Request Samples
curl -H "Authorization: Bearer $TOKEN" \
-X POST \
-F 'file=@/Users/LinodeGuy/pictures/screen_shot.jpg' \
https://api.linode.com/v4/support/tickets/11223344/attachments
Response Samples
{}
{
"errors": null
}
Responses
errors | [array] |
Support Ticket Close
Closes a Support Ticket you have access to modify.
Authorizations
personalAccessToken | |
oauth | account:read_write |
Path Parameters
ticketId | [integer] RequiredThe ID of the Support Ticket. |
Request Samples
curl -H "Authorization: Bearer $TOKEN" \
-X POST \
https://api.linode.com/v4/support/tickets/11223344/close
linode-cli tickets close 11223344
Response Samples
{}
{
"errors": null
}
Responses
errors | [array] |
Replies List
Returns a collection of replies to a Support Ticket on your Account.
Authorizations
personalAccessToken | |
oauth | account:read_only |
Path Parameters
ticketId | [integer] RequiredThe ID of the Support Ticket. |
Query Parameters
page |
The page of a collection to return. |
page_size |
The number of items to return per page. |
Request Samples
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/support/tickets/11223344/replies
linode-cli tickets replies 11223344
Response Samples
{
"data": null,
"page": 1,
"pages": 1,
"results": 1
}
{
"errors": null
}
Responses
data | [array] |
page | [integer] The current page. |
pages | [integer] The total number of pages. |
results | [integer] The total number of results. |
errors | [array] |
Reply Create
Adds a reply to an existing Support Ticket.
Authorizations
personalAccessToken | |
oauth | account:read_write |
Path Parameters
ticketId | [integer] RequiredThe ID of the Support Ticket. |
Request Samples
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"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!"
}' \
https://api.linode.com/v4/support/tickets/11223344/replies
linode-cli tickets reply 11223344 \
--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!"
Request Body Schema
description Required | [string]
1..65535
charactersThe content of your reply. |
Response Samples
{
"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": null
}
Responses
created | [string]<date-time> The date and time this Ticket reply was created. |
created_by | [string] The User who submitted this reply. |
description | [string] The body of this Support Ticket reply. |
from_linode | [boolean] If set to true, this reply came from a Linode employee. |
gravatar_id | [string] The Gravatar ID of the User who created this reply. |
id | [integer] The unique ID of this Support Ticket reply. |
errors | [array] |