Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a meter
Gets a meter.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Gets a meter.
Not available yet. Sylphx Billing is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- Path
GET https://api.sylphx.com/v1/meters/meter - Scope
billing:read - Effect
read— nothing is written. - Collection meters
- Publishable key callable
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the meter to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | meters/{meter}, where {meter} is the meter id {service}.{quantity}, for example meters/hosting.vcpu_seconds. |
uid | string | mtr_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. Output only. |
service | string | The service that emits the meter; the meter id's prefix. Output only. |
current_version | int32 | The version new usage is measured under. Output only. |
versions | MeterVersion[] | Every version, oldest first. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#MeterVersion
| Field | Type | What it is |
|---|---|---|
version | int32 | The version number, from 1. Output only. |
unit | string | The base unit, for example s, B, or tokens. Output only. |
aggregation | MeterAggregation | How quantities combine over a period. Output only. One of sum, max, last, unique_count. |
dimensions | MeterDimension[] | The dimensions a usage event may carry; at most 8. Output only. |
hard_spend | bool | Spend is bounded by budget leases. Output only. |
value_scale | int64 | A quantity is an integer count of 1/value_scale base units; 1 for integral units. Output only. |
effective_time | timestamp | When usage starts being measured under this version. Output only. |
#MeterDimension
| Field | Type | What it is |
|---|---|---|
key | string | The dimension key, for example class. Output only. |
values | string[] | The allowed values; empty means a bounded free-form string. Output only. |
required | bool | Every event must carry it. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/meters/meter" \
-H "Authorization: Bearer $SYLPHX_API_KEY"