HTTP API Reference for Momento Capacity Pools

Momento provides an HTTP API interface for managing Capacity Pools. This API lets you create, describe, update, list, and delete Capacity Pools programmatically, discover available capacity offerings, and scrape their utilization metrics.

A Capacity Pool is a customer-provisioned unit of dedicated Valkey capacity. Pool capacity is configured Valkey maxmemory per primary shard multiplied by the number of primary shards; replicas do not add Pool capacity. You choose how the Pool is sized, either explicit mode (Cluster), in which you specify the exact instance type, shard count, and replicas per shard, or managed mode (Flex), in which you give capacity and replication bounds and Momento sizes the Pool within them. Momento owns the underlying lifecycle and health of the Pool. Each Pool can host Databases, which share its compute and memory.

Limited preview

Momento Cache is available in limited preview. Sign in or sign up in the Momento console and select Request access before calling this API.

Info

The Momento platform is region-based with endpoints specific to each region. To view a list of supported regions and their endpoints, click here.

Authentication

You will need a Momento API Key generated via the Momento console. Momento API Keys control access to the Momento services and can be set to expire.

The API Key must be provided in the Authorization header.

Capacity Pool API

The Capacity Pool API lets you create, describe, update, list, and delete Capacity Pools, discover the capacity offerings available to your account, and scrape utilization metrics.

Provisioning

A Capacity Pool's capacity is described by a provisioning object. The object nests its configuration under a single key that names the provisioning mode. Exactly one mode key must be provided, and unknown fields are rejected. Two modes are available:

explicit (Cluster) — you specify the instance type, shard count, replicas per shard, and AZ placement directly.
managed (Flex) — you specify capacity and replication bounds, and Momento sizes the pool within them.

A pool's mode is fixed when it is created. Switching an existing pool between modes is not supported today.

In both modes, zones are availability-zone IDs (for example, use1-az1), not zone names — an AZ ID maps to the same physical zone across accounts.

Explicit mode

In explicit mode you specify the pool's shape directly:

{
  "explicit": {
    "instance_type": "r7g.xlarge",
    "shard_count": 3,
    "replicas_per_shard": 1,
    "zones": ["use1-az1", "use1-az2"]
  }
}

Field	Required?	Type	Description
explicit	yes	Object	The explicit-mode provisioning configuration. Exactly one mode key must be provided.
explicit.instance_type	yes	String	The instance type for the pool's nodes (for example, `r7g.xlarge`).
explicit.shard_count	yes	Integer	The number of shards in the pool.
explicit.replicas_per_shard	yes	Integer	The number of replicas per shard.
explicit.zones	yes	Array<String>	The availability-zone IDs across which the pool's nodes are placed. Must contain at least one zone.

Managed mode

In managed mode you specify bounds for capacity and replication, and Momento sizes the pool within them. Set a dimension's minimum equal to its maximum to pin it to an exact value:

{
  "managed": {
    "capacity": {
      "min_gib": 32,
      "max_gib": 128
    },
    "replication": {
      "min_replicas_per_shard": 1,
      "max_replicas_per_shard": 2
    },
    "zones": ["use1-az1", "use1-az2"],
    "family": "general"
  }
}

Field	Required?	Type	Description
managed	yes	Object	The managed-mode provisioning configuration. Exactly one mode key must be provided.
managed.capacity	yes	Object	The pool's capacity bounds, in GiB.
managed.capacity.min_gib	yes	Integer	The minimum capacity, in GiB. Set equal to `max_gib` to pin capacity.
managed.capacity.max_gib	yes	Integer	The maximum capacity, in GiB.
managed.replication	yes	Object	The pool's replication bounds.
managed.replication.min_replicas_per_shard	yes	Integer	The minimum replicas per shard. Set equal to the maximum to pin replication.
managed.replication.max_replicas_per_shard	yes	Integer	The maximum replicas per shard.
managed.zones	yes	Array<String>	The availability-zone IDs across which the pool's nodes are placed. Must contain at least one zone.
managed.family	no	String	The capacity family to use. When omitted, the Pool resolves to the cell default. The resolved family is always present in managed-mode responses.

Because managed capacity is quantized to the configurations available in the cell, the capacity you are granted may exceed min_gib. The last settled allocation is reported by current_capacity_gib; target_capacity_gib reports the allocation the Pool is converging to and differs only while a scale is in flight. Both fields use the same Pool-capacity quantity. current_replicas_per_shard reports settled replication.

Capacity offering discovery

Discovery responses are scoped to the calling account and the region served by the API endpoint. Use them to determine the managed families and Cluster instance types the account can select.

List managed capacity families

GET /capacity_pool/families returns:

Field	Type	Description
families	Array	The managed capacity families the calling account may select.
families[].name	String	The family name accepted by `provisioning.managed.family`.
families[].is_default	Boolean	Whether this is the cell's current default family.
families[].min_capacity_gib	Integer	The smallest granted Pool capacity offered by the family, in GiB.
families[].max_capacity_gib	Integer	The largest granted Pool capacity offered by the family, in GiB.

List Cluster instance types

GET /capacity_pool/instance_types returns an instance_types array containing the instance types the calling account may provision in explicit mode. The array is sorted and is empty when the cell offers no Capacity Pool instance types.

Select or reset a managed family

Set provisioning.managed.family to a family name when creating a managed Pool to pin that family. If you omit the field, the Pool resolves and pins the cell's current default. A later default change does not silently move an existing Pool.

On update, pass { "family": { "name": "<family>" } } under provisioning.managed to pin a named family. Pass { "family": "cell_default" } to re-resolve and pin the then-current cell default.

Status

A Capacity Pool has its own lifecycle status, surfaced at describe time:

Status	Description
creating	The pool has been accepted and its backing capacity is being provisioned asynchronously.
active	The pool is fully provisioned and ready to serve Databases.
deleting	The pool is being torn down.

These three values are the pool's complete status set. A pool stays active while its capacity converges to a requested change; there is no separate scaling or updating status. Progress, or a condition that blocks the change, surfaces as a diagnostic.

Diagnostics

Every Capacity Pool response includes a diagnostics field: an array of customer-actionable conditions affecting the pool (for example, insufficient capacity), derived from the underlying capacity at read time. The array is always present and is empty ([]) when there is nothing to surface.

Describe Capacity Pool returns active conditions plus recently-resolved ones; List Capacity Pools returns only active conditions.

Each diagnostic nests its details under a single key that names the kind of condition. Three kinds are defined.

The insufficient_capacity kind is raised when Momento cannot provision the requested capacity:

{
  "insufficient_capacity": {
    "state": "active",
    "message": "Insufficient r7g.xlarge capacity in use1-az1.",
    "instance_type": "r7g.xlarge",
    "availability_zones": ["use1-az1"],
    "first_observed_epoch_seconds": 1719360000,
    "last_observed_epoch_seconds": 1719363600
  }
}

The fields of an insufficient_capacity diagnostic:

Field	Type	Description
state	String	Whether the condition is currently in effect (`active`) or recently cleared (`resolved`).
message	String	A human-readable summary suitable for surfacing directly to the customer.
instance_type	String	The instance type that could not be provisioned.
availability_zones	Array<String>	The availability zones the condition has been observed in during this episode.
first_observed_epoch_seconds	Integer	When the condition was first observed, in seconds since the Unix epoch.
last_observed_epoch_seconds	Integer	The most recent time the condition was observed. For an active diagnostic, how recently it was confirmed still in effect; for a resolved one, the last failure before it cleared.
resolved_epoch_seconds	Integer	When the condition resolved, in seconds since the Unix epoch. Present only on a `resolved` diagnostic.

The scale_blocked_by_utilization kind is raised at propagation time when an update that passed request-time preflight can no longer be applied — the pool's current data no longer fits the requested configuration, or its usage can't currently be verified. The stored request is retried automatically and applies once it fits (or is superseded by another update):

