RESTAPI:Cryptshare Server Status Endpoint
This endpoint returns information about the Cryptshare Server, e.g. which REST API version is available on this Cryptshare Server.
With this information you are able to dynamically determine which endpoints are available or which fields are available.
Currently, only one UI REST API version is available. As soon as version 2.0 of the UI REST API is available, the list of uiApiVersions will contain multiple entries (for 1.x and 2.x).
GET https://<your-url>/api/status
For this endpoint no header information has to be sent, e.g. client id, client token or version headers.
The endpoint returns a ServerStatus object:
| Field name | Description | Type |
|---|---|---|
| apiVersions | The available REST API versions. | ApiVersion |
The ApiVersion object contains:
| Field name | Description | Type |
|---|---|---|
| uiApiVersions | The available UI REST API versions. | List of VersionEntry objects |
The VersionEntry object contains:
| Field name | Description | Type |
|---|---|---|
| major | The major version number of this REST API version. | Integer |
| minor | The minor version number of this REST API version. | Integer |
An example response:
{
apiVersions: {
uiApiVersions: [
{
major: 1,
minor: 13
}
]
}
}