Replicated apps API

The apps API from Replicated — 17 operation(s) for apps.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

23 operations 17 paths 32 schemas 4 DELETE10 GET5 POST4 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

Contact

Replicated, Inc.

Resource Areas

Authentication & Security 1

Replicated apps API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 23

Across 17 paths, the API surfaces 23 operations — 4 DELETE, 10 GET, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

apps 23

POST

/app

Create an app.

createApp 1 param → 201400401403

GET

/app/{app_id}

Get an app.

getAppProperties 1 param → 200400401403404

DELETE

/app/{app_id}

Delete an app.

deleteApp 1 param → 201400401403

POST

/app/{app_id}/builtin-license-field/{field_name}

Set a builtin license field value override for a given app and named field.

setBuiltinLicenseFieldOverride 3 params → 200400401403404

DELETE

/app/{app_id}/builtin-license-field/{field_name}

Delete a builtin license field override for a given app and named field.

deleteBuiltinLicenseFieldOverride 2 params → 204400401403404

GET

/app/{app_id}/builtin-license-fields

List builtin license fields for a given appId, with overrides applied.

listBuiltinLicenseFields 1 param → 200401403404

DELETE

/app/{app_id}/builtin-license-fields

Delete all of the builtin license field overrides for a given app and revert to the builtin defaults.

deleteBuiltinLicenseFieldsOverrides 1 param → 204400401403404

GET

/app/{app_id}/customer_instances

Export customer instances for an app as CSV or JSON.

listAppCustomerInstances 14 params → 200400404

GET

/app/{app_id}/customers_csv

Get customer report in CSV format.

listAppCustomersCsv 4 params → 200400

GET

/app/{app_id}/events

Get instance events in JSON format.

listAppInstanceEvents 7 params → 200204400404

GET

/app/{app_id}/images

Lists all registry images for an app by ID.

listAppImages 1 param → 200401403404

POST

/app/{app_id}/images/delete

Deletes registry images for an app by ID.

deleteAppImages 2 params → 200400401403404

POST

/app/{app_id}/license-field

Create a license field for a given app.

createLicenseField 2 params → 200400401403404

PUT

/app/{app_id}/license-field/{license_field_name}

Update a license field for a given appId and licenseFieldName.

editLicenseField 3 params → 200400401403404

DELETE

/app/{app_id}/license-field/{license_field_name}

Delete a field for a given app and named field.

deleteLicenseField 3 params → 200400401403404

GET

/app/{app_id}/license-fields

List license fields for a given appId.

listLicenseFields 1 param → 200400401403404

POST

/app/{app_id}/rename

Rename the app.

renameApp 2 params → 200400401403429

GET

/app/{app_id}/security-center-settings

Get app security center settings.

getSecurityCenterSettings 1 param → 200401403404

PUT

/app/{app_id}/security-center-settings

Update app security center settings.

updateSecurityCenterSettings 2 params → 200400401403404

PUT

/app/{app_id}/trial-signup

Update app trial signup setting.

updateAppTrialSignup 2 params → 200400401403404

GET

/app/{app_id}/trial-signup-settings

Get app trial signup settings.

getTrialSignupSettings 1 param → 200401403404

PUT

/app/{app_id}/trial-signup-settings

Update app trial signup settings.

updateTrialSignupSettings 2 params → 200400401403404

GET

/apps

List apps for a team.

apps → 200400401403404

Schemas 32

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

AppWithChannels

object

21 properties

InstallationTypeKurl

object

1 property

CustomerAdoption

object

7 properties

InstallerTypeEmbeddedCluster

object

4 properties

ImageVulnCounts

object

16 properties

InstallerTypeKotsConfig

object

1 property

LintResult

object

2 properties

Image

object

2 properties

InstallerTypeHelm

object

GitHubRef

object

EntitlementField

object

7 properties

InstallerTypeReplicatedSDK

object

1 property

CustomHostnameOverrides

object

4 properties

CustomSignupFieldDefinition

object

4 properties

InstallerTypePreflight

object

1 property

HelmInstallabilityIssue

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

HelmUnavailableResource

object

4 properties

ExtraLintRules

object

TrialSignupSettings

object

15 properties

InstallerTypeKots

object

2 properties

Channel

object

40 properties

BuiltInDefaultLicenseField

object

8 properties

InstallerTypeSupportBundle

object

1 property

EntitlementValueType

string

LintExpression

object

4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Replicated publishes across the network.

Replicated channelReleases API

AE Profile APIs.io

Replicated channels API

AE Profile APIs.io

Replicated clusterAddons API

AE Profile APIs.io

Replicated clusters API

AE Profile APIs.io

Replicated cmx API

AE Profile APIs.io

Replicated customers API

AE Profile APIs.io

Replicated customHostnames API

AE Profile APIs.io

Replicated enterprisePortal API

AE Profile APIs.io

Replicated externalRegistries API

AE Profile APIs.io

Replicated instances API

AE Profile APIs.io

Replicated networks API

AE Profile APIs.io

Replicated notifications API

AE Profile APIs.io

#apps

← Back to R APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Replicated apps API

Metadata

Authentication & Security 1

Paths & Operations 23

Schemas 32

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Replicated apps API

Metadata

Authentication & Security 1

Paths & Operations 23

Schemas 32

Specification

Source

More from Replicated 12

API Details

Provider

Explore more