Bucket Detail

Retrieve the details of a given bucket by key.

Note: The list_utilizations_gt attribute is available with Runscope API v1 or higher. For more information, see the Bucket Utilization API documentation.

Returns a single bucket resource.

Test Result Detail v1

curl 'https://api.runscope.com/v1/buckets/<bucket_key>' \
    -H 'Authorization: Bearer <access_token>'

Test Result Detail v0

curl 'https://api.runscope.com/buckets/<bucket_key>' \
    -H 'Authorization: Bearer <access_token>'

Bucket Detail Response Attributes

Attributes

  • auth_tokenstring

    Bucket auth token if set, otherwise this value is null

  • defaultboolean

    True if this bucket is the 'default' for a team. Default buckets cannot be deleted

  • keystring

    The unique identitifer used to address a bucket

  • namestring

    The name of this bucket as displayed in your dashboard

  • teamobject

    An object describing the team this bucket belongs to. Includes the name and uuid of the team

  • verify_sslboolean

    True if this bucket is configured to verify ssl for requests made to it

  • list_utilizations_gtinteger

    List the percentage of concurrent tests running in each location that meets or exceeds a certain threshold. If unspecified, the default threshold is 85%.

Response200 OK

{
    "data": {
        "auth_token": null,
        "default": false,
        "key": "ov2f2tq1floq",
        "name": "Mobile Apps",
        "team": {
            "name": "Mobile Team",
            "uuid": "7a7a0917-91d7-43ef-b8f4-fe31762167e0"
        },
        "verify_ssl": true,
        "locations_utilization_%": {
            "remote": 82,
            "US California": 86, 
            "US Iowa": 90
        }
    },
    "meta": {
        "status": "success"
    }
}