Spacetime Status API

The Status API is a small operational gRPC service exposed by every Spacetime instance. GetVersion returns the semantic version of the running Spacetime build, and GetMetrics returns instance insight metrics encoded in the standard OpenTelemetry metrics protobuf format — platform-type counts and inbound/outbound scheduling message counts. It is reachable through the nbictl command line tool as status-v1 and is the surface used to confirm connectivity and credentials against a new deployment.

API entry from apis.yml

apis.yml Raw ↑
aid: aalyria:spacetime-status
name: Spacetime Status API
description: The Status API is a small operational gRPC service exposed by every Spacetime instance. GetVersion
  returns the semantic version of the running Spacetime build, and GetMetrics returns instance insight
  metrics encoded in the standard OpenTelemetry metrics protobuf format — platform-type counts and inbound/outbound
  scheduling message counts. It is reachable through the nbictl command line tool as status-v1 and is
  the surface used to confirm connectivity and credentials against a new deployment.
humanURL: https://docs.spacetime.aalyria.com/api/
baseURL: https://nbi.example.spacetime.aalyria.com
x-endpoint-pattern: status-v1.$DOMAIN
tags:
- Status
- Metrics
- OpenTelemetry
- Observability
- gRPC
properties:
- type: Protobuf
  url: grpc/api/status/v1/status.proto