POST /api/lunasa/network/measurement/actions/{actionid}

POST /api/lunasa/network/measurement/actions/{actionid}

Performs the specified action on a ctc measurement service. The actions available are "enable" and "disable".

User Privileges

Users with the following role privileges can perform this command:

• admin
• operator

Parameters

actionid

This parameter specifies the id of the action to be performed. Could be action "enable" or "disable".

Use: Required

JSON Schema:

    Object
    type:string

interval

This parameter specifies the interval duration for the measurement to be enabled.

Note: The interval will be provided in seconds by default. It's value can have a range of 1-99999.

Use: Optional

Note: For enabling ctc measurement service, interval is required.

JSON Schema:

    Object
    type: integer

Responses

204

Success.

400

APPLIANCE_MEASUREMENT_ACTION_FAILED

Failed to perform specified action.

400

APPLIANCE_INVALID_PATTERN_DETECTED

One of the provided values has an inappropriate format.

400

APPLIANCE_MEASUREMENT_INTERVAL_REQUIRED

If trying to enable the ctc measurement service but not provided interval

404

APPLIANCE_ACTION_DOES_NOT_EXIST

Failed to match action

Example Request to enable the measurement service

   POST
   https://1.2.3.4:8443/api/lunasa/network/measurement/actions/enable
   {
      "interval": 99
   }

Example Request to disable the measurement service

   POST
   https://1.2.3.4:8443/api/lunasa/network/measurement/actions/disable
   {}

Example Response

    {}