Global Search
Find resources of your active account by name: endpoints, applications, domains and databases, in one call. This is the search behind the dashboard's command palette (⌘K). Each group returns at most 5 matches.
Matching is a case-insensitive substring match; matches that start with q come first (for an endpoint: its subdomain), each part in alphabetical order. % and _ in q are matched literally, not as wildcards. What each group searches:
- endpoints — the subdomain, the domain, or the whole hostname. Deleted endpoints are left out.
- applications — the application name. Deleted applications are left out.
- domains — the name of the account's own custom domains (the platform's shared domains are not included).
- databases — the database name, or the schema name of a database that has no name. Databases being deleted are left out.
Permissions: a group is searched only when your role may read it: endpoints need endpoints:read; applications need endpoints:read and the application_hosting entitlement; domains need domains:read; databases need databases:read and the managed_database entitlement. A group you can't read comes back as an empty array, never as an error.
Rate limit: 120 requests per minute per user. The search has a 3-second time budget; a search that runs out of time answers 500.
Query parameters
Response (200 OK)
q that was searched.uuid, hostname (the full hostname), status and serving_mode (agent for a tunnel endpoint; agentless for a static application, managed for a managed backend, WordPress or full-stack application). The uuid addresses the endpoint in GET /v1/endpoints/{uuid}.uuid, name and status. The uuid is the one the per-domain operations take, e.g. ACME status.All four arrays are always present; a group with no match (or one you can't read) is [].
Errors
q must be 2 to 64 characters — q is missing, too short or too long.No active account for this request, or Not a member of the active account.{"error": "Rate limit exceeded. Please try again later."}, header Retry-After: 60.Search failed (including a search that ran out of time), or Failed to resolve permissions.