Count websites

GET

https://api.modulards.com/api/public/v1/sites/count

Returns how many websites match the filters, without listing them. Use it to size a selection, for example how many websites carry a tag or run a given PHP version, before you act on it.

It accepts the same filters as “List websites”. Only filter is accepted: sort, page, fields and include answer 422.

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 on the website's name, slug or address.

filter[core_version][]stringOptional

Exact WordPress versions, for example 6.8.1. Several values match any of them.

filter[engine_version][]stringOptional

Exact PHP versions, for example 8.2.27. Several values match any of them.

filter[alerts][]stringOptional

Notification configuration ids. Several values match websites associated with any of them.

filter[id][]stringOptional

Website ids. Several values match any of them.

filter[team][]stringOptional

Team ids. Several values match websites in any of these teams.

filter[tags][]stringOptional

Tag ids. Several values match websites carrying any of these tags.

filter[connected]stringOptional

1 for websites whose connection works, 0 for websites that are not connected.

filter[patchstack]stringOptional

1 for websites with Patch & Protect switched on, 0 for websites without it.

Response

200 - Website count

jsonapiobjectOptional

metaobjectOptional