HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
HashiCorp Cloud Platform
HashiCorp Cloud Platform

List

get

/clusters

List

https://api.cloud.hashicorp.com/vault/2020-11-25/organizations/{location.organization_id}/projects/{location.project_id}/clusters

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Query Parameters
location.region.providerstring

provider is the named cloud provider ("aws", "gcp", "azure").

location.region.regionstring

region is the cloud region ("us-west1", "us-east1").

pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this 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 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.

filters.primaries_onlyboolean

Response

200 - OK
clustersobject[]

Cluster represents a single Vault cluster.

  • idstring

    id is ID of the Vault cluster.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • statestring

    State is the state of the Vault cluster. Note that this state represents the abstract Vault cluster itself, not necessarily whether Vault cluster is currently available or not.

    • CLUSTER_STATE_INVALID: CLUSTER_STATE_INVALID is a sentinel zero value so that an uninitialized value can be detected.
    • PENDING: PENDING is the state the cluster is in while it is waiting to be created.
    • CREATING: CREATING is the state the cluster is in while it is being provisioned for the first time.
    • RUNNING: RUNNING is the steady state while the cluster is running.
    • FAILED: FAILED is a failure state in which the cluster is unavailable and may required an operator restore action to recover.
    • UPDATING: UPDATING is the state the cluster is in while undergoing a version update.
    • RESTORING: RESTORING is the state the cluster is in while restoring from a snapshot.
    • DELETING: DELETING is the state the cluster is in while it is being de-provisioned.
    • SEALING: SEALING is the state the cluster is in when it is about to get sealed.
    • SEALED: SEALED is the state the cluster is in while a cluster is sealed.
    • UNSEALING: UNSEALING is the state the cluster is in when it is about to get unsealed.
    • CLUSTER_SCALING: CLUSTER_SCALING is the state the cluster is in when it is under an up or down scaling operation to a new tier_size state.
    • LOCKING: LOCKING is the state the cluster is in when it is about to get locked.
    • LOCKED: LOCKED is the state the cluster is in while a cluster is locked.
    • UNLOCKING: UNLOCKING is the state the cluster is in when it is about to get unlocked.
  • configobject
    • vault_configobject
      • namespacestring

        namespace is the name of the customer namespace.

      • initial_versionstring

        initial_version is the initial Vault version to use when creating the cluster. Once the cluster is created, this value is no longer used.

      • max_lease_ttlstring

        max_lease_ttl is the max lease ttl for this Vault cluster.

    • network_configobject
      • network_idstring

        network_id is the ID of the network the Vault cluster belongs to.

      • public_ips_enabledboolean

        public_ips_enabled indicates if public IP's are enabled.

      • cors_configobject
        • enabledboolean

          enabled is true if CORS is enabled for this cluster.

        • allowed_originsstring[]
        • allowed_headersstring[]
      • http_proxy_optionstring

        HttpProxyOption specifies whether a cluster has HTTP Proxy enabled or disabled. We use an enum instead of bool for readability and extensibility.

      • ip_allowlistobject[]

        CidrRange specifies an IP address and prefix in CIDR format.

        • addressstring
        • descriptionstring

          An optional description of the IP address range.

    • maintenance_configobject
    • snapshot_configobject
      • periodic_snapshots_disabledboolean
    • capacity_configobject
      • num_serversinteger

        num_servers is the number of nodes this Vault cluster should have.

    • vault_accessobject
      • urlstring
      • root_tokenstring
      • recovery_keystring
    • audit_configobject
      • audit_logs_disabledboolean
    • tierstring
      • DEV: NOTE: enum 0 values should be invalid. Use this field with care in GORM queries.
    • metrics_configobject
      • grafanaobject
        • endpointstring
        • userstring
        • passwordstring
      • splunkobject
        • hec_endpointstring
        • tokenstring
      • datadogobject
        • api_keystring
        • regionstring
      • cloudwatchobject
        • access_key_idstring
        • secret_access_keystring
        • regionstring
        • group_namestring
        • stream_namestring
        • namespacestring
      • elasticsearchobject
        • endpointstring
        • userstring
        • passwordstring
        • datasetstring
        • namespacestring
      • newrelicobject
        • account_idstring
        • license_keystring
        • regionstring
      • httpobject
        • uristring
        • methodstring
        • basicobject
          • userstring
          • passwordstring
        • bearerobject
          • tokenstring
        • headersobject
        • payload_prefixstring
        • payload_suffixstring
        • compressionboolean
        • codecstring
    • audit_log_export_configobject
      • grafanaobject
        • endpointstring
        • userstring
        • passwordstring
      • splunkobject
        • hec_endpointstring
        • tokenstring
      • datadogobject
        • api_keystring
        • regionstring
      • cloudwatchobject
        • access_key_idstring
        • secret_access_keystring
        • regionstring
        • group_namestring
        • stream_namestring
        • namespacestring
      • elasticsearchobject
        • endpointstring
        • userstring
        • passwordstring
        • datasetstring
        • namespacestring
      • newrelicobject
        • account_idstring
        • license_keystring
        • regionstring
      • httpobject
        • uristring
        • methodstring
        • basicobject
          • userstring
          • passwordstring
        • bearerobject
          • tokenstring
        • headersobject
        • payload_prefixstring
        • payload_suffixstring
        • compressionboolean
        • codecstring
    • major_version_upgrade_configobject
      • upgrade_typestring
      • maintenance_windowobject
        • day_of_weekstring
        • time_window_utcstring
    • disaster_recovery_network_configobject
      • network_idstring

        network_id is the ID of the network the Vault cluster belongs to.

      • locationobject

        Location represents a target for an operation in HCP.

        • organization_idstring

          organization_id is the id of the organization.

        • project_idstring

          project_id is the projects id.

        • regionobject

          Region identifies a Cloud data-plane region.

          • providerstring
          • regionstring
    • reporting_configobject
      • enrolledboolean
  • dns_namesobject

    DNSNames holds all of the cluster's DNS names.

    • privatestring

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

    • publicstring

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

    • proxystring

      proxy is the DNS name for proxied access to the cluster.

  • created_atstring

    created_at is the timestamp of when the cluster was first created.

  • current_versionstring

    currently_deployed_version is the version of the current Vault deployment.

  • performance_replication_infoobject
    • modestring

      Mode represents the role type for the Performance Replicated cluster.

      • CLUSTER_PERFORMANCE_REPLICATION_INFO_MODE_INVALID: CLUSTER_PERFORMANCE_REPLICATION_INFO_MODE_INVALID is a sentinel zero value so that an uninitialized value can be detected.
      • PRIMARY: PRIMARY mode type.
      • SECONDARY: SECONDARY mode type.
    • primary_cluster_linkobject

      Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

      • typestring

        type is the unique type of the resource. Each service publishes a unique set of types. The type value is recommended to be formatted in "." such as "hashicorp.hvn". This is to prevent conflicts in the future, but any string value will work.

      • uuidstring

        uuid is being deprecated in favor of the id field.

      • locationobject

        Location represents a target for an operation in HCP.

        • organization_idstring

          organization_id is the id of the organization.

        • project_idstring

          project_id is the projects id.

        • regionobject

          Region identifies a Cloud data-plane region.

          • providerstring
          • regionstring
      • descriptionstring

        description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

      • idstring

        id is the ID of the resource. This may be a slug ID or a UUID depending on the resource, and as such has no guarantee that it is globally unique. If a globally unique identifier for the resource is required, refer to internal_id.

      • internal_idstring

        internal_id is a globally unique identifier for the resource. In the case that a resource has a user specifiable identifier, the internal_id will differ.

    • paths_filterobject

      PathsFilter represents the paths in the Primary cluster the current cluster either can or cannot replicate, depending on the mode.

      • pathsstring[]
      • modestring
        • CLUSTER_PERFORMANCE_REPLICATION_PATHS_FILTER_MODE_INVALID: PATHS_FILTER_MODE_INVALID is a sentinel zero value so that an uninitialized value can be detected.
        • ALLOW: ALLOW allows only the specified paths for replication
        • DENY: DENY denies the specified paths for replication
  • resource_idstring

    resource_id is UUID of the Vault cluster.

  • notificationsobject[]
    • topicstring
    • meta_dataobject
  • creation_metadataobject
    • template_outputobject
      • idstring
      • accessorstring
      • fieldsobject
  • lock_originsstring[]

    LockOrigin holds the origin of the lock.

  • snapshot_schedulestring
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 will become 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 will become empty when there are no more pages.

Default Error Response
errorstring
codeinteger
messagestring
detailsobject[]

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

  • type_urlstring

    A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

    In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

    • If no scheme is provided, https is assumed.
    • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
    • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

    Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

    Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • valuestring

    Must be a valid serialized protocol buffer of the above specified type.