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

The releases API from Replicated — 13 operation(s) for releases.

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

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

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

14 operations 13 paths 41 schemas 5 GET8 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 releases API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 14

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

releases 14
POST
/app/{app_id}/channel/{channel_id}/release/{sequence}/demote
Demote a channel release.
demoteChannelRelease 4 params → 200400401403404
POST
/app/{app_id}/channel/{channel_id}/release/{sequence}/undemote
Un-demote a channel release.
unDemoteChannelRelease 4 params → 200400401403404
POST
/app/{app_id}/release
Create a new release.
createRelease 2 params → 201400401403404
POST
/app/{app_id}/release/draft
Draft a release for an app.
draftRelease 2 params → 200400401403404
GET
/app/{app_id}/release/{sequence}
Get a release by sequence.
getRelease 2 params → 200400401403404
PUT
/app/{app_id}/release/{sequence}
Update a release.
updateRelease 3 params → 200400401403404
POST
/app/{app_id}/release/{sequence}/compatibility
Report a compatibility result.
reportCompatibilityResult 3 params → 201400401403404
GET
/app/{app_id}/release/{sequence}/exposure
Get exposure counts for a release.
getReleaseExposure 2 params → 200400401403404
POST
/app/{app_id}/release/{sequence}/promote
Promote a release.
promoteRelease 3 params → 200400401403404
POST
/app/{app_id}/release/{sequence}/test
Test a release.
testRelease 3 params → 200400401403404412
GET
/app/{app_id}/releases
List releases for an app.
listReleases 4 params → 200400401403404
GET
/app/{app_id}/releases/active
List active releases for an app.
listActiveReleases 4 params → 400401403404
POST
/app/{app_id}/releases/archive
Archive releases.
archiveReleases 2 params → 200400401403404
GET
/app/{app_id}/releases/search
Find releases containing a container image reference.
getImageReleaseSearch 5 params → 200400401403404

Schemas 41

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

InstallationTypeKurl
object
1 property
ReleaseExposure
object
ReleaseExposure describes how widely a release is deployed and who has access to it: the number of active instances running it, and the number of customers wit…
5 properties
CustomerAdoption
object
7 properties
InstallerTypeEmbeddedCluster
object
4 properties
ChartStatus
string
SupportedDistributionAndVersions
object
6 properties
ValidationError
object
2 properties
AirgapBuildSummary
object
6 properties
ImageVulnCounts
object
16 properties
InstallerTypeKotsConfig
object
1 property
LintResult
object
2 properties
InstallerTypeHelm
object
AppRelease
object
21 properties
GitHubRef
object
InstallerTypeReplicatedSDK
object
1 property
CompatibilityResult
object
6 properties
SupportedVersion
object
2 properties
CustomHostnameOverrides
object
4 properties
InstallerTypePreflight
object
1 property
HelmInstallabilityIssue
object
2 properties
ImageReleaseSearchChannel
object
6 properties
CustomHostnameOverride
object
1 property
KotsChannelRelease
object
31 properties
InstallationTypes
object
9 properties
VulnCounts
object
5 properties
Actor
object
5 properties
Chart
object
7 properties
InstallerTypeKots
object
2 properties
TotalActiveInactiveCustomers
object
3 properties
HelmUnavailableResource
object
4 properties
HelmChart
object
6 properties
ExtraLintRules
object
ImageReleaseSearchResponse
object
3 properties
AppReleaseDraft
object
AppReleaseDraft is a draft of a release before it is created
3 properties
ImageReleaseSearchBucket
object
3 properties
Channel
object
40 properties
ImageReleaseSearchRelease
object
3 properties
ReleaseChannelExposure
object
3 properties
InstallerTypeSupportBundle
object
1 property
ClusterDistributionStatus
object
4 properties
LintExpression
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicated-releases-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 networks API