Socket
Socket
Sign inDemoInstall

cloudmersive-virus-api-client

Package Overview
Dependencies
38
Maintainers
1
Versions
21
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

cloudmersive-virus-api-client

The_Cloudmersive_Virus_Scan_API_lets_you_scan_files_and_content_for_viruses_and_identify_security_issues_with_content_


Version published
Maintainers
1
Weekly downloads
1,380
decreased by-7.07%

Weekly downloads

Readme

Source

cloudmersive-virus-api-client

CloudmersiveVirusApiClient - JavaScript client for cloudmersive-virus-api-client The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content. Cloudmersive Virus Scan API provides advanced virus scanning capabilities.

  • API version: v1
  • Package version: 1.3.0

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cloudmersive-virus-api-client --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your cloudmersive-virus-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('cloudmersive-virus-api-client') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CloudmersiveVirusApiClient = require('cloudmersive-virus-api-client');

var defaultClient = CloudmersiveVirusApiClient.ApiClient.instance;

// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix['Apikey'] = "Token"

var api = new CloudmersiveVirusApiClient.ScanApi()

var inputFile = "/path/to/file.txt"; // {File} Input file to perform the operation on.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.scanFile(inputFile, callback);

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

ClassMethodHTTP requestDescription
CloudmersiveVirusApiClient.ScanApiscanFilePOST /virus/scan/fileScan a file for viruses
CloudmersiveVirusApiClient.ScanApiscanFileAdvancedPOST /virus/scan/file/advancedAdvanced Scan a file for viruses
CloudmersiveVirusApiClient.ScanApiscanWebsitePOST /virus/scan/websiteScan a website for malicious content and threats
CloudmersiveVirusApiClient.ScanCloudStorageApiscanCloudStorageScanAwsS3FilePOST /virus/scan/cloud-storage/aws-s3/singleScan an AWS S3 file for viruses
CloudmersiveVirusApiClient.ScanCloudStorageApiscanCloudStorageScanAwsS3FileAdvancedPOST /virus/scan/cloud-storage/aws-s3/single/advancedAdvanced Scan an AWS S3 file for viruses
CloudmersiveVirusApiClient.ScanCloudStorageApiscanCloudStorageScanAzureBlobPOST /virus/scan/cloud-storage/azure-blob/singleScan an Azure Blob for viruses
CloudmersiveVirusApiClient.ScanCloudStorageApiscanCloudStorageScanAzureBlobAdvancedPOST /virus/scan/cloud-storage/azure-blob/single/advancedAdvanced Scan an Azure Blob for viruses
CloudmersiveVirusApiClient.ScanCloudStorageApiscanCloudStorageScanGcpStorageFilePOST /virus/scan/cloud-storage/gcp-storage/singleScan an Google Cloud Platform (GCP) Storage file for viruses
CloudmersiveVirusApiClient.ScanCloudStorageApiscanCloudStorageScanGcpStorageFileAdvancedPOST /virus/scan/cloud-storage/gcp-storage/single/advancedAdvanced Scan an Google Cloud Platform (GCP) Storage file for viruses
CloudmersiveVirusApiClient.ScanCloudStorageApiscanCloudStorageScanSharePointOnlineFilePOST /virus/scan/cloud-storage/sharepoint-online/site/singleVirus Scan a file in a SharePoint Online Site Drive
CloudmersiveVirusApiClient.ScanCloudStorageApiscanCloudStorageScanSharePointOnlineFileAdvancedPOST /virus/scan/cloud-storage/sharepoint-online/site/advancedAdvanced Virus Scan a file in a SharePoint Online Site Drive

Documentation for Models

Documentation for Authorization

Apikey

  • Type: API key
  • API key parameter name: Apikey
  • Location: HTTP header

FAQs

Last updated on 11 Dec 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc