HashiConf 2024 Now streaming live from Boston! Attend for free
HashiCorp Cloud Platform

HCP Consul Central

Loading…
Status
(opens in new tab)
preview

This page provides an API reference for the HCP Consul Central API, a RESTful API for the hosted management plane service available through HCP Consul. HCP Consul Central is an interface that centralizes management operations across all of your Consul clusters. It provides global visibility and control for both HashiCorp-managed and self-managed Consul clusters, even when you deploy services in multiple cloud environments and regions.

Refer to the HCP Consul Central API Overview for more information and instructions on how to authenticate and interact with the API.

Download Spec

Operations

​List ​Clusters

get

​/​consul​/​{parent_resource_name}​/​clusters

​List ​Clusters

https://api.cloud.hashicorp.com/2023-10-10/consul/{parent_resource_name}/clusters

Request

Path Parameters
parent_resource_namestringRequired

Parent Resource name will be of the form project/<project_id>

Query Parameters
pagination.page_sizeinteger

The maximum number of results per page to return. If the number of available results is larger than page_size, a next_page_token is returned, which you can use to get the next page of results in subsequent requests. A value of zero causes page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this parameter to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this parameter to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

namestring

Query param filter: name of the cluster

statestring[]

Query param filter: state of the cluster. This can be combination of creating, 'pending', running, disconnected.

typestring[]

Query param filter: type of the cluster. This can be combination of self_managed, hcp-managed.

order_bystring[]

Sorts the services based on a field. Allowed fields: name, state, created_at. The value needs to be of the format <{name/state/created_at} {asc/desc}>. For example: name asc, state desc.

Response

200 - OK
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value becomes empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value becomes empty when there are no more pages.

dataobject[]
  • resource_idstring
  • resource_namestring
  • parent_resource_idstring
  • parent_resource_namestring
  • namestring

    Name of the cluster.

  • statestring

    Current state of the cluster.

  • typestring

    Type of the cluster.

  • configobject

    ClusterConfig holds the configuration for a Consul cluster.

    • consul_configobject

      ConsulConfig exposes user settable configurations for a Consul cluster.

      • datacenterstring

        datacenter is the name of datacenter the Consul servers run in. If not set, a default value of dc1 is used.

        https://developer.hashicorp.com/consul/docs/agent/config/config-files#datacenter

      • connect_enabledboolean

        connect_enabled flag denotes that the service mesh is enabled on the Consul servers.

      • acl_enabledboolean

        acl_enabled stores if ACLs are enabled for this cluster or not.

    • network_configobject

      NetworkConfig configures the network of the Consul cluster.

      • privateboolean

        private indicates if this cluster's instances should be configured in a non-externally accessible way.

      • resource_idstring

        This parameter is the network resource's id.

      • resource_namestring

        This parameter is the network resource's name.

      • ip_allowlistobject[]

        CidrRange specifies an IP address and prefix in CIDR format.

        • addressstring
        • descriptionstring

          An optional description of the IP address range.

    • tierstring

      Tier represents the different groupings of features and cluster settings and determines the base billing product associated with a cluster resource.

    • sizestring

      Size corresponds to the size of the VM that a cluster is provisioned with. These sizes are represented as "t-shirt" sizes, with each corresponding to a specific instance type depending on the cloud provider.

    • dns_namesobject

      DNSNames holds all of the cluster's DNS names.

      • publicstring

        public is the DNS name pointing to the cluster's public IP addresses.

      • privatestring

        private is the DNS name pointing to the cluster's private IP addresses.

  • consul_versionstring
  • metaobject
    • created_atstring

      created_at is the timestamp when the cluster was first created.

    • updated_atstring

      updated_at is the timestamp when the cluster was last updated.

  • regionobject
    • providerstring
    • regionstring
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get ​Cluster

get

​/​{resource_name}

​Get ​Cluster

https://api.cloud.hashicorp.com/2023-10-10/{resource_name}

Request

Path Parameters
resource_namestringRequired

Resource name will be of the form consul/project/<project_id>/cluster/<cluster_id>

Response

200 - OK
dataobject
  • resource_idstring

    Resource ID of the cluster.

  • resource_namestring

    Resource name of the cluster.

  • parent_resource_idstring
  • parent_resource_namestring
  • namestring

    Name of the cluster.

  • statestring

    Current state of the cluster.

  • typestring

    Type of the cluster.

  • configobject

    ClusterConfig holds the configuration for a Consul cluster.

    • consul_configobject

      ConsulConfig exposes user settable configurations for a Consul cluster.

      • datacenterstring

        datacenter is the name of datacenter the Consul servers run in. If not set, a default value of dc1 is used.

        https://developer.hashicorp.com/consul/docs/agent/config/config-files#datacenter

      • connect_enabledboolean

        connect_enabled flag denotes that the service mesh is enabled on the Consul servers.

      • acl_enabledboolean

        acl_enabled stores if ACLs are enabled for this cluster or not.

    • network_configobject

      NetworkConfig configures the network of the Consul cluster.

      • privateboolean

        private indicates if this cluster's instances should be configured in a non-externally accessible way.

      • resource_idstring

        This parameter is the network resource's id.

      • resource_namestring

        This parameter is the network resource's name.

      • ip_allowlistobject[]

        CidrRange specifies an IP address and prefix in CIDR format.

        • addressstring
        • descriptionstring

          An optional description of the IP address range.

    • tierstring

      Tier represents the different groupings of features and cluster settings and determines the base billing product associated with a cluster resource.

    • sizestring

      Size corresponds to the size of the VM that a cluster is provisioned with. These sizes are represented as "t-shirt" sizes, with each corresponding to a specific instance type depending on the cloud provider.

    • dns_namesobject

      DNSNames holds all of the cluster's DNS names.

      • publicstring

        public is the DNS name pointing to the cluster's public IP addresses.

      • privatestring

        private is the DNS name pointing to the cluster's private IP addresses.

  • summaryobject
    • node_countinteger
    • server_countinteger
    • service_countinteger
    • service_passinginteger
    • service_warninginteger
    • service_criticalinteger
    • client_countinteger
  • consul_versionstring
  • metaobject
    • created_atstring

      created_at is the timestamp when the cluster was first created.

    • updated_atstring

      updated_at is the timestamp when the cluster was last updated.

  • regionobject
    • providerstring
    • regionstring
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List ​Nodes

get

​/​consul​/​{project_resource_name}​/​nodes

​List ​Nodes

https://api.cloud.hashicorp.com/2023-10-10/consul/{project_resource_name}/nodes

Request

Path Parameters
project_resource_namestringRequired

Project resource name of the project to which the node belongs. Resource name will be of the form project/<project_id>

Query Parameters
pagination.page_sizeinteger

The maximum number of results per page to return. If the number of available results is larger than page_size, a next_page_token is returned, which you can use to get the next page of results in subsequent requests. A value of zero causes page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this parameter to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this parameter to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

namestring[]

Query param filter: list of name of the nodes

cluster_namestring[]

Query param filter: list of name of the cluster

addressstring[]

Query param filter: list of address

partitionstring[]

Query param filter: list of partition

order_bystring[]

Sorts the nodes based on a field. Allowed fields: name, partition, created_at, updated_at The value needs to be of the format <Field Name> {asc/desc} For example: name, partition asc, name desc.

include_synthetic_nodesboolean

Include synthetic nodes in response

Response

200 - OK
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value becomes empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value becomes empty when there are no more pages.

dataobject[]
  • idstring
  • parent_resource_idstring
  • parent_resource_namestring
  • namestring
  • addressstring
  • cluster_namestring
  • partitionstring
  • tagged_addressesobject
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get ​Node

get

​/​{parent_resource_name}​/​node​/​{node_name}

​Get ​Node

https://api.cloud.hashicorp.com/2023-10-10/{parent_resource_name}/node/{node_name}

Request

Path Parameters
parent_resource_namestringRequired

Parent resource name will be of the form consul/project/<project_id>/cluster/<cluster_id>

node_namestringRequired

Node name of which details is required

Response

200 - OK
dataobject
  • idstring
  • parent_resource_idstring
  • parent_resource_namestring
  • namestring
  • addressstring
  • cluster_namestring
  • partitionstring
  • tagged_addressesobject
  • service_dataobject
    • detailsobject[]
      • service_namestring
      • instance_idsstring[]
      • instance_countinteger
      • portsinteger[]
      • namespacestring
      • kindstring
    • tagsstring[]
    • namespacesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List ​Cluster ​Nodes

get

​/​{parent_resource_name}​/​nodes

​List ​Cluster ​Nodes

https://api.cloud.hashicorp.com/2023-10-10/{parent_resource_name}/nodes

Request

Path Parameters
parent_resource_namestringRequired

Cluster resource name will be of the form consul/project/<project_id>/cluster/<cluster_id>

Query Parameters
pagination.page_sizeinteger

The maximum number of results per page to return. If the number of available results is larger than page_size, a next_page_token is returned, which you can use to get the next page of results in subsequent requests. A value of zero causes page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this parameter to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this parameter to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

namestring[]

Filters nodes based on the list of names.

cluster_namestring[]

Filters nodes based on the lists of cluster names.

addressstring[]

Filters nodes based on the lists of addresses.

partitionstring[]

Filters nodes based on the lists of partitions.

order_bystring[]

Sorts the nodes based on a field. Allowed fields: name, partition, created_at, updated_at. The value needs to be of the format <{name/partition/created_at/updated_at} {asc/desc}> For example: partition asc, name desc.

include_synthetic_nodesboolean

Include synthetic nodes in response

Response

200 - OK
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value becomes empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value becomes empty when there are no more pages.

dataobject[]
  • idstring
  • parent_resource_idstring
  • parent_resource_namestring
  • namestring
  • addressstring
  • cluster_namestring
  • partitionstring
  • tagged_addressesobject
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List ​Services

get

​/​consul​/​{project_resource_name}​/​services

​List ​Services

https://api.cloud.hashicorp.com/2023-10-10/consul/{project_resource_name}/services

Request

Path Parameters
project_resource_namestringRequired

Parent Resource name will be of the form project/<project_id>

Query Parameters
pagination.page_sizeinteger

The maximum number of results per page to return. If the number of available results is larger than page_size, a next_page_token is returned, which you can use to get the next page of results in subsequent requests. A value of zero causes page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this parameter to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this parameter to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

order_bystring[]

Sorts the services based on a field. Allowed fields: name, health. The value needs to be of the format <Field Name> {asc/desc} For example: name, name asc, name desc.

partitionstring

Query param filter: partition of the service.

namespacestring

Query param filter: namespace of the service.

statusstring[]

Query param filter: status of the service. This can be combination of passing, warning, critical, none.

kindstring[]

Query param filter: kind of the service. This can be combination of typical, connect-proxy, destination, api_gateway, ingress_gateway, terminating_gateway, mesh_gateway.

in_meshboolean

Query param filter: whether the service is in the service mesh or not. Possible values: true or false.

mtls_modestring[]

Query param filter: mTLS mode of the service. Possible values: permissive, strict.

cluster_idsstring[]

Query param filter: cluster_id of the service.

querystring

Search query to filter by. Searches across service name, cluster_id, partition, namespace, sameness_group, tags.

external_sourcesstring[]

Query param filter: external_sources. Returns a service when service's external sources overlap with the external sources specified.

Response

200 - OK
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value becomes empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value becomes empty when there are no more pages.

dataobject[]
  • namestring

    Name of the service.

  • cluster_idstring
  • cluster_resource_namestring
  • cluster_resource_idstring
  • namespacestring

    Namespace where the service is deployed.

  • partitionstring

    Partition where the service is deployed.

  • tagsstring[]
  • external_sourcesstring[]
  • connect_nativeboolean

    True if the service is “connect native”, meaning that it does not use an Envoy proxy.

  • connected_with_proxyboolean

    True if the service is connected to an Envoy mesh proxy.

  • transparent_proxyboolean

    Determines whether service traffic is forced to pass through the sidecar proxy.

  • connected_with_gatewayboolean

    True if the service is connected to a gateway.

  • gateway_configobject
    • associated_service_countinteger
  • instance_countinteger
  • checks_criticalinteger
  • checks_passinginteger
  • checks_warninginteger
  • kindstring
  • mtls_modestring
  • sameness_groupobject
    • namestring
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get ​Service

