Skip to content

List Services

Request

Filters and returns services for current Hub.
Can return services from all groups.
Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

Query
group_idinteger, >= 1

Filters services to only those which belong to group with ID specified by group_id.

archivedstring

Filters services by archived status:

  • true - return only services that were archived,
  • false - return only services that were not archived,
  • all - return services without filtering by archived status.
Default:"false"
Enum:"true""false""all"
deletedstring

Filters services by deletion status:

  • true - return only services that were deleted,
  • false - return only services that were not deleted,
  • all - return services without filtering by deleted status.
Default:"false"
Enum:"true""false""all"
qstring

String that filters services to those containing the search string in:

  • name,
  • custom_id.
per_group_sortboolean

Alters behavior of sort_prop:

  • (default) If per_group_sort is true - Sort by the sort_prop in each connected group individually,

  • if per_group_sort is false - Sort by sort_prop globally so output will contain connected services ignoring the order of connected groups.
    This means that connected services from same connected group may be interleaved by connected services from different connected groups.
    One exception is position sort_prop which forces per_group_sort to be true regardless of actual value used in request.

    If per_group_sort is true the order of connected groups is always determined by connected group position.

Default:true
sort_propstring

Determines which property results should be sorted by.
The final sorting depends also on per_group_sort parameter:

  • (default) If per_group_sort is true - Sort by the sort_prop in each group individually,
  • if per_group_sort is false - Sort by sort_prop globally so output will contain services ignoring the order of group.
    This means that services from same group may be interleaved by services from different groups.
    One exception is position sort_prop which forces per_group_sort to be true regardless of actual value used in request.

If per_group_sort is true the order of groups is always determined by group position.

Default:"position"
Enum:"position""created_at""updated_at"
sort_dirstring

Determines sorting direction inside each Group.
It does not affect the order of groups which is fixed to position.
Services will be sorted by sort_prop inside each group individually.

Default:"asc"
Enum:"asc""desc"
pageinteger, >= 1

Requested page index.

Default:1
per_pageinteger, [ 1 .. 100 ]

A limit on the number of records to be returned.

Default:25
api_versionstring

Api version

Value:"V3-R1"
curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/services?group_id=1&archived=true&deleted=true&q=string&per_group_sort=true&sort_prop=position&sort_dir=asc&page=1&per_page=25&api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
current_pageinteger, >= 1
Example:1
page_countinteger, >= 1
Example:4
per_pageinteger, [ 1 .. 100 ]
Example:25
totalinteger, >= 0
Example:1024
dataArray of objects
Response
{
  "current_page": 1,
  "page_count": 4,
  "per_page": 25,
  "total": 1024,
  "data": [
    { … }
  ]
}