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

Replicated networks API

The networks API from Replicated — 3 operation(s) for networks.

Replicated networks API is one of 22 APIs that Replicated publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 2.0, at version 3.0.0.

Requests are made against the base URL https://api.replicated.com/vendor/v3.

3 operations 3 paths 3 schemas 2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.0.0
Base URL
https://api.replicated.com/vendor/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Replicated networks API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 3

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

networks 3
GET
/network/{network_id}
Get the details for a test network.
getNetwork 1 param → 200400401403404
PUT
/network/{network_id}/update
Update network settings (policy and/or collect report).
updateNetwork 2 params → 200400401403404
GET
/networks
List test networks.
listNetworks 8 params → 200400401403404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Network (17 properties), NetworkResource (3 properties). Each schema is shown below with its type and property counts.

NetworkResource
object
3 properties
NetworkStatus
string
Network
object
17 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicated-networks-api-openapi.yml Raw ↑

Other APIs Replicated publishes across the network.

Replicated apps API
Replicated channelReleases API
Replicated channels API
Replicated clusterAddons API
Replicated clusters API
Replicated cmx API
Replicated customers API
Replicated customHostnames API
Replicated enterprisePortal API
Replicated externalRegistries API
Replicated instances API
Replicated notifications API