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

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

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

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

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

7 operations 7 paths 19 schemas 4 GET3 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 channelReleases API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 7

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

channelReleases 7
GET
/app/{app_id}/channel/{channel_id}/airgap/download-url
Get airgap bundle download URL the active release on the channel.
channelReleaseAirgapBundleURL 3 params → 200400401403404
POST
/app/{app_id}/channel/{channel_id}/release/{sequence}/airgap/build
Trigger airgap build for a channel's release.
channelReleaseAirgapBuild 3 params → 200400401403404
POST
/app/{app_id}/channel/{channel_id}/release/{sequence}/airgap/cancel
Cancel airgap build for a channel's release.
channelReleaseAirgapCancel 3 params → 200400401403404
GET
/app/{app_id}/channel/{channel_id}/release/{sequence}/airgap/status
Get airgap build status for a channel's release.
channelReleaseAirgapStatus 3 params → 200400401403404
GET
/app/{app_id}/channel/{channel_id}/release/{sequence}/install-commands
Get install commands for a specific channel release.
getChannelReleaseInstallCommands 3 params → 200400401403404
POST
/app/{app_id}/channel/{channel_id}/release/{sequence}/update-properties
Update properties for a channel release.
updateChannelRelease 4 params → 200400401403404
GET
/app/{app_id}/channel/{channel_id}/releases
List releases for an app channel.
listChannelReleases 8 params → 200400401403404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are KotsChannelRelease (31 properties), ImageVulnCounts (16 properties), InstallationTypes (9 properties), AirgapBuildSummary (6 properties). Each schema is shown below with its type and property counts.

InstallationTypeKurl
object
1 property
InstallerTypeEmbeddedCluster
object
4 properties
AirgapBuildSummary
object
6 properties
ImageVulnCounts
object
16 properties
InstallerTypeKotsConfig
object
1 property
LintResult
object
2 properties
InstallerTypeHelm
object
InstallerTypeReplicatedSDK
object
1 property
InstallerTypePreflight
object
1 property
HelmInstallabilityIssue
object
2 properties
KotsChannelRelease
object
31 properties
InstallationTypes
object
9 properties
VulnCounts
object
5 properties
Actor
object
5 properties
ChannelReleaseInstallCommands
object
2 properties
InstallerTypeKots
object
2 properties
HelmUnavailableResource
object
4 properties
InstallerTypeSupportBundle
object
1 property
LintExpression
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicated-channelreleases-api-openapi.yml Raw ↑

Other APIs Replicated publishes across the network.

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