EPepilot
App Installation

install

Changed on

Upsert app installation by its ID.

post/v1/app/{appId}

Request

  • Base URL
    https://app.sls.epilot.io
  • URL
    https://app.sls.epilot.io/v1/app/{appId}
  • Auth
    • HTTP bearer
    • or API key in header x-epilot-org-id

Path parameters

appIdstring required

Request body

versionstring

Version of the app to update to

_manifeststring[]

Manifest ID used to create/update the entity

Example request

{
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Response

App successfully installed.

app_idstring required

ID of the app configuration

installer_org_idstring required

Unique identifier for the organization the app is installed in

owner_org_idstring

Organization ID of the app creator

enabledboolean required

Flag to indicate if the app is enabled. Enabled is set to true when required option values are set.

namestring required

Name of the app

installed_versionstring required

Version of the app that is installed

rolestring

The name of the role the app can use to access APIs

_manifeststring[]

Manifest ID used to create/update the entity

Example response

{
  "components": [
    {
      "configuration": {
        "override_dev_mode": {
          "override_url": "http://localhost:3000"
        },
        "component_url": "https://cdn.apps.com/123/v1.0.0/bundle.js"
      }
    }
  ],
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Changes

  • 03b93188c6d4Revision changes
    • info

      added the new optional request property

  • d6e3c1e0a11bRevision changes
    • breaking

      the //// request property type changed from string to string boolean number

    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      the //////// response's property type changed from string to string boolean number for status

    • breaking

      the //// response's property type changed from string to string boolean number for status

    • warning

      removed the optional property ////////////// from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added ERP_INFORM_TOOLKIT discriminator mapping keys to the // response property for the response status