No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
dkenzox Merge pull request #23 from packethost/fix-documentation
Fixes request ip method in documentation
Latest commit edb31a2 Jun 3, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
test Add Ip and Device traffic methods Jun 3, 2016
.gitignore
.jscsrc
.jshintrc
Gruntfile.js
README.md
package.json
shippable.yaml

README.md

Packet Nodejs Build Status

Is a nodejs library which helps you consume our api routes.
For more info about the routes, please go to our Api's documentation

Installation

npm install packet-nodejs or git clone git@github.com:packethost/packet-nodejs.git

Use

Packet = require('packet-nodejs');
var api = new Packet('YOU API TOKEN HERE');
//You can change your Token later on
api.setApiToken('YOUR NEW TOKEN');

Implemented Routes

Methods

NOTES

To make the documentation simpler and easier to read I'll put here comments on general variables that would otherwise make the documentation too long if put in every method:

  • All the implemented methods take a callback function as the last parameter. This function accepts 2 parameters, error which is where an error will be if there was a problem with the request and body where you will find the data if there is any.

Projects

Parameters

id Project's ID.
project Project object.
parameters Parameters used for pagination and other filters, use false if you don't need anything.
user User's ID or User's Email.
callback Callback Function used to return the api's response.

Get Projects

Note: You can set id as false to get all the projects.
api.getProjects(id, parameters, callback);

Add Projects

api.addProject(project, callback);

Update Projects

api.updateProject(id, project, callback);

Remove Project

api.updateProject(id, callback);

Transfer Project's Ownership

api.transferProject(id, user, callback);

Invite To Project

api.inviteToProject(id, user, callback);

Request more IPs for a single project

api.requestIp(id, request, callback);

Get Project's IP Reservations

api.getProjectIpReservations(id, parameters, callback);

Devices

Parameters

projectId Project's ID.
id Device's ID.
device Device object.
parameters Parameters used for pagination and other filters, use false if you don't need anything.
action A valid action name. More Info
callback Callback Function used to return the api's response.

Get Devices

Note: You can set id as false to get all the devices a project has.
api.getProjects(projectId, id, parameters, callback);

Add Devices

api.getDevices(projectId, device, callback);

Update Devices

api.updateDevice(id, device, callback);

Remove Devices

api.removeDevice(id, callback);

Device Actions

api.deviceAction(id, action, callback);

Assign IP to Device

api.assignIp(id, ip, callback);

Device Traffic

api.getDeviceTraffic(id, parameters, callback);

Facilities

Parameters

callback Callback Function used to return the api's response.

Get Facilities

api.getLocations(callback);

Operating Systems

Parameters

callback Callback Function used to return the api's response.

Get Operating Systems

api.getOperatingSystems(callback);

Plans

Parameters

callback Callback Function used to return the api's response.

Get Plans

api.getPlans(callback);

Memberships

Parameters

id Membership's ID.
membership Membership object.
callback Callback Function used to return the api's response.

Get a single membership

api.getMembership(id, callback);

Update membership

api.updateMembership(id, membership, callback);

Remove membership

api.removeMembership(id, callback);

Invitations

Parameters

id Invitation's ID.
callback Callback Function used to return the api's response.

Get a single invitation

api.getInvitation(id, callback);

Accept an invitation

api.acceptInvitation(id, callback);

Remove invitation

api.removeInvitation(id, callback);

Ips

Parameters

id Ip's ID.
callback Callback Function used to return the api's response.

Get a single Ip

api.getIp(id, callback);

Remove invitation

api.removeIp(id, callback);

Transfer

Parameters

id Membership's ID
callback Callback Function used to return the api's response.

Get Transfer Request

api.getTransfer(id, callback);

Accept a Transfer Request

api.acceptTransfer(id, callback);

Remove a Transfer Request

api.removeTransfer(id, callback);

User

Parameters

user User object
callback Callback Function used to return the api's response.

Get User

api.getUser(callback);

Update current user

api.updateCurrentUser(user, callback);

Events

Parameters

id Event's ID
parameters Parameters used for pagination and other filters, use false if you don't need anything.
callback Callback Function used to return the api's response.

Get events

Note: Leaving id as false will return all the events for the current user. api.getEvents(id, parameters, callback);

Notifications

Parameters

id Notification's ID
parameters Parameters used for pagination and other filters, use false if you don't need anything.
callback Callback Function used to return the api's response.

Get notifications

Note: Leaving id as false will return all the notifications for the current user. api.getNotifications(id, parameters, callback);

SSH Keys

Parameters

id Notification's ID.
sshkey SSH Key object.
callback Callback Function used to return the api's response.

Get ssh keys

Note: Leaving id as false will return all the ssh keys for the current user. api.getSshkeys(id, parameters, callback);

Add a ssh key

api.addSshkey(sshkey, callback);

Update a ssh key

api.updateSshkey(id, sshkey, callback);

Remove a ssh key

api.removeSshkey(id, callback);

Email

Parameters

id Notification's ID.
email Email object.
callback Callback Function used to return the api's response.

Get an email

api.getEmail(id, callback);

Add an email

api.addEmail(email, callback);

Update an email

api.updateEmail(id, email, callback);

Remove an email

api.removeEmail(id, callback);