What is AliasNode in the /agent/check/register JSON request body?

Looking at the docs for the http /agent/check/register request, there’s a AliasNode field defined as:

Specifies the ID of the node for an alias check. If no service is specified, the check will alias the health of the node. If a service is specified, the check will alias the specified service on this particular node.

What is an “alias check”? What does “alias the health of the node” mean? What does “alias the specified service” mean?

Thanks in advance
Ben

1 Like

Hi @bslade.

Welcome to the HashiCorp Forums!

Here is the documentation that explains what Alias Checks are:

Ref: Define health checks | Consul | HashiCorp Developer

You will see this used in action when using Consul Service Mesh for example.

It’s the option in which your overall health of the service depends on multiple other services/nodes.

For eg: in the case of Service Mesh both application and its sidecar should be healthy before deeming the Service to be healthy.

I hope this helps.