NotateΒΆ

Used to add a description to an exporter, collector, or profile

Resource URL:

https://[replicator]/api/1/notate/[entity]/[identity]/[description]

Parameter

Description

[replicator]

Hostname or IP address of the Plixer Replicator

[entity]

profile or ip

[identity]

[profile_name] or [ip_address] of entity specified

[description]

Description or note to add to the entity in standard ASCII URI-compatible characters

Example request:

https://10.30.17.131/api/1/notate/profile/myprofile/My_Fantastic_Description

Example response:
{
    "description": "Success: Profile 'myprofile' has a new description",
    "result": "success"
}