support.new_ticket

Creates a new ticket for support. This is done using the support proxy API. For TrueNAS Community Edition it will be created on JIRA and for TrueNAS Enterprise on Salesforce.

For Community Edition, criticality, environment, phone, name, and email attributes are not required. For Enterprise, token and type attributes are not required.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data


Support ticket data for either enterprise or community support.

SupportNewTicketEnterprise

Type: object
No Additional Properties

Title

Type: string

Title of the support ticket.

Must be at most 200 characters long

Body

Type: string

Detailed description of the issue or request.

Must be at most 20000 characters long

Category

Type: string

Category or classification of the support issue.

Attach Debug

Type: boolean Default: false

Whether to attach debug information to the ticket.

Criticality

Type: string

Priority or criticality level of the issue.

Environment

Type: string

Description of the environment where the issue occurs.

Phone

Type: string

Contact phone number for this ticket.

Name

Type: string

Contact name for this ticket.

Email

Type: string

Contact email address for this ticket.

Cc

Type: array of string Default: []

Array of email addresses to copy on the ticket.

 No Additional Items
Each item of this array must be:
Type: string

SupportNewTicketCommunity

Type: object
No Additional Properties

Title

Type: string

Title of the support ticket.

Must be at most 200 characters long

Body

Type: string

Detailed description of the issue or request.

Must be at most 20000 characters long

Attach Debug

Type: boolean Default: false

Whether to attach debug information to the ticket.

Token

Type: string

Authentication token for creating community tickets.

Type

Type: enum (of string)

Type of ticket being created.

Must be one of:
  • "BUG"
  • "FEATURE"

Cc

Type: array of string Default: []

Array of email addresses to copy on the ticket.

 No Additional Items
Each item of this array must be:
Type: string

SupportNewTicketResult

Type: object

SupportNewTicketResult return fields.

 No Additional Properties

Ticket


Ticket number if successfully created. null if creation failed.

Type: integer
Type: null

Url


URL to view the created ticket. null if not available.

Type: string
Type: null

Has Debug

Type: boolean

Whether debug information was attached to the ticket.


Required roles: READONLY_ADMIN | SUPPORT_WRITE