getObject

Classes SoftLayer_Hardware_Server
Tags method sldn hardware

SoftLayer_Hardware_Server::getObject

Retrieve a SoftLayer_Hardware_Server record.

Description

getObject retrieves the SoftLayer_Hardware_Server object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve servers from the account that your portal user is assigned to.

Parameters

None

Required Headers

Optional Headers

Return Values

Error Handling

  • Throw the error “Unable to find object with id of {id}.” if the given initialization parameter has an invalid id field.
  • Throw the error “Access Denied.” if the given initialization parameter id field is not the account id of the user making the API call.
  • Throw the error “Method has not been implemented for this object type.” id the method is used.
  • Throws the exception ‘No operating system could be found for this server.’ Then the setOperatingSystemPassword method is called to change the password for a server that does not have an operating system setup. 
curl -g -u $SL_USER:$SL_APIKEY -X GET \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getObject'