1. API Operations
  2. Update target description

Deprecated

You are viewing a deprecated version of our API Reference. Please visit the up-to-date documentation.

Update target description

This operation updates the description of a target.


Request

Parameters
Parameter
op
Type
string
required
true

Updates the description of a target. The value is "update_target_description".

Parameter
target_id
Type
integer
required
true

The ID of the target.

Parameter
description
Type
string
required
true

The description to be set for the given target.

{
  "op": "update_target_description",
  "target_id": 7583,
  "description": "Internal test server"
}

Response

Attributes
Attribute
op_status
Type
string

The status of the operation. The value can be "success" or "fail".

Attribute
error
Type
string

Error message. Returned in case of a failed operation.

{
  "op_status": "success"
}