# hostedqueues-api ## Pages - [Hosted Queues API](https://docs.ezghcloud.com/hostedqueues-api/index.md) — Managed RabbitMQ and Kafka clusters in your VPC: one or three nodes reached by DNS names, with TLS, users whose passwords live in Secrets, and topics, consumer groups, vhosts, queues, exchanges, bindings and policies managed through the API. Every path is under an organization; lists are paged with limit, cursor and nextCursor. - [Cancel an operation](https://docs.ezghcloud.com/hostedqueues-api/CancelOperation/index.md) — 409 operation_finished or operation_not_cancellable when it can't be cancelled. - [Create a Hosted Queues cluster](https://docs.ezghcloud.com/hostedqueues-api/CreateCluster/index.md) — Asynchronous: answers 202 with the operation that creates it, its first user and that user's Secret. 409 subnet_has_no_room; 409 not_enough_hosts for a replicated cluster on hp-1. - [Create a binding](https://docs.ezghcloud.com/hostedqueues-api/CreateClusterBinding/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. The engine's and the platform's own objects are 409 internal_object. Its name is its server-assigned key. - [Create an exchange](https://docs.ezghcloud.com/hostedqueues-api/CreateClusterExchange/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. The engine's and the platform's own objects are 409 internal_object. - [Create a policy](https://docs.ezghcloud.com/hostedqueues-api/CreateClusterPolicy/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. The engine's and the platform's own objects are 409 internal_object. A definition key outside the allowlist is 400 unsupported_config. - [Create a queue](https://docs.ezghcloud.com/hostedqueues-api/CreateClusterQueue/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. The engine's and the platform's own objects are 409 internal_object. - [Create a topic](https://docs.ezghcloud.com/hostedqueues-api/CreateClusterTopic/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. The engine's and the platform's own objects are 409 internal_object. With no replicationFactor it takes the cluster's (1 single, 3 replicated). A config key outside the allowlist is 400 unsupported_config. - [Create a user](https://docs.ezghcloud.com/hostedqueues-api/CreateClusterUser/index.md) — Asynchronous. Its password is generated and written to a Secret in the cluster's project, as the caller: secrets.secrets.create and secrets.versions.create. Names starting ezgh_ are 400 reserved_name; a RabbitMQ vhost the cluster doesn't have is 400 unknown_vhost. On RabbitMQ the Secret's vhost and uri name the user's first vhost (vhost empty and no uri when it has none). - [Create a vhost](https://docs.ezghcloud.com/hostedqueues-api/CreateClusterVhost/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. Queues default to quorum. The name default is 400 reserved_name. - [Delete a cluster](https://docs.ezghcloud.com/hostedqueues-api/DeleteCluster/index.md) — Asynchronous. Deletes its users' Secrets too. 409 deletion_protected; 409 hosted_queue_in_use while a firewall rule names it. - [Delete a binding](https://docs.ezghcloud.com/hostedqueues-api/DeleteClusterBinding/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. The engine's and the platform's own objects are 409 internal_object. - [Delete a consumer group](https://docs.ezghcloud.com/hostedqueues-api/DeleteClusterConsumerGroup/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. 409 group_not_empty while it has members. - [Delete an exchange](https://docs.ezghcloud.com/hostedqueues-api/DeleteClusterExchange/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. The engine's and the platform's own objects are 409 internal_object. - [Delete a policy](https://docs.ezghcloud.com/hostedqueues-api/DeleteClusterPolicy/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. The engine's and the platform's own objects are 409 internal_object. - [Delete a queue](https://docs.ezghcloud.com/hostedqueues-api/DeleteClusterQueue/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. The engine's and the platform's own objects are 409 internal_object. - [Delete a topic](https://docs.ezghcloud.com/hostedqueues-api/DeleteClusterTopic/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. The engine's and the platform's own objects are 409 internal_object. - [Delete a user](https://docs.ezghcloud.com/hostedqueues-api/DeleteClusterUser/index.md) — Asynchronous. Deletes its Secret first, as the caller. - [Delete a vhost](https://docs.ezghcloud.com/hostedqueues-api/DeleteClusterVhost/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. 409 vhost_not_empty while it has queues, unless force=true. - [Get a cluster](https://docs.ezghcloud.com/hostedqueues-api/GetCluster/index.md) - [Get a binding](https://docs.ezghcloud.com/hostedqueues-api/GetClusterBinding/index.md) - [Get a consumer group](https://docs.ezghcloud.com/hostedqueues-api/GetClusterConsumerGroup/index.md) - [Get an exchange](https://docs.ezghcloud.com/hostedqueues-api/GetClusterExchange/index.md) - [Get a policy](https://docs.ezghcloud.com/hostedqueues-api/GetClusterPolicy/index.md) - [Get a queue](https://docs.ezghcloud.com/hostedqueues-api/GetClusterQueue/index.md) - [Get a topic](https://docs.ezghcloud.com/hostedqueues-api/GetClusterTopic/index.md) - [Get a user](https://docs.ezghcloud.com/hostedqueues-api/GetClusterUser/index.md) - [Get a vhost](https://docs.ezghcloud.com/hostedqueues-api/GetClusterVhost/index.md) - [Get an operation (poll it until it finishes)](https://docs.ezghcloud.com/hostedqueues-api/GetOperation/index.md) — While it's queued or running, Retry-After suggests when to poll again. Not recorded in Trails. - [List a cluster's bindings, by name](https://docs.ezghcloud.com/hostedqueues-api/ListClusterBindings/index.md) — RabbitMQ clusters only; 404 on Kafka. The vhost / is default in paths. Read from the broker every few seconds; observedAt says when. - [List a cluster's consumer groups, by name](https://docs.ezghcloud.com/hostedqueues-api/ListClusterConsumerGroups/index.md) — Kafka clusters only; 404 on RabbitMQ. Read from the broker every few seconds; observedAt says when. - [List a cluster's events, newest first](https://docs.ezghcloud.com/hostedqueues-api/ListClusterEvents/index.md) - [List a cluster's exchanges, by name](https://docs.ezghcloud.com/hostedqueues-api/ListClusterExchanges/index.md) — RabbitMQ clusters only; 404 on Kafka. The vhost / is default in paths. Read from the broker every few seconds; observedAt says when. - [List a cluster's policies, by name](https://docs.ezghcloud.com/hostedqueues-api/ListClusterPolicies/index.md) — RabbitMQ clusters only; 404 on Kafka. The vhost / is default in paths. Read from the broker every few seconds; observedAt says when. - [List a cluster's queues, by name](https://docs.ezghcloud.com/hostedqueues-api/ListClusterQueues/index.md) — RabbitMQ clusters only; 404 on Kafka. The vhost / is default in paths. Read from the broker every few seconds; observedAt says when. - [List a cluster's topics, by name](https://docs.ezghcloud.com/hostedqueues-api/ListClusterTopics/index.md) — Kafka clusters only; 404 on RabbitMQ. Read from the broker every few seconds; observedAt says when. - [List a cluster's users, newest first](https://docs.ezghcloud.com/hostedqueues-api/ListClusterUsers/index.md) - [List a cluster's vhosts, by name](https://docs.ezghcloud.com/hostedqueues-api/ListClusterVhosts/index.md) — RabbitMQ clusters only; 404 on Kafka. The vhost / is default in paths. Read from the broker every few seconds; observedAt says when. - [List a project's Hosted Queues clusters, newest first](https://docs.ezghcloud.com/hostedqueues-api/ListClusters/index.md) - [List engines, versions, modes, settings and upgrade targets](https://docs.ezghcloud.com/hostedqueues-api/ListEngineVersions/index.md) - [List the organization's operations, newest first](https://docs.ezghcloud.com/hostedqueues-api/ListOperations/index.md) - [Purge a queue](https://docs.ezghcloud.com/hostedqueues-api/PurgeClusterQueue/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. Its ready messages go. - [Raise every topic to three copies](https://docs.ezghcloud.com/hostedqueues-api/RaiseClusterReplication/index.md) — Asynchronous. Kafka replicated clusters only (404 on RabbitMQ; 409 not_replicated on a single node): every topic with fewer than three copies, apps' included, is raised to three. Topics stay as made otherwise. - [Reset a consumer group's offsets](https://docs.ezghcloud.com/hostedqueues-api/ResetClusterConsumerGroupOffsets/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. 409 group_not_empty while it has members. - [Rotate a user's password](https://docs.ezghcloud.com/hostedqueues-api/RotateClusterUserPassword/index.md) — Asynchronous. Writes a new version of its Secret (a new Secret if it was deleted), then applies it. - [Change a cluster](https://docs.ezghcloud.com/hostedqueues-api/UpdateCluster/index.md) — Asynchronous. mode (single to replicated only: 409 mode_downgrade_not_supported) and engineVersion (newer only: 409 downgrade_not_supported) each change on their own. Storage only grows, and grows while the cluster is storage_low. - [Change a policy](https://docs.ezghcloud.com/hostedqueues-api/UpdateClusterPolicy/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. - [Change a topic](https://docs.ezghcloud.com/hostedqueues-api/UpdateClusterTopic/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. The engine's and the platform's own objects are 409 internal_object. More partitions, config changes, or a higher replicationFactor (an explicit raise); fewer is 400. - [Change a user's permissions](https://docs.ezghcloud.com/hostedqueues-api/UpdateClusterUser/index.md) — Asynchronous. Applies live: the engine isn't restarted. A RabbitMQ user's Secret names one vhost in vhost and uri, its first at creation; a change that takes that vhost away gives the user a new password and a new Secret version naming the first vhost left (secrets.versions.create, as the caller), closes its open connections and records a user_password_rotated event. - [Change a vhost](https://docs.ezghcloud.com/hostedqueues-api/UpdateClusterVhost/index.md) — Asynchronous: it reaches the broker through the cluster. 409 cluster_not_ready while the cluster is creating, recovering or upgrading. - [Cluster](https://docs.ezghcloud.com/hostedqueues-api/schemas/Cluster/index.md) - [ClusterBinding](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterBinding/index.md) - [ClusterBindingCreate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterBindingCreate/index.md) - [ClusterBindingList](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterBindingList/index.md) - [ClusterConsumerGroup](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterConsumerGroup/index.md) - [ClusterConsumerGroupList](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterConsumerGroupList/index.md) - [ClusterConsumerGroupResetOffsets](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterConsumerGroupResetOffsets/index.md) - [ClusterCreate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterCreate/index.md) - [ClusterEvent](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterEvent/index.md) - [ClusterEventList](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterEventList/index.md) - [ClusterExchange](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterExchange/index.md) - [ClusterExchangeCreate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterExchangeCreate/index.md) - [ClusterExchangeList](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterExchangeList/index.md) - [ClusterList](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterList/index.md) - [ClusterPolicy](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterPolicy/index.md) - [ClusterPolicyCreate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterPolicyCreate/index.md) - [ClusterPolicyList](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterPolicyList/index.md) - [ClusterPolicyUpdate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterPolicyUpdate/index.md) - [ClusterQueue](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterQueue/index.md) - [ClusterQueueCreate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterQueueCreate/index.md) - [ClusterQueueList](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterQueueList/index.md) - [ClusterTopic](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterTopic/index.md) - [ClusterTopicCreate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterTopicCreate/index.md) - [ClusterTopicList](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterTopicList/index.md) - [ClusterTopicUpdate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterTopicUpdate/index.md) - [ClusterUpdate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterUpdate/index.md) - [ClusterUser](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterUser/index.md) - [ClusterUserCreate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterUserCreate/index.md) - [ClusterUserList](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterUserList/index.md) - [ClusterUserUpdate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterUserUpdate/index.md) - [ClusterVhost](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterVhost/index.md) - [ClusterVhostCreate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterVhostCreate/index.md) - [ClusterVhostList](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterVhostList/index.md) - [ClusterVhostUpdate](https://docs.ezghcloud.com/hostedqueues-api/schemas/ClusterVhostUpdate/index.md) - [Endpoint](https://docs.ezghcloud.com/hostedqueues-api/schemas/Endpoint/index.md) — How clients reach the cluster. Null until its names resolve. - [EngineVersions](https://docs.ezghcloud.com/hostedqueues-api/schemas/EngineVersions/index.md) - [Error](https://docs.ezghcloud.com/hostedqueues-api/schemas/Error/index.md) — Every non-2xx answer. Clients branch on code, never on message. - [KafkaSettings](https://docs.ezghcloud.com/hostedqueues-api/schemas/KafkaSettings/index.md) — Kafka's cluster settings; RabbitMQ clusters take none ({}). - [Maintenance](https://docs.ezghcloud.com/hostedqueues-api/schemas/Maintenance/index.md) - [Operation](https://docs.ezghcloud.com/hostedqueues-api/schemas/Operation/index.md) - [OperationList](https://docs.ezghcloud.com/hostedqueues-api/schemas/OperationList/index.md) - [OperationStatus](https://docs.ezghcloud.com/hostedqueues-api/schemas/OperationStatus/index.md) - [QuotaExceeded](https://docs.ezghcloud.com/hostedqueues-api/schemas/QuotaExceeded/index.md) — quota_exceeded: the quota that refused the request. Never with Retry-After. - [Storage](https://docs.ezghcloud.com/hostedqueues-api/schemas/Storage/index.md) - [Tags](https://docs.ezghcloud.com/hostedqueues-api/schemas/Tags/index.md) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved. - [UnauthenticatedAccess](https://docs.ezghcloud.com/hostedqueues-api/schemas/UnauthenticatedAccess/index.md) — Kafka only: a TLS listener on 9091 with no client authentication, for apps that can't do SASL, reachable only from allowedSourceCidrs and firewall peers. Null on RabbitMQ. - [UserPermissions](https://docs.ezghcloud.com/hostedqueues-api/schemas/UserPermissions/index.md) — Kafka: {preset: admin | readWrite | readOnly | custom, topics: [{topic, access: produce | consume | produceConsume, create}], groups: [{group}]}, names or prefixes with a trailing *. RabbitMQ: {vhosts: [{vhost, preset: readWrite | readOnly | custom, configure, write, read}]}, custom being RabbitMQ's regular expressions.