Sitecore API catalog/Status API/Status

Status

The status endpoint is used to retrieve information about the health and status of the system.

Operations

Retrieve overall system status

Request

Retrieves a summary of Content Hub system health, including minimal aggregated service status and links to detailed status resources. You do not need to authenticate to use this endpoint.

Security
OAuth2
curl -i -X GET \
  https://your-server/api/status \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Body
product_versionstring or null
build_datestring or null
rollout_datestring or null, (date-time)

The date the tenant was last updated. Unlike the build or release date, this property is tenant specific.

hostnamestring or null
region_namestring or null
aggregated_service_status_labelstring or nullread-only

Label for Stylelabs.M.Base.Web.Api.Models.Status.StatusInfoResource.AggregatedStatus.

index_template_versionsobject or null(IndexMappingMetaResource)
queuesobject(Link)

Represents a link to a resource.

jobsobject(Link)

Represents a link to a resource.

usersobject(Link)

Represents a link to a resource.

licenseobject(Link)

Represents a link to a resource.

systemobject(Link)

Represents a link to a resource.

errorobject(Link)

Represents a link to a resource.

data_storageobject(Link)

Represents a link to a resource.

media_storageobject(Link)

Represents a link to a resource.

searchobject(Link)

Represents a link to a resource.

graphobject(Link)

Represents a link to a resource.

service_statusobject(Link)

Represents a link to a resource.

versionobject(Link)

Represents a link to a resource.

publishingobject(Link)

Represents a link to a resource.

video-indexing-durationobject(Link)

Represents a link to a resource.

selfobject(Link)

Represents a link to a resource.

Response
{
  "product_version": "string",
  "build_date": "string",
  "rollout_date": "2019-08-24T14:15:22Z",
  "hostname": "string",
  "region_name": "string",
  "aggregated_service_status_label": "string",
  "index_template_versions": {
    "main_template_version": "string",
    "audit_template_version": { … }
  },
  "queues": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "jobs": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "users": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "license": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "system": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "error": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "data_storage": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "media_storage": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "search": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "graph": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "service_status": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "version": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "publishing": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "video-indexing-duration": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  }
}