How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Replicated customers API

The customers API from Replicated — 11 operation(s) for customers.

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

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

This API exposes 14 operations across 11 paths, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against a single base URL, https://api.replicated.com/vendor/v3.

14 operations 11 paths 45 schemas 1 DELETE6 GET1 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 14

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

customers 14
GET
/app/{app_id}/customer/{customer_id}/license-download
Download a customer license file as YAML.
downloadLicense 2 params → 200400401403404
GET
/app/{app_id}/customers
List customers for an app.
listAppCustomers 8 params → 200400401403404
GET
/app/{app_id}/enterprise-portal/trials
List all trial signups for an app.
listPendingTrials 6 params → 200400401403404
POST
/customer
Create a KOTS customer.
createCustomer body → 201400401403
GET
/customer-entitlements/{customer_id}
Get customer entitlements.
getCustomerEntitlements 1 param → 200400401403404
GET
/customer/{customer_id}
Get a customer.
getCustomer 1 param → 200400401403404
PUT
/customer/{customer_id}
Update a customer.
updateCustomer 1 param body → 200400401403404
DELETE
/customer/{customer_id}
Delete a customer.
deleteCustomer 1 param → 204400401403404
PATCH
/customer/{customer_id}
Patch a customer.
patchCustomer 1 param body → 200400401403404
POST
/customer/{customer_id}/airgap/password
Regenerate the airgap password used to access the customer's download portal.
postAirgapPassword 1 param body → 200400401403404
POST
/customer/{customer_id}/archive
Archive a customer.
archiveCustomer 1 param → 204400401403404
POST
/customer/{customer_id}/unarchive
Unarchive a customer.
unarchiveCustomer 1 param → 204400401403404
GET
/customers
List all customers.
listCustomers 6 params → 200400401403404
POST
/customers/search
Search all customers for a given team context.
searchTeamCustomers body → 200400

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are ESCustomer (59 properties), Customer (54 properties), CustomerChannelWithDetail (43 properties), KotsChannelRelease (31 properties). Each schema is shown below with its type and property counts.

GitHubRef
object
LicenseType
string
HelmInstallabilityIssue
object
2 properties
InstallerTypeHelm
object
LintExpression
object
4 properties
EntitlementValues
array
CustomerAdoption
object
7 properties
CustomerChannelWithDetail
object
43 properties
CustomerInstanceVersionHistory
object
9 properties
InstanceTags
array
InstallerTypeKotsConfig
object
1 property
ESCustomer
object
59 properties
InstallerTypeSupportBundle
object
1 property
KotsChannelRelease
object
31 properties
TotalActiveInactiveCustomers
object
3 properties
InstanceSecuritySummary
object
InstanceSecuritySummary represents aggregated security information for an instance
3 properties
SoftwarePullMilestoneInfo
object
3 properties
VulnCounts
object
5 properties
CustomerChannel
object
3 properties
HelmUnavailableResource
object
4 properties
ShipInstallStatus
object
2 properties
CustomerESInstance
object
7 properties
InstallerTypeEmbeddedCluster
object
4 properties
InstallationTypes
object
9 properties
InstallerTypeReplicatedSDK
object
1 property
LintResult
object
2 properties
InstallationTypeKurl
object
1 property
CustomerEntitlement
object
2 properties
Actor
object
5 properties
InstallerTypePreflight
object
1 property
EPAccessMilestoneInfo
object
2 properties
TrialSignupVerification
object
9 properties
CustomHostnameOverrides
object
4 properties
ImageVulnCounts
object
16 properties
CustomHostnameOverride
object
1 property
InstallerTypeKots
object
2 properties
InstanceTag
object
4 properties
HelmChart
object
6 properties
EntitlementValue
object
3 properties
CustomerActions
object
4 properties
ExtraLintRules
object
EnterprisePortalInfo
object
EnterprisePortalInfo contains Enterprise Portal status and timestamps for a customer
14 properties
CustomerInstance
object
24 properties
Customer
object
54 properties
InstancePreview
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicated-customers-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 customHostnames API
Replicated enterprisePortal API
Replicated externalRegistries API
Replicated instances API
Replicated networks API
Replicated notifications API
Where this information came from

This is an independent, third-party profile of Replicated customers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.