Replicated enterprisePortal API

The enterprisePortal API from Replicated — 27 operation(s) for enterpriseportal.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

36 operations 27 paths 20 schemas 5 DELETE16 GET1 PATCH7 POST7 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 enterprisePortal API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 36

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

enterprisePortal 36

GET

/app/{app_id}/enterprise-portal/access

Get download portal access settings

getEnterprisePortalAccess 1 param → 200400401403404

PUT

/app/{app_id}/enterprise-portal/access

Update download portal access settings

updateEnterprisePortalAccess 2 params → 200400401403404

GET

/app/{app_id}/enterprise-portal/branding

Get custom branding for the enterprise portal

getEnterprisePortalBranding 1 param → 200400401403404

PUT

/app/{app_id}/enterprise-portal/branding

Update custom branding for the enterprise portal

updateEnterprisePortalBranding 2 params → 200400401403404

POST

/app/{app_id}/enterprise-portal/content-repos/{repo_id}/template-updates/acknowledge

Mark pending upstream content template updates reviewed for the current user.

acknowledgeContentTemplateUpdates 2 params → 200401403404

PUT

/app/{app_id}/enterprise-portal/content-settings

Update Enterprise Portal content settings for an app.

updateEnterprisePortalContentSettings 2 params → 200400401403404

POST

/app/{app_id}/enterprise-portal/content-versions/pin

Pin a release version label to an existing content branch

createContentVersionPin 2 params → 200400401403404

DELETE

/app/{app_id}/enterprise-portal/content-versions/{version_id}

Delete a content version

deleteContentVersion 2 params → 200400401403404

POST

/app/{app_id}/enterprise-portal/content-versions/{version_id}/dismiss-notice

Clear the sync notice for a content version.

dismissContentVersionNotice 2 params → 200401403404

GET

/app/{app_id}/enterprise-portal/customer-allowed-domains

List customer allowed domains for the enterprise portal

listCustomerAllowedDomains 2 params → 200400401403404

POST

/app/{app_id}/enterprise-portal/customer-allowed-domains

Create a customer allowed domain for the enterprise portal

createCustomerAllowedDomain 2 params → 201400401403404

DELETE

/app/{app_id}/enterprise-portal/customer-allowed-domains/{allowedDomainId}

Delete a customer allowed domain for the enterprise portal

deleteCustomerAllowedDomain 3 params → 204400401403404

POST

/app/{app_id}/enterprise-portal/customer-user

Invite a customer user to the enterprise portal

inviteEnterprisePortalCustomerUser 2 params → 201400401403404

DELETE

/app/{app_id}/enterprise-portal/customer-user

Delete a customer user for the enterprise portal

deleteEnterprisePortalCustomerUser 3 params → 204400401403404

GET

/app/{app_id}/enterprise-portal/customer-users

List customer users for the enterprise portal

listEnterprisePortalCustomerUsers 8 params → 200400401403404

GET

/app/{app_id}/enterprise-portal/documentation

Get documentation URLs for various installation methods

getEnterprisePortalDocumentation 1 param → 200400401403404

PUT

/app/{app_id}/enterprise-portal/documentation

Update documentation URLs

updateEnterprisePortalDocumentation 2 params → 200400401403

GET

/app/{app_id}/enterprise-portal/email-history

List email history for the enterprise portal

listEnterprisePortalEmailHistory 6 params → 200400401403404

GET

/app/{app_id}/enterprise-portal/failed-login-attempts

List failed login attempts

listFailedLoginAttempts 6 params → 200400401403404

GET

/app/{app_id}/enterprise-portal/features

Get Enterprise Portal feature settings for an app

getPortalFeatures 1 param → 200401403404

PUT

/app/{app_id}/enterprise-portal/features

Update Enterprise Portal feature settings for an app

updatePortalFeatures 2 params → 200400401403404

GET

/app/{app_id}/enterprise-portal/install-attempts

List installation attempts for the enterprise portal

listInstallAttempts 6 params → 200400401403404

