Service List

From SingleHop Dropzone API
Jump to: navigation, search

Returns a list of available services for server. Also shows you weather the service is already active or not.

Contents

Path

  • /service/list/{$serverid}

Method

Required Data Parameters

  • {$serverid}: The server ID that is returned when using the list command.

Optional Data Parameters

  • None

Returned Data

stdClass Object(
  [success] => TRUE/FALSE
  [data] => stdClass Object(
    [services] => stdClass Object(
      [*SERVICEID*] => stdClass Object(
        [type] => They type of service.
        [serviceid] => The internal ID of the service.
        [active] => Is the service active on you (TRUE,FASLE).
        [available] => Is the service available (TRUE,FASLE).
        [automatable] => Can the service be activated automatically (TRUE,FASLE).
        [name] => Name of the service.
        [price] => Monthly cost of the service.
        [code] => Internal service code.
        [description] => The description of the service.
      )
    )
    [servicestree] => stdClass Object(
      [admin] => An array of IDs containing admin services that can be used with data->services->IDHERE.
      [backup] => An array of IDs containing backup services that can be used with data->services->IDHERE.
      [security] => An array of IDs containing security services that can be used with data->services->IDHERE.
      [mail] => An array of IDs containing mail services that can be used with data->services->IDHERE.
      [network] => An array of IDs containing network services that can be used with data->services->IDHERE.
      [ip] => An array of IDs containing IP services that can be used with data->services->IDHERE.
    )
  )
)
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox