health check endpoint for downstream

Spec for Testing Purposes 21 Jan 2026 (1.0.1)

Provides examples for a conformant API

Download OpenAPI description

api.json

api.yaml

Servers

Mock server

https://developer.api.test.commbank.com.au/_mock/apis/metadatatest/rest-spec-3/api/

customer

counterparty api tag description

Operations

counterparty

counterparty api tag description

health check endpoint

Request

Health check endpoint for checking API. Provides information on if the service is up and running

Security

OAuth2

Headers

x-request-idstring(uuid)<= 10 characters^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

A unique ID for each API request.

Example:

curl -i -X GET \
  -u <username>:<password> \
  https://developer.api.test.commbank.com.au/_mock/apis/metadatatest/rest-spec-3/api/health \
  -H 'x-request-id: 582dd6b6-61d3-46d5-bcdc-81fad7c27822'

Responses

successful operation

Headers

X-RateLimit-Limitnumber(int32)

The maximum number of requests you're permitted to make per hour.

Example: 10000

X-RateLimit-Remainingnumber(int32)

The number of requests remaining in the current rate limit window.

Example: 9999

X-RateLimit-Resetnumber(int32)

The time at which the current rate limit window resets in UTC epoch seconds.

Example: 1670798639

Content-Typestringrequired

Specifies the media type of the request or response body. If the content is a text-based type, the Content-type must include a character-set parameter of UTF-8.

Example: "application/json; charset=utf-8"

Content-Languagestring

Specifies the language of the content.

Default "en-US"

Example: "de-DE"

Bodyapplication/health+json

statusstringrequired

Indicates whether service is acceptable or not

Enum"HEALTHY""UNHEALTHY""DEGRADED""WARN"

Example: "HEALTHY"

messagestring<= 1024 characters^[ A-Za-z0-9_,\"@.\/#&+-]*$

checksobject

Response

application/health+json

{
  "status": "HEALTHY",
  "message": "string",
  "checks": {}
}

health check endpoint for downstream

Request

Health check endpoint for checking API downstream services

Headers

x-request-idstring(uuid)<= 10 characters^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

A unique ID for each API request.

Example:

curl -i -X GET \
  https://developer.api.test.commbank.com.au/_mock/apis/metadatatest/rest-spec-3/api/health/info \
  -H 'x-request-id: 582dd6b6-61d3-46d5-bcdc-81fad7c27822'

Responses

sucessful operation

Headers

X-RateLimit-Limitnumber(int32)

The maximum number of requests you're permitted to make per hour.

Example: 10000

X-RateLimit-Remainingnumber(int32)

The number of requests remaining in the current rate limit window.

Example: 9999

X-RateLimit-Resetnumber(int32)

The time at which the current rate limit window resets in UTC epoch seconds.

Example: 1670798639

Content-Typestringrequired

Specifies the media type of the request or response body. If the content is a text-based type, the Content-type must include a character-set parameter of UTF-8.

Example: "application/json; charset=utf-8"

Content-Languagestring

Specifies the language of the content.

Default "en-US"

Example: "de-DE"

Bodyapplication/health+json

statusstringrequired

Indicates whehter service is acceptable or not

Enum"HEALTHY""UNHEALTHY""DEGRADED""WARN"

Example: "HEALTHY"

messagestring<= 1024 characters^[ A-Za-z0-9_,\"@.\/#&+-]*$

checksobject

Response

application/health+json

{
  "status": "HEALTHY",
  "message": "string",
  "checks": {}
}

Spec for Testing Purposes 21 Jan 2026 (1.0.1)

customer

counterparty

health check endpoint

Request

Responses

Was this helpful?

health check endpoint for downstream

Request

Responses

Was this helpful?