fastmon Docs
Search

Search

Fehler melden

Search organizations, applications and sites the caller may act in.

Every organization the credential reaches is searched: direct memberships, partner clients, and for a platform admin's session every active organization. A key is cut to the organizations it was issued for and to its scopes - a key without site:read gets no sites, whatever its owner's role is. Inactive organizations never appear; inactive sites and applications do, flagged is_active: false, because reactivating one starts with finding it.

Results come per kind, each capped at limit, best match first: exact name, then prefix, then substring, then alphabetical. Applications and sites list prod before dev within each match class, so an exact dev match still beats a prefix prod match. A site's environment is its application's.

Authentifizierung

bearerAuth
headerAuthentifizierungBearer <token>

API token generated from the fastmon dashboard (Account → API Token) or at organization level (fmo_…, one that outlives its creator). Send as Authorization: Bearer fm_... or paste the full token (including its prefix) into the Authorize dialog.

Query-Parameter

q?Q

Substring to match, case-insensitive. Empty lists the first entries of each kind, applications and sites prod before dev, then by name.

Lengthlength <= 100
Default""
kinds?array<>|

Which kinds to search. Defaults to all three.

limit?Limit

Per-kind cap.

Range1 <= value <= 50
Default20

Response-Body

Successful Response

application/json
  1. response

One object holding three bounded lists, deliberately without {data, meta}.

Registered as an exemption in API_STANDARDS §9 rather than left looking like an oversight: there is no resume point for a cursor or an offset to name, and a per-kind total would be three numbers a palette cannot act on. docs/api/search.md carries the reasoning.

query*Query
limit*Limit
organizations*array<>
applications*array<>
sites*array<>
GET
/search
curl -X GET 'https://api.fastmon.eu/search'
{  "query": "string",  "limit": 0,  "organizations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "role": "owner",      "access": "member",      "is_partner": true    }  ],  "applications": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "environment": "prod",      "is_active": true,      "organization": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "role": "owner",        "access": "member"      }    }  ],  "sites": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "domain": "string",      "is_active": true,      "organization": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "role": "owner",        "access": "member"      },      "application": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "environment": "prod"      }    }  ]}