Service information endpoints
This section details the Helix Search service endpoints.
Service status
Description
GET http://localhost:1601/api/v1.2/status
A status check for the Helix Search service. Returns the status of services such as Helix server, Elasticsearch hosts and the Elasticsearch plugin.
Usage example
Get the status of the services:
curl http://localhost:1601/api/v1.2/status
Helix Search responds with the status of each service:
{ "status": { "code": 200, "message": "OK" }, "data": [ { "name": "config", "title": "Configuration", "status": "SUCCESS" "description": "Location: /p4search/config.properties" }, { "name": "p4-status", "title": "Perforce Connection", "status": "SUCCESS" "description": "P4PORT: localhost:1666" }, { "name": "p4-auth", "title": "Perforce Authentication", "status": "SUCCESS" "description": "P4USER: bot-integ" }, { "name": "es-status", "title": "Elasticsearch Hosts", "status": "SUCCESS" "description": "Hosts: http://localhost:9200 }, { "name": "es-plugin", "title": "Elasticsearch Protect Plugin", "status": "SUCCESS" "description": "Plugin: p4search-filter(disabled)" }, { "name": "security", "title": "Service Security", "status": "WARNING", "description": "Security (for the configuration pages): Disabled" } ] }
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" } [ }