POST

/app/{app_id}/enterprise-portal/install-options

Create an installation options record

createInstallOptions 3 params → 201400401403404

DELETE

/app/{app_id}/enterprise-portal/install-options/{install_options_id}

Delete an installation options record

deleteInstallOptions 2 params → 204400401403404

PATCH

/app/{app_id}/enterprise-portal/install-options/{install_options_id}

Update an installation options record

patchInstallOptions 4 params → 200400401403404

GET

/app/{app_id}/enterprise-portal/install-options/{option_id}

Get an install options record

getInstallOptions 3 params → 200400401403404

GET

/app/{app_id}/enterprise-portal/install-options/{option_id}/update-instructions

Get update instructions

getUpdateInstructions 6 params → 200400401403404

GET

/app/{app_id}/enterprise-portal/instances

List instances

listEnterprisePortalInstances 4 params → 200400401403404

GET

/app/{app_id}/enterprise-portal/service-accounts

List service accounts

listEnterprisePortalServiceAccounts 7 params → 200400401403404

DELETE

/app/{app_id}/enterprise-portal/service-accounts/{serviceAccountId}

Delete (revoke) a service account

deleteEnterprisePortalServiceAccount 2 params → 204400401403404

GET

/app/{app_id}/enterprise-portal/settings

Get enterprise portal settings for a customer

getEnterprisePortalSettings 2 params → 200400401403404

PUT

/app/{app_id}/enterprise-portal/settings

Update enterprise portal settings for a customer

updateEnterprisePortalSettings 2 params → 200400401403404

GET

/app/{app_id}/enterprise-portal/status

Get enterprise portal status

getEnterprisePortalStatus 1 param → 200400401403404

PUT

/app/{app_id}/enterprise-portal/status

Update status of the enterprise portal

updateEnterprisePortalStatus 2 params → 200400401403404

POST

/app/{app_id}/enterprise-portal/system-user-login

Create a one-time login URL for Enterprise Portal using a system user for the specified customer.

createEnterprisePortalSystemUserLogin 2 params → 201400401403404

GET

/app/{app_id}/enterprise-portal/update-attempts

List customer update attempts

listUpdateAttempts 5 params → 200400401403404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are InstallAttempt (30 properties), CustomerInstallOptions (26 properties), UpdateAttempt (22 properties), Instance (21 properties). Each schema is shown below with its type and property counts.

ArtifactDownloadResponse

object

ArtifactDownloadResponse describes a browser-downloadable artifact exposed alongside generated install instructions.

6 properties

InstanceResourceState

object

4 properties

InstanceTag

object

4 properties

InstallStepResponse

object

7 properties

InstallAttempt

object

InstallAttempt extends CustomerInstallOptions with calculated or joined fields to represent an installation attempt

30 properties

UpdateAttempt

object

UpdateAttempt represents a row from customerupdateattempts

22 properties

FailedLoginAttempt

object

FailedLoginAttempt represents a failed login attempt record

7 properties

UpdateInstructionsResponse

object

7 properties

AllowedDomain

object

6 properties

Instance

object

21 properties

CustomerInstallOptions

object

26 properties

CustomerUser

object

11 properties

Documentation

object

9 properties

InstallInstructionsResponse

object

7 properties

EmailHistoryItem

object

EmailHistoryItem represents an email with its latest status for display

12 properties

ContentVersion

object

10 properties

EnterprisePortalSettings

object

7 properties

ServiceAccount

object

9 properties

CustomerInvite

object

10 properties

ContentSettings

object

1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Replicated publishes across the network.

Replicated apps API

AE Profile APIs.io

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

#enterprisePortal

← Back to R APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Replicated enterprisePortal API

Metadata

Authentication & Security 1

Paths & Operations 36

Schemas 20

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Replicated enterprisePortal API

Metadata

Authentication & Security 1

Paths & Operations 36

Schemas 20

Specification

Source

More from Replicated 12

API Details

Provider

Explore more