Create unit

This is an API function to create a unit. This API function corresponds to the operation of the [Add] button that is displayed by selecting the [Unit] on the operation screen of Manager.

= Remarks =

The request parameters in JSON format of the following API functions are the same.

  • Create unit
  • Modify unit details

The response parameters of the following API functions are the same.

  • Create unit
  • Modify unit details
  • Acquire unit details
Format
curl -X POST --header 'Content-Type: application/json'
             --header 'Accept: application/json'
             --header 'X-API-KEY:APIKEY'
             -d 'REQUESTBODYINJSONFORMAT'
             'http://HOSTNAME:PORTNUMBER/api/v1/units'
Request body (JSON format)
{
   "shushinHostName": "string",
   "shushinPort": 0,
   "unitName": "string"
}
Request parameter (JSON format)
Item name Request parameter Type Value Default value
Host Name of Receiver shushinHostName String Maximum 68 ASCII characters (without NULL) Impossible to omit
Port Number on Receiver shushinPort Integer 1 to 65535 30000
Unit Name unitName String Maximum 64 characters Impossible to omit
Response
{
　　　"shushinHostName": "string",
　　　"shushinPort": 0,
　　　"unitId": "string",
　　　"unitName": "string",
　　　"unitVersion": 0
}
Response parameter

For details of the response parameters, see Response parameter described in Acquire unit details.