{
  "scale_blocked_by_utilization": {
    "state": "active",
    "message": "The requested configuration is smaller than the pool's current data; retrying until it fits.",
    "requested_shard_count": 6,
    "requested_instance_type": "r7g.xlarge",
    "data_approx": "42 GB",
    "capacity_approx": "32 GB",
    "first_observed_epoch_seconds": 1719360000,
    "last_observed_epoch_seconds": 1719363600
  }
}

The fields of a scale_blocked_by_utilization diagnostic:

Field	Type	Description
state	String	Whether the condition is currently in effect (`active`) or recently cleared (`resolved`).
message	String	A human-readable summary suitable for surfacing directly to the customer.
requested_shard_count	Integer	The requested shard count that isn't landing.
requested_instance_type	String	The requested instance type that isn't landing.
data_approx	String	A rounded total of the pool's current data. Present only when the data doesn't fit; absent when usage can't be verified.
capacity_approx	String	A rounded total of what the requested configuration can hold. Present only when the data doesn't fit.
first_observed_epoch_seconds	Integer	When the condition was first observed, in seconds since the Unix epoch.
last_observed_epoch_seconds	Integer	The most recent time the condition was observed.
resolved_epoch_seconds	Integer	When the condition resolved, in seconds since the Unix epoch. Present only on a `resolved` diagnostic.

The capacity_limit_reached kind is raised when a managed pool's utilization calls for growth but the pool is already at its configured maximum capacity. It remains active until you raise the ceiling or usage drops:

{
  "capacity_limit_reached": {
    "state": "active",
    "message": "The pool has reached its configured capacity limit.",
    "max_gib": 128,
    "utilization_percent": 92,
    "first_observed_epoch_seconds": 1719360000,
    "last_observed_epoch_seconds": 1719363600
  }
}

The fields of a capacity_limit_reached diagnostic:

Field	Type	Description
state	String	Whether the condition is currently in effect (`active`) or recently cleared (`resolved`).
message	String	A human-readable summary suitable for surfacing directly to the customer.
max_gib	Integer	The configured capacity ceiling, in GiB, that the pool has reached.
utilization_percent	Integer	Utilization of the fullest part of the pool, as a percentage of granted capacity.
first_observed_epoch_seconds	Integer	When the condition was first observed, in seconds since the Unix epoch.
last_observed_epoch_seconds	Integer	The most recent time the condition was observed.
resolved_epoch_seconds	Integer	When the condition resolved, in seconds since the Unix epoch. Present only on a `resolved` diagnostic.

Create Capacity Pool

Creates a new Capacity Pool with the specified provisioning. The pool is created synchronously in creating status; the backing capacity is provisioned asynchronously. Use the Describe Capacity Pool endpoint to poll until the pool's status is active.

Request

Path: /capacity_pool/{name}
HTTP Method: POST

Path Parameters

Parameter name	Required?	Type	Description
name	yes	URL-safe string	The name of the Capacity Pool.

Headers

Header name	Required?	Type	Description
Authorization	yes	String	The Momento API key, in string format, is used for authentication/authorization of the request.
Content-Type	yes	String	Must be `application/json`.

Request Body

An explicit-mode pool:

{
  "provisioning": {
    "explicit": {
      "instance_type": "r7g.xlarge",
      "shard_count": 3,
      "replicas_per_shard": 1,
      "zones": ["use1-az1", "use1-az2"]
    }
  }
}

A managed-mode pool:

{
  "provisioning": {
    "managed": {
      "capacity": { "min_gib": 32, "max_gib": 128 },
      "replication": { "min_replicas_per_shard": 1, "max_replicas_per_shard": 2 },
      "zones": ["use1-az1", "use1-az2"]
    }
  }
}

Field	Required?	Type	Description
provisioning	yes	Object	The provisioning configuration for the pool. All fields of the chosen mode are required at create. See Provisioning.

Responses

Success

Status Code: 201 Created

{
  "name": "prod-us-east-1",
  "provisioning": {
    "explicit": {
      "instance_type": "r7g.xlarge",
      "shard_count": 3,
      "replicas_per_shard": 1,
      "zones": ["use1-az1", "use1-az2"]
    }
  },
  "status": "creating",
  "diagnostics": []
}

Field	Type	Description
name	String	The name of the Capacity Pool.
provisioning	Object	The pool's provisioning configuration. See Provisioning.
status	String	The pool's lifecycle status. See Status.
diagnostics	Array	Customer-actionable conditions affecting the pool. Empty when there is nothing to surface. See Diagnostics.
current_capacity_gib	Integer	Managed pools only. The capacity, in GiB, the pool concretely has right now within its requested bounds. Omitted for explicit pools.
current_replicas_per_shard	Integer	Managed pools only. The replicas per shard the pool concretely has right now within its requested bounds. Omitted for explicit pools.
target_capacity_gib	Integer	Managed pools only. The Pool capacity the service is converging to. Equal to `current_capacity_gib` except while a scale is in flight.

Error

Status Code: 400 Bad Request

"Invalid Argument" indicates the request body contains invalid configuration. See the message body for further details.

Status Code: 401 Unauthorized

This error type typically indicates that the Momento API key passed in is either invalid or expired. See the body of the message for further details.

Status Code: 403 Forbidden

This error type typically indicates the Momento API key passed in does not grant the required access. See the body of the message for further details.

Status Code: 409 Already Exists

A Capacity Pool with the specified name already exists.

Status Code: 429 Too Many Requests

Creating the pool would exceed the account's capacity limit. See Service limits.

Status Code: 500 Internal Server Error

This error type typically indicates that the service is experiencing issues. Contact Momento support for further assistance.

Describe Capacity Pool

Retrieves the details of a specific Capacity Pool.

Request

Path: /capacity_pool/{name}
HTTP Method: GET

Path Parameters

Parameter name	Required?	Type	Description
name	yes	URL-safe string	The name of the Capacity Pool.

Headers

Header name	Required?	Type	Description
Authorization	yes	String	The Momento API key, in string format, is used for authentication/authorization of the request.

Responses

Success

Status Code: 200 OK

An explicit-mode pool:

{
  "name": "prod-us-east-1",
  "provisioning": {
    "explicit": {
      "instance_type": "r7g.xlarge",
      "shard_count": 3,
      "replicas_per_shard": 1,
      "zones": ["use1-az1", "use1-az2"]
    }
  },
  "status": "active",
  "diagnostics": []
}

A managed-mode pool additionally reports the capacity and replication it concretely has right now via current_capacity_gib and current_replicas_per_shard:

{
  "name": "flex-us-east-1",
  "provisioning": {
    "managed": {
      "capacity": { "min_gib": 32, "max_gib": 128 },
      "replication": { "min_replicas_per_shard": 1, "max_replicas_per_shard": 2 },
      "zones": ["use1-az1", "use1-az2"]
    }
  },
  "status": "active",
  "diagnostics": [],
  "current_capacity_gib": 64,
  "current_replicas_per_shard": 1
}

The status field reflects the pool's lifecycle status (creating / active / deleting). The diagnostics field is derived from the underlying capacity at read time; Describe returns active conditions plus recently-resolved ones. See Diagnostics. For managed Pools, current_capacity_gib and current_replicas_per_shard report the last settled allocation, while target_capacity_gib reports the Pool capacity being applied. These fields are omitted for explicit Pools.

Error

Status Code: 401 Unauthorized

This error type typically indicates that the Momento API key passed in is either invalid or expired.

Status Code: 403 Forbidden

This error type typically indicates the Momento API key passed in does not grant the required access.

Status Code: 404 Not Found

The specified Capacity Pool does not exist.

Status Code: 500 Internal Server Error

