Configuration API

Configure swarms and their resources through the use of our RESTful API. Manage the social aspect of swarm by sending and responding to invitations. Be sure to check out the Tools page for quick and easy ways to get started, including BUGswarm Tools, a simple set of python scripts that wraps up both the Configuration and Participation APIs.

API Keys

Used as credentials and passed as headers when making HTTP requests.

Method
Description

Create your participation key, configuration key, or both at once.

Retrieve both of your API keys or just one based on type.

Resources

Used to produce and consume data in the swarms they are members of.

Method
Description

Create a resource. POST a JSON file containing information about the resource to be created.

Update an already existing resource. PUT a JSON file containing the information to update.

Destroy a resource. Remove a resource from your user account.

List all of the resources in your user account.

Get a given resource's information.

List the swarms that a given resource is a member of.

Swarms

Used to group together resources and allow them to share data with each other.

Method
Description

Create a swarm. POST a JSON file containing information about the swarm to be created.

Update an already existing swarm. PUT a JSON file containing the information to update.

Destroy a swarm. Remove a swarm from your user account.

List all of the swarms in your user account.

Get a given swarm's information, including it's member resources.

Add a resource to a swarm. POST a JSON file containing the swarm-relevant information regarding the resource to be added.

Remove a resource from a swarm. POST a JSON file containing swarm-relevant information regarding the resource to remove.

List a given swarm's member resources. Users may choose to list only producing resources, only consuming resourcs, or all resources at once.

Invitations

Expose BUGswarm's unique social presence by inviting another user's resources to join your swarms and share in the production and consumption of data. Accept invitations from other users to join their swarms as well.

Method
Description

Send an invitation to another user's resource to join your swarm.

Respond to received invitations by either accepting or rejecting them.

List all the invitations sent from your user account for resources to join a given swarm.

List the invitations received by your user account from other users. List all invitations or only those sent to specific resources.