REreplicated
enterprisePortal

Update documentation URLs

Update documentation URLs and markdown content for various installation methods

Required RBAC Policy: kots/app/[:appid]/enterprise-portal/documentation/update

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

Request

  • Base URL
    https://api.replicated.com/vendor/v3
  • URL
    https://api.replicated.com/vendor/v3/app/{app_id}/enterprise-portal/documentation
  • Auth
    API key in header Authorization

Path parameters

app_idstring required

App identifier

Request body

embeddedClusterInstallURLstring

URL for Embedded Cluster installation documentation

embeddedClusterPostInstallstring

Markdown content for Embedded Cluster post-installation steps

embeddedClusterPreInstallstring

Markdown content for Embedded Cluster pre-installation steps

helmInstallURLstring

URL for Helm installation documentation

helmPostInstallstring

Markdown content for Helm post-installation steps

helmPreInstallstring

Markdown content for Helm pre-installation steps

kotsInstallURLstring

URL for KOTS installation documentation

kurlInstallURLstring

URL for kURL installation documentation

valuesOverrideURLstring

URL for Values Override documentation

Response

object required

Changes

No recorded changes to this operation across all 3 revisions of this API.