Developer Documentation
Child pages
  • WHM API 1 Functions - ticket_create_stub_ticket
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description

This function creates a stub ticket.The system will use the stub ticket to create a cPanel support ticket.

Examples

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/ticket_create_stub_ticket
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/ticket_create_stub_ticket
 Command Line
whmapi1 ticket_create_stub_ticket

 


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
 {
	"metadata": {
		"result": 1,
		"version": 1,
		"command": "ticket_create_stub_ticket",
		"reason": "OK"
	},
	"data": {
		"ticket_id": 7648492
		"secure_id": rofh411bv8
	}
}
 Output (XML)
<result>
	<metadata>
		<result>1</result>
		<version>1</version>
		<command>ticket_create_stub_ticket</command>
		<reason>OK</reason>
	</metadata>
	<data>
		<ticket_id>7648492</ticket_id>
		<secure_id>rofh411bv8</secure_id>
	</data>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
ticket_idinteger

The support ticket number that other functions can lookup or make additional changes to the support ticket.

A positive integer.

7648492

secure_idstring

The support ticket's secure ID token.

Note:

We added this return in cPanel & WHM version 76.

A string value.rofh411bv8

Function information

API Version:

WHM API 1

Available in:

WHM 60+

Methods:

GET, POST

Required Parameters:

(none)

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions