$ 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);
    }
});

$ grunt doc

$ grunt shell:generateReadme

$ grunt eslint

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

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

Construct a new NimbusecAPI object.

Read all existing bundles depending on an optional filter.

Kind: instance method of NimbusecAPI
Access: public

Read all existing domains depending on an optional filter.

Kind: instance method of NimbusecAPI
Access: public

Create a domain from the given object.

Kind: instance method of NimbusecAPI
Access: public

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

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

Kind: instance method of NimbusecAPI
Access: public

Read all existing tokens depending on an optional filter.

Kind: instance method of NimbusecAPI
Access: public

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

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

Kind: instance method of NimbusecAPI
Access: public

Read list of infected domains depending on an optional filter.

Kind: instance method of NimbusecAPI
Access: public

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

Kind: instance method of NimbusecAPI
Access: public

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

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

Kind: instance method of NimbusecAPI
Access: public

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

Execute a HTTP GET request on the API server.

Kind: instance method of NimbusecAPI
Access: private

Execute a HTTP DELETE request on the API server.

Kind: instance method of NimbusecAPI
Access: private

Execute a HTTP POST request on the API server.

Kind: instance method of NimbusecAPI
Access: private

Execute a HTTP PUT request on the API server.

Kind: instance method of NimbusecAPI
Access: private

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI

Kind: inner typedef of NimbusecAPI
Properties

Kind: inner typedef of NimbusecAPI
Properties

Kind: inner typedef of NimbusecAPI
Properties

Kind: inner typedef of NimbusecAPI
Properties

Kind: inner typedef of NimbusecAPI
Properties

Kind: inner typedef of NimbusecAPI
Properties

Kind: inner typedef of NimbusecAPI
Properties

Kind: inner typedef of NimbusecAPI
Properties

Kind: inner typedef of NimbusecAPI
Properties

Error object passed in first argument of callbacks.

Kind: inner typedef of NimbusecAPI
Properties