Content can be downloaded with GET method.
HEAD Status in JSON Format
Service status data of the SIC service in JSON format (only head, no content).
head
Response
200
Response
200
head/servicestatus
200
healthcheck
System Healthcheck
This allows to check the basic state of the system (can it be reached, does it respond).
GET Health Check
Returns a status message of the system.
get
Response
200 application/json
Response
200 application/json
Healthcheck successful
HealthCheckResponse
messagestringrequired
Response message from health check.
<= 100 characters
Example:The health check GET request was successfully received and processed.
requestDateTimestring(date-time)required
According to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds.
Example:2024-12-21T10:52:05.1904957+01:00
receivedHeadersarray[object]required
Show Child Parameters
environmentStagestringrequired
The instance to which the request was sent to.
Example:X1
applicationVersionstringrequired
The version of the API backend.
Example:4.5.0-julia
apiVersionstringrequired
The version of the API.
Example:1.0.23
get/healthcheck
200 application/json
HEAD Health Check
Returns a status message of the system (only head, no content).
head
Response
200
Response
200
Content can be downloaded with GET method.
head/healthcheck
200
ServiceStatusResponseEntry
objectStatus data for one service.
serviceIdentificationstringrequired
Values for Production Services: PCI_P
Values for Test environments:
- SIC IP service: XCI_E; ACI_E; XCI_P; ACI_P; VCI_E; VCI_P
>= 1 characters<= 10 characters
Example:PCI_P
statusstringrequired
Status information for the service is either UP or DOWN or UNKNOWN.
>= 2 characters<= 20 characters
Example:UP
timestampstring(date-time)required
Date and time (according to ISO 8601) at which this status data was last checked.
Example:2024-12-21T10:52:05.1904957+01:00
Example