This error type typically indicates that the service is experiencing issues.

List Capacity Pools

Lists all Capacity Pools owned by your account in the region served by this API endpoint.

Request

Path: /capacity_pool
HTTP Method: GET

Headers

Header name	Required?	Type	Description
Authorization	yes	String	The Momento API key, in string format, is used for authentication/authorization of the request.

Responses

Success

Status Code: 200 OK

{
  "capacity_pools": [
    {
      "name": "prod-us-east-1",
      "provisioning": {
        "explicit": {
          "instance_type": "r7g.xlarge",
          "shard_count": 3,
          "replicas_per_shard": 1,
          "zones": ["use1-az1", "use1-az2"]
        }
      },
      "status": "active",
      "diagnostics": []
    },
    {
      "name": "flex-us-east-1",
      "provisioning": {
        "managed": {
          "capacity": { "min_gib": 32, "max_gib": 128 },
          "replication": { "min_replicas_per_shard": 1, "max_replicas_per_shard": 2 },
          "zones": ["use1-az1"]
        }
      },
      "status": "active",
      "diagnostics": [],
      "current_capacity_gib": 64,
      "current_replicas_per_shard": 1
    }
  ]
}

Field	Type	Description
capacity_pools	Array	The Capacity Pools owned by the calling account. Each entry has the same shape as the Describe Capacity Pool response, except that `diagnostics` includes only active conditions.

Error

Status Code: 401 Unauthorized

This error type typically indicates that the Momento API key passed in is either invalid or expired.

Status Code: 403 Forbidden

This error type typically indicates the Momento API key passed in does not grant the required access.

Status Code: 500 Internal Server Error

This error type typically indicates that the service is experiencing issues.

Update Capacity Pool

Updates the provisioning of an existing Capacity Pool. The request body contains only the fields to change; any subset of the fields is valid. The configuration is nested under the same mode key as the pool's current provisioning (explicit or managed); within it, a present field overwrites and an absent field is left unchanged. A pool's mode cannot be changed by an update.

An accepted update is applied asynchronously. The pool's backing capacity converges to the new provisioning (adding or removing replicas, rolling instance types, resizing within managed bounds, and so on) after the response is returned. The pool stays active while it converges; see Status.

For an active explicit-mode pool, a capacity-reducing request is preflighted against fresh memory utilization telemetry before the requested provisioning is stored. If the data would not fit, or usage cannot be verified, the API rejects the PATCH with 409 Precondition Failed. Adjust the target shape or retry; a rejected request is not queued. An accepted update can still report scale_blocked_by_utilization if conditions change before propagation.

Request

Path: /capacity_pool/{name}
HTTP Method: PATCH

Path Parameters

Parameter name	Required?	Type	Description
name	yes	URL-safe string	The name of the Capacity Pool.

Headers

Header name	Required?	Type	Description
Authorization	yes	String	The Momento API key, in string format, is used for authentication/authorization of the request.
Content-Type	yes	String	Must be `application/json`.

Request Body

For an explicit-mode pool (here, raising replicas per shard):

{
  "provisioning": {
    "explicit": {
      "replicas_per_shard": 2
    }
  }
}

For a managed-mode pool, a present capacity or replication replaces that dimension's bounds in full (here, raising the capacity ceiling):

{
  "provisioning": {
    "managed": {
      "capacity": { "min_gib": 32, "max_gib": 256 }
    }
  }
}

