Authentication

Used to authenticate the user and start/stop API sessions

Login

Starts a new API session

GET request:

Note

Legacy API – Deprecated- recommend using POST

Resource URL:

https://[replicator]/api/1/login/[sha2]

Parameter

Description

[replicator]

Hostname or IP address of the Plixer Replicator

[sha2]

Interactive Mode (CLI) password converted to SHA2 512-bit hex

Example request:

https://10.30.17.131/api/1/login/098f6bcd4621d373ca098f6bcd4621d563cade4e832629b4f6d098f4bcd4621d373cade4e831627b4f6e4e832627b4f

POST request:

Starts a new API session

Resource URL:

POST https://[replicator]/api/1/login/

{
 “user” : “admin”
 “passwd”: “[passwd]”
}

Parameter

Description

[replicator]

Hostname or IP address of the Plixer Replicator

[passwd]

SHA512 hash of the password for the admin username

Example response:
{
 "path": "login successful.",
 "result": "success"
}
Log out

Manually terminates an API session (API sessions are automatically terminated after 30 minutes)

Resource URL:

https://[replicator]/api/1/logout

Parameter

Description

[replicator]

Hostname or IP address of the Plixer Replicator

Example request:

https://10.30.17.131/api/1/logout

Example response:
{
 "path": "logout successful.",
 "result": "success"
}