API Reference

Page tree

Registers the user during the first-time logging in. Refer to Logging in to NAKIVO Backup and Replication for an explanation.

Endpoint

https://<Director_IP_address>:4443/c/router

Request Example

curl
 curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data "{
        "action": "RegistrationManagement",
        "method": "register",
        "data": ["john", "PasswordXYZ", "john.dent@company.com", null],
        "type": "rpc",
        "tid": 1}"

Request Fields

Field
Type
Value(s)
Description
action
string
 RegistrationManagement
The action that is invoked
method
string
 register
The method that is invoked
data
array
Parameters of the method to be invoked
type
string
rpc
Type of communication protocol
tid
integer
1
Transaction ID. Used to identify the request by both the client and the server

Data

Field
Type
Description
username
stringUser name to be registered as the application administrator
password
stringPassword of the user to be registered
email
stringEmail of the user to be registered
ec2InstanceId
stringEC2 Instance ID, optional

Response Sample

 {
    "action": "RegistrationManagement",
    "method": "register",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": null
}

Response Fields

Field
Value
Description
message
stringMessage if the request failed
where
stringReference to the method where the problem occurred
cause
stringCause of failure
data
string
  • No labels