Skip to navigation

Get registry metrics

Returns storage use against the plan quota and outbound bandwidth over the last 24 hours, 7 days or 30 days. Bytes are decimal (1 GB = 1,000,000,000 bytes). Requires scope: container-registry.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# REGISTRY_ID: Registry ID
curl "https://api.ibee.ai/v1/container-registry/registries/$REGISTRY_ID/metrics?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

registry_idstringRequiredformat: "uuid"
Registry ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

rangeenumOptionalDefaults to 24h
Time window.
Allowed values:

Response

Metrics returned.
registry_idstringformat: "uuid"
ID of the registry.
rangeenum

Window covered.

  • 24h
  • 7d
  • 30d
Allowed values:
granularityenum

Spacing of bandwidth_points.

  • 15m
  • 1h
  • 1d
Allowed values:
range_startdatetime

Start of the window (ISO 8601).

range_enddatetime

End of the window (ISO 8601).

generated_atdatetime

When the metrics were computed (ISO 8601).

storageobject
Storage use against the plan quota.
bandwidthobject
Outbound bandwidth over the window.
bandwidth_pointslist of objects
Outbound bytes per interval across the window.
coverageobject
How complete the bandwidth data is for the window.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
503
Service Unavailable Error