UpdateCollection - Chronosphere Documentation

Authorizations

API-Token

string

header

required

Chronosphere API token

Path Parameters

slug

string

required

Body

application/json

collection

object

The Collection to update.

Show child attributes

collection.name

string

required

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

collection.team_slug

string

required

The slug of the team that the collection belongs to.

collection.description

string

A description of the collection.

collection.notification_policy_slug

string

The slug of the default notification policy for monitors in this collection. This value is only required when the collection contains monitors and one or more of those monitors don't explicitly reference a policy. This value does not override the policy used when a monitor explicitly references a different policy.

collection.slug

string

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

create_if_missing

boolean

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

dry_run

boolean

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

Response

A successful response containing the updated Collection.

collection

object

Show child attributes

collection.name

string

required

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

collection.team_slug

string

required

The slug of the team that the collection belongs to.

collection.created_at

string<date-time>

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

collection.description

string

A description of the collection.

collection.notification_policy_slug

string

The slug of the default notification policy for monitors in this collection. This value is only required when the collection contains monitors and one or more of those monitors don't explicitly reference a policy. This value does not override the policy used when a monitor explicitly references a different policy.

collection.slug

string

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

collection.updated_at

string<date-time>

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

Endpoints

Authorizations

Path Parameters

Body

Response