Administrative APIs mostly handle operational tasks such as cluster switches. They do not provide access to Sophora documents. This use case is covered by the Sophora Content API.
All enpoints prefixed with v1 require basic authentication. Here is an example using curl to initiate a cluster switch:
curl --request POST --data '{"serverId": "3f97b113-8a71-31e2-a4f3-2d8d48772eaf"}' -u admin:admin -H 'Content-Type: application/json' 'http://localhost:1196/v1/management/switchPrimary'
| Name | Path | Format | Method | Description |
|---|---|---|---|---|
| Thread Dump | /threaddump | Plain Text | GET | Creates a thread dump and returns the result as unstructured text. It uses the same thread dump format as jstack. |
| Started | /status/started | true/false | GET | Informs, whether the server's startup has completed |
| Readiness | /status/ready | true/false | GET | Informs, whether the server is ready to take requests. On Replicas and Stages this especially awaits pending synchronizations from the primary. |
| Liveness | /status/liveness | true | GET | Always returns the String "true". This endpoint can be used to check, whether the server generally is running. |
| Configuration Hashes - System Documents | /v1/management/configurationHash/systemDocument | JSON | GET | Returns the configuration hashes of all system documents. Each hash entry also contains a json representation of the system document. Available since Server Version 5.5.0 |
| Configuration Hashes - Structure Nodes | /v1/management/configurationHash/structureNodeDocument | JSON | GET | Returns the configuration hashes of all structure nodes. Each hash entry also contains a json representation of the structure node. Available since Server Version 5.5.0 |
| Configuration Hashes - Document Proposals | /v1/management/configurationHash/documentProposalSection | JSON | GET | Returns the configuration hashes of all document proposals. Available since Server Version 5.5.0 |
| Configuration Hashes - CNDs | /v1/management/configurationHash/cnd | JSON | GET | Returns the configuration hashes of all cnds. Available since Server Version 5.5.0 |
| IBF - latest documents versions | /v1/management/ibf/cluster | JSON | GET | Returns the invertible bloom filter for documents in the default workspace. Available since Server Version 5.5.0 |
| IBF - live versions | /v1/management/ibf/staging | JSON | GET | Returns the invertible bloom filter for documents in the live workspace. Available since Server Version 5.5.0 |
| Server Info | /v1/management/server | JSON | GET | Returns the server info of the current server. Available since Server Version 5.5.0 |
| Server Infos | /v1/management/servers | JSON | GET | Returns all known server infos in the cluster. Available since Server Version 5.5.0 |
| Primary Switch | /v1/management/switchPrimary | JSON | POST | Initiates a cluster switch. Pass the server id of the new primary server as json:{"serverId": "3f97b113-8a71-31e2-a4f3-2d8d48772eaf"}Available since Server Version 5.5.0 |
Monitoring APIs
The monitoring APIs to access the Sophora Server status and prometheus metrics are described here.