Field	Required?	Type	Description
provisioning	yes	Object	The provisioning configuration to change, nested under the mode key. Must match the pool's current mode.
provisioning.explicit.instance_type	no	String	If present, the new instance type for the pool's nodes.
provisioning.explicit.shard_count	no	Integer	If present, the new number of shards.
provisioning.explicit.replicas_per_shard	no	Integer	If present, the new number of replicas per shard.
provisioning.explicit.zones	no	Array<String>	If non-empty, replaces the pool's zone set. An empty or absent value leaves the zones unchanged.
provisioning.managed.capacity	no	Object	If present, replaces the capacity bounds (`min_gib`, `max_gib`) in full.
provisioning.managed.replication	no	Object	If present, replaces the replication bounds (`min_replicas_per_shard`, `max_replicas_per_shard`) in full.
provisioning.managed.zones	no	Array<String>	If non-empty, replaces the pool's zone set. An empty or absent value leaves the zones unchanged.
provisioning.managed.family	no	Object or String	`{ "name": "<family>" }` pins a named family; `"cell_default"` re-resolves and pins the current cell default.

Responses

Success

Status Code: 200 OK

Returns the updated pool in the same shape as the Describe Capacity Pool response.

{
  "name": "prod-us-east-1",
  "provisioning": {
    "explicit": {
      "instance_type": "r7g.xlarge",
      "shard_count": 3,
      "replicas_per_shard": 2,
      "zones": ["use1-az1", "use1-az2"]
    }
  },
  "status": "active",
  "diagnostics": []
}

Error

Status Code: 400 Bad Request

The request body contains invalid configuration.

Status Code: 401 Unauthorized

This error type typically indicates that the Momento API key passed in is either invalid or expired.

Status Code: 403 Forbidden

The update is not permitted for this pool. Contact Momento support for further assistance.

Status Code: 404 Not Found

The specified Capacity Pool does not exist.

Status Code: 409 Precondition Failed

The requested explicit-mode shrink cannot be verified as safe, or the current data would not fit. The update was not stored.

Status Code: 429 Too Many Requests

The update would exceed the account's capacity limit. See Service limits.

Status Code: 500 Internal Server Error

This error type typically indicates that the service is experiencing issues.

Delete Capacity Pool

Deletes a Capacity Pool. The pool is marked deleting and its backing capacity is torn down asynchronously, after which the pool is removed.

note

A Capacity Pool cannot be deleted while it still has Databases pinned to it. Delete the pool's Databases first.

Request

Path: /capacity_pool/{name}
HTTP Method: DELETE

Path Parameters

Parameter name	Required?	Type	Description
name	yes	URL-safe string	The name of the Capacity Pool.

Headers

Header name	Required?	Type	Description
Authorization	yes	String	The Momento API key, in string format, is used for authentication/authorization of the request.

Responses

Success

Status Code: 202 Accepted

The pool deletion has been accepted and is being processed asynchronously. There is no response body.

Error

Status Code: 401 Unauthorized

This error type typically indicates that the Momento API key passed in is either invalid or expired.

Status Code: 403 Forbidden

This error type typically indicates the Momento API key passed in does not grant the required access.

Status Code: 409 Conflict

The pool still has Databases pinned to it and cannot be deleted.

Status Code: 500 Internal Server Error

This error type typically indicates that the service is experiencing issues.

Capacity Pool Metrics

Returns real-time utilization metrics for the Capacity Pools in your account and the region served by this API endpoint, in Prometheus exposition format. The endpoint takes no pool name and returns one block of samples per pool in that region. Query each regional endpoint for an all-region view. Point a Prometheus-compatible scraper at it, or fetch it directly with curl.

See Capacity Pool metrics for the seven Prometheus metrics and the separate six-metric conditional CloudWatch contract.

Request

Path: /capacity_pool/metrics
HTTP Method: GET

Headers

Header name	Required?	Type	Description
Authorization	yes	String	The Momento API key, in string format, is used for authentication/authorization of the request. A key with read access is sufficient.

Responses

Success

Status Code: 200 OK

The response Content-Type is text/plain; version=0.0.4 (the Prometheus text exposition format). The body carries one set of samples per Capacity Pool. Every sample is labeled with account_id, endpoint (the serving cell), and pool_name:

