Profile¶

Used to manage profile settings and behavior

Resource URL:

Renames an existing profile

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[current]	Name of the profile to be renamed
[new]	New name for the profile

Example request:

Example response:

{
    "description": "Success: Profile 'oldprofile' is now 'myprofile'",
    "result": "success"
}

Resource URL:

Toggles the singularity setting for a profile

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[name]	Name of the profile to be updated
[action]	`enable` or `disable`

Example request:

Example response:

{
    "description": "Success: Profile 'myprofile' singularity enabled",
    "result": "success"
}

Resource URL:

Removes, disables, or enables a profile

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[action]	`remove`, `disable`, or `enable`
[name]	Target profile for the operation

Example request:

https://10.30.17.131/api/1/profile/disable/myprofile

Example response:

{
    "description": "Success: Profile myprofile has been set to 'disable'",
    "result": "success"
}

Resource URL:

Creates a new profile or updates an existing profile

Parameter	Description
[replicator]	Hostname or IP address of the Plixer Replicator
[action]	`add` or `update`
[name]	Name of the profile to create or update
[listeningport]	UDP port to listen to for incoming packets (In Port)
[sendingport]	The UDP port to send packets from (Out Port)

Example request:

https://10.30.17.131/api/1/profile/add/myprofile/2055/4739

Example response:

{
    "description": "Success: Profile 'myprofile' has been added and enabled.",
    "result": "success"
}