Service Usage API reference
Consumer service discovery and project enablement.
Published contracts: @socra/service-api@0.1.0.
Base URL
https://service.socra.cloudService usage
Services available to or enabled on a project.
List services for project
GET
/usage/v1/servicesQuery parameters
project_idcustomrequiredavailableboolean | "true" | "false"optionalenabledboolean | "true" | "false"optionallimitintegeroptionalmin: 1 · max: 100afterstringoptionalResponse
2 fields
dataobject[]required
dataobject[]requiredidcustomrequirednamestringrequiredmin length: 1 · max length: 253 · pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$titlestringrequiredstate"enabled" | "disabled"requireddependenciesstring[]requiredhas_morebooleanrequiredEnable service
POST
/usage/v1/services/{name}/enablePath parameters
namestringrequiredmin length: 1 · max length: 253 · pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$Request body
project_idcustomrequiredResponse
5 fields
idcustomrequirednamestringrequiredmin length: 1 · max length: 253 · pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$titlestringrequiredstate"enabled" | "disabled"requireddependenciesstring[]requiredDisable service
POST
/usage/v1/services/{name}/disablePath parameters
namestringrequiredmin length: 1 · max length: 253 · pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$Request body
project_idcustomrequiredResponse
5 fields
idcustomrequirednamestringrequiredmin length: 1 · max length: 253 · pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$titlestringrequiredstate"enabled" | "disabled"requireddependenciesstring[]requiredMetric usage
Aggregated managed-service metrics for a consumer project.
Query project service usage
GET
/usage/v1/projects/{project_id}/services/{service}/usagePath parameters
project_idcustomrequiredservicestringrequiredmin length: 1 · max length: 253 · pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$Query parameters
metricstringoptionalmin length: 1 · max length: 384start_timecustomrequiredend_timecustomrequiredinterval"hour" | "day"requiredResponse
6 fields
service_idcustomrequiredservicestringrequiredmin length: 1 · max length: 253 · pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$start_timecustomrequiredend_timecustomrequiredinterval"hour" | "day"requiredseriesobject[]required
seriesobject[]requiredmetricstringrequiredmin length: 1 · max length: 384kind"delta" | "gauge" | "cumulative"requiredvalue_type"integer" | "number"requiredunitstringrequiredaggregation"sum" | "latest"requiredconsumer_project_idcustomoptionalpointsobject[]required
pointsobject[]requiredstart_timecustomrequiredend_timecustomrequiredvaluenumberrequiredsamplesintegerrequiredmin: 0 · max: 9007199254740991