- Created by Documentation, last modified on Sep 21, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function creates a stub ticket.The system will use the stub ticket to create a cPanel support ticket.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/ticket_create_stub_ticket
https://hostname.example.com:2087/cpsess##########/xml-api/ticket_create_stub_ticket
whmapi1 ticket_create_stub_ticket
Notes:
- 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
{ "metadata": { "result": 1, "version": 1, "command": "ticket_create_stub_ticket", "reason": "OK" }, "data": { "ticket_id": 7648492 "secure_id": rofh411bv8 } }
<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:
Parameters
This function does not accept parameters.
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
ticket_id | integer | The support ticket number that other functions can lookup or make additional changes to the support ticket. | A positive integer. |
|
secure_id | string | 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:
Available in:
WHM 60+
Methods:
GET, POST
Required Parameters:
Return Formats:
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
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - ticket_ssh_test — This function verifies the connection from the cPanel Customer Portal to the server.
-
Page:WHM API 1 Functions - ticket_revoke — This function removes a cPanel Customer Portal SSH key from the server.
-
Page:WHM API 1 Functions - ticket_update_service_agreement_approval — This function records a user's acceptance of the Technical Support Agreement (TSA).
-
Page:WHM API 1 Functions - ticket_validate_oauth2_code — This function validates the OAuth2 code from the cPanel Customer Portal.
-
Page:WHM API 1 Functions - ticket_ssh_test_start — This function initiates an SSH connection test.