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.

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>'

Attributes

• auth_tokenstring

  Bucket auth token if set, otherwise this value is null

• created_atinteger

  Time stamp for bucket creation

• 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

  Show/Hide Child Attributes

  • namestring

    The name of this team

  • uuidstring

    The unique identifier for this 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%.

• is_privateboolean

  True if the bucket is private, and false if public

• are_secrets_enabledboolean

  True if secrets are enabled in the bucket

• tests_countinteger

  Number of tests in the bucket

{
    "meta": {
        "status": "success"
    },
    "data": {
        "name": "new-RB",
        "key": "ez97w2r9wgzw",
        "auth_token": null,
        "default": false,
        "verify_ssl": true,
        "created_at": 1754570554,
        "is_private": false,
        "are_secrets_enabled": false,
        "tests_count": 72,
        "team": {
            "name": "tester_runscope_team",
            "id": "ad216122-ee73-4b2f-8ff3-b1ce14b1fd52"
        },
        "custom_emails": [],
        "collections_url": "https://stageapi.runscope.com/buckets/ez97w2r9wgzw/collections",
        "messages_url": "https://stageapi.runscope.com/buckets/ez97w2r9wgzw/stream",
        "tests_url": "https://stageapi.runscope.com/buckets/ez97w2r9wgzw/tests",
        "trigger_url": "https://stageapi.runscope.com/radar/bucket/3a144e5c-074a-43ac-8398-07ea3163a0b8/trigger",
        "is_schedule_test_paused": false
    },
    "error": null
}