Skip to navigation

List uptime global configurations

View as MarkdownOpen in Claude

Lists your Uptime Monitor global configurations: the named check settings you assign to websites. Use it to find the id of a configuration to retrieve, update, delete or assign websites to, or to see which one new websites receive by default.

The id is also what the preset_uptime field of “Create a Modular Connector download link” takes, to attach a configuration to a website that is being connected.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Query parameters

filter[s]stringOptional

Free-text search over the configuration name.

filter[is_default]stringOptional

1 returns only the configuration new websites receive; 0 returns the others.

sortstringOptional

name (default), created_at or sites_count; prefix with - for descending.

page[number]stringOptional
Page number, starting at 1. Default 1.
page[size]stringOptional
Items per page, 1 to 50. Default 15.
fields[preset-uptimes]stringOptional

Sparse fieldset: only the attributes named here are answered. sites_count, the number of websites that use each configuration, is computed only when named here or when sorting by sites_count; a fieldset that names only sites_count answers only that attribute.

filter[id][]stringOptional

Exact configuration ids. Repeat the parameter for several: any of them matches.

filter[status][]stringOptional

enabled or disabled. Repeat the parameter for several: any of them matches.

Response

200 - Uptime configurations

datalist of objectsOptional
jsonapiobjectOptional
metaobjectOptional