get

​/​{cluster_resource_name}​/​service​/​{service_name}

​Get ​Service

https://api.cloud.hashicorp.com/2023-10-10/{cluster_resource_name}/service/{service_name}

Request

Path Parameters
cluster_resource_namestringRequired

Cluster Resource Name will be of the form consul/project/<project_id>/cluster/<cluster_id>

service_namestringRequired

The name of the service.

Query Parameters
partitionstring

Query param filter: partition of the service.

namespacestring

Query param filter: namespace of the service.

Response

200 - OK
dataobject
  • namestring

    Name of the service.

  • cluster_idstring
  • cluster_resource_namestring
  • cluster_resource_idstring
  • namespacestring

    Namespace where the service is deployed.

  • partitionstring

    Partition where the service is deployed.

  • tagsstring[]
  • external_sourcesstring[]
  • connect_nativeboolean

    True if the service is “connect native”, meaning that it does not use an Envoy proxy.

  • connected_with_proxyboolean

    True if the service is connected to an Envoy mesh proxy.

  • transparent_proxyboolean

    Determines whether service traffic is forced to pass through the sidecar proxy.

  • connected_with_gatewayboolean

    True if the service is connected to a gateway.

  • gateway_configobject
    • associated_service_countinteger
  • instance_countinteger
  • checks_criticalinteger
  • checks_passinginteger
  • checks_warninginteger
  • kindstring
  • mtls_modestring
  • sameness_groupobject
    • namestring
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List ​Cluster ​Services

get

​/​{cluster_resource_name}​/​services

​List ​Cluster ​Services

https://api.cloud.hashicorp.com/2023-10-10/{cluster_resource_name}/services

Request

Path Parameters
cluster_resource_namestringRequired

Cluster resource name will be of the form consul/project/<project_id>/cluster/<cluster_id>

Query Parameters
pagination.page_sizeinteger

The maximum number of results per page to return. If the number of available results is larger than page_size, a next_page_token is returned, which you can use to get the next page of results in subsequent requests. A value of zero causes page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this parameter to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this parameter to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

order_bystring[]

Sorts the services based on a field. Allowed fields: name, health. The value needs to be of the format <{name/health} {asc/desc}> For example: name asc, health desc.

partitionstring

Query param filter: partition of the service.

namespacestring

Query param filter: namespace of the service.

statusstring[]

Query param filter: status of the service. This can be combination of passing, warning, critical, none.

kindstring[]

Query param filter: kind of the service. This can be combination of typical, connect-proxy, destination, api-gateway, ingress-gateway, terminating-gateway, mesh-gateway.

in_meshboolean

Query param filter: whether the service is in the service mesh or not. Possible values: true or false.

mtls_modestring[]

Query param filter: mTLS mode of the service. Possible value: permissive, strict.

querystring

Search query to filter by. Searches across service name, cluster_id, partition, namespace, sameness_group, tags

external_sourcesstring[]

Query param filter: external_sources. Returns a service when service's external sources overlap with the external sources specified.

Response

200 - OK
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value becomes empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value becomes empty when there are no more pages.

dataobject[]
  • namestring

    Name of the service.

  • cluster_idstring
  • cluster_resource_namestring
  • cluster_resource_idstring
  • namespacestring

    Namespace where the service is deployed.

  • partitionstring

    Partition where the service is deployed.

  • tagsstring[]
  • external_sourcesstring[]
  • connect_nativeboolean

    True if the service is “connect native”, meaning that it does not use an Envoy proxy.

  • connected_with_proxyboolean

    True if the service is connected to an Envoy mesh proxy.

  • transparent_proxyboolean

    Determines whether service traffic is forced to pass through the sidecar proxy.

  • connected_with_gatewayboolean

    True if the service is connected to a gateway.

  • gateway_configobject
    • associated_service_countinteger
  • instance_countinteger
  • checks_criticalinteger
  • checks_passinginteger
  • checks_warninginteger
  • kindstring
  • mtls_modestring
  • sameness_groupobject
    • namestring
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get ​Service ​Instance

