Generating Secret Key API Secret Key is a software credential that allows a program to access a user account without the actual Password.It has an encrypted code that works as an identifier when sent to the API server. This secret key is used for generating a access token. This document provides steps to generate a …
Installing API Service API service enables external system to integrate with NirvaShare allowing to manage some of the admin tasks such as creating, editing, deleting shares, login profiles, access users, etc. This document explains how to install API service in NirvaShare. The installation can be performed using a single install script. Once you run the …
Login Profile Login Profile in NirvaShare is used for setting a policy for authentication type and access restrictions while sharing files from the Object Storages like S3, Azure Blob, Wasabi,etc. It is necessary to create a Login Profile in NirvaShare to share and access files or folders from various Object Storage. Numerous Authentication methods for …
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 …
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": …
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 …
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 …
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": …
How to Use WinSCP with NirvaShare to connect with WebDav WinSCP is commonly used for secure file transfers between a local and a remote computer in Microsoft Windows. It supports numerous file protocols like WebDav, FTP etc. Through this document, let us understand the procedure to use WinSCP to access shared files from NirvaShare using …
How to Use WinSCP with NirvaShare to connect with Webdav Read More »
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 …