Skip to content

List of Hubs

Request

Filters and returns Hub records with basic info.

Security
ApiKeyAuth
Query
typestring

Filters Hubs by their type.

Possible values:

  • type=primary - return only Primary Hubs,
  • type=connected - return only Connected Hubs.

Hub types:

  • Primary Hub - Independent Hub without any overlap with other Hubs data.
    Associated with billing subscription. Can have Connected Hubs if its subscription allows it.

  • Connected Hub - Hub that shares following aspects with its Primary Hub

    • Subset of Groups,
    • Subset of Services,
    • Events affecting the shared Services,
    • Subscription.

    All other data like Subscriptions and settings is independent.

Default:"primary"
Enum:"primary""connected"
parent_idstring

Valid only for Connected Hubs.
Filters Hubs by their Primary Hub ID.

qstring

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

  • name,
  • subdomain.
sort_propstring

Determines which property results should be sorted by.

Default:"position"
Enum:"position""created_at""start_time"
sort_dirstring

Determines sorting direction.

Default:"asc"
Enum:"asc""desc"
per_parent_sortstring

Valid only for Connected Hubs.

  • true - sorts Connected Hubs by their parent Primary Hub position,
  • false - omits sorting Connected Hubs by their parent Primary Hub position.
Enum:"true""false"
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?type=primary&parent_id=string&q=string&sort_prop=position&sort_dir=asc&per_parent_sort=true&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": [
    { … }
  ]
}