# HELP capacity_pool_memory_used_bytes Bytes of a pool's Valkey maxmemory eviction ceiling in use.
# TYPE capacity_pool_memory_used_bytes gauge
# HELP capacity_pool_memory_maxmemory_bytes A pool's Valkey maxmemory eviction ceiling.
# TYPE capacity_pool_memory_maxmemory_bytes gauge
# HELP capacity_pool_memory_utilization_ratio Fraction of a pool's Valkey maxmemory eviction ceiling in use.
# TYPE capacity_pool_memory_utilization_ratio gauge
# HELP capacity_pool_evictions_total Total keys evicted for a pool
# TYPE capacity_pool_evictions_total counter
# HELP capacity_pool_host_cpu_usage_ratio CPU utilization for a pool, 0.0-1.0.
# TYPE capacity_pool_host_cpu_usage_ratio gauge
# HELP capacity_pool_host_network_rx_utilization_ratio Network receive utilization for a pool, 0.0-1.0.
# TYPE capacity_pool_host_network_rx_utilization_ratio gauge
# HELP capacity_pool_host_network_tx_utilization_ratio Network transmit utilization for a pool, 0.0-1.0.
# TYPE capacity_pool_host_network_tx_utilization_ratio gauge
capacity_pool_memory_used_bytes{account_id="acct-1a2b",endpoint="cell-1-us-east-1-1",pool_name="prod-us-east-1"} 12884901888
capacity_pool_memory_maxmemory_bytes{account_id="acct-1a2b",endpoint="cell-1-us-east-1-1",pool_name="prod-us-east-1"} 34359738368
capacity_pool_memory_utilization_ratio{account_id="acct-1a2b",endpoint="cell-1-us-east-1-1",pool_name="prod-us-east-1"} 0.375
capacity_pool_evictions_total{account_id="acct-1a2b",endpoint="cell-1-us-east-1-1",pool_name="prod-us-east-1"} 421
capacity_pool_host_cpu_usage_ratio{account_id="acct-1a2b",endpoint="cell-1-us-east-1-1",pool_name="prod-us-east-1"} 0.22
capacity_pool_host_network_rx_utilization_ratio{account_id="acct-1a2b",endpoint="cell-1-us-east-1-1",pool_name="prod-us-east-1"} 0.14
capacity_pool_host_network_tx_utilization_ratio{account_id="acct-1a2b",endpoint="cell-1-us-east-1-1",pool_name="prod-us-east-1"} 0.09

The exposed metrics:

Metric	Type	Description
capacity_pool_memory_used_bytes	gauge	Bytes of the pool's Valkey `maxmemory` eviction ceiling in use.
capacity_pool_memory_maxmemory_bytes	gauge	The pool's Valkey `maxmemory` eviction ceiling.
capacity_pool_memory_utilization_ratio	gauge	Fraction of the eviction ceiling in use, computed as `used / maxmemory`.
capacity_pool_evictions_total	counter	Total keys evicted for the pool.
capacity_pool_host_cpu_usage_ratio	gauge	Host CPU utilization (0.0–1.0). Emitted only when a reading is available.
capacity_pool_host_network_rx_utilization_ratio	gauge	Host network receive utilization (0.0–1.0). Emitted only when a reading is available.
capacity_pool_host_network_tx_utilization_ratio	gauge	Host network transmit utilization (0.0–1.0). Emitted only when a reading is available.

The # HELP and # TYPE header lines are always present, even when your account has no pools in the selected region (in which case no sample lines follow). The three capacity_pool_host_* metrics appear only when a reading is available.

Error

Status Code: 401 Unauthorized

This error type typically indicates that the Momento API key passed in is either invalid or expired.

Status Code: 403 Forbidden

This error type typically indicates the Momento API key passed in does not grant the required access.

Status Code: 429 Too Many Requests

The request was throttled. Reduce your scrape frequency and retry.

Status Code: 500 Internal Server Error

This error type typically indicates that the service is experiencing issues.

Examples

Example: Create an explicit-mode Capacity Pool

Create a new Capacity Pool with 3 shards and 1 replica per shard across two AZs:

