Home → Documentation → Configuration API → API Keys
Jump to

API Keys

Create and list your API keys. The Configuration API key is used for all methods associated with the Configuration API, including establishing swarms and their resources as well as managing invitations. The Participation API key is used for connecting resources to the swarms they are members of to allow production and consumption of data in those swarms. More information on this use can be found in the Participation API.

Create

  • URL: http://api.bugswarm.net/keys
  • Method: POST
  • Authentication: "username:password"
  • Parameters (Required): None
  • Parameters (Optional): Key type

This method is used to create API keys. If a key already exists, this method will replace that key with a new one. To create a specific key, users must specify the key type in the URL. For instance, http://api.bugswarm.net/keys/participation will generate the participation key, while http://api.bugswarm.net/keys will generate both keys by default.

Usage: 
curl -X POST --user "username:password" http://api.bugswarm.net/keys
curl -X POST --user "username:password" http://api.bugswarm.net/keys/configuration
curl -X POST --user "username:password" http://api.bugswarm.net/keys/participation
Returns: The created key(s) as either a JSON object or, if no type of is specified, an array of JSON objects. 
[
  {
    "created_at": "2011-10-21T15:37:35.636Z", 
    "key": "b8c2382d0fd9123f3d0ccc760afa03854c652fdb", 
    "status": "active", 
    "type": "configuration", 
    "user_id": "username"
  }, 
  {
    "created_at": "2011-10-21T15:37:35.744Z", 
    "key": "c0eb23bb29bcf123d74d79801bdc5b06f1e97bdd", 
    "status": "active", 
    "type": "participation", 
    "user_id": "username"
  }
]

List

  • URL: http://api.bugswarm.net/keys
  • Method: GET
  • Authentication: "username:password"
  • Parameters (Required): None
  • Parameters (Optional): Key type

This method will list the API keys associated with the user's account. Users may specify which key they would like to retrieve by specifying the key type in the the URL. For instance, http://api.bugswarm.net/keys/configuration will retrieve the configuration key, while http://api.bugswarm.net/keys/participation will retrieve the participation key. If no key type is specified in the URL, all keys will be returned.

Usage: 
curl -X GET --user "username:password" http://api.bugswarm.net/keys
curl -X GET --user "username:password" http://api.bugswarm.net/keys/configuration
curl -X GET --user "username:password" http://api.bugswarm.net/keys/participation
Returns: The desired key(s) as either a JSON object or, if no type is specified, an array of JSON objects.
[
    {
        "key": "c7cf33294f91c29abc778c8f6382eaaed8405372",
        "user_id": "username",
        "created_at": "2011-09-09T23:45:22.109Z",
        "status": "active",
        "type": "configuration"
    },
    {
        "key": "33d1e9e8fe9802e34c99b6c465552a0bc2ca0714",
        "user_id": "username",
        "created_at": "2011-09-09T23:45:22.221Z",               
        "status": "active",
        "type": "participation"
    }
]