Documentation

API Error Responses

API Error Responses The following document provides details of error responses obtained while executing different APIs. Response Body { "status": 400, "errorType": 1, "message": "invalid auth header", "timestamp": "2024-08-20T11:52:06.358+00:00" } Property Description status Indicates the http error status code like 401, 500, etc errorType error type message Cause of the error. timestamp Timestamp when the …

API Error Responses Read More »

Login Profile API

Login Profile API This API performs actions such as updating login profile, updating viewid, getting Login profile, duplicating Login profile, adding Login Profile, searching for a Login profile and deleting a Login Profile. Update POST ​/api​/v1​/loginprofile​/update This API is essential for updating the login profile. Request Body { "id": 0, "title": "string", "description": "string", "ipRange": …

Login Profile API Read More »

Access User API

Access User API Access user API allows operations such as create, edit, delete, etc with Access users. Update POST ​/api​/v1​/accessuser​/update This API updates an Access User. Request Body { "id": 0, "firstName": "string", "lastName": "string", "email": "string", "authId": 0, "active": true } Property Mandatory Description id yes Access user id firstname no first name of …

Access User API Read More »

Login API

Login API Login API allow to generate an access token. The default validity of the token is one hour. Login POST /api​/v1​/login Request Body { "username": "string", "secretkey": "string" } Property Mandatory Description username yes User name secretkey yes secret key Response Success Code – 200 { "token": "string" } Error Response In order to …

Login API Read More »

Share API

Share API The share API provides REST API to perform functions on shares such as adding, updating, deleting, etc. New Share POST /api/v1/share/add Creates a new Share. Request Body { "title": "string", "location": "string", "notifyEmails": "string", "path": "string", "description": "string", "startupMessage": "string", "authenticationId": 0, "canDelete": true, "canUpload": true, "canCreateFolder": true, "canDownload": true, "canDownloadFolder": true, "canView": …

Share API Read More »

API Integration

API Integration An API acts as an interface that is essential for establishing communication helping to perform administrative tasks between an external system and NirvaShare. Using API service, external systems can communicate with NirvaShare for workflow automation with respect to administration. External Systems can use API to perform administrative tasks like create, edit or delete …

API Integration Read More »

Generate API Access Token

Generate API Access Token API Access Token consists of an encrypted access key code that acts as an identifier when sent to an API server. It is a credential that allows an application to access an API in NirvaShare. API token can be generated both from the UI and also through the REST api. In …

Generate API Access Token Read More »

Create API User

Create API User API user in NirvaShare is an admin privileged user and external systems can use the API users to perform administrative tasks using automation. External system can communicate with NirvaShare using the REST API for reasons related to workflow automation. In the below document, let us understand the procedure to create an API …

Create API User Read More »