curl -X POST -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "provisioning": {
      "explicit": {
        "instance_type": "r7g.xlarge",
        "shard_count": 3,
        "replicas_per_shard": 1,
        "zones": ["use1-az1", "use1-az2"]
      }
    }
  }' \
  "https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/capacity_pool/prod-us-east-1"

Example: Create a managed-mode Capacity Pool

Create a Capacity Pool that Momento sizes between 32 GB and 128 GB, with 1–2 replicas per shard:

curl -X POST -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "provisioning": {
      "managed": {
        "capacity": { "min_gib": 32, "max_gib": 128 },
        "replication": { "min_replicas_per_shard": 1, "max_replicas_per_shard": 2 },
        "zones": ["use1-az1", "use1-az2"]
      }
    }
  }' \
  "https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/capacity_pool/flex-us-east-1"

Example: Describe Capacity Pool

Get details for a specific Capacity Pool:

curl -H "Authorization: <token>" \
  "https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/capacity_pool/prod-us-east-1"

Example: List Capacity Pools

List all Capacity Pools in your account for the selected region:

curl -H "Authorization: <token>" \
  "https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/capacity_pool"

Example: Update Capacity Pool

Increase the replicas per shard to 2:

curl -X PATCH -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "provisioning": {
      "explicit": {
        "replicas_per_shard": 2
      }
    }
  }' \
  "https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/capacity_pool/prod-us-east-1"

Example: Delete Capacity Pool

Delete a Capacity Pool (all of its Databases must be deleted first):

curl -X DELETE -H "Authorization: <token>" \
  "https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/capacity_pool/prod-us-east-1"

Example: Scrape Capacity Pool metrics

Fetch utilization metrics for all Capacity Pools in your account for the selected region:

curl -H "Authorization: <token>" \
  "https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/capacity_pool/metrics"

Authentication​

Capacity Pool API

Provisioning​

Explicit mode​

Managed mode​

Capacity offering discovery​

List managed capacity families​

List Cluster instance types​

Select or reset a managed family​

Status​

Diagnostics​

Create Capacity Pool​

Request​

Path Parameters​

Headers​

Request Body​

Responses​

Success​

Error​

Describe Capacity Pool​

Request​

Path Parameters​

Headers​

Responses​

Success​

Error​

List Capacity Pools​

Request​

Headers​

Responses​

Success​

Error​

Update Capacity Pool​

Request​

Path Parameters​

Headers​

Request Body​

Responses​

Success​

Error​

Delete Capacity Pool​

Request​

Path Parameters​

Headers​

Responses​

Success​

Error​

Capacity Pool Metrics​

Request​

Headers​

Responses​

Success​

Error​

Examples

Example: Create an explicit-mode Capacity Pool​

Example: Create a managed-mode Capacity Pool​

Example: Describe Capacity Pool​

Example: List Capacity Pools​

Example: Update Capacity Pool​

Example: Delete Capacity Pool​

Example: Scrape Capacity Pool metrics​

Authentication

Provisioning

Explicit mode

Managed mode

Capacity offering discovery

List managed capacity families

List Cluster instance types

Select or reset a managed family

Status

Diagnostics

Create Capacity Pool

Request

Path Parameters

Headers

Request Body

Responses

Success

Error

Describe Capacity Pool

Request

Path Parameters

Headers

Responses

Success

Error

List Capacity Pools

Request

Headers

Responses

Success

Error

Update Capacity Pool

Request

Path Parameters

Headers

Request Body

Responses

Success

Error

Delete Capacity Pool

Request

Path Parameters

Headers

Responses

Success

Error

Capacity Pool Metrics

Request

Headers

Responses

Success

Error

Example: Create an explicit-mode Capacity Pool

Example: Create a managed-mode Capacity Pool

Example: Describe Capacity Pool

Example: List Capacity Pools

Example: Update Capacity Pool

Example: Delete Capacity Pool

Example: Scrape Capacity Pool metrics