Skip to content

login

Overview

Login

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP

Tags

  • login : Operations related to login

Paths

POST operation for login

POST /login

Description

Use this operation to Login To SD-WAN Appliance

Parameters

Type Name Schema
Body body
optional
login_request_schema

Responses

HTTP Code Description Schema
200 Resource successfully added login_post_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Consumes

  • application/json

Produces

  • application/json

Tags

  • login

DELETE operation for login

DELETE /login/{deletePathParam}

Description

Use this operation to Logout From SD-WAN Appliance

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added login_delete_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • login

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

login

Name Schema
password
optional
password
username
optional
username

login_delete_success_schema

Name Schema
login
optional
login

login

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

login_post_success_schema

Name Schema
login
optional
login

login

Name Description Schema
message
optional
Example : "resource added succesfully" string

login_put_success_schema

Name Schema
login
optional
login

login

Name Description Schema
message
optional
Example : "resource modified succesfully" string

login_request_schema

Name Schema
login
optional
login

login_response_schema

Type : < login_response_schema > array

login_response_schema

Name Schema
password
optional
password
username
optional
username

password

Authentication Password

Type : string

username

User Name

Type : string