Get diagnostic information
GET/healthcheck
Checks the health of the API for a specific targetId and verifies that request headers are returned unchanged.
Request
Responses
- 200
- 400
- 500
- 501
- 502
- 503
- 504
Diagnostic information including echoed request headers.
Bad Request - The format of the request was invalid.
Examples:
-
InvalidPayload: type: /problems/INVALID_PAYLOAD title: Payload does not comply with API specification detail: Malformed JSON instance: path/to/corresponding/resource
-
InvalidParameter: type: /problems/INVALID_PAYLOAD title: Invalid parameter values have been detected detail: Sent data could not processed instance: path/to/corresponding/resource
-
MissingId: type: /problems/INVALID_PAYLOAD title: The payload was not valid detail: ID is missing instance: path/to/corresponding/resource
Response Headers
Response language - always en.
i.e. "Bearer error=''invalid_token''" according to RFC6750 section-3
Service User defined ID from request to correlate HTTP requests between a Service User and a Service Provider.
Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.
Examples:
-
TechnicalServerError: type: /problems/TECHNICAL_ERROR title: Technical error on server side detail: Processing yielded a technical error instance: path/to/corresponding/resource
-
ResourceTooLarge: type: /problems/RESOURCE_TOO_LARGE title: Generated resource was too large detail: The generated resource exceeded the size limit instance: path/to/corresponding/resource
Response Headers
Response language - always en.
Service User defined ID from request to correlate HTTP requests between a Service User and a Service Provider.
Not Implemented - The server does not support the functionality required to fulfill the request.
Examples:
- EndpointNotImplemented: type: /problems/NOT_IMPLEMENTED title: Target endpoint is not implemented detail: This endpoint is not implemented instance: path/to/corresponding/resource
Response Headers
Response language - always en.
Service User defined ID from request to correlate HTTP requests between a Service User and a Service Provider.
Bad Gateway - The server received an invalid response from the upstream server.
Response Headers
Response language - always en.
Service User defined ID from request to correlate HTTP requests between a Service User and a Service Provider.
Service Unavailable - The server is currently unable to handle the request due to a temporary overload or scheduled maintenance.
Response Headers
Response language - always en.
Service User defined ID from request to correlate HTTP requests between a Service User and a Service Provider.
Gateway Timeout - The server did not get a response in time that it needed in order to complete the request.
Response Headers
Response language - always en.
Service User defined ID from request to correlate HTTP requests between a Service User and a Service Provider.