Jump to Content
Documentation
Support
API Reference
Documentation
Support
Log In
API Reference
Log In
API Reference
List apps for a team.
Search
JUMP TO
Vendor API V3
apps
Create an app.
post
Get an app.
get
Delete an app.
delete
Set a builtin license field value override for a given app and named field.
post
Delete a builtin license field override for a given app and named field.
delete
List builtin license fields for a given appId, with overrides applied.
get
Delete all of the builtin license field overrides for a given app and revert to the builtin defaults.
delete
Get customer instance report in CSV or JSON format.
get
Get customer report in CSV format.
get
Get instance events in JSON format.
get
Create a license field for a given app.
post
Update a license field for a given appId and licenseFieldName.
put
Delete a field for a given app and named field.
delete
List license fields for a given appId.
get
Rename the app.
post
List apps for a team.
get
channels
Creates a channel in the KOTS application.
post
Get a channel.
get
Updates an app channel.
put
Archives an app channel.
delete
Patches an app channel.
patch
Get adoption rates for an app channel.
get
Get an embedded cluster release.
get
Get customer instance trends for an app channel.
get
List channels for an app.
get
channelReleases
Get airgap bundle download URL the active release on the channel.
get
Trigger airgap build for a channel's release.
post
Get install commands for a specific channel release.
get
Update properties for a channel release.
post
List releases for an app channel.
get
releases
Demote a channel release.
post
Un-demote a channel release.
post
Create a new release.
post
Draft a release for an app.
post
Get a release by sequence.
get
Update a release.
put
Report a compatibility result.
post
Promote a release.
post
Test a release.
post
List releases for an app.
get
List active releases for an app.
get
Archive releases.
post
clusters
List cluster usage.
get
Create a test cluster.
post
Get clusters filters.
get
List cluster quotas.
get
Get clusters stats.
get
List cluster versions.
get
Get the details for a test cluster.
get
Delete a test cluster.
delete
Get the kubeconfig for a test cluster.
get
Update a nodegroup for a cluster.
put
Exposes a port on a cluster.
post
Deletes a port from a cluster.
delete
Lists ports for a cluster.
get
Update the tags for a cluster.
put
Update ttl for a cluster.
put
Upgrade a test cluster.
post
List test clusters.
get
Add credits to a team.
post
Send a request to increase cluster quota.
post
customHostnames
/app/{app_id}/custom-hostname
post
/app/{app_id}/custom-hostname
delete
/app/{app_id}/custom-hostname/default/set
put
/app/{app_id}/custom-hostname/default/unset
put
List custom hostnames for an app.
get
customers
Get customer entitlements.
get
Get a customer.
get
Download a customer license file as YAML.
get
List customers for an app.
get
Create a KOTS customer.
post
Update a customer.
put
Patch a customer.
patch
Regenerate the airgap password used to access the customer's download portal.
post
Archive a customer.
post
Unarchive a customer.
post
List all customers.
get
Search all customers for a given team context.
post
instances
List customer instances.
get
Get tags for a instance.
get
Create or update the tags for an instance.
put
Archive an instance.
put
Unarchive an instance.
put
clusterAddons
Lists addons for all clusters.
get
Adds an object store addon to a cluster.
post
Deletes an addon from a cluster.
delete
cmx
List CMX usage history.
get
Get CMX usage stats.
get
externalRegistries
List external registries for a team.
get
Creates an external registry with the specified parameters.
post
Get the logs for a specific external registry.
get
Test external registry for a team.
put
Deletes an external registry by endpoint.
delete
notifications
Subscribe to instance events.
post
Unsubscribe from instance events.
post
Get team instance subscriptions.
get
Get Slack webhook URL for team.
get
Set Slack webhook URL for team.
post
Test Slack webhook URL for team.
post
Get user instance subscriptions.
get
Powered by
List apps for a team.
get
https://api.replicated.com/vendor/v3/apps
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!
