Service information endpoints
This section details the Helix Search service endpoints.
Service status
Description
GET http://localhost:1601/api/v1.2/status
An admin can perform a status check for the Helix Search service. Returns the status of services such as Helix Server, Elasticsearch hosts, Elasticsearch plugin, and the Extensions. When used without authentication, the extension status is not returned.
Authentication
Supports basic authentication and bearer token authentication, see API authentication.
Usage example
Get the status of the services:
curl -H "Authorization: Bearer <auth_token>" http://localhost:1601/api/v1.2/status
Helix Search responds with the status of each service:
{ "status": { "code": 200, "message": "OK" }, "data": [ { "name": "p4-status", "title": "Helix Core server connection", "status": "SUCCESS", "description": "P4PORT: p4d.helix:1666" }, { "name": "p4-auth", "title": "Helix Core Service authentication", "status": "SUCCESS", "description": "P4USER: p4search" }, { "name": "p4-index", "title": "Helix Core Index authentication", "status": "SUCCESS", "description": "P4USER: super" }, { "name": "es-status", "title": "Elasticsearch Hosts", "status": "SUCCESS", "description": "Hosts: http://es.helix:9200" }, { "name": "es-plugin", "title": "Elasticsearch Protect plugin", "status": "SUCCESS", "description": "Plugin: p4search-filter(enabled)" }, { "name": "auto-detect", "title": "Image detection service", "status": "SUCCESS", "description": "DeepDetect - Image tagging" }, { "name": "asset-ext", "title": "Helix Core Asset (extension)", "status": "SUCCESS", "description": "Installed: helix-core-search-asset" }, { "name": "index-ext", "title": "Helix Core Indexer (extension)", "status": "SUCCESS", "description": "Installed: helix-core-search-indexer" }, { "name": "obliterate-ext", "title": "Helix Core Obliterate (extension)", "status": "SUCCESS", "description": "Installed: helix-core-search-obliterate" } ] }
Service configuration
Description
GET http://localhost:1601/api/v1.2/config
Displays the service configuration parameters and their current values.
Authentication
Supports X-Auth-Token authentication and bearer token authentication (admin or greater), see API authentication.
Usage example
Get the current values of the service configuration parameters:
curl -X GET -H "X-Auth-Token: <X-AUTH-TOKEN>" -H "Content-Type: application/json" http://localhost:1601/api/v1.2/config
Helix Search responds with:
{ "status": { "code": 200, "message": "OK" }, "data": [ { "com.perforce.p4search.service.host": "0.0.0.0", "com.perforce.p4search.core.p4trust": "", "com.perforce.p4search.index.restricted": "true", "com.perforce.p4search.tika.maxfilesize": "104857600", "com.perforce.p4search.core.service.p4user": "p4search", "com.perforce.p4search.elastic.tracktotalhits": "10000", "com.perforce.p4search.service.version": "2021.3.2187544", "com.perforce.p4search.index.threads": "8", "com.perforce.p4search.service.keypass": "", "com.perforce.p4search.service.keystore": "", "com.perforce.p4search.index.bulksize": "10000", "com.perforce.p4search.core.allowed": "", "com.perforce.p4search.core.anonymous.p4ticket": "", "com.perforce.p4search.service.product": "p4search", "com.perforce.p4search.index.name": "perforce1", "com.perforce.p4search.core.service.p4ticket": "DDF5996CE30C5DF5EC48261457451512", "com.perforce.p4search.core.anonymous.p4user": "anonymous", "com.perforce.p4search.elastic.hosts": "http://localhost:9200", "com.perforce.p4search.service.port": "1601", "com.perforce.p4search.elastic.filter": "true", "com.perforce.p4search.elastic.user": "", "com.perforce.p4search.elastic.pass": "", "com.perforce.p4search.service.protocol": "http", "com.perforce.p4search.core.p4port": "localhost:1666" } [ }
Service build version
Description
GET http://localhost:1601/api/v1.2/build
Returns current build version of the Helix Search service.
Usage example
Get the build version of the Helix Search service:
curl http://localhost:1601/api/v1.2/build
Helix Search responds with:
{ "status": { "code": 200, "message": "OK" }, "data": [ { "2021.3.2187544" } [ }
Last indexed time
Description
GET http://localhost:1601/api/v1.2/status/lastindexed
Returns the time Helix Server was last indexed.
Example usage
To check the last index time:
curl http://localhost:1601/api/v1.2/status/lastindexed
Helix Search responds with:
{ "status": { "code": 200, "message": "OK" }, "data": "Thu Mar 03 13:15:34 GMT 2022" }