createCancelServerTicket

Classes SoftLayer_Ticket
Tags method sldn ticket

SoftLayer_Ticket::createCancelServerTicket

Create a sales cancel server ticket to be cancelled on next bill date.

Description

A cancel server request creates a ticket to cancel the resource on next bill date. The hardware ID parameter is required to determine which server is to be cancelled. NOTE: Hourly bare metal servers will be cancelled on next bill date.

The reason parameter could be from the list below:

  • “No longer needed”
  • “Business closing down”
  • “Server / Upgrade Costs”
  • “Migrating to larger server”
  • “Migrating to smaller server”
  • “Migrating to a different SoftLayer datacenter”
  • “Network performance / latency”
  • “Support response / timing”
  • “Sales process / upgrades”
  • “Moving to competitor”

The content parameter describes further the reason for cancelling the server.

Parameters

Name Type Description
attachmentId int The internal identifier of the server to cancel.
reason string Cancellation reason.
content string Cancellation content for ticket. A brief description explaining the cancellation reason.
cancelAssociatedItems boolean Flag to indicate that associated billing items assigned to the server should be canceled also.
attachmentType enum
  • HARDWARE

Required Headers

Optional Headers

Return Values

Error Handling

  • Throws the exception “Attachment id must be provided.” when attachment id parameter is not provided.
  • Throws the exception “Cancellation reason must be provided.” when reason parameter is not provided.
  • Throws the exception “Cancellation content description must be provided.” when content parameter is not provided.
  • Throws the exception “A cancellation ticket already exists for this server. Please refer to ticket .” if an open cancellation ticket already exists for this server.
  • Throws the exception “You do not have permission to this service.” when a portal user does not have permission to cancel server. 
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int, string, string, boolean, enum]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/createCancelServerTicket'