Bucket Resources

Retrieve details for the buckets available to the authorized account. If the account belongs to multiple teams, buckets for all the teams the belong to are accessible.


Bucket List

These bucket keys may be used to make requests through Runscope to capture API data on behalf of the authorized account. Authenticated buckets are only returned if you are authorized with the bucket:auth_token scope.

Request

GET/buckets

Response

Returns a list of buckets.

Sample Response Data
{
    "data": [
        {
            "auth_token": null, 
            "default": false, 
            "key": "z20co0kgljjk", 
            "name": "Lucky Notebook", 
            "team": {
                "name": "Personal Team", 
                "uuid": "7a7a0917-91d7-43ef-b8f4-fe31762167e0"
            }, 
            "verify_ssl": true
        }, 
        {
            "auth_token": null, 
            "default": false, 
            "key": "ov2f2tqifoov", 
            "auth_token": "7n7n0917-91q7-43rs-o8s4-sr31762167r0",
            "name": "Mobile Apps", 
            "team": {
                "name": "Mobile Team", 
                "uuid": "7a7a0917-91d7-43ef-b8f4-fe31762167e0"
            }, 
            "verify_ssl": true
        }, 
    ], 
    "meta": {
        "status": "success"
    }
}

Bucket Detail

Retrieve the details of a given bucket by key.

Request

GET/buckets/<bucket_key>

Response

Returns a single bucket resource.

Data Attributes
auth_token Bucket auth token if set, otherwise this value is null
default True if this bucket is the 'default' for a team. Default buckets cannot be deleted.
key The unique identitifer used to address a bucket.
name The name of this bucket as displayed in your dashboard.
team An object describing the team this bucket belongs to. Includes the name and uuid of the team.
verify_ssl True if this bucket is configured to verify ssl for requests made to it.
Sample Response Data
{
    "data": {
        "auth_token": null, 
        "default": false, 
        "key": "ov2f2tq1floq", 
        "name": "Mobile Apps", 
        "team": {
            "name": "Mobile Team", 
            "uuid": "7a7a0917-91d7-43ef-b8f4-fe31762167e0"
        }, 
        "verify_ssl": true
    }, 
    "meta": {
        "status": "success"
    }
}

Creating a Bucket

Request

POST/buckets

POST Parameters
name string required Name of this bucket.
team_uuid uuid required Unique identifier for the team this to create this bucket for.

Response

Data Attributes
auth_token Bucket auth token if set, otherwise this value is null
default True if this bucket is the 'default' for a team. Default buckets cannot be deleted.
key The unique identitifer used to address a bucket.
name The name of this bucket as displayed in your dashboard.
team An object describing the team this bucket belongs to. Includes the name and uuid of the team.
verify_ssl True if this bucket is configured to verify ssl for requests made to it.
Sample Response Data
{
	"data": {
		"auth_token": null, 
		"default": false, 
		"key": "ov2f2tq1floq", 
		"name": "Mobile Apps", 
		"team": {
			"name": "Mobile Team", 
			"uuid": "7a7a0917-91d7-43ef-b8f4-fe31762167e0"
		}, 
		"verify_ssl": true
	}, 
	"meta": {
		"status": "success"
    }
}

Deleting a Bucket

Delete a bucket by key. You cannot delete the default bucket on an account.

Request

DELETE/buckets/<bucket_key>

Response

204 No Content with no body.


Clearing a Bucket

Clear a bucket (remove all messages) by key.

Request

DELETE/buckets/<bucket_key>/messages

Response

204 No Content with no body.