API Health Check

The /healthcheck endpoint checks the operating status of our APIs. It is a ping for the API entry points to ensure the entry points are accessible. This is the first thing you can do if something goes wrong.

Performing the API health check (for first-time users)

1. To run the health check of an API, for example, for the Eligibility V3 API, import the Eligibility OpenAPI Spec from the Eligibility V3 API Getting Started page in to Postman (Preferred method) or any other tool/platform of your choice.

Using Postman

1. Generate a Bearer token using the /apip/auth/v2/token endpoint.

📘

BEARER TOKEN LIFESPAN

The lifespan of a Bearer token is one hour (3600 seconds) for both sandbox and production environments.

Request

1. Under the Postman >> MedicalNetwork >> Eligibility collection, run a GET request for health check.

https://sandbox-apigw.optum.com/medicalnetwork/eligibility/v3/healthcheck

Response

If the API engine is working correctly and if the entry points are accessible, the API operating status response shows "OK".

📘

NOTE

If you receive a response other than 200 OK, the health check failed.

Please submit a service ticket with Optum by providing the traceId.

Using Try It interface

1. Go to API Reference.
2. Click the API Tools tab.
3. Click /apip/auth/v2/token.
4. Enter the following values in their respective fields.

📘

NOTE

To view the request example, pull down the Example drop-down.

5. Click Try It to generate a bearer token.
6. Go to Optum API Reference.
7. In the left navigation, click Health Check on the required API.
8. Enter the bearer token generated by performing step 5, in the Authorization field.
9. Click Try It.
   The response to the requested API shows.

📘

NOTE

A response other than a 200 OK, indicates that the API health check failed.

Healthcheck endpoints

See API URLs and Endpoints.