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 cmx API

The cmx API from Replicated — 5 operation(s) for cmx.

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

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

This API exposes 6 operations across 5 paths, and defines 6 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.

6 operations 5 paths 6 schemas 1 DELETE4 GET1 POST

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 cmx API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 6

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

cmx 6
GET
/cmx/history
List CMX usage history.
listCMXHistory 11 params → 200400401403404
GET
/cmx/quotas
List CMX quotas.
listCMXQuotas → 200400401403404
GET
/cmx/stats
Get CMX usage stats.
getCMXStats → 200400401403404
GET
/cmx/user/public-keys
Get public keys for the authenticated user.
getUserPublicKeys → 200400401
POST
/cmx/user/public-keys
Add a public key for the authenticated user.
addUserPublicKey 1 param → 201400401
DELETE
/cmx/user/public-keys/{user_id}/{fingerprint}
Delete a public key for the authenticated user.
deleteUserPublicKey 2 params → 200400401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CMXHistory (27 properties), CMXQuota (6 properties), Actor (5 properties), UserPublicKeyResponse (4 properties). Each schema is shown below with its type and property counts.

Tag
object
2 properties
CMXQuota
object
6 properties
UserPublicKeyResponse
object
4 properties
Actor
object
5 properties
CMXHistory
object
Any non-historical fields have been omitted.
27 properties
DistributionType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicated-cmx-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 customers API
Replicated customHostnames API
Replicated enterprisePortal API
Replicated externalRegistries API
Replicated instances API
Replicated networks API
Replicated notifications API