Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NVIDIA Run:ai Network Topologies API

The Network Topologies API enables administrators to reflect the hierarchical network topology connectivity of nodes in a data center, such as racks, blocks, and other organizational units, to improve pod scheduling decisions for communication-intensive AI/ML workloads. To support topology-aware scheduling, this API allows administrators to define a multi-level network topology element using ordered Kubernetes node labels that represent the network connectivity of nodes in the data center. Nodes are labeled with the same key-value pairs labels that represent their location in the data center network. These labels are used by the NVIDIA Run:ai Scheduler to prefer scheduling pods on nodes that are "closer" to each other, minimizing communication overhead and optimizing workload performance.

NVIDIA Run:ai Network Topologies API is one of 62 APIs that NVIDIA Run:ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Network Topologies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 3.0.3, at version latest.

Requests are made against a single base URL, https://app.run.ai.

5 operations 3 paths 11 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
latest
Base URL
https://app.run.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

NVIDIA Run:ai Network Topologies API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Network Topologies 5

The Network Topologies API enables administrators to reflect the hierarchical network topology connectivity of nodes in a data center, such as racks, blocks, and other organizatio…

GET
/api/v1/network-topologies
Get network topologies.
get_network_topologies 1 param → 200401403404500503
POST
/api/v1/network-topologies
Create network topologies
create_network_topology body → 201400401403404500503
GET
/api/v1/network-topologies/count
Count the amount of network topologies in a tenant.
get_network_topologies_count 1 param → 200401403404500503
GET
/api/v1/network-topologies/{networkTopologyId}
Get network topology by id.
get_network_topology_by_id 1 param → 200401403404500503
DELETE
/api/v1/network-topologies/{networkTopologyId}
Delete network topology by ID.
delete_network_topology 1 param → 204401403404500503

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Error (3 properties), NetworkTopologyUpdateFields (1 property), CountResponse (1 property). Each schema is shown below with its type and property counts.

NetworkTopologyUpdateFields
object
1 property 1 required
NetworkTopologyLevels
array
Ordered array of network topology levels
Error
object
3 properties 2 required
CountResponse
object
1 property 1 required
NetworkTopologyId
string
The unique identifier for the network topology
TenantId
integer
The id of the tenant.
NetworkTopologiesSource
string
Identifier of the the source of the topology. Useful for tracking where the topology data originated (i.e. Run:ai, Cluster).
ClusterId
string
The id of the cluster.
NetworkTopologyName
string
Name of the network topology
NetworkTopology
NetworkTopologyCreateRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-network-topologies-api-openapi.yml Raw ↑

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API
NVIDIA Run:ai Access rules API
NVIDIA Run:ai Administrator Command Line Interface API
NVIDIA Run:ai AI Applications API
NVIDIA Run:ai Applications API
NVIDIA Run:ai AuditLogs API
NVIDIA Run:ai Clusters API
NVIDIA Run:ai Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API