Error
A valid request URL is required to generate request examples{
"data": {
"status": "ok",
"service": "external-api"
},
"asOf": 1791454901
}{
"error": "The request is not valid. See details.",
"code": "invalid_request",
"requestId": "a5ba5c77-7339-4e12-b2cf-3c1f848f8da8",
"details": [
{
"path": "body.foo",
"issue": "is not a known field"
}
]
}{
"error": "Unauthorized.",
"code": "unauthorized",
"requestId": "ea80702c-a332-4e32-922e-76bcb02e6156"
}{
"error": "The request body is too large.",
"code": "payload_too_large",
"requestId": "0c8e5a7d-3f21-4b96-a4d8-7e1b9c2f6a30"
}{
"error": "Send the request body as application/json.",
"code": "unsupported_media_type",
"requestId": "9b4f6e2a-1c7d-4a85-8e3f-5d0a2b6c9e17"
}{
"error": "Too many requests. Wait and try again.",
"code": "rate_limited",
"requestId": "8e2f4a6c-1b3d-4e5f-9a7b-0c2d4e6f8a1b"
}{
"error": "An unexpected error occurred.",
"code": "internal_error",
"requestId": "4a7c9e1f-6b2d-4f83-9c05-8e3a1d7b2f64"
}{
"error": "The service is temporarily unavailable.",
"code": "service_unavailable",
"requestId": "7d3a1f9c-5e82-4b06-a3c7-9f2e6b4d1a58"
}{
"error": "<string>",
"code": "invalid_request",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"issue": "<string>"
}
]
}Health
Check the API and your key
Checks that the function is up and that your API key works. Send an empty JSON object. A 200 with status: "ok" means the key was accepted.
POST
/
health.ping
Error
A valid request URL is required to generate request examples{
"data": {
"status": "ok",
"service": "external-api"
},
"asOf": 1791454901
}{
"error": "The request is not valid. See details.",
"code": "invalid_request",
"requestId": "a5ba5c77-7339-4e12-b2cf-3c1f848f8da8",
"details": [
{
"path": "body.foo",
"issue": "is not a known field"
}
]
}{
"error": "Unauthorized.",
"code": "unauthorized",
"requestId": "ea80702c-a332-4e32-922e-76bcb02e6156"
}{
"error": "The request body is too large.",
"code": "payload_too_large",
"requestId": "0c8e5a7d-3f21-4b96-a4d8-7e1b9c2f6a30"
}{
"error": "Send the request body as application/json.",
"code": "unsupported_media_type",
"requestId": "9b4f6e2a-1c7d-4a85-8e3f-5d0a2b6c9e17"
}{
"error": "Too many requests. Wait and try again.",
"code": "rate_limited",
"requestId": "8e2f4a6c-1b3d-4e5f-9a7b-0c2d4e6f8a1b"
}{
"error": "An unexpected error occurred.",
"code": "internal_error",
"requestId": "4a7c9e1f-6b2d-4f83-9c05-8e3a1d7b2f64"
}{
"error": "The service is temporarily unavailable.",
"code": "service_unavailable",
"requestId": "7d3a1f9c-5e82-4b06-a3c7-9f2e6b4d1a58"
}{
"error": "<string>",
"code": "invalid_request",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"issue": "<string>"
}
]
}Authorizations
The client's own API key (kmi_<id>_<secret>), issued by Kamui. A missing, malformed, unknown, revoked or expired key answers 401 unauthorized.
Headers
Your id for this request: 1 to 128 letters, digits, ., _, : or -. It is echoed in the response. Any other value is replaced with a new UUID.
Pattern:
^[A-Za-z0-9._:-]{1,128}$Body
application/json
The body is of type object.