Aalyria

Spacetime Northbound Interface (NBI)

The Northbound Interface allows humans or applications to define and orchestrate a Spacetime network. It carries the Model API (NMTS entities and relationships describing platforms, antennas, interfaces and their time-dynamic position and orientation), the Provisioning API (traffic-engineering policies, links, downtimes, protection and disjoint association groups, geographic regions), the Solution API (computed beams and candidate paths), the Simulation API (scenarios and analyses), Permissions and Audit Logs. It is a gRPC API defined in Protocol Buffers and served per customer instance over subdomain-resolved endpoints such as model-v1.$DOMAIN.

GitHub

Documentation

📖
Documentation
https://docs.spacetime.aalyria.com/api/nbi/
📖
GettingStarted
https://docs.spacetime.aalyria.com/api/nbi/build-your-first-scenario/

Other Resources

🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/aalyria/refs/heads/main/grpc/api/model/v1/model.proto
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/aalyria/refs/heads/main/apis.yml

API entry from apis.yml

apis.yml Raw ↑ 
aid: aalyria:spacetime-nbi
name: Spacetime Northbound Interface (NBI)
description: The Northbound Interface allows humans or applications to define and orchestrate a Spacetime
  network. It carries the Model API (NMTS entities and relationships describing platforms, antennas, interfaces
  and their time-dynamic position and orientation), the Provisioning API (traffic-engineering policies,
  links, downtimes, protection and disjoint association groups, geographic regions), the Solution API
  (computed beams and candidate paths), the Simulation API (scenarios and analyses), Permissions and Audit
  Logs. It is a gRPC API defined in Protocol Buffers and served per customer instance over subdomain-resolved
  endpoints such as model-v1.$DOMAIN.
humanURL: https://docs.spacetime.aalyria.com/api/nbi/
baseURL: https://nbi.example.spacetime.aalyria.com
x-endpoint-pattern: <service>-<version>.$DOMAIN (subdomain endpoint resolution; per-customer Spacetime
  instance domain issued by Aalyria)
tags:
- Orchestration
- Networking
- Provisioning
- Modeling
- gRPC
properties:
- type: Protobuf
  url: grpc/api/model/v1/model.proto
- type: Documentation
  url: https://docs.spacetime.aalyria.com/api/nbi/
- type: GettingStarted
  url: https://docs.spacetime.aalyria.com/api/nbi/build-your-first-scenario/