EMS Configuration API curl Examples

Here are some examples to interact with the API using the tool curl with a server certificate file.

Login with user and password credentials:

curl --cacert ca.crt -i -X POST -d username='user' -d password='password' -c ./cookies.txt https://nbin1/nbapiemswsweb/login

Get the first page of network element without any search options:

curl --cacert ca.crt -i -H “Content-Type:application/json” -X GET -b ./cookies.txt https://nbin1/nbapiemswsweb/rest/v1/Search/NetworkElement

Get a specific element by its IP:

curl --cacert sca.crt -i -H “Content-Type:application/json” -X GET -b ./cookies.txt 'https://nbin1/nbapiemswsweb/rest/v1/Search/NetworkElement?so_ipAddress=10.250.61.7'

Start an executor:

curl --cacert ca.crt -i --data "" -X POST -b ./cookies.txt https://nbin1/nbapiemswsweb/rest/v1/ConfigFlowExecutor/1/start

Start a SAT test:

curl --cacert ca.crt -i -H "Content-Type:application/json" --data '{"testName":"new","networkElementId":2,"description":"Set a description here","note":"Any special note","operator":"Operator name here"}' -X POST -b ./cookies.txt https://nbin1/nbapiemswsweb/rest/v1/SAT/Y1564/startTest

Add a NE credential:

curl --cacert ca.crt -i -H "Content-Type:application/json" --data '{ "name": "new_cred","password": "admin","userId": "admin"}' -X POST -b ./cookies.txt https://nbin1/nbapiemswsweb/rest/v1/NECredential

Delete a NE Credential:

curl --cacert ca.crt -i --data "" -X DELETE -b ./cookies.txt https://nbin1/nbapiemswsweb/rest/v1/NECredential/1

Note: The ca.crt server certificate file where the CN name is matching the server name (nbin1).