List services
A page of the organization's services, ordered by sort. For a key
that also holds catalog:resource:read, each service carries
live_environments: how many environments it runs in.
Requires the catalog:component:read scope.
Authorization
Parameters
Query parameters
owner_team_idstringOnly services owned by this team.tierintegerOnly services whose tier is at this place in the order, 1 the most critical.lifecycleLifecyclekindComponentKindqstringSearch the name and slug, at most 100 characters.sortstringslug(the default),kind,tier(services with no tier last) orlifecycle; a leading-reverses it. Any other value is refused.limitintegerPage size, 20 by default, at most 100.cursorstringThe previous page'spagination.next_cursor.
Responses
200
A page of services.
dataarray of Component & objectidstringorg_idstringslugstringdisplay_namestringdescriptionstringkindComponentKindowner_team_idstring | nulltier_idstring | nulltierinteger | nullThe tier's place in the order, 1 the most critical.sla_overridesSLATargetsShow SLATargets properties
availabilitynumberA percentage above 0 and at most 100, up to 3 decimals.responseobjectMinutes to acknowledge, per On-Call severity (critical,high,medium,low,info), 1 to 525600.resolutionobjectMinutes to resolve, per severity.support_hoursobjectkindstring requiredtimezonestringdaysarray of integerISO weekdays, 1 is Monday.fromstringtostring
max_unowned_daysinteger
lifecycleLifecyclerepo_urlstringdocs_urlstringrunbook_urlstringcreated_bystringcreated_atstring (date-time)updated_atstring (date-time)live_environmentsintegerEnvironments it runs in. Only withcatalog:resource:read.
paginationPaginationShow Pagination properties
next_cursorstring | nullhas_morebooleantotalintegerHow many match, on the first page of the resource and application lists.
400
The request is not valid: a field or filter value is wrong
(VALIDATION_ERROR, with a sentence saying what), the body is not
the expected JSON or carries an unknown field (INVALID_BODY), the
cursor is not one this list gave (INVALID_CURSOR), a binding names
a service that does not exist (UNKNOWN_COMPONENT), or a PATCH
tries to change a slug (SLUG_IMMUTABLE).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
403
The key lacks a scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
429
Too many requests (RATE_LIMITED). Wait for Retry-After seconds.
Retry-AfterintegerSeconds to wait before retrying.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
Example request
curl -X GET 'https://evohub.io/api/v1/catalog/components' \
-H 'Authorization: Bearer <TOKEN>'