get

​/​{cluster_resource_name}​/​node​/​{node}​/​service​/​{service_name}​/​instance​/​{instance_id}

​Get ​Service ​Instance

https://api.cloud.hashicorp.com/2023-10-10/{cluster_resource_name}/node/{node}/service/{service_name}/instance/{instance_id}

Request

Path Parameters
cluster_resource_namestringRequired

Cluster resource name will be of the form consul/project/<project_id>/cluster/<cluster_id>

nodestringRequired

Name of the node on which the service instance resides.

service_namestringRequired

Name of the service.

instance_idstringRequired

Unique identifier for the service instance.

Query Parameters
namespacestring

Namespace where the service is deployed.

partitionstring

Partition where the service is deployed.

Response

200 - OK
dataobject
  • namestring
  • idstring
  • cluster_idstring
  • cluster_resource_namestring
  • cluster_resource_idstring
  • namespacestring

    Namespace where the service is deployed.

  • partitionstring

    Partition where the service is deployed.

  • nodestring
  • addressstring

    Service-specific IP address or hostname. If no value is specified, the IP address of the agent node is used by default.

  • portinteger
  • connected_with_proxyboolean

    True if the service is connected to an Envoy mesh proxy.

  • external_sourcestring
  • statusstring
  • service_checks_criticalinteger
  • service_checks_warninginteger
  • service_checks_passinginteger
  • proxy_checks_criticalinteger
  • proxy_checks_warninginteger
  • proxy_checks_passinginteger
  • node_checks_criticalinteger
  • node_checks_warninginteger
  • node_checks_passinginteger
  • kindstring
  • tagsstring[]
  • metaobject
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List ​Service ​Instances

get

​/​{cluster_resource_name}​/​service​/​{service_name}​/​instances

​List ​Service ​Instances

https://api.cloud.hashicorp.com/2023-10-10/{cluster_resource_name}/service/{service_name}/instances

Request

Path Parameters
cluster_resource_namestringRequired

Cluster resource name will be of the form consul/project/<project_id>/cluster/<cluster_id>

service_namestringRequired

Unique identifier for the service instance.

Query Parameters
pagination.page_sizeinteger

The maximum number of results per page to return. If the number of available results is larger than page_size, a next_page_token is returned, which you can use to get the next page of results in subsequent requests. A value of zero causes page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this parameter to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this parameter to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

namespacestring

Query param filter: namespace of the service.

partitionstring

Query param filter: partition of the service.

querystring

Search query to filter by. Searches across id and tags.

statusstring[]

Query param filter: status of the service. This can be combination of passing, warning, critical, none.

order_bystring[]

Sorts the services based on a field. Allowed fields: id, health. The value needs to be of the format <Field Name> {asc/desc} For example: id, id asc, health desc.

Response

200 - OK
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value becomes empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value becomes empty when there are no more pages.

dataobject[]
  • namestring
  • idstring
  • cluster_idstring
  • cluster_resource_namestring
  • cluster_resource_idstring
  • namespacestring

    Namespace where the service is deployed.

  • partitionstring

    Partition where the service is deployed.

  • nodestring
  • addressstring

    Service-specific IP address or hostname. If no value is specified, the IP address of the agent node is used by default.

  • portinteger
  • connected_with_proxyboolean

    True if the service is connected to an Envoy mesh proxy.

  • external_sourcestring
  • statusstring
  • service_checks_criticalinteger
  • service_checks_warninginteger
  • service_checks_passinginteger
  • proxy_checks_criticalinteger
  • proxy_checks_warninginteger
  • proxy_checks_passinginteger
  • node_checks_criticalinteger
  • node_checks_warninginteger
  • node_checks_passinginteger
  • kindstring
  • tagsstring[]
  • metaobject
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.