nimbusec v3.0.0

Nimbusec client API library for Node.js

Installation

$ npm install nimbusec

## Usage Example

var nimbusecAPI = require('nimbusec');

var api = new nimbusecAPI('NIMBUSEC-KEY', 'NIMBUSEC-SECRET');
api.findDomains(null, function(err, domains) {

    if (err) {
        console.log('An error occured : ');
        console.log(' - code : '+ err.statusCode);
        console.log(' - message : '+ err.message);
        process.exit(1);
    }

    console.log('My domains are :');
    for (var i = 0; i < domains.length; i++) {
        console.log('  - ' + domains[i].name);
    }
});

Commands

Generate HTML documentation

$ grunt doc

Generate README.md file

$ grunt shell:generateReadme

Check the coding style

$ grunt eslint

To Do

• Implement /v2/user/* part of the API
• Implement /v2/domain//screenshot/* part of the API when available

API Reference

NimbusecAPI

Kind: global class
Access: public

• NimbusecAPI
  • new NimbusecAPI(key, secret, [options])
  • instance
    • .findBundles(filter, callback)
    • .findDomains(filter, callback)
    • .createDomain(domain, callback)
    • .updateDomain(domain, domainID, callback)
    • .deleteDomain(domainID, callback)
    • .findAgentToken(filter, callback)
    • .createAgentToken(agentToken, callback)
    • .deleteAgentToken(agentToken, callback)
    • .findInfectedDomains(filter, callback)
    • .findDomainResults(domainID, filter, callback)
    • .updateDomainResult(domainID, resultID, result, callback)
    • .getDomainMetadata(domainID, callback)
    • ._parseResponse(err, data, response, callback) ℗
    • ._get(uri, filter, callback) ℗
    • ._delete(uri, callback) ℗
    • ._post(uri, obj, callback) ℗
    • ._put(uri, obj, callback) ℗
  • inner
    • ~findBundlesCallback : function
    • ~findDomainsCallback : function
    • ~createDomainCallback : function
    • ~updateDomainCallback : function
    • ~deleteDomainCallback : function
    • ~findAgentTokenCallback : function
    • ~createAgentTokenCallback : function
    • ~deleteAgentTokenCallback : function
    • ~findInfectedDomainsCallback : function
    • ~findDomainResultsCallback : function
    • ~updateDomainResultCallback : function
    • ~getDomainMetadataCallback : function
    • ~Domain : object
    • ~DomainMetadata : object
    • ~Result : object
    • ~Package : object
    • ~Agent : object
    • ~AgentToken : object
    • ~User : object
    • ~Notification : object
    • ~CMS : object
    • ~Error : object

new NimbusecAPI(key, secret, options)

Construct a new NimbusecAPI object.

nimbusecAPI.findBundles(filter, callback)

Read all existing bundles depending on an optional filter.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI.findDomains(filter, callback)

Read all existing domains depending on an optional filter.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI.createDomain(domain, callback)

Create a domain from the given object.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI.updateDomain(domain, domainID, callback)

Update an existing domain by the given object. To modify only certain fields of the domain you can include just these fields inside of the domain object you pass. The destination path for the request is determined by the ID.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI.deleteDomain(domainID, callback)

Delete a specific domain. The destination path for the request is determined by the ID.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI.findAgentToken(filter, callback)

Read all existing tokens depending on an optional filter.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI.createAgentToken(agentToken, callback)

Create an server agent token from the given object. In the following step this token can be used to run the server agent.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI.deleteAgentToken(agentToken, callback)

Delete a specific agent token. The destination path for the request is determined by the ID.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI.findInfectedDomains(filter, callback)

Read list of infected domains depending on an optional filter.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI.findDomainResults(domainID, filter, callback)

Read list of results of a domain depending on an optional filter.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI.updateDomainResult(domainID, resultID, result, callback)

Update an existing DomainResult by the given object. Only status can be modified to acknowledge a specific result. The destination path for the request is determined by the ID.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI.getDomainMetadata(domainID, callback)

Retrieve domain metadata. The destination path for the request is determined by the ID.

Kind: instance method of NimbusecAPI
Access: public

nimbusecAPI._parseResponse(err, data, response, callback) ℗

Parse the HTTP response. Will get the error message in x-nimbusec-error header if present. Will parse JSON into JavaScript Object if present.

Kind: instance method of NimbusecAPI
Access: private

nimbusecAPI._get(uri, filter, callback) ℗

Execute a HTTP GET request on the API server.

Kind: instance method of NimbusecAPI
Access: private

nimbusecAPI._delete(uri, callback) ℗

Execute a HTTP DELETE request on the API server.

Kind: instance method of NimbusecAPI
Access: private

nimbusecAPI._post(uri, obj, callback) ℗

Execute a HTTP POST request on the API server.

Kind: instance method of NimbusecAPI
Access: private

nimbusecAPI._put(uri, obj, callback) ℗

Execute a HTTP PUT request on the API server.

Kind: instance method of NimbusecAPI
Access: private

NimbusecAPI~findBundlesCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~findDomainsCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~createDomainCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~updateDomainCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~deleteDomainCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~findAgentTokenCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~createAgentTokenCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~deleteAgentTokenCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~findInfectedDomainsCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~findDomainResultsCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~updateDomainResultCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~getDomainMetadataCallback : function

Kind: inner typedef of NimbusecAPI

NimbusecAPI~Domain : object

Kind: inner typedef of NimbusecAPI
Properties

NimbusecAPI~DomainMetadata : object

Kind: inner typedef of NimbusecAPI
Properties

NimbusecAPI~Result : object

Kind: inner typedef of NimbusecAPI
Properties

NimbusecAPI~Package : object

Kind: inner typedef of NimbusecAPI
Properties

NimbusecAPI~Agent : object

Kind: inner typedef of NimbusecAPI
Properties

NimbusecAPI~AgentToken : object

Kind: inner typedef of NimbusecAPI
Properties

NimbusecAPI~User : object

Kind: inner typedef of NimbusecAPI
Properties

NimbusecAPI~Notification : object

Kind: inner typedef of NimbusecAPI
Properties

NimbusecAPI~CMS : object

Kind: inner typedef of NimbusecAPI
Properties

NimbusecAPI~Error : object

Error object passed in first argument of callbacks.

Kind: inner typedef of NimbusecAPI
Properties