Child pages
  • WHM API 1 Functions - ticket_get_support_info
Skip to end of metadata
Go to start of metadata

Description

This function retrieves the license holder's support-related information.

Note:

To use this function, you must set up a cPanelID token in your current session. For more information, read our cPanelID documentation.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/ticket_get_support_info?api.version=1
 Command Line
whmapi1 ticket_get_support_info


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

 Output (JSON)
{  
   "metadata":{  
      "version":1,
      "result":1,
      "command":"ticket_get_support_info",
      "reason":"OK"
   },
   "data":{
        "gets_direct_support": 0,
        "company_id": "7",
        "has_compatibility_info": "1",
        "distro": "centos enterprise 6.8",
        "tech_contact_email": "support@example.com",
        "arch_supported": 1,
        "arch": "x86_64",
        "ip": "192.168.0.1",
        "company_name": "Example, L.L.C.",
        "has_company_info": "1",
        "pub_support_contact": "http://documentation.example.com/",
        "hostname": "server.example.com",
        "logo_url": "http://example.com/assets/ourlogo.png",
        "pub_tech_contact": "https://support.example.com/",
        "distro_supported": 1
    }
}


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

Return

Type

Description

Possible values

Example

company_id

integerA number that represents the company  with the licensed IP address.

A positive integer.

7

tech_contact_email

stringThe contact email address for the company's technical support.A valid email address.
support@example.com

ip

stringThe license provider's IP address.A valid IPv4 IP address.192.168.0.1

company_name

stringThe company name associated with the submitted IP address.A string value.Example, L.L.C.

pub_support_contact

stringThe URL to the company's general support resources.
  • A valid URL.

  • An empty return.
http://documentation.example.com/

hostname

stringThe hostname of the server as recorded in the license database.
  • A valid hostname.
  • An IP address.
server.example.com

logo_url

stingThe optional URL to the company's brand image file on the partner website.A valid URL.
http://example.com/assets/ourlogo.png

pub_tech_contact

string

The optional URL to the company's technical support resources.

Note:

If the pub_tech_contact return does not contain a value, the system will use the pub_support_contact return's value.

A valid URL.
https://support.example.com/

gets_direct_support

BooleanWhether the IP address owner's primary support is cPanel, L.L.C.
  • 1 — Receives initial support from cPanel, L.L.C.
  • 0 — Receives initial support from partner.

0

has_compatibility_info

BooleanWhether the response contains the server's compatibility information.
  • 1 — Contains compatibility info.
  • 0 — Does not contain compatibility info.
1

distro

stringThe server's operating system retrieved during the last license check.A string value.

centos enterprise 6.8

distro_supported

stingWhether cPanel Technical Support provides assistance for the server's operating system.
  • 1 — Yes.
  • 0 — No.
  • -1 — Unknown OS.
1

arch

stringThe server's CPU architecture retrieved at the last license check.A string value.

x86_64

arch_supported

stringWhether cPanel Support provides assistance with the server's CPU architecture.
  • 1 — Yes.
  • 0 — No.
  • -1 —Unknown architecture.
1

has_company_info

BooleanWhether the response contains the company information associated with the licensed IP address.
  • 1 — Contains company info.
  • 0 — Does not contain company info.
0