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

The channels API from Replicated — 7 operation(s) for channels.

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

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

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

10 operations 7 paths 28 schemas 2 DELETE5 GET1 PATCH1 POST1 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 channels API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 10

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

channels 10
POST
/app/{app_id}/channel
Creates a channel in the KOTS application.
createChannel 2 params → 201400401403
GET
/app/{app_id}/channel/{channel_id}
Get a channel.
getChannelProperties 4 params → 200400401403404
PUT
/app/{app_id}/channel/{channel_id}
Updates an app channel.
updateChannel 3 params → 200400401403
DELETE
/app/{app_id}/channel/{channel_id}
Archives an app channel.
archiveChannel 2 params → 200400401403
PATCH
/app/{app_id}/channel/{channel_id}
Patches an app channel.
patchChannel 3 params → 200400401403
GET
/app/{app_id}/channel/{channel_id}/adoption
Get adoption rates for an app channel.
getChannelAdoptionReport 6 params → 200400401403404
DELETE
/app/{app_id}/channel/{channel_id}/delete
Permanently deletes an app channel.
deleteChannel 2 params → 200400401403
GET
/app/{app_id}/channel/{channel_id}/embeddedcluster/release
Get an embedded cluster release.
getEmbeddedClusterRelease 6 params → 200400401403404
GET
/app/{app_id}/channel/{channel_id}/trends
Get customer instance trends for an app channel.
getChannelInstanceTrends 3 params → 200400401403404
GET
/app/{app_id}/channels
List channels for an app.
listChannels 8 params → 200400401403404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Channel (40 properties), KotsChannelRelease (31 properties), ImageVulnCounts (16 properties), InstanceTrends (10 properties). Each schema is shown below with its type and property counts.

InstallationTypeKurl
object
1 property
CustomerAdoption
object
7 properties
InstallerTypeEmbeddedCluster
object
4 properties
ImageVulnCounts
object
16 properties
VersionAdoptionReport
object
2 properties
InstallerTypeKotsConfig
object
1 property
LintResult
object
2 properties
InstallerTypeHelm
object
GitHubRef
object
InstallerTypeReplicatedSDK
object
1 property
CustomHostnameOverrides
object
4 properties
InstallerTypePreflight
object
1 property
HelmInstallabilityIssue
object
2 properties
VersionAdoption
object
2 properties
CustomHostnameOverride
object
1 property
KotsChannelRelease
object
31 properties
InstallationTypes
object
9 properties
VulnCounts
object
5 properties
Actor
object
5 properties
TotalActiveInactiveCustomers
object
3 properties
HelmChart
object
6 properties
InstallerTypeKots
object
2 properties
HelmUnavailableResource
object
4 properties
ExtraLintRules
object
InstanceTrends
object
10 properties
Channel
object
40 properties
InstallerTypeSupportBundle
object
1 property
LintExpression
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicated-channels-api-openapi.yml Raw ↑

Other APIs Replicated publishes across the network.

Replicated apps API
Replicated channelReleases 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 networks API
Replicated notifications API