The API allows you to login, logout, view user session and check api connection status.
Check api connection status by http status code. Api connection status is OK when http status code is equal 204 (No Content).
media type | data type | description |
---|---|---|
application/json | string (JSON) | no content |
GET /session
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
...
Login user.
media type | data type | description |
---|---|---|
application/json | LoginRequest (JSON) | specify details to login as user |
media type | data type | description |
---|---|---|
application/json | SessionInfoResponse (JSON) | details about user session |
POST /session/login
Content-Type: application/json
Accept: application/json
{
"login" : "...",
"password" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"requester" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"infoTourEnabled" : true,
"lastFailedLoginIp" : "...",
"language" : "PL",
"appUserSettings" : {
"pageSize" : 12345,
"timeFormat" : 12345
},
"privileges" : [ "APP_INSTANCE_EXPORT_TASK_REGISTER", "APP_CMD_EXEC_CONFIG_WRITE" ],
"endpointsTokens" : {
"endpointsServerManagerToken" : "...",
"endpointsServerManagerWarning" : "...",
"endpointsOrganizationAdminToken" : "...",
"endpointsOrganizationAdminWarning" : "..."
},
"uiConsoleMode" : "WORKFLOW",
"lastSuccessfulLogin" : 1451677502000,
"lastFailedLogin" : 1451649601000,
"uiTimeZone" : "UTC"
}
media type | data type |
---|---|
application/json | LoginWithTokenRequest (JSON) |
media type | data type | description |
---|---|---|
application/json | SessionInfoResponse (JSON) |
POST /session/login-with-token
Content-Type: application/json
Accept: application/json
{
"token" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"requester" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"infoTourEnabled" : true,
"lastFailedLoginIp" : "...",
"language" : "DE",
"appUserSettings" : {
"pageSize" : 12345,
"timeFormat" : 12345
},
"privileges" : [ "STORAGE_SNAPSHOT_SLA_READ", "STORAGE_INFRASTRUCTURE_READ" ],
"endpointsTokens" : {
"endpointsServerManagerToken" : "...",
"endpointsServerManagerWarning" : "...",
"endpointsOrganizationAdminToken" : "...",
"endpointsOrganizationAdminWarning" : "..."
},
"uiConsoleMode" : "WORKFLOW",
"lastSuccessfulLogin" : 1451677502000,
"lastFailedLogin" : 1451649601000,
"uiTimeZone" : "UTC"
}
Logout current user.
POST /session/logout
Content-Type: */*
...
HTTP/1.1 201 Created
Refresh Endpoints tokens.
media type | data type | description |
---|---|---|
application/json | SessionInfoResponse (JSON) | endpoint tokens |
POST /session/refresh-endpoints-tokens
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 201 Created
Content-Type: application/json
{
"requester" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"infoTourEnabled" : true,
"lastFailedLoginIp" : "...",
"language" : "DE",
"appUserSettings" : {
"pageSize" : 12345,
"timeFormat" : 12345
},
"privileges" : [ "STORAGE_INSTANCE_SNAPSHOT_TASK_REGISTER", "OS_CREDENTIAL_WRITE" ],
"endpointsTokens" : {
"endpointsServerManagerToken" : "...",
"endpointsServerManagerWarning" : "...",
"endpointsOrganizationAdminToken" : "...",
"endpointsOrganizationAdminWarning" : "..."
},
"uiConsoleMode" : "WORKFLOW",
"lastSuccessfulLogin" : 1451677502000,
"lastFailedLogin" : 1451649601000,
"uiTimeZone" : "UTC"
}
Get user session info.
media type | data type | description |
---|---|---|
application/json | SessionInfoResponse (JSON) | details about user session |
GET /session/user
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"requester" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"infoTourEnabled" : true,
"lastFailedLoginIp" : "...",
"language" : "PL",
"appUserSettings" : {
"pageSize" : 12345,
"timeFormat" : 12345
},
"privileges" : [ "VE_BACKUP_SLA_WRITE", "NODE_WRITE" ],
"endpointsTokens" : {
"endpointsServerManagerToken" : "...",
"endpointsServerManagerWarning" : "...",
"endpointsOrganizationAdminToken" : "...",
"endpointsOrganizationAdminWarning" : "..."
},
"uiConsoleMode" : "TASK",
"lastSuccessfulLogin" : 1451677502000,
"lastFailedLogin" : 1451649601000,
"uiTimeZone" : "UTC"
}
Login for node.
media type | data type | description |
---|---|---|
application/json | NodeLoginRequest (JSON) | specify details to login as node |
media type | data type | description |
---|---|---|
application/json | SessionInfoResponse (JSON) | details about node session |
POST /session/node/login
Content-Type: application/json
Accept: application/json
{
"login" : "...",
"password" : "...",
"version" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"requester" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"infoTourEnabled" : true,
"lastFailedLoginIp" : "...",
"language" : "FR",
"appUserSettings" : {
"pageSize" : 12345,
"timeFormat" : 12345
},
"privileges" : [ "VE_INSTANCE_UNMOUNT_TASK_REGISTER", "OS_CREDENTIAL_WRITE" ],
"endpointsTokens" : {
"endpointsServerManagerToken" : "...",
"endpointsServerManagerWarning" : "...",
"endpointsOrganizationAdminToken" : "...",
"endpointsOrganizationAdminWarning" : "..."
},
"uiConsoleMode" : "WORKFLOW",
"lastSuccessfulLogin" : 1451677502000,
"lastFailedLogin" : 1451649601000,
"uiTimeZone" : "UTC"
}
Get current user details.
media type | data type | description |
---|---|---|
application/json | AppUserDetails (JSON) | user details |
GET /session/user/details
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"login" : "...",
"firstName" : "...",
"lastName" : "...",
"lastFailedLoginIp" : "...",
"source" : "LDAP",
"language" : "PL",
"active" : true,
"infoTourEnabled" : true,
"endpointsOrganization" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"groups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"appUserSettings" : {
"pageSize" : 12345,
"timeFormat" : 12345
},
"externalId" : "...",
"thirdPartyRestriction" : "NO_RESTRICTION",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"lastSuccessfulLogin" : 1451649601000,
"lastFailedLogin" : 1451677502000,
"uiTimeZone" : "UTC"
}