EPepilot
App Configuration

getConfiguration

Changed on

Retrieve a specific app configuration

get/v1/app-configurations/{appId}

Request

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

Query parameters

versionstring

Version of the app configuration to retrieve

Response

Successful response

app_idstring required
namestring required

Name of the app

dev_modeboolean

Flag to indicate if the app is in dev mode. If true, the app takes the override_url property of components into account.

versionsstring[] required

List of available versions of the app

public_versionsstring[]

List of available public versions of the app

support_emailstring

Email address for support requests

latest_versionstring required

Latest version of the app

categorystring

Category of the app.

icon_urlstring

URL of the app icon.

documentation_urlstring

URL of the app documentation.

owner_org_idstring required

Organization ID of the app owner

internalboolean

Flag to indicate if the app is built by epilot.

publicboolean

Flag to indicate if the app is public.

pendingboolean

Flag to indicate if the app is pending for verification

versionstring required

Version of the app that is installed

is_betaboolean

Flag to indicate if the app is in beta.

deprecated_atstring

Timestamp when the app version is deprecated

changelogstring

Changelog for the app version

review_status'approved' | 'rejected' | 'pending'

Status of the review process

Example response

{
  "notifications": {
    "email": "developer@example.com"
  },
  "components": [
    {
      "configuration": {
        "override_dev_mode": {
          "override_url": "http://localhost:3000"
        },
        "component_url": "https://cdn.apps.com/123/v1.0.0/bundle.js"
      }
    }
  ]
}

Changes

  • d6e3c1e0a11bRevision changes
    • 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

    • 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

  • 2ab2aaf08d93Revision changes
    • breaking

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

    • warning

      added the new number enum value to the ///////////// response property for the response status

    • info

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

    • info

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