WARNING

WARNING: These APIs are currently in an 'alpha' state and are likely to change over time. We recommend you not use them in a production setting at this time!


Create an ExtensionPackage

For an extension package to be available to the Launch platform, it must be added as an ExtensionPackage.

Extension packages are processed asynchronously and have a status attribute representing the current status of the ExtensionPackage.

note

This endpoint expects multipart requests.

Status

An ExtensionPackage status may be one of the following values.

pending

When an ExtensionPackage is created, status is set to pending. This indicates that Launch received the information for the extension package and will begin processing.

ExtensionPackages with a status of pending are not available for use.

succeeded

When processing of the ExtensionPackage has completed, if processing was successful, the status will change to succeeded.

failed

When processing of the ExtensionPackage has completed, if processing was unsuccessful, the status will change to failed. An ExtensionPackage with a status of failed may be updated until processing succeeds.

ExtensionPackages with a status of failed are not available for use.

Availability

ExtensionPackages have an availability attribute that represents its visibility and availability for use.

An ExtensionPackage availability may be one of the following values.

development

An extension package in development is only visible to, and available within, the Company that owns it, and Properties which are configured for extension development.

private

A private ExtensionPackage is only visible to, and available for installation on a Property within the Company that owns it.

public

A public ExtensionPackage is visible and available to all Companies and Properties.

When an ExtensionPackage is created, availability is set to development. After testing has been completed, you can transition the ExtensionPackage to either private or public.

Attributes

package
required file. The extension package archive.

Definition

POST  /extension_packages

Example Request

curl https://mc-api-activation-reactor-integration.adobe.io/extension_packages \
  -H "Accept: application/vnd.api+json;revision=1" \
  -H "Content-Type: multipart/form-data" \
  -H "Authorization: Bearer [TOKEN]" \
  -H "X-Api-Key: [KEY]" \
  -F "package"="@[PATH]" 

Example Response

202 Accepted
{
  "data": {
    "id": "EP10bb503178694d73bc0cd84387b82172",
    "type": "extension_packages",
    "attributes": {
      "actions": null,
      "author": null,
      "availability": "development",
      "cdn_path": null,
      "conditions": null,
      "configuration": null,
      "created_at": "2018-09-14T11:34:56.877Z",
      "data_elements": null,
      "description": null,
      "display_name": null,
      "events": null,
      "exchange_url": null,
      "hosted_lib_files": null,
      "icon_path": null,
      "main": null,
      "name": null,
      "resources": null,
      "shared_modules": null,
      "status": "pending",
      "platform": "null",
      "updated_at": "2018-09-14T11:34:56.877Z",
      "version": null,
      "view_base_path": null
    },
    "links": {
      "self": "https://mc-api-activation-reactor-integration.adobe.io/extension_packages/EP10bb503178694d73bc0cd84387b82172"
    }
  }
}