createAdministrativeTicket

Classes SoftLayer_Ticket
Tags method sldn ticket

SoftLayer_Ticket::createAdministrativeTicket

Create an administrative support ticket.

Description

Create an administrative support ticket. Use an administrative ticket if you require SoftLayer’s assistance managing your server or content. If you are experiencing an issue with SoftLayer’s hardware, network, or services then please open a standard support ticket.

Support tickets may only be created in the open state. The SoftLayer API defaults new ticket properties ‘‘userEditableFlag’’ to true, ‘‘accountId’’ to the id of the account that your API user belongs to, and ‘‘statusId’’ to 1001 (or “open”). You may not assign your new to ticket to users that your API user does not have access to.

Once your ticket is created it is placed in a queue for SoftLayer employees to work. As they update the ticket new SoftLayer_Ticket_Update entries are added to the ticket object.

Administrative support tickets add a one-time $3USD charge to your account.

Parameters

Name Type Description
templateObject SoftLayer_Ticket A skeleton SoftLayer_Ticket object containing the data of the ticket you wish to submit.
contents string The contents of the first update of the ticket. This is typically the ticket’s problem description.
attachmentId int An optional internal identifier of a piece of hardware or CloudLayer Computing Instance you wish to attach to this ticket. If you attach hardware to a ticket then you must also specify a root or admin password.
rootPassword string The root password of the hardware you wish to attach to this ticket. Providing your administrative password can significantly improve your ticket response time.
controlPanelPassword string An optional administrative password to a hosting control panel running on your server, if your server has one installed.
accessPort string The TCP port on your server that SoftLayer must use to access your operating system. This is typically 22 for SSH and 3389 for Remote Desktop.
attachedFiles SoftLayer_Container_Utility_File_Attachment[] An array of files to attach to a ticket upon creation.
attachmentType enum
  • HARDWARE
  • VIRTUAL_GUEST

Required Headers

Optional Headers

Return Values

Error Handling

  • Throw the exception “Please provide a title when creating an administrative support ticket.” If the $templateObject parameter does not have a title set.
  • Throw the exception “Please provide ticket contents.” if no contents are provided to the method.
  • Throw the exception “Please provide a root/admin password.” if a hardware id was passed to the method, but a root password wasn’t. 
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Ticket, string, int, string, string, string, SoftLayer_Container_Utility_File_Attachment, enum]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/createAdministrativeTicket'