Details the working status of the microservice.

  • Published on May 28, 2025
  • 8 minute(s) read
Prev Next
Get
/health

Checks the connection to all of the resources required for operation and returns a global status.

Security
HTTP
Type bearer

JWT authentication security

OAuth

OAuth Grant type, Private JWT

FlowClient Credentials
Token URL$(host)/oauth/token
Scopes:
get.healthRead health status
Header parameters
x-b3-traceid
string

Overall ID of the trace, shared by every span in the trace.

The value is 64 or 128 bits long.

Min length0
Max length32
Pattern^[a-zA-Z0-9_]*$
Example80f198ee56343ba864fe8b2a57d3eff7
x-b3-parentspanid
string

Position of the parent operation in the trace tree.

The value is 64 bits long.

The value is omitted when the span is the root of the trace tree.

Min length0
Max length32
Pattern^[a-zA-Z0-9_]*$
Example05e3ac9a4f6e3b90
x-b3-spanid
string

Position of the current operation in the trace tree.

The value is 64 bits long.

Do not interpret the value: it may or may not be derived from the value of the TraceId.

Min length0
Max length32
Pattern^[a-zA-Z0-9_]*$
Examplee457b5a2e4d86bd1
x-b3-sampled
string

Sampling decision.

Sampling is a mechanism to reduce the volume of data in the tracing system. In B3, sampling applies consistently per-trace: once the sampling decision is made, the same value must be consistently sent downstream. This means that either all or no spans share a trace ID.

The possible values are:

  • 0 = Deny
  • 1 = Accept
  • d = Debug
Min length0
Max length32
Pattern^[a-zA-Z0-9_]*$
Example1
x-santander-client-id
stringRequired

Client ID header

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Examplea1b30a84-7bf3-442e-84a0-e935d8163b5a
Responses
200

Health Pass/Warning response

Pass
{
  "status": "pass"
}
Warn
{
  "status": "warn"
}
object

Health Pass/Warning response schema

status
string

status: (required) indicates whether the service status is acceptable or not. API publishers SHOULD use following values for the field:

  • "pass": healthy (acceptable aliases: "ok" to support Node's Terminus and "up" for Java's SpringBoot),

  • "fail": unhealthy (acceptable aliases: "error" to support Node's Terminus and "down" for Java's SpringBoot), and

  • "warn": healthy, with some concerns.

The value of the status field is case-insensitive and is tightly related with the HTTP response code returned by the health endpoint. For "pass" status, HTTP response code in the 2xx-3xx range MUST be used. For "fail" status, HTTP response code in the 4xx-5xx range MUST be used. In case of the "warn" status, endpoints MUST return HTTP status in the 2xx-3xx range, and additional information SHOULD be provided, utilizing optional fields of the response.

A health endpoint is only meaningful in the context of the component it indicates the health of. It has no other meaning or purpose. As such, its health is a conduit to the health of the component. Clients SHOULD assume that the HTTP response code returned by the health endpoint is applicable to the entire component (e.g. a larger API or a microservice). This is compatible with the behavior that current infrastructural tooling expects: load-balancers, service discoveries and others, utilizing health-checks.

Valid values[ "pass", "ok", "up", "warn" ]
Examplepass
204

No content

400

Bad request

err400Example
{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "level": "FATAL",
      "message": "Bad Request",
      "description": "Error validating schema"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
401

Unauthorized

err401Example
{
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Unauthorized",
      "level": "ERROR",
      "description": "Authorization credentials are missing or invalid"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
403

Forbidden

err403Example
{
  "errors": [
    {
      "code": "FORBIDDEN",
      "level": "FATAL",
      "message": "Forbidden",
      "description": "Logged in user is not authorized to access data"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
404

Not found

err404Example
{
  "errors": [
    {
      "code": "NOT_FOUND",
      "level": "FATAL",
      "message": "Not Found",
      "description": "Requested resource was not found but may be available later"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
406

Not acceptable

err406Example
{
  "errors": [
    {
      "code": "NOT_ACCEPTABLE",
      "level": "FATAL",
      "message": "Not Acceptable",
      "description": "Request content not acceptable"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
414

URI too long

err414Example
{
  "errors": [
    {
      "code": "URI_TOO_LONG",
      "level": "FATAL",
      "message": "URI Too Long",
      "description": "URI is longer than the maximum size allowed by the server"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
422

Unprocessable entity

err422Example
{
  "errors": [
    {
      "code": "UNPROCESSABLE_ENTITY",
      "level": "FATAL",
      "message": "Unprocessable Entity",
      "description": "Request was well formed but there are semantic errors"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
429

Too many requests

err429Example
{
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "level": "ERROR",
      "message": "Too Many Requests",
      "description": "User has sent too many requests"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
500

Internal server error

err500Example
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "level": "FATAL",
      "message": "Internal server error",
      "description": "Server has encountered an error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
503

Service unavailable

err503Example
{
  "errors": [
    {
      "code": "SERVICE_UNAVAILABLE",
      "level": "ERROR",
      "message": "Service unavailable",
      "description": "Server is not ready to handle the request"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
504

Gateway timeout

err504Example
{
  "errors": [
    {
      "code": "GATEWAY_TIMEOUT",
      "level": "ERROR",
      "message": "Gateway timeout",
      "description": "Server cannot get a gateway response in time"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
default

Default error

errDefaultExample
{
  "errors": [
    {
      "code": "Error code",
      "level": "ERROR",
      "message": "Error message",
      "description": "Error description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid