UpdateBucket - Chronosphere Documentation

Authorizations

API-Token

string

header

required

Chronosphere API token

Path Parameters

slug

string

required

Body

application/json

bucket

object

The Bucket to update.

Show child attributes

bucket.name

string

required

The name of the Bucket. You can modify this value after the Bucket is created.

bucket.description

string

Optional description of the bucket.

bucket.labels

object

Optional labels marking the bucket.

Show child attributes

bucket.labels.{key}

string

bucket.notification_policy_slug

string

Slug of the notification policy used by default for monitors in this bucket. This is optional if the bucket does not contain monitors or all of its monitors explicitly reference a policy. This policy takes precedence over a bucket-owned notification policy. This does not override the policy used when a monitor explicitly references a policy.

bucket.slug

string

The unique identifier of the Bucket. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the Bucket is created.

bucket.team_slug

string

Optional slug of the team the bucket belongs to.

create_if_missing

boolean

If true, the Bucket will be created if it does not already exist, identified by slug. If false, an error will be returned if the Bucket does not already exist.

dry_run

boolean

If true, validates the specified configuration without creating or updating the Bucket. If the specified configuration is valid, the endpoint returns a partial response without the Bucket. If the specified configuration is invalid, the endpoint returns an error.

Response

A successful response containing the updated Bucket.

bucket

object

Show child attributes

bucket.name

string

required

The name of the Bucket. You can modify this value after the Bucket is created.

bucket.created_at

string<date-time>

Timestamp of when the Bucket was created. Cannot be set by clients.

bucket.description

string

Optional description of the bucket.

bucket.labels

object

Optional labels marking the bucket.

Show child attributes

bucket.labels.{key}

string

bucket.notification_policy_slug

string

Slug of the notification policy used by default for monitors in this bucket. This is optional if the bucket does not contain monitors or all of its monitors explicitly reference a policy. This policy takes precedence over a bucket-owned notification policy. This does not override the policy used when a monitor explicitly references a policy.

bucket.slug

string

The unique identifier of the Bucket. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the Bucket is created.

bucket.team_slug

string

Optional slug of the team the bucket belongs to.

bucket.updated_at

string<date-time>

Timestamp of when the Bucket was last updated. Cannot be set by clients.

Endpoints

Authorizations

Path Parameters

Body

Response