tickets
Creates, updates, deletes, gets or lists a tickets
resource.
Overview
Name | tickets |
Type | Resource |
Id | linode.support.tickets |
Fields
The following fields are returned by SELECT
queries:
- get_ticket
- get_tickets
Returns a single support ticket.
Name | Datatype | Description |
---|---|---|
id | integer | Read-only The ID of the support ticket. |
gravatar_id | string | Read-only The Gravatar ID of the user who opened this ticket. (example: 474a1b7373ae0be4132649e69c36ce30) |
attachments | array | Read-only A list of filenames representing attached files associated with this ticket. |
closable | boolean | Whether the ticket can be closed. |
closed | string (date-time) | Filterable, Read-only When this ticket was closed. (example: 2024-06-04T16:07:03) |
description | string | Read-only The full details of the issue or question. (example: I'm having trouble setting the root password on my Linode. I tried following the instructions, but something isn't working. Can you please help me figure out how I can reset it?) |
entity | object | Read-only The ticket was opened for this entity. An entity represents a specific object you've created, such as a Linode or a Managed Database. |
opened | string (date-time) | Filterable, Read-only When this ticket was created. (example: 2024-06-04T14:16:44) |
opened_by | string | Read-only The user who opened this ticket. (example: some_user) |
status | string | Read-only The current status of this ticket. (example: open) |
summary | string | Read-only The summary or title for this ticket. (example: Having trouble resetting Linode root password.) |
updated | string (date-time) | Filterable, Read-only When this ticket was last updated. (example: 2024-06-04T16:07:03) |
updated_by | string | Read-only The user who last updated this ticket. (example: some_other_user) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_ticket | select | Returns a specific support ticket under your account. Learn more... Learn more... | ||
get_tickets | select | page , page_size | Returns a collection of all support tickets opened from your account. This includes tickets you've opened and tickets generated by Linode customer support regarding your account. Open tickets are returned first in the response. Learn more... Learn more... | |
post_ticket | insert | data__summary , data__description | Open a support ticket. A ticket can only target a single, specific entity. For example, for an issue with a specific Linode, open a ticket and target it using its linode_id . Leave all other entities out of the request or set them to null .Learn more... Learn more... | |
post_close_ticket | delete | Closes a support ticket you have access to modify. Learn more... Learn more... | ||
post_ticket_attachment | exec | file | Adds a file attachment to an open support ticket on your account. Use an attachment to help customer support resolve your ticket. The file attachment is submitted in the request as multipart/form-data type. Accepted file extensions include: .gif , .jpg , .jpeg , .pjpg , .pjpeg , .tif , .tiff , .png , .pdf , or .txt . OAuth scopes.<br /> account:read_write<br /> Learn more... |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
page | integer | The page of a collection to return. |
page_size | integer | The number of items to return per page. |
SELECT
examples
- get_ticket
- get_tickets
Returns a specific support ticket under your account.
Learn more...
Learn more...
SELECT
id,
gravatar_id,
attachments,
closable,
closed,
description,
entity,
opened,
opened_by,
status,
summary,
updated,
updated_by
FROM linode.support.tickets;
Returns a collection of all support tickets opened from your account. This includes tickets you've opened and tickets generated by Linode customer support regarding your account. Open tickets are returned first in the response.
Learn more...
Learn more...
SELECT
data,
page,
pages,
results
FROM linode.support.tickets
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';
INSERT
examples
- post_ticket
- Manifest
Open a support ticket. A ticket can only target a single, specific entity. For example, for an issue with a specific Linode, open a ticket and target it using its linode_id
. Leave all other entities out of the request or set them to null
.
Learn more...
Learn more...
INSERT INTO linode.support.tickets (
data__bucket,
data__database_id,
data__description,
data__domain_id,
data__firewall_id,
data__linode_id,
data__lkecluster_id,
data__longviewclient_id,
data__managed_issue,
data__nodebalancer_id,
data__region,
data__summary,
data__vlan,
data__volume_id,
data__vpc_id
)
SELECT
'{{ bucket }}',
{{ database_id }},
'{{ description }}' --required,
{{ domain_id }},
{{ firewall_id }},
{{ linode_id }},
{{ lkecluster_id }},
{{ longviewclient_id }},
{{ managed_issue }},
{{ nodebalancer_id }},
'{{ region }}',
'{{ summary }}' --required,
'{{ vlan }}',
{{ volume_id }},
{{ vpc_id }}
RETURNING
id,
gravatar_id,
attachments,
closable,
closed,
description,
entity,
opened,
opened_by,
status,
summary,
updated,
updated_by
;
# Description fields are for documentation purposes
- name: tickets
props:
- name: bucket
value: string
description: >
The name of an Object Storage bucket entity for this ticket. Run the [List Object Storage buckets](https://techdocs.akamai.com/linode-api/reference/get-object-storage-buckets) operation and store the `label` for the target bucket. You also need to provide the specific `region` where the bucket is located.
- name: database_id
value: integer
description: >
The ID of the Managed Database entity for the ticket. Run the [List Managed Databases](https://techdocs.akamai.com/linode-api/reference/get-databases-instances) operation and store the `id` for the target database.
- name: description
value: string
description: >
The full details of the issue or question.
- name: domain_id
value: integer
description: >
The ID of the domain entity for the ticket. Run the [List domains](https://techdocs.akamai.com/linode-api/reference/get-domains) operation and store the `id` for the target domain.
- name: firewall_id
value: integer
description: >
The ID of the Firewall entity for the ticket. Run the [List a Linode's firewalls](https://techdocs.akamai.com/linode-api/reference/get-linode-firewalls) operation and store the `id` for the target Linode firewall.
- name: linode_id
value: integer
description: >
The ID of the Linode entity for the ticket. Run the [List Linodes](https://techdocs.akamai.com/linode-api/reference/get-linode-instances) operation and store the `id` for the target Linode.
- name: lkecluster_id
value: integer
description: >
The ID of the Linode Kubernetes Engine (LKE) cluster entity for the ticket. Run the [List Kubernetes clusters](https://techdocs.akamai.com/linode-api/reference/get-lke-clusters) operation and store the `id` for the target LKE cluster.
- name: longviewclient_id
value: integer
description: >
The ID of the Longview client entity for the ticket. Run the [List Longview clients](https://techdocs.akamai.com/linode-api/reference/get-longview-clients) operation and store the `id` for the target client.
- name: managed_issue
value: boolean
description: >
Whether this ticket is related to a [managed service](https://www.linode.com/products/managed/). If `true`, the following constraints apply:
- You can't provide an entity, such as a `linode_id` or `bucket` with this request.
- Your account needs a managed service [enabled](https://techdocs.akamai.com/linode-api/reference/post-enable-managed-service).
default: false
- name: nodebalancer_id
value: integer
description: >
The ID of the NodeBalancer entity for the ticket. Run the [List NodeBalancers](https://techdocs.akamai.com/linode-api/reference/get-node-balancers) operation and store the `id` for the target NodeBalancer.
- name: region
value: string
description: >
The ID of the [region](https://techdocs.akamai.com/linode-api/reference/get-regions) where this ticket's target entity resides. This only applies to tickets for a `vlan` or an Object Storage `bucket`.
> 📘
>
> Set this to the `clusterId` for a legacy Object Storage `bucket`.
- name: summary
value: string
description: >
The summary or title for this support ticket.
- name: vlan
value: string
description: >
The label of the VLAN entity for the ticket. Run the [List VLANs](https://techdocs.akamai.com/linode-api/reference/get-vlans) operation and store the `id` for the target VLAN. You also need to provide the specific `region` where the VLAN is located.
- name: volume_id
value: integer
description: >
The ID of the volume entity for the ticket. Run the [List volumes](https://techdocs.akamai.com/linode-api/reference/get-volumes) operation and store the `id` for the target volume.
- name: vpc_id
value: integer
description: >
The ID of the VPC entity for the ticket. Run the [List VPCs](https://techdocs.akamai.com/linode-api/reference/get-vpcs) operation and store the `id` for the target VPC.
DELETE
examples
- post_close_ticket
Closes a support ticket you have access to modify.
Learn more...
Learn more...
DELETE FROM linode.support.tickets;
Lifecycle Methods
- post_ticket_attachment
Adds a file attachment to an open support ticket on your account. Use an attachment to help customer support resolve your ticket. The file attachment is submitted in the request as multipart/form-data
type. Accepted file extensions include: .gif
, .jpg
, .jpeg
, .pjpg
, .pjpeg
, .tif
, .tiff
, .png
, .pdf
, or .txt
. OAuth scopes.
<br /> account:read_write<br />
Learn more...
EXEC linode.support.tickets.post_ticket_attachment
@@json=
'{
"file": "{{ file }}"
}';